Fix endless loading thread report header #42504

tsa321 · 2024-05-23T06:54:59Z

Details

Fixed Issues

$ #40928
PROPOSAL: #40928 (comment)

Tests

Open admins or announce room
Send a message containing only mentioned room name (for example #admins or #announce)
Select Reply in thread of that message
Wait for at least 5 seconds
Verify the thread report header looks like common thread header and is not changed into endless loading

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open admins or announce room
Send a message containing only mentioned room name (for example #admins or #announce)
Select Reply in thread of that message
Wait for at least 5 seconds
Verify the thread report header looks like common thread header and is not changed into endless loading

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-native-d.mp4

Android: mWeb Chrome

android-mweb_d.mp4

iOS: Native

ios-native_d.mp4

iOS: mWeb Safari

ios-msfari_d.mp4

MacOS: Chrome / Safari

macos-web-d.mp4

MacOS: Desktop

macos-desktop_d.mp4

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>

melvin-bot · 2024-05-23T06:55:04Z

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

tsa321 · 2024-05-23T06:59:30Z

src/libs/ReportUtils.ts

+    accountIds.forEach((id, index) => (accountIdToName[id] = logins[index]));
+
+    const parser = new ExpensiMark();
+    return parser.htmlToText(html, {reportIdToName});


I am using ExpensiMark.htmltoText instead of my original code.
But there is typecheck error for accountIdToName of extras in here. The field must be accountIdToName and not accountIDToName.
The typecheck will fails if I include accountIdToName in this line. This also need changes in ExpensiMark.

We need to include accountIdToName, don't we?

@luacmartins Yes, but there will be lint error if I used accountIdToName.
the field is defined as accountIDName in here.

But in the the javascript function it uses accountIdName with lower d in here.

Should I make changes in ExpensiMark ?

Yes, let's do it.

tsa321 · 2024-05-23T07:04:03Z

src/libs/ReportUtils.ts

+    const mentionReportRegex = /<mention-report reportID="(\d+)" *\/>/gi;
+    const matches = html.matchAll(mentionReportRegex);
+
+    const reportIdToName: Record<string, string> = {};
+    for (const match of matches) {
+        if (match[1] !== reportID) {
+            // eslint-disable-next-line @typescript-eslint/no-use-before-define
+            reportIdToName[match[1]] = getReportName(getReport(match[1])) ?? '';
+        }
+    }


Instead of searching for mentioned room name id before parsing, we could pass callback (id) => getReportName(getReport(id)) into extras. In here.

But this will need changes in ExpensiMark.js

tsa321 · 2024-05-23T07:06:45Z

@mollfpr PR is ready for review....

tsa321 · 2024-05-23T13:17:50Z

Also, since thread report will be displayed in LHN, the function parseHtmlToString will be used many times when rendering LHN. Even when sending a message, the LHN will be rendered. To optimize the performance we could cache the result into object with key reportActionID_lastModified. So, as long as report action isn't modified we will just return the value of that key.

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>

luacmartins

Looking good overall. Left a few comments though.

luacmartins · 2024-05-27T16:20:15Z

src/libs/ReportUtils.ts

+    const mentionReportRegex = /<mention-report reportID="(\d+)" *\/>/gi;
+    const matches = html.matchAll(mentionReportRegex);
+
+    const reportIdToName: Record<string, string> = {};


Suggested change

const reportIdToName: Record<string, string> = {};

const reportIDToName: Record<string, string> = {};

@luacmartins I am following the ExpensiMark field name in here.

If I use reportIDToName it doesn't work.

luacmartins · 2024-05-27T16:21:34Z

src/libs/ReportUtils.ts

+    }
+
+    const mentionUserRegex = /<mention-user accountID="(\d+)" *\/>/gi;
+    const accountIdToName: Record<string, string> = {};


Suggested change

const accountIdToName: Record<string, string> = {};

const accountIDToName: Record<string, string> = {};

and also with accountIdToName in here

luacmartins · 2024-05-27T16:21:43Z

src/libs/ReportUtils.ts

+
+    const mentionUserRegex = /<mention-user accountID="(\d+)" *\/>/gi;
+    const accountIdToName: Record<string, string> = {};
+    const accountIds = Array.from(html.matchAll(mentionUserRegex), (m) => Number(m[1]));


Suggested change

const accountIds = Array.from(html.matchAll(mentionUserRegex), (m) => Number(m[1]));

const accountIDs = Array.from(html.matchAll(mentionUserRegex), (mention) => Number(mention[1]));

luacmartins · 2024-05-27T16:26:41Z

src/libs/ReportUtils.ts

@@ -487,6 +487,7 @@ let currentUserEmail: string | undefined;
 let currentUserPrivateDomain: string | undefined;
 let currentUserAccountID: number | undefined;
 let isAnonymousUser = false;
+const reportActionMessageCache: Record<string, string> = {};


Let's leave a comment explaining why we need this cache map

luacmartins · 2024-05-27T16:27:20Z

src/libs/ReportUtils.ts

+    accountIds.forEach((id, index) => (accountIdToName[id] = logins[index]));
+
+    const parser = new ExpensiMark();
+    return parser.htmlToText(html, {reportIdToName});


We need to include accountIdToName, don't we?

luacmartins · 2024-05-27T16:27:43Z

Bump for review @mollfpr

mollfpr · 2024-05-27T16:45:17Z

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

Screenshots/Videos

Android: Native

42504.Android.mp4

Android: mWeb Chrome

42504.mWeb-Chrome.mp4

iOS: Native

42504.iOS.mov

iOS: mWeb Safari

42504.mWeb-Safari.mov

MacOS: Chrome / Safari

42504.Web.mp4

MacOS: Desktop

42504.Desktop.mp4

…function Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>

tsa321 · 2024-05-28T02:51:07Z

@mollfpr I have made a PR in expensify common: Expensify/expensify-common#708 to fix the typecheck error

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>

luacmartins

Waiting on the expensify-common PR to be merged so we can bump up the version here and test this again

luacmartins · 2024-05-28T16:53:17Z

@tsa321 I merged the expensify-common PR. Can you bump up the version on this one so we can continue with testing please?

tsa321 · 2024-05-29T01:53:08Z

@luacmartins @mollfpr the new release of Expensify-Common will be published to npm (I think by this Expensify/expensify-common#699 ). After that commit, the expensify-common lib folder won't be included in expensify-common folder inside node_modules. import ExpensiMark from 'expensify-common/lib/ExpensiMark'; will be modified into import {ExpensiMark} from 'expensify-common

and PR: #42387 will migrate all import usage of expensify-common.
I think we should wait for #42387

blazejkustra · 2024-05-29T13:02:23Z

After that commit, the expensify-common lib folder won't be included in expensify-common folder inside node_modules. import ExpensiMark from 'expensify-common/lib/ExpensiMark'; will be modified into import ExpensiMark from 'expensify-common/ExpensiMark

PR that upgrades expensify-common is ready. Just to clarify it won't be import ExpensiMark from 'expensify-common/ExpensiMark but instead:

import {ExpensiMark} from 'expensify-common';
//or
import ExpensiMark from 'expensify-common/dist/ExpensiMark';

luacmartins · 2024-05-30T14:10:51Z

@tsa321 can you update the PR to use the new expensify-common version?

tsa321 · 2024-05-30T14:18:24Z

@luacmartins I think we are holding on #42387
After it is merged, I will merge main.

luacmartins

Still holding on #42387

blazejkustra · 2024-06-05T18:01:51Z

@tsa321 @luacmartins #42387 was just merged 🚀

luacmartins · 2024-06-05T19:37:14Z

Nice! Let's continue work on this PR @tsa321

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>

tsa321 · 2024-06-05T23:45:14Z

@mollfpr Expensify-Common has been updated and I have merged main. PR is ready for review...

mollfpr

LGTM 👍

All yours @luacmartins

luacmartins

LGTM

OSBotify · 2024-06-06T17:09:16Z

✋ 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-11T23:32:22Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.81-11 🚀

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

tsa321 added 2 commits May 23, 2024 10:34

Fix endless loading spinner of thread header

b0f38df

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>

Fix typecheck, lint and minor changes

09ca09f

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>

tsa321 requested a review from a team as a code owner May 23, 2024 06:55

melvin-bot bot requested review from mollfpr and removed request for a team May 23, 2024 06:55

tsa321 commented May 23, 2024

View reviewed changes

isabelastisser mentioned this pull request May 23, 2024

[HOLD for payment 2024-06-20] [HOLD for payment 2024-06-18] [$250] Room - Endless Loading of Header When Navigating to Thread of Mentioned Room #40928

Closed

6 tasks

Add report action message cache

1153dca

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>

luacmartins self-requested a review May 27, 2024 14:48

luacmartins requested changes May 27, 2024

View reviewed changes

Change variable names, add comment and move cache check inside parse …

4bdd280

…function Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>

Fix type checks error

64c8e1f

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>

luacmartins self-requested a review May 28, 2024 13:42

luacmartins reviewed May 28, 2024

View reviewed changes

Merge branch 'main' into endless_loHeader

7760acf

blazejkustra mentioned this pull request May 29, 2024

[TS migration] Update expensify-common usage in NewDot #42387

Merged

49 tasks

luacmartins self-requested a review May 30, 2024 14:10

tsa321 changed the title ~~Fix endless loading thread report header~~ [HOLD] Fix endless loading thread report header May 30, 2024

luacmartins changed the title ~~[HOLD] Fix endless loading thread report header~~ [HOLD #42387] Fix endless loading thread report header Jun 3, 2024

luacmartins reviewed Jun 3, 2024

View reviewed changes

tsa321 added 2 commits June 6, 2024 06:14

Merge branch 'main' into endless_loHeader

a2e73aa

Fix prettier

969e400

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>

tsa321 changed the title ~~[HOLD #42387] Fix endless loading thread report header~~ Fix endless loading thread report header Jun 5, 2024

mollfpr approved these changes Jun 6, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins June 6, 2024 15:41

luacmartins approved these changes Jun 6, 2024

View reviewed changes

luacmartins merged commit 679a82e into Expensify:main Jun 6, 2024
17 checks passed

luacmartins mentioned this pull request Jun 6, 2024

[HOLD for payment 2024-06-21] [$250] mWeb - Chat - Quote markdown is not applied #43180

Closed

6 tasks

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

Deploy Checklist: New Expensify 2024-06-10 #43344

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix endless loading thread report header #42504

Fix endless loading thread report header #42504

tsa321 commented May 23, 2024

melvin-bot bot commented May 23, 2024

tsa321 May 23, 2024 •

edited

Loading

luacmartins May 27, 2024

tsa321 May 27, 2024

luacmartins May 27, 2024

tsa321 May 23, 2024

tsa321 commented May 23, 2024

tsa321 commented May 23, 2024

luacmartins left a comment

luacmartins May 27, 2024

tsa321 May 27, 2024 •

edited

Loading

luacmartins May 27, 2024

tsa321 May 27, 2024

luacmartins May 27, 2024

luacmartins May 27, 2024

luacmartins May 27, 2024

luacmartins commented May 27, 2024

mollfpr commented May 27, 2024 •

edited

Loading

tsa321 commented May 28, 2024 •

edited

Loading

luacmartins left a comment

luacmartins commented May 28, 2024

tsa321 commented May 29, 2024 •

edited

Loading

blazejkustra commented May 29, 2024

luacmartins commented May 30, 2024

tsa321 commented May 30, 2024

luacmartins left a comment

blazejkustra commented Jun 5, 2024

luacmartins commented Jun 5, 2024

tsa321 commented Jun 5, 2024 •

edited

Loading

mollfpr left a comment

luacmartins left a comment

OSBotify commented Jun 6, 2024

OSBotify commented Jun 11, 2024

	const reportIdToName: Record<string, string> = {};
	const reportIDToName: Record<string, string> = {};

	const accountIdToName: Record<string, string> = {};
	const accountIDToName: Record<string, string> = {};

	const accountIds = Array.from(html.matchAll(mentionUserRegex), (m) => Number(m[1]));
	const accountIDs = Array.from(html.matchAll(mentionUserRegex), (mention) => Number(mention[1]));

Fix endless loading thread report header #42504

Fix endless loading thread report header #42504

Conversation

tsa321 commented May 23, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 23, 2024

tsa321 May 23, 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

Choose a reason for hiding this comment

tsa321 commented May 23, 2024

tsa321 commented May 23, 2024

luacmartins left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tsa321 May 27, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luacmartins commented May 27, 2024

mollfpr commented May 27, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

tsa321 commented May 28, 2024 • edited Loading

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented May 28, 2024

tsa321 commented May 29, 2024 • edited Loading

blazejkustra commented May 29, 2024

luacmartins commented May 30, 2024

tsa321 commented May 30, 2024

luacmartins left a comment

Choose a reason for hiding this comment

blazejkustra commented Jun 5, 2024

luacmartins commented Jun 5, 2024

tsa321 commented Jun 5, 2024 • edited Loading

mollfpr left a comment

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 6, 2024

OSBotify commented Jun 11, 2024

tsa321 May 23, 2024 •

edited

Loading

tsa321 May 27, 2024 •

edited

Loading

mollfpr commented May 27, 2024 •

edited

Loading

tsa321 commented May 28, 2024 •

edited

Loading

tsa321 commented May 29, 2024 •

edited

Loading

tsa321 commented Jun 5, 2024 •

edited

Loading