Align default IDs in ReportUtils file #54297

VickyStash · 2024-12-18T14:39:57Z

Explanation of Change

Fixed Issues

$ #50360
PROPOSAL: #50360 (comment)

Tests

Verify that no errors appear in the JS console

Test report-related functionality:

Open the app and log in.
Send several messages in workspace/1-1/ self DM chats
Send several messages from Users A and B and back.
Submit expenses: manual/scan/distance
React to the message/update it/delete

Offline tests

Same, as in the Tests section.

QA Steps

Verify that no errors appear in the JS console

Same, as in the Tests section.

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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
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

android1.mp4

Android: mWeb Chrome

android_web1.mp4

iOS: Native

iOS: mWeb Safari

ios_web1.mp4

MacOS: Chrome / Safari

web1.mp4

MacOS: Desktop

desktop1.mp4

…efault-id # Conflicts: # src/libs/ReportUtils.ts

…efault-id # Conflicts: # src/libs/PolicyUtils.ts

.eslintrc.changed.js

VickyStash · 2024-12-19T11:39:00Z

src/libs/ReportUtils.ts

-    const moneyRequestReportID = originalMessage?.IOUReportID ?? -1;
+    const moneyRequestReportID = originalMessage?.IOUReportID;

    if (!moneyRequestReportID) {


It looks like before moneyRequestReportID always was a truly value. So this condition never worked. Should I remove it maybe?

I think it's better to keep it.

…efault-id # Conflicts: # src/libs/ReportUtils.ts

…efault-id

…efault-id # Conflicts: # .eslintrc.changed.js

VickyStash · 2024-12-19T17:59:55Z

I have some issues with ios build, so I'll attach the recording tomorrow.
Upd: there are still some issues with ios build : #54413

melvin-bot · 2024-12-19T18:00:07Z

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

paultsimura

Overall – solid work 🔥
I'm sure we could break something but it's nearly impossible to test everything on such a change. Too bad we don't have robust unit tests yet 😞

src/libs/ReportUtils.ts

paultsimura · 2024-12-20T19:40:22Z

src/libs/ReportUtils.ts

-    const moneyRequestReportID = originalMessage?.IOUReportID ?? -1;
+    const moneyRequestReportID = originalMessage?.IOUReportID;

    if (!moneyRequestReportID) {


I think it's better to keep it.

paultsimura · 2024-12-20T19:47:43Z

src/libs/ReportUtils.ts

-        originalMessage: {
-            ...(originalMessage ?? {}),
-            whisperedTo: hasReceipt ? originalMessage?.whisperedTo : [],
-            linkedReportID: originalMessage?.linkedReportID ?? '0',
-        },
+        originalMessage: originalMessage
+            ? {
+                  ...originalMessage,
+                  whisperedTo: hasReceipt ? originalMessage.whisperedTo : [],
+                  linkedReportID: originalMessage.linkedReportID,
+              }
+            : undefined,


I'm not sure about this change 🤔
We used to always assign an object, and now it's undefined. Are you confident it's safe? Maybe let's at least fall back to {}?

Defaulting to {} causes TS errors.
I'm not sure if there was no originalMessage before, update function should create one...

src/libs/ReportUtils.ts

paultsimura · 2024-12-20T20:01:19Z

src/libs/ReportUtils.ts

One suggestion: there are multiple places where we do things like:

iouReportID ? reportsTransactions[iouReportID] ?? [] : []

WDYT about making a private function and reuse it?

function reportsTransactionsOrEmpty(reportID: string | undefined) { if (!reportID) { return []; } return reportsTransactions[reportID] ?? []; }

Applied: 964115d

…efault-id

VickyStash · 2024-12-24T12:51:43Z

@paultsimura I've applied your feedback. I'm going to be OOO 25-29 Dec 🎄 , maybe it would be good not to merge this PR during the time, so I can be around to monitor any regressions.

paultsimura · 2024-12-25T14:40:00Z

I'm going to be OOO 25-29 Dec 🎄

Got it, I'll hold on with approval. There seem to be conflicts anyway now.

…efault-id # Conflicts: # src/libs/ReportActionsUtils.ts # src/libs/ReportUtils.ts

VickyStash · 2024-12-30T09:54:58Z

@paultsimura Conflicts are resolved!

paultsimura · 2024-12-30T18:24:39Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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.webm

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-12-30.at.19.25.22.mov

MacOS: Desktop

paultsimura

Tested as thoroughly as I could. Hopefully, we won't break anything as the diff is large 😟
LGTM ✔️

paultsimura · 2024-12-30T18:54:08Z

@VickyStash should we remove src/libs/ReportUtils.ts from ignore right in this PR?

src/libs/ReportUtils.ts

neil-marcellini

Thanks for this. Mostly looks good. I left some NAB suggestions and I also have a few questions I would like answered before we merge it.

src/libs/ReportUtils.ts

neil-marcellini · 2024-12-31T20:41:43Z

src/pages/home/report/PureReportActionItem.tsx

+                    // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
+                    iouReportID={ReportActionsUtils.getIOUReportIDFromReportActionPreview(action) as string}


Instead can we have the component set iouReportID as an optional string?

Yes, and it should be done during PureReportActionItem updates. I didn't include it in this PR cause it's already complex enough and touches different functionality.
Updating PureReportActionItem + ReportPreview will require dealing with at least 40 more lint/ts cases, which should be then tested. So I think it would be safe to handle it separately.

.eslintrc.changed.js

neil-marcellini

Good to go, thank you

OSBotify · 2025-01-02T18:13:41Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2025-01-06T18:33:43Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.81-0 🚀

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

github-actions · 2025-01-08T02:44:34Z

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.81-6 🚀

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

VickyStash added 7 commits December 18, 2024 09:22

Minor update to trigger errors

ef08327

Remove default ids in ReportUtils file pt1

9fc5a78

Remove default ids in ReportUtils file pt2

9d201ac

Merge branch 'refs/heads/main' into VickyStash/refactor/ReportUtils-d…

25f8862

…efault-id # Conflicts: # src/libs/ReportUtils.ts

Remove default ids in ReportUtils file pt3

1d956b4

Remove default ids in PolicyUtils file

fe2e643

Remove default ids in ReportActionsUtils.ts file

1c2742d

VickyStash mentioned this pull request Dec 18, 2024

[HOLD for payment 2025-01-15] [HOLD for payment 2025-01-02] [HOLD for payment 2024-12-30] [$250] Undo defaults of -1 and "-1" for account/report/policy IDs #50360

Open

VickyStash added 3 commits December 19, 2024 11:31

Fix TS errors in OptionsListUtils

fd1d6c1

Minor update

a1027fb

Merge branch 'refs/heads/main' into VickyStash/refactor/ReportUtils-d…

6bb6081

…efault-id # Conflicts: # src/libs/PolicyUtils.ts

VickyStash commented Dec 19, 2024

View reviewed changes

.eslintrc.changed.js Outdated Show resolved Hide resolved

VickyStash commented Dec 19, 2024

View reviewed changes

VickyStash added 6 commits December 19, 2024 13:55

Ignore PureReportActionItem

42a1576

Merge branch 'refs/heads/main' into VickyStash/refactor/ReportUtils-d…

059eefc

…efault-id # Conflicts: # src/libs/ReportUtils.ts

Lint fixes

68cae12

Merge branch 'refs/heads/main' into VickyStash/refactor/ReportUtils-d…

33409ae

…efault-id

Bug fix

5a5a020

Merge branch 'refs/heads/main' into VickyStash/refactor/ReportUtils-d…

414f16c

…efault-id # Conflicts: # .eslintrc.changed.js

VickyStash changed the title ~~[WIP] align default IDs in ReportUtils file~~ Align default IDs in ReportUtils file Dec 19, 2024

VickyStash marked this pull request as ready for review December 19, 2024 18:00

VickyStash requested a review from a team as a code owner December 19, 2024 18:00

melvin-bot bot requested review from paultsimura and removed request for a team December 19, 2024 18:00

paultsimura reviewed Dec 20, 2024

View reviewed changes

VickyStash added 3 commits December 24, 2024 12:39

Merge branch 'refs/heads/main' into VickyStash/refactor/ReportUtils-d…

d99288e

…efault-id

Apply reviewer feedback pt1

93834a3

Add getReportTransactions function

964115d

Minor code clean up

ddcb3ef

Merge branch 'refs/heads/main' into VickyStash/refactor/ReportUtils-d…

43e79df

…efault-id # Conflicts: # src/libs/ReportActionsUtils.ts # src/libs/ReportUtils.ts

paultsimura approved these changes Dec 30, 2024

View reviewed changes

melvin-bot bot requested a review from neil-marcellini December 30, 2024 18:52

Remove ReportUtils.ts from ignored files

8f52497

paultsimura reviewed Dec 30, 2024

View reviewed changes

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

VickyStash added 2 commits December 30, 2024 21:22

Minor type update

3a7151d

Remove ReportActionsUtils file from ignored list as well

5869543

neil-marcellini requested changes Dec 31, 2024

View reviewed changes

Add warn logs

a7516f5

neil-marcellini approved these changes Jan 2, 2025

View reviewed changes

neil-marcellini merged commit 84e51e2 into Expensify:main Jan 2, 2025
19 checks passed

github-actions bot mentioned this pull request Jan 6, 2025

Deploy Checklist: New Expensify 2025-01-06 #54825

Closed

74 tasks

paultsimura mentioned this pull request Jan 10, 2025

Add toggle for enable/disable instead of label #54451

Merged

48 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Align default IDs in ReportUtils file #54297

Align default IDs in ReportUtils file #54297

VickyStash commented Dec 18, 2024 •

edited

Loading

VickyStash Dec 19, 2024

paultsimura Dec 20, 2024

VickyStash commented Dec 19, 2024 •

edited

Loading

melvin-bot bot commented Dec 19, 2024

paultsimura left a comment

paultsimura Dec 20, 2024

paultsimura Dec 20, 2024

VickyStash Dec 24, 2024

paultsimura Dec 20, 2024

VickyStash Dec 24, 2024

VickyStash commented Dec 24, 2024

paultsimura commented Dec 25, 2024

VickyStash commented Dec 30, 2024

paultsimura commented Dec 30, 2024 •

edited

Loading

paultsimura left a comment •

edited

Loading

paultsimura commented Dec 30, 2024 •

edited

Loading

neil-marcellini left a comment •

edited

Loading

neil-marcellini Dec 31, 2024

VickyStash Jan 2, 2025

neil-marcellini left a comment

OSBotify commented Jan 2, 2025

github-actions bot commented Jan 6, 2025

github-actions bot commented Jan 8, 2025

		// eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
		iouReportID={ReportActionsUtils.getIOUReportIDFromReportActionPreview(action) as string}

Align default IDs in ReportUtils file #54297

Align default IDs in ReportUtils file #54297

Conversation

VickyStash commented Dec 18, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

VickyStash commented Dec 19, 2024 • edited Loading

melvin-bot bot commented Dec 19, 2024

paultsimura left a 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

Choose a reason for hiding this comment

VickyStash commented Dec 24, 2024

paultsimura commented Dec 25, 2024

VickyStash commented Dec 30, 2024

paultsimura commented Dec 30, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

paultsimura left a comment • edited Loading

Choose a reason for hiding this comment

paultsimura commented Dec 30, 2024 • edited Loading

neil-marcellini left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neil-marcellini left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 2, 2025

github-actions bot commented Jan 6, 2025

github-actions bot commented Jan 8, 2025

VickyStash commented Dec 18, 2024 •

edited

Loading

VickyStash commented Dec 19, 2024 •

edited

Loading

paultsimura commented Dec 30, 2024 •

edited

Loading

paultsimura left a comment •

edited

Loading

paultsimura commented Dec 30, 2024 •

edited

Loading

neil-marcellini left a comment •

edited

Loading