[CP Staging] Fix crash when navigating to new public room #41219

MonilBhavsar · 2024-04-29T15:07:36Z

Details

Fixes a crash in ImageSVG component when we're trying to render an empty object

Fixed Issues

$ #41170
$ #41130
PROPOSAL:

Tests

Open any chat and paste Public room link (e.g. https://staging.new.expensify.com/r/2652281908731856)
Click on the link
Ensure chat opens and there is no crash

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open any chat and paste Public room link (e.g. https://staging.new.expensify.com/r/2652281908731856)
Click on the link
Ensure chat opens and there is no crash

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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 verified the translation was requested/reviewed 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.js 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.
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

See MacOS: Chrome / Safari

Android: mWeb Chrome

See MacOS: Chrome / Safari

iOS: Native

See MacOS: Chrome / Safari

iOS: mWeb Safari

See MacOS: Chrome / Safari

MacOS: Chrome / Safari

Screen.Recording.2024-04-29.at.8.41.51.PM.mov

MacOS: Desktop

See MacOS: Chrome / Safari

melvin-bot · 2024-04-29T15:14:24Z

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

MonilBhavsar · 2024-04-29T15:15:13Z

Minor change, seeking internal review

puneetlath · 2024-04-29T15:20:56Z

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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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.js 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.
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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-04-29.at.11.32.26.AM.mov

MacOS: Desktop

puneetlath · 2024-04-29T15:35:36Z

src/libs/SidebarUtils.ts

@@ -413,7 +413,7 @@ function getOptionData({
    result.subtitle = subtitle;
    result.participantsList = participantPersonalDetailList;

-    result.icons = ReportUtils.getIcons(report, personalDetails, UserUtils.getAvatar(personalDetail?.avatar ?? {}, personalDetail?.accountID), '', -1, policy);
+    result.icons = ReportUtils.getIcons(report, personalDetails, UserUtils.getAvatar(personalDetail?.avatar ?? '', personalDetail?.accountID), '', -1, policy);


It's weird that the {} doesn't throw a type error. Do you think we should add avatarSource is string | undefined like we do here.

I think it returns if avatar source is string or undefined and if we should use default avatar. It does not necessarily ensure type. we can have something like -

if (typeof(avatarSource) !== string or typeof(avatarSource) !== undefined) throw TypeCheckError;

Let's discuss in slack and do as a follow up?

I think we should just add a empty object check in ReportUtils.getIcons. When it's empty, we can just use the FallbackAvatar. Right now empty object is still a valid for the AvatarSource type so someone can still re-introduce this bug without noticing.

I think we should just add a empty object check in ReportUtils.getIcons

It doesn't fully solve the concern of reintroducing this crash again, no? There are other places too where we call Avatar methods - getAvatar() and AvatarSource argument type is {} and it is returned as {} causing such crashes

Right now empty object is still a valid for the AvatarSource type so someone can still re-introduce this bug without noticing.

Right, how about throwing as mentioned above

It doesn't fully solve the concern of reintroducing this crash again, no?

For this crash it would. The root problem was that ReportUtils.getIcons is returning an invalid source when given certain params. I think we should just fix that by validating the params and returning the fallback if validation fails. We can write a isValidAvatarSource function and use it where needed.

Right, how about throwing as mentioned above

I'm not sure how that helps honestly. Does that not also crash the app?

For this crash it would. The root problem was that ReportUtils.getIcons is returning an invalid source when given certain params. I think we should just fix that by validating the params and returning the fallback if validation fails

Agree with this. I meant if we have this logic at lower level function like getAvatar(), it would help us to catch all errors as ReportUtils.getIcons was getting defaultIcon argument that resulted from getAvatar()

We can write a isValidAvatarSource function and use it where needed

Sounds good 👍
and if the check fails, we return avatarSource as empty string, correct?

I'm not sure how that helps honestly. Does that not also crash the app?

Yes, if someone added such param then it would throw the error so we can catch it during testing

Oh okay I see. I think we should probably validate in both places just to be safe. For ReportUtils.getIcons I think we should just return the FallbackAvatar when the given AvatarSource is invalid. I'm not sure about other places though.

Yes, if someone added such param then it would throw the error so we can catch it during testing

We're already throwing an error and crashing the app as it is. So I don't think throwing a different error will make the bug more noticeable in testing. I think we should always avoid crashing the app and just log the error instead. That way we can still catch it in testing and if we don't, the app isn't crashing for users.

[CP Staging] Fix crash when navigating to new public room (cherry picked from commit 4db1763)

OSBotify · 2024-04-29T18:33:38Z

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 1.4.67-2 🚀

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

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

mountiny · 2024-04-29T19:28:03Z

@MonilBhavsar Can you please link the second blocker and add the QA steps so it also tests the second blocker (once applause retests)? Thanks!

OSBotify · 2024-04-29T23:14:31Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.67-7 🚀

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

OSBotify · 2024-04-30T00:42:00Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.67-7 🚀

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

Correct default parameter

3940e24

MonilBhavsar self-assigned this Apr 29, 2024

MonilBhavsar marked this pull request as ready for review April 29, 2024 15:14

MonilBhavsar requested a review from a team as a code owner April 29, 2024 15:14

melvin-bot bot requested review from Ollyws and removed request for a team April 29, 2024 15:14

MonilBhavsar changed the title ~~Fix crash when navigating to new public room~~ [CP Staging] Fix crash when navigating to new public room Apr 29, 2024

MonilBhavsar removed the request for review from Ollyws April 29, 2024 15:14

puneetlath approved these changes Apr 29, 2024

View reviewed changes

puneetlath reviewed Apr 29, 2024

View reviewed changes

MonilBhavsar merged commit 4db1763 into main Apr 29, 2024
21 of 23 checks passed

MonilBhavsar deleted the monil-fixCrash branch April 29, 2024 17:37

OSBotify pushed a commit that referenced this pull request Apr 29, 2024

Merge pull request #41219 from Expensify/monil-fixCrash

b9ee13c

[CP Staging] Fix crash when navigating to new public room (cherry picked from commit 4db1763)

github-actions bot mentioned this pull request Apr 29, 2024

Deploy Checklist: New Expensify 2024-04-26 #41122

Closed

63 tasks

MonilBhavsar mentioned this pull request Apr 29, 2024

[HOLD for payment 2024-05-08] [$250] App Crashes When Exiting and Re-entering Thread in Offline #41130

Closed

6 tasks

melvin-bot bot mentioned this pull request Apr 29, 2024

[HOLD for payment 2024-05-08] App crashes while trying to join public room via deep link #41170

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Fix crash when navigating to new public room #41219

[CP Staging] Fix crash when navigating to new public room #41219

MonilBhavsar commented Apr 29, 2024 •

edited

Loading

melvin-bot bot commented Apr 29, 2024

MonilBhavsar commented Apr 29, 2024

puneetlath commented Apr 29, 2024 •

edited

Loading

puneetlath Apr 29, 2024

MonilBhavsar Apr 29, 2024

arosiclair Apr 29, 2024

MonilBhavsar Apr 30, 2024 •

edited

Loading

arosiclair Apr 30, 2024

MonilBhavsar Apr 30, 2024

arosiclair May 1, 2024

OSBotify commented Apr 29, 2024

mountiny commented Apr 29, 2024

OSBotify commented Apr 29, 2024

OSBotify commented Apr 30, 2024

[CP Staging] Fix crash when navigating to new public room #41219

[CP Staging] Fix crash when navigating to new public room #41219

Conversation

MonilBhavsar commented Apr 29, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 29, 2024

MonilBhavsar commented Apr 29, 2024

puneetlath commented Apr 29, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

puneetlath Apr 29, 2024

Choose a reason for hiding this comment

MonilBhavsar Apr 29, 2024

Choose a reason for hiding this comment

arosiclair Apr 29, 2024

Choose a reason for hiding this comment

MonilBhavsar Apr 30, 2024 • edited Loading

Choose a reason for hiding this comment

arosiclair Apr 30, 2024

Choose a reason for hiding this comment

MonilBhavsar Apr 30, 2024

Choose a reason for hiding this comment

arosiclair May 1, 2024

Choose a reason for hiding this comment

OSBotify commented Apr 29, 2024

mountiny commented Apr 29, 2024

OSBotify commented Apr 29, 2024

OSBotify commented Apr 30, 2024

MonilBhavsar commented Apr 29, 2024 •

edited

Loading

puneetlath commented Apr 29, 2024 •

edited

Loading

MonilBhavsar Apr 30, 2024 •

edited

Loading