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

Use a single moderationDecision instead of the moderationDecisions array #22852

Merged
merged 9 commits into from
Jul 27, 2023

Conversation

dangrous
Copy link
Contributor

@dangrous dangrous commented Jul 13, 2023

cc @thienlnam

Details

Short version - right now we're using an array of decisions instead a single moderationDecision in it to the front end, due to switching directions partway through the project (we originally were sending the total moderation history). This causes problems with Onyx.merge (some funkiness and messy code required to handle optimistic updates), and it's simpler to handle the moderationDecision on its own, so that it will be replaced instead of added on. By the time this is in review, we send the single object through from Auth to Web-E to App so we should be all set.

Once this is deployed, we'll have one more set of PRs to remove the deprecated logic from Web-E and Auth. Technically this could pose some problems if people are using old App versions, but given the low usage of this feature I'm not super concerned. cc @thienlnam in case you have differing opinions.

Fixed Issues

N/A - General clean up of potential moderation bugs linked to sending an array.

Tests

  • [FOR INTERNAL TEAM ONLY] Same as QA with the addition of:
    • Open Concierge locally to the Manifesto Tier
    • Send another message (with any text, NOT MODERATION_TEST, and flag it as Intimidation
    • You should receive the moderation request in Concierge
    • Clear the flags on the message
    • Verify that the message reappears as normal on both accounts.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Open any chat
  2. Send the message "MODERATION_TEST" from one account
  3. Flag the message as spam from the other account
  4. Verify there is no visual change to the message on either account (getting whispers is fine)
  5. Reflag the message as bullying
  6. Verify the message is hidden on both accounts
  7. Verify the "Reveal/Hide message" button works as expected
  8. Reflag the message as assault
  9. Verify the message is removed in both accounts
  • 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 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
    • 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

Still struggling to get mWeb Chrome working, I'm resetting my device so we'll see.

Web Screenshot 2023-07-14 at 12 50 57
Mobile Web - Chrome
Mobile Web - Safari Screenshot 2023-07-14 at 14 09 48
Desktop Screenshot 2023-07-14 at 12 57 26
iOS Screenshot 2023-07-14 at 14 11 12
Android Screenshot 2023-07-14 at 14 17 57

@dangrous dangrous self-assigned this Jul 13, 2023
@dangrous dangrous changed the title [WIP] first pass [Hold Web-E#38164] Use a single moderationDecision instead of the moderationDecisions array Jul 14, 2023
@dangrous
Copy link
Contributor Author

Almost ready, web-e is on staging

@dangrous dangrous changed the title [Hold Web-E#38164] Use a single moderationDecision instead of the moderationDecisions array Use a single moderationDecision instead of the moderationDecisions array Jul 21, 2023
@dangrous dangrous marked this pull request as ready for review July 21, 2023 14:27
@dangrous dangrous requested a review from a team as a code owner July 21, 2023 14:27
@melvin-bot melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team July 21, 2023 14:27
@melvin-bot
Copy link

melvin-bot bot commented Jul 21, 2023

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

@Santhosh-Sellavel
Copy link
Collaborator

Should we hold this for other PR-related moderation?

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 23, 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 & Desktop
Screen.Recording.2023-07-24.at.12.22.20.AM.mov
Mobile Web - Chrome & Mobile Web - Safari
Screen.Recording.2023-07-25.at.2.21.01.AM.mov
iOS & Android
Screen.Recording.2023-07-25.at.2.08.20.AM.mov

@Santhosh-Sellavel
Copy link
Collaborator

@dangrous One question is this a bug?

  1. Try flagging a message as SPAM
  2. Verify There is no visual change to the message on either account (getting whispers is fine) ✅
  3. Reflag the message as bullying
  4. Verify the message is hidden on both accounts ✅
  5. Verify the "Reveal/Hide message" button works as expected ✅
  6. Reflag the message as SPAM
  7. Messages reappeared and the hide/reveal option was hidden but back after a few seconds ✅ or ❌ ?
Screen.Recording.2023-07-24.at.12.33.41.AM.mov

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

Looks good just waiting for this #22852 (comment)

@dangrous
Copy link
Contributor Author

i think that is an existing bug, but let me see if I can fix it here. (I have a note somewhere that says "Flagging as spam when already flagged as higher hides the 'reveal message' button very briefly" which I think is the same bug). The issue seems to be with the optimistic data still - since expected behavior is the end state (no change from when it was already flagged - and that's the updated data coming from the server.

@dangrous
Copy link
Contributor Author

Updated! That bug should be fixed - i also cleaned up the logic a bit since it was unnecessarily complicated.

@Santhosh-Sellavel
Copy link
Collaborator

After flagging only comments in the thread LHN shows fake

Screenshot 2023-07-25 at 2 02 59 AM

Should I log a bug separately as this exists on the main too?

@thienlnam thienlnam self-requested a review July 24, 2023 20:36
@thienlnam
Copy link
Contributor

Adding myself as a reviewer for this issue since it's not linked to an existing one so pullerbear didn't pull one.

Would be great if we could resolve the above bug as well in this PR - I know we had the same problem with deleting the only comment in a chat report. I wonder if we could do the same here as well

@Santhosh-Sellavel
Copy link
Collaborator

@dangrous
Testing while offline, after clicking flag comment infinite loading in RHN, is this expected?

Screenshot 2023-07-25 at 2 11 46 AM

@thienlnam
Copy link
Contributor

That does not look intended, you should be able to flag comments offline

@Santhosh-Sellavel
Copy link
Collaborator

Should I log a bug separately or will this be handled here?

@Santhosh-Sellavel
Copy link
Collaborator

IMO we should create follow-ups as both bugs are not caused here, let me know your thoughts thanks!
cc: @dangrous @thienlnam

@dangrous
Copy link
Contributor Author

I will look into both of these! I think separate issues might make the most sense since they're not caused by this PR and contributors can likely work on both. But let me take a little bit of time and see if I can figure them out now.

@dangrous
Copy link
Contributor Author

One down, one to go

@dangrous
Copy link
Contributor Author

Let's actually move ahead with this PR, and add a separate issue for the loading while offline - it's not consistently reproducible (at least for me) so would need a bunch more investigation. It's definitely front end (so contributor friendly), and not directly related to this.

@Santhosh-Sellavel
Copy link
Collaborator

@dangrous Please resolve conflicts, thanks!

@dangrous
Copy link
Contributor Author

Oops I thought I commented here yesterday. Conflicts resolved

@Santhosh-Sellavel
Copy link
Collaborator

Will look later today

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@melvin-bot melvin-bot bot requested a review from AndrewGable July 27, 2023 19:39
@melvin-bot
Copy link

melvin-bot bot commented Jul 27, 2023

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

@AndrewGable AndrewGable removed their request for review July 27, 2023 20:51
@AndrewGable
Copy link
Contributor

Deferring review to @thienlnam

Copy link
Contributor

@thienlnam thienlnam left a comment

Choose a reason for hiding this comment

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

Awesome, thanks!

@thienlnam thienlnam merged commit 190f759 into main Jul 27, 2023
@thienlnam thienlnam deleted the dangrous-objectmoderationdecisionnotarray branch July 27, 2023 21:30
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.47-1 🚀

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

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 2, 2023

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.49-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 3, 2023

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.49-3 🚀

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.

5 participants