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

Add leaveRoom action #15392

Merged
merged 19 commits into from
Mar 7, 2023
Merged

Add leaveRoom action #15392

merged 19 commits into from
Mar 7, 2023

Conversation

marcochavezf
Copy link
Contributor

@marcochavezf marcochavezf commented Feb 23, 2023

Requires https://github.com/Expensify/Web-Expensify/pull/36572

Details

Hides and shows the Leave Room button according to the chatType or visibility and triggers the LeaveRoom command to leave the room.

Fixed Issues

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

Tests

  1. Create a new workspace, save the reportID of the #announce room.
  2. ./script/sql.sh and run the following query to update the visibility rNVP to be "public_announce":
    INSERT INTO reportNameValuePairs (reportID, name, value) VALUES (, "visibility", "public_announce");
    Alternatively you can use the reportID of an existing public room, ask @MitchExpensify
  3. In another browser or an incognito session sign in with another account
  4. Navigate to the #announce room (i.e. localhost:8080/r/<reportID)
  5. Click on Leave Room and verify the member's list is updated in the first browser session
  • Verify that no errors appear in the JS console

Offline tests

Same as Test steps, but before Clicking on the Leave Room put the browser/app offline and verify the room disappears from the LHN

QA Steps

  1. Join this room https://new.expensify.com/r/3073545337096441 (or ask @MitchExpensify for the link for a public announce room) with two accounts (e.g. marco@expensify.com and marco@expensifail.com)
  2. On one of those accounts, click on Leave Room and verify the member's list is updated in the other account.
  • 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 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 correct English and 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 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
Screen.Recording.2023-03-02.at.11.17.14.mov
Mobile Web - Chrome
Screen.Recording.2023-03-02.at.12.02.30.mov
Mobile Web - Safari
Screen.Recording.2023-03-02.at.12.01.10.mov
Desktop
Screen.Recording.2023-03-02.at.12.03.23.mov
iOS
Screen.Recording.2023-03-02.at.11.56.43.mov
Android
Screen.Recording.2023-03-02.at.11.58.05.mov

@marcochavezf marcochavezf self-assigned this Feb 23, 2023
@jasperhuangg jasperhuangg self-requested a review March 1, 2023 21:05
@marcochavezf marcochavezf added CP Staging InternalQA This pull request required internal QA labels Mar 2, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Mar 2, 2023

⚠️ ⚠️ Heads up! This pull request has the CP Staging label ⚠️ ⚠️
If you applied the CP Staging label before the PR was merged, the PR will be be immediately deployed to staging even if the open StagingDeployCash deploy checklist is locked.
However if you applied the CP Staging after the PR was merged it's possible it won't be CP'ed automatically. If you need it to be CP'ed to staging, tag a member of @Expensify/mobile-deployers to CP it manually, otherwise you can wait for it to go out with the next deploy.

@marcochavezf marcochavezf changed the title [WIP] Add leaveRoom action [HOLD #36572] Add leaveRoom action Mar 2, 2023
@marcochavezf marcochavezf marked this pull request as ready for review March 2, 2023 18:59
@marcochavezf marcochavezf requested a review from a team as a code owner March 2, 2023 19:00
@marcochavezf marcochavezf requested a review from iwiznia March 2, 2023 19:00
@melvin-bot melvin-bot bot requested review from joelbettner and sobitneupane and removed request for a team March 2, 2023 19:00
@MelvinBot
Copy link

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

@jasperhuangg
Copy link
Contributor

jasperhuangg commented Mar 6, 2023

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 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 correct English and 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 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
web.mov
Mobile Web - Chrome
Screen.Recording.2023-03-06.at.12.44.03.PM.mov
Mobile Web - Safari
mobile-web-safari.mov
Desktop
desktop.mov
iOS
ios.mov
Android

@jasperhuangg
Copy link
Contributor

jasperhuangg commented Mar 6, 2023

Screenshot 2023-03-06 at 11 13 12 AM

Sorry jumped the gun, found this during testing @marcochavezf

EDIT: fixed it for ya since I noticed there was some other logic that needed fixing, also opened this PR https://github.com/Expensify/Auth/pull/7604 that we should probably deploy before yours since your PR enables the "Public" option in the new room page.

@jasperhuangg jasperhuangg changed the title Add leaveRoom action [HOLD Auth#7604] Add leaveRoom action Mar 6, 2023
@jasperhuangg jasperhuangg changed the title [HOLD Auth#7604] Add leaveRoom action Add leaveRoom action Mar 7, 2023
@jasperhuangg jasperhuangg changed the title Add leaveRoom action [HOLD Auth#7604] Add leaveRoom action Mar 7, 2023
@jasperhuangg
Copy link
Contributor

@marcochavezf Auth PR was just merged, if it isn't deployed tomorrow I'll ask for a CP for ya

@jasperhuangg jasperhuangg changed the title [HOLD Auth#7604] Add leaveRoom action Add leaveRoom action Mar 7, 2023
@jasperhuangg jasperhuangg merged commit 17cf77e into main Mar 7, 2023
@jasperhuangg jasperhuangg deleted the marco-addLeaveRoomAction branch March 7, 2023 18:08
OSBotify pushed a commit that referenced this pull request Mar 8, 2023
Add leaveRoom action

(cherry picked from commit 17cf77e)
OSBotify added a commit that referenced this pull request Mar 8, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Mar 8, 2023

🚀 Cherry-picked to staging by https://github.com/jasperhuangg in version: 1.2.80-1 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@marcochavezf
Copy link
Contributor Author

The LeaveRoom button looks good on web:

Screen.Recording.2023-03-08.at.12.49.12.mov

@marcochavezf
Copy link
Contributor Author

On Android (and I think the other platforms) the latest version hasn't been updated. The possible reason here.

@marcochavezf
Copy link
Contributor Author

Tested well on the remaining platforms (1.2.80-1) 👍🏽

@OSBotify
Copy link
Contributor

OSBotify commented Mar 9, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.2.80-2 🚀

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

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

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

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

onyxMethod: CONST.ONYX.METHOD.SET,
key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,
value: {
stateNum: CONST.REPORT.STATE_NUM.SUBMITTED,
Copy link
Contributor

@wildan-m wildan-m Oct 28, 2024

Choose a reason for hiding this comment

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

@marcochavezf what is the reason that we use

                value: {
                    stateNum: CONST.REPORT.STATE_NUM.SUBMITTED,
                    statusNum: CONST.REPORT.STATUS.CLOSED,
                },

Than directly set the report to null?

cc: @parasharrajat

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @wildan-m, iirc we just close the report (where this values represent a closed report) to hide instead of removing completely from Onyx. And I think that's because in case we receive an update for that report, we don't show it again

Also I noticed this code doesn't exist in main, and was changed in this PR https://github.com/Expensify/App/pull/27966/files#diff-8afe5b71ee0436c21364148c86dadd640f2bff3e3d916addbb1f1f6f7e5b6a43R1939-R1940

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
InternalQA This pull request required internal QA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants