feature: Stop using reportAction.originalMessage or reportAction.messge #40168

nkdengineer · 2024-04-12T09:20:21Z

Details

This PR is part of Phase 1, linking this plan

Fixed Issues

$ #39797
PROPOSAL: #39797 (comment)

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…ge.text

melvin-bot · 2024-04-15T11:10:27Z

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

cubuspl42 · 2024-04-16T07:54:56Z

Typo in the PR name: messge.text
Conflicts
Failing unit tests

cubuspl42 · 2024-04-16T08:17:34Z

src/components/Attachments/AttachmentCarousel/extractAttachmentsFromReport.ts

@@ -76,9 +76,9 @@ function extractAttachmentsFromReport(parentReportAction?: OnyxEntry<ReportActio
            return;
        }

-        const decision = action?.message?.[0]?.moderationDecision?.decision;
+        const decision = ReportActionsUtils.getReportActionMessage(action)?.moderationDecision?.decision;


Please introduce a local variable, so we don't repeat ourselves and so the lines don't get extremely long.

Please do that in other spots of the PR, wherever it's easy to do.

cubuspl42 · 2024-04-16T08:20:52Z

src/libs/ModifiedExpenseMessage.ts

@@ -8,6 +8,7 @@ import DateUtils from './DateUtils';
 import getReportPolicyID from './getReportPolicyID';
 import * as Localize from './Localize';
 import * as PolicyUtils from './PolicyUtils';
+import {getReportActionOriginalMessage} from './ReportActionsUtils';


We always import ReportActionsUtils like import * as ReportActionsUtils; this would be a precedence. I know it affects line length, but I think we should keep being consistent

src/libs/ReportActionsUtils.ts

nkdengineer · 2024-04-16T09:34:46Z

@cubuspl42 I'm updating, will ping you back when completed.

cubuspl42 · 2024-04-16T09:36:01Z

Please fill the Details, at least one sentence. You could mention that this PR is part of Phase 1, linking this plan.

cubuspl42 · 2024-04-17T10:33:16Z

Please correct me if I'm wrong, but it looks like we're quite far from being done here. Please search the code for the string originalMessage, case-sensitive. There are around 300 results; some of them are local variables, but some are actual leftovers of the concept we were supposed to remove from the code.

nkdengineer · 2024-04-17T10:54:04Z

@cubuspl42 I refactor by checking .originalMessage. The other cases in the app now is update field originalMessage in optimistic data. We should keep this now because many filed from originalMessage doesn't exist in message filed. We should remove this from optimistic data when the phrase 2 is done. What do you think? Correct me if I missed something.

cubuspl42 · 2024-04-17T11:24:25Z

We should keep this now because many filed from originalMessage doesn't exist in message filed

(I assume you meant "fields")

But if this is the case, how can we execute the Phase 2...

Stop sending originalMessage

...?

cc: @quinthar

cubuspl42 · 2024-04-17T11:24:44Z

Conflicts ⚔️

cubuspl42 · 2024-04-18T08:09:00Z

@quinthar

The clarification question you is: was your original intention to remove reportAction.originalMessage, altogether (reads, writes, optimistic updates, ...), from the frontend code in Phase 1, assuming that all such usages can be replaced with the "array message" (message.html || message[0].html) ?

@nkdengineer

We should keep this now because many filed from originalMessage doesn't exist in message filed

Would you expand on this, providing examples? As typing was added to Expensify relatively recently, it would be best if you focused on analyzing the backend-returned data in addition to inspecting the TypeScript types.

nkdengineer · 2024-04-18T08:30:41Z

@cubuspl42 Here is an example. For iou action, the originalMessage data has some fields like IOUTransactionID, IOUReportID, ... that don't exist in message data

cubuspl42 · 2024-04-23T09:16:22Z

@nkdengineer Unit tests fail

cubuspl42 · 2024-04-23T09:16:40Z

We're discussing this PR on Slack

mallenexpensify · 2024-04-24T00:19:33Z

@nkdengineer @parasharrajat will be taking over to review the PR.

nkdengineer · 2024-04-25T02:00:30Z

@parasharrajat About this concern here #40168 (comment), can you please tell me the update of the discuss in Slack here #40168 (comment)? Thanks.

c3024 · 2024-04-30T08:31:26Z

#40168 (comment)

@nkdengineer There are a few ?.originalMessage as well. Could you replace them as well, fix conflicts and check failures of unit tests etc.?

nkdengineer · 2024-05-02T10:39:54Z

I'm fixing.

nkdengineer · 2024-05-06T09:08:55Z

@c3024 Can you please share with me what is the result of this discussion #40168 (comment)?

c3024 · 2024-05-07T17:13:34Z

We will replace all cases where fields are available in both originalMessage and message. If some field is available in originalMessage but not in message we will retain that use of that originalMessage.

OSBotify · 2024-06-21T09:20:14Z

✋ 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 · 2024-06-21T21:42:58Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.0.1-0 🚀

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

c3024 · 2024-06-23T12:06:30Z

Phase 1 (External / clientside): Stop using originalMessage, start using array-message
Update every instance of originalMessage.html to use message.html || message[0].html
Update every instance of message.text to dynamically strip the text from message.html || message[0].html

Based on this description we assumed all report actions that have text have html.
But there are two cases #44214 and #44207 where report action does not have html or html is blank but text has the right data.

cc: @nkdengineer @roryabraham

aldo-expensify · 2024-06-24T22:54:21Z

src/libs/ReportUtils.ts

+    if (!ReportActionsUtils.isMoneyRequestAction(reportAction)) {
+        return '';
+    }


This check seems to be causing this deploy blocker: #44338

The actionName is "REIMBURSEMENTQUEUED"

Fixing here: #44357

aldo-expensify · 2024-06-24T22:55:27Z

src/libs/ReportUtils.ts

+    if (!ReportActionsUtils.isReimbursementDeQueuedAction(reportAction)) {
+        return '';
+    }


Wondering if this check could cause a similar problem like the one here: https://github.com/Expensify/App/pull/40168/files#r1651736267

deetergp · 2024-06-24T23:00:46Z

I'm pretty sure this PR is the cause if this blocker: #40168

blazejkustra · 2024-06-25T09:28:36Z

Found a regression from this PR, fix is up here

c3024 · 2024-06-25T09:32:00Z

@blazejkustra that is included in this followup PR #44365.

blazejkustra · 2024-06-25T10:19:11Z

src/libs/ReportActionsUtils.ts

+function getReportActionText(reportAction: PartialReportAction): string {
+    const html = getReportActionHtml(reportAction);
+    const parser = new ExpensiMark();
+    return html ? parser.htmlToText(html) : '';
+}
+
+function getTextFromHtml(html?: string): string {
+    const parser = new ExpensiMark();
+    return html ? parser.htmlToText(html) : '';
+}


Bookmark 🔖

OSBotify · 2024-06-25T19:43:35Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.1-19 🚀

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

ZhenjaHorbach · 2024-07-10T15:53:47Z

src/libs/ReportUtils.ts


-    if (isEmptyObject(report) || !report?.reportID) {
+    if (isEmptyObject(report) || !report?.reportID || isEmptyObject(iouReportAction)) {


These changes caused this issue

Empty iouReportAction leads to an empty preview message, causing the chat will not be displayed in LHN.

eh2077 · 2024-07-30T01:37:08Z

src/libs/SidebarUtils.ts

-        } else if (
-            lastActionName === CONST.REPORT.ACTIONS.TYPE.ROOM_CHANGE_LOG.INVITE_TO_ROOM ||
-            lastActionName === CONST.REPORT.ACTIONS.TYPE.ROOM_CHANGE_LOG.REMOVE_FROM_ROOM ||
-            lastActionName === CONST.REPORT.ACTIONS.TYPE.POLICY_CHANGE_LOG.INVITE_TO_ROOM ||
-            lastActionName === CONST.REPORT.ACTIONS.TYPE.POLICY_CHANGE_LOG.REMOVE_FROM_ROOM
-        ) {
-            const lastActionOriginalMessage = lastAction?.actionName ? (lastAction?.originalMessage as ChangeLog) : null;
+        } else if (ReportActionsUtils.isRoomChangeLogAction(lastAction)) {


This caused a regression here #44610

DylanDylann · 2024-08-29T09:34:39Z

src/libs/ReportActionsUtils.ts

@@ -324,7 +385,10 @@ function getCombinedReportActions(reportActions: ReportAction[], transactionThre
    const isSelfDM = report?.chatType === CONST.REPORT.CHAT_TYPE.SELF_DM;
    // Filter out request and send money request actions because we don't want to show any preview actions for one transaction reports
    const filteredReportActions = [...reportActions, ...filteredTransactionThreadReportActions].filter((action) => {
-        const actionType = (action as OriginalMessageIOU).originalMessage?.type ?? '';
+        if (!isMoneyRequestAction(action)) {


@nkdengineer Coming from your new PR #48139, Why did we need to add this check?

@DylanDylann It's only used to predict the type of action.

feture: Stop using reportAction.originalMessage or reportAction.messa…

a9fedf4

…ge.text

nkdengineer mentioned this pull request Apr 12, 2024

[HOLD for payment 2024-07-10] [HOLD for payment 2024-07-02] LOW: [$500] Stop using reportAction.originalMessage or reportAction.message.text #39797

Closed

refactor using getReportActionMessage

9c9cd84

nkdengineer marked this pull request as ready for review April 15, 2024 11:09

nkdengineer requested a review from a team as a code owner April 15, 2024 11:09

melvin-bot bot removed the request for review from a team April 15, 2024 11:10

melvin-bot bot requested a review from cubuspl42 April 15, 2024 11:10

cubuspl42 suggested changes Apr 16, 2024

View reviewed changes

nkdengineer changed the title ~~feature: Stop using reportAction.originalMessage or reportAction.messge.text~~ feature: Stop using reportAction.originalMessage or reportAction.messge Apr 17, 2024

revert change originalMessage

23b45eb

nkdengineer force-pushed the fix/39797 branch from e114a09 to 23b45eb Compare May 8, 2024 07:57

fix ts check

342f51f

roryabraham approved these changes Jun 21, 2024

View reviewed changes

roryabraham merged commit 0150459 into Expensify:main Jun 21, 2024
15 checks passed

github-actions bot mentioned this pull request Jun 21, 2024

Deploy Checklist: New Expensify 2024-06-21 #44186

Closed

ishpaul777 mentioned this pull request Jun 24, 2024

[HOLD for payment 2024-07-10] [HOLD for payment 2024-07-02] [$250] Room - Room chat LHN preview displays "removed 0 user" after editing room description #44194

Closed

6 tasks

francoisl mentioned this pull request Jun 24, 2024

[HOLD for payment 2024-07-10] [HOLD for payment 2024-07-02] [$250] Expense - Expense preview in the main chat is blank when deleting expense offline #44214

Closed

6 tasks

aldo-expensify reviewed Jun 24, 2024

View reviewed changes

blazejkustra mentioned this pull request Jun 25, 2024

Fix repeated "[ExpensiMark] Missing account name" errors #44370

Closed

48 tasks

blazejkustra reviewed Jun 25, 2024

View reviewed changes

deetergp mentioned this pull request Jun 25, 2024

[ESM] Localize system messages #43079

Merged

49 tasks

ishpaul777 mentioned this pull request Jun 25, 2024

[HOLD for payment 2024-07-10] [BUG] Staging web fails to load, shows 'TypeError: Cannot use 'in' operator to search for 'whisperedTo' in []' error #44392

Closed

6 tasks

aldo-expensify mentioned this pull request Jun 26, 2024

Add useEffect to select default tax code #43519

Merged

50 tasks

blazejkustra mentioned this pull request Jun 26, 2024

[Payment due][$250] Centralize ExpensiMark usage with a dedicated Parser module #44451

Closed

ZhenjaHorbach reviewed Jul 10, 2024

View reviewed changes

ZhenjaHorbach mentioned this pull request Jul 10, 2024

[HOLD for payment 2024-07-10] [$250] Split - 1:1 DMs are not instantly created when splitting expense (compared to prod) #44216

Closed

6 tasks

NikkiWines mentioned this pull request Jul 25, 2024

Track expense-App crashes when submitting a track expense to someone #46181

Closed

6 tasks

eh2077 reviewed Jul 30, 2024

View reviewed changes

eh2077 mentioned this pull request Jul 30, 2024

[HOLD for payment 2024-07-24] Thread - LHN displays "removed 1 user" instead of "left the chat" after leaving thread #44610

Closed

6 tasks

DylanDylann reviewed Aug 29, 2024

View reviewed changes

DylanDylann mentioned this pull request Aug 29, 2024

fix: LHN preview for expense report shows 0.00 when there is only one scan expense #48139

Merged

50 tasks

srikarparsi mentioned this pull request Sep 17, 2024

Fix ReportUtils Lint #49325

Merged

50 tasks


		if (isEmptyObject(report) \|\| !report?.reportID) {
		if (isEmptyObject(report) \|\| !report?.reportID \|\| isEmptyObject(iouReportAction)) {

feature: Stop using reportAction.originalMessage or reportAction.messge #40168

feature: Stop using reportAction.originalMessage or reportAction.messge #40168

Conversation

nkdengineer commented Apr 12, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 15, 2024

cubuspl42 commented Apr 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nkdengineer commented Apr 16, 2024

cubuspl42 commented Apr 16, 2024

cubuspl42 commented Apr 17, 2024

nkdengineer commented Apr 17, 2024

cubuspl42 commented Apr 17, 2024

cubuspl42 commented Apr 17, 2024

cubuspl42 commented Apr 18, 2024

nkdengineer commented Apr 18, 2024

cubuspl42 commented Apr 23, 2024

cubuspl42 commented Apr 23, 2024

mallenexpensify commented Apr 24, 2024

nkdengineer commented Apr 25, 2024

c3024 commented Apr 30, 2024 • edited Loading

nkdengineer commented May 2, 2024

nkdengineer commented May 6, 2024 • edited Loading

c3024 commented May 7, 2024

OSBotify commented Jun 21, 2024

OSBotify commented Jun 21, 2024

c3024 commented Jun 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deetergp commented Jun 24, 2024

blazejkustra commented Jun 25, 2024 • edited Loading

c3024 commented Jun 25, 2024

Choose a reason for hiding this comment

OSBotify commented Jun 25, 2024

ZhenjaHorbach Jul 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nkdengineer commented Apr 12, 2024 •

edited

Loading

c3024 commented Apr 30, 2024 •

edited

Loading

nkdengineer commented May 6, 2024 •

edited

Loading

blazejkustra commented Jun 25, 2024 •

edited

Loading

ZhenjaHorbach Jul 10, 2024 •

edited

Loading