Skip to content

[Desktop Navigation] Add a dedicated Workspace filter to the Reports tab#59450

Merged
mountiny merged 10 commits intoExpensify:mainfrom
software-mansion-labs:improve-desktop-nav/1-add-workspace-filter
Apr 8, 2025
Merged

[Desktop Navigation] Add a dedicated Workspace filter to the Reports tab#59450
mountiny merged 10 commits intoExpensify:mainfrom
software-mansion-labs:improve-desktop-nav/1-add-workspace-filter

Conversation

@WojtekBoman
Copy link
Copy Markdown
Contributor

@WojtekBoman WojtekBoman commented Apr 1, 2025

Explanation of Change

This PR adds a new Workspace filter to the Reports tab. To display the new screen it's necessary to have access to the leftHandBar beta.

Fixed Issues

$ #59366
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Precondition: You are logged in to an account with access to the leftHandBar beta

  1. Open the Reports tab
  2. Open the filters page
  3. Select Workspace from the filters list
  4. Select any workspace
  5. Select View results
  6. Verify if the results are filtered correctly

Offline tests

QA Steps

Same as tests

  • 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
Screen.Recording.2025-04-08.at.13.10.46.mov
Android: mWeb Chrome
Screen.Recording.2025-04-08.at.13.12.44.mov
iOS: Native
Screen.Recording.2025-04-08.at.13.28.47.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2025-04-08.at.13.03.52.mov
MacOS: Desktop
Screen.Recording.2025-04-08.at.13.08.05.mov

Copy link
Copy Markdown
Contributor

@Kicu Kicu left a comment

Choose a reason for hiding this comment

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

LGTM 👍 , left you a few comments.

I did not run the code, just went through this to see if its readable and what I would expect

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.

this is temporary right? eventually we need to fallback to something so that we display it for user. Something like "unknown" or simply policyID?

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.

related to above ☝️ if by any chance

policies[`${ONYXKEYS.COLLECTION.POLICY}${workspaceFilter}`]

is undefined, then we have no name and we display nothing

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.

withPermissionCheck sounds super generic and its not easy to know what permission we check.

Change the name to something related to what we are actually implementing. Example: typeFiltersKeysWith[Optional|Possible]Policy etc

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.

can we instead do something like:

const [firstArray, ...rest] = arrays;
return [key, [firstArray, policy, rest]

? also it reads quit bad with the generic name firstArray. Maybe we can call it for what it is - like filtersConfig, filtersConfig element(s)?

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 renamed it to firstFiltersSection to indicate what it is related to

@WojtekBoman WojtekBoman force-pushed the improve-desktop-nav/1-add-workspace-filter branch from 3c4d950 to 24ab5b1 Compare April 7, 2025 13:40
@WojtekBoman
Copy link
Copy Markdown
Contributor Author

@Expensify/design @flaviadefaria @mountiny

Hey, it should be ready for testing, feel free to generate new builds and check if the new workspace filter works fine :) Tomorrow I'll put final touches on this PR and release it for review

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 7, 2025

🚧 @dannymcclain has triggered a test app build. You can view the workflow run here.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 7, 2025

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
Android 🤖🔄 iOS 🍎🔄
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/59450-hybrid/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/59450-hybrid/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/59450/NewExpensify.dmg https://59450.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@dannymcclain
Copy link
Copy Markdown
Contributor

Looking and working as expected to me!

When I select a workspace in the filter, it changes the header—I assume that's expected for now, right?
CleanShot 2025-04-07 at 09 55 39@2x
CleanShot 2025-04-07 at 09 55 18@2x

Unrelated to this PR, I will note that personally I'd love to see a workspace column for the expenses. Because we're just showing From and To (which are individuals), I kinda just have to trust that the expenses are in fact on the workspace I'm filtering to... There's no real visual confirmation that that is true. But we can talk about that some other time in some other place 😅

@shawnborton
Copy link
Copy Markdown
Contributor

When I select a workspace in the filter, it changes the header—I assume that's expected for now, right?

I would think that if this is part of the updated LHB project, we should not be changing the header when a workspace is selected, right?

@shawnborton
Copy link
Copy Markdown
Contributor

Actually maybe that is expected for now, since the other PR is the one that updates the content/look of the header. So maybe ignore me!

@WojtekBoman
Copy link
Copy Markdown
Contributor Author

When I select a workspace in the filter, it changes the header—I assume that's expected for now, right?

I would think that if this is part of the updated LHB project, we should not be changing the header when a workspace is selected, right?

Yes, it's expected for now, the workspace icon will be removed in another PR :)

Copy link
Copy Markdown
Contributor

@289Adam289 289Adam289 left a comment

Choose a reason for hiding this comment

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

LGTM. Left just one small comment. It may be possible that sanitize checks will be needed, but I wasn't able to find anything else.

Comment thread src/libs/SearchQueryUtils.ts Outdated
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.

Workspace name can include space so running it through sanitizeSearchValue is necessary

@WojtekBoman WojtekBoman marked this pull request as ready for review April 8, 2025 11:34
@WojtekBoman WojtekBoman requested a review from a team as a code owner April 8, 2025 11:34
@melvin-bot melvin-bot Bot requested review from dukenv0307 and removed request for a team April 8, 2025 11:34
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 8, 2025

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

@dannymcclain
Copy link
Copy Markdown
Contributor

I think from a design perspective this is good to go 🚀

Comment thread src/libs/SearchQueryUtils.ts Outdated
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 only use policies to get the name of specific policyID, so I think we should pass the policyName: string

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.

Hmm, I implemented it similarly to other filters, we pass the entire collection and extract data for specific ids/ids. Also, it will be useful when we implement a multiselect workspace filter

Comment thread src/pages/Search/SearchPageNarrow.tsx Outdated
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 should be !queryJSON || ...

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.

Hmm, I am not sure if isCannedQuery should be true when !queryJSON, maybe I'll reuse code that I wrote in SearchTypeMenu.tsx

@dukenv0307
Copy link
Copy Markdown
Contributor

Looks good, just left some minor comments

@mountiny
Copy link
Copy Markdown
Contributor

mountiny commented Apr 8, 2025

Awaiting for the feedback to be addressed

@WojtekBoman WojtekBoman force-pushed the improve-desktop-nav/1-add-workspace-filter branch from a125f4b to 09f9c68 Compare April 8, 2025 17:27
@WojtekBoman
Copy link
Copy Markdown
Contributor Author

@dukenv0307 I replied to your comments, please check if it's ok now :)

@dukenv0307
Copy link
Copy Markdown
Contributor

code looks good now

@dukenv0307
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 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
Screen.Recording.2025-04-09.at.00.42.06.mov
Android: mWeb Chrome
Screen.Recording.2025-04-09.at.00.39.38.mov
iOS: Native
Screen.Recording.2025-04-09.at.00.41.01.mov
iOS: mWeb Safari
Screen.Recording.2025-04-09.at.00.38.36.mov
MacOS: Chrome / Safari
Screen.Recording.2025-04-09.at.00.38.02.mov
MacOS: Desktop
Screen.Recording.2025-04-09.at.00.45.09.mov

@melvin-bot melvin-bot Bot requested a review from mountiny April 8, 2025 17:46
@dukenv0307
Copy link
Copy Markdown
Contributor

LGTM

Copy link
Copy Markdown
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

@WojtekBoman @dukenv0307 are there no unit tests to add for this new search option?

/**
* A copy of `isDefaultExpensesQuery` handling the policy ID, used if you have access to the leftHandBar beta.
* When this beta is no longer needed, this method will be renamed to `isDefaultExpensesQuery` and will replace the old method.
*
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
*

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.

It will be done in this PR: #59943

@mountiny mountiny merged commit 8648481 into Expensify:main Apr 8, 2025
18 checks passed
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Apr 8, 2025

✋ 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
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 9, 2025

🚀 Deployed to staging by https://github.com/mountiny in version: 9.1.25-0 🚀

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

@github-actions
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.25-4 🚀

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

@WojtekBoman
Copy link
Copy Markdown
Contributor Author

@WojtekBoman @dukenv0307 are there no unit tests to add for this new search option?

I believe the logic of the new filter still needs to be adjusted, it will be done in the next [Desktop Navigation] PRs, so we'll add tests once the whole functionality is finished

@mountiny
Copy link
Copy Markdown
Contributor

thanks

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.

8 participants