[No QA][TS migration] Migrate Storybook files #37771

ruben-rebelo · 2024-03-05T16:24:58Z

Details

[TS migration] Migrate *Storybook to TypeScript

Fixed Issues

$ #25334
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console
Run storybook
Storybook works as before

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Same as in the Tests section.

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

kubabutkiewicz · 2024-03-05T16:50:36Z

.storybook/preview.tsx

 import './fonts.css';

+type Parameter = {


I think there is a built in Storybook type for that
import { Parameters } from '@storybook/addons';

kubabutkiewicz · 2024-03-05T16:52:30Z

.storybook/main.ts

+    managerHead: (head: string) => string;
+};
+
+const main: Main = {


Also for this there is a built in type
import { StorybookConfig } from '@storybook/core-common';

fabioh8010 · 2024-03-06T09:02:40Z

.storybook/webpack.config.ts

+import {DefinePlugin} from 'webpack';
+import type {Configuration, RuleSetRule} from 'webpack';
+
+type CustomWebpackConfig = {


Could you check if there is already some webpack type we can use for it?

We are already using Configuration from webpack. CustomWebpackConfig was created to workaround some type issues, without this type we would need to have a lot of condition to TS comply with the correct typing.
I find Configuration from webpack a bit too generic for this specific case.

.storybook/webpack.config.ts

blazejkustra · 2024-03-11T15:10:56Z

.storybook/webpack.config.ts

+    };
+};
+
+let envFile;


Isn't it any in this case?

I've updated this type, thanks!

melvin-bot · 2024-03-12T10:02:43Z

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

ntdiary · 2024-03-13T12:55:32Z

@ruben-rebelo, the page can't display icons, but it woks on the main branch. BTW, the lint test failed.

ntdiary · 2024-03-13T13:36:55Z

.storybook/webpack.config.ts

+            (rule): rule is RuleSetRule =>
+                typeof rule !== 'boolean' && typeof rule !== 'string' && typeof rule !== 'number' && !!rule?.test && rule.test instanceof RegExp && rule.test.test('.svg'),
+        );
+        if (fileLoaderRule?.exclude) {


Suggested change

if (fileLoaderRule?.exclude) {

if (fileLoaderRule) {

ruben-rebelo · 2024-03-22T09:50:13Z

@ntdiary Thank you, I've updated the PR

ntdiary · 2024-03-22T14:49:42Z

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.

Screenshots/Videos

Android: Native

n/a

Android: mWeb Chrome

n/a

iOS: Native

n/a

iOS: mWeb Safari

n/a

MacOS: Chrome / Safari

37771-web.mp4

MacOS: Desktop

n/a

ntdiary

melvin-bot · 2024-03-22T14:51:43Z

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

blazejkustra · 2024-03-25T12:27:36Z

@ntdiary Would you mind approved a second time? No internal got assigned

.storybook/webpack.config.ts

MonilBhavsar · 2024-03-26T11:25:43Z

.storybook/webpack.config.ts

+    };
+};
+
+let envFile: string | null;


envFile can be of type string only?

I've updated removed null

Co-authored-by: Błażej Kustra <46095609+blazejkustra@users.noreply.github.com>

…elo/App into ts-migration/storybook

MonilBhavsar · 2024-03-26T17:10:18Z

Thanks!

melvin-bot · 2024-03-26T17:10:42Z

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

MonilBhavsar · 2024-03-26T17:11:10Z

All tests were passing!

OSBotify · 2024-03-26T17:16:45Z

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

[TS migration] Migrate Storybook files

e3c79db

kubabutkiewicz reviewed Mar 5, 2024

View reviewed changes

fabioh8010 reviewed Mar 6, 2024

View reviewed changes

ruben-rebelo added 2 commits March 6, 2024 14:55

[TS migration][Storybook] Feedback

d906791

[TS migration][Storybook] Lint

2f5bf90

fabioh8010 approved these changes Mar 8, 2024

View reviewed changes

blazejkustra suggested changes Mar 11, 2024

View reviewed changes

[TS migration][storybook] Fixed styling and feedback

1acd6ea

ruben-rebelo marked this pull request as ready for review March 12, 2024 10:02

ruben-rebelo requested a review from a team as a code owner March 12, 2024 10:02

melvin-bot bot requested review from ntdiary and removed request for a team March 12, 2024 10:02

blazejkustra approved these changes Mar 12, 2024

View reviewed changes

ntdiary reviewed Mar 13, 2024

View reviewed changes

ruben-rebelo added 2 commits March 22, 2024 09:37

Merge branch 'main' into ts-migration/storybook

cadc458

[TS migration][Storybook] Feedback

57fe5e7

ntdiary approved these changes Mar 22, 2024

View reviewed changes

ntdiary approved these changes Mar 25, 2024

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar March 25, 2024 14:35

MonilBhavsar reviewed Mar 26, 2024

View reviewed changes

ruben-rebelo and others added 4 commits March 26, 2024 16:07

Update .storybook/webpack.config.ts

58ab1f2

Co-authored-by: Błażej Kustra <46095609+blazejkustra@users.noreply.github.com>

[TS migration][Webpack] changed envFile to be only string

68210c3

Merge branch 'ts-migration/storybook' of https://github.com/ruben-reb…

7da601f

…elo/App into ts-migration/storybook

[TS migration][webpack] Prettier

4fc0eed

MonilBhavsar approved these changes Mar 26, 2024

View reviewed changes

MonilBhavsar merged commit 271a3b2 into Expensify:main Mar 26, 2024
16 checks passed

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

MonilBhavsar removed the Emergency label Mar 26, 2024

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

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

Closed

melvin-bot bot mentioned this pull request Mar 29, 2024

[HOLD for payment 2024-04-05] [TS migration] Migrate 'Storybook' files to TypeScript #25334

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA][TS migration] Migrate Storybook files #37771

[No QA][TS migration] Migrate Storybook files #37771

ruben-rebelo commented Mar 5, 2024

kubabutkiewicz Mar 5, 2024

kubabutkiewicz Mar 5, 2024

fabioh8010 Mar 6, 2024

ruben-rebelo Mar 6, 2024

blazejkustra Mar 11, 2024

ruben-rebelo Mar 12, 2024

melvin-bot bot commented Mar 12, 2024

ntdiary commented Mar 13, 2024 •

edited

Loading

ntdiary Mar 13, 2024

ruben-rebelo commented Mar 22, 2024

ntdiary commented Mar 22, 2024 •

edited

Loading

ntdiary left a comment

melvin-bot bot commented Mar 22, 2024

blazejkustra commented Mar 25, 2024

MonilBhavsar Mar 26, 2024

ruben-rebelo Mar 26, 2024

MonilBhavsar commented Mar 26, 2024

melvin-bot bot commented Mar 26, 2024

MonilBhavsar commented Mar 26, 2024

OSBotify commented Mar 26, 2024

[No QA][TS migration] Migrate Storybook files #37771

[No QA][TS migration] Migrate Storybook files #37771

Conversation

ruben-rebelo commented Mar 5, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

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 12, 2024

ntdiary commented Mar 13, 2024 • edited Loading

Choose a reason for hiding this comment

ruben-rebelo commented Mar 22, 2024

ntdiary commented Mar 22, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ntdiary left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Mar 22, 2024

blazejkustra commented Mar 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MonilBhavsar commented Mar 26, 2024

melvin-bot bot commented Mar 26, 2024

MonilBhavsar commented Mar 26, 2024

OSBotify commented Mar 26, 2024

ntdiary commented Mar 13, 2024 •

edited

Loading

ntdiary commented Mar 22, 2024 •

edited

Loading