[No QA] Display policy changes logs in NewDot #16500

luacmartins · 2023-03-24T22:23:55Z

Details

Allow workspace changes to be displayed in NewDot

cc @yuwenmemon

Fixed Issues

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

Tests

Setup:

Pull the changes in this Web-E branch
In OldDot, create a paid policy
In OldDot, navigate to Policy > People > Approval mode and change the approval mode
In NewDot, search for the #admins room for the paid policy
Verify that you can see the updated the Approval Mode from "Submit and Close" to "Submit and Approve" policy change message
Verify that the text color is muted (should be the same color as the timestamp)

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

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

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

MelvinBot · 2023-03-27T15:13:32Z

@aimane-chnaif @chiragsalian 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]

yuwenmemon · 2023-03-27T15:15:45Z

src/libs/ReportActionsUtils.js

@@ -193,6 +193,11 @@ function getSortedReportActionsForDisplay(reportActions) {
    const filteredReportActions = filterOutDeprecatedReportActions(reportActions);
    const sortedReportActions = getSortedReportActions(filteredReportActions, true);
    return _.filter(sortedReportActions, (reportAction) => {
+        // Allow all Policy Change reportActions to be displayed
+        if (CONST.REPORT.ACTIONS.TYPE.POLICYCHANGELOG_REGEX.test(reportAction.actionName)) {


We should use startsWith instead of a regex. (https://www.measurethat.net/Benchmarks/Show/4797/1/js-regex-vs-startswith-vs-indexof#latest_results_block)

Updated! But according to that benchmark, we should actually be using indexOf :P

src/pages/home/report/ReportActionItem.js

aimane-chnaif · 2023-03-27T15:23:31Z

Does this require C+ review?

luacmartins · 2023-03-27T15:26:18Z

@aimane-chnaif I'm not sure that you'll be able to test this PR. You can always review the code though

yuwenmemon · 2023-03-27T15:44:52Z

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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

src/libs/ReportActionsUtils.js

aimane-chnaif

policychangelog messages can be grouped or not?

App/src/libs/ReportActionsUtils.js

Lines 120 to 124 in 61726eb

    
           // Do not group if previous or current action was a renamed action 
        
           if (previousAction.actionName === CONST.REPORT.ACTIONS.TYPE.RENAMED 
        
               || currentAction.actionName === CONST.REPORT.ACTIONS.TYPE.RENAMED) { 
        
               return false; 
        
           }

yuwenmemon · 2023-03-27T16:07:59Z

@aimane-chnaif - Yes they can. So no need to worry about that part.

yuwenmemon · 2023-03-27T16:22:55Z

Hmmm.. Tested locally - I have two logs in a chat and the second one is showing in a different style as the first:

luacmartins · 2023-03-27T16:52:20Z

@yuwenmemon I don't see the styling issue. Do you have more specific reproducible steps?

aimane-chnaif · 2023-03-27T17:00:41Z

And maybe add automated tests in ReportActionUtilsTest?

luacmartins · 2023-03-27T17:18:56Z

@aimane-chnaif these are system messages and users should not be able to delete or react to them. The only context actions available are Copy to clipboard, Copy link and Mark as unread

aimane-chnaif · 2023-03-27T17:20:23Z

I am heard systematic messages also accept reactions.
I will defer to reaction expert whether this kind of message can be reacted or not. cc: @stitesExpensify

luacmartins · 2023-03-27T17:22:59Z

We might have to change the way these messages are stored in the backend if we want to support reactions cc @yuwenmemon

stitesExpensify · 2023-03-27T17:53:34Z

We might have to change the way these messages are stored in the backend if we want to support reactions

Are policy change logs in chats not reportActions? I personally like the ability to react to changes like people joining/leaving channels in slack, I think it is a fun way to interact.

aimane-chnaif · 2023-03-28T11:19:36Z

@luacmartins latest updates should show context menu like this, correct?

yuwenmemon

Looks good just one comment!

yuwenmemon · 2023-03-28T11:58:31Z

src/CONST.js

@@ -337,6 +337,48 @@ const CONST = {
                IOU: 'IOU',
                RENAMED: 'RENAMED',
                CHRONOSOOOLIST: 'CHRONOSOOOLIST',
+                POLICYCHANGELOG: {
+                    POLICYCHANGELOG_UPDATE_NAME: 'POLICYCHANGELOG_UPDATE_NAME',


The POLICYCHANGELOG_ prefix here is kind of redundant - can we remove them everywhere in this object?

package-lock.json

yuwenmemon · 2023-03-28T15:11:10Z

@chiragsalian all urs

chiragsalian

Code LGTM 👍

aimane-chnaif

LGTM too, though not able to test 🙂

MelvinBot · 2023-03-28T15:36:29Z

🎯 @aimane-chnaif, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #16622.

OSBotify · 2023-03-28T15:45:44Z

✋ 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 · 2023-03-28T18:12:23Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.2.91-0 🚀

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

OSBotify · 2023-03-29T17:48:41Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.91-1 🚀

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

luacmartins added 3 commits March 24, 2023 17:22

add regex and conditional

86b0c56

create PolicyChangeLogActionItem

8bb7a42

add PolicyChangeLogActionItem to ReportActionItem

1eee700

luacmartins self-assigned this Mar 24, 2023

luacmartins added 4 commits March 27, 2023 14:40

revert changes to PolicyChangeLogActionItem

0acb700

rm unused import

e7e7635

add styles to system message

9a9bf8b

update color

34b9e2b

luacmartins changed the title ~~Display policy changes logs in NewDot~~ [No QA] Display policy changes logs in NewDot Mar 27, 2023

luacmartins marked this pull request as ready for review March 27, 2023 15:12

luacmartins requested a review from a team as a code owner March 27, 2023 15:12

melvin-bot bot requested review from aimane-chnaif and chiragsalian and removed request for a team March 27, 2023 15:13

yuwenmemon requested changes Mar 27, 2023

View reviewed changes

use startsWith instead of regex

168c5a5

luacmartins requested a review from yuwenmemon March 27, 2023 15:20

fix tests

55d155f

yuwenmemon previously approved these changes Mar 27, 2023

View reviewed changes

chiragsalian requested changes Mar 27, 2023

View reviewed changes

src/libs/ReportActionsUtils.js Outdated Show resolved Hide resolved

aimane-chnaif reviewed Mar 27, 2023

View reviewed changes

simplify logic and add specific consts

3b89cae

luacmartins dismissed yuwenmemon’s stale review via 3b89cae March 27, 2023 16:44

luacmartins added 3 commits March 27, 2023 17:06

add all policy change log types

00ed57f

update test

f3ed5da

disable reactions

dcff1f2

luacmartins added 2 commits March 28, 2023 11:10

revert disable reactions

88f9878

rm parenthesis

fee39d4

yuwenmemon requested changes Mar 28, 2023

View reviewed changes

luacmartins added 2 commits March 28, 2023 12:36

rm POLICYCHANGELOG prefix

e6552c4

fix test

2e080fb

luacmartins requested a review from yuwenmemon March 28, 2023 12:37

luacmartins added 2 commits March 28, 2023 12:52

update contains logic

24101a3

revert package-lock.json changes

1d0f6d1

yuwenmemon approved these changes Mar 28, 2023

View reviewed changes

package-lock.json Outdated Show resolved Hide resolved

chiragsalian approved these changes Mar 28, 2023

View reviewed changes

aimane-chnaif approved these changes Mar 28, 2023

View reviewed changes

melvin-bot bot mentioned this pull request Mar 28, 2023

Payment issue for E/App PR#16500 #16622

Closed

chiragsalian merged commit d57b331 into main Mar 28, 2023

chiragsalian deleted the cmartins-displayPolicyChanges branch March 28, 2023 15:37

OSBotify mentioned this pull request Mar 28, 2023

Deploy Checklist: New Expensify 2023-03-28 #16632

Closed

30 tasks

luacmartins mentioned this pull request Apr 3, 2023

Payment issue for E/App PR#16500 #16887

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Display policy changes logs in NewDot #16500

[No QA] Display policy changes logs in NewDot #16500

luacmartins commented Mar 24, 2023 •

edited

Loading

MelvinBot commented Mar 27, 2023

yuwenmemon Mar 27, 2023

luacmartins Mar 27, 2023

aimane-chnaif commented Mar 27, 2023

luacmartins commented Mar 27, 2023

yuwenmemon commented Mar 27, 2023 •

edited

Loading

aimane-chnaif left a comment

yuwenmemon commented Mar 27, 2023

yuwenmemon commented Mar 27, 2023

luacmartins commented Mar 27, 2023

aimane-chnaif commented Mar 27, 2023

luacmartins commented Mar 27, 2023

aimane-chnaif commented Mar 27, 2023

luacmartins commented Mar 27, 2023

stitesExpensify commented Mar 27, 2023

aimane-chnaif commented Mar 28, 2023

yuwenmemon left a comment

yuwenmemon Mar 28, 2023

yuwenmemon commented Mar 28, 2023

chiragsalian left a comment

aimane-chnaif left a comment

MelvinBot commented Mar 28, 2023

OSBotify commented Mar 28, 2023

OSBotify commented Mar 28, 2023

OSBotify commented Mar 29, 2023

	// Do not group if previous or current action was a renamed action
	if (previousAction.actionName === CONST.REPORT.ACTIONS.TYPE.RENAMED
	\|\| currentAction.actionName === CONST.REPORT.ACTIONS.TYPE.RENAMED) {
	return false;
	}

[No QA] Display policy changes logs in NewDot #16500

[No QA] Display policy changes logs in NewDot #16500

Conversation

luacmartins commented Mar 24, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Mar 27, 2023

yuwenmemon Mar 27, 2023

Choose a reason for hiding this comment

luacmartins Mar 27, 2023

Choose a reason for hiding this comment

aimane-chnaif commented Mar 27, 2023

luacmartins commented Mar 27, 2023

yuwenmemon commented Mar 27, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

yuwenmemon commented Mar 27, 2023

yuwenmemon commented Mar 27, 2023

luacmartins commented Mar 27, 2023

aimane-chnaif commented Mar 27, 2023

luacmartins commented Mar 27, 2023

aimane-chnaif commented Mar 27, 2023

luacmartins commented Mar 27, 2023

stitesExpensify commented Mar 27, 2023

aimane-chnaif commented Mar 28, 2023

yuwenmemon left a comment

Choose a reason for hiding this comment

yuwenmemon Mar 28, 2023

Choose a reason for hiding this comment

yuwenmemon commented Mar 28, 2023

chiragsalian left a comment

Choose a reason for hiding this comment

aimane-chnaif left a comment

Choose a reason for hiding this comment

MelvinBot commented Mar 28, 2023

OSBotify commented Mar 28, 2023

OSBotify commented Mar 28, 2023

OSBotify commented Mar 29, 2023

luacmartins commented Mar 24, 2023 •

edited

Loading

yuwenmemon commented Mar 27, 2023 •

edited

Loading