Apple sign-in

[lindboe]

Details

Fixed Issues

$ #7079
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

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

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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[github-actions]

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

[lindboe]

I have read the CLA Document and I hereby sign the CLA

[cdanwards]

I have read the CLA Document and I hereby sign the CLA

[curlyCoder15]

I have read the CLA Document and I hereby sign the CLA

[silasjmatson]

I have read the CLA Document and I hereby sign the CLA

[cdanwards]

@marcochavezf I'm unable to edit Lizzi's comment so I'll be posting the videos and testing instructions in comments.

[cdanwards]

Screenshots/Videos

Web

Low_Res_Web_AppleSignIn.mov

Mobile Web - Chrome

Low_Res_AndroidChrome_AppleSignIn.mov

Mobile Web - Safari

Low_Res_iOSSafari_AppleSignIn.mov

Desktop

Low_Res_Desktop_AppleSignIn.mov

iOS

Low_Res_iOS_AppleSignIn.mov

Android

Low_Res_Android_AppleSignIn.mov

[cdanwards]

Tests

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

Offline tests

Feature is not available in offline mode

QA Steps

Same as Tests

[melvin-bot]

@marcochavezf @thesahindia 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]

[marcochavezf]

@marcochavezf I'm unable to edit Lizzi's comment so I'll be posting the videos and testing instructions in comments.

Ok, I will update the OP with the instructions.

[marcochavezf]

Since we're rolling this out alongside a new feature allowing unauthenticated users to open public rooms, could you also run through these steps while testing? @cdanwards @rushatgabhane

1. Sign out
2. Open a public room (like the ExpensiConX #announce room or this other public room for testing)
3. Verify you can see the announce room as an anonymous user (random email).
4. Click on Sign in or any action that should not be allowed to an unauthenticated user
5. Verify you're redirected to the signin page
6. Enter email/phone
7. Enter magic code
8. Verify you can see the public room in the LHN
9. Repeat steps 1-5
10. Sign-in with Apple
11. Verify you can still see the public room in the LHN

If you find any issue let me know so I can fix it immediately

[rushatgabhane]

nitpick: the cursor should be of type pointer for the buttons

Screen.Recording.2023-05-31.at.23.52.30.mov

[rushatgabhane]

For mWeb view, the vertical margins don't look right.

[rushatgabhane]

I think this should be move to CONST file

[rushatgabhane]

why are we capitalizing the first letter of sign in provider?

could we add a comment above this on why we're doing it?

[cdanwards]

Removing this.

[OSBotify]

✋ 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]

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

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

[0xmiros]

Now that deployed to staging, gonna test web based platforms.
@marcochavezf should we announce in channel stop reporting bugs related to web apple sign-in? As we haven't tested yet.

At first, apple sign-in button doesn't show at all, which was reported earlier.

[ayazhussain79]

Apps not working getting this error

[0xmiros]

@ayazhussain79 did you run install npm and pod?

[ayazhussain79]

it is working now

[marcochavezf]

Hi @cdanwards @lindboe the PR was deployed to staging and seems there's an issue with CSP to load the apple script

[lindboe]

@marcochavezf as far as I'm aware, that's a backend change to add the script host (https://appleid.cdn-apple.com) to the script-src directive, right?

[mvtglobally]

@lindboe @marcochavezf @rushatgabhane @shawnborton We are facing the issue with the login. Should we log a bug, or its expected now?

Recording.83.1.mp4

[marcochavezf]

Hmm this a bug but I think we should need to revert until we fix the CSP issue. @roryabraham given how the app is hosted for web, I think we'd to wait until NewDot is migrated to our servers to fix the CSP issue, correct? Or do you know if there's way to allow load the apple script for this case?

[roryabraham]

Depending on the urgency we can fix the existing CSP in CloudFlare.

[roryabraham]

I think we can make this change in the CSP pretty easily, I'll create a PR...

[roryabraham]

@marcochavezf https://github.com/Expensify/Cloudflare-Workers/pull/67

FWIW, static things are pretty easy to add to our CSP, but dynamic things (like injecting a nonce into script tags) are harder. The main thing is that we don't currently have any way to locally test our CSP, and we're working on fixing that by moving NewDot web hosting from S3 to our servers and re-implementing the CSP in PHP instead of in a CloudFlare worker where it lives today.

[marcochavezf]

Perfect, thank you! We'd just need to wait for the PR that updates the CSP in the Cloudflare worker

[robertjchen]

CSP was updated 👍

[0xmiros]

button shows now but still not working after apple login - Continue button still does nothing (#16723 (comment))

Screen.Recording.2023-07-20.at.9.47.25.AM.mov

[marcochavezf]

@cdanwards @lindboe seems the authorization request to the Apple servers is successful, but it seems it's not redirecting/sending the response to the site:

Looking at the URL seems we're redirecting to the production site (new.expensiy.com vs staging (staging.new.expensify.com):

https://appleid.apple.com/auth/authorize?client_id=com.chat.expensify.chat.AppleSignIn&redirect_uri=https%3A%2F%2Fnew.expensify.com%2Fappleauth&response_type=code%20id_token&scope=name%20email&response_mode=web_message&frame_id=782dc751-a25b-48fe-a85e-00401bd3cb9e&m=12&v=1.5.5

[marcochavezf]

Linking here an issue where we were using DeeplinkWrapper in PublicScreens #23285 (comment)

[marcochavezf]

Linking here an issue where we were using DeeplinkWrapper in PublicScreens #23285 (comment)

@cdanwards @lindboe could you check this issue ^? I wonder if we can move DeeplinkWrapper to where it was before

[OSBotify]

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

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

[iwiznia]

This caused a regression, so reverting it #23285

[OSBotify]

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

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

[OSBotify]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.43-7 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.44-2 🚀

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