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

fix unsubscribe is typing event if not focus on screen #39347

Merged
merged 16 commits into from
Apr 15, 2024

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Apr 1, 2024

Details

  • This PR is to fix the issue: When you join a room, you subscribe to various Pusher channels that should only be active while in that room. However, when you leave the room, sometimes it doesn't unsubscribe you from the channels. This "leak" will gradually slow down the app.

Fixed Issues

$ #38905
PROPOSAL: #38905 (comment)

Tests

  1. Device A: Sign in with user A and open report with user B
  2. Device B: Sign in with user B and open report with user A
  3. Device A: Type anything in composer
  4. Device B: Verify that there is a text "User A is typing..." appears below the composer for a while
  5. Device B: Open another report
  6. Device A: Type anything in composer
  7. Device B: Open developer mode, choose "Console" tab. Verify that there is no [info] [Onyx] log in console. That message will be something like [info] [Onyx] merge() called for key: reportUserIsTyping_4555629044294735 properties: 15225462 - ""
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Device A: Sign in with user A and open report with user B
  2. Device B: Sign in with user B and open report with user A
  3. Device A: Type anything in composer
  4. Device B: Verify that there is a text "User A is typing..." appears below the composer for a while
  5. Device B: Open another report
  6. Device A: Type anything in composer
  7. Device B: Open developer mode, choose "Console" tab. Verify that there is no [info] [Onyx] log in console. That message will be something like [info] [Onyx] merge() called for key: reportUserIsTyping_4555629044294735 properties: 15225462 - ""
  • 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 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 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
Screen.Recording.2024-04-01.at.18.16.35.mov
Android: mWeb Chrome
Screen.Recording.2024-04-01.at.18.18.46.mov
iOS: Native
Screen.Recording.2024-04-01.at.18.11.26.mov
iOS: mWeb Safari
Screen.Recording.2024-04-01.at.18.13.01.mov
MacOS: Chrome / Safari
output.mp4
MacOS: Desktop
Screen.Recording.2024-04-01.at.18.08.15.mov

@tienifr tienifr marked this pull request as ready for review April 1, 2024 10:54
@tienifr tienifr requested a review from a team as a code owner April 1, 2024 10:54
@melvin-bot melvin-bot bot requested review from jjcoffee and removed request for a team April 1, 2024 10:54
Copy link

melvin-bot bot commented Apr 1, 2024

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

@tienifr
Copy link
Contributor Author

tienifr commented Apr 1, 2024

Updating screen recordings ...

@tienifr
Copy link
Contributor Author

tienifr commented Apr 1, 2024

Updated all screen recordings

@jjcoffee
Copy link
Contributor

jjcoffee commented Apr 1, 2024

@tienifr There's a failing jest test, any ideas what might be causing that? Seems like it could be related to this PR.

@jjcoffee
Copy link
Contributor

jjcoffee commented Apr 1, 2024

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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
android-native-2024-04-01_15.51.42.mp4
Android: mWeb Chrome
android-chrome-2024-04-01_15.56.08.mp4
iOS: Native
ios-native-2024-04-01_15.32.49.mp4
iOS: mWeb Safari
ios-safari-2024-04-01_15.46.22.mp4
MacOS: Chrome / Safari
desktop-chrome-2024-04-01_15.58.12.mp4
MacOS: Desktop
desktop-app-2024-04-01_16.01.22.mp4

@jjcoffee
Copy link
Contributor

jjcoffee commented Apr 1, 2024

BUG: Switching to another report using a less direct action, like searching and tapping on any report does not unsubscribe. (Same for using the workspace switcher to navigate to a workspace that doesn't have the current report, or requesting money from a different report).

desktop-chrome-search-2024-04-01_16.09.47.mp4

@tienifr
Copy link
Contributor Author

tienifr commented Apr 2, 2024

@jjcoffee Related to the failed jest unit test: I`ve tried running npx jest --silent --shard=3/3 --max-workers 4 in the latest main but there is the same error

@jjcoffee
Copy link
Contributor

jjcoffee commented Apr 5, 2024

@tienifr The latest commit doesn't seem to fix the issue, e.g. following these repro steps:

  1. Open any report A as user A
  2. Tap the search icon and select any other report B
  3. Open report A as User B and start typing
  4. Observe that reportUserIsTyping is still showing in the console

The same happens if requesting money from another chat/workspace (which causes a switch to another report).

@tienifr
Copy link
Contributor Author

tienifr commented Apr 5, 2024

@jjcoffee

  • I fixed the problem you mentioned.
  • But because we are introducing a new prop in ReportActionView page, that is lastVisitedPath, leads to a failed perf test. I am investigating a new solution.

@tienifr
Copy link
Contributor Author

tienifr commented Apr 5, 2024

@jjcoffee The new solution is to create a new component, "UserTypingEventListener". Then the perf error is gone. Can you review PR again?

@jjcoffee
Copy link
Contributor

jjcoffee commented Apr 5, 2024

@tienifr Unfortunately I'm still seeing the same issue. Can you make sure to retest for that issue before asking for re-review? Thanks! 🙏

@tienifr
Copy link
Contributor Author

tienifr commented Apr 5, 2024

@jjcoffee Yeah. I retested and verify that it works properly. Below is screen recording:

  • In case we open another chat by searching:
output.mp4
  • In case we open another chat by requesting money:
output.mp4

@tienifr
Copy link
Contributor Author

tienifr commented Apr 8, 2024

@jjcoffee Do you have any feedback about my comment?

@jjcoffee
Copy link
Contributor

jjcoffee commented Apr 9, 2024

@tienifr Ah sorry, not sure why when I tested the same issue was happening, maybe there was some stale Onyx data? Anyway, it's working well now! Can you merge main to fix the ts/lint failing tests?

Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

A few questions I'd like to get clarified before merging please - I know this is an important improvement but I don't want to move too fast if the code isn't clean / understandable

src/pages/home/report/UserTypingEventListener.tsx Outdated Show resolved Hide resolved
src/pages/home/report/UserTypingEventListener.tsx Outdated Show resolved Hide resolved
src/pages/home/report/UserTypingEventListener.tsx Outdated Show resolved Hide resolved
@tienifr
Copy link
Contributor Author

tienifr commented Apr 10, 2024

@Beamanator I resolved all your comments

@Beamanator Beamanator self-requested a review April 10, 2024 09:10
Co-authored-by: Alex Beaman <dabeamanator@gmail.com>
@tienifr
Copy link
Contributor Author

tienifr commented Apr 10, 2024

@Beamanator I updated the comment as you suggested

Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

Looking good to me!

@jjcoffee before I merge, do you feel that "optimistic report" comment is good now, or do you feel it needs a bit more explanation?

@jjcoffee
Copy link
Contributor

@Beamanator makes sense to me!

@Beamanator
Copy link
Contributor

@tienifr please merge main 1 more time to hopefully fix the tests

@Beamanator
Copy link
Contributor

Hmm I'm not seeing the Jest test (job3) failing on other, recently created PRs so I'm wondering if this is actually related to this PR -> I'm also seeing it fail locally in your fork & branch, @tienifr 🤔

@tienifr
Copy link
Contributor Author

tienifr commented Apr 10, 2024

@Beamanator I tried to run job3 in main branch, and still encountered the error. Here is the result:

Screen.Recording.2024-04-10.at.17.35.22.mov

@jjcoffee Can you try it?

@Beamanator
Copy link
Contributor

@tienifr hmm that's interesting, that's a different error than I'm seeing, though in the same file 😅 Here's what I'm seeing in your PR & in github actions:

FAIL tests/ui/UnreadIndicatorsTest.tsx (44.075 s)
  ● Unread Indicators › Clear the new line indicator and bold when we navigate away from a chat that is now read

    TypeError: Cannot read properties of undefined (reading 'props')

      175 |     const hintText = Localize.translateLocal('accessibilityHints.navigatesToChat');
      176 |     const optionRows = screen.queryAllByAccessibilityHint(hintText);
    > 177 |     fireEvent(optionRows[index], 'press');
          |              ^
      178 |     await waitForBatchedUpdatesWithAct();
      179 | }
      180 |

@Beamanator
Copy link
Contributor

FYI I started a slack thread cuz that may be easier to discuss there - https://expensify.slack.com/archives/C01GTK53T8Q/p1712745268351209

Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

I added some thoughts in that slack thread but gotta run for a while - if this gets fixed please ping me so I can jump back on to merge, but for now I don't think we should merge until we KNOW the exact test fails in the exact same way on main, or until we fix the test in this PR

@tienifr
Copy link
Contributor Author

tienifr commented Apr 15, 2024

Still discussing this on slack

@Beamanator
Copy link
Contributor

@tienifr please review the change I suggested - if it makes sense to you, can you please make the change & pull main & test hopefully 1 last time?

@tienifr
Copy link
Contributor Author

tienifr commented Apr 15, 2024

@Beamanator Thanks for your suggestion. I applied, tested and it works well

Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

Thanks @tienifr 👍 I'm going to approve & merge b/c it doesn't look like there's any big new changes since @jjcoffee tested last, and you tested again recently so LGTM

@Beamanator Beamanator merged commit ecd22c4 into Expensify:main Apr 15, 2024
15 checks passed
@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

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.63-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants