[TS Migration] Migrate PlaidLink directory to TypeScript #30915

JKobrynski · 2023-11-06T15:00:44Z

Details

Fixed Issues

$
#25068
PROPOSAL: N/A

Tests

Log into the app
Navigate to the Settings page
Navigate to the Wallet page
Go through the Add bank account process and make sure it works correctly

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests section above

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

src/components/PlaidLink/index.native.tsx

BartoszGrajdek · 2023-11-07T15:11:27Z

src/components/PlaidLink/index.native.tsx

-        Log.info('[PlaidLink] Handled Plaid Event: ', false, event);
-        props.onEvent(event.eventName, event.metadata);
+    usePlaidEmitter((event: LinkEvent) => {
+        Log.info('[PlaidLink] Handled Plaid Event: ', false, event.eventName);


Are you sure there should be event.eventName here?

If you try to pass the whole event object, it produces the following error:

Argument of type 'LinkEvent' is not assignable to parameter of type 'Parameters | undefined'. Type 'LinkEvent' is not assignable to type 'Record<string, unknown>'.

Do you think we should keep it as it is or maybe JSON.stringify it?

Related to microsoft/TypeScript#15300. There is no correct way to fix. We can however apply a workaround:

Pass {...event} to Log.info

Or change event type (convert interface to type) event: Pick<LinkEvent, keyof LinkEvent>

Done (1st option)

BartoszGrajdek · 2023-11-07T15:14:09Z

src/components/PlaidLink/index.native.tsx

    });
    useEffect(() => {
-        props.onEvent(CONST.BANK_ACCOUNT.PLAID.EVENTS_NAME.OPEN, {});
+        onEvent(CONST.BANK_ACCOUNT.PLAID.EVENTS_NAME.OPEN);


I know that this argument you've removed was probably unnecessary, but please make sure it doesn't cause any regressions.

This may actually cause a crash. Please do one of the following:

Update AddPlaidBankAccount to take into account the possibility of metadata being undefined (cannot access metadata.error_code)

Revert this change and add a dummy object (+update types.ts to mark metadata as required)

Done (1st option)

src/components/PlaidLink/nativeModule/index.android.ts

blazejkustra · 2023-11-17T13:41:04Z

Before making this PR ready for review please add QA steps!

melvin-bot · 2023-11-20T07:34:34Z

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

mountiny · 2023-11-22T11:32:03Z

@s77rt can you please do checklist on this PR?

s77rt · 2023-11-22T12:16:22Z

src/components/PlaidLink/index.native.tsx

-        Log.info('[PlaidLink] Handled Plaid Event: ', false, event);
-        props.onEvent(event.eventName, event.metadata);
+    usePlaidEmitter((event: LinkEvent) => {
+        Log.info('[PlaidLink] Handled Plaid Event: ', false, event.eventName);


Related to microsoft/TypeScript#15300. There is no correct way to fix. We can however apply a workaround:

Pass {...event} to Log.info

Or change event type (convert interface to type) event: Pick<LinkEvent, keyof LinkEvent>

s77rt · 2023-11-22T12:53:14Z

src/components/PlaidLink/types.ts

+    token: string;
+
+    // Callback to execute once the user taps continue after successfully entering their account information
+    onSuccess?: (args: {publicToken?: string; metadata: PlaidLinkOnSuccessMetadata | LinkSuccessMetadata}) => void;


Suggested change

onSuccess?: (args: {publicToken?: string; metadata: PlaidLinkOnSuccessMetadata | LinkSuccessMetadata}) => void;

onSuccess?: (args: {publicToken: string; metadata: PlaidLinkOnSuccessMetadata | LinkSuccessMetadata}) => void;

publicToken is not optional

https://github.com/plaid/react-plaid-link/blob/fd5e476d619a7155c80c27ccf691259ec4840fea/src/types/index.ts#L59

https://github.com/plaid/react-native-plaid-link-sdk/blob/f6a623cc4e1a1963a51b4321e94f3fa2b4660fe2/Types.ts#L233

s77rt · 2023-11-22T13:13:18Z

src/components/PlaidLink/types.ts

+    onExit?: () => void;
+
+    // Callback to execute whenever a Plaid event occurs
+    onEvent: (eventName: PlaidLinkStableEvent | string, metadata?: PlaidLinkOnEventMetadata | LinkEventMetadata) => void;


Suggested change

onEvent: (eventName: PlaidLinkStableEvent | string, metadata?: PlaidLinkOnEventMetadata | LinkEventMetadata) => void;

onEvent: (eventName: string, metadata?: PlaidLinkOnEventMetadata | LinkEventMetadata) => void;

PlaidLinkStableEvent is a string

s77rt · 2023-11-22T13:25:45Z

src/components/PlaidLink/index.native.tsx

    });
    useEffect(() => {
-        props.onEvent(CONST.BANK_ACCOUNT.PLAID.EVENTS_NAME.OPEN, {});
+        onEvent(CONST.BANK_ACCOUNT.PLAID.EVENTS_NAME.OPEN);


This may actually cause a crash. Please do one of the following:

Update AddPlaidBankAccount to take into account the possibility of metadata being undefined (cannot access metadata.error_code)

Revert this change and add a dummy object (+update types.ts to mark metadata as required)

JKobrynski · 2023-11-27T13:12:25Z

@s77rt I applied the changes you suggested, thank you for thorough review!

s77rt · 2023-11-27T13:36:52Z

@JKobrynski Thanks! Code looks good to me. Working on checklist / tests. I noticed the tests steps are not correct. I think we need to go through the Add bank process not the debit card process.

s77rt · 2023-11-27T13:54:52Z

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

Android: Native

android.mov

Android: mWeb Chrome

mweb-chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mweb-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

mountiny · 2023-11-28T13:12:53Z

@s77rt bump on this one, thanks

s77rt · 2023-11-28T13:15:15Z

@mountiny Was just waiting for the steps update 😅
@JKobrynski Sorry for the delay here. Next time please tag me otherwise I wouldn't know that a change was made

melvin-bot · 2023-11-28T13:15:34Z

🎯 @s77rt, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #32115.

mountiny

Thanks!

OSBotify · 2023-11-28T13:53: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.

mvtglobally · 2023-11-30T03:05:48Z

Issue #32079 repro when executing this PR

OSBotify · 2023-11-30T12:15:03Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.5-7 🚀

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

JKobrynski added 4 commits November 3, 2023 09:23

start migrating PlaidLink to TypeScript

8c008e3

migrate PlaidLinks native module to TypeScript, create a file for types

0205ca5

Merge branch 'main' into migratePlaidLinkToTypeScript

d7ca940

migrate native PlaidLink to TypeScript

e55fe14

kubabutkiewicz reviewed Nov 6, 2023

View reviewed changes

src/components/PlaidLink/index.native.tsx Show resolved Hide resolved

JKobrynski requested a review from kubabutkiewicz November 6, 2023 15:11

VickyStash reviewed Nov 6, 2023

View reviewed changes

src/components/PlaidLink/index.native.tsx Outdated Show resolved Hide resolved

make onEvent a required prop to avoid optional chaining

9e15bc8

JKobrynski requested a review from VickyStash November 7, 2023 11:00

BartoszGrajdek reviewed Nov 7, 2023

View reviewed changes

blazejkustra suggested changes Nov 9, 2023

View reviewed changes

src/components/PlaidLink/nativeModule/index.android.ts Outdated Show resolved Hide resolved

Merge branch 'main' into migratePlaidLinkToTypeScript

a7ddf2c

JKobrynski requested a review from blazejkustra November 15, 2023 13:32

remove unused nativeModule

42d0373

blazejkustra approved these changes Nov 17, 2023

View reviewed changes

JKobrynski marked this pull request as ready for review November 20, 2023 07:34

JKobrynski requested a review from a team as a code owner November 20, 2023 07:34

melvin-bot bot removed request for a team, VickyStash and kubabutkiewicz November 20, 2023 07:34

JKobrynski mentioned this pull request Nov 20, 2023

[$250] [HOLD for payment 2024-01-18] [TS migration] Migrate 'PlaidLink' component to TypeScript #25068

Closed

mountiny requested review from s77rt and mountiny November 22, 2023 11:30

s77rt suggested changes Nov 22, 2023

View reviewed changes

JKobrynski added 3 commits November 27, 2023 13:41

pass event to Log.info

3d12dc8

allow metadata to be undefined in onEvent

2eaae67

make publicToken required param

b41332c

change eventName type to string

938887f

JKobrynski requested a review from s77rt November 27, 2023 13:12

s77rt approved these changes Nov 28, 2023

View reviewed changes

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

Payment issue for E/App PR#30915 #32115

Closed

mountiny assigned JKobrynski Nov 28, 2023

mountiny approved these changes Nov 28, 2023

View reviewed changes

mountiny merged commit 935608b into Expensify:main Nov 28, 2023
17 of 18 checks passed

github-actions bot mentioned this pull request Nov 29, 2023

Deploy Checklist: New Expensify 2023-11-29 #32175

Closed

55 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS Migration] Migrate PlaidLink directory to TypeScript #30915

[TS Migration] Migrate PlaidLink directory to TypeScript #30915

JKobrynski commented Nov 6, 2023 •

edited

Loading

BartoszGrajdek Nov 7, 2023

JKobrynski Nov 15, 2023

s77rt Nov 22, 2023

JKobrynski Nov 27, 2023

BartoszGrajdek Nov 7, 2023

s77rt Nov 22, 2023

JKobrynski Nov 27, 2023

blazejkustra commented Nov 17, 2023

melvin-bot bot commented Nov 20, 2023

mountiny commented Nov 22, 2023

s77rt Nov 22, 2023

s77rt Nov 22, 2023

JKobrynski Nov 27, 2023

s77rt Nov 22, 2023

JKobrynski Nov 27, 2023

s77rt Nov 22, 2023

JKobrynski commented Nov 27, 2023

s77rt commented Nov 27, 2023

s77rt commented Nov 27, 2023 •

edited

Loading

mountiny commented Nov 28, 2023

s77rt commented Nov 28, 2023

melvin-bot bot commented Nov 28, 2023

mountiny left a comment

OSBotify commented Nov 28, 2023

mvtglobally commented Nov 30, 2023

OSBotify commented Nov 30, 2023

	onSuccess?: (args: {publicToken?: string; metadata: PlaidLinkOnSuccessMetadata \| LinkSuccessMetadata}) => void;
	onSuccess?: (args: {publicToken: string; metadata: PlaidLinkOnSuccessMetadata \| LinkSuccessMetadata}) => void;

	onEvent: (eventName: PlaidLinkStableEvent \| string, metadata?: PlaidLinkOnEventMetadata \| LinkEventMetadata) => void;
	onEvent: (eventName: string, metadata?: PlaidLinkOnEventMetadata \| LinkEventMetadata) => void;

[TS Migration] Migrate PlaidLink directory to TypeScript #30915

[TS Migration] Migrate PlaidLink directory to TypeScript #30915

Conversation

JKobrynski commented Nov 6, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blazejkustra commented Nov 17, 2023

melvin-bot bot commented Nov 20, 2023

mountiny commented Nov 22, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JKobrynski commented Nov 27, 2023

s77rt commented Nov 27, 2023

s77rt commented Nov 27, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny commented Nov 28, 2023

s77rt commented Nov 28, 2023

melvin-bot bot commented Nov 28, 2023

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 28, 2023

mvtglobally commented Nov 30, 2023

OSBotify commented Nov 30, 2023

JKobrynski commented Nov 6, 2023 •

edited

Loading

s77rt commented Nov 27, 2023 •

edited

Loading