[CP Staging] fix: prevent app crash in group chat when going back online by TMisiukiewicz · Pull Request #54652 · Expensify/App

TMisiukiewicz · 2024-12-30T10:57:50Z

Explanation of Change

When going back online, the app was crashing because once the optimistic report was created, the shape of the report was changing, and it was dynamically change Onyx key from report_ to report_undefined. We need to bring back the fallback to empty string in ReportDetailsPage to avoid dynamically subscribing to entire collection.

Couldn't record videos on mobile web as I haven't found any way to open debug modal on a simulator

Fixed Issues

$ #54595
PROPOSAL:

Tests

Go offline.
Open FAB > Start chat.
Create a group chat with any user.
Click on the group chat header.
Go online.
Verify the app did not crash

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

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

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-12-30T10:57:55Z

@getusha 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]

Beamanator · 2024-12-30T11:11:01Z

src/pages/ReportDetailsPage.tsx

+    // eslint-disable-next-line rulesdir/no-default-id-values
+    const [parentReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID ?? ''}`);
+    // eslint-disable-next-line rulesdir/no-default-id-values
+    const [reportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.reportID ?? ''}`);


Should we use CONST.DEFAULT_NUMBER_ID as the defaults here? Or is '' better?

using CONST.DEFAULT_NUMBER_ID also breaks the app because key is dynamically changed from report_ to report_0. I think using '' is the only safe way here

Interesting! I am surprised b/c we use CONST.DEFAULT_NUMBER_ID so often, even for the report ID like here:

App/src/pages/home/report/ReportActionsView.tsx

Line 95 in d641a12

const [transactionThreadReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${transactionThreadReportID ?? CONST.DEFAULT_NUMBER_ID}`);

I am very ok with keeping this '' for now, but I think we'll eventually want a better solution OR we should make eslint accept default to an empty string (again, later / not in this PR), what do you think? :D

I think ideally in the future we could align the shape of optimistic report with the one that comes from OpenReport endpoint - we optimistically create it with parentReportID as empty string and then we receive null in a response. This might require a change on the backend

I'm tagging @VickyStash to answer allowing empty string as default question, as she has much more context of this rule than me 😅

Innnteresting! Ok so how about for now, since your solution should work, let's get it merged & CP'd so we can unblock deploy, then we can figure out "the best solution" as a follow-up?

It looks like somewhere in the app the parentReportID is optimistically set to empty string ''.

So this way the hook

const [parentReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID}`);

tries to get the data using firstly

report_ key - the whole collection key
report_undefined key - specific report key

Since one useOnyx hook is used to get both collection and specific item it gives error.
For the same reason the nullish coalescing rule was disabled before.

Ideally, we should find out why parentReportID is turned into a string and prevent it. But we discussed it with @TMisiukiewicz and it looks like it can have side effects at this stage.
For now, we can also check specifically if parentReportID is not an empty string or turn it back to as it was before (@shubham1206agra mentioned below).

shubham1206agra · 2024-12-30T11:47:11Z

src/pages/ReportDetailsPage.tsx

+    // eslint-disable-next-line rulesdir/no-default-id-values
+    const [parentReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID ?? ''}`);
+    // eslint-disable-next-line rulesdir/no-default-id-values
+    const [reportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.reportID ?? ''}`);


Suggested change

// eslint-disable-next-line rulesdir/no-default-id-values

const [parentReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID ?? ''}`);

// eslint-disable-next-line rulesdir/no-default-id-values

const [reportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.reportID ?? ''}`);

/* eslint-disable @typescript-eslint/prefer-nullish-coalescing */

const [parentReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID || CONST.DEFAULT_NUMBER_ID}`);

const [reportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.reportID || CONST.DEFAULT_NUMBER_ID}`);

Lets do the original way.

Ooh yeah if we end up with this:

const [reportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}`);

Will that subscribe to the entire collection? That sounds baaaad

I guess something like this should work as well:
This way we can get rid of nullish-coalescing disable

const [parentReportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.parentReportID === '' ? undefined : report?.parentReportID}`);

shubham1206agra · 2024-12-30T11:47:46Z

src/pages/ReportDetailsPage.tsx

+    // eslint-disable-next-line rulesdir/no-default-id-values
+    const [parentReportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.parentReportID ?? ''}`);


Suggested change

// eslint-disable-next-line rulesdir/no-default-id-values

const [parentReportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.parentReportID ?? ''}`);

const [parentReportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.parentReportID || CONST.DEFAULT_NUMBER_ID}`);

/* eslint-enable @typescript-eslint/prefer-nullish-coalescing */

Beamanator

@TMisiukiewicz I think @shubham1206agra is right that we can't default to empty strings, because that would subscribe to entire collections - can you please help us get this updated quick so we can test & merge to fix the deploy blocker?

TMisiukiewicz · 2024-12-30T12:13:48Z

good catch - I think my mind is still somewhere in a Christmas season 😆 thanks for help everyone!

VickyStash · 2024-12-30T12:16:06Z

src/pages/ReportDetailsPage.tsx

+    /* eslint-disable @typescript-eslint/prefer-nullish-coalescing */
+    const [parentReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID || CONST.DEFAULT_NUMBER_ID}`);


Maybe we can also get rid of nullish-coalescing disable, but it's up to you

Suggested change

/* eslint-disable @typescript-eslint/prefer-nullish-coalescing */

const [parentReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID || CONST.DEFAULT_NUMBER_ID}`);

const [parentReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID === '' ? undefined : report.parentReportID}`);

Beamanator · 2024-12-30T12:54:06Z

@VickyStash won't the '' ? undefined parts potentially leave us in the case with report_undefined / reportNameValuePairs_undefined which could cause the crash again?

VickyStash · 2024-12-30T12:57:15Z

@VickyStash won't the '' ? undefined parts potentially leave us in the case with report_undefined / reportNameValuePairs_undefined which could cause the crash again?

I've explained it here.
Not the report_undefined causing the crash, but trying to get both the collection and collection item with the same hook.
So I guess just report_undefined on its own shouldn't cause any crashes.

Beamanator · 2024-12-30T13:07:24Z

Aah true, thanks for pointing that out 👍

But even if report_undefined doesn't cause a crash, it's a bit weird to default to it, no? Do we do that anywhere else in the codebase? I didn't see any cases (for report-related collections).

I would prefer going with @shubham1206agra 's suggestion for now instead of possibly using report_undefined, but @VickyStash I'm interested to hear if you think one is better vs the other!

shubham1206agra · 2024-12-30T13:08:09Z

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

Screen.Recording.2024-12-30.at.6.37.04.PM.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-12-30.at.6.31.01.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-12-30.at.6.23.34.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-12-30.at.6.21.46.PM.mov

MacOS: Desktop

Screen.Recording.2024-12-30.at.6.26.13.PM.mov

src/pages/ReportDetailsPage.tsx

Beamanator · 2024-12-30T13:13:40Z

I think we should look into "where we set parentReportID to ''" as a follow-up, but for now I want to get this merged to fix the open deploy blocker 🙏 Any disagreements?

OSBotify · 2024-12-30T13:59:48Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

…oup-chat fix: prevent app crash in group chat when going back online (cherry picked from commit 9debee9) (CP triggered by Beamanator)

github-actions · 2024-12-30T14:52:23Z

🚀 Cherry-picked to staging by https://github.com/Beamanator in version: 9.0.79-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

github-actions · 2024-12-31T21:52:56Z

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.79-5 🚀

platform	result
🤖 android 🤖	true ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	success ✅

fix app crash in group chat

7846542

TMisiukiewicz requested a review from a team as a code owner December 30, 2024 10:57

melvin-bot bot requested review from getusha and removed request for a team December 30, 2024 10:57

ignore no-default-id-values rule for report details

ab1c902

Beamanator reviewed Dec 30, 2024

View reviewed changes

Beamanator requested review from shubham1206agra and removed request for getusha December 30, 2024 11:34

shubham1206agra reviewed Dec 30, 2024

View reviewed changes

Beamanator requested changes Dec 30, 2024

View reviewed changes

use default ID instead of empty string

36aff23

VickyStash reviewed Dec 30, 2024

View reviewed changes

shubham1206agra approved these changes Dec 30, 2024

View reviewed changes

melvin-bot bot requested a review from youssef-lr December 30, 2024 13:08

Beamanator reviewed Dec 30, 2024

View reviewed changes

src/pages/ReportDetailsPage.tsx Show resolved Hide resolved

Beamanator approved these changes Dec 30, 2024

View reviewed changes

Beamanator merged commit 9debee9 into Expensify:main Dec 30, 2024

Beamanator changed the title ~~fix: prevent app crash in group chat when going back online~~ [CP Staging] fix: prevent app crash in group chat when going back online Dec 30, 2024

OSBotify pushed a commit that referenced this pull request Dec 30, 2024

Merge pull request #54652 from callstack-internal/fix/app-crash-in-gr…

98bf0e2

…oup-chat fix: prevent app crash in group chat when going back online (cherry picked from commit 9debee9) (CP triggered by Beamanator)

github-actions bot added the CP Staging marks PRs that have been CP'd to staging label Dec 30, 2024

github-actions bot mentioned this pull request Dec 30, 2024

Deploy Checklist: New Expensify 2024-12-26 #54591

Closed

42 tasks

melvin-bot bot mentioned this pull request Dec 31, 2024

[HOLD for payment 2025-01-13] [HOLD for payment 2025-01-07] Chat - App crashes when creating group chat offline and returning online on report details RHP #54595

Closed

8 tasks

		// eslint-disable-next-line rulesdir/no-default-id-values
		const [parentReportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.parentReportID ?? ''}`);

		/* eslint-disable @typescript-eslint/prefer-nullish-coalescing */
		const [parentReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID \|\| CONST.DEFAULT_NUMBER_ID}`);

Conversation

TMisiukiewicz commented Dec 30, 2024

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Dec 30, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Beamanator Dec 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Beamanator left a comment

Choose a reason for hiding this comment

Uh oh!

TMisiukiewicz commented Dec 30, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Beamanator commented Dec 30, 2024

Uh oh!

VickyStash commented Dec 30, 2024

Uh oh!

Beamanator commented Dec 30, 2024

Uh oh!

shubham1206agra commented Dec 30, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Beamanator commented Dec 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OSBotify commented Dec 30, 2024

Uh oh!

github-actions bot commented Dec 30, 2024

Uh oh!

github-actions bot commented Dec 31, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Beamanator Dec 30, 2024 •

edited

Loading

Beamanator commented Dec 30, 2024 •

edited

Loading