Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TS migration] Migrate 'AddressForm.js' component to TypeScript #34149

Merged
merged 15 commits into from
Mar 4, 2024

Conversation

pasyukevich
Copy link
Contributor

@pasyukevich pasyukevich commented Jan 9, 2024

Details

Fixed Issues

$ #31957
PROPOSAL:

Tests

  1. Go to Settings/Wallet.
  2. add this useEffect on WalletPage.js:
useEffect(() => {
        if (cardList[234523452345]) {
            return;
        }
        // eslint-disable-next-line rulesdir/prefer-actions-set-data
        window.Onyx.merge(`cardList`, {
            234523452345: {
                key: '234523452345',
                cardID: 234523452345,
                state: 2,
                bank: 'Expensify Card',
                availableSpend: 10000,
                domainName: 'expensify.com',
                lastFourPAN: '2345',
                isVirtual: false,
                fraud: null,
            },
        });
    }, [cardList]);
  1. Click on the Expensify Card in the Assigned Cards section list.
  2. On the Expensify Card page you're currently on, press the Get Physical Card button at the bottom of the page.
  3. If you have filled in your details before, you should be shown the confirmation page with the correct data already filled. Otherwise, you'll be shown either the legal name, phone number, or address steps until you have filled in every single piece of data required.
  4. Verify that validation errors are displayed correctly on every step
  5. When all data is filled, you can press the Ship Card button on the confirmation step to go back to the Expensify Card page.
  6. At this point, it's not possible to send the request to the API so the Expensify Card page won't show the updated state when you already requested the physical card.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Use an account with Expensify card in 'Not issued' state.
  2. Go to Settings/Wallet
  3. Click on the Expensify Card in the Assigned Cards section list.
  4. On the Expensify Card page you're currently on, press the Get Physical Card button at the bottom of the page.
  5. If you have filled in your details before, you should be shown the confirmation page with the correct data already filled. Otherwise, you'll be shown either the legal name, phone number, or address steps until you have filled in every single piece of data required.
  6. Verify that validation errors are displayed correctly on every step
  7. When all data is filled, you can press the Ship Card button on the confirmation step to go back to the Expensify Card page.
  8. At this point, it's not possible to send the request to the API so the Expensify Card page won't show the updated state when you already requested the physical card.
  • 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-native-converted.webm
Android: mWeb Chrome
android-web-converted.webm
iOS: Native
ios-native-converted.mp4
iOS: mWeb Safari
ios-web-converted.mp4
MacOS: Chrome / Safari
desktop-web-converted.mov
MacOS: Desktop
desktop-native-converted.mov

@pasyukevich pasyukevich force-pushed the feature/migrate-AddressForm branch 4 times, most recently from c533366 to 4e88a52 Compare January 9, 2024 16:38
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
@pasyukevich pasyukevich force-pushed the feature/migrate-AddressForm branch 4 times, most recently from 610d212 to 70699c4 Compare January 16, 2024 08:57
city?: string;
country?: string;
state?: string;
zipPostCode?: string | Array<string | Record<string, string>>;
Copy link
Contributor

@fabioh8010 fabioh8010 Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
zipPostCode?: string | Array<string | Record<string, string>>;
zipPostCode?: Localize.MaybePhraseKey;

Could you test if this works?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated


// Check "State" dropdown is a valid state if selected Country is USA
if (values.country === CONST.COUNTRY.US && !COMMON_CONST.STATES[values.state]) {
if (values.country === CONST.COUNTRY.US && !values.state) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it does not work as before

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works as it was before since this value can be entered only with dropdown

}

if ('samples' in countryRegexDetails) {
countryZipFormat = countryRegexDetails.samples as string;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are this assertions needed? What are the types of countryRegexDetails.regex and countryRegexDetails.samples?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To specify types in this case (some countries don't have those fields and ts resolve those fields as unknown)

RegExp and string accordingly

@@ -21,6 +23,35 @@ type DateOfBirthForm = Form & {
dob?: string;
};

type AddressForm = Form & {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has changed last week, please merge the newest main

@@ -116,6 +144,7 @@ function AddressForm({city, country, formID, onAddressChanged, onSubmit, shouldS
}, []);

return (
// @ts-expect-error TODO: Remove this once FormProvider (https://github.com/Expensify/App/issues/25109) is migrated to TypeScript.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please merge the newest main and follow new Form practices (check other forms with validate/onSubmit functions)

Copy link

melvin-bot bot commented Feb 8, 2024

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@pasyukevich pasyukevich marked this pull request as ready for review February 8, 2024 17:29
@pasyukevich pasyukevich requested a review from a team as a code owner February 8, 2024 17:29
@melvin-bot melvin-bot bot removed the request for review from a team February 8, 2024 17:29
Copy link

melvin-bot bot commented Feb 8, 2024

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

@melvin-bot melvin-bot bot requested a review from fedirjh February 8, 2024 17:29
@fedirjh
Copy link
Contributor

fedirjh commented Feb 26, 2024

@pasyukevich Could you please merge main? Thank you.

@pasyukevich
Copy link
Contributor Author

@fedirjh PR updated

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link

melvin-bot bot commented Feb 29, 2024

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

jasperhuangg
jasperhuangg previously approved these changes Mar 1, 2024
@jasperhuangg
Copy link
Contributor

conflicts!

@pasyukevich
Copy link
Contributor Author

@jasperhuangg PR updated

@jasperhuangg jasperhuangg merged commit 34ce9e0 into Expensify:main Mar 4, 2024
15 checks passed
@melvin-bot melvin-bot bot added the Emergency label Mar 4, 2024
Copy link

melvin-bot bot commented Mar 4, 2024

@jasperhuangg 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.

@OSBotify
Copy link
Contributor

OSBotify commented Mar 4, 2024

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 4, 2024

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 1.4.47-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 6, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.47-10 🚀

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


if (countrySpecificZipRegex) {
if (countrySpecificZipRegex && values.zipPostCode) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change broke the "is required" check for the zip codes. We shouldn't have added this condition and used the conditional chaining where needed instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants