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 App show error when open unlink in Desktop App #23738

Merged
merged 15 commits into from
Aug 11, 2023

Conversation

hoangzinh
Copy link
Contributor

@hoangzinh hoangzinh commented Jul 27, 2023

Details

Fixed Issues

$ #19681
PROPOSAL: #19681 (comment)

Tests

On Web/mWeb

  1. Add a secondary login account, and leave it unverified
  2. Sign out and sign in to the secondary login account above
  3. Click on Unlink button
  4. Open email account, click on 'the validation link here' to unlink the account
  5. Verify that the page shows "Secondary login successfull unlinked" message

On Desktop
Ensure you logged out Expensify account in Web browser

  1. Add a secondary login account, and leave it unverified
  2. Sign out and sign in to the secondary login account above
  3. Click on Unlink button
  4. Open email account in Web browser, click on 'the validation link here' to unlink the account
  5. Verify that the link opened in Web browser and there is no prompt to open the link in Desktop
  6. Verify that the Web browser shows "Secondary login successfull unlinked" message

On Native apps
Ensure you logged out Expensify account in Web browser

  1. Add a secondary login account, and leave it unverified
  2. Sign out and sign in to the secondary login account above
  3. Click on Unlink button
  4. Open email account, click on 'the validation link here' to unlink the account
  5. Verify that the Native app shows "Secondary login successfull unlinked" message
  • Verify that no errors appear in the JS console

Offline tests

Can not test when offline

QA Steps

Same as Tests

  • 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
    • 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 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
Screen.Recording.2023-08-04.at.09.06.42.-.web.mp4
Mobile Web - Chrome
Screen.Recording.2023-07-27.at.23.04.03.-.android.chrome.mov
Mobile Web - Safari
Screen.Recording.2023-07-27.at.22.53.01.-.ios.safari.mov
Desktop
Screen.Recording.2023-07-27.at.22.48.17.-.desktop.mp4
iOS
Screen.Recording.2023-07-27.at.23.02.10.-.ios.mp4
Android
Screen.Recording.2023-07-27.at.23.05.56.-.android.mp4

@hoangzinh hoangzinh marked this pull request as ready for review July 27, 2023 16:15
@hoangzinh hoangzinh requested a review from a team as a code owner July 27, 2023 16:15
@melvin-bot melvin-bot bot removed the request for review from a team July 27, 2023 16:15
@melvin-bot
Copy link

melvin-bot bot commented Jul 27, 2023

@Santhosh-Sellavel 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]

@Santhosh-Sellavel
Copy link
Collaborator

@hoangzinh I find the Desktop steps confusing.

Verify that the link opened in a Web browser and there is no prompt to open the link in the Desktop

We won't show open in the desktop prompt for the dev environment. Have you checked by removing the restriction does it still work?

src/ROUTES.js Outdated
Comment on lines 190 to 193

ROUTES_REGEX: {
UNLINK_LOGIN: /\/u($|(\/\/*))/,
},
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is it okay to be here? I think its better to be on CONST

Thoughts @francoisl?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah agreed. Looks like we even already have a REGEX object, which has a similar ROUTES sub-object here. That sounds like a good place to put this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated PR to move this const to CONST

@hoangzinh
Copy link
Contributor Author

@hoangzinh I find the Desktop steps confusing.

Verify that the link opened in a Web browser and there is no prompt to open the link in the Desktop

We won't show open in the desktop prompt for the dev environment. Have you checked by removing the restriction does it still work?

@Santhosh-Sellavel definitely I did. In my recording, I also tried to show it show the desktop prompt for the home url

@Santhosh-Sellavel
Copy link
Collaborator

Will get to this tomorrow, please get this done @hoangzinh

Comment on lines 41 to 42
// Function to detect if current route should open in Web only.
isUnsupportedDeeplinkRoute() {
Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel Jul 31, 2023

Choose a reason for hiding this comment

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

Comment can be more user friendly

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you have any suggestion @Santhosh-Sellavel I think current comment is clear to me.

@Santhosh-Sellavel
Copy link
Collaborator

Seems to be tested well, After clicking the link we are redirected to the home page with a success message, but the unlink page is shown for a while after opening the link for unlinking is it a problem?

i.e This page is shown for a while
Screenshot 2023-08-02 at 6 29 45 AM

cc: @hoangzinh @francoisl

@hoangzinh
Copy link
Contributor Author

@Santhosh-Sellavel It's not good UX, I think. What is the expected behavior here?:

  • Option 1: Show full loading page
  • Option 2: Redirect to the Login page first, then call API unlink, then show error/success.

@Santhosh-Sellavel
Copy link
Collaborator

@francoisl @NikkiWines What can we do here?

@francoisl
Copy link
Contributor

Some sort of loading indicator sounds best to me (whether full page or not). We already set isLoading: true for the Account key here when we make the API request, can we piggy-back on that to know that the unlinking is in progress?

Comment on lines 41 to 47
// A function to detect if current route should be opened in Web only.
isUnsupportedDeeplinkRoute() {
return _.some([CONST.REGEX.ROUTES.UNLINK_LOGIN], (unsupportRouteRegex) => {
const routeRegex = new RegExp(unsupportRouteRegex);
return routeRegex.test(window.location.pathname);
});
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

The method name looks sufficient. Instead, we could have a comment inside explaining why the unlink login path was added here. Thoughts?

cc: @hoangzinh @francoisl

Copy link
Contributor

Choose a reason for hiding this comment

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

(Personal preference) I don't mind the comment outside the function, even if the name sounds sufficient. But overall neutral, I'm ok if we keep it or remove it.

However, yes a comment inside explaining why the unlink route is there sounds like a good idea to me!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added the comment inside this func. Please help me review it again. Thanks

@hoangzinh
Copy link
Contributor Author

hoangzinh commented Aug 4, 2023

Some sort of loading indicator sounds best to me (whether full page or not). We already set isLoading: true for the Account key here when we make the API request, can we piggy-back on that to know that the unlinking is in progress?

@Santhosh-Sellavel @francoisl I just updated with the full page loading, as a simplest implement. Because if we go with not full page loading, we need to involve Designer/UX into and discuss where should we display loading indicator.

I also recorded this full page loading in the Web section of this PR description.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Aug 7, 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 / 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 & Desktop
Unlink.mov
Mobile Web - Chrome
Screen.Recording.2023-08-08.at.12.01.25.AM.mov
Mobile Web - Safari

Simulator Screenshot - iPhone 14 - 2023-08-07 at 23 56 46

iOS
Simulator.Screen.Recording.-.iPhone.14.-.2023-08-08.at.00.13.57.mp4
Android
Screen.Recording.2023-08-10.at.8.14.58.AM.mov

@Santhosh-Sellavel
Copy link
Collaborator

Please resolve conflicts @hoangzinh!

@Santhosh-Sellavel
Copy link
Collaborator

bump @hoangzinh!

@hoangzinh
Copy link
Contributor Author

@Santhosh-Sellavel sorry I was off yesterday. I just resolved conflict of this PR. Could you help to review it again? Thanks

Comment on lines 21 to 29
const isUnsupportedDeeplinkRoute = useMemo(
() =>
// According to the design, we don't support unlink in Desktop app https://github.com/Expensify/App/issues/19681#issuecomment-1610353099
_.some([CONST.REGEX.ROUTES.UNLINK_LOGIN], (unsupportRouteRegex) => {
const routeRegex = new RegExp(unsupportRouteRegex);
return routeRegex.test(window.location.pathname);
}),
[],
);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do we need to memorize this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's an expensive calculator (loop through array and do regex) so I prefer memo it to prevent it rerun every time the component re-render.

Copy link
Collaborator

Choose a reason for hiding this comment

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

1 value in array I don't think its expensive. Let's just have a definition and use it.

Copy link
Contributor Author

@hoangzinh hoangzinh Aug 10, 2023

Choose a reason for hiding this comment

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

I just updated the PR. Please help me review it again. Thanks

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@Santhosh-Sellavel
Copy link
Collaborator

@francoisl bump!

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.

LGTM, thanks for pushing this through to the end.

@francoisl francoisl merged commit 7aac7fa into Expensify:main Aug 11, 2023
12 of 13 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.54-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.54-13 🚀

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

return;
}

Navigation.navigate(ROUTES.HOME);
Copy link
Member

Choose a reason for hiding this comment

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

Hey, this line caused a bug - #36618

RCA is here.

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.

5 participants