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.

Sign up for GitHub

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

Jump to bottom

[TS migration] Migrate 'ConfirmContent.js' component to TypeScript #31699

Merged
merged 12 commits into from
Dec 27, 2023
Merged

[TS migration] Migrate 'ConfirmContent.js' component to TypeScript #31699

merged 12 commits into from
Dec 27, 2023

Conversation

fvlvte
Copy link
Contributor

@fvlvte fvlvte commented Nov 22, 2023 •
edited
Loading

Details

Migrated ConfirmContent component to TypeScript.

Fixed Issues

$ #25047
PROPOSAL: N/A

Tests

  • Verify that no errors appear in the JS console

QA Steps

  • Verify that no errors appear in the JS console
  • Navigate to any chat
  • Click on any message context menu to delete it
  • Click cancel on dialog
  • Dialog disappeared and message is still in chat
  • Click on any message context menu to delete it
  • Click on confirm
  • Dialog disappeared and message was removed

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
android-web.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios-safari.mov
MacOS: Chrome / Safari
macos-web.mov
MacOS: Desktop
macos-desktop.mov

@fvlvte fvlvte requested a review from a team as a code owner November 22, 2023 13:43
@melvin-bot melvin-bot bot requested review from robertKozik and removed request for a team November 22, 2023 13:43
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Nov 22, 2023

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

@fvlvte
Copy link
Contributor Author

fvlvte commented Nov 22, 2023

Blocked by #25098

@fvlvte fvlvte marked this pull request as draft November 22, 2023 13:47
@fvlvte fvlvte changed the title [TS migration] Migrate 'ConfirmContent.js' component to TypeScript [BLOCKED][TS migration] Migrate 'ConfirmContent.js' component to TypeScript Nov 27, 2023
@fvlvte fvlvte changed the title [BLOCKED][TS migration] Migrate 'ConfirmContent.js' component to TypeScript [TS migration] Migrate 'ConfirmContent.js' component to TypeScript Dec 4, 2023
@fabioh8010
Copy link
Contributor

fabioh8010 commented Dec 6, 2023 •
edited
Loading

@fvlvte You can start working on this now.

rezkiy37
rezkiy37 reviewed Dec 7, 2023
View reviewed changes
Copy link
Contributor

@rezkiy37 rezkiy37 left a comment

Choose a reason for hiding this comment

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

Left a couple minor comments, after LGTM.

VickyStash
VickyStash suggested changes Dec 8, 2023
View reviewed changes
src/components/ConfirmContent.tsx Outdated
Comment on lines 16 to 20
/** A callback to call when the form has been submitted */
onConfirm: (...args: unknown[]) => void;

/** A callback to call when the form has been closed */
onCancel: (...args: unknown[]) => void;
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe it's possible to define specific props instead of using unknown?

src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated
Comment on lines 79 to 82
titleStyles = [],
promptStyles = [],
contentStyles = [],
iconAdditionalStyles = [],
Copy link
Contributor

Choose a reason for hiding this comment

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

No need in default values for styles

Suggested change
titleStyles = [],
promptStyles = [],
contentStyles = [],
iconAdditionalStyles = [],
titleStyles,
promptStyles,
contentStyles,
iconAdditionalStyles,

src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated
shouldShowCancelButton: boolean;

/** Icon to display above the title */
iconSource: null | string | ((props: unknown) => ReactNode);
Copy link
Contributor

Choose a reason for hiding this comment

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

I haven't found specific case where iconSource being passed to this component, could you confirm if there is a case where iconSource is used

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's not used anywhere but I think TS migration is not a place for feature removing - what do You think @fabioh8010?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure if we should remove to be honest.. it was added 4 months ago, looks still "fresh". @grgia I saw that your commit added this support for icon along with other thing, but this prop is not being used anymore. Do you know if we can remove the prop alongside with the logic to show the icon? Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

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

Since we got no response, @fvlvte let's keep it and proceed with this PR. Please let me know when the PR is ready to be re-reviewed again!

fabioh8010
fabioh8010 reviewed Dec 8, 2023
View reviewed changes
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
src/components/ConfirmContent.tsx Outdated Show resolved Hide resolved
@pac-guerreiro
Copy link
Contributor

@fvlvte LGTM 👍

@fabioh8010
Copy link
Contributor

@fvlvte Please resolve conflicts and tag us again for review

@fvlvte
Copy link
Contributor Author

fvlvte commented Dec 15, 2023

Resolved @fabioh8010 @pac-guerreiro

@fvlvte
Merge branch 'main' into 25047-migrate-confirmContent
a045dfa 
# Conflicts:
#	src/components/Icon/index.tsx
@fvlvte fvlvte marked this pull request as ready for review December 19, 2023 09:39
@fabioh8010
Copy link
Contributor

@fvlvte Please resolve conflicts.

@mountiny Looks like C+ assignment didn't work, could you assign someone? Thanks 🙇‍♂️

@mountiny mountiny requested review from thesahindia and mountiny and removed request for robertKozik December 22, 2023 15:41
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 27, 2023 •
edited
Loading

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@fvlvte fvlvte force-pushed the 25047-migrate-confirmContent branch from d895b7b to 81a25c8 Compare December 27, 2023 11:20
@fvlvte
Merge branch 'main' into 25047-migrate-confirmContent
d1daf2b 
# Conflicts:
#	src/components/ConfirmContent.js
#	src/components/Icon/index.tsx
@fvlvte
Applied changes from main.
9d85314
@fvlvte fvlvte force-pushed the 25047-migrate-confirmContent branch from 81a25c8 to 9d85314 Compare December 27, 2023 11:24
@thesahindia
Copy link
Member

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
Screen.Recording.2023-12-27.at.6.16.38.PM.mov
Android: mWeb Chrome
iOS: Native
Screen.Recording.2023-12-27.at.5.40.21.PM.mov
iOS: mWeb Safari
Screen.Recording.2023-12-27.at.5.41.32.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2023-12-27.at.5.14.39.PM.mov
MacOS: Desktop
Screen.Recording.2023-12-27.at.5.29.18.PM.mov

mountiny
mountiny approved these changes Dec 27, 2023
View reviewed changes
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks everyone!

@mountiny mountiny merged commit 6a4770a into Expensify:main Dec 27, 2023
16 of 17 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.

@github-actions github-actions bot mentioned this pull request Dec 27, 2023
Closed
41 tasks
@melvin-bot melvin-bot bot mentioned this pull request Dec 28, 2023
Closed
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.18-8 🚀

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

@fvlvte fvlvte deleted the 25047-migrate-confirmContent branch December 30, 2023 00:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pac-guerreiro pac-guerreiro pac-guerreiro left review comments

@rezkiy37 rezkiy37 rezkiy37 left review comments

@VickyStash VickyStash VickyStash requested changes

@fabioh8010 fabioh8010 fabioh8010 approved these changes

@mountiny mountiny mountiny approved these changes

@thesahindia thesahindia thesahindia approved these changes

Assignees

@fvlvte fvlvte

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@fvlvte @fabioh8010 @pac-guerreiro @thesahindia @OSBotify @VickyStash @mountiny @rezkiy37