ReportAction text for transactions edited in OldDot #30603

cristipaval · 2023-10-30T18:55:52Z

This is part of the Backward compatibility project.

Details

In OldDot, it's possible to edit multiple fields at once on transactions. This PR adds support for the MODIFIEDEXPENSE report actions that have multiple changes in the originalMessage.

Fixed Issues

Part of https://github.com/Expensify/Expensify/issues/327756

Tests

The admin account has a free workspace and adds the employee as a member
employee creates a money request in workspace chat
admin signs into OldDot and opens the newly created expense report
admin edits multiple fields of the transaction (eg. price, category and description)
Verify that admin sees a new report action in the report history in OldDot, describing the changes
Verify that admin sees a new report action in the transaction thread in NewDot, describing the changes
Verify that employee sees a new report action in the transaction thread in NewDot, describing the changes

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests

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: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-10-30T18:56:27Z

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

cristipaval · 2023-10-30T18:59:20Z

I'll attach the screenshots soon.

cristipaval · 2023-10-31T12:54:26Z

I added all screenshots except the iOS native, @tgolen. Still working on making my simulator point to my dev env. Discussing it here

tgolen · 2023-10-31T14:30:51Z

src/libs/ReportUtils.js

+        if (index === 0) {
+            return acc + value;
+        }
+        return `${acc}. ${value.charAt(0).toUpperCase()}${value.slice(1)}`;


I think this looks a bit strange to have a mixture of upper/lower case and also a mix of punctuation:

The reason they don't start with a capital is because you should read it like "Cristi changed...". With the addition of these multiple fragments though, it looks off. Here is what I suggest:

Each message should start with a lower case

Each message should end with a period

If there are multiple fragments, then they should be like changed the date to blah and the amount to blah. (for two) and changed the date to blah, the amount to blah, and the description to blah. (for more than two)

I implemented it similar to how it currently is in OldDot.
I really like your suggestion, I'll also ask in the wave4 channel if we want to change it in OldDot as well because it sounds more natural.

…se-message

cristipaval · 2023-11-07T22:36:48Z

@tgolen, I addressed your feedback. The wording is different when the user sets a field that was empty before, changes it, or deletes it.

I know there's a lot of repetitive code that can be improved, but for now I want to see if how the message looks is ok, see below:

tgolen · 2023-11-08T01:54:26Z

I think that looks OK, yeah. Thanks for doing that.

…

On Tue, Nov 7, 2023 at 3:37 PM Cristi Paval ***@***.***> wrote: @tgolen <https://github.com/tgolen>, I addressed your feedback. The wording is different when the user sets a field that was empty before, changes it, or deletes it. I know there's a lot of repetitive code that can be improved, but for now I want to see if how the message looks is ok, see below: [image: Screenshot 2023-11-08 at 00 33 54] <https://user-images.githubusercontent.com/18078393/281200947-ecdcc9ef-7766-4168-abb6-9459c4381fd7.png> — Reply to this email directly, view it on GitHub <#30603 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJMAB5PV2QVKK23ZOZKORDYDKZYXAVCNFSM6AAAAAA6WQGPEGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMBQGMYDQMBXHE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

cristipaval · 2023-11-08T14:23:29Z

Ready for a new review, @tgolen.

src/libs/ReportUtils.js

Co-authored-by: Tim Golen <tgolen@gmail.com>

…se-message

cristipaval · 2023-12-14T00:26:14Z

This is again ready for review @situchan!

dylanexpensify · 2023-12-14T18:42:58Z

bump @situchan for review!

…se-message

situchan · 2023-12-18T13:10:29Z

I will retest and checklist today

cristipaval · 2023-12-18T13:40:38Z

I will retest and checklist today

Please do; I want to merge this one, as conflicts are coming in.

situchan · 2023-12-19T15:54:48Z

oldDot:
You modified expense 'Merchant'. New merchant is 'Merchant2' (previously 'Merchant'). New date is '2023-12-01' (previously '2023-12-07'). New amount is '$4.00' (previously '$6.00'). New reimbursability status is 'No'. New description is 'test2' (previously 'test'). Added situchandrashil7+23@gmail.com as an attendee.

this branch:
changed the amount to $4.00 (previously $6.00), the description to "test2" (previously "test"), the date to 2023-12-01 (previously 2023-12-06), and the merchant to "Merchant2" (previously "Merchant").

staging:
changed the amount to $4.00 (previously $6.00)

I noticed that date doesn't match (In above example, 2023-12-07 in oldDot, 2023-12-06 in newDot).
But the root cause already exists in production: #33248
So I consider this out of scope

situchan · 2023-12-19T16:28:04Z

LHN last message not displaying correctly until open report first time after login.
I think it's BE issue. Already happening on main so out of scope

Screen.Recording.2023-12-19.at.11.26.47.AM.mov

situchan · 2023-12-19T16:47:01Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

situchan

melvin-bot · 2023-12-19T16:49:37Z

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

melvin-bot · 2023-12-19T16:49:41Z

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

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

stitesExpensify

LGTM!

OSBotify · 2023-12-19T22:25:17Z

✋ 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-12-21T05:30:17Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.4.15-0 🚀

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

OSBotify · 2023-12-22T05:19:00Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.15-5 🚀

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

jjcoffee · 2024-02-05T14:48:05Z

src/libs/ModifiedExpenseMessage.ts

+        return '';
+    }
+    const reportActionOriginalMessage = reportAction.originalMessage as ExpenseOriginalMessage | undefined;
+    const policyID = ReportUtils.getReportPolicyID(reportAction.reportID) ?? '';


MODIFIEDEXPENSE report actions don't have the reportID property, so we fail to get the policyTagListName here. This caused #33493.

ReportAction text for transactions edited in OldDot

94e2dee

cristipaval self-assigned this Oct 30, 2023

cristipaval requested a review from a team as a code owner October 30, 2023 18:55

melvin-bot bot requested review from tgolen and removed request for a team October 30, 2023 18:56

cristipaval added 2 commits October 30, 2023 21:02

Make Lint happy.

6e5d6b0

Run prettier.

a7f3f38

tgolen requested changes Oct 31, 2023

View reviewed changes

cristipaval added 5 commits November 7, 2023 22:42

Merge remote-tracking branch 'origin/main' into cristi_modified-expen…

a445ea6

…se-message

Improve message for MODIFIEDEXPENSE action

a0a856c

Add a safety check

960d00a

Improve MODIFIEDEXPENSE action message

a4e82a8

Improve MODIFIEDEXPENSE action message

b9b7ef4

Remove redundancy.

5190539

cristipaval added 4 commits November 8, 2023 15:59

Update function doc

b5518be

Create reusable function

be978f9

Run prettier

b31ba92

Fix lint.

376944c

cristipaval requested a review from tgolen November 8, 2023 14:23

tgolen requested changes Nov 8, 2023

View reviewed changes

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

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

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

cristipaval and others added 4 commits November 8, 2023 18:11

Update src/libs/ReportUtils.js

b9f4243

Co-authored-by: Tim Golen <tgolen@gmail.com>

Merge remote-tracking branch 'origin/main' into cristi_modified-expen…

16df2d9

…se-message

Move logic in a separate unit

bab1de4

Move policy tags logic to PolicyUtils

4ea44ee

cristipaval added 3 commits December 14, 2023 02:19

3 more tests

a6a28a6

3 more tests

27945e8

Make lint happy an run prettier

8aad9bd

cristipaval mentioned this pull request Dec 14, 2023

Add perf tests for ReportUtils #32637

Merged

47 tasks

cristipaval mentioned this pull request Dec 18, 2023

[SMARTSCAN] [$500] LOW: Web - Request Money - "Changed the date to..." message looks as a new message after refreshing the page #26683

Closed

6 tasks

cristipaval added 2 commits December 18, 2023 15:03

Merge remote-tracking branch 'origin/main' into cristi_modified-expen…

d22c617

…se-message

Add changes from main

13f7b9c

situchan approved these changes Dec 19, 2023

View reviewed changes

melvin-bot bot requested a review from stitesExpensify December 19, 2023 16:49

melvin-bot bot mentioned this pull request Dec 19, 2023

Payment issue for E/App PR#30603 [DUE DEC 25] #33304

Closed

tgolen approved these changes Dec 19, 2023

View reviewed changes

stitesExpensify approved these changes Dec 19, 2023

View reviewed changes

stitesExpensify merged commit df98114 into main Dec 19, 2023
17 of 18 checks passed

stitesExpensify deleted the cristi_modified-expense-message branch December 19, 2023 22:21

github-actions bot mentioned this pull request Dec 21, 2023

Deploy Checklist: New Expensify 2023-12-21 #33391

Closed

51 tasks

mkhutornyi mentioned this pull request Dec 27, 2023

[HOLD for payment 2024-01-24] [$500] IOU - The date does not change and a message with incorrect dates is added #33248

Closed

6 tasks

jjcoffee reviewed Feb 5, 2024

View reviewed changes

jjcoffee mentioned this pull request Feb 5, 2024

[HOLD for payment 2024-02-07] [$500] Tag - Custom name for tag in tag edit message reverts to "tag" after relogin #33493

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ReportAction text for transactions edited in OldDot #30603

ReportAction text for transactions edited in OldDot #30603

cristipaval commented Oct 30, 2023 •

edited by github-actions bot

Loading

melvin-bot bot commented Oct 30, 2023

cristipaval commented Oct 30, 2023

cristipaval commented Oct 31, 2023

tgolen Oct 31, 2023

cristipaval Oct 31, 2023 •

edited

Loading

cristipaval commented Nov 7, 2023

tgolen commented Nov 8, 2023 via email

cristipaval commented Nov 8, 2023

cristipaval commented Dec 14, 2023

dylanexpensify commented Dec 14, 2023

situchan commented Dec 18, 2023

cristipaval commented Dec 18, 2023

situchan commented Dec 19, 2023

situchan commented Dec 19, 2023

situchan commented Dec 19, 2023

situchan left a comment

melvin-bot bot commented Dec 19, 2023

melvin-bot bot commented Dec 19, 2023

stitesExpensify left a comment

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

OSBotify commented Dec 22, 2023

jjcoffee Feb 5, 2024

ReportAction text for transactions edited in OldDot #30603

ReportAction text for transactions edited in OldDot #30603

Conversation

cristipaval commented Oct 30, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 30, 2023

cristipaval commented Oct 30, 2023

cristipaval commented Oct 31, 2023

tgolen Oct 31, 2023

Choose a reason for hiding this comment

cristipaval Oct 31, 2023 • edited Loading

Choose a reason for hiding this comment

cristipaval commented Nov 7, 2023

tgolen commented Nov 8, 2023 via email

cristipaval commented Nov 8, 2023

cristipaval commented Dec 14, 2023

dylanexpensify commented Dec 14, 2023

situchan commented Dec 18, 2023

cristipaval commented Dec 18, 2023

situchan commented Dec 19, 2023

situchan commented Dec 19, 2023

situchan commented Dec 19, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 19, 2023

melvin-bot bot commented Dec 19, 2023

stitesExpensify left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

OSBotify commented Dec 22, 2023

jjcoffee Feb 5, 2024

Choose a reason for hiding this comment

cristipaval commented Oct 30, 2023 •

edited by github-actions bot

Loading

cristipaval Oct 31, 2023 •

edited

Loading