[TS migration] Migrate 'Banner.js' component to TypeScript by VickyStash · Pull Request #31496 · Expensify/App

VickyStash · 2023-11-17T17:45:52Z

Details

[TS migration] Migrate 'Banner.js' component to TypeScript

Fixed Issues

$ #25088
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Storybook:

Open Storybook -> Banner
Make sure Banner components look ok (Banner with link, HTML Banner, Info Banner)

App:

Open a chat of the archived workspace.
Make sure a Banner about archived workspace looks ok.

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Storybook:

Open Storybook -> Banner
Make sure Banner components look ok (Banner with link, HTML Banner, Info Banner)

App:

Open a chat of the archived workspace.
Make sure a Banner about archived workspace looks ok.

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

Storybook

fabioh8010 · 2023-11-20T08:59:08Z

                        </View>
-                        {props.shouldShowCloseButton && (
-                            <Tooltip text={props.translate('common.close')}>
+                        {shouldShowCloseButton && !!onClose && (


This will probably create a regression here as onClose/onPress props are optional.

@fabioh8010 Since onClose is passed together with shouldShowCloseButton, and in your example shouldShowCloseButton isn't passed and will be false by default, I think it should be ok.

Makes sense, thanks!

NAB: Fine with this change but after this change, I am not sure about the need of shouldShowCloseButton prop. onClose prop should be enough.

fabioh8010 · 2023-11-20T09:09:19Z

                        </View>
-                        {props.shouldShowCloseButton && (
-                            <Tooltip text={props.translate('common.close')}>
+                        {shouldShowCloseButton && !!onClose && (


Makes sense, thanks!

BartoszGrajdek

LGTM!

melvin-bot · 2023-11-20T16:15:15Z

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

0xmiroslav · 2023-11-21T11:28:45Z

Error: The package "@esbuild/darwin-x64" could not be found, and is needed by esbuild.

I am getting this error while running storybook. Anyone can help?

Edit: fixed by installing esbuild

0xmiroslav · 2023-11-21T11:37:48Z

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 / Chrome
- iOS / native
- iOS / 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(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.
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.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

storybook.mov

MacOS: Desktop

desktop.mov

0xmiroslav

LGTM!

melvin-bot · 2023-11-21T11:38:18Z

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

bondydaa · 2023-11-22T17:58:06Z

looks like some places we use .ts and other .tsx extension, does it matter which one is used?

@bondydaa Yeah, we use .tsx extension when a file has JSX syntax (components for example), otherwise it's just .ts

ah yeah makes sense 🤦

OSBotify · 2023-11-22T18:02:20Z

✋ 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-11-23T17:11:12Z

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.4.3-0 🚀

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

OSBotify · 2023-11-23T17:51:22Z

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.4.3-0 🚀

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

OSBotify · 2023-11-27T19:05:18Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.3-11 🚀

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

VickyStash added 2 commits November 17, 2023 18:37

[TS migration] Migrate 'Banner.js' component

67a29ca

Replace withLocalize HOC with hook usage

c4ca2d5

fabioh8010 reviewed Nov 20, 2023

View reviewed changes

fabioh8010 approved these changes Nov 20, 2023

View reviewed changes

BartoszGrajdek approved these changes Nov 20, 2023

View reviewed changes

VickyStash marked this pull request as ready for review November 20, 2023 16:15

VickyStash requested a review from a team as a code owner November 20, 2023 16:15

melvin-bot Bot requested review from 0xmiroslav and removed request for a team November 20, 2023 16:15

0xmiroslav approved these changes Nov 21, 2023

View reviewed changes

melvin-bot Bot requested a review from bondydaa November 21, 2023 11:38

bondydaa approved these changes Nov 22, 2023

View reviewed changes

bondydaa merged commit 856b6e7 into Expensify:main Nov 22, 2023

github-actions Bot mentioned this pull request Nov 23, 2023

Deploy Checklist: New Expensify 2023-11-23 #31786

Closed

60 tasks done

melvin-bot Bot mentioned this pull request Nov 27, 2023

[HOLD for payment 2023-12-04] [TS migration] Migrate 'Banner.js' component to TypeScript #25088

Closed

Conversation

VickyStash commented Nov 17, 2023 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BartoszGrajdek left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Nov 20, 2023

Uh oh!

0xmiroslav commented Nov 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

0xmiroslav commented Nov 21, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

0xmiroslav left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Nov 21, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 22, 2023

Uh oh!

OSBotify commented Nov 23, 2023

Uh oh!

OSBotify commented Nov 23, 2023

Uh oh!

OSBotify commented Nov 27, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

VickyStash commented Nov 17, 2023 •

edited

Loading

0xmiroslav commented Nov 21, 2023 •

edited

Loading