[No QA] Fix #15965 - Remove desktop app deep link on quit by allroundexperts · Pull Request #16650 · Expensify/App

allroundexperts · 2023-03-28T21:33:33Z

Details

This PR adds a callback to the Electron app when it is about to quit. The callback un-registers the electron app as default protocol client.

Fixed Issues

$ #15965
PROPOSAL: #15965 (comment)

Tests

Install the New Expensify Desktop app on your machine.
Start the local electron app by running npm run desktop.
Open any web browser and enter: new-expensify://test.
Verify that the browser shows a prompt mentioning Open with Electron App.
Close the local Electron app and re-enter new-expensify://test in the browser.
Verify that the browser shows a prompt mentioning Open with New Expensify App.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

No QA

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

screen-recording-2023-03-29-at-22207-am_gD3T0xeC.mp4

iOS

Android

MelvinBot · 2023-03-28T21:41:12Z

@neil-marcellini @eVoloshchak 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]

eVoloshchak · 2023-03-28T23:52:54Z

 // So we track preferredLocale separately via ELECTRON_EVENTS.LOCALE_UPDATED
 let preferredLocale = CONST.DEFAULT_LOCALE;

+const appProtocol = CONST.DEEPLINK_BASE_URL.replace('://', '');


There's also a scheme in electronBuilder.config.js

Hm... It lies outside of the desktop directory. I think the file won't get imported correctly.

Getting this:

allroundexperts · 2023-03-29T00:04:22Z

@eVoloshchak Can you please add @neil-marcellini to the assignee list of this PR? I think I accidentally removed his assignment.

neil-marcellini · 2023-03-29T09:44:36Z

@allroundexperts is this ready for my review?

allroundexperts · 2023-03-29T09:46:36Z

@allroundexperts is this ready for my review?

@neil-marcellini The PR in general is ready for review. I'm not sure if your review will come after @eVoloshchak has approved this.

neil-marcellini

It tests well and looks good. Awesome! Thank you.

neil-marcellini · 2023-03-29T11:47:46Z

All you @eVoloshchak. Testing should be pretty easy since this is only relevant to Desktop.

eVoloshchak · 2023-03-29T13:29:53Z

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

N/A

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop

Screen.Recording.2023-03-29.at.16.33.07.mov

iOS

N/A

Android

N/A

eVoloshchak

Looks good and tests well

This is affecting only developers, I don't know if QA can run dev version of the app to test this

allroundexperts · 2023-03-29T22:47:35Z

Thanks for the review @eVoloshchak!
@neil-marcellini All yours.

neil-marcellini · 2023-03-30T09:54:19Z

Cool, good point about the QA. I marked it [No QA] and removed the QA steps from the description.

OSBotify · 2023-03-30T09:58:14Z

✋ 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 · 2023-03-31T12:05:29Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.2.93-0 🚀

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

OSBotify · 2023-04-03T18:40:14Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.2.93-4 🚀

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

allroundexperts added 2 commits March 29, 2023 02:19

fix: remove electrons default protocol handler on dev

e0dd9d1

fix: added comment

48cd6ff

allroundexperts marked this pull request as ready for review March 28, 2023 21:41

allroundexperts requested a review from a team as a code owner March 28, 2023 21:41

melvin-bot Bot requested review from eVoloshchak and neil-marcellini and removed request for a team March 28, 2023 21:41

allroundexperts mentioned this pull request Mar 28, 2023

[HOLD for payment 2023-04-10] [$2000] Deep links from web fail to open in desktop #15965

Closed

6 tasks

eVoloshchak suggested changes Mar 28, 2023

View reviewed changes

Comment thread desktop/main.js Outdated

Comment thread desktop/main.js Outdated

fix: use url scheme from const file

4e89309

eVoloshchak suggested changes Mar 28, 2023

View reviewed changes

allroundexperts requested review from eVoloshchak and removed request for neil-marcellini March 28, 2023 23:59

allroundexperts marked this pull request as draft March 29, 2023 08:20

allroundexperts marked this pull request as ready for review March 29, 2023 08:20

allroundexperts changed the title ~~Fix #15965~~ Fix #15965 - Remove desktop app deep link on quit Mar 29, 2023

neil-marcellini self-requested a review March 29, 2023 09:42

neil-marcellini approved these changes Mar 29, 2023

View reviewed changes

eVoloshchak approved these changes Mar 29, 2023

View reviewed changes

neil-marcellini changed the title ~~Fix #15965 - Remove desktop app deep link on quit~~ [No QA] Fix #15965 - Remove desktop app deep link on quit Mar 30, 2023

neil-marcellini merged commit 46f8a36 into Expensify:main Mar 30, 2023

OSBotify mentioned this pull request Mar 31, 2023

Deploy Checklist: New Expensify 2023-03-31 #16787

Closed

20 tasks

Uh oh!

Conversation

allroundexperts commented Mar 28, 2023 • edited by neil-marcellini Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

MelvinBot commented Mar 28, 2023

Uh oh!

Uh oh!

Uh oh!

eVoloshchak Mar 28, 2023

Choose a reason for hiding this comment

Uh oh!

allroundexperts Mar 28, 2023

Choose a reason for hiding this comment

Uh oh!

allroundexperts Mar 28, 2023

Choose a reason for hiding this comment

Uh oh!

allroundexperts commented Mar 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

neil-marcellini commented Mar 29, 2023

Uh oh!

allroundexperts commented Mar 29, 2023

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

neil-marcellini commented Mar 29, 2023

Uh oh!

eVoloshchak commented Mar 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

eVoloshchak left a comment

Choose a reason for hiding this comment

Uh oh!

allroundexperts commented Mar 29, 2023

Uh oh!

neil-marcellini commented Mar 30, 2023

Uh oh!

OSBotify commented Mar 30, 2023

Uh oh!

OSBotify commented Mar 31, 2023

Uh oh!

OSBotify commented Apr 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

allroundexperts commented Mar 28, 2023 •

edited by neil-marcellini

Loading

allroundexperts commented Mar 29, 2023 •

edited

Loading

eVoloshchak commented Mar 29, 2023 •

edited

Loading