[OldDot Rules Migration] Category settings: Default categories #48391

BartoszGrajdek · 2024-09-02T08:09:45Z

Details

This PR adds a possibility to edit default spend categories like it used to work on OldDot.

Fixed Issues

$ #47018

Tests

Firstly we need to ensure two things:

Create a fresh workspace
Go to Workspace Settings -> More features -> Organize
Enable Categories setting

Now going into proper testing:

Go to Workspace Settings -> Categories -> Settings (You should see a list of default spend categories)
Click on one of the spend categories
Select a category you want to assign to a given spend category

Verify that it worked and is shown in spend categories list now.

Offline tests

Same as above

QA Steps

Same as above

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 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
  - 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: https://swmansion.slack.com/archives/C01GTK53T8Q/p1725349335502689
- 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.mov

Android: mWeb Chrome

chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

BrtqKr

Looks fine, couple small remarks

src/components/CategoryPicker.tsx

src/languages/es.ts

src/libs/actions/Policy/Policy.ts

src/pages/workspace/categories/WorkspaceCategoriesSettingsPage.tsx

src/components/CategoryPicker.tsx

melvin-bot · 2024-09-03T11:39:46Z

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

ahmedGaber93 · 2024-09-03T18:58:55Z

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

a.mp4

Android: mWeb Chrome

aw.mp4

iOS: Native

i.mp4

iOS: mWeb Safari

iw.mp4

MacOS: Chrome / Safari

w.mp4

MacOS: Desktop

d.mp4

ahmedGaber93 · 2024-09-03T19:19:26Z

I faced those two minor issues while testing, but the core function works fine.

Bug: console error when scroll the nested SectionList

20240903115941364.mp4

Bug: back button is focused with blue border after search for category and select it

20240903121216185.mp4

marcaaron

Great work so far. Had a few comments.

src/components/CategoryPicker.tsx

src/libs/actions/Policy/Policy.ts

src/pages/workspace/categories/WorkspaceCategoriesSettingsPage.tsx

src/components/CategoryPicker.tsx

src/components/SelectionList/CategorySelectorListItem.tsx

src/pages/workspace/categories/WorkspaceCategoriesSettingsPage.tsx

ahmedGaber93 · 2024-09-03T21:22:26Z

Bug: exist workspace (Not newly created) appear with blank space in Default spend categories section

ahmedGaber93 · 2024-09-03T21:31:43Z

@marcaaron Sorry for reviewing the code after your review, It seems we were reviewing the code at the same time, and when posting my review I didn't note your review is posted.

I know you don't take care about these things, But I had to clarify.

marcaaron · 2024-09-04T00:08:39Z

@ahmedGaber93 No worries. It's fine to review PRs in parallel. But let me know if you have a specific concern. I still want you to review whether I review early or not.

ahmedGaber93 · 2024-09-04T00:30:07Z

@marcaaron Thanks, I just wrote a small notes above, and I need your opinion here #48391 (comment)

BartoszGrajdek · 2024-09-04T12:30:17Z

Alright, I've addressed all of the comments above, the PR is ready for review! @marcaaron @ahmedGaber93 🤞🏻

ahmedGaber93 · 2024-09-04T12:34:50Z

@BartoszGrajdek Great, I will start reviewing after half an hour.

ahmedGaber93 · 2024-09-04T13:45:25Z

@BartoszGrajdek this issue #48391 (comment) still appear on old workspace

ahmedGaber93 · 2024-09-04T13:47:57Z

Minor Bug on iOS mWeb Safari: spend category is not select from the first tap, we need to two taps or scroll then tap

issue.mp4

ahmedGaber93 · 2024-09-04T14:12:01Z

The back button outline issue here #48391 (comment) is still reproduced.
You should start search first, then select a spend category from search result to be able to reproduced

BartoszGrajdek · 2024-09-04T14:56:31Z

@BartoszGrajdek this issue #48391 (comment) still appear on old workspace

This is a backend problem which I've informed marc about, we currently don't get any updates to mmcGroup on old workspaces, hence nothing's shown

BartoszGrajdek · 2024-09-04T15:10:28Z

The back button outline issue here #48391 (comment) is still reproduced.
You should start search first, then select a spend category from search result to be able to reproduced

The same thing is happening on staging in Distance Rates where CategorySelector is also used, so I believe this shouldn't be stopping us

Video

distance-rates.mov

ahmedGaber93 · 2024-09-04T15:12:32Z

@BartoszGrajdek yes, it looks like it's a BE issue, but what do you think about hiding the header section in this case

BartoszGrajdek · 2024-09-04T15:39:47Z

@BartoszGrajdek yes, it looks like it's a BE issue, but what do you think about hiding the header section in this case

You're right, overlooked that 😅

Minor Bug on iOS mWeb Safari: spend category is not select from the first tap, we need to two taps or scroll then tap

Looks like this ^ is the only remaining problem I'm not sure yet how to solve it but I'll try to work on it in a few hours. It seems like it's only happening from time to time, so I'll need to figure out how to consistently reproduce it first.

My mWeb Safari

ios.mov

BartoszGrajdek · 2024-09-04T19:11:24Z

Okay regarding the issue described above - IMO this is something we can handle either in a follow-up PR or with the whole Modal issue at once.

That's because it's happening only in cases where the user hasn't scrolled or searched anything and even then it's happening like 1 out of 20 times.

This is most likely related to the scrolling problem I've described here, but for now as this PR is a different task it's not something I think we should focus on. Let me know what do you think 🙌🏻 @marcaaron @ahmedGaber93

ahmedGaber93 · 2024-09-04T19:49:05Z

and even then it's happening like 1 out of 20 times.

I think it depends on the device because it reproduced with me every time. But I agree It's not a big deal to focus on now, and we can handle it in a follow-up PR.

ahmedGaber93

LGTM!

marcaaron · 2024-09-04T21:11:22Z

handle either in a follow-up PR or with the whole Modal issue at once.

Sounds good to me. The problem seems unrelated to these changes specifically.

marcaaron

LGTM ❤️ !

Great work @BartoszGrajdek! And nice job reviewing @ahmedGaber93 🙇

OSBotify · 2024-09-04T21:24:09Z

✋ 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-09-05T19:41:02Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 9.0.30-0 🚀

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

IuliiaHerets · 2024-09-06T05:35:52Z

This PR is failing for Android because of issue #48676

…Grajdek/category-settings-default-categories" This reverts commit dc11324, reversing changes made to 14b8277.

s77rt · 2024-10-11T14:22:09Z

src/pages/workspace/categories/SpendCategorySelectorListItem.tsx

+    const setNewCategory = (selectedCategory: ListItem) => {
+        if (!selectedCategory.text) {
+            return;
+        }
+        Policy.setWorkspaceDefaultSpendCategory(policyID, groupID, selectedCategory.text);
+    };


When setting a new category we had to check that it's not the current selected one i.e. newCategory != currentCategory. This is because we have a case where if you go offline, delete the current category and select it again the following API calls will be queued:

Delete category

Set spend category

And in the second API call we will be setting the spend category to a category that no longer exists which will causes an error.

(Comnig from #49295)

BartoszGrajdek added 9 commits September 2, 2024 10:08

feat: add default categories handling

eaa19a1

refactor: change flatlist to selection list

1874bff

chore: resolve merge conflicts

9833de9

fix: scrolling category selector bug

2646a9f

fix: SetWorkspaceDefaultSpendCategory API types

62bc63e

fix: CategoryPicker types

2fd739b

feat: add translations

09cd340

fix: VirtualizedList inside ScrollView error

4b9d455

fix: remove unused types

645bb70

BrtqKr reviewed Sep 3, 2024

View reviewed changes

BartoszGrajdek added 2 commits September 3, 2024 13:23

fix: cleanup

898ff98

refactor: add a comment explaining sectionListStyles

5981f6e

BartoszGrajdek commented Sep 3, 2024

View reviewed changes

src/components/CategoryPicker.tsx Outdated Show resolved Hide resolved

BrtqKr approved these changes Sep 3, 2024

View reviewed changes

BartoszGrajdek marked this pull request as ready for review September 3, 2024 11:39

BartoszGrajdek requested a review from a team as a code owner September 3, 2024 11:39

melvin-bot bot requested review from ahmedGaber93 and removed request for a team September 3, 2024 11:39

marcaaron assigned BartoszGrajdek Sep 3, 2024

marcaaron requested changes Sep 3, 2024

View reviewed changes

src/components/CategoryPicker.tsx Outdated Show resolved Hide resolved

src/libs/actions/Policy/Policy.ts Outdated Show resolved Hide resolved

src/pages/workspace/categories/WorkspaceCategoriesSettingsPage.tsx Show resolved Hide resolved

ahmedGaber93 reviewed Sep 3, 2024

View reviewed changes

BartoszGrajdek added 2 commits September 4, 2024 12:19

refactor: address review comments

7343191

fix: scroll error

41e6968

fix: focus button

b7742e5

fix: hide section header when empty

147fc69

ahmedGaber93 approved these changes Sep 4, 2024

View reviewed changes

melvin-bot bot requested a review from marcaaron September 4, 2024 19:50

marcaaron approved these changes Sep 4, 2024

View reviewed changes

marcaaron merged commit dc11324 into Expensify:main Sep 4, 2024
16 checks passed

github-actions bot mentioned this pull request Sep 5, 2024

Deploy Checklist: New Expensify 2024-09-05 #48664

Closed

69 tasks

IuliiaHerets mentioned this pull request Sep 6, 2024

Android - Categories - Category list opens & closes instantly with last few spend categories #48676

Closed

6 tasks

IuliiaHerets mentioned this pull request Sep 6, 2024

[$250] [HOLD for payment 2024-10-10] Categories - Spend category field is not grayed out after changing category offline #48678

Closed

6 tasks

lakchote mentioned this pull request Sep 6, 2024

[HOLD for payment 2024-09-16] Categories - Unable to select subcategory as the default spend category #48690

Closed

6 tasks

lakchote added a commit that referenced this pull request Sep 6, 2024

Revert "Merge pull request #48391 from software-mansion-labs/@Bartosz…

0073443

…Grajdek/category-settings-default-categories" This reverts commit dc11324, reversing changes made to 14b8277.

s77rt reviewed Oct 11, 2024

View reviewed changes

s77rt mentioned this pull request Oct 11, 2024

[HOLD for payment 2024-10-14] [$250] Categories - RBR appears next to workspace after selecting the deleted spend category offline #49295

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[OldDot Rules Migration] Category settings: Default categories #48391

[OldDot Rules Migration] Category settings: Default categories #48391

BartoszGrajdek commented Sep 2, 2024 •

edited

Loading

BrtqKr left a comment

melvin-bot bot commented Sep 3, 2024

ahmedGaber93 commented Sep 3, 2024 •

edited

Loading

ahmedGaber93 commented Sep 3, 2024

marcaaron left a comment

ahmedGaber93 commented Sep 3, 2024

ahmedGaber93 commented Sep 3, 2024 •

edited

Loading

marcaaron commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024

BartoszGrajdek commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024 •

edited

Loading

BartoszGrajdek commented Sep 4, 2024

BartoszGrajdek commented Sep 4, 2024 •

edited

Loading

ahmedGaber93 commented Sep 4, 2024 •

edited

Loading

BartoszGrajdek commented Sep 4, 2024

BartoszGrajdek commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024 •

edited

Loading

ahmedGaber93 left a comment

marcaaron commented Sep 4, 2024

marcaaron left a comment

OSBotify commented Sep 4, 2024

OSBotify commented Sep 5, 2024

IuliiaHerets commented Sep 6, 2024

s77rt Oct 11, 2024

[OldDot Rules Migration] Category settings: Default categories #48391

[OldDot Rules Migration] Category settings: Default categories #48391

Conversation

BartoszGrajdek commented Sep 2, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

BrtqKr left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 3, 2024

ahmedGaber93 commented Sep 3, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ahmedGaber93 commented Sep 3, 2024

marcaaron left a comment

Choose a reason for hiding this comment

ahmedGaber93 commented Sep 3, 2024

ahmedGaber93 commented Sep 3, 2024 • edited Loading

marcaaron commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024

BartoszGrajdek commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024 • edited Loading

BartoszGrajdek commented Sep 4, 2024

BartoszGrajdek commented Sep 4, 2024 • edited Loading

ahmedGaber93 commented Sep 4, 2024 • edited Loading

BartoszGrajdek commented Sep 4, 2024

BartoszGrajdek commented Sep 4, 2024

ahmedGaber93 commented Sep 4, 2024 • edited Loading

ahmedGaber93 left a comment

Choose a reason for hiding this comment

marcaaron commented Sep 4, 2024

marcaaron left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 4, 2024

OSBotify commented Sep 5, 2024

IuliiaHerets commented Sep 6, 2024

s77rt Oct 11, 2024

Choose a reason for hiding this comment

BartoszGrajdek commented Sep 2, 2024 •

edited

Loading

ahmedGaber93 commented Sep 3, 2024 •

edited

Loading

ahmedGaber93 commented Sep 3, 2024 •

edited

Loading

ahmedGaber93 commented Sep 4, 2024 •

edited

Loading

BartoszGrajdek commented Sep 4, 2024 •

edited

Loading

ahmedGaber93 commented Sep 4, 2024 •

edited

Loading

ahmedGaber93 commented Sep 4, 2024 •

edited

Loading