Fix Apple Sign In token path #25710

lindboe · 2023-08-22T19:00:27Z

Details

Fixes the path where we access the Apple Sign-In token.

Also removes the lodashGet call from the success listener, as it was erroring when testing with ngrok:

Uncaught TypeError: lodash_get__WEBPACK_IMPORTED_MODULE_4___default()(...) is undefined
    lodashGet index.website.js:20
    successListener index.website.js:57
    ge appleid.auth.js:26
    we appleid.auth.js:26
    <anonymous> appleid.auth.js:26
    <anonymous> appleid.auth.js:26
    <anonymous> appleid.auth.js:26
    EventListener.handleEvent* appleid.auth.js:26

Not sure why it's undefined, but we don't need it. Updated the contributing guide accordingly.

Fixed Issues

$ #25697
PROPOSAL: #25697 (comment)

Tests

This flow is only fully testable on staging, as it requires a configured HTTPS domain name matching Expensify's Apple configuration. In the meantime, we checked that the idToken param is selected correctly:

Configure a local testing environment as described in the contributing guide
Add a debugging statement to verify the idToken param is sent to Session.beginAppleSignIn (I was having issues with the debugger/console logging when running on ngrok, so I used window.alert, which worked well)
See that idToken is set as expected
Additionally verify that the SignInWithApple command is sent with the idToken form parameter in the browser inspector

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

Test Apple Sign In as usual

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Showing alert debug statement with token of appropriate length:

successfulwindowalert.mov

Showing idToken param in SignInWithAppleRequest:

showIdTokenParam.mov

We don't expect the request to succeed since it isn't signed appropriately for the Expensify API backend's configuration.

Mobile Web - Chrome

n/a

Mobile Web - Safari

n/a

Desktop

n/a

iOS

n/a

Android

n/a

The `lodashGet` call was causing an error, saying webpack couldn't load the module, at least when used with ngrok. ``` Uncaught TypeError: lodash_get__WEBPACK_IMPORTED_MODULE_4___default()(...) is undefined lodashGet index.website.js:20 successListener index.website.js:57 ge appleid.auth.js:26 we appleid.auth.js:26 <anonymous> appleid.auth.js:26 <anonymous> appleid.auth.js:26 <anonymous> appleid.auth.js:26 EventListener.handleEvent* appleid.auth.js:26 ``` Remove the call so that it's more easily testable. Developers can override values just fine, and QA won't need it.

melvin-bot · 2023-08-22T19:06:06Z

@allroundexperts 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]

allroundexperts · 2023-08-22T19:08:47Z

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

marcochavezf · 2023-08-22T19:41:17Z

Hi @allroundexperts, sorry I will complete the checklist to merge it and CP it to staging since it's a straightforward fix

OSBotify · 2023-08-22T19:49:08Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Fix Apple Sign In token path (cherry picked from commit 7640a6f)

OSBotify · 2023-08-22T21:44:12Z

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

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

amyevans · 2023-08-23T19:05:52Z

✅ Verified the fix on staging following the CP

OSBotify · 2023-08-24T03:05:11Z

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

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

OSBotify · 2023-08-28T18:53:02Z

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

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

OSBotify · 2023-08-30T01:22:05Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀

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

lindboe added 2 commits August 22, 2023 11:16

Fix Apple Sign In token path

9bed4b5

lindboe force-pushed the lindboe/fix-asi-path branch from cefc840 to 89d0945 Compare August 22, 2023 19:05

lindboe marked this pull request as ready for review August 22, 2023 19:06

lindboe requested a review from a team as a code owner August 22, 2023 19:06

melvin-bot bot requested review from allroundexperts and removed request for a team August 22, 2023 19:06

lindboe mentioned this pull request Aug 22, 2023

FEATURE REQUEST: Add Google/Apple sign in on New Dot, like we have on Old Dot #7079

Closed

marcochavezf approved these changes Aug 22, 2023

View reviewed changes

marcochavezf merged commit 7640a6f into Expensify:main Aug 22, 2023

OSBotify pushed a commit that referenced this pull request Aug 22, 2023

Merge pull request #25710 from infinitered/lindboe/fix-asi-path

564abeb

Fix Apple Sign In token path (cherry picked from commit 7640a6f)

roryabraham mentioned this pull request Aug 22, 2023

Deploy Checklist: New Expensify 2023-08-21 #25625

Closed

OSBotify mentioned this pull request Aug 28, 2023

Deploy Checklist: New Expensify 2023-08-28 #26113

Closed

melvin-bot bot mentioned this pull request Aug 28, 2023

[HOLD for payment 2023-09-04] Login - Can't sign in with Apple #25697

Closed

6 tasks

arosiclair mentioned this pull request Aug 29, 2023

[HOLD for payment 2023-10-09] [$500] Login - Abracadabra/2FA page displays but user can't login/continue until page is reloaded #26190

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Apple Sign In token path #25710

Fix Apple Sign In token path #25710

lindboe commented Aug 22, 2023 •

edited

Loading

melvin-bot bot commented Aug 22, 2023

allroundexperts commented Aug 22, 2023 •

edited by marcochavezf

Loading

marcochavezf commented Aug 22, 2023

OSBotify commented Aug 22, 2023

OSBotify commented Aug 22, 2023

amyevans commented Aug 23, 2023

OSBotify commented Aug 24, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 30, 2023

Fix Apple Sign In token path #25710

Fix Apple Sign In token path #25710

Conversation

lindboe commented Aug 22, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 22, 2023

allroundexperts commented Aug 22, 2023 • edited by marcochavezf Loading

Reviewer Checklist

Screenshots/Videos

marcochavezf commented Aug 22, 2023

OSBotify commented Aug 22, 2023

OSBotify commented Aug 22, 2023

amyevans commented Aug 23, 2023

OSBotify commented Aug 24, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 30, 2023

lindboe commented Aug 22, 2023 •

edited

Loading

allroundexperts commented Aug 22, 2023 •

edited by marcochavezf

Loading