Fix ReportUtils Lint #49325

srikarparsi · 2024-09-17T07:08:46Z

Details

Follow up from https://github.com/Expensify/App/pull/46934/files to fix lint errors (The PR did not cause them, just edited the same file)

Fixed Issues

$ #46934 (comment)
PROPOSAL:

Tests

Create a task
Reply in the task
Ensure that it renders correctly
Send an IOU to another user
Click inside the IOU
Ensure that it renders correctly

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

srikarparsi · 2024-09-17T07:35:13Z

@nkdengineer @thienlnam do you know if we migrated to start using reportAction.message instead of reportAction.originalMessage here? PR for context where we deprecated originalMessage

thienlnam · 2024-09-17T18:27:29Z

Yeah, the goal is to stop using originalMessage and just use message instead

merge main

srikarparsi · 2024-09-18T05:24:53Z

Hi @nkdengineer, do you know if there was a reason this instance of originalMessage was not changed in this PR? Do we still need it?

nkdengineer · 2024-09-18T05:31:39Z

Yeah, the goal is to stop using originalMessage and just use message instead

@srikarparsi Because BE change doesn't change this then we still keep the originalMessage data in optimistic data.

srikarparsi · 2024-09-18T05:55:38Z

Got it, I'm going to disable this lint error for now since it's setting originalMessage, not getting it and we still use it in the backend.

melvin-bot · 2024-09-18T05:56:10Z

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

srikarparsi · 2024-09-18T06:16:40Z

Hi @tgolen, I saw that you deprecated getParentReportAction in this PR so I just wanted to check if I'm going about this the right way. I also saw that we were using getReportAction in some places to get the parentReportAction but I felt like that has the same problem you described in this issue body?

c3024 · 2024-09-19T10:24:31Z

@srikarparsi

I wasn’t aware that a separate PR here is being worked on to remove getParentReportAction. 😃 I worked on the same thing along with another fix here because a check was failing.

I think it would be better to use a type predicate for isThread and a few other functions in ReportUtils to assert that the report is a thread. That way, we don’t need to repeatedly check for the parentReport and parentReportAction, as TypeScript will infer it correctly.

Please check if any of the changes in #49324 for lint fixes are useful for this PR.

I completed the changes as far as I felt are ideal in that PR and we might also consider reviewing that PR and merging it instead of this PR.

src/libs/ReportUtils.ts

srikarparsi · 2024-09-19T20:48:59Z

I think it would be better to use a type predicate for isThread and a few other functions in ReportUtils to assert that the report is a thread. That way, we don’t need to repeatedly check for the parentReport and parentReportAction, as TypeScript will infer it correctly.

Definitely agree with this thank you.

Please check if any of the changes in #49324 for lint fixes are useful for this PR.

I completed the changes as far as I felt are ideal in that PR and we might also consider reviewing that PR and merging it instead of this PR.

Yup! Taking a look. I do think it would be better to do it in this PR so we can identify regressions easier. If you want to put your PR on hold for this one, we probably should be able to get this merged today or tomorrow.

youssef-lr · 2024-09-19T21:35:23Z

src/libs/ReportUtils.ts

@@ -4248,6 +4260,7 @@ function buildOptimisticTaskCommentReportAction(

    // These parameters are not saved on the reportAction, but are used to display the task in the UI
    // Added when we fetch the reportActions on a report
+    // eslint-disable-next-line deprecation/deprecation


Hmm it doesn't seem like this rule exists in eslint, also it doesn't look like eslint is complaining about this line at all, but it's rather TS

Hm so it's actually interesting. Locally, it says that the error is deprecation/deprecation when I run npm run lint-changed

I'm going to switch it to eslint-disable-next-line for now to suppress the error? What do you think? The other thing we can do is what was done here with a spread operator but I'm not sure if it's worth it.

hungvu193 · 2024-09-19T23:54:42Z

Thanks for assigning. I'll start my testing shortly

hungvu193 · 2024-09-20T01:28:14Z

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

Uploading Screen Recording 2024-09-20 at 08.56.55.mov…

Android: mWeb Chrome

Screen.Recording.2024-09-20.at.09.07.10.mov

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-09-20.at.08.44.18.mov

MacOS: Desktop

hungvu193 · 2024-09-20T01:40:28Z

Found this during testing but it also happened on main.

Screen.Recording.2024-09-20.at.08.35.07.mov

melvin-bot · 2024-09-20T02:05:45Z

@tgolen Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

melvin-bot · 2024-09-20T02:05:48Z

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

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

OSBotify · 2024-09-20T03:17:29Z

✋ 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-09-24T19:29:53Z

🚀 Deployed to staging by https://github.com/robertjchen in version: 9.0.40-0 🚀

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

github-actions · 2024-09-27T17:44:48Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.40-6 🚀

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

fix lint

45ae762

srikarparsi self-assigned this Sep 17, 2024

srikarparsi added 3 commits September 17, 2024 03:14

more lint changes

bfaa8d6

remove uneeded

a98a93f

prettier

0f674a1

srikarparsi mentioned this pull request Sep 17, 2024

Update archive feature #46934

Merged

50 tasks

fix error

05d474a

Pujan92 mentioned this pull request Sep 17, 2024

[NO QA] Feat: Pending state with no feed #48489

Merged

58 tasks

srikarparsi added 3 commits September 18, 2024 01:16

use message instead of originalMessage

0757451

Merge branch 'main' into srikar-reportUtilsLint

ba9597a

merge main

revert

da96212

remove eslint for setting optimistic data

1b0cce9

srikarparsi marked this pull request as ready for review September 18, 2024 05:55

srikarparsi requested a review from a team as a code owner September 18, 2024 05:55

melvin-bot bot requested a review from youssef-lr September 18, 2024 05:56

melvin-bot bot removed the request for review from a team September 18, 2024 05:56

srikarparsi requested a review from thienlnam September 18, 2024 05:58

remove specific deprecation

5e94320

jayeshmangwani mentioned this pull request Sep 19, 2024

fix last accessed report for new user #49324

Merged

50 tasks

youssef-lr reviewed Sep 19, 2024

View reviewed changes

src/libs/ReportUtils.ts Show resolved Hide resolved

use isThread for checks

2c8485d

srikarparsi added 2 commits September 19, 2024 17:13

one more

bbdc076

null and specific error

3bf7935

youssef-lr reviewed Sep 19, 2024

View reviewed changes

dont specify error

d790940

hoangzinh mentioned this pull request Sep 19, 2024

Add support for inline code with space only characters #49038

Merged

50 tasks

srikarparsi requested a review from hungvu193 September 19, 2024 23:44

hungvu193 approved these changes Sep 20, 2024

View reviewed changes

melvin-bot bot requested a review from tgolen September 20, 2024 02:05

melvin-bot bot mentioned this pull request Sep 20, 2024

Payment issue for E/App PR#49325 #49508

Closed

robertjchen approved these changes Sep 20, 2024

View reviewed changes

robertjchen merged commit 7af7a3f into main Sep 20, 2024
17 of 19 checks passed

robertjchen deleted the srikar-reportUtilsLint branch September 20, 2024 03:05

github-actions bot mentioned this pull request Sep 24, 2024

Deploy Checklist: New Expensify 2024-09-24 #49662

Closed

67 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix ReportUtils Lint #49325

Fix ReportUtils Lint #49325

srikarparsi commented Sep 17, 2024 •

edited

Loading

srikarparsi commented Sep 17, 2024

thienlnam commented Sep 17, 2024

srikarparsi commented Sep 18, 2024 •

edited

Loading

nkdengineer commented Sep 18, 2024

srikarparsi commented Sep 18, 2024

melvin-bot bot commented Sep 18, 2024

srikarparsi commented Sep 18, 2024 •

edited

Loading

c3024 commented Sep 19, 2024

srikarparsi commented Sep 19, 2024

youssef-lr Sep 19, 2024

srikarparsi Sep 19, 2024

hungvu193 commented Sep 19, 2024

hungvu193 commented Sep 20, 2024 •

edited

Loading

hungvu193 commented Sep 20, 2024

melvin-bot bot commented Sep 20, 2024

melvin-bot bot commented Sep 20, 2024

OSBotify commented Sep 20, 2024

OSBotify commented Sep 24, 2024

github-actions bot commented Sep 27, 2024

Fix ReportUtils Lint #49325

Fix ReportUtils Lint #49325

Conversation

srikarparsi commented Sep 17, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

srikarparsi commented Sep 17, 2024

thienlnam commented Sep 17, 2024

srikarparsi commented Sep 18, 2024 • edited Loading

nkdengineer commented Sep 18, 2024

srikarparsi commented Sep 18, 2024

melvin-bot bot commented Sep 18, 2024

srikarparsi commented Sep 18, 2024 • edited Loading

c3024 commented Sep 19, 2024

srikarparsi commented Sep 19, 2024

youssef-lr Sep 19, 2024

Choose a reason for hiding this comment

srikarparsi Sep 19, 2024

Choose a reason for hiding this comment

hungvu193 commented Sep 19, 2024

hungvu193 commented Sep 20, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hungvu193 commented Sep 20, 2024

melvin-bot bot commented Sep 20, 2024

melvin-bot bot commented Sep 20, 2024

OSBotify commented Sep 20, 2024

OSBotify commented Sep 24, 2024

github-actions bot commented Sep 27, 2024

srikarparsi commented Sep 17, 2024 •

edited

Loading

srikarparsi commented Sep 18, 2024 •

edited

Loading

srikarparsi commented Sep 18, 2024 •

edited

Loading

hungvu193 commented Sep 20, 2024 •

edited

Loading