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

Apple & Google Sign In #23673

Merged
merged 94 commits into from
Aug 17, 2023
Merged

Conversation

cdanwards
Copy link
Contributor

@cdanwards cdanwards commented Jul 26, 2023

Details

Fixed Issues

$ #7079

NOTE: Reading through contributingGuides/APPLE_GOOGLE_SIGNIN.md provides more details about testing in development as well as rationale for design decisions.

Tests

Apple Sign In

iOS

  • Ensure app builds correctly
  • Select the Apple Icon Button
  • Enter valid Apple ID and Password
  • If prompted, validate with 2 factor authentication
  • Select to share email with app
  • Select continue and sign in with Expensify
  • Ensure logged in correctly

Android

  • Ensure app builds correctly
  • Select the Apple Icon Button
  • Enter valid Apple ID and Password
  • If prompted, validate with 2 factor authentication
  • Select to share email with app
  • Select continue and sign in with Expensify
  • Ensure logged in correctly

Web

  • Ensure no errors in console
  • Select the Apple Icon Button
  • Ensure Pop Up window appears
  • Enter valid Apple ID and Password
  • If prompted, validate with 2 factor authentication
  • Select to share email with app, if prompted.
  • Select continue and sign in with Expensify
  • Ensure correct redirect to Expensify tab
  • Ensure login occurs

Desktop

  • Ensure no errors in console
  • Select the Apple Icon Button
  • Check that is redirects to web tab, url will be new.expensify.com/sign-in-with-apple (It will automatically redirect to home login because of redirects)
  • Navigate to staging.new.expensify.com/sign-in-with-apple
  • Ensure page loads and there is a Continue with Apple button.
  • Select Button
  • Go through web login flow
  • After successful login, ensure there is a prompt to go back to desktop app
  • Select option to navigate back to desktop app
  • Ensure successful navigation
  • Check for successful login once navigated back to desktop app

Google Sign In

iOS

  • Ensure app builds correctly
  • Select the Google Icon Button
  • Enter valid email and Password
  • If prompted, validate with 2 factor authentication
  • Ensure logged in correctly

Android

  • Ensure app builds correctly
  • Select the Google Icon Button
  • Enter valid email and Password
  • If prompted, validate with 2 factor authentication
  • Select to share email with app
  • Select continue and sign in with Expensify
  • Ensure logged in correctly

Web

  • Ensure no errors in console
  • Select the Google Icon Button
  • Ensure Pop Up window appears
  • Enter valid email and Password
  • If prompted, validate with 2 factor authentication
  • Select to share email with app, if prompted.
  • Ensure correct redirect to Expensify tab
  • Ensure login occurs

Desktop

  • Ensure no errors in console
  • Select the Google Icon Button
  • Check that is redirects to web tab, url will be new.expensify.com/sign-in-with-google (It will automatically redirect to home login because of redirects)
  • Navigate to staging.new.expensify.com/sign-in-with-google
  • Ensure page loads and there is a Continue with Google button.
  • Select Button
  • Go through web login flow
  • After successful login, ensure there is a prompt to go back to desktop app
  • Select option to navigate back to desktop app
  • Ensure successful navigation
  • Check for successful login once navigated back to desktop app

Offline tests

Feature is not available in offline mode

QA Steps

Same as Tests

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

Apple:

Apple.Web.Flow_LowRes.mp4

Google:

Google.Web.Flow_LowRes.mp4
Mobile Web - Chrome
Chrome.Mobile.Web_LowRes.mp4
Mobile Web - Safari
Safari.Mobile.Web_LowRes.mp4
Desktop

Apple:

Apple.Desktop.w.Redirect_LowRes.mp4

Google:

Google.Desktop.w.Redirect_LowRes.mp4
iOS
IOS_LowRes.mp4
Android
Android_LowRes.mp4

@cdanwards
Copy link
Contributor Author

Yeah! @situchan it's pretty easy to get your authToken and agent up and running. Here's the explanation on their site: https://dashboard.ngrok.com/get-started/setup - Once you login they list through the steps of setting it up and running the agent.

@situchan
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

@cdanwards
Copy link
Contributor Author

@marcochavezf are there any other checks we need to do to get this through?

Also, just to clarify. I'm going to create an issue preemptively for the Bug4 (COOP error likely from Google's GSI), were there any other errors that should have issues created to track? I know we solved the white background issue on dev by hiding the buttons on dev.

@marcochavezf
Copy link
Contributor

We're just tracking the issue here, we can link the bug4 there

@situchan
Copy link
Contributor

@marcochavezf We should test web based platforms after deploy to staging, right?

@marcochavezf
Copy link
Contributor

Yes, given the limitations to testing localhost in both platforms, I'm going to merge it to include it in today's deployment and test properly the remaining parts on staging

@marcochavezf marcochavezf merged commit 2b52597 into Expensify:main Aug 17, 2023
12 checks passed
@cdanwards
Copy link
Contributor Author

@marcochavezf just to make sure I'm on the same page. Link the conversation about bug4 in the tracking issue, or create a new issue about bug4 and link that in the tracking issue?

@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.

@marcochavezf
Copy link
Contributor

Ah sorry for the confusion @cdanwards, let's create a new issue for bug4 and link it to the tracking issue please

@cdanwards
Copy link
Contributor Author

@marcochavezf no worries! Just wanted to make sure I understood. I'll get that issue created!

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.3.56-0 🚀

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

@dangrous
Copy link
Contributor

Hi all! See the above deploy blocker - #25768 - Can we look into why that Google sign in button jumps on desktop Safari? Thanks!

@cdanwards
Copy link
Contributor Author

@dangrous Hey! I'm taking a look at this! We mainly tested on Chrome and Brave browsers during development and I haven't been able to reproduce there (We were informed that Firefox wasn't supported). Is Safari one of the supported browsers? It definitely seems like an issue of the iframe rendering and possible re-rendering the button and the styles being updated on a millisecond delay.

@dangrous
Copy link
Contributor

dangrous commented Aug 23, 2023

Yeah that's what I was thinking too. I wonder if we will need to apply the styles/width/height to an empty element and then replace it with the Google button when it's loaded, or something?

As for browsers, I'm confirming in Slack but it looks like Safari was on our QA test list so it seems like yes.

EDIT: confirmed, we support Safari

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

setHasShownPrompt(true);
} else {
// Navigation state is not set up yet, we're unsure if we should show the deep link prompt or not
if (currentScreen === undefined || isAuthenticated === false) {
Copy link
Contributor

Choose a reason for hiding this comment

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

In this context, why would we use isAuthenticated === false?

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@napster125 We don't want to show the deeplink prompt to unauthenticated users.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There's discussion of it within this feature's design document. Trying to find if we included that conversation in the contributing guide.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@parasharrajat
Copy link
Member

Google sign-in uses a system theme and adjusts coloring accordingly. We didn't handle the color scheme for this which caused a white background on the G-sign button. #25638

Comment on lines +69 to +80
if (!isMacOSWeb() || isUnsupportedDeeplinkRoute || CONFIG.ENVIRONMENT === CONST.ENVIRONMENT.DEV || hasShownPrompt) {
return;
}
// We want to show the prompt immediately if the user is already authenticated.
// Otherwise, we want to wait until the navigation state is set up
// and we know the user is on a screen that supports deeplinks.
if (isAuthenticated) {
promptToOpenInDesktopApp();
setHasShownPrompt(true);
} else {
// Navigation state is not set up yet, we're unsure if we should show the deep link prompt or not
if (currentScreen === undefined || isAuthenticated === false) {
Copy link
Contributor

Choose a reason for hiding this comment

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

These conditions did not consider opening magic link on logged in user, and caused this issue #32795

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants