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

feat: Subscribe guides to a new presence pusher channel #48696

Merged
merged 11 commits into from
Sep 19, 2024

Conversation

daledah
Copy link
Contributor

@daledah daledah commented Sep 6, 2024

Details

Fixed Issues

$ #47888
PROPOSAL: #47888 (comment)

Tests

  1. Signin
  2. Verify that: pusher channel is subscribed
  3. Signout
  4. Verify that: pusher channel is unsubscribed
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Signin
  2. Verify that: pusher channel is subscribed
  3. Signout
  4. Verify that: pusher channel is unsubscribed
  • 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@daledah daledah marked this pull request as ready for review September 10, 2024 10:27
@daledah daledah requested a review from a team as a code owner September 10, 2024 10:27
@melvin-bot melvin-bot bot requested review from situchan and removed request for a team September 10, 2024 10:27
Copy link

melvin-bot bot commented Sep 10, 2024

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

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

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

I tested it and it didn't work. I am looking into why, but would appreciate you also taking look

@MonilBhavsar
Copy link
Contributor

I investigated a bit. I am experiencing an inverse behavior -
it tries to subscribe the channel when I am signing out
It get's thrown from here

if (!socket) {
throw new Error(`[Pusher] instance not found. Pusher.subscribe()
most likely has been called before Pusher.init()`);
}

Screenshot 2024-09-11 at 4 33 06 PM Could you please take a look, thanks!

@MonilBhavsar
Copy link
Contributor

Also, a heads up isGuide is now in Onyx on staging environment

@daledah
Copy link
Contributor Author

daledah commented Sep 12, 2024

@MonilBhavsar I tested on the staging server and the channel is subscribed:

Screenshot 2024-09-13 at 02 51 34 Screenshot 2024-09-13 at 02 50 26

@MonilBhavsar
Copy link
Contributor

Let me try again 👁️

@daledah
Copy link
Contributor Author

daledah commented Sep 14, 2024

@MonilBhavsar I'm committing some changes, please wait before testing again.

@MonilBhavsar
Copy link
Contributor

Thanks! :D

Also curious what's the source of these screenshots? I mean how did you log it? #48696 (comment)

@daledah
Copy link
Contributor Author

daledah commented Sep 14, 2024

@MonilBhavsar I watched it on WS channels of DevTool Network tab.

@MonilBhavsar
Copy link
Contributor

Thanks! Somehow activeGuides is not showing up for me. Any idea what could go wrong here. Or your changes should fix it?

Screenshot 2024-09-13 at 7 30 02 PM

@daledah
Copy link
Contributor Author

daledah commented Sep 14, 2024

@MonilBhavsar I updated, please test again, thanks!

Also, I realized that when signing out, the pusher channel disconnects so we don't need to define a disconnect function for activeGuides channel anymore.

src/CONST.ts Outdated Show resolved Hide resolved
@MonilBhavsar
Copy link
Contributor

Okay thanks! Worked initially. Running some more tests

@MonilBhavsar
Copy link
Contributor

@situchan feel free to review

@MonilBhavsar
Copy link
Contributor

Okay, it works fine 👍
Let's aim to get it deployed on Monday 🚀

src/libs/actions/User.ts Outdated Show resolved Hide resolved
@melvin-bot melvin-bot bot requested a review from MonilBhavsar September 16, 2024 07:10
Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

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

Minor update

src/libs/actions/User.ts Outdated Show resolved Hide resolved
src/libs/Permissions.ts Outdated Show resolved Hide resolved
@daledah
Copy link
Contributor Author

daledah commented Sep 18, 2024

@MonilBhavsar I updated. Anyway, looks like there's a new check: https://github.com/Expensify/App/actions/runs/10914605763/job/30293006179?pr=48696. Should I fix this as well?

@MonilBhavsar
Copy link
Contributor

Yes, you need to fix it. We cannot merge without it

@situchan
Copy link
Contributor

@MonilBhavsar I updated. Anyway, looks like there's a new check: https://github.com/Expensify/App/actions/runs/10914605763/job/30293006179?pr=48696. Should I fix this as well?

Here's context: https://expensify.slack.com/archives/C01GTK53T8Q/p1726169039084589

FYI: AuthScreens.tsx is being migrated in #49185

@MonilBhavsar
Copy link
Contributor

Okay, let's update ActiveGuidesListener in this PR

/home/runner/work/App/App/src/components/ActiveGuidesEventListener.tsx
28:16 error 'withOnyx' is deprecated. Use useOnyx instead of withOnyx whenever possible.

@MonilBhavsar
Copy link
Contributor

Please merge main

@MonilBhavsar
Copy link
Contributor

Conflicts now :(

Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

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

Thanks!

@MonilBhavsar
Copy link
Contributor

Gonna ignore the error in AuthScreen.tsx as it is being worked on in another issue #48696 (comment)

@MonilBhavsar MonilBhavsar merged commit 37bf6b2 into Expensify:main Sep 19, 2024
15 of 16 checks passed
Copy link

melvin-bot bot commented Sep 19, 2024

@MonilBhavsar 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.

@MonilBhavsar
Copy link
Contributor

Reason: #48696 (comment)

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

@kavimuru
Copy link

@MonilBhavsar could you help with the following steps

Verify that: pusher channel is subscribed

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 9.0.39-0 🚀

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

@MonilBhavsar
Copy link
Contributor

Yes, i'll verify

@jjcoffee
Copy link
Contributor

Possible regression in #49532, could you take a look? @daledah @situchan

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.39-5 🚀

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.

6 participants