[TS migration] Migrate 'FormAlertWithSubmitButton.js' component to TypeScript #31303

kubabutkiewicz · 2023-11-14T12:22:28Z

Details

Fixed Issues

$ #25017

Tests

Go to login page
Enter email
Enter password
You should sucessfully login into app

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to login page
Enter email
Enter password
You should sucessfully login into app

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

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2023-11-14T12:22:33Z

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

…s-migration/FormAlertWithSubmitButton/component

pac-guerreiro · 2023-12-12T16:49:40Z

src/components/FormAlertWithSubmitButton.tsx

+    message = '',
+    isDisabled = false,
+    isMessageHtml = false,
+    containerStyles,


Careful, this prop used to default to array

@pac-guerreiro we agreed earlier that styles props don't need default values here is a conversation

@kubabutkiewicz Oh okay, maybe that discussion should be added to the TS guidelines, what you think @fabioh8010 ?

pac-guerreiro · 2023-12-12T16:50:09Z

src/components/FormAlertWithSubmitButton.tsx

+
+    return (
+        <FormAlertWrapper
+            containerStyles={[styles.mh5, styles.mb5, styles.justifyContentEnd, containerStyles]}


If containerStyles is an array, it needs to be spread here

@pac-guerreiro It will work, look at screenshots

The style props are able to handle nested arrays 🙂

Nvm then @kubabutkiewicz @fabioh8010, I had the idea that we could not pass nested arrays like that

Sorry if I am being dumb, but I am seeing this console warning and I believe it is related to this change:

I am seeing this console warning and I believe it is related to this change

@rlinoz, eh, I think you are right. However, on main branch, FormAlertWrapper has been migrated to tsx , so this error will not appear after merging, we can merge that to this branch to validate it first. :)

src/components/FormAlertWithSubmitButton.tsx

pac-guerreiro · 2023-12-12T16:53:04Z

src/components/FormAlertWithSubmitButton.tsx

+        >
+            {(isOffline: boolean) => (
+                <View>
+                    {isOffline && !enabledWhenOffline ? (


I know that this is out of scope with this PR purpose but there's code duplication in this ternary and should be addressed

I see your point but during TS migration we should not do refactors which are not related to migration, maybe you can create a seperate issue for that?

BartoszGrajdek

LGTM!

pac-guerreiro · 2023-12-13T16:33:46Z

@kubabutkiewicz LGTM 👍

…s-migration/FormAlertWithSubmitButton/component

melvin-bot · 2023-12-13T21:45:12Z

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

…s-migration/FormAlertWithSubmitButton/component

kubabutkiewicz · 2023-12-15T13:53:14Z

@ntdiary kindly bump 😄

ntdiary · 2023-12-15T15:31:00Z

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

31303-android-native.mp4

Android: mWeb Chrome

31303-android-chrome.mp4

iOS: Native

31303-ios-native.mp4

iOS: mWeb Safari

31303-ios-safari.mp4

MacOS: Chrome / Safari

31303-web.mp4

MacOS: Desktop

31303-desktop.mp4

ntdiary

LGTM! :)
Additionally, @kubabutkiewicz, can you please add the QA steps? May be just a simple note that it is the same as the Tests.

melvin-bot · 2023-12-15T16:09:06Z

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

ntdiary · 2023-12-16T13:32:17Z

src/components/FormAlertWithSubmitButton.tsx

+            onFixTheErrorsLinkPressed={onFixTheErrorsLinkPressed}
+            errorMessageStyle={errorMessageStyle}
+        >
+            {(isOffline: boolean) => (


Additionally, after merging the main branch to this branch, we need to slightly modify this type. Perhaps we can use boolean | undefined ? :)

…s-migration/FormAlertWithSubmitButton/component

kubabutkiewicz · 2023-12-18T10:36:49Z

@ntdiary thanks ! done

OSBotify · 2023-12-18T14:47:43Z

✋ 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 · 2023-12-19T02:42:21Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.4.14-0 🚀

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

OSBotify · 2023-12-19T03:45:42Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.4.14-0 🚀

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

OSBotify · 2023-12-21T05:13:17Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.14-6 🚀

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

ref: started moving FormAlertWithSubmitButton to Typescript

76bf131

kubabutkiewicz added 2 commits November 24, 2023 12:53

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

afce2be

…s-migration/FormAlertWithSubmitButton/component

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

a14c893

…s-migration/FormAlertWithSubmitButton/component

VickyStash approved these changes Dec 11, 2023

View reviewed changes

fabioh8010 approved these changes Dec 12, 2023

View reviewed changes

pac-guerreiro reviewed Dec 12, 2023

View reviewed changes

src/components/FormAlertWithSubmitButton.tsx Show resolved Hide resolved

pac-guerreiro reviewed Dec 12, 2023

View reviewed changes

src/components/FormAlertWithSubmitButton.tsx Show resolved Hide resolved

pac-guerreiro reviewed Dec 12, 2023

View reviewed changes

BartoszGrajdek approved these changes Dec 12, 2023

View reviewed changes

kubabutkiewicz added 4 commits December 13, 2023 22:00

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

5f60d3c

…s-migration/FormAlertWithSubmitButton/component

fix: typo

747cc21

fix: typo

fdb2b8a

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

feab7c5

…s-migration/FormAlertWithSubmitButton/component

kubabutkiewicz marked this pull request as ready for review December 13, 2023 21:45

kubabutkiewicz requested a review from a team as a code owner December 13, 2023 21:45

melvin-bot bot requested review from ntdiary and removed request for a team December 13, 2023 21:45

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

3ff9bcf

…s-migration/FormAlertWithSubmitButton/component

ntdiary approved these changes Dec 15, 2023

View reviewed changes

melvin-bot bot requested a review from rlinoz December 15, 2023 16:09

ntdiary reviewed Dec 16, 2023

View reviewed changes

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

d48e53b

…s-migration/FormAlertWithSubmitButton/component

fix: resolve type issue

7f17798

rlinoz approved these changes Dec 18, 2023

View reviewed changes

rlinoz merged commit 11d7821 into Expensify:main Dec 18, 2023
13 checks passed

github-actions bot mentioned this pull request Dec 19, 2023

Deploy Checklist: New Expensify 2023-12-19 #33264

Closed

98 tasks

melvin-bot bot mentioned this pull request Dec 21, 2023

[HOLD for payment 2023-12-28] [TS migration] Migrate 'FormAlertWithSubmitButton.js' component to TypeScript #25017

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'FormAlertWithSubmitButton.js' component to TypeScript #31303

[TS migration] Migrate 'FormAlertWithSubmitButton.js' component to TypeScript #31303

kubabutkiewicz commented Nov 14, 2023 •

edited

Loading

melvin-bot bot commented Nov 14, 2023

pac-guerreiro Dec 12, 2023

kubabutkiewicz Dec 13, 2023

pac-guerreiro Dec 13, 2023

pac-guerreiro Dec 12, 2023

kubabutkiewicz Dec 13, 2023

fabioh8010 Dec 13, 2023

pac-guerreiro Dec 13, 2023

rlinoz Dec 15, 2023

ntdiary Dec 16, 2023 •

edited

Loading

pac-guerreiro Dec 12, 2023

kubabutkiewicz Dec 13, 2023

BartoszGrajdek left a comment

pac-guerreiro commented Dec 13, 2023 •

edited

Loading

melvin-bot bot commented Dec 13, 2023

kubabutkiewicz commented Dec 15, 2023

ntdiary commented Dec 15, 2023 •

edited

Loading

ntdiary left a comment •

edited

Loading

melvin-bot bot commented Dec 15, 2023

ntdiary Dec 16, 2023

kubabutkiewicz commented Dec 18, 2023

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

[TS migration] Migrate 'FormAlertWithSubmitButton.js' component to TypeScript #31303

[TS migration] Migrate 'FormAlertWithSubmitButton.js' component to TypeScript #31303

Conversation

kubabutkiewicz commented Nov 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 14, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ntdiary Dec 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BartoszGrajdek left a comment

Choose a reason for hiding this comment

pac-guerreiro commented Dec 13, 2023 • edited Loading

melvin-bot bot commented Dec 13, 2023

kubabutkiewicz commented Dec 15, 2023

ntdiary commented Dec 15, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

ntdiary left a comment • edited Loading

Choose a reason for hiding this comment

melvin-bot bot commented Dec 15, 2023

Choose a reason for hiding this comment

kubabutkiewicz commented Dec 18, 2023

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

kubabutkiewicz commented Nov 14, 2023 •

edited

Loading

ntdiary Dec 16, 2023 •

edited

Loading

pac-guerreiro commented Dec 13, 2023 •

edited

Loading

ntdiary commented Dec 15, 2023 •

edited

Loading

ntdiary left a comment •

edited

Loading