[No QA] Add unit test for report should not be displayed in LHN #53745

mkzie2 · 2024-12-09T06:56:13Z

Explanation of Change

Fixed Issues

$ #52034
PROPOSAL: #52034 (comment)

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

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

melvin-bot · 2024-12-09T08:29:23Z

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

c3024 · 2024-12-10T06:14:56Z

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

c3024

LGTM!

mountiny

Couple comments, @mkzie2 can you please make sure to always use the WHEN, AND, THEN words in the comments in the tests?

mountiny · 2024-12-10T11:21:29Z

tests/ui/LHNItemsPresence.tsx

+        it('should not display the report marked as hidden', async () => {
+            // When the SidebarLinks are rendered.
+            LHNTestUtils.getDefaultRenderedSidebarLinks();
+            const report: Report = {
+                ...createReport(),
+                participants: {
+                    [TEST_USER_ACCOUNT_ID]: {
+                        notificationPreference: CONST.REPORT.NOTIFICATION_PREFERENCE.HIDDEN,
+                    },
+                },
+            };
+
+            // And a report marked as hidden is initialized in Onyx
+            await initializeState({
+                [`${ONYXKEYS.COLLECTION.REPORT}${report.reportID}`]: report,
+            });
+
+            // Then hidden report should not appear in the sidebar.
+            expect(getOptionRows()).toHaveLength(0);
+        });


We are actually doind some changes to this flow, can you also add a test (if not present) to make sure the report that has empty notification preference is also not rendered?

Added a case for empty notification.

tests/ui/LHNItemsPresence.tsx

Co-authored-by: Vit Horacek <[email protected]>

mountiny

@mkzie2 Lets make sure all the comments follow the standard as this will be example for other tests

tests/ui/LHNItemsPresence.tsx

Co-authored-by: Vit Horacek <[email protected]>

mkzie2 · 2024-12-12T08:22:55Z

@mkzie2 Lets make sure all the comments follow the standard as this will be example for other tests

Sure, noted.

mkzie2 · 2024-12-12T08:25:55Z

@mountiny I updated the comment format.

mountiny

I think you still need to start with the Given word which will set the conditions and then when

tests/ui/LHNItemsPresence.tsx

mkzie2 · 2024-12-16T08:19:43Z

@mountiny Added the Given word.

mountiny

@mkzie2 you have not added the Given expression to the test comments

tests/ui/LHNItemsPresence.tsx

mkzie2 · 2024-12-18T05:44:07Z

@mkzie2 you have not added the Given expression to the test comments

I misunderstood what you meant 😅

mkzie2 · 2024-12-18T06:38:21Z

@mountiny I updated.

mountiny

One small thing @mkzie2

tests/unit/ReportUtilsTest.ts

Co-authored-by: Vit Horacek <[email protected]>

mkzie2 · 2024-12-23T15:23:02Z

@mountiny I updated.

mkzie2 added 8 commits December 9, 2024 13:54

add shouldReportBeInOptionList test

219090e

add ui test for hidden report

e6002f5

add ui test for the default room

18596e8

fix default room ui test

303544c

add ui test for single transaction thread

4450fb7

add ui test for the report with parent message pending removal

76ff4a2

add ui test for read report in the focus mode

0dc095e

fix read report ui test

8087720

mkzie2 force-pushed the mkzie2-issue/52034 branch from d7508d9 to 8087720 Compare December 9, 2024 08:23

mkzie2 marked this pull request as ready for review December 9, 2024 08:29

mkzie2 requested a review from a team as a code owner December 9, 2024 08:29

melvin-bot bot requested review from c3024 and removed request for a team December 9, 2024 08:29

mkzie2 mentioned this pull request Dec 9, 2024

[$250] Implement tests for reports that should not be displayed in LHN #52034

Open

OlimpiaZurek approved these changes Dec 9, 2024

View reviewed changes

merge main

2a52f32

c3024 approved these changes Dec 10, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny December 10, 2024 06:15

mountiny assigned mkzie2 Dec 10, 2024

mountiny requested changes Dec 10, 2024

View reviewed changes

mkzie2 and others added 8 commits December 11, 2024 15:38

Merge branch 'main' into mkzie2-issue/52034

4dbb367

Update tests/ui/LHNItemsPresence.tsx

75ef6bf

Co-authored-by: Vit Horacek <[email protected]>

Update tests/ui/LHNItemsPresence.tsx

42603f6

Co-authored-by: Vit Horacek <[email protected]>

Update tests/ui/LHNItemsPresence.tsx

9f755df

Co-authored-by: Vit Horacek <[email protected]>

Update tests/ui/LHNItemsPresence.tsx

bb354fb

Co-authored-by: Vit Horacek <[email protected]>

Update tests/ui/LHNItemsPresence.tsx

44423fe

Co-authored-by: Vit Horacek <[email protected]>

Update tests/ui/LHNItemsPresence.tsx

6bfd501

Co-authored-by: Vit Horacek <[email protected]>

Update tests/ui/LHNItemsPresence.tsx

0f5a9ad

Co-authored-by: Vit Horacek <[email protected]>

fix read report test

5446ec9

mkzie2 force-pushed the mkzie2-issue/52034 branch from 0c0603d to 5446ec9 Compare December 11, 2024 09:09

mountiny requested changes Dec 11, 2024

View reviewed changes

tests/ui/LHNItemsPresence.tsx Outdated Show resolved Hide resolved

Update tests/ui/LHNItemsPresence.tsx

8bbf6fe

Co-authored-by: Vit Horacek <[email protected]>

mkzie2 added 2 commits December 12, 2024 15:23

Merge branch 'main' into mkzie2-issue/52034

6655108

update comment with when-and-then format

eb1095d

mkzie2 requested a review from a team as a code owner December 12, 2024 08:43

mkzie2 force-pushed the mkzie2-issue/52034 branch from 9028f61 to eb1095d Compare December 12, 2024 08:44

mountiny requested changes Dec 13, 2024

View reviewed changes

tests/ui/LHNItemsPresence.tsx Outdated Show resolved Hide resolved

mkzie2 added 2 commits December 16, 2024 15:17

Merge branch 'main' into mkzie2-issue/52034

c9dccbd

add given word

e792e87

mountiny requested changes Dec 18, 2024

View reviewed changes

tests/ui/LHNItemsPresence.tsx Outdated Show resolved Hide resolved

tests/ui/LHNItemsPresence.tsx Outdated Show resolved Hide resolved

Merge branch 'main' into mkzie2-issue/52034

407c7a4

mkzie2 added 2 commits December 18, 2024 12:51

add given word

02d8152

fix lint

71d9b23

mountiny previously approved these changes Dec 23, 2024

View reviewed changes

tests/unit/ReportUtilsTest.ts Outdated Show resolved Hide resolved

mkzie2 and others added 2 commits December 23, 2024 22:21

Merge branch 'main' into mkzie2-issue/52034

b3302fc

Update tests/unit/ReportUtilsTest.ts

ad960d3

Co-authored-by: Vit Horacek <[email protected]>

mkzie2 dismissed mountiny’s stale review via ad960d3 December 23, 2024 15:22

Merge branch 'main' into mkzie2-issue/52034

d6abec5

mkzie2 requested a review from mountiny December 26, 2024 08:07

mountiny approved these changes Dec 26, 2024

View reviewed changes

mountiny merged commit e94df0f into Expensify:main Dec 26, 2024
15 checks passed

mountiny mentioned this pull request Dec 26, 2024

Comprehensive unit tests and docs for LHN item presence #52031

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Add unit test for report should not be displayed in LHN #53745

[No QA] Add unit test for report should not be displayed in LHN #53745

mkzie2 commented Dec 9, 2024 •

edited

Loading

melvin-bot bot commented Dec 9, 2024

c3024 commented Dec 10, 2024 •

edited

Loading

c3024 left a comment

mountiny left a comment

mountiny Dec 10, 2024

mkzie2 Dec 11, 2024

mountiny left a comment

mkzie2 commented Dec 12, 2024

mkzie2 commented Dec 12, 2024

mountiny left a comment

mkzie2 commented Dec 16, 2024

mountiny left a comment

mkzie2 commented Dec 18, 2024

mkzie2 commented Dec 18, 2024

mountiny left a comment

mkzie2 commented Dec 23, 2024

[No QA] Add unit test for report should not be displayed in LHN #53745

[No QA] Add unit test for report should not be displayed in LHN #53745

Conversation

mkzie2 commented Dec 9, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 9, 2024

c3024 commented Dec 10, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

c3024 left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

mountiny Dec 10, 2024

Choose a reason for hiding this comment

mkzie2 Dec 11, 2024

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

mkzie2 commented Dec 12, 2024

mkzie2 commented Dec 12, 2024

mountiny left a comment

Choose a reason for hiding this comment

mkzie2 commented Dec 16, 2024

mountiny left a comment

Choose a reason for hiding this comment

mkzie2 commented Dec 18, 2024

mkzie2 commented Dec 18, 2024

mountiny left a comment

Choose a reason for hiding this comment

mkzie2 commented Dec 23, 2024

mkzie2 commented Dec 9, 2024 •

edited

Loading

c3024 commented Dec 10, 2024 •

edited

Loading