Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix infinitely loading Of Attachment from qa.guide when opened in Search #50427

Merged
merged 11 commits into from
Oct 11, 2024

Conversation

shahinyan11
Copy link

@shahinyan11 shahinyan11 commented Oct 8, 2024

Details

Fixed Issues

$ #50006
PROPOSAL: #50006 (comment)

Tests

  1. Go to staging.new.expensify.com
  2. Go to DM
  3. Send the following message. (The message is from [email protected] in #admins)
    !(https://d2k5nsl2zxldvw.cloudfront.net/images/animations/animation_setupguide.gif)
  4. Go to Search > Chat
  5. Click on the message sent in Step 3
  6. Make sure the attachment model does not have an infinite load.
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as in the Tests section.

  • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
Screen.Recording.2024-10-08.at.16.18.32.mov
Android: mWeb Chrome
Screen.Recording.2024-10-08.at.15.38.46.mov
iOS: Native
Untitled.mov
iOS: mWeb Safari
Screen.Recording.2024-10-08.at.15.49.20.mov
MacOS: Chrome / Safari
Screen.Recording.2024-10-08.at.15.25.23.mov
MacOS: Desktop
Screen.Recording.2024-10-08.at.15.52.45.mov

@shahinyan11 shahinyan11 requested a review from a team as a code owner October 8, 2024 14:55
@melvin-bot melvin-bot bot requested review from suneox and removed request for a team October 8, 2024 14:55
Copy link

melvin-bot bot commented Oct 8, 2024

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

src/ROUTES.ts Outdated Show resolved Hide resolved
@suneox
Copy link
Contributor

suneox commented Oct 8, 2024

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
Screen.Recording.2024-10-08.at.23.22.10.mp4
Android: mWeb Chrome
Screen.Recording.2024-10-08.at.23.20.47.mp4
iOS: Native
Screen.Recording.2024-10-08.at.23.24.13.mp4
iOS: mWeb Safari
Screen.Recording.2024-10-08.at.23.29.01.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-10-08.at.23.17.21.mp4
MacOS: Desktop
Screen.Recording.2024-10-08.at.23.19.24.mp4

Console Warning: Function components cannot be given refs has raised on slack
Console Warning: TRenderEngineProvider: Support for defaultProps has raised on slack

@suneox
Copy link
Contributor

suneox commented Oct 8, 2024

@shahinyan11 Please fix the ESLint check

@shahinyan11
Copy link
Author

shahinyan11 commented Oct 8, 2024

@shahinyan11 Please fix the ESLint check

@suneox ESLint error related to using useOnyx instead of withOnyx. Shouldn't this be done as a separate task?

@suneox
Copy link
Contributor

suneox commented Oct 8, 2024

@suneox ESLint error related to using useOnyx instead of withOnyx. Shouldn't this be done as a separate task?

Ah, this error is not related to the scope change of this issue, we can skip this one.

@shahinyan11
Copy link
Author

@suneox Is there anything else I need to do?

@suneox
Copy link
Contributor

suneox commented Oct 8, 2024

@suneox Is there anything else I need to do?

@shahinyan11 Nope, another refactor will handle ESLint for this one.

Copy link
Contributor

@suneox suneox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pipeline fails due to the changed files, and the scope of this issue is not related to withOnyx, so we can handle replace withOnyx in another task

@melvin-bot melvin-bot bot requested a review from cead22 October 8, 2024 16:51
src/ROUTES.ts Outdated Show resolved Hide resolved
@cead22
Copy link
Contributor

cead22 commented Oct 8, 2024

Reminder from the updated contributing guidelines

Open a pull request. It is required to complete every step and check every box in the PR Author Checklist. If a box has been checked without the action being taken, it will be a violation of Rule #2 and could lead to a warning being issued.

This item is checked and there's a warning on videos in both the PR author and reviewer checklists. Can you please report it or open an issue for it and link it here?

  • 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)

@suneox
Copy link
Contributor

suneox commented Oct 8, 2024

@shahinyan11 could you please verify the author checklist item I verified there are no console errors? Last time, I only saw a pipeline error due to the Changed files ESLint check 🤔. Did we have any issue for this item?

@cead22
Copy link
Contributor

cead22 commented Oct 8, 2024

Let me know if there are more recent guidelines for updating withOnyx with useOnyx, but from this post, I think we should include those updates in this PR

@cead22
Copy link
Contributor

cead22 commented Oct 8, 2024

@shahinyan11 could you please verify the author checklist item I verified there are no console errors? Last time, I only saw a pipeline error due to the Changed files ESLint check 🤔. Did we have any issue for this item?

I unchecked this in both checklists because I saw console errors, and didn't see where those were fixed or reported

@suneox
Copy link
Contributor

suneox commented Oct 8, 2024

Let me know if there are more recent guidelines for updating withOnyx with useOnyx, but from this post, I think we should include those updates in this PR

@cead22 I got it, thank you for pointing this out!

@shahinyan11 We will handle pipeline in this PR

@shahinyan11
Copy link
Author

shahinyan11 commented Oct 8, 2024

@suneox What console error are you talking about? Do you mean TRenderEngineProvider: Support for defaultProps ?
And about migration to useOnex I have a doubts. We have a logic in memo which depends on props.user. is it worth deleting withOnyx in this case ?

@cead22
Copy link
Contributor

cead22 commented Oct 8, 2024

@suneox What console error are you talking about? Do you mean TRenderEngineProvider: Support for defaultProps ?

Yes, that one on the Android Native video on the submitter checklist and the iOS native on the reviewer checklist. And Function components cannot be given ref... on the iOS native video of the reviewer checklist

And about migration to useOnex I have a doubts. We have a logic in memo which depends on props.user. is it worth deleting withOnyx in this case ?

I'm not sure actually, can you ask in #expensify-open-source please?

@shahinyan11
Copy link
Author

@suneox @cead22 I have added discussion in Slack about ESLint error, but I do not know whose answer should I follow

@shahinyan11
Copy link
Author

Yes, that one on the Android Native video on the submitter checklist and the iOS native on the reviewer checklist. And Function components cannot be given ref... on the iOS native video of the reviewer checklist
ure actually, can you ask in #expensify-open-source please?

@cead22 That warning exists in the main branch and does not appear from my changes. What should I do in this case

@suneox
Copy link
Contributor

suneox commented Oct 9, 2024

@cead22 That warning exists in the main branch and does not appear from my changes. What should I do in this case

Regarding the console errors that were raised previously, and we have other issues being addressed in #49062 and #49035

@suneox
Copy link
Contributor

suneox commented Oct 9, 2024

@suneox @cead22 I have added discussion in Slack about ESLint error, but I do not know whose answer should I follow

@shahinyan11 I’ve provided a solution in your thread, and I’m also waiting for confirmation in the C+ thread

@shahinyan11
Copy link
Author

@shahinyan11 I’ve provided a solution in your thread, and I’m also waiting for confirmation in the C+ thread

Should I implement your solution now or wait for confirmation?

@suneox
Copy link
Contributor

suneox commented Oct 9, 2024

Should I implement your solution now or wait for confirmation?

I’m still waiting for feedback, let’s wait for a confirmation.

@shahinyan11
Copy link
Author

@cead22 Could I set this point as checked without any additional comments

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)

since @suneox reported it in this comment

@cead22
Copy link
Contributor

cead22 commented Oct 9, 2024

Yup, that's great. The process works :)

@cead22
Copy link
Contributor

cead22 commented Oct 10, 2024

@suneox can you give this another review please, since a few things changed? Thanks

@suneox
Copy link
Contributor

suneox commented Oct 10, 2024

@suneox can you give this another review please, since a few things changed? Thanks

Sure, I’ll start the review and retest in about an hour

@suneox
Copy link
Contributor

suneox commented Oct 10, 2024

@shahinyan11 Could you please sync with the latest main? I’d like to verify the re-render after migrate to useOnyx. Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don’t need to create a new file, we should just keep it in the ImageRenderer component as this pattern doesn’t exist in the code base

Copy link
Contributor

@suneox suneox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have verified that migrating to useOnyx keeps the render times the same for ImageRenderer component

@suneox
Copy link
Contributor

suneox commented Oct 11, 2024

I have verified that migrating to useOnyx keeps the render times the same for ImageRenderer component

@cead22 the new change has been reviewed

@cead22 cead22 merged commit 45a3a13 into Expensify:main Oct 11, 2024
17 checks passed
@OSBotify
Copy link
Contributor

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

Copy link
Contributor

🚀 Deployed to staging by https://github.com/cead22 in version: 9.0.49-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.49-2 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants