[TS migration] Migrate 'EmojiPickerAction.js' lib to TypeScript #26795

blazejkustra · 2023-09-05T16:04:48Z

Details

Migration of EmojiPickerAction.js to Typescript.

Fixed Issues

$ #24798
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console
Verify that EmojiPicker is working correctly

Offline tests

N/A

QA Steps

N/A

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 / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

android-web.mov

Mobile Web - Safari

ios-web.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-09-06T09:41:16Z

@ntdiary 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 · 2023-09-06T09:52:00Z

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

src/libs/actions/EmojiPickerAction.ts

hayata-suenaga · 2023-09-06T20:30:08Z

src/libs/actions/EmojiPickerAction.ts

+    vertical: ValueOf<typeof CONST.MODAL.ANCHOR_ORIGIN_VERTICAL>;
+};
+
+type EmojiPicker = {


Why are we defining the component type in this file?

It's not the component type, it's what is defined in useImperativeHandle here. Do you think the name is misleading? @hayata-suenaga

I mean this is component API right? the methods exposed the component through useImperativeHandle?

I think we should define this inside the component file instead of defining this here where we store the reference to the component.

I know we haven't started migration of component files, but I think we should start thinking about where type definitions should belong and how to coordinates the migration when the type needed are not defined yet.

I agree that EmojiPicker type should be defined next to EmojiPicker component. But until it's not migrated we have couple options:

Put this PR on hold until we get to EmojiPicker component

Merge this now, and move the type when EmojiPicker component is migrated (we can add a comment on the issue to remember about this)

Define types.ts file with EmojiPicker type next to the component

Generally I think we won't be able to avoid such situations and sometimes we have to define types in undesirable places. At some point of the migration we will have to clean a bit, for example we'll have to clean style types or define shared types that are often used - until then we have to accept that we will repeat or litter the code sometimes.

cc @fabioh8010 @hayata-suenaga

I'm confortable with option two, and adding a TODO comment above the type as well:

Merge this now, and move the type when EmojiPicker component is migrated (we can add a comment on the issue to remember about this)

We can create some cleanup and review issues for some of the categories of files (I kinda have been done this cleanup for styles already) , e.g. styles, models, libs, hooks, hoc's, components and pages I think are good candidates for these clean ups. After each migration of all issues of that category we will create a new issue to review all past work and ensure consistency. I can add these "checkpoints" on our spreadsheet, WDYT? @hayata-suenaga @blazejkustra

@fabioh8010 That sounds good to me 😄 Add it to the spreadsheet please, and we will get back to this.

I don't have the capacity to manage this, so I'd appreciate if SWM and CallStack and develop a strategy to coordinate and keep track the cleanup efforts we have to do. 🙇

Sure thing @hayata-suenaga, that's on me and @fabioh8010, we will coordinate such cleanups!

Let me know if issues need to be created in App 🙇

@hayata-suenaga @blazejkustra I created new rows in the spreadsheet about these review issues, here are the lines:

57

261

277

295

486

550

@hayata-suenaga Could you please create the issues? Thank you!

@hayata-suenaga bump

src/libs/actions/EmojiPickerAction.ts

fabioh8010 · 2023-09-12T00:14:58Z

src/libs/actions/EmojiPickerAction.ts

+    vertical: ValueOf<typeof CONST.MODAL.ANCHOR_ORIGIN_VERTICAL>;
+};
+
+type EmojiPicker = {


I'm confortable with option two, and adding a TODO comment above the type as well:

Merge this now, and move the type when EmojiPicker component is migrated (we can add a comment on the issue to remember about this)

src/libs/actions/EmojiPickerAction.ts

blazejkustra · 2023-09-12T11:14:24Z

@fabioh8010 @hayata-suenaga Ready for your review!

fabioh8010

LGTM, CK still need to do the checklist.

hayata-suenaga · 2023-09-15T01:29:07Z

I'll wait for the checklist to be completed before I do review 🙇

fabioh8010 · 2023-09-19T09:53:22Z

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 / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-09-19.at.10.28.30.mov

Screen.Recording.2023-09-19.at.10.28.48.mov

Desktop

Screen.Recording.2023-09-19.at.10.33.51.mov

Mobile Web - Chrome

Screen.Recording.2023-09-19.at.10.30.14.mov

Android

Screen.Recording.2023-09-19.at.10.30.59.mov

Mobile Web - Safari

Screen.Recording.2023-09-19.at.10.32.47.mov

iOS

Screen.Recording.2023-09-19.at.10.33.14.mov

blazejkustra · 2023-09-27T09:07:56Z

@hayata-suenaga Kind bump 😄

OSBotify · 2023-09-28T01:33:02Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-09-28T19:17:16Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.75-0 🚀

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

OSBotify · 2023-10-02T17:21:11Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.75-12 🚀

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

OSBotify · 2023-10-02T17:49:46Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.76-0 🚀

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

OSBotify · 2023-10-03T15:50:43Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

[TS migration] Migrate 'EmojiPickerAction.js' lib to TypeScript

d3b1cf5

blazejkustra marked this pull request as ready for review September 6, 2023 09:41

blazejkustra requested a review from a team as a code owner September 6, 2023 09:41

melvin-bot bot requested review from ntdiary and removed request for a team September 6, 2023 09:41

ntdiary approved these changes Sep 6, 2023

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga September 6, 2023 09:52

hayata-suenaga reviewed Sep 6, 2023

View reviewed changes

src/libs/actions/EmojiPickerAction.ts Outdated Show resolved Hide resolved

hayata-suenaga reviewed Sep 6, 2023

View reviewed changes

src/libs/actions/EmojiPickerAction.ts Show resolved Hide resolved

fabioh8010 reviewed Sep 12, 2023

View reviewed changes

fabioh8010 mentioned this pull request Sep 12, 2023

[No QA] [TS migration] Migrate 'Growl.js' lib to TypeScript #26933

Merged

59 tasks

BartoszGrajdek mentioned this pull request Sep 12, 2023

[HOLD for payment 2024-03-22] [TS migration] Migrate 'GrowlNotification' component to TypeScript #25127

Open

blazejkustra mentioned this pull request Sep 12, 2023

[HOLD for payment 2024-04-25] [$250] [TS migration] Migrate 'EmojiPicker' component to TypeScript #25155

Closed

Adjust after review

3d7c110

blazejkustra requested review from hayata-suenaga and fabioh8010 September 12, 2023 11:14

fabioh8010 approved these changes Sep 14, 2023

View reviewed changes

blazejkustra added 2 commits September 18, 2023 10:08

Merge branch 'main' into ts-migration/EmojiPickerAction

0ccbac1

Remove void return type

ff8edae

fabioh8010 approved these changes Sep 19, 2023

View reviewed changes

Merge branch 'main' into ts-migration/EmojiPickerAction

17944fd

hayata-suenaga approved these changes Sep 28, 2023

View reviewed changes

hayata-suenaga merged commit d63e76f into Expensify:main Sep 28, 2023
1 check passed

OSBotify mentioned this pull request Sep 28, 2023

Deploy Checklist: New Expensify 2023-09-28 #28412

Closed

OSBotify mentioned this pull request Oct 2, 2023

Deploy Checklist: New Expensify 2023-10-02 #28635

Closed

melvin-bot bot mentioned this pull request Oct 2, 2023

[HOLD for payment 2023-10-09] [TS migration] Migrate 'EmojiPickerAction.js' lib to TypeScript #24798

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'EmojiPickerAction.js' lib to TypeScript #26795

[TS migration] Migrate 'EmojiPickerAction.js' lib to TypeScript #26795

blazejkustra commented Sep 5, 2023 •

edited

Loading

melvin-bot bot commented Sep 6, 2023

melvin-bot bot commented Sep 6, 2023

hayata-suenaga Sep 6, 2023

blazejkustra Sep 7, 2023

hayata-suenaga Sep 11, 2023

blazejkustra Sep 11, 2023

fabioh8010 Sep 12, 2023

fabioh8010 Sep 12, 2023

blazejkustra Sep 12, 2023

hayata-suenaga Sep 12, 2023

fabioh8010 Sep 14, 2023

fabioh8010 Sep 19, 2023

fabioh8010 Sep 12, 2023

blazejkustra commented Sep 12, 2023

fabioh8010 left a comment

hayata-suenaga commented Sep 15, 2023

fabioh8010 commented Sep 19, 2023

blazejkustra commented Sep 27, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 3, 2023

[TS migration] Migrate 'EmojiPickerAction.js' lib to TypeScript #26795

[TS migration] Migrate 'EmojiPickerAction.js' lib to TypeScript #26795

Conversation

blazejkustra commented Sep 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 6, 2023

melvin-bot bot commented Sep 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blazejkustra commented Sep 12, 2023

fabioh8010 left a comment

Choose a reason for hiding this comment

hayata-suenaga commented Sep 15, 2023

fabioh8010 commented Sep 19, 2023

Reviewer Checklist

Screenshots/Videos

blazejkustra commented Sep 27, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 3, 2023

blazejkustra commented Sep 5, 2023 •

edited

Loading