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

show loading indicator when policy is loading #29842

Conversation

c3024
Copy link
Contributor

@c3024 c3024 commented Oct 18, 2023

Details

Fixed Issues

$ #28402
PROPOSAL: #28402 (comment)

Tests

Test 1

  1. Create a workspace X from user A
  2. Go to the workspace X -> Members -> Invite and copy the URL
  3. From another device, login with user B and open this link copied in Step 2
  4. Verify that the invite page is not briefly shown. Instead, a loading indicator is shown during this time till the policy is loaded.

Test 2

  1. Create a workspace X from user A
  2. Go to the workspace X -> Members and copy the URL
  3. From another device, login with user B and open this link copied in Step 2
  4. Verify that the members page is not briefly shown. Instead, a loading indicator is shown during this time till the policy is loaded.

Test 3

  1. Create a workspace X from user A
  2. Go to the workspace X -> Settings -> Currency and copy the URL
  3. From another device, login with user B and open this link copied in Step 2
  4. Verify that the currency page is not briefly shown. Instead, a loading indicator is shown during this time till the policy is loaded.

Test 4

  1. Create a workspace X from user A
  2. Invite user B to this workspace
  3. Go to the workspace X -> Members -> Invite and copy the URL
  4. From another device, login with user B and open this link copied in Step 3
  5. Verify that the not found page is shown immediately

Test 5

  1. Create a workspace X from user A
  2. Invite user B to this workspace
  3. Go to the workspace X -> Members and copy the URL
  4. From another device, login with user B and open this link copied in Step 3
  5. Verify that the not found page is shown immediately

Test 6

  1. Create a workspace X from user A
  2. Invite user B to this workspace
  3. Go to the workspace X -> Settings -> Currency and copy the URL
  4. From another device, login with user B and open this link copied in Step 3
  5. Verify that the not found page is shown immediately
  • Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Test 1

  1. Create a workspace X from user A
  2. Go to the workspace X -> Members -> Invite and copy the URL
  3. From another device, login with user B and open this link copied in Step 2
  4. Verify that the invite page is not briefly shown. Instead, a loading indicator is shown during this time till the policy is loaded.

Test 2

  1. Create a workspace X from user A
  2. Go to the workspace X -> Members and copy the URL
  3. From another device, login with user B and open this link copied in Step 2
  4. Verify that the members page is not briefly shown. Instead, a loading indicator is shown during this time till the policy is loaded.

Test 3

  1. Create a workspace X from user A
  2. Go to the workspace X -> Settings -> Currency and copy the URL
  3. From another device, login with user B and open this link copied in Step 2
  4. Verify that the currency page is not briefly shown. Instead, a loading indicator is shown during this time till the policy is loaded.

Test 4

  1. Create a workspace X from user A
  2. Invite user B to this workspace
  3. Go to the workspace X -> Members -> Invite and copy the URL
  4. From another device, login with user B and open this link copied in Step 3
  5. Verify that the not found page is shown immediately

Test 5

  1. Create a workspace X from user A
  2. Invite user B to this workspace
  3. Go to the workspace X -> Members and copy the URL
  4. From another device, login with user B and open this link copied in Step 3
  5. Verify that the not found page is shown immediately

Test 6

  1. Create a workspace X from user A
  2. Invite user B to this workspace
  3. Go to the workspace X -> Settings -> Currency and copy the URL
  4. From another device, login with user B and open this link copied in Step 3
  5. Verify that the not found page is shown immediately
  • 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 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
    • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

MacOS: Chrome / Safari Test 1
webChrome-loadingInvite-test1.mp4

Test 2

webChrome-loadingMembers-test2.mp4

Test 3

webChrome-loadingCurrency-test3.mp4

Test 4

webChrome-test4.mp4

Test 5

webChrome-test5.mp4

Test 6

webChrome-test6.mp4
Android: Native
androidNativeInviteMissing.mov
Android: mWeb Chrome
mWebChromeInvitePage-compressed.mp4
iOS: Native
iOSNative.mov
iOS: mWeb Safari
iOS-Safari.mov
MacOS: Desktop
desktop-loadingInvite.mp4

@c3024 c3024 marked this pull request as ready for review October 18, 2023 05:04
@c3024 c3024 requested a review from a team as a code owner October 18, 2023 05:04
@melvin-bot melvin-bot bot removed the request for review from a team October 18, 2023 05:04
@melvin-bot
Copy link

melvin-bot bot commented Oct 18, 2023

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

@c3024
Copy link
Contributor Author

c3024 commented Oct 19, 2023

Bump @rushatgabhane

@rushatgabhane
Copy link
Member

rushatgabhane commented Oct 20, 2023

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 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
Screen.Recording.2023-10-20.at.10.33.55.mov
Mobile Web - Chrome

Uploading Screen Recording 2023-10-20 at 10.43.50.mov…

Mobile Web - Safari

Uploading Screen Recording 2023-10-20 at 10.43.50.mov…

Desktop
Screen.Recording.2023-10-20.at.10.41.22.mov
iOS
Screen.Recording.2023-10-20.at.10.37.52.mov
Android
Screen.Recording.2023-10-20.at.10.39.21.mov

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@francoisl LGTM!

For context, other pages are already using withPolicyAndFullscreenLoading

@melvin-bot melvin-bot bot requested a review from francoisl October 20, 2023 05:14
Copy link
Contributor

@francoisl francoisl left a comment

Choose a reason for hiding this comment

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

Nice

@francoisl francoisl merged commit 86e75ad into Expensify:main Oct 20, 2023
23 of 24 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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/francoisl in version: 1.3.88-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.88-11 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 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