[TS migration] Migrate 'Composer.stories.js', 'DragAndDrop.stories.js', 'Form.stories.js' and 'RadioButtonWithLabel.stories.js' stories to TypeScript by VickyStash · Pull Request #37820 · Expensify/App

VickyStash · 2024-03-06T13:56:32Z

Details

[TS migration] Migrate 'Composer.stories.js', 'DragAndDrop.stories.js', 'Form.stories.js' and 'RadioButtonWithLabel.stories.js' stories to TypeScript

Fixed Issues

$ #25355
$ #25356
$ #25357
$ #32036

PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Launch storybook.
Open DragAndDrop story. Drop an image to the drop area, make sure it works as before.
Open RadioButtonWithLabel story. Make sure checked/unchecked radio button looks ok.
Open Composer story. Make sure it looks the same way as before.
Open Form story. Looks through forms and make sure they look and works as before.
5.1 Default form - mark Terms and Conditions checkbox and press Submit button. Popup with submitted info should appear in a couple of seconds.
5.2 Input Error - press Submit button - whole form should be in different validation errors.
5.3 Loading - loading indicator should be shown instead of Submit button.
5.4 Server Error - error message should display above Submit button
5.5 With Native Event Handler - input values, they also should display below input

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Same as in the Tests section.

PR Author Checklist

Screenshots/Videos

Composer

DragAndDrop

DragAndDrop.mp4

Form

form.mp4

RadioButtonWithLabel

VickyStash · 2024-03-06T13:57:38Z

src/stories/Composer.stories.tsx

                    multiline
                    onChangeText={setComment}
                    onPasteFile={setPastedFile}
                    style={[defaultStyles.textInputCompose, defaultStyles.w100, defaultStyles.verticalAlignTop]}
                />
            </View>
            <View style={[defaultStyles.flexRow, defaultStyles.mv5, defaultStyles.flexWrap, defaultStyles.w100]}>
-                <View
-                    style={[defaultStyles.border, defaultStyles.noLeftBorderRadius, defaultStyles.noRightBorderRadius, defaultStyles.p5, defaultStyles.flex1]}
-                    id={CONST.REPORT.DROP_NATIVE_ID}


DROP_NATIVE_ID doesn't exist in CONST.REPORT

VickyStash · 2024-03-07T15:31:19Z

src/stories/Form.stories.tsx

+    if (args.formState?.error) {
+        FormActions.setErrors(args.formID, {error: args.formState.error as MaybePhraseKey});
+    } else {
+        FormActions.clearErrors(args.formID);
+    }


Before, this method FormActions.setErrors(args.formID, args.formState.error); was used for both setting and clearing error. But that approach wasn't aligned with our current typing.

VickyStash · 2024-03-07T15:31:49Z

src/stories/Form.stories.tsx

+    if (args.formState?.error) {
+        FormActions.setErrors(args.formID, {error: args.formState.error as MaybePhraseKey});
+    } else {
+        FormActions.clearErrors(args.formID);
+    }


See this comment

melvin-bot · 2024-03-07T15:47:38Z

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

src/ONYXKEYS.ts

src/stories/Form.stories.tsx

blazejkustra · 2024-03-11T15:07:00Z

This doesn't require QA, right? How about adding [No QA] to the title?

blazejkustra · 2024-03-11T15:07:48Z

src/components/DragAndDrop/Provider/types.ts


    /** Indicate that users are dragging file or not */
-    setIsDraggingOver: (value: boolean) => void;
+    setIsDraggingOver?: (value: boolean) => void;


Are you sure this should be optional?

@blazejkustra Yep, it's already so on the main. Report screen uses DragAndDropProvider without setIsDraggingOver as well.

VickyStash · 2024-03-11T17:05:58Z

This doesn't require QA, right? How about adding [No QA] to the title?

@blazejkustra It's possible to test it and I've specified test steps, but I'm okay to mark it as No QA if there is an agreement for stories as well 👌

melvin-bot · 2024-03-12T09:07:02Z

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

c3024 · 2024-03-12T12:48:11Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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

melvin-bot · 2024-03-12T12:51:20Z

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

NikkiWines

melvin-bot · 2024-03-12T20:49:30Z

@NikkiWines 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 · 2024-03-12T20:54:30Z

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

NikkiWines · 2024-03-12T22:44:57Z

tests were definitely passing when I merged 🤔

OSBotify · 2024-03-13T19:59:36Z

🚀 Deployed to staging by https://github.com/NikkiWines in version: 1.4.52-0 🚀

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

OSBotify · 2024-03-15T10:15:57Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.52-6 🚀

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

[TS migration] Migrate Composer and DragAndDrop story

ec5777f

VickyStash commented Mar 6, 2024

View reviewed changes

VickyStash added 4 commits March 6, 2024 15:38

[TS migration] Migrate RadioButtonWithLabel story

12a6bc4

[TS migration] Migrate Form story

98cf7d7

Code improvement

6702201

Lint fix

ff352a3

VickyStash commented Mar 7, 2024

View reviewed changes

fabioh8010 reviewed Mar 8, 2024

View reviewed changes

src/ONYXKEYS.ts Outdated Show resolved Hide resolved

Update storybook form typing

763e621

fabioh8010 approved these changes Mar 8, 2024

View reviewed changes

src/stories/Form.stories.tsx Outdated Show resolved Hide resolved

src/stories/Form.stories.tsx Outdated Show resolved Hide resolved

Code improvements

42d69f1

JKobrynski approved these changes Mar 11, 2024

View reviewed changes

blazejkustra approved these changes Mar 11, 2024

View reviewed changes

VickyStash marked this pull request as ready for review March 12, 2024 09:06

VickyStash requested a review from a team as a code owner March 12, 2024 09:06

melvin-bot bot requested review from c3024 and removed request for a team March 12, 2024 09:07

ruben-rebelo mentioned this pull request Mar 12, 2024

[No QA][TS migration] Migrate multiple unit and Performance test to Typescript #37685

Merged

49 tasks

c3024 approved these changes Mar 12, 2024

View reviewed changes

melvin-bot bot requested a review from NikkiWines March 12, 2024 12:53

NikkiWines approved these changes Mar 12, 2024

View reviewed changes

NikkiWines merged commit 9117956 into Expensify:main Mar 12, 2024

melvin-bot bot added the Emergency label Mar 12, 2024

NikkiWines removed the Emergency label Mar 12, 2024

github-actions bot mentioned this pull request Mar 13, 2024

Deploy Checklist: New Expensify 2024-03-13 #38257

Closed

74 tasks

lanitochka17 mentioned this pull request Mar 14, 2024

[HOLD for payment 2024-04-05] [$500] Storybook - "Couldn't find a navigation object" error when trying to select a year #38331

Closed

6 tasks

Conversation

VickyStash commented Mar 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

VickyStash Mar 6, 2024

Choose a reason for hiding this comment

Uh oh!

VickyStash Mar 7, 2024

Choose a reason for hiding this comment

Uh oh!

VickyStash Mar 7, 2024

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Mar 7, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blazejkustra commented Mar 11, 2024

Uh oh!

blazejkustra Mar 11, 2024

Choose a reason for hiding this comment

Uh oh!

VickyStash Mar 11, 2024

Choose a reason for hiding this comment

Uh oh!

VickyStash commented Mar 11, 2024

Uh oh!

melvin-bot bot commented Mar 12, 2024

Uh oh!

c3024 commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Mar 12, 2024

Uh oh!

NikkiWines left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Mar 12, 2024

Uh oh!

OSBotify commented Mar 12, 2024

Uh oh!

NikkiWines commented Mar 12, 2024

Uh oh!

OSBotify commented Mar 13, 2024

Uh oh!

OSBotify commented Mar 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

VickyStash commented Mar 6, 2024 •

edited

Loading

c3024 commented Mar 12, 2024 •

edited

Loading