[TS Migration] Adjustments on KYCWall #34870

ruben-rebelo · 2024-01-22T10:36:01Z

Details

[TS migration] Migrate KYCWall component

Fixed Issues

$ #25126
$ #34904

PROPOSAL: N/A

Tests

log into the app
press the FAB and request money from e.g. workspace that you are a part of (to make it easier and not have to jump between accounts)
select the said workspace and press on pay with Expensify
confirm that the pop up shows in which you can select an option and be navigated to it

Verify that no errors appear in the JS console

Offline tests

Same as Tests section

QA Steps

Same as 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

VickyStash · 2024-01-22T14:41:19Z

src/components/KYCWall/BaseKYCWall.tsx

@@ -146,7 +145,7 @@ function KYCWall({
     *
     */
    const continueAction = useCallback(
-        (event?: SyntheticEvent<NativeTouchEvent>, iouPaymentType?: TransferMethod) => {
+        (event?: GestureResponderEvent | KeyboardEvent | undefined, iouPaymentType?: TransferMethod) => {


Why you have both ?:and | undefined. If the param is not required leave ?:, if it's always passed to the function, but can be undefined leave | undefined

VickyStash · 2024-01-22T14:41:55Z

src/libs/actions/PaymentMethods.ts

@@ -17,7 +17,7 @@ import type PaymentMethod from '@src/types/onyx/PaymentMethod';
 import type {FilterMethodPaymentType} from '@src/types/onyx/WalletTransfer';

 type KYCWallRef = {
-    continueAction?: (event?: SyntheticEvent<NativeTouchEvent>, iouPaymentType?: TransferMethod) => void;
+    continueAction?: (event?: GestureResponderEvent | KeyboardEvent | undefined, iouPaymentType?: TransferMethod) => void;


fabioh8010 · 2024-01-22T16:08:22Z

src/components/KYCWall/BaseKYCWall.tsx

@@ -161,7 +160,7 @@ function KYCWall({
            }

            // Use event target as fallback if anchorRef is null for safety
-            const targetElement = anchorRef.current ?? (event?.nativeEvent.target as HTMLDivElement);
+            const targetElement = anchorRef.current ?? (event?.currentTarget as HTMLElement);


Please make sure this change works for all platforms (native/web)

github-actions · 2024-01-22T17:26:59Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/34870/index.html	❌ FAILED ❌
	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/34870/NewExpensify.dmg	https://34870.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

blazejkustra · 2024-01-22T17:41:42Z

src/components/KYCWall/BaseKYCWall.tsx

@@ -68,8 +67,8 @@ function KYCWall({
    walletTerms,
    shouldShowPersonalBankAccountOption = false,
 }: BaseKYCWallProps) {
-    const anchorRef = useRef<HTMLDivElement>(null);
-    const transferBalanceButtonRef = useRef<HTMLDivElement | null>(null);
+    const anchorRef = useRef<HTMLElement>(null);


Why is this changed?

It's related with this comment: #33714 (comment)
In order to make the types compatible with MenuItem and Button we had to change the event type which than the target is not compatible with HTMLDivElement and just with HTMLElement.

melvin-bot · 2024-01-22T18:12:18Z

@rushatgabhane 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 · 2024-01-22T18:20:44Z

Asking @johnmlee101 or @joekaufmanexpensify to test this build out

mountiny · 2024-01-22T18:31:33Z

@ruben-rebelo This was fixed! but the reassure tests are something we should fix before merging

mountiny · 2024-01-22T18:44:47Z

restarted

mountiny · 2024-01-23T21:00:12Z

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

Was tested in Slack https://expensify.slack.com/archives/C049HHMV9SM/p1705929941791079

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

mountiny · 2024-01-23T21:00:24Z

Tested in slack https://expensify.slack.com/archives/C049HHMV9SM/p1705929941791079

mountiny

Thanks!

melvin-bot · 2024-01-23T21:01:48Z

@mountiny looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

mountiny · 2024-01-23T21:01:56Z

the failing reassure tests are flaky and they were skipped on main https://github.com/Expensify/App/actions/runs/7614760746/job/20741389627?pr=34870

OSBotify · 2024-01-23T21:05:59Z

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

thienlnam · 2024-01-25T05:55:30Z

Works as expected!

OSBotify · 2024-01-25T08:51:43Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.31-7 🚀

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

[TS Migration] Adjusted KYCWall based on some regressions

a68f19d

ruben-rebelo mentioned this pull request Jan 22, 2024

[TS migration] Migrate KYCWall component #33714

Merged

50 tasks

[TS migration] BaseKYCWall code improvements

459a9f8

VickyStash reviewed Jan 22, 2024

View reviewed changes

fabioh8010 reviewed Jan 22, 2024

View reviewed changes

mountiny assigned ruben-rebelo Jan 22, 2024

mountiny added the Ready To Build label Jan 22, 2024

mountiny changed the title ~~[TS Migration] Adjustments on KYCWall~~ [CP Staging] [TS Migration] Adjustments on KYCWall Jan 22, 2024

[TS migration] KYCWall addressed suggestion

f4b8565

mountiny mentioned this pull request Jan 22, 2024

[HOLD for payment 2024-02-01] When Paying with Expensify the passed payment type is REPORT #34904

Closed

6 tasks

blazejkustra reviewed Jan 22, 2024

View reviewed changes

blazejkustra approved these changes Jan 22, 2024

View reviewed changes

ruben-rebelo marked this pull request as ready for review January 22, 2024 18:12

ruben-rebelo requested a review from a team as a code owner January 22, 2024 18:12

melvin-bot bot requested review from rushatgabhane and removed request for a team January 22, 2024 18:12

hoangzinh mentioned this pull request Jan 23, 2024

[TS migration] Migrate 'SettlementButton.js' component to TypeScript #33866

Merged

50 tasks

mountiny changed the title ~~[CP Staging] [TS Migration] Adjustments on KYCWall~~ [TS Migration] Adjustments on KYCWall Jan 23, 2024

mountiny approved these changes Jan 23, 2024

View reviewed changes

mountiny added the InternalQA This pull request required internal QA label Jan 23, 2024

mountiny merged commit 0706c8c into Expensify:main Jan 23, 2024
16 of 21 checks passed

melvin-bot bot added the Emergency label Jan 23, 2024

mountiny removed the Emergency label Jan 23, 2024

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

Deploy Checklist: New Expensify 2024-01-24 #35037

Closed

48 tasks

rushatgabhane mentioned this pull request Jan 24, 2024

[HOLD for payment 2024-02-01] [$250] [TS migration] Migrate 'KYCWall' component to TypeScript #25126

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS Migration] Adjustments on KYCWall #34870

[TS Migration] Adjustments on KYCWall #34870

ruben-rebelo commented Jan 22, 2024 •

edited by mountiny

Loading

VickyStash Jan 22, 2024

VickyStash Jan 22, 2024

fabioh8010 Jan 22, 2024

github-actions bot commented Jan 22, 2024

blazejkustra Jan 22, 2024

ruben-rebelo Jan 22, 2024

melvin-bot bot commented Jan 22, 2024

mountiny commented Jan 22, 2024

mountiny commented Jan 22, 2024

mountiny commented Jan 22, 2024

mountiny commented Jan 23, 2024 •

edited

Loading

mountiny commented Jan 23, 2024

mountiny left a comment

melvin-bot bot commented Jan 23, 2024

mountiny commented Jan 23, 2024

OSBotify commented Jan 23, 2024

thienlnam commented Jan 25, 2024

OSBotify commented Jan 25, 2024

[TS Migration] Adjustments on KYCWall #34870

[TS Migration] Adjustments on KYCWall #34870

Conversation

ruben-rebelo commented Jan 22, 2024 • edited by mountiny Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

VickyStash Jan 22, 2024

Choose a reason for hiding this comment

VickyStash Jan 22, 2024

Choose a reason for hiding this comment

fabioh8010 Jan 22, 2024

Choose a reason for hiding this comment

github-actions bot commented Jan 22, 2024

blazejkustra Jan 22, 2024

Choose a reason for hiding this comment

ruben-rebelo Jan 22, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Jan 22, 2024

mountiny commented Jan 22, 2024

mountiny commented Jan 22, 2024

mountiny commented Jan 22, 2024

mountiny commented Jan 23, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny commented Jan 23, 2024

mountiny left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 23, 2024

mountiny commented Jan 23, 2024

OSBotify commented Jan 23, 2024

thienlnam commented Jan 25, 2024

OSBotify commented Jan 25, 2024

ruben-rebelo commented Jan 22, 2024 •

edited by mountiny

Loading

mountiny commented Jan 23, 2024 •

edited

Loading