Skip to content

[No QA] Remove a call to getReportNameValuePairs from shouldShowFlagComment()#65204

Merged
blimpich merged 26 commits into
mainfrom
tgolen-remove-rnvps-16
Jul 4, 2025
Merged

[No QA] Remove a call to getReportNameValuePairs from shouldShowFlagComment()#65204
blimpich merged 26 commits into
mainfrom
tgolen-remove-rnvps-16

Conversation

@tgolen

@tgolen tgolen commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

Explanation of Change

This PR makes shouldShowFlagComment() a pure function.
It also adds unit tests for all the different logic cases.

Fixed Issues

Part of #59961

Tests

None. It's all covered by unit tests on existing functionality so functional testing isn't necessary.

  • Verify that no errors appear in the JS console

Offline tests

None

QA Steps

None

  • 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@tgolen tgolen requested a review from DylanDylann June 30, 2025 19:38
@tgolen tgolen self-assigned this Jun 30, 2025
@tgolen tgolen requested a review from a team as a code owner June 30, 2025 19:38
@melvin-bot melvin-bot Bot requested review from cristipaval and removed request for a team June 30, 2025 19:38
@melvin-bot

melvin-bot Bot commented Jun 30, 2025

Copy link
Copy Markdown

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

@tgolen

tgolen commented Jun 30, 2025

Copy link
Copy Markdown
Contributor Author

@DylanDylann Can you please give a C+ review on this?

Comment thread tests/utils/collections/transaction.ts Outdated
tag: randWord(),
parentTransactionID: index.toString(),
status: rand(Object.values(CONST.TRANSACTION.STATUS)),
status: rand(Object.values(CONST.TRANSACTION.STATUS)) as Transaction['status'],

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was getting some type errors, and this seemed to fix it. If you'd like me to undo it and come up with a better plan, please let me know.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it happens to you because some your local setup. I don't see type errors in these places and our GitHub action also doesn't alert to any error. So I think we should revert these changes

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, thanks for checking. I'll revert them.

Comment thread tests/unit/ReportUtilsTest.ts Outdated
await Onyx.set(`${ONYXKEYS.COLLECTION.REPORT}${chatReport.reportID}`, null);
});

it('should return false for an archived chatreport', () => {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
it('should return false for an archived chatreport', () => {
it('should return false for an archived chat report', () => {

Comment thread tests/unit/ReportUtilsTest.ts Outdated
actorAccountID: 123456,
};

describe('can flag report action', () => {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should add unit tests for canFlagReportAction function and hard-code value of this function here

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good idea. I'll work on that today.

@tgolen tgolen Jul 1, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and hard-code value of this function here

Actually, I'm not 100% sure what you mean by this. What would get hard-coded? I think shouldShowFlagComment() would still need two cases:

  1. A report action that can be flagged
  2. A report action that cannot be flagged

Since canFlagReportAction() is only called inside of shouldShowFlagComment(), there wouldn't be anything to hard code in the tests.

@DylanDylann DylanDylann Jul 1, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tgolen canFlagReportAction() is called in three places so If possible, I think we should test this function independently

Screenshot 2025-07-01 at 21 12 18

Comment thread tests/unit/ReportUtilsTest.ts Outdated
Comment on lines +3818 to +3819
// It will be true here because the report action can be flagged since it was a whisper from someone that is not Concierge
// It doesn't matter if the expense report is archived or not

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These comments are unnecessary

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heh, I was having a hard time wrapping my head around all the negated logic, so I found them helpful, but I'll remove them if they aren't helpful.

Comment on lines +3914 to +3924
it('should return false for an archived chat report', () => {
// It will be false here because it's a chat report with Chronos and therefore
// it doesn't matter if the report is archived or not, it will always be false.
expect(shouldShowFlagComment(validReportAction, chatReport, false)).toBe(false);
});

it('should return false for a non-archived chat report', () => {
// It will be false here because it's a chat report with Chronos and therefore
// it doesn't matter if the report is archived or not, it will always be false.
expect(shouldShowFlagComment(validReportAction, chatReport, false)).toBe(false);
});

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

duplicated

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, that first one should pass true for the third parameter.

Comment on lines +3945 to +3955
it('should return false for an archived chat report', () => {
// It will be false here because it's a chat report with Concierge and therefore
// it doesn't matter if the report is archived or not, it will always be false.
expect(shouldShowFlagComment(validReportAction, chatReport, false)).toBe(false);
});

it('should return false for a non-archived chat report', () => {
// It will be false here because it's a chat report with Concierge and therefore
// it doesn't matter if the report is archived or not, it will always be false.
expect(shouldShowFlagComment(validReportAction, chatReport, false)).toBe(false);
});

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

duplicated

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, the first one should pass true for the third parameter.

Comment thread tests/unit/ReportUtilsTest.ts Outdated
});
});

describe('chat reports', () => {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already had UTs for isArchivedNonExpenseReport function so I don't think we need to have this case here

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, that's a good point.

Comment thread tests/unit/ReportUtilsTest.ts Outdated
});
});

describe('expense reports', () => {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already had UTs for isArchivedNonExpenseReport function so I don't think we need to have this case here

@DylanDylann

DylanDylann commented Jul 1, 2025

Copy link
Copy Markdown
Contributor

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@tgolen

tgolen commented Jul 1, 2025

Copy link
Copy Markdown
Contributor Author

I haven't had time to work on this today, but I am hoping to get to it tomorrow to add full coverage unit tests to canFlagReportAction()

@tgolen tgolen requested a review from DylanDylann July 2, 2025 21:45
@tgolen

tgolen commented Jul 2, 2025

Copy link
Copy Markdown
Contributor Author

I was able to update this PR with complete unit test coverage for canFlagReportAction() and also isWhisperAction()

@DylanDylann DylanDylann left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I don't understand why the check spell action failed. @tgolen Could you merge main again or trigger this action again?

@melvin-bot melvin-bot Bot requested a review from blimpich July 3, 2025 07:52
@melvin-bot

melvin-bot Bot commented Jul 3, 2025

Copy link
Copy Markdown

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

melvin-bot Bot commented Jul 3, 2025

Copy link
Copy Markdown

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

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

@tgolen

tgolen commented Jul 3, 2025 via email

Copy link
Copy Markdown
Contributor Author

@blimpich

blimpich commented Jul 3, 2025

Copy link
Copy Markdown
Contributor

Looks good but lots of failing jest / lint checks. Are those unrelated?

@tgolen

tgolen commented Jul 4, 2025

Copy link
Copy Markdown
Contributor Author

Hm, not sure. I'll dig into those today.

});

it('cannot be flagged if the report does not exist', () => {
expect(canFlagReportAction(nonWhisperReportAction, 'starwarsisthebest')).toBe(false);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
expect(canFlagReportAction(nonWhisperReportAction, 'starwarsisthebest')).toBe(false);
expect(canFlagReportAction(nonWhisperReportAction, '1234')).toBe(false);

@tgolen

tgolen commented Jul 4, 2025

Copy link
Copy Markdown
Contributor Author

OK, this should be all good now. Tests are all passing.

@blimpich blimpich merged commit 2fd0d07 into main Jul 4, 2025
18 checks passed
@blimpich blimpich deleted the tgolen-remove-rnvps-16 branch July 4, 2025 21:05
@OSBotify

OSBotify commented Jul 4, 2025

Copy link
Copy Markdown
Contributor

✋ 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

github-actions Bot commented Jul 7, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/blimpich in version: 9.1.77-1 🚀

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

@github-actions

github-actions Bot commented Jul 8, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.77-2 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants