fix: Skeleton is displayed when create offline Room in focus mode and switch #54180

truph01 · 2024-12-16T08:35:13Z

Explanation of Change

Fixed Issues

$ #53660
PROPOSAL: #53660 (comment)

Tests

Go to Settings> Preferences> Priority mode> Focus
Go offline
Create a room
Go to Settings> Preferences> Priority mode> Most recent
Go to the room from step 3
Verify: Welcome to the room message should be displayed

Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

output.mp4

Android: mWeb Chrome

Screen.Recording.2024-12-16.at.15.26.56.mov

iOS: Native

Screen.Recording.2024-12-16.at.15.30.45.mov

iOS: mWeb Safari

Screen.Recording.2024-12-16.at.15.32.31.mov

MacOS: Chrome / Safari

Screen.Recording.2024-12-16.at.15.17.27.mov

MacOS: Desktop

Screen.Recording.2024-12-16.at.15.34.29.mov

… switch

melvin-bot · 2024-12-16T08:35:19Z

@jjcoffee Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

jjcoffee · 2024-12-16T13:53:11Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

android-app-2024-12-16_14.57.08.mp4

Android: mWeb Chrome

android-chrome-2024-12-16_14.59.08.mp4

iOS: Native

ios-app-2024-12-16_15.05.49.mp4

iOS: mWeb Safari

ios-safari-2024-12-16_15.10.50.mp4

MacOS: Chrome / Safari

desktop-chrome-2024-12-16_14.51.36.mp4

MacOS: Desktop

desktop-app-2024-12-16_14.54.18.mp4

jjcoffee · 2024-12-16T14:45:19Z

src/libs/actions/Report.ts

@@ -2386,6 +2393,13 @@ function addPolicyReport(policyReport: ReportUtils.OptimisticChatReport) {
            key: ONYXKEYS.FORMS.NEW_ROOM_FORM,
            value: {isLoading: false},
        },
+        {
+            onyxMethod: Onyx.METHOD.MERGE,


This is duplicate code of the above section. But I think we do want it in the failureData as isOptimisticReport should always clear.

I added the isOptimisticReport: false to failureData.

Do you see that we already have this code above though?

App/src/libs/actions/Report.ts

Lines 2376 to 2380 in 83267e2

onyxMethod: Onyx.METHOD.MERGE,

key: `${ONYXKEYS.COLLECTION.REPORT_METADATA}${policyReport.reportID}`,

value: {

isOptimisticReport: false,

},

@jjcoffee Apologies for misunderstanding your comment earlier, @jjcoffee 🙏. I've updated the PR to remove the duplicate logic.

jjcoffee · 2024-12-16T15:07:59Z

src/pages/home/ReportScreen.tsx

@@ -384,7 +384,7 @@ function ReportScreen({route, currentReportID = '', navigation}: ReportScreenPro
        !isCurrentReportLoadedFromOnyx ||
        // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
        (deleteTransactionNavigateBackUrl && ReportUtils.getReportIDFromLink(deleteTransactionNavigateBackUrl) === report?.reportID) ||
-        isLoading;
+        ((!ReportUtils.isUserCreatedPolicyRoom(report) || !reportMetadata.isOptimisticReport) && isLoading);


Hmm now that I think about it this feels a bit hacky. Is there any reason to specifically apply this to policy rooms?

I've also noticed whilst testing that isLoadingApp gets set to true only when the mode is switched to Most recent (not to #focus), which makes me think that we may have actually missed the true RCA here. I think isLoadingApp is either being incorrectly set when the focus mode is switched, or this is an unexpected side-effect of it.

A similar behaviour happens on any existing report, where if you switch specifically from #focus to Most recent, only the most recent message loads, the rest are in a loading state.

Hmm now that I think about it this feels a bit hacky. Is there any reason to specifically apply this to policy rooms?

I just want to ensure this change doesn’t unintentionally affect other report types I might not have context on. It’s important to verify these also work correctly with the new change.

I've also noticed whilst testing that isLoadingApp gets set to true only when the mode is switched to Most recent (not to #focus), which makes me think that we may have actually missed the true RCA here. I think isLoadingApp is either being incorrectly set when the focus mode is switched, or this is an unexpected side-effect of it.

When switching from focus mode to default mode, we call openApp():

App/src/libs/actions/App.ts

Lines 75 to 78 in d86024e

// When someone switches their priority mode we need to fetch all their chats because only #focus mode works with a subset of a user's chats. This is only possible via the OpenApp command.

if (nextPriorityMode === CONST.PRIORITY_MODE.DEFAULT && priorityMode === CONST.PRIORITY_MODE.GSD) {

// eslint-disable-next-line @typescript-eslint/no-use-before-define

openApp();

As a result, isLoadingApp gets set to true.

A similar behavior happens on any existing report, where if you switch specifically from #focus to Most recent, only the most recent message loads, the rest are in a loading state.

I see your point. However, for existing reports, we show the loading indicator because we don’t know “how many actions are missing” when switching from focus mode to default mode. In the case of an optimistic report, though, we can confidently determine that “no fetch is needed,” as explained here:

App/src/libs/shouldFetchReport.ts

Line 7 in d86024e

// If the report is optimistic, there's no need to fetch it. The original action should create it.

I just want to ensure this change doesn’t unintentionally affect other report types I might not have context on. It’s important to verify these also work correctly with the new change.

Makes sense, limiting the scope can reduce the chance for regressions. Are we okay to just focus on rooms here @lakchote, or do you think we should fix other reports (e.g. group chats)?

However, for existing reports, we show the loading indicator because we don’t know “how many actions are missing”

Okay, just gonna check on Slack regarding the expected behaviour there to make sure.

I'd say we need to fix the whole issue as a whole and fix this for other reports.
If this introduces potential side effects/regressions, then we'll need to fix it and that would indicate the RCA of the solution here wasn't the correct one. I'd prefer to have solved the root cause and not a possibly hack that works for certain report types.

Okay gotcha - let's do it for all report types, then - unless you disagree @truph01.

jjcoffee

Tests well and LGTM (we can ignore the lint errors since they're not parts of the code we've touched). We've limited scope here to affect Rooms only (see here)

lakchote · 2024-12-19T10:44:12Z

Tests well and LGTM (we can ignore the lint errors since they're not parts of the code we've touched). We've limited scope here to affect Rooms only (see here)

Posted about here. We should fix the root issue.

truph01 · 2024-12-23T10:00:48Z

@jjcoffee I updated PR based on comment

jjcoffee

LGTM! Confirmed that it works with other chat types, e.g. group chat.

jjcoffee · 2024-12-23T10:39:11Z

All yours @lakchote 🙏

fix: Skeleton is displayed when create offline Room in focus mode and…

82da9af

… switch

truph01 requested a review from a team as a code owner December 16, 2024 08:35

melvin-bot bot requested review from jjcoffee and removed request for a team December 16, 2024 08:35

truph01 mentioned this pull request Dec 16, 2024

[$250] Room - Skeleton is displayed when create offline Room in focus mode and switch to most recent #53660

Open

8 tasks

jjcoffee reviewed Dec 16, 2024

View reviewed changes

truph01 added 3 commits December 17, 2024 11:26

fix: set isOptimisticReport to false in failureData

259e66c

merge main

83267e2

fix: remove duplicate logic

912c328

jjcoffee approved these changes Dec 19, 2024

View reviewed changes

melvin-bot bot requested a review from lakchote December 19, 2024 10:25

truph01 added 2 commits December 23, 2024 16:56

fix: apply the fix to all report type

3974cc7

merge main

b7a690b

jjcoffee approved these changes Dec 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Skeleton is displayed when create offline Room in focus mode and switch #54180

fix: Skeleton is displayed when create offline Room in focus mode and switch #54180

truph01 commented Dec 16, 2024

melvin-bot bot commented Dec 16, 2024

jjcoffee commented Dec 16, 2024 •

edited

Loading

jjcoffee Dec 16, 2024

truph01 Dec 17, 2024

jjcoffee Dec 17, 2024

truph01 Dec 17, 2024

jjcoffee Dec 16, 2024

jjcoffee Dec 16, 2024

truph01 Dec 17, 2024

jjcoffee Dec 17, 2024

lakchote Dec 19, 2024

jjcoffee Dec 20, 2024

jjcoffee left a comment

lakchote commented Dec 19, 2024

truph01 commented Dec 23, 2024

jjcoffee left a comment

jjcoffee commented Dec 23, 2024

	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT_METADATA}${policyReport.reportID}`,
	value: {
	isOptimisticReport: false,
	},

	// When someone switches their priority mode we need to fetch all their chats because only #focus mode works with a subset of a user's chats. This is only possible via the OpenApp command.
	if (nextPriorityMode === CONST.PRIORITY_MODE.DEFAULT && priorityMode === CONST.PRIORITY_MODE.GSD) {
	// eslint-disable-next-line @typescript-eslint/no-use-before-define
	openApp();

fix: Skeleton is displayed when create offline Room in focus mode and switch #54180

Are you sure you want to change the base?

fix: Skeleton is displayed when create offline Room in focus mode and switch #54180

Conversation

truph01 commented Dec 16, 2024

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 16, 2024

jjcoffee commented Dec 16, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjcoffee left a comment

Choose a reason for hiding this comment

lakchote commented Dec 19, 2024

truph01 commented Dec 23, 2024

jjcoffee left a comment

Choose a reason for hiding this comment

jjcoffee commented Dec 23, 2024

jjcoffee commented Dec 16, 2024 •

edited

Loading