Add code to NewDot to handle both new and old Pusher event types #18192

tgolen · 2023-04-29T14:14:25Z

Held on https://github.com/Expensify/Web-Expensify/pull/37222 to remove the three unused events

Details

This code sets up the app to be able to handle unified pusher events

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/279349

Tests

The only thing needing to be tested is that there are no regressions with the existing pusher updates. This can be done by:

Open the app
Verify data loads from the server

Verify that no errors appear in the JS console

Offline tests

None

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
- 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 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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

MelvinBot · 2023-05-01T17:04:45Z

@eVoloshchak @grgia One of you needs to 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]

iwiznia · 2023-05-03T15:56:08Z

src/libs/Pusher/EventType.js

-    PREFERRED_LOCALE: 'preferredLocale',
-    EXPENSIFY_CARD_UPDATE: 'expensifyCardUpdate',
-    SCREEN_SHARE_REQUEST: 'screenshareRequest',


What's the migration plan? We start sending both old and new events from the backend, then remove the old one when this is released?

No, it's more simple than that. Web-E just needed to be updated to send these three events as Onyx updates, which NewDot already supports. Once that Web-E change is in production, then the HOLD can be removed on this.

I am confused... if web-e stopped sending the old events, then all existing apps will be broken till this is deployed, no??

No. Older versions of NewDot (for like the past several months) can all handle the onyx update event. Web-E is just switching over to using that.

iwiznia · 2023-05-03T15:57:40Z

src/libs/actions/User.js

    // Receive any relevant Onyx updates from the server
    PusherUtils.subscribeToPrivateUserChannelEvent(Pusher.TYPE.ONYX_API_UPDATE, currentUserAccountID, (pushJSON) => {
        SequentialQueue.getCurrentRequest().then(() => {
            Onyx.update(pushJSON);
            triggerNotifications(pushJSON);
        });
    });
-
-    // Live-update an user's preferred locale
-    Pusher.subscribe(pusherChannelName, Pusher.TYPE.PREFERRED_LOCALE, (pushJSON) => {


I assume this will be migrated in the web-e code?

Yep, it was already migrated. In fact, Web-E had stopped using this event in favor of an Onyx update event a while ago (during the big API refactoring) and this was never properly cleaned up.

tgolen · 2023-05-08T21:42:03Z

@eVoloshchak @grgia This PR is unheld and ready for review

tgolen · 2023-05-09T13:46:52Z

@eVoloshchak will you be able to get a PR checklist going for this? It should be very quick testing.

eVoloshchak · 2023-05-09T18:52:54Z

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 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-05-09.at.22.11.46.mov

Mobile Web - Chrome

Screen_Recording_20230509-221034_Chrome.mp4

Mobile Web - Safari

Screen.Recording.2023-05-09.at.22.08.28.mov

Desktop

Screen.Recording.2023-05-09.at.22.11.22.mov

iOS

Screen.Recording.2023-05-09.at.22.07.58.mov

Android

Screen_Recording_20230509-220938_New.Expensify.mp4

eVoloshchak

Looks good, works normal

melvin-bot · 2023-05-09T19:24:28Z

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

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

tgolen · 2023-05-10T15:41:37Z

OK, I fixed a conflict so this is ready to be merged if you want to do the honors @iwiznia

OSBotify · 2023-05-12T15:17:35Z

✋ 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-05-15T09:19:44Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.14-0 🚀

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

mvtglobally · 2023-05-15T14:10:04Z

@tgolen Can you confirm server side internally? We will run regular regressions.

tgolen · 2023-05-15T14:27:13Z

I confirmed this and have marked this PR off the checklist.

OSBotify · 2023-05-17T00:19:34Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.14-14 🚀

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

tgolen added 7 commits April 29, 2023 07:17

Add basic skeleton methods

5a4e910

Add basic functionality to pubsub

8e0a6c3

Split code to listen to old events and new events

d10dc25

Cleanup params

4e0a80a

Add more multipleEvent handlers

a22baa2

Subscribe to the card event just like the others

6cd8007

Simplify to only allow a single callback per event

3fc4f24

tgolen self-assigned this Apr 29, 2023

tgolen added 2 commits April 29, 2023 08:31

Remove unused import

5d7d033

Remove unused events

c0f6fea

tgolen changed the title ~~Add code to NewDot to handle both new and old Pusher event types~~ [HOLD Web-Expensify/pull/37222]Add code to NewDot to handle both new and old Pusher event types May 1, 2023

tgolen added 2 commits May 1, 2023 11:02

Removed more unused events

032eaa9

Remove unused imports

995f196

tgolen requested a review from iwiznia May 1, 2023 17:04

tgolen marked this pull request as ready for review May 1, 2023 17:04

tgolen requested a review from a team as a code owner May 1, 2023 17:04

melvin-bot bot requested review from eVoloshchak and grgia and removed request for a team May 1, 2023 17:04

iwiznia previously approved these changes May 3, 2023

View reviewed changes

Fix the way data is accessed

40f95bf

tgolen dismissed iwiznia’s stale review via 40f95bf May 3, 2023 18:44

Merge branch 'main' into tgolen-pusher-multipleEvents

9381872

iwiznia approved these changes May 4, 2023

View reviewed changes

tgolen changed the title ~~[HOLD Web-Expensify/pull/37222]Add code to NewDot to handle both new and old Pusher event types~~ Add code to NewDot to handle both new and old Pusher event types May 8, 2023

eVoloshchak approved these changes May 9, 2023

View reviewed changes

melvin-bot bot mentioned this pull request May 9, 2023

Payment issue for E/App PR#18192 #18668

Closed

Merge branch 'main' into tgolen-pusher-multipleEvents

8f029f1

tgolen merged commit 95c22f1 into main May 12, 2023

tgolen deleted the tgolen-pusher-multipleEvents branch May 12, 2023 15:11

OSBotify mentioned this pull request May 15, 2023

Deploy Checklist: New Expensify 2023-05-15 #18938

Closed

67 tasks

dukenv0307 mentioned this pull request May 17, 2023

[$1000] Chat - Offline sent messages with emojis added are displayed without emojis after going online #17110

Closed

6 tasks

dukenv0307 mentioned this pull request Jun 7, 2023

[HOLD for payment 2023-07-24] [$1000] Reply in thread count is not update while send message faster #19445

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add code to NewDot to handle both new and old Pusher event types #18192

Add code to NewDot to handle both new and old Pusher event types #18192

tgolen commented Apr 29, 2023 •

edited

Loading

MelvinBot commented May 1, 2023

iwiznia May 3, 2023

tgolen May 3, 2023

iwiznia May 3, 2023

tgolen May 3, 2023

iwiznia May 3, 2023

tgolen May 3, 2023

iwiznia May 3, 2023

tgolen commented May 8, 2023

tgolen commented May 9, 2023

eVoloshchak commented May 9, 2023 •

edited

Loading

eVoloshchak left a comment

melvin-bot bot commented May 9, 2023

tgolen commented May 10, 2023

OSBotify commented May 12, 2023

OSBotify commented May 15, 2023

mvtglobally commented May 15, 2023

tgolen commented May 15, 2023

OSBotify commented May 17, 2023

Add code to NewDot to handle both new and old Pusher event types #18192

Add code to NewDot to handle both new and old Pusher event types #18192

Conversation

tgolen commented Apr 29, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented May 1, 2023

iwiznia May 3, 2023

Choose a reason for hiding this comment

tgolen May 3, 2023

Choose a reason for hiding this comment

iwiznia May 3, 2023

Choose a reason for hiding this comment

tgolen May 3, 2023

Choose a reason for hiding this comment

iwiznia May 3, 2023

Choose a reason for hiding this comment

tgolen May 3, 2023

Choose a reason for hiding this comment

iwiznia May 3, 2023

Choose a reason for hiding this comment

tgolen commented May 8, 2023

tgolen commented May 9, 2023

eVoloshchak commented May 9, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak left a comment

Choose a reason for hiding this comment

melvin-bot bot commented May 9, 2023

tgolen commented May 10, 2023

OSBotify commented May 12, 2023

OSBotify commented May 15, 2023

mvtglobally commented May 15, 2023

tgolen commented May 15, 2023

OSBotify commented May 17, 2023

tgolen commented Apr 29, 2023 •

edited

Loading

eVoloshchak commented May 9, 2023 •

edited

Loading