[TS migration] Migrate 'SignInDesktop' page by brunovjk · Pull Request #35406 · Expensify/App

brunovjk · 2024-01-30T14:51:17Z

Details

[TS migration] Migrate 'SignInDesktop' page, files:

src/pages/signin/DesktopRedirectPage.js
src/pages/signin/GoogleSignInDesktopPage/index.website.js
src/pages/signin/GoogleSignInDesktopPage/index.js
src/pages/signin/DesktopSignInRedirectPage/index.website.js
src/pages/signin/DesktopSignInRedirectPage/index.js
src/pages/signin/AppleSignInDesktopPage/index.website.js
src/pages/signin/AppleSignInDesktopPage/index.js

Fixed Issues

$ #31988
PROPOSAL: N/A

Tests

Pre-condition:

Render the web Sign In with Google button in Development. APPLE_GOOGLE_SIGNIN.md#render-the-web-sign-in-with-google-button-in-development
Update newExpensifyURL so we can use https://dev.new.expensify.com:8083 in place of https://new.expensify.com/
Start Dektop App (npm run desktop) at :8082.
Start Web App (npm run web) at :8083.
Manually login with any google account to the Web App (dev.new.expensify.com:8083). Don't use the Google Sign Button, it won't work.
Update the webpack.dev.js config to change host from dev.new.expensify.com to localhost and server type from https to http. APPLE_GOOGLE_SIGNIN.md#hostport-requirements

Steps to test:

Go to the Desktop App and click on the Google SignIn button.
Verify that you have been redirected to .../sign-in-with-google and the URL automatically updates to .../desktop-signin-redirect.
Click on Try Again to be redirected to the Desktop App.
Verify that we are logged into DesktopApp with the same account we used in Pre-condition Step 5.
Logout in the DektopApp.
In the Desktop App click on the Apple SignIn button.
Verify that you have been redirected to .../sign-in-with-apple and the URL automatically updates to .../desktop-signin-redirect.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Google SignIn

Sign out of Desktop and Web apps
Go to the Desktop app and click on the Google SignIn button.
Verify that you have been redirected to the URL .../sign-in-with-google in the browser
Login with a Google Account and verify that URL automatically updates to .../desktop-signin-redirect.
Verify that it is directed to Desktop app. (If there is a prompt to open on Desktop app click on the prompt to redirect to Desktop app)
Verify that we are logged into Desktop app with the same account logged in at Step 4

Apple Signin

Sign out of Desktop and Web apps
Go to the Desktop app and click on the Apple SignIn button.
Verify that you have been redirected to the URL .../sign-in-with-apple in the browser
Login with an Apple Account and verify that URL automatically updates to .../desktop-signin-redirect.
Verify that it is directed to Desktop app. (If there is a prompt to open on Desktop app click on the prompt to redirect to Desktop app)
Verify that we are logged into Desktop app with the same account logged in at Step 4

PR Author Checklist

Screenshots/Videos

Android: Native

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

N/A

MacOS: Desktop

MacOS_.Desktop.-Ts.migration_31988.mp4

melvin-bot · 2024-01-31T15:40:40Z

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

brunovjk · 2024-02-01T16:29:35Z

~~I still haven't managed to enable SSO options on my local dev.~~ https://expensify.slack.com/archives/C01GTK53T8Q/p1706821021396549
Done

brunovjk · 2024-02-02T12:41:10Z

@c3024 The changes that I believe are necessary, following the TypeScript's style guide, have already been made.
Currently working on Steps test and POCs. Can you help me here? I'm not sure what steps to test these files we should use. What is the 'user Flow' here?
Thanks for the help.

c3024 · 2024-02-02T14:07:27Z

@brunovjk Sorry, could not respond to your earlier pings. I've been checking other PRs. I'll check and get back in a few hours.

c3024 · 2024-02-03T06:10:10Z

I think visiting these routes

App/src/ROUTES.ts

Lines 50 to 52 in 3ab4e6e

    
           APPLE_SIGN_IN: 'sign-in-with-apple', 
        
           GOOGLE_SIGN_IN: 'sign-in-with-google', 
        
           DESKTOP_SIGN_IN_REDIRECT: 'desktop-signin-redirect',

because the third party desktop signin screens correspond to these routes

App/src/libs/Navigation/linkingConfig/config.ts

Lines 17 to 18 in 3ab4e6e

    
           [SCREENS.SIGN_IN_WITH_APPLE_DESKTOP]: ROUTES.APPLE_SIGN_IN, 
        
           [SCREENS.SIGN_IN_WITH_GOOGLE_DESKTOP]: ROUTES.GOOGLE_SIGN_IN,

and checking if they are working as expected with nothing broken and no new console warnings and errors should do.

You might want to modify this line for dekstop prompt in dev environment.

App/src/components/DeeplinkWrapper/index.website.tsx

Line 65 in 3ab4e6e

    
           if (!isMacOSWeb() || isUnsupportedDeeplinkRoute || hasShownPrompt || CONFIG.ENVIRONMENT === CONST.ENVIRONMENT.DEV || autoAuthState === CONST.AUTO_AUTH_STATE.NOT_STARTED) {

brunovjk · 2024-02-05T20:48:23Z

Thank you @c3024 I saw your message before, still working on those tests. This PR will be ready for review soon. At the latest by the end of this week 02/09, but I believe sooner.

brunovjk · 2024-02-07T12:56:08Z

@c3024 The PR is ready for review.

c3024 · 2024-02-11T13:39:01Z

In the pre-condition, at this step

Login with any google account to the Web App (dev.new.expensify.com:8083)

I am not able to login with a Google account on web. I am getting a blank white screen.

blankGoogle.mp4

I followed all the preceding steps in the pre-condition. Could you help me with this? @brunovjk

brunovjk · 2024-02-11T15:11:13Z

@c3024 Thanks for the review. My bad, I didn't make it so clear, that in Pre-condition-step 5 I logged in with a Google account not through the GoogleSignIn Button, but I entered the account manually, I fixed now, but during the tests I did, I tested several 'Step test Path', none led to accurate reproduction, but none had a failure or error in relation to TS migration. Actually I'm not very happy with these steps, I'll redo/improve it and let you know. If you have any ideas please don't hesitate to let me know. Do you think we can/should ask an Internal Engineer for help with the tests here?

brunovjk · 2024-02-12T10:53:42Z

Hello @blazejkustra were you able to test using the steps I provided? Thank you :D

blazejkustra · 2024-02-12T11:02:57Z

No, I only reviewed typescript-wise @brunovjk 😄

brunovjk · 2024-02-12T11:12:56Z

Nice, thank you @blazejkustra. I agree, the TS migration is looking good. I will keep working on those steps today, I believe it is important for the QA team.

c3024 · 2024-02-12T17:56:37Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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(theme.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 the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

signinDesktop.mp4

c3024 · 2024-02-12T18:01:46Z

I think the test steps cover well enough to verify the changes made.

c3024

LGTM

melvin-bot · 2024-02-12T18:02:00Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #31988 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

c3024

youssef-lr

LGTM

OSBotify · 2024-02-12T22:28:30Z

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

kavimuru · 2024-02-13T19:14:32Z

@youssef-lr @c3024 Could you help with "Precondition" part for the QA team?

c3024 · 2024-02-14T14:28:38Z

My bad @kavimuru . The QA steps do not require the pre-condition because the buttons are already rendered. Please follow the following steps.

QA steps

Google SignIn

Sign out of Desktop and Web apps
Go to the Desktop app and click on the Google SignIn button.
Verify that you have been redirected to the URL .../sign-in-with-google in the browser
Login with a Google Account and verify that URL automatically updates to .../desktop-signin-redirect.
Verify that it is directed to Desktop app. (If there is a prompt to open on Desktop app click on the prompt to redirect to Desktop app)
Verify that we are logged into Desktop app with the same account logged in at Step 4

Apple Signin

Sign out of Desktop and Web apps
Go to the Desktop app and click on the Apple SignIn button.
Verify that you have been redirected to the URL .../sign-in-with-apple in the browser
Login with an Apple Account and verify that URL automatically updates to .../desktop-signin-redirect.
Verify that it is directed to Desktop app. (If there is a prompt to open on Desktop app click on the prompt to redirect to Desktop app)
Verify that we are logged into Desktop app with the same account logged in at Step 4

c3024 · 2024-02-14T14:29:19Z

Please suggest any corrections if required here #35406 (comment).

@brunovjk

brunovjk · 2024-02-14T14:39:20Z

True, we don't need pre-conditioning for QA tests, I hadn't realized that, thank you @c3024. Should I edit the PR 'Details' with these QA steps? They look good to me.

c3024 · 2024-02-14T14:40:46Z

I thought we cannot edit the earlier comments after PR has been merged. If we can, please edit and include the steps.

brunovjk · 2024-02-14T14:42:27Z

Done :)

OSBotify · 2024-02-15T05:23:49Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.41-12 🚀

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

brunovjk and others added 4 commits January 29, 2024 14:12

Rename .js files to .ts/.tsx for TypeScript migration

da3d8a7

Add // @ts-expect-error in pages using ThirdPartySignInPage

77980b1

Remove JSDOC comments

124eabb

Merge branch 'Expensify:main' into ts-migration/31988

c8f2cf6

brunovjk mentioned this pull request Jan 30, 2024

[hold for payment 2024-02-22] [$250] [TS migration] Migrate 'SignInDesktop' page to TypeScript #31988

Closed

brunovjk marked this pull request as ready for review January 31, 2024 15:40

brunovjk requested a review from a team as a code owner January 31, 2024 15:40

melvin-bot Bot removed the request for review from a team January 31, 2024 15:40

melvin-bot Bot requested a review from c3024 January 31, 2024 15:40

Merge branch 'Expensify:main' into ts-migration/31988

f65b570

brunovjk added 2 commits February 1, 2024 18:51

Merge branch 'Expensify:main' into ts-migration/31988

7706700

Merge branch 'Expensify:main' into ts-migration/31988

b27220b

brunovjk marked this pull request as draft February 2, 2024 13:53

brunovjk added 2 commits February 6, 2024 07:32

Merge branch 'Expensify:main' into ts-migration/31988

129ba24

Merge branch 'Expensify:main' into ts-migration/31988

6d2a697

brunovjk changed the title ~~Ts migration/31988~~ [TS migration] Migrate 'SignInDesktop' page Feb 7, 2024

brunovjk marked this pull request as ready for review February 7, 2024 12:52

Merge branch 'Expensify:main' into ts-migration/31988

97fc609

blazejkustra approved these changes Feb 12, 2024

View reviewed changes

Merge branch 'Expensify:main' into ts-migration/31988

552b78d

c3024 approved these changes Feb 12, 2024

View reviewed changes

melvin-bot Bot requested a review from youssef-lr February 12, 2024 18:02

youssef-lr approved these changes Feb 12, 2024

View reviewed changes

youssef-lr merged commit 5aee9a3 into Expensify:main Feb 12, 2024

brunovjk deleted the ts-migration/31988 branch February 12, 2024 22:34

github-actions Bot mentioned this pull request Feb 13, 2024

Deploy Checklist: New Expensify 2024-02-13 #36429

Closed

Conversation

brunovjk commented Jan 30, 2024 • edited 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!

melvin-bot Bot commented Jan 31, 2024

Uh oh!

brunovjk commented Feb 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brunovjk commented Feb 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

c3024 commented Feb 2, 2024

Uh oh!

c3024 commented Feb 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brunovjk commented Feb 5, 2024

Uh oh!

brunovjk commented Feb 7, 2024

Uh oh!

c3024 commented Feb 11, 2024

Uh oh!

brunovjk commented Feb 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brunovjk commented Feb 12, 2024

Uh oh!

blazejkustra commented Feb 12, 2024

Uh oh!

brunovjk commented Feb 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

c3024 commented Feb 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

c3024 commented Feb 12, 2024

Uh oh!

c3024 left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Feb 12, 2024

Uh oh!

c3024 left a comment

Choose a reason for hiding this comment

Uh oh!

youssef-lr left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Feb 12, 2024

Uh oh!

kavimuru commented Feb 13, 2024

Uh oh!

c3024 commented Feb 14, 2024

QA steps

Google SignIn

Apple Signin

Uh oh!

c3024 commented Feb 14, 2024

Uh oh!

brunovjk commented Feb 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

c3024 commented Feb 14, 2024

Uh oh!

brunovjk commented Feb 14, 2024

Uh oh!

OSBotify commented Feb 15, 2024

Uh oh!

Reviewers

Assignees

brunovjk commented Jan 30, 2024 •

edited

Loading

brunovjk commented Feb 1, 2024 •

edited

Loading

brunovjk commented Feb 2, 2024 •

edited

Loading

c3024 commented Feb 3, 2024 •

edited

Loading

brunovjk commented Feb 11, 2024 •

edited

Loading

brunovjk commented Feb 12, 2024 •

edited

Loading

c3024 commented Feb 12, 2024 •

edited

Loading

brunovjk commented Feb 14, 2024 •

edited

Loading