[NoQA] Initial setup for LHN tests #52452

OlimpiaZurek · 2024-11-13T09:08:42Z

Explanation of Change

This PR adds the basic setup for LHN tests, with a few utility functions and some existing mocks that we can reuse. I noticed there were some broken and skipped LHN tests in the code. A few of these tests are still useful, so I’ve included them here, but most were outdated and not needed.

Fixed Issues

$ #52036
PROPOSAL:

Tests

N/A

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A
// 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 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

melvin-bot · 2024-11-13T09:24:51Z

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

ntdiary

I checked the tracking issue and found that this PR doesn't require C+ review, so just approve it to push it forward for internal review. :)
cc @mountiny

mountiny · 2024-11-13T12:40:01Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

mountiny

Looks good, but I think it would be great to standardize on the comments and make sure all the tests are clearly described, but make sure the comments explain why something is happening/ why we doing it and not what we are doing

tests/ui/LHNItemsPresence.tsx

mountiny

@OlimpiaZurek great, can you please just update with the empty lines?

mountiny · 2024-11-14T14:11:53Z

tests/ui/LHNItemsPresence.tsx

+            // When the SidebarLinks are rendered without a specified report ID.
+            LHNTestUtils.getDefaultRenderedSidebarLinks();
+            const report = createReport();
+            // And the Onyx state is initialized with a report.


NAB: for style guide and readability we should leave empty line above the comments

Suggested change

// And the Onyx state is initialized with a report.

// And the Onyx state is initialized with a report.

mountiny · 2024-11-14T14:12:45Z

tests/ui/LHNItemsPresence.tsx

+            });
+            // Then the report should not appear in the sidebar as it is not pinned.
+            expect(getOptionRows()).toHaveLength(0);
+


And here I think we do not need the space as there is no comment

Suggested change

mountiny

Much nicer, thanks!

OlimpiaZurek changed the title ~~Initial setup for LHN tests~~ [NOQA]Initial setup for LHN tests Nov 13, 2024

OlimpiaZurek marked this pull request as ready for review November 13, 2024 09:24

OlimpiaZurek requested a review from a team as a code owner November 13, 2024 09:24

melvin-bot bot requested review from ntdiary and removed request for a team November 13, 2024 09:24

ntdiary approved these changes Nov 13, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny November 13, 2024 09:46

mountiny assigned OlimpiaZurek Nov 13, 2024

mountiny requested changes Nov 13, 2024

View reviewed changes

tests/ui/LHNItemsPresence.tsx Show resolved Hide resolved

OlimpiaZurek added 2 commits November 14, 2024 12:04

Initial setup for LHN tests

5e9e0b2

add comments

114e455

OlimpiaZurek force-pushed the lhn-test-setup branch from 39d0036 to 114e455 Compare November 14, 2024 11:05

mountiny changed the title ~~[NOQA]Initial setup for LHN tests~~ [NoQA] Initial setup for LHN tests Nov 14, 2024

mountiny requested changes Nov 14, 2024

View reviewed changes

adjust spacing for comment readability

47e511f

mountiny approved these changes Nov 14, 2024

View reviewed changes

This was referenced Nov 14, 2024

Investigate workflow job failing on main: test / test (job 3) #52573

Closed

Investigate workflow job failing on main: confirmPassingBuild #52574

Closed

mountiny merged commit b7f466a into Expensify:main Nov 14, 2024
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] Initial setup for LHN tests #52452

[NoQA] Initial setup for LHN tests #52452

OlimpiaZurek commented Nov 13, 2024 •

edited by mountiny

Loading

melvin-bot bot commented Nov 13, 2024

ntdiary left a comment •

edited

Loading

mountiny commented Nov 13, 2024 •

edited

Loading

mountiny left a comment

mountiny left a comment

mountiny Nov 14, 2024

mountiny Nov 14, 2024

mountiny left a comment

	// And the Onyx state is initialized with a report.

	// And the Onyx state is initialized with a report.

[NoQA] Initial setup for LHN tests #52452

[NoQA] Initial setup for LHN tests #52452

Conversation

OlimpiaZurek commented Nov 13, 2024 • edited by mountiny Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 13, 2024

ntdiary left a comment • edited Loading

Choose a reason for hiding this comment

mountiny commented Nov 13, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

mountiny Nov 14, 2024

Choose a reason for hiding this comment

mountiny Nov 14, 2024

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OlimpiaZurek commented Nov 13, 2024 •

edited by mountiny

Loading

ntdiary left a comment •

edited

Loading

mountiny commented Nov 13, 2024 •

edited

Loading