Create Category utils file #42305

dangrous · 2024-05-16T16:06:34Z

cc @luacmartins and @amyevans since this was your initiative

Details

First stage of #38477 - setting up the directory and creating the Category specific stuff, will then make new PRs for Members, Tags, and Distance Rates.

77 files is scary! But most of them are just swapping an import.

In terms of testing, we could maybe do some spot checks re: categories, but otherwise this is just administrative and shouldn't cause any issues. No new or changed functionality, just organization.

Fixed Issues

#38477
PROPOSAL:

Tests

N/A

Verify that no errors appear in the JS console

Offline tests

QA Steps

N/A

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

dangrous · 2024-05-16T17:15:17Z

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

@@ -12,7 +12,7 @@ import useLocalize from '@hooks/useLocalize';
 import useNetwork from '@hooks/useNetwork';
 import useThemeStyles from '@hooks/useThemeStyles';
 import useWindowDimensions from '@hooks/useWindowDimensions';
-import {openDraftWorkspaceRequest} from '@libs/actions/Policy';
+import {openDraftWorkspaceRequest} from '@libs/actions/Policy/Policy';


Commenting on my own code here but I think we should change all of these @libs/actions to @userActions - what do you think, reviewer?

I asked here but didn't get any responses.

Yeah that change should be fine!

Why do you think we should change this?

just consistency, really - if we have the more specific shortcut I feel like we should use it?

Yea, that makes sense. Let's do it!

dangrous · 2024-05-16T17:22:56Z

oh huh PullerBear isn't going to work with the site down. Will try again later.

amyevans · 2024-05-16T18:13:26Z

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

@@ -12,7 +12,7 @@ import useLocalize from '@hooks/useLocalize';
 import useNetwork from '@hooks/useNetwork';
 import useThemeStyles from '@hooks/useThemeStyles';
 import useWindowDimensions from '@hooks/useWindowDimensions';
-import {openDraftWorkspaceRequest} from '@libs/actions/Policy';
+import {openDraftWorkspaceRequest} from '@libs/actions/Policy/Policy';


Yeah that change should be fine!

src/libs/actions/Policy/Policy.ts

luacmartins

LGTM

dangrous · 2024-05-22T21:48:05Z

Okay I think this is ready to go now - I updated the shortcut! Will try reapplying PullerBear too now that the site is not broken

melvin-bot · 2024-05-22T21:48:43Z

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

amyevans · 2024-05-22T22:00:24Z

Looks like the linter is failing

dangrous · 2024-05-23T13:40:47Z

oh lol changing the shortcuts changed the alphabetization

Gonals · 2024-05-24T00:08:29Z

Conflicts!

luacmartins

LGTM. We have conflicts now though

luacmartins · 2024-05-28T13:39:17Z

@dangrous conflicts again

dangrous · 2024-05-28T17:09:27Z

Merge conflicts fixed! We should probably request a merge for this one in #deployers, right? It's a bit high-risk if I missed anything, but it's going to keep building up conflicts... Let me know what you think.

luacmartins · 2024-05-28T20:24:11Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

dangrous · 2024-05-28T21:42:38Z

Hm, in working on the Tags PR, I discovered there's one function that I and the linter didn't notice I've now doubled, buildOptimisticPolicyCategories.

I just tried shifting this over, but now we get a circular dependency with navigateWhenEnableFeature and removePendingFieldsFromCustomUnit being needed in Category.ts, and buildOptimisticPolicyCategories being needed in Policy.ts. They're only used in those two files... Any ideas on how to fix that? Or just leave it for a final cleanup in the end? There's a chance migrating Members, Distance Rates, etc. will solve it for us.

OSBotify · 2024-05-29T09:43:36Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.77-0 🚀

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

OSBotify · 2024-05-30T21:26:25Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

OSBotify · 2024-05-30T22:38:23Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

dangrous added 4 commits May 14, 2024 16:22

add draft file

be23161

narrow down to category files and update internal references

e25769a

Merge branch 'main' into dangrous-categoryutilsfile

3d58c34

move Policy file

46c5b58

dangrous self-assigned this May 16, 2024

dangrous added 5 commits May 16, 2024 12:09

missed two references

d999124

prettier

ee83f81

shift all references to new file

658ba82

remove code from Policy.ts

cca7b33

prettier again

a9687c1

dangrous commented May 16, 2024

View reviewed changes

dangrous marked this pull request as ready for review May 16, 2024 17:21

dangrous requested a review from a team as a code owner May 16, 2024 17:21

amyevans reviewed May 16, 2024

View reviewed changes

luacmartins previously approved these changes May 21, 2024

View reviewed changes

switch shortcut to @userActions

243ec4e

dangrous dismissed luacmartins’s stale review via 243ec4e May 22, 2024 21:46

dangrous requested review from a team and removed request for a team May 22, 2024 21:48

melvin-bot bot requested review from Gonals and removed request for a team May 22, 2024 21:48

amyevans previously approved these changes May 22, 2024

View reviewed changes

prettier

48df536

dangrous dismissed amyevans’s stale review via 48df536 May 23, 2024 13:40

amyevans previously approved these changes May 23, 2024

View reviewed changes

dangrous mentioned this pull request May 23, 2024

Create Tag utils file #42559

Merged

50 tasks

luacmartins previously approved these changes May 27, 2024

View reviewed changes

Gonals previously approved these changes May 28, 2024

View reviewed changes

merge conflicts

f259939

dangrous dismissed stale reviews from Gonals, luacmartins, and amyevans via f259939 May 28, 2024 16:33

luacmartins self-requested a review May 28, 2024 16:48

luacmartins approved these changes May 28, 2024

View reviewed changes

amyevans approved these changes May 28, 2024

View reviewed changes

Gonals approved these changes May 28, 2024

View reviewed changes

luacmartins merged commit a414ef1 into main May 28, 2024
15 of 20 checks passed

luacmartins deleted the dangrous-categoryutilsfile branch May 28, 2024 20:26

github-actions bot mentioned this pull request May 29, 2024

Deploy Checklist: New Expensify 2024-05-29 #42741

Closed

dangrous mentioned this pull request Jun 11, 2024

[HOLD for payment 2024-06-28] [HOLD for payment 2024-06-24] [HOLD for payment 2024-06-20] [HOLD for payment 2024-06-18] [POLISH][Simplified Collect] Create utils files for each page #38477

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create Category utils file #42305

Create Category utils file #42305

dangrous commented May 16, 2024 •

edited

Loading

dangrous May 16, 2024

amyevans May 16, 2024

luacmartins May 21, 2024

dangrous May 22, 2024

luacmartins May 22, 2024

dangrous commented May 16, 2024

amyevans May 16, 2024

luacmartins left a comment

dangrous commented May 22, 2024

melvin-bot bot commented May 22, 2024

amyevans commented May 22, 2024

dangrous commented May 23, 2024

Gonals commented May 24, 2024

luacmartins left a comment

luacmartins commented May 28, 2024

dangrous commented May 28, 2024

luacmartins commented May 28, 2024 •

edited

Loading

dangrous commented May 28, 2024

OSBotify commented May 29, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

Create Category utils file #42305

Create Category utils file #42305

Conversation

dangrous commented May 16, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

dangrous May 16, 2024

Choose a reason for hiding this comment

amyevans May 16, 2024

Choose a reason for hiding this comment

luacmartins May 21, 2024

Choose a reason for hiding this comment

dangrous May 22, 2024

Choose a reason for hiding this comment

luacmartins May 22, 2024

Choose a reason for hiding this comment

dangrous commented May 16, 2024

amyevans May 16, 2024

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

dangrous commented May 22, 2024

melvin-bot bot commented May 22, 2024

amyevans commented May 22, 2024

dangrous commented May 23, 2024

Gonals commented May 24, 2024

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented May 28, 2024

dangrous commented May 28, 2024

luacmartins commented May 28, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

dangrous commented May 28, 2024

OSBotify commented May 29, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

dangrous commented May 16, 2024 •

edited

Loading

luacmartins commented May 28, 2024 •

edited

Loading