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

Polish admins-only policy room feature #21950

Merged
merged 39 commits into from
Jul 25, 2023

Conversation

rezkiy37
Copy link
Contributor

@rezkiy37 rezkiy37 commented Jun 30, 2023

Details

Fixed Issues

$ #21456
PROPOSAL: #21456 (comment)

Tests

  • Verify that no errors appear in the JS console
  1. Add the “Who can post” setting to the “New Room” form.
    a. Since, it is not a production feature yet, you should be invited to the policy room beta.
    b. Run script "web" and open the web app. Obviously, you are able to run on any platform, but here we can easily debug.
    c. Click on "+" (FAB menu).
    d. Click on "New room".
    e. Select a workspace, where you are an admin.
    f. Verify that there is a new selector - "Who can post" with 2 values: "All members" and "Amins only".
    g. Fill in all selectors/inputs as you want (up to you).
    h. Open the "Network" tap of DevTools. Recommendations: select "XHR/Fetch" and "Preserve Log".
    i. Click on "Create room".
    j. Find a request ends "command=AddWorksapceRoom" and open "Payload" tap.
    k. Verify that there is the writeCapability key and the value should be that you have selected: "All members" equals all and "Amins only" equals admins.
    l. Repeat from the c step, but select the other value for the new selector.
  2. Filter out admin-only rooms for members in the “Share somewhere” selector of the “Assign task” action (accessible via the FAB menu) - so that members cannot share a task to the room.
    a. Since, it is not a production feature yet, you should be invited to the policy room beta and assign task beta.
    b. Run script "web" and open the web app. Obviously, you are able to run on any platform, but here we can easily debug.
    c. You should be a member of any workspace where there are "admin-only" and "all members" posting rooms. Note: you should not be an admin for this workspace to test this improvement.
    d. Click on "+" (FAB menu).
    f. Click on "Assign task".
    f. Fill in any text to "Title" and "Description", it is up to you.
    g. Click on "Next".
    h. Click on "Assign".
    i. Verify that no "admin-only" rooms, because your are a member for the current workspace.
  3. Reduce the padding between the last message and the bottom of the page when Composer isn’t present (e.g. for the “member” view in an admin-only room).
    a. Since, it is not a production feature yet, you should be invited to the policy room beta.
    b. Run script "web" and open the web app. Obviously, you are able to run on any platform, but here we can easily debug.
    c. You should be a member of any workspace where there are "admin-only" and "all members" posting rooms. Note: you should not be an admin for this workspace to test this improvement.
    d. Open any "admin-only" posting room.
    e. Verify that the distance between the bottom and the last message is shorter than on the staging or production.
  4. Update the room description to be Use ${roomName} to hear about important announcements related to ${workspaceName} for "admin-only" rooms.
    a. Since, it is not a production feature yet, you should be invited to the policy room beta.
    b. Run script "web" and open the web app. Obviously, you are able to run on any platform, but here we can easily debug.
    c. Open any "admin-only" posting room.
    d. Verify that the welcome message is a kind of: "Use <ROOM_NAME> to hear about important announcements related to <WORKSPACE_NAME>".

Offline tests

  1. Add the “Who can post” setting to the “New Room” form.
    a. Since, it is not a production feature yet, you should be invited to the policy room beta.
    b. Open the app.
    c. Enable the offline mode.
    d. Click on "+" (FAB menu).
    e. Click on "New room".
    f. Select a workspace, where you are an admin.
    g. Verify that a new selector appears - "Who can post" with 2 values: "All members" and "Amins only".
    h. Select any value for the new selector. Fill in the other selectors/inputs as you want (up to you).
    i. Click on "Create room".
    j. The app should redirect you to a new room chat page.
    k. Open the chat settings and verify that it has the same values that you entered before.
    l. Disable the offline mode.
    m. Repeat from the c step, but select the other value for the new selector.

QA Steps

  • Verify that no errors appear in the JS console
  1. Add the “Who can post” setting to the “New Room” form.
    a. Since, it is not a production feature yet, you should be invited to the policy room beta.
    b. Open the app.
    c. Click on "+" (FAB menu).
    d. Click on "New room".
    e. Select a workspace, where you are an admin.
    f. Verify that a new selector appears - "Who can post" with 2 values: "All members" and "Amins only".
    g. Select any value for the new selector. Fill in the other selectors/inputs as you want (up to you).
    h. Click on "Create room".
    i. The app should redirect you to a new room chat page.
    j. Open the chat settings and verify that it has the same values that you entered before.
    k. Repeat from the c step, but select the other value for the new selector.
  2. Filter out admin-only rooms for members in the “Share somewhere” selector of the “Assign task” action (accessible via the FAB menu) - so that members cannot share a task to the room.
    a. Since, it is not a production feature yet, you should be invited to the policy room beta and assign task beta.
    b. Open the app.
    c. You should be a member of any workspace where there are "admin-only" and "all members" posting rooms. Note: you should not be an admin for this workspace to test this improvement.
    d. Click on "+" (FAB menu).
    f. Click on "Assign task".
    f. Fill in any text to "Title" and "Description", it is up to you.
    g. Click on "Next".
    h. Click on "Assign".
    i. Verify that no "admin-only" rooms, because your are a member for the current workspace.
  3. Reduce the padding between the last message and the bottom of the page when Composer isn’t present (e.g. for the “member” view in an admin-only room).
    a. Since, it is not a production feature yet, you should be invited to the policy room beta.
    b. Open the app.
    c. You should be a member of any workspace where there are "admin-only" and "all members" posting rooms. Note: you should not be an admin for this workspace to test this improvement.
    d. Open any "admin-only" posting room.
    e. Verify that the distance between the bottom and the last message is shorter than on the staging or production.
  4. Update the room description to be Use ${roomName} to hear about important announcements related to ${workspaceName} for "admin-only" rooms.
    a. Since, it is not a production feature yet, you should be invited to the policy room beta.
    b. Open the app.
    c. Open any "admin-only" posting room.
    d. Verify that the welcome message is a kind of: "Use <ROOM_NAME> to hear about important announcements related to <WORKSPACE_NAME>".

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
  1. Add the “Who can post” setting to the “New Room” form.
1.mov
1 1 1 2
  1. Filter out admin-only rooms for members in the “Share somewhere” selector of the “Assign task” action (accessible via the FAB menu) - so that members cannot share a task to the room.
2.mp4
  1. Reduce the padding between the last message and the bottom of the page when Composer isn’t present (e.g. for the “member” view in an admin-only room).
3 after
  1. Update the room description to be Use ${roomName} to hear about important announcements related to ${workspaceName} for "admin-only" rooms.
4
Mobile Web - Chrome
  1. Add the “Who can post” setting to the “New Room” form.
Chrome.1.MP4

Chrome 1

  1. Filter out admin-only rooms for members in the “Share somewhere” selector of the “Assign task” action (accessible via the FAB menu) - so that members cannot share a task to the room.
Chrome.2.MP4
  1. Reduce the padding between the last message and the bottom of the page when Composer isn’t present (e.g. for the “member” view in an admin-only room).

Mobile Chrome 3, 4

  1. Update the room description to be Use ${roomName} to hear about important announcements related to ${workspaceName} for "admin-only" rooms.

Mobile Chrome 3, 4

Mobile Web - Safari
  1. Add the “Who can post” setting to the “New Room” form.
Mobile.Safari.1.MP4
  1. Filter out admin-only rooms for members in the “Share somewhere” selector of the “Assign task” action (accessible via the FAB menu) - so that members cannot share a task to the room.
Mobile.Safari.2.MP4
  1. Reduce the padding between the last message and the bottom of the page when Composer isn’t present (e.g. for the “member” view in an admin-only room).

Mobile Safari 3, 4

  1. Update the room description to be Use ${roomName} to hear about important announcements related to ${workspaceName} for "admin-only" rooms.

Mobile Safari 3, 4

Desktop
  1. Add the “Who can post” setting to the “New Room” form.
Deskop.1.mov
  1. Filter out admin-only rooms for members in the “Share somewhere” selector of the “Assign task” action (accessible via the FAB menu) - so that members cannot share a task to the room.
Deskop.2.mov
  1. Reduce the padding between the last message and the bottom of the page when Composer isn’t present (e.g. for the “member” view in an admin-only room).
Desktop 3, 4
  1. Update the room description to be Use ${roomName} to hear about important announcements related to ${workspaceName} for "admin-only" rooms.
Desktop 3, 4
iOS
  1. Add the “Who can post” setting to the “New Room” form.
IOS.1.mov
  1. Filter out admin-only rooms for members in the “Share somewhere” selector of the “Assign task” action (accessible via the FAB menu) - so that members cannot share a task to the room.
IOS.2.mov
  1. Reduce the padding between the last message and the bottom of the page when Composer isn’t present (e.g. for the “member” view in an admin-only room).
IOS 3, 4
  1. Update the room description to be Use ${roomName} to hear about important announcements related to ${workspaceName} for "admin-only" rooms.
IOS 3, 4
Android
  1. Add the “Who can post” setting to the “New Room” form.
Android.1.mov
  1. Filter out admin-only rooms for members in the “Share somewhere” selector of the “Assign task” action (accessible via the FAB menu) - so that members cannot share a task to the room.
Android.2.mov
  1. Reduce the padding between the last message and the bottom of the page when Composer isn’t present (e.g. for the “member” view in an admin-only room).
Android 3, 4
  1. Update the room description to be Use ${roomName} to hear about important announcements related to ${workspaceName} for "admin-only" rooms.
Android 3, 4

@rezkiy37 rezkiy37 marked this pull request as ready for review July 4, 2023 09:45
@rezkiy37 rezkiy37 requested a review from a team as a code owner July 4, 2023 09:45
@melvin-bot melvin-bot bot requested review from mananjadhav and shawnborton and removed request for a team July 4, 2023 09:45
@melvin-bot
Copy link

melvin-bot bot commented Jul 4, 2023

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

@shawnborton
Copy link
Contributor

Seems good to me. One thing to consider though for a different PR, do we want all of the inputs on the create room flow to use our push-to-page pattern? cc @JmillsExpensify @trjExpensify for a gut check there

@rezkiy37
Copy link
Contributor Author

rezkiy37 commented Jul 6, 2023

@shawnborton Hi! Do I need an approve from you on this PR?

@shawnborton
Copy link
Contributor

This looks good to me, assuming we'll update the input style in a different PR.

@amyevans
Copy link
Contributor

@rezkiy37 there are conflicts now 😅

@rezkiy37
Copy link
Contributor Author

rezkiy37 commented Jul 24, 2023

@rezkiy37 there are conflicts now 😅

Just fixed!

@mananjadhav
Copy link
Collaborator

@amyevans I did some testing and it works fine. Can you do a final review? I can then finish the checklist by uploading screencasts for all the platforms?

@amyevans
Copy link
Contributor

@mananjadhav Done!

@mananjadhav
Copy link
Collaborator

mananjadhav commented Jul 25, 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 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
web-policy-admin_UJauJnF3.mp4
Mobile Web - Chrome
mweb-chrome-policy-admin.mov
Mobile Web - Safari
mweb-safari-policy-admin.mov
Desktop
desktop-policy-admin.mov
iOS
ios-policy-admin.mov
Android
android-policy-admin.mov

@mananjadhav
Copy link
Collaborator

@amyevans All yours.

🎀 👀 🎀 C+ reviewed.

cc - @rezkiy37

@amyevans amyevans merged commit 0e2f742 into Expensify:main Jul 25, 2023
10 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/amyevans in version: 1.3.46-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.47-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.46-2 🚀

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

@Pujan92
Copy link
Contributor

Pujan92 commented Jul 28, 2023

@rezkiy37 @mananjadhav @amyevans due to incorrect mappings in buildOptimisticChatReport for missed instances within this PR causing regressions.

@rezkiy37
Copy link
Contributor Author

@rezkiy37 @mananjadhav @amyevans due to incorrect mappings in buildOptimisticChatReport for missed instances within this PR causing regressions.

@Pujan92, AFAIK, you already posted a proposal to fix it. Are you going to open a PR or should I do it?

@Pujan92
Copy link
Contributor

Pujan92 commented Jul 28, 2023

I can raise a PR but as it is in the regression period the author gets the first chance to raise it.

@rezkiy37
Copy link
Contributor Author

I can raise a PR but as it is in the regression period the author gets the first chance to raise it.

Well, I am the author and will fix it. Okay?

@Pujan92
Copy link
Contributor

Pujan92 commented Jul 28, 2023

Well, I am the author and will fix it. Okay?

Sure 😅 , if it is considered and labeled as deployBlocker then maybe the team could have considered my proposal and assigned me to unblock deployment.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.47-6 🚀

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.

7 participants