Upgrade eventemitter event library #34

hungvu193 · 2023-09-19T04:50:09Z

Details

Expensify/App#26986
Replace the current events library with eventemitter3 which is well maintained and faster!

Fixed Issues

$ Expensify/App#26986
PROPOSAL: Expensify/App#26986 (comment)

Tests

For the warning:

Open the app
Keep the window open and switch between other tabs.
Verify that there's no console error

For the normal key listener:

Open the app, login with any account
Press Command + J, verify that it open the keyboard shortcuts dialog.
Press Esc, verify that it closes the shortcuts dialog.
Press Command + K, verify that it open the Search screen.
Press Command + Shift + K, verify that it open the New Message screen
Go to any report, type some text and press Enter, verify it sends the messages.
Go to any Forms, focus on any input, press Enter, verify it triggers the submit form.

Verify that no errors appear in the JS console

Offline tests

Same as 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 / 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

chrome.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

desktop.mov

iOS

Android

hungvu193 · 2023-09-19T09:48:37Z

PR is ready for review! @thesahindia

One question, do you know how to test key shortcut on mWeb and mobile?

thesahindia · 2023-09-19T11:35:11Z

PR is ready for review! @thesahindia

The last commit is not verified. Please fix it @hungvu193.

One question, do you know how to test key shortcut on mWeb and mobile?

Nope, never tried it. I think you should ask about it in our slack channel.

hungvu193 · 2023-09-19T11:39:49Z

The last commit is not verified. Please fix it @hungvu193.

Updated!

package.json

hungvu193 · 2023-09-20T04:34:31Z

Seems we need external keyboard to test it for mobile, but I don't have it, do you have one @thesahindia?

thesahindia · 2023-09-20T21:54:55Z

Seems we need external keyboard to test it for mobile, but I don't have it, do you have one @thesahindia?

Nope, but I will get one in the morning. Waiting for it.

hungvu193 · 2023-09-21T02:16:16Z

Seems we need external keyboard to test it for mobile, but I don't have it, do you have one @thesahindia?

Nope, but I will get one in the morning. Waiting for it.

Awesome!

thesahindia · 2023-09-21T22:09:18Z

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-22.at.1.07.47.AM.mov

Mobile Web - Chrome

86526849-4cf3-4940-882c-268889db0510.MP4

Mobile Web - Safari

RPReplay_Final1695326575.MP4

Desktop

Screen.Recording.2023-09-22.at.1.09.48.AM.mov

iOS

Android

ebf22008-ff10-4621-9b61-78c438937a3f.MP4

thesahindia

Tested well!

thesahindia · 2023-09-21T22:12:07Z

cc: @roryabraham

roryabraham · 2023-09-25T07:52:09Z

@hungvu193 I can't merge this due to unsigned commits. Please rebase and sign all commits retroactively

bump to ee3 update packagejson.lock file, verify signcommit Update package.json bump to ee3 update packagejson.lock file, verify signcommit

hungvu193 · 2023-09-25T08:13:05Z

@hungvu193 I can't merge this due to unsigned commits. Please rebase and sign all commits retroactively

@roryabraham Ok, I've just updated.

parasharrajat · 2023-09-25T09:52:15Z

Just to make sure, did we test this PR on Android and iOS with an external keyboard? @thesahindia

thesahindia · 2023-09-25T19:47:31Z

Just to make sure, did we test this PR on Android and iOS with an external keyboard? @thesahindia

Yep, I tested it on native and mWeb.

hungvu193 force-pushed the upgrade-eventemitter-event branch 2 times, most recently from 40b2f99 to d52a76b Compare September 19, 2023 11:39

parasharrajat reviewed Sep 19, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

hungvu193 force-pushed the upgrade-eventemitter-event branch from d52a76b to 9deafb6 Compare September 19, 2023 11:55

thesahindia approved these changes Sep 21, 2023

View reviewed changes

danieldoglas requested a review from roryabraham September 25, 2023 05:10

roryabraham approved these changes Sep 25, 2023

View reviewed changes

hungvu193 force-pushed the upgrade-eventemitter-event branch 2 times, most recently from 20ea30d to 188752a Compare September 25, 2023 08:08

Update package.json

27b7861

bump to ee3 update packagejson.lock file, verify signcommit Update package.json bump to ee3 update packagejson.lock file, verify signcommit

hungvu193 force-pushed the upgrade-eventemitter-event branch from f013b8c to 27b7861 Compare September 25, 2023 08:12

roryabraham approved these changes Sep 25, 2023

View reviewed changes

roryabraham merged commit 4a30957 into Expensify:main Sep 25, 2023

hungvu193 mentioned this pull request Sep 28, 2023

Upgrade react-native-key-command version Expensify/App#28370

Merged

59 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade eventemitter event library #34

Upgrade eventemitter event library #34

hungvu193 commented Sep 19, 2023 •

edited

Loading

hungvu193 commented Sep 19, 2023

thesahindia commented Sep 19, 2023

hungvu193 commented Sep 19, 2023

hungvu193 commented Sep 20, 2023

thesahindia commented Sep 20, 2023

hungvu193 commented Sep 21, 2023

thesahindia commented Sep 21, 2023

thesahindia left a comment

thesahindia commented Sep 21, 2023

roryabraham commented Sep 25, 2023

hungvu193 commented Sep 25, 2023

parasharrajat commented Sep 25, 2023 •

edited

Loading

thesahindia commented Sep 25, 2023

Upgrade eventemitter event library #34

Upgrade eventemitter event library #34

Conversation

hungvu193 commented Sep 19, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

hungvu193 commented Sep 19, 2023

thesahindia commented Sep 19, 2023

hungvu193 commented Sep 19, 2023

hungvu193 commented Sep 20, 2023

thesahindia commented Sep 20, 2023

hungvu193 commented Sep 21, 2023

thesahindia commented Sep 21, 2023

Reviewer Checklist

Screenshots/Videos

thesahindia left a comment

Choose a reason for hiding this comment

thesahindia commented Sep 21, 2023

roryabraham commented Sep 25, 2023

hungvu193 commented Sep 25, 2023

parasharrajat commented Sep 25, 2023 • edited Loading

thesahindia commented Sep 25, 2023

hungvu193 commented Sep 19, 2023 •

edited

Loading

parasharrajat commented Sep 25, 2023 •

edited

Loading