Align default IDs in Report.ts file by pac-guerreiro · Pull Request #54306 · Expensify/App

pac-guerreiro · 2024-12-18T16:06:44Z

Explanation of Change

Fixed Issues

$ #50360
PROPOSAL: #50360 (comment)

Tests

Write a comment on a report
1. Test if you’re able to edit the comment
2. Test if you’re able to mark the comment as unread
3. Test if you’re able to delete the comment
Open a report
1. Test if you’re shown the proper report
Join a thread in a report
1. Test if you’ve joined the thread properly
Create a thread in a report by clicking Reply in thread on any comment
1. Test if you’re shown the proper child report for the thread you just created
Create a private workspace room, then mention it in another room inside the same workspace
1. Test if the mention comment redirects to the proper room and no errors are shown
2. Test if you’re able to leave the room you just created
Track an expense, then edit it by pressing Edit expense from your personal report
1. Test if you’re redirected to the proper expense report page
Create a task while offline
1. Test if the task is displayed properly

Offline tests

Same as tests

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

Android.-.Native.mp4

Android: mWeb Chrome

Android.-.Chrome.mp4

iOS: Native

iOS.-.Native.mp4

iOS: mWeb Safari

iOS.-.Safari.mp4

MacOS: Chrome / Safari

MacOS.-.Chrome.mp4

MacOS: Desktop

MacOS.-.Desktop.mp4

melvin-bot · 2024-12-18T16:06:49Z

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

pac-guerreiro · 2024-12-18T16:08:23Z

cc @VickyStash

VickyStash

Left some comments, will take more thorough look tomorrow! 👀

VickyStash · 2024-12-18T16:15:04Z

+        // API expects a string, that's why policyID must default to a string
+        // eslint-disable-next-line rulesdir/no-default-id-values
+        parentReportID: currentTask.parentReportID ?? '',


API expects a string

Are you sure? How was it before TS migration? Is it be possible to call this API call without parentReportID or with invalid parentReportID?

@VickyStash I'm not sure what the API expects or how to test it, but currently we send '-1' in case currentTask.parentReportID is undefined

Answered here: #54306 (comment)

paultsimura · 2024-12-18T19:51:01Z

    WORKSPACE_INITIAL: {
        route: 'settings/workspaces/:policyID',
-        getRoute: (policyID: string, backTo?: string) => `${getUrlWithBackToParam(`settings/workspaces/${policyID}`, backTo)}` as const,
+        getRoute: (policyID = '', backTo?: string) => `${getUrlWithBackToParam(`settings/workspaces/${policyID}`, backTo)}` as const,


I think the initial idea of this ESlint change was to make sure the real values are passed where needed. And the missing data to be correctly handled where the function is being called.

For instance, we shouldn't change these getRoute functions, but throw something when we don't have the policyID when calling WORKSPACE_INITIAL.getRoute().

@iwiznia please correct me if I'm wrong. And what should we do when we don't have a policy ID but need to navigate to this page?

I don't think any of these routes should be used by passing an empty policyID

Yeah, I think it makes more sense to add the condition on level above to make sure WORKSPACE_INITIAL.getRoute(...) not called without policy id. Same for other cases here.
@pac-guerreiro let's try to do it so

@iwiznia @paultsimura @VickyStash

getRoute(...) is mostly used in Navigation.navigate(...) and I'm worried that if we prevent it from running we'll disrupt normal app flow

Can't we just do it like this ROUTES.REPORT_WITH_ID.getRoute(`${report.preexistingReportID}`)?

This way we still navigate the user to the new page but we pass undefined as string

Have you tried to navigate to the page with invalid id? What results do you get

@VickyStash if the id is invalid, the page will show a Not found page but it seems that all reports in Onyx are deleted

VickyStash · 2024-12-19T07:51:39Z

    } else {
        Navigation.navigateWithSwitchPolicyID({route: ROUTES.HOME});
-        Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(report?.reportID ?? '-1'), actionType);
+        Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(report?.reportID), actionType);


Make sure it's not called if there is no report?.reportID

@VickyStash

But if I prevent navigation from happening it will disrupt normal user flow 🤔 Shouldn't we warn the user that there was some problem, or something?

Let's try to test it as I mentioned here. What happens if you navigate user to the screen with -1 id

@VickyStash if the id is invalid, the page will show a Not found page but it seems that all reports in Onyx are deleted

VickyStash · 2024-12-19T07:56:07Z

+        // API expects a string, that's why parentReportID must default to a string
+        // eslint-disable-next-line rulesdir/no-default-id-values
+        parentReportID: currentTask.parentReportID ?? '',


Should it be possible to call this request without a valid parentReportID?

If yes - can we pass undefined instead of '' string?

If no - add a condition to prevent it

@VickyStash

I don't know that information, where can I get it?

Ideas:

try to call the API call with '', -1 and with undefined as parentReportID - check if it makes any difference

check if the defaulting value always was there

…on-report-actions # Conflicts: # src/libs/actions/Report.ts

…on-report-actions

pac-guerreiro · 2024-12-19T23:22:41Z

I applied most of the suggestions but left some questions 😄

VickyStash · 2024-12-20T08:11:33Z

@pac-guerreiro left suggestions to some of your questions!

…on-report-actions

pac-guerreiro · 2024-12-20T20:41:03Z

Today I resolved the remaining eslint issues 😄

@VickyStash I left some replies but I wasn't able to confirm what the API expects in some situations. I guess it should be face to pass undefined for those ids.

I'll be away until January 2nd but someone should take care of my work 😄 Happy holidays! 🎉

VickyStash · 2025-01-02T17:59:12Z

Hey @pac-guerreiro, welcome back 👋

@VickyStash I left some replies but I wasn't able to confirm what the API expects in some situations. I guess it should be face to pass undefined for those ids.

Have you tried what I suggested in this comment?

VickyStash · 2025-01-02T18:20:13Z

-                          workspaceCategoriesLink: `${environmentURL}/${ROUTES.WORKSPACE_CATEGORIES.getRoute(onboardingPolicyID ?? '-1')}`,
-                          workspaceMembersLink: `${environmentURL}/${ROUTES.WORKSPACE_MEMBERS.getRoute(onboardingPolicyID ?? '-1')}`,
-                          workspaceMoreFeaturesLink: `${environmentURL}/${ROUTES.WORKSPACE_MORE_FEATURES.getRoute(onboardingPolicyID ?? '-1')}`,
+                          adminsRoomLink: `${environmentURL}/${ROUTES.REPORT_WITH_ID.getRoute(`${adminsChatReportID}`)}`,


I guess from user perspective we will have the same result if we just pass adminsChatReportID

Suggested change

adminsRoomLink: `${environmentURL}/${ROUTES.REPORT_WITH_ID.getRoute(`${adminsChatReportID}`)}`,

adminsRoomLink: `${environmentURL}/${ROUTES.REPORT_WITH_ID.getRoute(adminsChatReportID)}`,

Could you try to navigate the route with -1 and undefined values, will it act the same?

@VickyStash You're right but if I didn't make this change, then eslint gets upset with me for passing an undefined value 😅

I think it can be resolved by just updating the type, right?

UPD: Similar case is discussed in another PR #54534 (comment)

…on-report-actions

fabioh8010

@pac-guerreiro Please don't forget to remove src/libs/actions/Report.ts from .eslintrc.changed.js

fabioh8010 · 2025-01-07T18:48:09Z

Also @pac-guerreiro please remove [No QA] label and add test steps / screenshots to this PR, we must make sure the changes are safe

…on-report-actions

VickyStash · 2025-01-15T08:10:30Z

Can you please resolve lint error related to import, it doesn't look complex, just 4 usages.

I told @pac-guerreiro to do it in a follow-up PR in order to avoid further delays here

VickyStash · 2025-01-15T08:13:25Z

+            if (!onboardingData) {
+                return;
+            }


Are you sure we should end openReport function execution if there is no onboardingData?

@VickyStash this was suggested by @fabioh8010. I think it makes sense to stop openReport execution if something is not right, but I guess we could add a Log.warn here.

Answered here.

VickyStash · 2025-01-15T08:20:40Z

+    if (!targetChatReportID) {
+        return null;
+    }


I'm not sure about this return.
Since it is located not in the top of the function, maybe we can add Log.warn so it's easy to catch it up?
Or maybe we can try to handle without it at all.
Wdyt? @fabioh8010

@VickyStash this was suggested by @fabioh8010. I agree with adding a Log.warn here 😄

Yeah this case is hard because there is no way to make targetChatReportID be always defined as it comes from an Onyx value extracted from a collection, which is not guaranteed to be defined. In this case looks like making targetChatReportID be assigned a default value could be the only option, but it defeats our very purpose here, so I suggested to stop function's execution (making it return undefined or null), and the places where it's called will have to handle it by either doing some other logic or stop their execution too.

Also @pac-guerreiro I'm assuming you tested extensively these parts to make sure this change works as expect, right?

Co-authored-by: Viktoryia Kliushun <vikstash@gmail.com>

fabioh8010 · 2025-01-15T18:00:46Z

+    if (!targetChatReportID) {
+        return null;
+    }


Yeah this case is hard because there is no way to make targetChatReportID be always defined as it comes from an Onyx value extracted from a collection, which is not guaranteed to be defined. In this case looks like making targetChatReportID be assigned a default value could be the only option, but it defeats our very purpose here, so I suggested to stop function's execution (making it return undefined or null), and the places where it's called will have to handle it by either doing some other logic or stop their execution too.

…on-report-actions # Conflicts: # .eslintrc.changed.js # src/ROUTES.ts

pac-guerreiro · 2025-01-16T22:51:54Z

Today I resolved conflicts and applied @fabioh8010 and @VickyStash suggestions 😄

pac-guerreiro · 2025-01-17T10:42:53Z

@iwiznia @paultsimura the PR is ready for your final review 😄

paultsimura · 2025-01-17T11:09:58Z

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

chrome.webm

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2025-01-17.at.11.49.09.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2025-01-17.at.11.50.01.mp4

MacOS: Chrome / Safari

Screen.Recording.2025-01-17.at.11.46.27.mov

MacOS: Desktop

Screen.Recording.2025-01-17.at.11.47.37.mov

paultsimura

LGTM ✔️

Note: the lint issue will be fixed in a follow-up PR.

neil-marcellini

Looks pretty solid. A couple small requests.

…on-report-actions

pac-guerreiro · 2025-01-20T21:10:45Z

@neil-marcellini I just applied the changes you requested, thank you 😄

neil-marcellini

Good to go, thank you

melvin-bot · 2025-01-21T18:42:12Z

@neil-marcellini looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

neil-marcellini · 2025-01-21T18:42:24Z

Not an emergency. Lint will be fixed in a following PR.

OSBotify · 2025-01-21T18:50:51Z

✋ 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-23T18:27:07Z

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

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

mvtglobally · 2025-01-24T01:22:29Z

#55676 found when running this PR

paultsimura · 2025-01-24T07:32:11Z

#55676 found when running this PR

A note for the BZ team:
This PR is still on staging while the issue is in prod. Therefore, it is not a root cause.

github-actions · 2025-01-28T01:50:33Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.89-8 🚀

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

fix: undo default values to comply with eslint rules

0612e06

pac-guerreiro requested a review from a team as a code owner December 18, 2024 16:06

melvin-bot Bot requested a review from paultsimura December 18, 2024 16:06

melvin-bot Bot removed the request for review from a team December 18, 2024 16:06

doc: fix typo in comment

f927a37

VickyStash reviewed Dec 18, 2024

View reviewed changes

paultsimura reviewed Dec 18, 2024

View reviewed changes

VickyStash reviewed Dec 19, 2024

View reviewed changes

VickyStash mentioned this pull request Dec 19, 2024

Fix cycle dependencies in metro console #53852

Merged

50 tasks

pac-guerreiro changed the title ~~fix: undo default values to comply with eslint rules~~ [No QA] Remove default values for IDs to comply with eslint rules Dec 19, 2024

pac-guerreiro added 3 commits December 19, 2024 20:54

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

8d1cf91

…on-report-actions # Conflicts: # src/libs/actions/Report.ts

chore: apply suggestions and follow guidelines

7f97310

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

430a195

…on-report-actions

pac-guerreiro added 2 commits December 20, 2024 18:30

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

2e07d76

…on-report-actions

chore: resolve eslint issues

4be070e

VickyStash reviewed Jan 2, 2025

View reviewed changes

pac-guerreiro added 2 commits January 2, 2025 23:13

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

34de8a5

…on-report-actions

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

8d6f43c

…on-report-actions

fabioh8010 reviewed Jan 7, 2025

View reviewed changes

pac-guerreiro added 2 commits January 7, 2025 23:58

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

b589b0f

…on-report-actions

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

b7e916d

…on-report-actions

VickyStash mentioned this pull request Jan 8, 2025

Align default IDs in Task.ts file #54960

Merged

50 tasks

VickyStash reviewed Jan 15, 2025

View reviewed changes

refactor: apply suggestions

805a33b

Co-authored-by: Viktoryia Kliushun <vikstash@gmail.com>

fabioh8010 reviewed Jan 15, 2025

View reviewed changes

pac-guerreiro added 2 commits January 16, 2025 22:48

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

026a422

…on-report-actions # Conflicts: # .eslintrc.changed.js # src/ROUTES.ts

refactor: apply suggestions

b47b57c

VickyStash approved these changes Jan 17, 2025

View reviewed changes

fabioh8010 approved these changes Jan 17, 2025

View reviewed changes

paultsimura approved these changes Jan 17, 2025

View reviewed changes

melvin-bot Bot requested a review from neil-marcellini January 17, 2025 11:10

neil-marcellini requested changes Jan 17, 2025

View reviewed changes

Comment thread src/libs/actions/Report.ts Outdated

Comment thread src/libs/actions/Report.ts Outdated

Comment thread src/libs/API/parameters/AddCommentOrAttachementParams.ts Outdated

pac-guerreiro added 2 commits January 20, 2025 21:03

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

9e3b8b7

…on-report-actions

refactor: apply suggestions

20c7866

pac-guerreiro requested a review from neil-marcellini January 20, 2025 21:10

neil-marcellini approved these changes Jan 21, 2025

View reviewed changes

neil-marcellini merged commit 9b31270 into Expensify:main Jan 21, 2025

melvin-bot Bot added the Emergency label Jan 21, 2025

neil-marcellini removed the Emergency label Jan 21, 2025

pac-guerreiro mentioned this pull request Jan 21, 2025

[No QA] 50360 - Follow up to fix eslint errors #55566

Merged

48 tasks

github-actions Bot mentioned this pull request Jan 23, 2025

Deploy Checklist: New Expensify 2025-01-23 #55657

Closed

	adminsRoomLink: `${environmentURL}/${ROUTES.REPORT_WITH_ID.getRoute(`${adminsChatReportID}`)}`,
	adminsRoomLink: `${environmentURL}/${ROUTES.REPORT_WITH_ID.getRoute(adminsChatReportID)}`,

Conversation

pac-guerreiro commented Dec 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Dec 18, 2024

Uh oh!

pac-guerreiro commented Dec 18, 2024

Uh oh!

VickyStash left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

VickyStash Dec 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pac-guerreiro commented Dec 19, 2024

Uh oh!

VickyStash commented Dec 20, 2024

Uh oh!

pac-guerreiro commented Dec 20, 2024

Uh oh!

VickyStash commented Jan 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabioh8010 left a comment

pac-guerreiro commented Dec 18, 2024 •

edited

Loading

VickyStash Dec 20, 2024 •

edited

Loading