[TS migration] Migrate G14 stories from storybook to Typescript #38056

ruben-rebelo · 2024-03-11T15:43:16Z

Details

[TS migration] Migrate AddressSearch, Banner, Button and ButtonWithDropdownMenu stories to typescript

Fixed Issues

$ #25345
$ #25346
$ #25347
$ #25348
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console
Run storybook
The above mention stories are working as previously

Offline tests

N/A

QA Steps

N/A

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

N/a

Android: mWeb Chrome

N/a

iOS: Native

N/a

iOS: mWeb Safari

N/a

MacOS: Chrome / Safari

N/a

MacOS: Desktop

N/a

…opdownMenu stories to typescript

melvin-bot · 2024-03-11T15:43:20Z

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

kubabutkiewicz · 2024-03-11T15:55:02Z

src/components/AddressSearch/index.tsx

@@ -455,3 +455,4 @@ function AddressSearch(
 AddressSearch.displayName = 'AddressSearchWithRef';

 export default forwardRef(AddressSearch);
+export type {AddressSearchProps};


Suggested change

export type {AddressSearchProps};

export type {AddressSearchProps};

kubabutkiewicz · 2024-03-11T15:55:15Z

src/components/Banner.tsx

@@ -109,3 +109,4 @@ function Banner({text, onClose, onPress, containerStyles, textStyles, shouldRend
 Banner.displayName = 'Banner';

 export default memo(Banner);
+export type {BannerProps}


Suggested change

export type {BannerProps}

export type {BannerProps}

kubabutkiewicz · 2024-03-11T15:55:23Z

src/components/Button/index.tsx

@@ -348,3 +348,4 @@ function Button(
 Button.displayName = 'Button';

 export default withNavigationFallback(React.forwardRef(Button));
+export type {ButtonProps};


Suggested change

export type {ButtonProps};

export type {ButtonProps};

kubabutkiewicz · 2024-03-11T15:56:11Z

src/stories/AddressSearch.stories.tsx

    return (
        <AddressSearch
-            value={value}
-            onInputChange={({street}) => setValue(street)}
+            value={value as string}


why do we need this assertion here ?

This is needed because value can only be string but InputChange has multiple types that can be used.

kubabutkiewicz · 2024-03-11T15:59:34Z

src/stories/ButtonWithDropdownMenu.stories.tsx

    },
    pressOnEnter: true,
    options: [
-        {value: 'One', text: 'One'},
-        {value: 'Two', text: 'Two'},
+        {value: 'One', text: 'One', icon: Expensicons.Wallet},


why it is added here ?

Options has the mandatory icon param.

fabioh8010 · 2024-03-11T16:04:02Z

src/stories/AddressSearch.stories.tsx

@@ -15,12 +20,12 @@ export default {
    },
 };

-function Template(args) {
-    const [value, setValue] = useState('');
+function Template(args: AddressSearchProps) {


Suggested change

function Template(args: AddressSearchProps) {

function Template(props: AddressSearchProps) {

fabioh8010 · 2024-03-11T16:04:20Z

src/stories/Banner.stories.tsx

@@ -11,25 +15,25 @@ const story = {
    component: Banner,
 };

-function Template(args) {
+function Template(args: BannerProps) {


Suggested change

function Template(args: BannerProps) {

function Template(props: BannerProps) {

fabioh8010 · 2024-03-11T16:04:29Z

src/stories/Button.stories.tsx

    title: 'Components/Button',
    component: Button,
 };

-function Template(args) {
+function Template(args: ButtonProps) {


Suggested change

function Template(args: ButtonProps) {

function Template(props: ButtonProps) {

fabioh8010 · 2024-03-11T16:04:37Z

src/stories/ButtonWithDropdownMenu.stories.tsx

@@ -11,23 +15,23 @@ const story = {
    component: ButtonWithDropdownMenu,
 };

-function Template(args) {
+function Template(args: ButtonWithDropdownMenuProps<unknown>) {


Suggested change

function Template(args: ButtonWithDropdownMenuProps<unknown>) {

function Template(props: ButtonWithDropdownMenuProps<unknown>) {

melvin-bot · 2024-03-15T17:34:50Z

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

DylanDylann · 2024-03-20T06:43:56Z

@ruben-rebelo Could you help to merge the latest main?

DylanDylann · 2024-03-20T11:20:08Z

src/stories/ButtonWithDropdownMenu.stories.tsx

 Default.args = {
-    buttonText: 'Pay using Expensify',
+    customText: 'Pay using Expensify',


@ruben-rebelo Why do you change here?

@DylanDylann This was changed because the actual prop which sets the text of the button is now customText instead of buttonText.

DylanDylann · 2024-03-20T11:20:58Z

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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.

Only post video on web

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-03-22.at.17.36.54.mov

MacOS: Desktop

DylanDylann · 2024-03-22T03:11:28Z

@ruben-rebelo Bump on this one

fabioh8010 · 2024-03-22T07:37:21Z

@ruben-rebelo let's merge with main and reply this comment!

ruben-rebelo · 2024-03-22T09:07:21Z

@DylanDylann I've merged main and answered the comment above

DylanDylann · 2024-03-22T09:27:49Z

@ruben-rebelo While testing, I see that ButtonWithDropdownMenu is lost in storybook after applying your change

Latest main:

After applying your change

ruben-rebelo · 2024-03-22T10:02:25Z

@DylanDylann You are correct, I've fixed the issue and updated the PR.
Please take a look.
Thank you!

melvin-bot · 2024-03-22T10:39:16Z

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

DylanDylann · 2024-03-22T11:21:49Z

@francoisl Please also help to assign me to corresponding issues

melvin-bot · 2024-03-22T17:14:25Z

@francoisl 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-22T17:20:22Z

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

francoisl · 2024-03-22T17:24:03Z

Tests were passing 😕

[TS migration] Migrate AddressSearch, Banner, Button and ButtonWithDr…

ff0c54f

…opdownMenu stories to typescript

kubabutkiewicz reviewed Mar 11, 2024

View reviewed changes

fabioh8010 reviewed Mar 11, 2024

View reviewed changes

[TS migration][G14] Lint fix

90d87e9

fabioh8010 approved these changes Mar 12, 2024

View reviewed changes

kubabutkiewicz approved these changes Mar 12, 2024

View reviewed changes

blazejkustra approved these changes Mar 12, 2024

View reviewed changes

ruben-rebelo marked this pull request as ready for review March 15, 2024 17:34

ruben-rebelo requested a review from a team as a code owner March 15, 2024 17:34

melvin-bot bot requested review from DylanDylann and removed request for a team March 15, 2024 17:34

DylanDylann reviewed Mar 20, 2024

View reviewed changes

Merge branch 'main' into ts-migration/g14

c988f96

[TS migration][g14] Fixed buttonwithdropdownmenu story

cc466d2

DylanDylann approved these changes Mar 22, 2024

View reviewed changes

melvin-bot bot requested a review from francoisl March 22, 2024 10:39

francoisl approved these changes Mar 22, 2024

View reviewed changes

francoisl merged commit 7f5cf61 into Expensify:main Mar 22, 2024
17 checks passed

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

francoisl removed the Emergency label Mar 22, 2024

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

Deploy Checklist: New Expensify 2024-03-27 #39033

Closed

DylanDylann mentioned this pull request Mar 30, 2024

[$500] [HOLD for payment 2024-03-26] [Simplified Collect][Taxes] Create WorkspaceTaxesSettingsPage #37788

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate G14 stories from storybook to Typescript #38056

[TS migration] Migrate G14 stories from storybook to Typescript #38056

ruben-rebelo commented Mar 11, 2024

melvin-bot bot commented Mar 11, 2024

kubabutkiewicz Mar 11, 2024

kubabutkiewicz Mar 11, 2024

kubabutkiewicz Mar 11, 2024

kubabutkiewicz Mar 11, 2024

ruben-rebelo Mar 11, 2024

kubabutkiewicz Mar 11, 2024

ruben-rebelo Mar 11, 2024

fabioh8010 Mar 11, 2024

fabioh8010 Mar 11, 2024

fabioh8010 Mar 11, 2024

fabioh8010 Mar 11, 2024

melvin-bot bot commented Mar 15, 2024

DylanDylann commented Mar 20, 2024

DylanDylann Mar 20, 2024

ruben-rebelo Mar 22, 2024

DylanDylann commented Mar 20, 2024 •

edited

Loading

DylanDylann commented Mar 22, 2024

fabioh8010 commented Mar 22, 2024

ruben-rebelo commented Mar 22, 2024

DylanDylann commented Mar 22, 2024

ruben-rebelo commented Mar 22, 2024

melvin-bot bot commented Mar 22, 2024

DylanDylann commented Mar 22, 2024

melvin-bot bot commented Mar 22, 2024

OSBotify commented Mar 22, 2024

francoisl commented Mar 22, 2024

	export type {AddressSearchProps};

	export type {AddressSearchProps};

	function Template(args: AddressSearchProps) {
	function Template(props: AddressSearchProps) {

	function Template(args: BannerProps) {
	function Template(props: BannerProps) {

	function Template(args: ButtonProps) {
	function Template(props: ButtonProps) {

	function Template(args: ButtonWithDropdownMenuProps<unknown>) {
	function Template(props: ButtonWithDropdownMenuProps<unknown>) {

[TS migration] Migrate G14 stories from storybook to Typescript #38056

[TS migration] Migrate G14 stories from storybook to Typescript #38056

Conversation

ruben-rebelo commented Mar 11, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 11, 2024

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

melvin-bot bot commented Mar 15, 2024

DylanDylann commented Mar 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DylanDylann commented Mar 20, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

DylanDylann commented Mar 22, 2024

fabioh8010 commented Mar 22, 2024

ruben-rebelo commented Mar 22, 2024

DylanDylann commented Mar 22, 2024

ruben-rebelo commented Mar 22, 2024

melvin-bot bot commented Mar 22, 2024

DylanDylann commented Mar 22, 2024

melvin-bot bot commented Mar 22, 2024

OSBotify commented Mar 22, 2024

francoisl commented Mar 22, 2024

DylanDylann commented Mar 20, 2024 •

edited

Loading