[NoQA] Add policyID to getOrderedReportIDs and sortReportsByLastRead by WojtekBoman · Pull Request #33302 · Expensify/App

WojtekBoman · 2023-12-19T16:16:21Z

Details

In this PR have been modified two functions. To both of them has been added an additional param: policyID. The modified functions:

getOrderedReportIDs -> To this function has been added possibility to filter reports by the given policyID
sortReportsByLastRead -> This function is used in findLastAccessedReport. Thanks to the additional param it's possible to find a last accessed report within the specific workspace. It will be useful in the future when we try to open the app from the deeplink only with the workspace id without the information about a specific report that we should open.

When the workspace switcher is ready, the appropriate policyID should be passed to the functions listed above.

cc: @hayata-suenaga

Fixed Issues

$ #31877
PROPOSAL: described in the design doc: https://docs.google.com/document/d/1VnEf2ThbbiQj0kx9KnAihF0DWf50s2Bn_MztEyEwtjg/edit?pli=1#bookmark=id.v253hbgx14pm

Tests

To test whether filtering works properly, pass an example policyID to the functions mentioned above, and check if the returned data is associated with the workspace whose ID was passed to the function.

Verify that no errors appear in the JS console

Offline tests

To test whether filtering works properly, pass an example policyID to the functions mentioned above, and check if the returned data is associated with the workspace whose ID was passed to the function.

QA Steps

To test whether filtering works properly, pass an example policyID to the functions mentioned above, and check if the returned data is associated with the workspace whose ID was passed to the function.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

This PR only modifies utility functions.

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-12-19T17:07:15Z

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

hayata-suenaga · 2023-12-20T21:18:41Z

Thank you for opening the PR @WojtekBoman while I'm still working the backend API 🙇 I like how you're working on things you can work on right now 🙇

hayata-suenaga · 2023-12-20T21:21:47Z


 /**
- * Given a collection of reports returns them sorted by last read
+ * Given a collection of reports returns them sorted by last read and optionally filtered by a specific policyID.


Suggested change

* Given a collection of reports returns them sorted by last read and optionally filtered by a specific policyID.

* Given a collection of reports, return them sorted by the last read timestamp. Filters the sorted reports by a policy ID, if provided.

WojtekBoman · 2024-01-08T11:02:18Z

All comments have been resolved :)

hayata-suenaga · 2024-01-08T16:13:30Z

@WojtekBoman sorry for the wait 🙇 I'm back from OOO

another internal engineer took over the task of creating the backend API. I'll give you update as that progresses 🙇

hayata-suenaga · 2024-01-11T17:55:33Z

The backend API has been deployed to the staging environment. I will notify you when it is deployed to production. The new API is named OpenWorkspace.

hayata-suenaga · 2024-01-11T17:56:28Z

wait, I think the NewDot talks to the staging server right? if that is the case, you can already test your PR if you need the new API to do so. @WojtekBoman

mountiny · 2024-01-16T23:43:19Z

Let us know in slack when this is ready, we can merge to the feature branch

mountiny · 2024-01-17T17:45:38Z

+    let reportsValues = Object.values(reports ?? {});
+    if (policyID) {
+        reportsValues = reportsValues.filter((report) => !!report && doesReportBelongToWorkspace(report, policyID, policyMemberAccountIDs));
+    }


Should we move this before the sortReportsByLastRead method/ outside? This is now changing the purpose of the method which was only to sort so I fee like any filtering should be done before that and we only pass the collection of the reports we know we want to sort

I've created the separated method to filter reports which is invoked before the sortReportsByLastRead, but to achieve that I had to move parsing OnyxCollection to the array to the parent function. Is it ok? This change required adjusting types in the function params.

hayata-suenaga

finally got around reviewing this 😓 code looks good to me 🟢

mountiny · 2024-01-18T12:16:20Z

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

App works!

mountiny · 2024-01-18T12:30:59Z

+
+    type OpenWorkspaceParams = {
+        policyID: string;
+        clientMemberEmails: string;


Suggested change

clientMemberEmails: string;

clientMemberAccountIDs: string;

mountiny · 2024-01-18T12:31:06Z

+
+    const params: OpenWorkspaceParams = {
+        policyID,
+        clientMemberEmails: JSON.stringify(clientMemberAccountIDs),


Suggested change

clientMemberEmails: JSON.stringify(clientMemberAccountIDs),

clientMemberAccountIDs: JSON.stringify(clientMemberAccountIDs),

mountiny · 2024-01-18T12:31:46Z

    API.read('OpenWorkspaceReimburseView', params, {successData, failureData});
 }

+function openWorkspace(policyID: string, clientMemberAccountIDs: number[]) {


Cuold you add docs here to explain what is returned in this case?

mountiny

Thank you!

OSBotify · 2024-01-18T14:10:51Z

✋ 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-01-19T10:02:18Z

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

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

OSBotify · 2024-01-21T22:47:01Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.28-0 🚀

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

mollfpr · 2024-03-14T13:32:44Z


+    if (currentPolicyID || policyMemberAccountIDs.length > 0) {
+        reportsToDisplay = reportsToDisplay.filter((report) => ReportUtils.doesReportBelongToWorkspace(report, currentPolicyID, policyMemberAccountIDs));
+    }


Hi 👋 Coming from #35963

When the IOU report and details page are not highlighted in the LHN, the filter removes the current viewed report. So to fix it we decided to add a check where it's past the currently viewed report.

WojtekBoman added 2 commits December 19, 2023 16:34

Add policyID to getOrderedReportIDs and sortReportsByLastRead

68bc20b

Refactor getOrderedReportIDs function

3519aa3

WojtekBoman marked this pull request as ready for review December 19, 2023 17:07

WojtekBoman requested a review from a team as a code owner December 19, 2023 17:07

melvin-bot Bot requested review from akinwale and removed request for a team December 19, 2023 17:07

mountiny assigned WojtekBoman Dec 20, 2023

mountiny requested changes Dec 20, 2023

View reviewed changes

Comment thread src/libs/SidebarUtils.ts Outdated

mountiny removed the request for review from akinwale December 20, 2023 13:32

mountiny changed the title ~~Add policyID to getOrderedReportIDs and sortReportsByLastRead~~ [NoQA] Add policyID to getOrderedReportIDs and sortReportsByLastRead Dec 20, 2023

Refactor getOrderedReportIDs function

fd51ac7

hayata-suenaga self-requested a review December 20, 2023 21:18

hayata-suenaga reviewed Dec 20, 2023

View reviewed changes

Merge branch 'main' into filter-out-reports-by-workspace

7c9f4f3

Merge branch 'main' into filter-out-reports-by-workspace

56b1bbe

hayata-suenaga mentioned this pull request Jan 11, 2024

[HOLD for payment 2024-01-28] Filter out reports based on the active workspace #31877

Closed

WojtekBoman added 2 commits January 16, 2024 10:19

Add openWorkspace request

baf40b7

Add policyID and policyMemberAccountIDs params to findLastAccessedReport

2788c74

WojtekBoman added 5 commits January 17, 2024 07:32

Merge branch 'main' into filter-out-reports-by-workspace

df65140

Refactor doesReportBelongToWorkspace function

269cde1

Refactor getOrderedReportIDs function

a92114a

Update sortReportsByLastRead description

03fcbd8

Additional check for Concierge in doesReportBelongToWorkspace

8f398a6

mountiny reviewed Jan 17, 2024

View reviewed changes

Comment thread src/libs/ReportUtils.ts Outdated

mountiny reviewed Jan 17, 2024

View reviewed changes

Fix policyMemberAccountIDs types

94b6a69

hayata-suenaga previously approved these changes Jan 18, 2024

View reviewed changes

Refactor function names and descriptions

af744fd

WojtekBoman dismissed hayata-suenaga’s stale review via af744fd January 18, 2024 07:50

WojtekBoman added 2 commits January 18, 2024 09:11

Merge branch 'main' into filter-out-reports-by-workspace

12ef275

Add filterReportsByPolicyIdAndMemberAccountIDs function

57bda5c

mountiny requested changes Jan 18, 2024

View reviewed changes

WojtekBoman added 2 commits January 18, 2024 14:26

Refactor function params and descriptions

2c9b08f

Add openWorkspace docs

76cda90

mountiny approved these changes Jan 18, 2024

View reviewed changes

mountiny merged commit 5592cad into Expensify:main Jan 18, 2024

github-actions Bot mentioned this pull request Jan 19, 2024

Deploy Checklist: New Expensify 2024-01-19 #34789

Closed

19 tasks

mollfpr reviewed Mar 14, 2024

View reviewed changes

mollfpr mentioned this pull request Mar 14, 2024

[HOLD for payment 2024-03-13] [$500] Workspace switcher - LHN does not show IOU report and details page under "workspace" filter #35963

Closed

6 tasks

	* Given a collection of reports returns them sorted by last read and optionally filtered by a specific policyID.
	* Given a collection of reports, return them sorted by the last read timestamp. Filters the sorted reports by a policy ID, if provided.

	clientMemberEmails: JSON.stringify(clientMemberAccountIDs),
	clientMemberAccountIDs: JSON.stringify(clientMemberAccountIDs),

Uh oh!

Conversation

WojtekBoman commented Dec 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Dec 19, 2023

Uh oh!

Uh oh!

hayata-suenaga commented Dec 20, 2023

Uh oh!

hayata-suenaga Dec 20, 2023

Choose a reason for hiding this comment

Uh oh!

WojtekBoman commented Jan 8, 2024

Uh oh!

hayata-suenaga commented Jan 8, 2024

Uh oh!

hayata-suenaga commented Jan 11, 2024

Uh oh!

hayata-suenaga commented Jan 11, 2024

Uh oh!

mountiny commented Jan 16, 2024

Uh oh!

Uh oh!

Uh oh!

mountiny Jan 17, 2024

Choose a reason for hiding this comment

Uh oh!

WojtekBoman Jan 18, 2024

Choose a reason for hiding this comment

Uh oh!

hayata-suenaga left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny commented Jan 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mountiny left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mountiny Jan 18, 2024

Choose a reason for hiding this comment

Uh oh!

mountiny Jan 18, 2024

Choose a reason for hiding this comment

Uh oh!

mountiny Jan 18, 2024

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jan 18, 2024

Uh oh!

OSBotify commented Jan 19, 2024

Uh oh!

OSBotify commented Jan 21, 2024

Uh oh!

mollfpr Mar 14, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

WojtekBoman commented Dec 19, 2023 •

edited

Loading

mountiny commented Jan 18, 2024 •

edited

Loading

mountiny left a comment •

edited

Loading