feat: load policy categories only when needed #49756

jaydamani · 2024-09-25T22:59:23Z

Details

policy categories were not loaded on app start due to which the 'categorise it' button did not show policies that the user did not visit after login

Fixed Issues

$ #47854
PROPOSAL: #47854 (comment)

Tests

Go to staging.new.expensify.com
Create a few workspaces
Go to self DM
Send a message
Log out and log it
Do not open any workspace chat and go to self DM
Click + > Track expense > Manual
Submit a track manual expense
Click Categorize it
Search for other existing workspace chats that do not show up in the list
Note that the other existing workspace chats do not return in the search result
Open all the workspace chats
Repeat Step 9 and 10
Note that workspace chats are only searchable after the workspace chats are visited

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to staging.new.expensify.com
Create a few workspaces
Go to self DM
Send a message
Log out and log it
Do not open any workspace chat and go to self DM
Click + > Track expense > Manual
Submit a track manual expense
Click Categorize it
Search for other existing workspace chats that do not show up in the list
Note that the other existing workspace chats do not return in the search result
Open all the workspace chats
Repeat Step 9 and 10
Note that workspace chats are only searchable after the workspace chats are visited

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_app.mp4

Android: mWeb Chrome

android_web.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.16.-.2024-09-25.at.22.27.17.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.16.-.2024-09-25.at.23.57.12.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-09-25.at.21.39.18.mp4

MacOS: Desktop

Screen.Recording.2024-09-25.at.21.44.05.mp4

melvin-bot · 2024-09-25T22:59:28Z

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

jaydamani · 2024-09-25T23:48:34Z

For offline mode after the user selects a workspace, since no categories are loaded for workspace it will show like below instead. This seems incorrect as the workspace does have categories but they are not loaded because user is offline. Should we just show a message that says you need to be online to view this or do we have a common component for this?

dukenv0307 · 2024-09-26T04:33:47Z

src/components/CategoryPicker.tsx

+    const [policyCategoriesDraft] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_CATEGORIES_DRAFT}${policyID}`);
+    const [policyRecentlyUsedCategories] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_RECENTLY_USED_CATEGORIES}${policyID}`);
+
+    Category.getPolicyCategories(policyID);


we shouldn't call API in here. You can do the same as openPolicyCategoriesPage

dukenv0307 · 2024-09-26T04:35:53Z

For offline mode after the user selects a workspace, since no categories are loaded for workspace it will show like below instead. This seems incorrect as the workspace does have categories but they are not loaded because user is offline. Should we just show a message that says you need to be online to view this or do we have a common component for this?

@jaydamani I think we can show the loading skeleton or OfflineIndicator page cc @shawnborton

jaydamani · 2024-09-26T19:35:26Z

There might be an oversight. There is already an API call which loads the categories when user selects the policy so, the new endpoint may not be needed.

dukenv0307 · 2024-09-27T03:40:36Z

@jaydamani What do you mean?

jaydamani · 2024-09-27T04:10:23Z

@dukenv0307 As part of the solution for the orignal issue, we created a new endpoint getPolicyCategories from backend. This PR updates frontend to use the new endpoint for the "categorise it" flow to load all categories after the user selects a workspace but while making the changes from review I noticed that "categorise it" flow already calls another endpoint from here which loads required data related to workspace including the categories for that workspace. So we may not need new endpoint to load categories from the CategoryPicker.
cc: @thienlnam

thienlnam · 2024-09-27T16:24:39Z

The new endpoint is the same as openDraftWorkspaceRequest, it's an alias so the request is 1:1:1 for this different use-case.

Also, I agree we will need to update this offline pattern since you cannot categorize offline so probably the OfflineIndicator

jaydamani · 2024-09-30T12:54:27Z

@dukenv0307 This is now ready for review.
Here is preview for when user is offline:

dukenv0307 · 2024-10-01T03:00:52Z

@jaydamani Thank you. I'm reviewing...

dukenv0307 · 2024-10-01T03:49:58Z

@jaydamani I think we shouldn't use <OfflineIndicator />

we can do the same as

cc @thienlnam @shawnborton @dannymcclain

jaydamani · 2024-10-01T06:12:47Z

@dukenv0307 I also agree that looks more appropriate. should we keep it consistent and block the whole flow so show full page offline view when user clicks on "categorize it" or only show it when user selects a workspace and we do not have data for that workspace.
Current offline flow:

User clicks on categorise it
User selects a workspace for the expense
If categories are already loaded, we show the stale data
If categories are not loaded we show an empty state asking user to create categories like this but with offline indicator at bottom

dukenv0307 · 2024-10-01T08:47:15Z

Here is my thought:

User clicks on categorise it
User selects a workspace for the expense
If categories are already loaded, we show the stale data
If categories are not loaded we show full page offline view

dannymcclain · 2024-10-01T13:40:49Z

Here is my thought:

User clicks on categorise it

User selects a workspace for the expense

If categories are already loaded, we show the stale data

If categories are not loaded we show full page offline view

I think this approach makes sense to me. cc @trjExpensify @dubielzyk-expensify for thoughts as well.

trjExpensify · 2024-10-01T23:20:42Z

That makes sense to me!

dubielzyk-expensify · 2024-10-02T00:16:34Z

Yep that looks good to me

src/pages/iou/request/step/IOURequestStepCategory.tsx

dukenv0307 · 2024-10-02T04:35:06Z

src/pages/iou/request/step/StepScreenWrapper.tsx

@@ -25,6 +25,9 @@ type StepScreenWrapperProps = {
    /** Whether or not to display not found page */
    shouldShowNotFoundPage?: boolean;

+    /** Whether to show offline indicator */
+    shouldShowOfflineIndicator?: boolean;


Can you explain why this change?

StepScreenWrapper renders ScreenWrapper which shows OfflineInidicator at bottom for small screen but our page would already show that user is offline so showing an indicator at bottom would feel weird.

App/src/components/ScreenWrapper.tsx

Line 123 in 9627f5f

shouldShowOfflineIndicator = true,

App/src/components/ScreenWrapper.tsx

Line 288 in 9627f5f

{isSmallScreenWidth && shouldShowOfflineIndicator && <OfflineIndicator style={offlineIndicatorStyle} />}

Basically, to avoid this:

Another approach I tried was to add below code to IOURequestStepCategory but then the header will not render because it comes from StepScreenWrapper so the current approach seemed better

if (policyCategories === undefined && isOffline) { // a children is mandatory for FullPageOfflineBlockingView return <FullPageOfflineBlockingView>{null}</FullPageOfflineBlockingView> }

dukenv0307 · 2024-10-03T03:49:04Z

@jaydamani In case we already loaded policy categories, but all of them are disabled or it's empty, should we show FullPageOfflineBlockingView?

IMO, we should show FullPageOfflineBlockingView only when the categories are loading in offline mode ~ policyCategories === undefined (We need to double check when there's actually no category, policyCategories is undefined or [])

cc @dannymcclain

dukenv0307 · 2024-10-03T03:50:47Z

Here's the current behavior:

Screen.Recording.2024-10-03.at.10.49.22.mov

dukenv0307 · 2024-10-04T03:23:19Z

@jaydamani Can you take a look at my concern above?

jaydamani · 2024-10-04T06:09:51Z

@jaydamani Can you take a look at my concern above?

I was away yesterday, will work on it and push today.

…a is undefined locally

dukenv0307 · 2024-10-05T04:45:56Z

@jaydamani Is it ready for review?

jaydamani · 2024-10-05T04:49:29Z

@dukenv0307 you can review it

dukenv0307 · 2024-10-05T08:15:34Z

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.2024-10-05.at.15.22.34.mov

Android: mWeb Chrome

Screen.Recording.2024-10-05.at.15.20.38.mov

iOS: Native

Screen.Recording.2024-10-05.at.15.22.47.mov

iOS: mWeb Safari

Screen.Recording.2024-10-05.at.15.19.44.mov

MacOS: Chrome / Safari

web-resize.mp4

MacOS: Desktop

Screen.Recording.2024-10-05.at.15.25.59.mov

feat: load policy categories only when needed

be904bd

jaydamani requested a review from a team as a code owner September 25, 2024 22:59

melvin-bot bot requested a review from dukenv0307 September 25, 2024 22:59

melvin-bot bot removed the request for review from a team September 25, 2024 22:59

jaydamani mentioned this pull request Sep 25, 2024

[$250] Track > Categorize it flow - Unable to search for workspace chats if the reports are not visited previously #47854

Open

6 tasks

jaydamani added 2 commits September 26, 2024 05:08

fix ts error

66db43f

fix lint errors

a966b2e

dukenv0307 reviewed Sep 26, 2024

View reviewed changes

jaydamani added 3 commits September 29, 2024 01:01

update API call for IOURequestStepCategory

b873784

withOnyx to useOnyx migration for IOURequestStepCategory

e262b38

add offline indicator for IOURequestStepCategory

e4a7807

update offline 'categorize it' flow

543716c

dukenv0307 reviewed Oct 2, 2024

View reviewed changes

src/pages/iou/request/step/IOURequestStepCategory.tsx Outdated Show resolved Hide resolved

dukenv0307 reviewed Oct 2, 2024

View reviewed changes

remove unused code

0a4ccd4

jaydamani added 2 commits October 4, 2024 19:22

update categorize it flow to show offline blocking view only when dat…

a52e69e

…a is undefined locally

fix category selection in offline view for categorize it flow

4a7f23f

dukenv0307 approved these changes Oct 5, 2024

View reviewed changes

melvin-bot bot requested a review from thienlnam October 5, 2024 08:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: load policy categories only when needed #49756

feat: load policy categories only when needed #49756

jaydamani commented Sep 25, 2024

melvin-bot bot commented Sep 25, 2024

jaydamani commented Sep 25, 2024

dukenv0307 Sep 26, 2024

dukenv0307 commented Sep 26, 2024 •

edited

Loading

jaydamani commented Sep 26, 2024

dukenv0307 commented Sep 27, 2024

jaydamani commented Sep 27, 2024

thienlnam commented Sep 27, 2024

jaydamani commented Sep 30, 2024

dukenv0307 commented Oct 1, 2024

dukenv0307 commented Oct 1, 2024 •

edited

Loading

jaydamani commented Oct 1, 2024

dukenv0307 commented Oct 1, 2024

dannymcclain commented Oct 1, 2024

trjExpensify commented Oct 1, 2024

dubielzyk-expensify commented Oct 2, 2024

dukenv0307 Oct 2, 2024

jaydamani Oct 2, 2024

dukenv0307 commented Oct 3, 2024

dukenv0307 commented Oct 3, 2024 •

edited

Loading

dukenv0307 commented Oct 4, 2024

jaydamani commented Oct 4, 2024

dukenv0307 commented Oct 5, 2024

jaydamani commented Oct 5, 2024

dukenv0307 commented Oct 5, 2024 •

edited

Loading

feat: load policy categories only when needed #49756

Are you sure you want to change the base?

feat: load policy categories only when needed #49756

Conversation

jaydamani commented Sep 25, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 25, 2024

jaydamani commented Sep 25, 2024

dukenv0307 Sep 26, 2024

Choose a reason for hiding this comment

dukenv0307 commented Sep 26, 2024 • edited Loading

jaydamani commented Sep 26, 2024

dukenv0307 commented Sep 27, 2024

jaydamani commented Sep 27, 2024

thienlnam commented Sep 27, 2024

jaydamani commented Sep 30, 2024

dukenv0307 commented Oct 1, 2024

dukenv0307 commented Oct 1, 2024 • edited Loading

jaydamani commented Oct 1, 2024

dukenv0307 commented Oct 1, 2024

dannymcclain commented Oct 1, 2024

trjExpensify commented Oct 1, 2024

dubielzyk-expensify commented Oct 2, 2024

dukenv0307 Oct 2, 2024

Choose a reason for hiding this comment

jaydamani Oct 2, 2024

Choose a reason for hiding this comment

dukenv0307 commented Oct 3, 2024

dukenv0307 commented Oct 3, 2024 • edited Loading

dukenv0307 commented Oct 4, 2024

jaydamani commented Oct 4, 2024

dukenv0307 commented Oct 5, 2024

jaydamani commented Oct 5, 2024

dukenv0307 commented Oct 5, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

dukenv0307 commented Sep 26, 2024 •

edited

Loading

dukenv0307 commented Oct 1, 2024 •

edited

Loading

dukenv0307 commented Oct 3, 2024 •

edited

Loading

dukenv0307 commented Oct 5, 2024 •

edited

Loading