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 'ReportWelcomeText.js' component to TypeScript #33251

Merged
merged 8 commits into from
Jan 2, 2024

Conversation

nikos-amofa
Copy link
Contributor

@nikos-amofa nikos-amofa commented Dec 18, 2023

Details

Fixed Issues

$ #25101
PROPOSAL: #25101 (comment)

Tests

  1. Open any chat.
  2. Verify that the Welcome title looks the same as before with ReportWelcomeText.js.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as Tests

  • 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 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: mWeb Chrome Screenshot 2023-12-20 at 10 40 26 AM
iOS: Native
iOS: mWeb Safari Screenshot 2023-12-20 at 10 47 24 AM
MacOS: Chrome / Safari Screenshot at Dec 18 13-25-57
MacOS: Desktop desktop

@nikos-amofa nikos-amofa marked this pull request as ready for review December 18, 2023 18:53
@nikos-amofa nikos-amofa requested a review from a team as a code owner December 18, 2023 18:53
@melvin-bot melvin-bot bot requested review from dangrous and removed request for a team December 18, 2023 18:53
Copy link

melvin-bot bot commented Dec 18, 2023

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

@dangrous
Copy link
Contributor

Should this go through a C+ before my review?

@nikos-amofa
Copy link
Contributor Author

@dangrous Yes, it still needs to go through C+.
Discussion here

@dangrous
Copy link
Contributor

Hm yeah that's what I thought too, I wonder why it didn't autoassign.

@burczu
Copy link
Contributor

burczu commented Dec 19, 2023

@dangrous I think @nikosamofa was in a hurry and created the PR before being assigned to the issue by Expensify engineer after the C+ recommendation. That's why I wasn't assigned automatically. Could you please assign me here?

const isMultipleParticipant = participantAccountIDs.length > 1;
const displayNamesWithTooltips = ReportUtils.getDisplayNamesWithTooltips(
OptionsListUtils.getPersonalDetailsForAccountIDs(participantAccountIDs, props.personalDetails),
// TODO: Remove type assertion (`as PersonalDetailsList`) after `src/libs/OptionsListUtils.js` is migrated into ts
Copy link
Contributor

Choose a reason for hiding this comment

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

The comment is not aligned with the TS Guidelines.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@fabioh8010 I tried to find the issue for TS migration of OptionsListUtils, but was not able to find it, so commented TODO like above.
Could you kindly point out the issue number for it?
OR will it be okay to remove this TODO comment here?

Copy link
Contributor

Choose a reason for hiding this comment

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

@nikosamofa Here it is!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, addressed by e9e32fb

Comment on lines 23 to 29
type ReportWelcomeTextProps = ReportWelcomeTextOnyxProps & {
/** The report currently being looked at */
report: Report;

/** The policy for the current route */
policy: Policy;
};
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
type ReportWelcomeTextProps = ReportWelcomeTextOnyxProps & {
/** The report currently being looked at */
report: Report;
/** The policy for the current route */
policy: Policy;
};
type ReportWelcomeTextProps = ReportWelcomeTextOnyxProps & {
/** The report currently being looked at */
report: OnyxEntry<Report>;
/** The policy for the current route */
policy: OnyxEntry<Policy>;
};

Since ReportActionItemCreated is passing Onyx entries to report and policy, let's type them as OnyxEntry as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, addressed by 3fad7ce

};

function ReportWelcomeText(props) {
function ReportWelcomeText({report = {} as Report, policy = {} as Policy, personalDetails = {}}: ReportWelcomeTextProps) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
function ReportWelcomeText({report = {} as Report, policy = {} as Policy, personalDetails = {}}: ReportWelcomeTextProps) {
function ReportWelcomeText({report, policy, personalDetails = {}}: ReportWelcomeTextProps) {

Let's avoid assigning those variables to empty objects {}. report and policy is being used in ReportActionItemCreated and these props comes from Onyx, so the value can be null and you can treat the nullability in the code.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, addressed by 3fad7ce

@@ -1,92 +1,65 @@
import lodashGet from 'lodash/get';
import PropTypes from 'prop-types';
import _ from 'lodash';
Copy link
Contributor

Choose a reason for hiding this comment

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

You should be able to remove lodash completely in this file:

{!_.isEmpty(pronouns) && <Text>{` (${pronouns})`}</Text>}
{!!pronouns && <Text>{` (${pronouns})`}</Text>}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, addressed by 3fad7ce

<Text key={`${displayName}${pronouns}${index}`}>
<Text>{translate('reportActionsView.beginningOfChatHistory')}</Text>
{displayNamesWithTooltips.map(({displayName, pronouns, accountID}, index) => (
<Text key={`${displayName}${pronouns}${accountID}`}>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if you have already noticed this, but I changed

<Text key={`${displayName}${pronouns}${index}`}>

to

<Text key={`${displayName}${pronouns}${accountID}`}>

ESlint complained Do not use Array index in keys react/no-array-index-key

I assume accountID will be unique inside this array, can you confirm it?

Copy link
Contributor

Choose a reason for hiding this comment

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

@nikosamofa Another alternative (if accountID can't be used) is to suppress the rule with // eslint-disable-next-line react/no-array-index-key.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed by 73b8b7f

</>
)}
{isChatRoom && (
<>
<Text>{roomWelcomeMessage.phrase1}</Text>
{roomWelcomeMessage.showReportName && (
{roomWelcomeMessage.showReportName && !!report?.reportID && (
Copy link
Contributor Author

Choose a reason for hiding this comment

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

ROUTES.REPORT_WITH_ID_DETAILS.getRoute requires string, not undefined type, so !!report?.reportID is added here for the conditional rendering

Copy link
Contributor

Choose a reason for hiding this comment

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

@nikosamofa I think is better to do this condition inside onPress callback instead of here, e.g.:

onPress={() => {
    if (!report?.reportID) {
        return;
    }

    Navigation.navigate(ROUTES.REPORT_WITH_ID_DETAILS.getRoute(report.reportID));
}}

You can also extract this onPress callback to a separate function for better code visibility.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed by 73b8b7f

Copy link
Contributor

@fabioh8010 fabioh8010 left a comment

Choose a reason for hiding this comment

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

LGTM besides my last comments!

</>
)}
{isChatRoom && (
<>
<Text>{roomWelcomeMessage.phrase1}</Text>
{roomWelcomeMessage.showReportName && (
{roomWelcomeMessage.showReportName && !!report?.reportID && (
Copy link
Contributor

Choose a reason for hiding this comment

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

@nikosamofa I think is better to do this condition inside onPress callback instead of here, e.g.:

onPress={() => {
    if (!report?.reportID) {
        return;
    }

    Navigation.navigate(ROUTES.REPORT_WITH_ID_DETAILS.getRoute(report.reportID));
}}

You can also extract this onPress callback to a separate function for better code visibility.

@blazejkustra
Copy link
Contributor

@nikosamofa Could you adjust the title of this PR so it aligns with the issue?
[TS migration] Migrate 'ReportWelcomeText.js' component to TypeScript

@nikos-amofa nikos-amofa changed the title TS migration for ReportWelcomeText done [TS migration] Migrate 'ReportWelcomeText.js' component to TypeScript Dec 19, 2023
@dangrous dangrous requested review from burczu and removed request for blazejkustra and fabioh8010 December 19, 2023 18:27
@burczu
Copy link
Contributor

burczu commented Dec 20, 2023

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

Screenshot 2023-12-20 at 13 02 49

Android: mWeb Chrome

Screenshot 2023-12-20 at 10 54 51

iOS: Native

Screenshot 2023-12-20 at 10 49 43

iOS: mWeb Safari

n/a

MacOS: Chrome / Safari

Screenshot 2023-12-20 at 10 58 50

MacOS: Desktop

Screenshot 2023-12-20 at 13 08 44

@burczu
Copy link
Contributor

burczu commented Dec 20, 2023

@nikosamofa You've added only screenshot/video for web to your PR's Author Checklist. Please add missing screenshots for other platforms.

@nikos-amofa
Copy link
Contributor Author

@burczu I've added screenshots for Android: mweb chrome, ios: mweb safari, desktop
I had issues running the native apps on my local
ios
android

Was not able to run it. As you confirmed they are working fine, I think we're good to go

Copy link
Contributor

@burczu burczu left a comment

Choose a reason for hiding this comment

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

@nikosamofa Thanks, I've also had an issue with iOS mWeb, so putting things together I think it's safe to say it's tested.

LGTM

Copy link

melvin-bot bot commented Dec 21, 2023

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

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

@nikos-amofa
Copy link
Contributor Author

@burczu Thanks for reviewing the PR
Who has the responsibility to merge this PR? Do I need to ping someone else for it?

@burczu
Copy link
Contributor

burczu commented Dec 21, 2023

@nikosamofa Because you've omitted the standard flow on how we work, the bot didn't assign any internal engineer to the PR. I guess, @dangrous could do it for us, or @bondydaa who was eventually assigned to the issue.

@dangrous
Copy link
Contributor

yeah I can review and merge! @nikosamofa can you double check you're using the latest checklist from https://raw.githubusercontent.com/Expensify/App/main/.github/PULL_REQUEST_TEMPLATE.md in the PR description? The check isn't liking it.

Thanks, will review shortly.

@nikos-amofa
Copy link
Contributor Author

Thanks @dangrous , I updated the author checklist from the link you provided

dangrous
dangrous previously approved these changes Dec 21, 2023
Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

Works for me!

@dangrous
Copy link
Contributor

Bloop sorry you as well, @burczu , looks like we must have just updated the checklists - sorry! https://raw.githubusercontent.com/Expensify/App/main/contributingGuides/REVIEWER_CHECKLIST.md

@burczu
Copy link
Contributor

burczu commented Dec 22, 2023

@dangrous Updated, but I wonder what happened? I usually copy the list from this comment: #33251 (comment) - if requirements has changed, shouldn't be this comment changed too?

@blazejkustra
Copy link
Contributor

blazejkustra commented Dec 28, 2023

@burczu @dangrous Checklist is still failing 🤔 @nikosamofa Please merge the newest main

@nikos-amofa
Copy link
Contributor Author

@blazejkustra There was a merge conflict, I resolved it and confirmed the component works fine. The checklist should be green after current checking. Thanks

@nikos-amofa
Copy link
Contributor Author

@dangrous Welcome back, could you review this PR and merge it if it's fine? Thanks

Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

LGTM!

@dangrous dangrous merged commit ff13beb into Expensify:main Jan 2, 2024
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jan 2, 2024

✋ 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

OSBotify commented Jan 2, 2024

🚀 Deployed to staging by https://github.com/dangrous in version: 1.4.21-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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