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 infinite loader when using attachments deeplink #24210

Conversation

huzaifa-99
Copy link
Contributor

@huzaifa-99 huzaifa-99 commented Aug 7, 2023

Details

Fixed Issues

$ #23899
PROPOSAL: #23899 (comment)

Tests

Case 1: Using deeplink after logout (logout -> Use deep link -> login)

  1. Open a chat that has some attachments, open any attachment and copy the url
  2. Logout
  3. Paste the URL in browser
  4. Now enter your email and login
  5. Verify that after login the attachment modal opens up and you see the attachments

Case 2: For small screens only (mWeb and mobile native) - Using deeplink after login (login -> from LHN open deep link)

  1. Open a chat that has some attachments, open any attachment and copy the url
  2. Logout
  3. Login
  4. Paste the URL in browser
  5. Verify that the attachment modal opens up and you see the attachments
  • Verify that no errors appear in the JS console

Offline tests

Same as "Tests" section above

QA Steps

Same as "Tests" section above

  • 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 / Chrome
    • iOS / native
    • iOS / 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
      • 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Chrome

Web.Chrome.mp4

Safari

Web.Safari.mp4
Mobile Web - Chrome
mWeb.Chrome.mp4
Mobile Web - Safari
mWeb.Safari.mp4
Desktop
Desktop.Native.mp4
iOS
IOS.Native.mp4
Android
Android.Native.mp4

@huzaifa-99 huzaifa-99 requested a review from a team as a code owner August 7, 2023 13:03
@melvin-bot melvin-bot bot requested review from allroundexperts and removed request for a team August 7, 2023 13:03
@melvin-bot
Copy link

melvin-bot bot commented Aug 7, 2023

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

@huzaifa-99
Copy link
Contributor Author

huzaifa-99 commented Aug 7, 2023

@allroundexperts from here

On a side note, @huzaifa-99 you have to clear the app from memory before opening the deep link in native. Otherwise, it won't work.

This doesn't seem to work with native ios/android devices when using deep link after logout. I tried to clear both the native project build folders + stimulator installations, but no luck. It does work tho after login, for which I have added the test videos.

I have not added test videos for case 1 for android/ios native, other videos are complete.

Case 1: Using deeplink after logout (logout -> Use deep link -> login)

I have asked in slack for the time being

Any help is appreciated. Thanks

@huzaifa-99
Copy link
Contributor Author

Ok, so a lot of changes to AttachmentCarousel got merged just some time ago. Will fix the conflicts soon and upload retested videos

@allroundexperts
Copy link
Contributor

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 / Chrome
    • iOS / native
    • iOS / 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 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 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(themeColors.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 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

Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@huzaifa-99
Copy link
Contributor Author

Bump on this message, @allroundexperts

@allroundexperts
Copy link
Contributor

Bump on this message, @allroundexperts

This normally does work. I'm not sure what the exact issue is here. I'll test on my side once the code is ready.

@huzaifa-99
Copy link
Contributor Author

Bump on this message, @allroundexperts

This normally does work. I'm not sure what the exact issue is here. I'll test on my side once the code is ready.

The code is ready from my side, unless you have some feedback? I replied to your earlier comment here.

The only thing left from my side is to test Case 1 from OP

Case 1: Using deeplink after logout (logout -> Use deep link -> login)

on android and ios native.

@allroundexperts
Copy link
Contributor

I have replied there already.

@huzaifa-99
Copy link
Contributor Author

I have replied there already.

Thanks, looking into it

@huzaifa-99
Copy link
Contributor Author

I think we need a better solution here. I'm not entirely convinced that we should be getting the same thing from different places within a single file.

Updated the logic in efab87a

@huzaifa-99
Copy link
Contributor Author

Gentle bump on this @allroundexperts

@huzaifa-99
Copy link
Contributor Author

huzaifa-99 commented Oct 25, 2023

Update

Recap -> We have 2 test cases

  • Case 1: Using attachment deep link after logout and then login => logout -> Use deep link -> login
  • Case 2: Using attachment deep link after login => login -> Use deep link

Case 2 is only for small screens i.e mWeb and mobile native


Case 2 doesn't work on iOS/Android native devices because deep links don't work after logout. Fails with a navigation error

Screenshot image

we already have an issue to handle that error -> #27168
also it's PR was merged -> #28278
but later got reverted -> #29706
due to a deploy blocker / regression -> #29642

Applying the diff in #28278 solved our issue (using deep link after logout and then logging in -> case 2).


I think we should wait for #27168 to get this resolved.

cc: @allroundexperts

@huzaifa-99
Copy link
Contributor Author

Update: #27168 is still in progress

@huzaifa-99
Copy link
Contributor Author

Update: #27168 still in progress

@huzaifa-99
Copy link
Contributor Author

Update: same as above

@huzaifa-99
Copy link
Contributor Author

huzaifa-99 commented Dec 13, 2023

Update:

#27168 got a new PR merged #31316. I have updated this PR with relevant changes and now all works as expected. I will upload the latest test videos soon.

@huzaifa-99
Copy link
Contributor Author

Bump for review @allroundexperts.

1 similar comment
@huzaifa-99
Copy link
Contributor Author

Bump for review @allroundexperts.

@allroundexperts
Copy link
Contributor

@huzaifa-99 Can you please resolve the conflicts here?

@huzaifa-99
Copy link
Contributor Author

Done @allroundexperts

@allroundexperts
Copy link
Contributor

@huzaifa-99 #31316 seems to have been reverted. Can you please confirm if your changes are still valid?

@allroundexperts
Copy link
Contributor

On Desktop web, I'm getting the following:

Screen.Recording.2024-01-14.at.1.20.40.AM.mov

@mallenexpensify
Copy link
Contributor

I think we should wait for #27168 to get this resolved.

The above was closed, it was not reproducible.

Should we proceed here now?

@allroundexperts
Copy link
Contributor

I think that this PR is way outdated now. It would be better in my opinion to get new proposals and follow on from there.

@mallenexpensify
Copy link
Contributor

I added the retest-weekly label to the GH. Let's see if QA is able to reproduce then we'll go from there.

@huzaifa-99
Copy link
Contributor Author

Apologies for the late reply

I think that this PR is way outdated now. It would be better in my opinion to get new proposals and follow on from there.

I think it would be good, as I don't have availability for 2 weeks. Thanks.

@mallenexpensify
Copy link
Contributor

Thanks @huzaifa-99 , going to close this out. Will keep the issue open for now, pending retest results

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.

3 participants