Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TS migration] Migrate 'MoneyReportHeader.js' component to TypeScript #33570

Merged
merged 29 commits into from
Jan 17, 2024

Conversation

KrAbhas
Copy link
Contributor

@KrAbhas KrAbhas commented Dec 25, 2023

Details

Migrating the MoneyReportHeader component from jsx to tsx

Fixed Issues

Typescript migration for MoneyReportHeader

$ #25108
PROPOSAL: #25108 (comment)

Tests

  1. Create a Money Request
  2. Go to created Money Request
  3. Verify that you can see the header
  4. Verify clicking on 3 dot menu shows the pop-over
  5. Create the send money report and perform above 4 steps for this as well.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests steps.

QA Steps

Same as Tests steps.

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
android_native.mov
Android: mWeb Chrome
androidmweb.mov
iOS: Native Screenshot 2023-12-29 at 9 15 15 PM
iphone_native.mov
iOS: mWeb Safari
iphonemweb.mov
MacOS: Chrome / Safari For request report Screenshot 2023-12-26 at 4 08 37 AM For sent report Screenshot 2023-12-28 at 8 26 56 PM
MacOS: Desktop Screenshot 2023-12-26 at 4 08 37 AM

@KrAbhas KrAbhas requested a review from a team as a code owner December 25, 2023 22:11
@melvin-bot melvin-bot bot removed the request for review from a team December 25, 2023 22:12
Copy link

melvin-bot bot commented Dec 25, 2023

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

@melvin-bot melvin-bot bot requested a review from rlinoz December 25, 2023 22:12
@KrAbhas KrAbhas changed the title [TS MIGRATION]Typescript migration for MoneyRequestHeader [TS MIGRATION]Typescript migration for MoneyReportHeader Dec 25, 2023
@VickyStash
Copy link
Contributor

@KrAbhas Please, resolve lint and TS errors. If the TS issue appears due to not migrated files, follow the rules described in the guidelines.

Also please add screenshots for every platform.

@KrAbhas KrAbhas requested a review from VickyStash December 28, 2023 04:55
@KrAbhas
Copy link
Contributor Author

KrAbhas commented Dec 28, 2023

Lint issues have been resolved, I am testing and adding the screenshots, will be done in a couple of hours. Will let you know once completed.

@KrAbhas Please, resolve lint and TS errors. If the TS issue appears due to not migrated files, follow the rules described in the guidelines.

Also please add screenshots for every platform.

src/components/MoneyReportHeader.tsx Outdated Show resolved Hide resolved
src/components/MoneyReportHeader.tsx Outdated Show resolved Hide resolved
src/components/MoneyReportHeader.tsx Outdated Show resolved Hide resolved
src/components/MoneyReportHeader.tsx Outdated Show resolved Hide resolved
src/components/MoneyReportHeader.tsx Outdated Show resolved Hide resolved
src/components/MoneyReportHeader.tsx Outdated Show resolved Hide resolved
src/components/MoneyReportHeader.tsx Outdated Show resolved Hide resolved
src/components/MoneyReportHeader.tsx Outdated Show resolved Hide resolved
src/components/MoneyReportHeader.tsx Outdated Show resolved Hide resolved
src/components/MoneyReportHeader.tsx Outdated Show resolved Hide resolved
@VickyStash
Copy link
Contributor

Please update PR name to follow the issue name, so
[TS migration] Migrate 'MoneyReportHeader.js' component to TypeScript

@KrAbhas KrAbhas changed the title [TS MIGRATION]Typescript migration for MoneyReportHeader [TS migration] Migrate 'MoneyReportHeader.js' component to TypeScript Dec 28, 2023
Copy link
Contributor

@VickyStash VickyStash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@KrAbhas
Copy link
Contributor Author

KrAbhas commented Dec 29, 2023

I will attach the screenshots for mobile devices soon, after resolving some of the setup issues. Almost solved, due to new Mac setup facing some trouble.

@KrAbhas
Copy link
Contributor Author

KrAbhas commented Dec 29, 2023

Added all screenshots and videos.

@KrAbhas
Copy link
Contributor Author

KrAbhas commented Jan 5, 2024

@rlinoz , everything updated. The lint error is coming from some other files(not changed in this PR), so will be fixed as part of other issues I guess.

@rlinoz
Copy link
Contributor

rlinoz commented Jan 5, 2024

Thanks @KrAbhas, I believe the lint fix was merged, would you mind merging main once more?

@KrAbhas
Copy link
Contributor Author

KrAbhas commented Jan 6, 2024

@rlinoz Yes it's fixed. Thanks!

src/libs/HeaderUtils.ts Outdated Show resolved Hide resolved
rlinoz
rlinoz previously approved these changes Jan 9, 2024
@rlinoz
Copy link
Contributor

rlinoz commented Jan 9, 2024

Oh I approved, but lint is failing

@mananjadhav
Copy link
Collaborator

Yes I am still waiting on the lint fixes, will start with the checklist then.

@KrAbhas Can you please fix the lint issue?

@flodnv flodnv requested a review from mananjadhav January 10, 2024 15:43
@mananjadhav
Copy link
Collaborator

mananjadhav commented Jan 11, 2024

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(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-money-report-header.mov
Android: mWeb Chrome
mweb-chrome-money-report-header.mov
iOS: Native
ios-money-report-header.mov
iOS: mWeb Safari
mweb-safari-money-report-header.mov
MacOS: Chrome / Safari
web-money-report-header.mov
MacOS: Desktop
desktop-money-report-header.mov

Copy link

melvin-bot bot commented Jan 14, 2024

🎯 @mananjadhav, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #34484.

@rlinoz
Copy link
Contributor

rlinoz commented Jan 15, 2024

One more conflict to go, then we can merge.

@blazejkustra
Copy link
Contributor

@KrAbhas Please resolve conflicts

@KrAbhas
Copy link
Contributor Author

KrAbhas commented Jan 16, 2024

@rlinoz some problem is coming from master in unchanged file related to typecheck. please tag me once fixed, I will take a fresh pull.

@rlinoz rlinoz merged commit 6034b10 into Expensify:main Jan 17, 2024
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.4.27-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.27-1 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants