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

Update subscribe on leave #30812

Merged
merged 14 commits into from
Jan 6, 2024
Merged

Update subscribe on leave #30812

merged 14 commits into from
Jan 6, 2024

Conversation

srikarparsi
Copy link
Contributor

@srikarparsi srikarparsi commented Nov 3, 2023

Details

Fixed Issues

$ #30546
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Test with this Auth PR

  1. Comment in a room
  2. .Reply in thread to that comment
  3. Leave the thread report that you commented in
  4. The subscribe icon should show up in the parent comment's action menu

Offline tests

QA Steps

  • Verify that no errors appear in the JS console

Same as Tests

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

Android: Native
Android: mWeb Chrome image
iOS: Native
iOS: mWeb Safari image
MacOS: Chrome / Safari
Screen.Recording.2023-11-16.at.4.11.58.AM.mov
MacOS: Desktop image

@srikarparsi srikarparsi self-assigned this Nov 3, 2023
@srikarparsi srikarparsi marked this pull request as ready for review November 16, 2023 09:29
@srikarparsi srikarparsi requested a review from a team as a code owner November 16, 2023 09:29
@melvin-bot melvin-bot bot requested review from ntdiary and removed request for a team November 16, 2023 09:29
Copy link

melvin-bot bot commented Nov 16, 2023

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

@srikarparsi srikarparsi requested review from chiragsalian and a team and removed request for ntdiary November 16, 2023 09:29
@melvin-bot melvin-bot bot requested review from ntdiary and removed request for a team November 16, 2023 09:29
Copy link

melvin-bot bot commented Nov 16, 2023

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

@ntdiary
Copy link
Contributor

ntdiary commented Nov 16, 2023

Hi, I need to spend more time on another modal refocusing issue, so I plan to un-assign myself. If @chiragsalian is available, please feel free to push forward. :)

Well, I can't un-assign myself in a PR...😅

@situchan
Copy link
Contributor

I can take this over if @ntdiary agrees

@ntdiary
Copy link
Contributor

ntdiary commented Nov 17, 2023

I can take this over if @ntdiary agrees

@situchan, please feel free to push forward if needed. 🚀

@situchan
Copy link
Contributor

@srikarparsi please pull main. It maybe fix author checklist failing.

@srikarparsi
Copy link
Contributor Author

Hi, I didn't add the other screenshots yet which is why author checklist is failing. Please review it if you have a chance in the meantime though and I'll add screenshots tomorrow :)

@situchan
Copy link
Contributor

Missing screenshots doesn't affect checklist. If you pull main, I think it will be fixed.

@situchan
Copy link
Contributor

And https://github.com/Expensify/Auth/pull/9222 is deployed to staging/production?

@chiragsalian
Copy link
Contributor

And https://github.com/Expensify/Auth/pull/9222 is deployed to staging/production?

nope its not merged yet.

@srikarparsi srikarparsi requested review from situchan and removed request for ntdiary November 27, 2023 21:34
@srikarparsi
Copy link
Contributor Author

Hey @situchan, Auth PR is on production now so this is ready for review :)

@situchan
Copy link
Contributor

Please complete author checklist when you get a chance

@srikarparsi
Copy link
Contributor Author

Finished the checklist and merged main, it's ready for review whenever you get a chance @situchan

@situchan
Copy link
Contributor

Code LGTM! Testing

@situchan
Copy link
Contributor

@srikarparsi Leave case works well. I think we should implement same for Join case.
So optimistically subscribe when join. I tested and confirmed this was implemented already in backend.

@srikarparsi
Copy link
Contributor Author

Thanks for the review! For joining a room, I believe we already optimistically subscribe when we join.

Join room button calls updateNotificationPreference here

Update notification preference sends optimistic data for childReportNotificationPreference here

Was this what you were referring to or something else?

@situchan
Copy link
Contributor

Thanks for the review! For joining a room, I believe we already optimistically subscribe when we join.

Join room button calls updateNotificationPreference here

Update notification preference sends optimistic data for childReportNotificationPreference here

Was this what you were referring to or something else?

I reported based on testing

Screen.Recording.2023-12-22.at.2.08.30.AM.mov

@situchan
Copy link
Contributor

I think I found the root cause. parentReportID is 5th param of updateNotificationPreference but it's not being passed.
Should this be fixed separately? Or here in this PR? I am fine either way. Just to confirm

@srikarparsi
Copy link
Contributor Author

Nice, thanks @situchan. Yeah, I just added in the fix for it here since it's pretty straightforward.

@situchan
Copy link
Contributor

situchan commented Jan 4, 2024

Please resolve conflict came from #33791 you reviewed

@situchan
Copy link
Contributor

situchan commented Jan 4, 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 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.mov
Android: mWeb Chrome
mchrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
msafari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

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

:shipit:

@melvin-bot melvin-bot bot requested a review from deetergp January 4, 2024 07:22
Copy link

melvin-bot bot commented Jan 4, 2024

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

@deetergp
Copy link
Contributor

deetergp commented Jan 5, 2024

@srikarparsi You've got a failing Reassure Performance Tests failure. Not sure how to go about addressing that…

@situchan
Copy link
Contributor

situchan commented Jan 5, 2024

@srikarparsi You've got a failing Reassure Performance Tests failure. Not sure how to go about addressing that…

It's unrelated.
We disabled that test temporarily in #34042 so after pulling main, it will be gone

@deetergp deetergp merged commit 0c351a4 into main Jan 6, 2024
13 checks passed
@deetergp deetergp deleted the srikar-updateSubscribeOnLeave branch January 6, 2024 01:16
@OSBotify
Copy link
Contributor

OSBotify commented Jan 6, 2024

✋ 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

OSBotify commented Jan 9, 2024

🚀 Deployed to staging by https://github.com/deetergp in version: 1.4.23-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.23-4 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 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