[No QA] [TS migration] Migrate 'CustomStatusBar' component to TypeScript by kubabutkiewicz · Pull Request #29753 · Expensify/App

kubabutkiewicz · 2023-10-17T11:37:26Z

Details

Fixed Issues

$ #24977

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Click on FAB icon
Select 'Save the World'
Verify everything looks good
Go to Settings
Select Workspace, Preference, Security, Wallet
Check if everything looks good

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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

VickyStash · 2023-10-17T12:34:59Z

    [SCREENS.SETTINGS.SECURITY]: colors.ice500,
    [SCREENS.SETTINGS.STATUS]: colors.green700,
    [SCREENS.SETTINGS.ROOT]: darkTheme.sidebar,
+    [SCREENS.SETTINGS.WALLET]: '',


@kubabutkiewicz Do you still need this?

I don't need that , thanks @VickyStash fixed

blazejkustra · 2023-10-20T08:24:42Z

+            if (currentRoute?.name && themeColors.PAGE_BACKGROUND_COLORS[currentRoute.name]) {
                currentScreenBackgroundColor = themeColors.PAGE_BACKGROUND_COLORS[currentRoute.name];
            }


Suggested change

if (currentRoute?.name && themeColors.PAGE_BACKGROUND_COLORS[currentRoute.name]) {

currentScreenBackgroundColor = themeColors.PAGE_BACKGROUND_COLORS[currentRoute.name];

}

if (currentRoute?.name && currentRoute.name in themeColors.PAGE_BACKGROUND_COLORS) {

currentScreenBackgroundColor = themeColors.PAGE_BACKGROUND_COLORS[currentRoute.name as keyof typeof themeColors.PAGE_BACKGROUND_COLORS];

}

blazejkustra · 2023-10-20T08:25:01Z

    loungeAccessOverlay: colors.blue800,
    mapAttributionText: colors.black,
-    PAGE_BACKGROUND_COLORS: {},
+    PAGE_BACKGROUND_COLORS: {} as PageBackgroundColors,


How about moving colors into the object so satisfies ThemeBase works as expected?

Suggested change

PAGE_BACKGROUND_COLORS: {} as PageBackgroundColors,

PAGE_BACKGROUND_COLORS: {

[SCREENS.HOME]: colors.darkAppBackground,

[SCREENS.SAVE_THE_WORLD.ROOT]: colors.tangerine800,

[SCREENS.SETTINGS.PREFERENCES]: colors.blue500,

[SCREENS.SETTINGS.WORKSPACES]: colors.pink800,

[SCREENS.SETTINGS.SECURITY]: colors.ice500,

[SCREENS.SETTINGS.STATUS]: colors.green700,

[SCREENS.SETTINGS.ROOT]: colors.darkAppBackground,

},

and same for light theme

@kubabutkiewicz Actually you can wait for this PR to be merged first

…s-migration/CustomStatusBar/component

blazejkustra

Missing types.ts file @kubabutkiewicz

…s-migration/CustomStatusBar/component

kubabutkiewicz · 2023-11-17T11:48:03Z

@blazejkustra kindy bump 😄

melvin-bot · 2023-11-17T12:10:19Z

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

MonilBhavsar · 2023-11-20T09:06:19Z

+    (): React.ReactNode;
+    displayName?: string;


Sorry I didn't get it. Where are these properties used?

Maybe this came from CustomStatusBar.displayName = 'CustomStatusBar'; but we don't really need to type this.
I don't see the need of this file as CustomStatusBar component doesn't have any props

Exactly, I had similar thought

This is due to guidelines , here is the reasoning.

We don't have this pattern for any other TS components which have props.
Is it guideline not defining types of component itself if has props?
And defining types of component itself if no props?

Okay, why displayName is an optional property?

@MonilBhavsar adjusted, displayName is not optional now

We don't have this pattern for any other TS components which have props.
Is it guideline not defining types of component itself if has props?
And defining types of component itself if no props?

I think we should add this to our guidelines in .md file

…s-migration/CustomStatusBar/component

MonilBhavsar

Looks good, thanks!

MonilBhavsar · 2023-11-28T12:58:25Z

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(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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

MonilBhavsar · 2023-11-28T13:35:05Z

@kubabutkiewicz could you please merge main into this branch. Looks like android build is failing because of outdated branch

MonilBhavsar · 2023-11-28T18:51:21Z

Nevermind, it was an issue with my dev environment

OSBotify · 2023-11-28T18:55:33Z

✋ 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-30T12:14:54Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.5-7 🚀

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

kubabutkiewicz added 2 commits October 17, 2023 13:32

fix: correct theme types

dabd1be

fix: use less stricter type for theme

71bbb7d

VickyStash reviewed Oct 17, 2023

View reviewed changes

fix: removed unnecesary prop

1c9fb3c

blazejkustra suggested changes Oct 20, 2023

View reviewed changes

kubabutkiewicz added 3 commits October 30, 2023 09:59

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

721282c

…s-migration/CustomStatusBar/component

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

9105b4a

…s-migration/CustomStatusBar/component

fix: typings

004fe6e

kubabutkiewicz requested a review from blazejkustra November 7, 2023 15:53

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

34ac9e6

…s-migration/CustomStatusBar/component

blazejkustra suggested changes Nov 10, 2023

View reviewed changes

kubabutkiewicz added 2 commits November 13, 2023 16:41

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

6d95138

…s-migration/CustomStatusBar/component

fix: added types file

aba9339

blazejkustra suggested changes Nov 15, 2023

View reviewed changes

Comment thread src/components/CustomStatusBar/types.ts Outdated

kubabutkiewicz added 2 commits November 17, 2023 12:44

fix: resolve comments

91ff29e

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

23c5d03

…s-migration/CustomStatusBar/component

blazejkustra approved these changes Nov 17, 2023

View reviewed changes

kubabutkiewicz marked this pull request as ready for review November 17, 2023 12:09

kubabutkiewicz requested a review from a team as a code owner November 17, 2023 12:09

melvin-bot Bot requested review from MonilBhavsar and removed request for a team November 17, 2023 12:10

MonilBhavsar reviewed Nov 20, 2023

View reviewed changes

kubabutkiewicz added 2 commits November 24, 2023 10:51

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

3a65642

…s-migration/CustomStatusBar/component

fix: resolve comment

c071561

MonilBhavsar approved these changes Nov 28, 2023

View reviewed changes

MonilBhavsar merged commit 4e7ea29 into Expensify:main Nov 28, 2023

MonilBhavsar mentioned this pull request Nov 28, 2023

[HOLD for payment 2023-12-07] [TS migration] Migrate 'CustomStatusBar' component to TypeScript #24977

Closed

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

Deploy Checklist: New Expensify 2023-11-29 #32175

Closed

55 tasks

-    PAGE_BACKGROUND_COLORS: {} as PageBackgroundColors,
+    PAGE_BACKGROUND_COLORS: {
+        [SCREENS.HOME]: colors.darkAppBackground,
+        [SCREENS.SAVE_THE_WORLD.ROOT]: colors.tangerine800,
+        [SCREENS.SETTINGS.PREFERENCES]: colors.blue500,
+        [SCREENS.SETTINGS.WORKSPACES]: colors.pink800,
+        [SCREENS.SETTINGS.SECURITY]: colors.ice500,
+        [SCREENS.SETTINGS.STATUS]: colors.green700,
+        [SCREENS.SETTINGS.ROOT]: colors.darkAppBackground,
+    },

Conversation

kubabutkiewicz commented Oct 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!

Choose a reason for hiding this comment

Uh oh!

blazejkustra left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kubabutkiewicz commented Nov 17, 2023

Uh oh!

melvin-bot Bot commented Nov 17, 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!

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!

MonilBhavsar left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

MonilBhavsar commented Nov 28, 2023

Uh oh!

MonilBhavsar commented Nov 28, 2023

Uh oh!

OSBotify commented Nov 28, 2023

Uh oh!

OSBotify commented Nov 30, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kubabutkiewicz commented Oct 17, 2023 •

edited

Loading

MonilBhavsar commented Nov 28, 2023 •

edited

Loading