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 'NewChatSelector' page to TypeScript... #38441

Merged
merged 6 commits into from
Mar 29, 2024

Conversation

MahmudjonToraqulov
Copy link
Contributor

Details

Migrated 'NewChatSelector' page to TypeScript

Fixed Issues

$ #31989
PROPOSAL: #31989 (comment)

Tests

  1. Open website
  2. On the home page, click on plus icon
  3. Click on Start Chat
  4. Write any username that you didn't chatted yet
  5. Click on Enter
  • Verify that no errors appear in the JS console

Offline tests

  1. Open website
  2. On the home page, click on plus icon
  3. Click on Start Chat
  4. Write any username that you didn't chatted yet
  5. Click on Enter

QA Steps

  1. Open website
  2. On the home page, click on plus icon
  3. Click on Start Chat
  4. Write any username that you didn't chatted yet
  5. Click on Enter
  • 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
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
2024-01-22.05-28-21.mp4
MacOS: Desktop
2024-01-22.05-35-14.mp4

@MahmudjonToraqulov MahmudjonToraqulov requested a review from a team as a code owner March 16, 2024 16:20
@melvin-bot melvin-bot bot requested review from sobitneupane and removed request for a team March 16, 2024 16:20
Copy link

melvin-bot bot commented Mar 16, 2024

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

Copy link
Contributor

github-actions bot commented Mar 16, 2024

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

@MahmudjonToraqulov
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@MahmudjonToraqulov
Copy link
Contributor Author

Hey @sobitneupane @blazejkustra. Why is CLA failing again? I did everything right.

@sobitneupane
Copy link
Contributor

@MahmudjonToraqulov You are required to upload screen recordings for all the platforms.

@sobitneupane
Copy link
Contributor

Why is CLA failing again? I did everything right.

The issue should be resolved once internal engineer approves the workflow to run.

>
<TopTab.Screen
name={CONST.TAB.NEW_CHAT}
// @ts-expect-error TODO: 'isGroupChat' is declared here.
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's remove this ts expect error, instead let's make isGroupChat optional

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok.

shouldEnableKeyboardAvoidingView={false}
includeSafeAreaPaddingBottom={false}
shouldShowOfflineIndicator={false}
shouldEnableMaxHeight
testID={NewChatSelectorPage.displayName}
>
<HeaderWithBackButton
title={props.translate('sidebarScreen.fabNewChat')}
onBackButtonPress={navigation.goBack}
Copy link
Contributor

Choose a reason for hiding this comment

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

Why was this removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I copied and pasted last changes. Maybe this caused some issues. I'll fix them.

return (
<ScreenWrapper
<ScreenWrapper
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a space added? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I copied and pasted last changes. Maybe this caused some issues. I'll fix them.

Comment on lines 25 to 31
tabBar={({state, navigation, position}) => (
<TabSelector
state={state}
navigation={navigation}
position={position}
/>
)}
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
tabBar={({state, navigation, position}) => (
<TabSelector
state={state}
navigation={navigation}
position={position}
/>
)}
tabBar={TabSelector}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok. Will do it.

@MahmudjonToraqulov
Copy link
Contributor Author

Hey @blazejkustra. I made requested changes. You could check it.

@blazejkustra
Copy link
Contributor

@sobitneupane All yours!

@MahmudjonToraqulov
Copy link
Contributor Author

I'll upload screen recordings for all the platforms soon.

@sobitneupane
Copy link
Contributor

sobitneupane commented Mar 20, 2024

@MahmudjonToraqulov In addition to this, there are some lint issues in the PR, you can check with npm run lint. Can you please fix those.
Screenshot 2024-03-20 at 16 07 05

@fabioh8010
Copy link
Contributor

@MahmudjonToraqulov bump

@MahmudjonToraqulov
Copy link
Contributor Author

@MahmudjonToraqulov In addition to this, there are some lint issues in the PR, you can check with npm run lint. Can you please fix those. Screenshot 2024-03-20 at 16 07 05

Ok.

@MahmudjonToraqulov
Copy link
Contributor Author

@MahmudjonToraqulov bump

Sorry for the delay. I'm having some issues while tryiing to run Android Native.

@MahmudjonToraqulov
Copy link
Contributor Author

BUILD FAILED in 7m 10s
error Failed to install the app. Command failed with exit code 1: ./gradlew app:installDevelopmentDebug -PreactNativeDevServerPort=8081 FAILURE: Build failed with an exception. * What went wrong:
Could not determine the dependencies of task ':app:processDevelopmentDebugResources'.

I'm getting this error while trying "npm run android". Could you help me with that?

@MahmudjonToraqulov
Copy link
Contributor Author

lint issues

I have made commit to fix that.

@sobitneupane
Copy link
Contributor

I'm getting this error while trying "npm run android". Could you help me with that?

@MahmudjonToraqulov You can upload video for other platforms. I will test in android.

@MahmudjonToraqulov
Copy link
Contributor Author

I'm getting this error while trying "npm run android". Could you help me with that?

@MahmudjonToraqulov You can upload video for other platforms. I will test in android.

I did it with Desktop and Macos Chrome. Right now I cannot with IOS and Android as I said, but I'm trying to solve it.
Can I test IOS chrome and Android chrome on my Macos browser?

@sobitneupane
Copy link
Contributor

I did it with Desktop and Macos Chrome. Right now I cannot with IOS and Android as I said, but I'm trying to solve it.
Can I test IOS chrome and Android chrome on my Macos browser?

Nope. You need to test it either on Simulator or on real device.

@MahmudjonToraqulov
Copy link
Contributor Author

MahmudjonToraqulov commented Mar 25, 2024 via email

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

@MahmudjonToraqulov Looks like there are still some issues to be handled. Styling of tab selector is off.

Screenshot 2024-03-25 at 12 47 56

@MahmudjonToraqulov
Copy link
Contributor Author

@sobitneupane I commited new changes. Pls check it and tell me. And one more thing. I tried so many ways to test the App but didn't help yet. Could you help me testing it if you don't mind?

@blazejkustra
Copy link
Contributor

And one more thing. I tried so many ways to test the App but didn't help yet.

What do you mean? It doesn't work?

@MahmudjonToraqulov
Copy link
Contributor Author

MahmudjonToraqulov commented Mar 26, 2024 via email

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

Screenshots/Videos

Android: Native
Screen.Recording.2024-03-27.at.12.23.21.mov
Android: mWeb Chrome
iOS: Native
Screen.Recording.2024-03-27.at.12.15.18.mov
iOS: mWeb Safari
Screen.Recording.2024-03-27.at.12.12.22.mov
Screenshot 2024-03-27 at 12 10 16 Screenshot 2024-03-27 at 12 11 13
MacOS: Chrome / Safari Screenshot 2024-03-27 at 12 10 13
MacOS: Desktop
Screen.Recording.2024-03-27.at.12.13.55.mov

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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.

Copy link

melvin-bot bot commented Mar 27, 2024

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

@melvin-bot melvin-bot bot requested a review from stitesExpensify March 27, 2024 06:43
Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

Looks pretty good, one question, and it looks like lint is failing

@@ -34,6 +37,7 @@ export const TopTab = createMaterialTopTabNavigator();
// except ID is now required, and it gets a `selectedTab` from Onyx
function OnyxTabNavigator({id, selectedTab = '', children, onTabSelected = () => {}, screenListeners, ...rest}: OnyxTabNavigatorProps) {
return (
// @ts-expect-error: Types of property 'tabBar' are incompatible.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are we creating an exception here? Shouldn't we be fixing the actual issue?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok. I'll fix it.

Copy link
Contributor

Choose a reason for hiding this comment

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

You could try assertion here, instead of ts-expect-error

tabBar={tabBar as (props: MaterialTopTabBarProps) => React.ReactNode}

Copy link
Contributor

Choose a reason for hiding this comment

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

Or better, fix TabSelectorProps type 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You could try assertion here, instead of ts-expect-error

You mean I should use it inside <TopTab.Navigator?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes

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 giving me an error then like the pic.
Screenshot 2024-03-28 at 20 43 15

Copy link
Contributor

Choose a reason for hiding this comment

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

You didn't destruct tabBar from props 😅

Copy link
Contributor

Choose a reason for hiding this comment

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

I think TabSelectorProps is broken, try this:

type TabSelectorProps = MaterialTopTabBarProps & {
    /* Callback fired when tab is pressed */
    onTabPress?: (name: string) => void;
};

Copy link
Contributor

Choose a reason for hiding this comment

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

With no changes in TabNavigator

@blazejkustra
Copy link
Contributor

@MahmudjonToraqulov You forgot to run prettier on the PR, files aren't formatted properly

@MahmudjonToraqulov
Copy link
Contributor Author

@MahmudjonToraqulov You forgot to run prettier on the PR, files aren't formatted properly

I'll do it.

@melvin-bot melvin-bot bot requested a review from stitesExpensify March 29, 2024 06:26
@blazejkustra
Copy link
Contributor

@stitesExpensify All yours again 😄

@blazejkustra
Copy link
Contributor

@MahmudjonToraqulov When was the last time you merged main here? 🙈

@stitesExpensify stitesExpensify merged commit d46383f into Expensify:main Mar 29, 2024
15 checks passed
@melvin-bot melvin-bot bot added the Emergency label Mar 29, 2024
Copy link

melvin-bot bot commented Mar 29, 2024

@stitesExpensify looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@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

OSBotify commented Apr 2, 2024

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.4.59-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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

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

Successfully merging this pull request may close these issues.

6 participants