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

[MacOS Electron Popup] allow deeplink popup for all routes on mac #16869

Merged
merged 3 commits into from
Apr 10, 2023
Merged

[MacOS Electron Popup] allow deeplink popup for all routes on mac #16869

merged 3 commits into from
Apr 10, 2023

Conversation

Prince-Mendiratta
Copy link
Contributor

@Prince-Mendiratta Prince-Mendiratta commented Apr 3, 2023

Details

With this PR, we allow all routes to new expensify to show the option to show the "Open link in New Expensify?" desktop app popup.

Specifically, these changes were brought forward to support the desktop app popup when transitioning from old expensify to new expensify via the concierge button on old expensify.

Fixed Issues

$ #16083
PROPOSAL: #16083 (comment)

Tests

We need to check for the deeplink popup when transitioning from old expensify to new expensify via the concierge button on old expensify.

It is slightly complicated to test this functionality locally since we disable the popups in dev environment. To setup the development environment, please do the following:

  1. Checkout this PR locally.
  2. Change the following lines to remove the environment check:
  1. Run npm run web.
  2. Download the production Desktop App from new.expensify.com.

To continue testing the PR,

  1. Open expensify.com, login with account A.
  2. Run app on localhost and login with same account.
  3. Open the Desktop app and login with account A. You can close the app now.
  4. Click on the concierge button at bottom right on expensify.com/inbox
  5. Now, the thing here is that it'll redirect to new.expensify.com, which is not where we want to test. As soon as you click on the button, you'll be redirected. Try to copy the link as soon as possible. It'll be of the format:
https://new.expensify.com/transition?accountID=[REDACTED]&email=[REDACTED]&shortLivedAuthToken=[REDACTED]&encryptedAuthToken=[REDACTED]&exitTo=r%2F&shouldForceLogin=true
  1. Once you copy the link, change the scheme and host to:
http://localhost:8080/transition?accountID=[REDACTED]&email=[REDACTED]&shortLivedAuthToken=[REDACTED]&encryptedAuthToken=[REDACTED]&exitTo=r%2F&shouldForceLogin=true
  1. Ensure that you are shown the "Open app in "New Expensify" popup.

Note: Technically the concierge chat should be opened in ND but that is not the case. It is an unrelated bug to this PR and has been reported here.

  • Verify that no errors appear in the JS console

Offline tests

N/A.

QA Steps

  1. Open staging.expensify.com, login with account A.
  2. Open staging.new.expensify.com and login with same account.
  3. Download and open the staging Desktop App, if you haven't already.
  4. Click on the concierge button at bottom right on staging.expensify.com/inbox
  5. Ensure that you are shown the "Open app in "New Expensify" popup.
  • 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 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 correct English and 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
    • 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 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

Haven't uploaded videos for platform other than MacOS Web because:

  1. The desktop app popup is available only for MacOS.
  2. You cannot open Old dot on desktop app.

Do bring this up if you disagree.

MacOS [Web]
web1.mp4

@Prince-Mendiratta Prince-Mendiratta requested a review from a team as a code owner April 3, 2023 13:51
@melvin-bot melvin-bot bot requested review from iwiznia and rushatgabhane and removed request for a team April 3, 2023 13:51
@MelvinBot
Copy link

@iwiznia @rushatgabhane One of you needs to 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]

@rushatgabhane
Copy link
Member

rushatgabhane commented Apr 3, 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 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 correct English and 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 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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

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

@rushatgabhane
Copy link
Member

rushatgabhane commented Apr 3, 2023

@Prince-Mendiratta QA steps can be simplified because the concierge link on staging.expensify.com redirects to staging on new dot.

Proposed QA steps:

  1. Download and open the staging Desktop if you haven't already.
  2. Open staging.expensify.com and login
  3. Click on the concierge button at bottom right on staging.expensify.com/inbox

Can you please update the OP if you agree?

@rushatgabhane
Copy link
Member

@Prince-Mendiratta the test steps on dev could be simplified as well.

  1. Make sure you have the desktop app installed
  2. Open links like [localhost:8080, localhost:8080/settings, localhost:8080/iou/request etc] in a new browser.
  3. Verify that you see a opne in desktop app popup

@Prince-Mendiratta
Copy link
Contributor Author

@rushatgabhane

QA steps can be simplified because the concierge link on staging.expensify.com redirects to staging on new dot.

That's great, I have updated the OP description.

the test steps on dev could be simplified as well.
2. Open links like [localhost:8080, localhost:8080/settings, localhost:8080/iou/request etc] in a new browser.

I don't think we should reduce the test steps to just this, since we need to test the functionality when transitioning from Old Dot. As for the other routes, it already should work since we haven't modified anything that affects them. What do you think?

@rushatgabhane
Copy link
Member

cool

Signed-off-by: Prince Mendiratta <[email protected]>
@Prince-Mendiratta
Copy link
Contributor Author

Prince-Mendiratta commented Apr 4, 2023

@rushatgabhane looks like some quite significant changes were introduced to this component yesterday with #16043. I've tested locally and it works well but can you please take a look as well at the latest conflict resolution and confirm that the changes are aligned with the logic behind this issue and #16043 ?

cc @ntdiary @pecanoro

@Prince-Mendiratta
Copy link
Contributor Author

gentle bump @rushatgabhane

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.

@iwiznia LGTM!

@Prince-Mendiratta
Copy link
Contributor Author

Bump @iwiznia

@iwiznia iwiznia merged commit 41a629d into Expensify:main Apr 10, 2023
@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/iwiznia in version: 1.2.99-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.2.99-6 🚀

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

Comment on lines -69 to -72
if (!matchedRoute) {
this.updateAppInstallationCheckStatus();
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

This caused a regression #23409. After allowing all the routes to use the short lived auth token (which is triggered after the highlighted code snippet) the magic login link didn't work correctly because of the existed auth token (the one that that we attach to each url). Magic link only works if no auth token is supplied otherwise we'd be stuck on the account that we used on Web.

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.

6 participants