[TS migration] Migrate 'SignInButtons' component to TypeScript #33404

shahinyan11 · 2023-12-21T09:57:03Z

Details

[TS migration] Migrate 'SignInButtons' component to TypeScript

Fixed Issues

$ #31980
PROPOSAL: N/A

Tests

Go to sign in page on any environment besides DEV
Click the Google/Apple icon below the "sign in with" text
Verify that buttons works as expected

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as in the Tests section.

Verify that no errors appear in the JS console

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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.

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

2023-12-21.17.05.27.mp4

iOS: Native

ios.mov

iOS: mWeb Safari

Screen.Recording.2023-12-21.at.16.39.02.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-21.at.16.10.17.mov

MacOS: Desktop

Screen.Recording.2023-12-21.at.16.16.39.mov

melvin-bot · 2023-12-21T09:57:08Z

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

burczu · 2023-12-21T09:59:29Z

@shahinyan11 Videos/screenshots are missing in your PR Author's Checklist. Please complete it.

burczu · 2023-12-21T10:10:19Z

@shahinyan11 Please also request review from @fabioh8010 and @blazejkustra.

shahinyan11 · 2023-12-21T11:04:17Z

Videos/screenshots are missing in your PR Author's Checklist. Please complete it.

I know. I just wanted to add a video and then ask to review

shahinyan11 · 2023-12-21T11:06:34Z

Please also request review from @fabioh8010 and @blazejkustra.

How I should request review from them. Only you are mentioned in reviewers

burczu · 2023-12-21T11:08:17Z

Please also request review from @fabioh8010 and @blazejkustra.

How I should request review from them. Only you are mentioned in reviewers

Hmmm... I thought you can do it as an author of the PR. I'll speak to Fabio then and let them know.

shahinyan11 · 2023-12-21T11:56:25Z

@burczu Should I add videos with testing full apple sign in flow or only work of buttons is enough ? I would like to ask permission to not record videos with full apple sign in flow for Web and Desktop because the testing apple sign in on those platforms is a big process .

burczu · 2023-12-21T11:58:38Z

@burczu Should I add videos with testing full apple sign in flow or only working buttons is enough ? I would like to ask permission to not record videos with full apple sign in flow for Web and Desktop because the testing apple sign in on those platforms is a big process .

@shahinyan11 I think working buttons is enough.

shahinyan11 · 2023-12-21T13:14:08Z

@burczu I have added all videos .
I apologize for such videos. but if they don't suitable, I need some help to deal with apple and google sign in for desktop and web

src/components/SignInButtons/AppleAuthWrapper/index.ios.ts

src/components/SignInButtons/AppleAuthWrapper/index.ts

src/components/SignInButtons/AppleSignIn/index.android.tsx

src/types/modules/dom.d.ts

src/types/modules/google.d.ts

src/components/SignInButtons/GetUserLanguage.ts

src/components/SignInButtons/AppleSignIn/index.ios.tsx

blazejkustra · 2023-12-28T14:00:00Z

@shahinyan11 Typecheck is failing, please merge the newest main and fix 😄

shahinyan11 · 2023-12-28T16:19:51Z

@blazejkustra Ready

src/components/SignInButtons/AppleAuthWrapper/index.ios.tsx

src/components/SignInButtons/AppleSignIn/index.android.tsx

src/components/SignInButtons/AppleSignIn/index.website.tsx

rushatgabhane · 2024-01-02T20:13:33Z

src/libs/actions/Session/index.ts

@@ -296,11 +296,11 @@ function beginSignIn(email: string) {
 * Given an idToken from Sign in with Apple, checks the API to see if an account
 * exists for that email address and signs the user in if so.
 */
-function beginAppleSignIn(idToken: string) {
+function beginAppleSignIn(idToken: string | undefined | null) {


should this function accept undefined strings? If so, why?

Suggested change

function beginAppleSignIn(idToken: string | undefined | null) {

function beginAppleSignIn(idToken: string) {

@rushatgabhane The beginAppleSignIn function is called in Promise.then where the received value can be undefined . We should use this approach or call it in a condition

rushatgabhane · 2024-01-02T20:15:36Z

src/libs/actions/Session/index.ts

@@ -313,11 +313,11 @@ function beginAppleSignIn(idToken: string) {
 * Shows Google sign-in process, and if an auth token is successfully obtained,
 * passes the token on to the Expensify API to sign in with
 */
-function beginGoogleSignIn(token: string) {
+function beginGoogleSignIn(token: string | null) {


@rushatgabhane The same cause

rushatgabhane · 2024-01-10T07:05:56Z

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

arosiclair · 2024-01-11T02:36:40Z

@shahinyan11 @rushatgabhane @yuwenmemon seems like this is causing linting errors on main:

/Users/arosiclair/Expensidev/App/src/components/SignInButtons/AppleSignIn/index.website.tsx
  2:1  error  Import "NativeConfig" is only used as types                               @typescript-eslint/consistent-type-imports
  4:1  error  Import "WithNavigationFocusProps" is only used as types                   @typescript-eslint/consistent-type-imports
  9:1  error  All imports in the declaration are only used as types. Use `import type`  @typescript-eslint/consistent-type-imports

/Users/arosiclair/Expensidev/App/src/components/SignInButtons/GetUserLanguage.ts
  1:1  error  All imports in the declaration are only used as types. Use `import type`  @typescript-eslint/consistent-type-imports

/Users/arosiclair/Expensidev/App/src/components/SignInButtons/GoogleSignIn/index.website.tsx
  8:1  error  All imports in the declaration are only used as types. Use `import type`  @typescript-eslint/consistent-type-imports

/Users/arosiclair/Expensidev/App/src/components/SignInButtons/IconButton.tsx
   2:1  error  All imports in the declaration are only used as types. Use `import type`  @typescript-eslint/consistent-type-imports
   9:1  error  All imports in the declaration are only used as types. Use `import type`  @typescript-eslint/consistent-type-imports
  10:1  error  All imports in the declaration are only used as types. Use `import type`  @typescript-eslint/consistent-type-imports

✖ 8 problems (8 errors, 0 warnings)
  8 errors and 0 warnings potentially fixable with the `--fix` option.

yuwenmemon · 2024-01-11T02:56:15Z

Should be a quick fix. I can handle.

OSBotify · 2024-01-11T09:58:52Z

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 1.4.24-4 🚀

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

OSBotify · 2024-01-15T11:40:12Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.24-8 🚀

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

Migrate 'SignInButtons' component to TypeScript

59460ba

shahinyan11 requested a review from a team as a code owner December 21, 2023 09:57

melvin-bot bot requested review from burczu and removed request for a team December 21, 2023 09:57

fabioh8010 reviewed Dec 21, 2023

View reviewed changes

Fix Review Comments

5e38df3

shahinyan11 requested a review from fabioh8010 December 21, 2023 15:05

fabioh8010 approved these changes Dec 22, 2023

View reviewed changes

blazejkustra approved these changes Dec 28, 2023

View reviewed changes

src/components/SignInButtons/AppleSignIn/index.ios.tsx Outdated Show resolved Hide resolved

Fix Review Comments

c2fcaf4

shahinyan11 requested review from fabioh8010 and blazejkustra December 28, 2023 12:29

Shahe Shahinyan added 2 commits December 28, 2023 18:57

merge main into current branch

0b16d84

fix Typescript check error

cdea74d

blazejkustra approved these changes Dec 29, 2023

View reviewed changes

rushatgabhane reviewed Jan 2, 2024

View reviewed changes

src/components/SignInButtons/AppleAuthWrapper/index.ios.tsx Show resolved Hide resolved

rushatgabhane suggested changes Jan 2, 2024

View reviewed changes

shahinyan11 requested review from rushatgabhane and blazejkustra January 4, 2024 12:28

blazejkustra approved these changes Jan 5, 2024

View reviewed changes

rushatgabhane approved these changes Jan 10, 2024

View reviewed changes

melvin-bot bot requested a review from yuwenmemon January 10, 2024 08:04

yuwenmemon approved these changes Jan 11, 2024

View reviewed changes

yuwenmemon merged commit 8460043 into Expensify:main Jan 11, 2024
16 of 27 checks passed

yuwenmemon mentioned this pull request Jan 11, 2024

[No QA] Fix linter error for type imports #34309

Merged

48 tasks

github-actions bot mentioned this pull request Jan 11, 2024

Deploy Checklist: New Expensify 2024-01-11 #34327

Closed

54 tasks

melvin-bot bot mentioned this pull request Jan 15, 2024

[HOLD for payment 2024-01-22] [$250] [TS migration] Migrate 'SignInButtons' component to TypeScript #31980

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'SignInButtons' component to TypeScript #33404

[TS migration] Migrate 'SignInButtons' component to TypeScript #33404

shahinyan11 commented Dec 21, 2023 •

edited

Loading

melvin-bot bot commented Dec 21, 2023

burczu commented Dec 21, 2023

burczu commented Dec 21, 2023

shahinyan11 commented Dec 21, 2023 •

edited

Loading

shahinyan11 commented Dec 21, 2023 •

edited

Loading

burczu commented Dec 21, 2023

shahinyan11 commented Dec 21, 2023 •

edited

Loading

burczu commented Dec 21, 2023

shahinyan11 commented Dec 21, 2023

blazejkustra commented Dec 28, 2023

shahinyan11 commented Dec 28, 2023

rushatgabhane Jan 2, 2024

shahinyan11 Jan 4, 2024

rushatgabhane Jan 2, 2024

shahinyan11 Jan 4, 2024

rushatgabhane commented Jan 10, 2024 •

edited

Loading

arosiclair commented Jan 11, 2024

yuwenmemon commented Jan 11, 2024

OSBotify commented Jan 11, 2024

OSBotify commented Jan 15, 2024

	function beginAppleSignIn(idToken: string \| undefined \| null) {
	function beginAppleSignIn(idToken: string) {

[TS migration] Migrate 'SignInButtons' component to TypeScript #33404

[TS migration] Migrate 'SignInButtons' component to TypeScript #33404

Conversation

shahinyan11 commented Dec 21, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 21, 2023

burczu commented Dec 21, 2023

burczu commented Dec 21, 2023

shahinyan11 commented Dec 21, 2023 • edited Loading

shahinyan11 commented Dec 21, 2023 • edited Loading

burczu commented Dec 21, 2023

shahinyan11 commented Dec 21, 2023 • edited Loading

burczu commented Dec 21, 2023

shahinyan11 commented Dec 21, 2023

blazejkustra commented Dec 28, 2023

shahinyan11 commented Dec 28, 2023

rushatgabhane Jan 2, 2024

Choose a reason for hiding this comment

shahinyan11 Jan 4, 2024

Choose a reason for hiding this comment

rushatgabhane Jan 2, 2024

Choose a reason for hiding this comment

shahinyan11 Jan 4, 2024

Choose a reason for hiding this comment

rushatgabhane commented Jan 10, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

arosiclair commented Jan 11, 2024

yuwenmemon commented Jan 11, 2024

OSBotify commented Jan 11, 2024

OSBotify commented Jan 15, 2024

shahinyan11 commented Dec 21, 2023 •

edited

Loading

shahinyan11 commented Dec 21, 2023 •

edited

Loading

shahinyan11 commented Dec 21, 2023 •

edited

Loading

shahinyan11 commented Dec 21, 2023 •

edited

Loading

rushatgabhane commented Jan 10, 2024 •

edited

Loading