[NoQA] Add BrickRoadsUtils #33239

WojtekBoman · 2023-12-18T15:22:27Z

Details

This PR introduces BrickRoadsUtils.ts file in the src/libs package. The new type has been defined in the new file: type BrickRoad = 'RBR' | 'GBR' | undefined. The file contains two functions:

getWorkspacesBrickRoads: Function returns a map where the keys are policyIDs and the values are BrickRoads for each policy
getBrickRoadForPolicy: Function takes as a parameter policy and returns BrickRoad for the passed policy. This function is used in the getWorkspacesBrickRoads.

The algorithm was implemented accordingly to the description that can be found in the design doc: https://docs.google.com/document/d/1VnEf2ThbbiQj0kx9KnAihF0DWf50s2Bn_MztEyEwtjg/edit#heading=h.70m1twt8rsqp

cc: @hayata-suenaga

Fixed Issues

$ #31878
PROPOSAL: described in the design doc: https://docs.google.com/document/d/1VnEf2ThbbiQj0kx9KnAihF0DWf50s2Bn_MztEyEwtjg/edit#heading=h.70m1twt8rsqp

Tests

To test the function, invoke getWorkspacesBrickRoads anywhere in the application and verify that the returned map contains valid data

Verify that no errors appear in the JS console

Offline tests

To test the function, invoke getWorkspacesBrickRoads anywhere in the application and verify that the returned map contains valid data

QA Steps

To test the function, invoke getWorkspacesBrickRoads anywhere in the application and verify that the returned map contains valid data

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

This PR introduces only utility functions.

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-12-18T16:33:29Z

@fedirjh 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-18T22:42:03Z

src/libs/BrickRoadsUtils.ts

+const getBrickRoadForPolicy = (policyReport: Report): BrickRoad => {
+    const policyReportAction = ReportActionsUtils.getAllReportActions(policyReport.reportID);
+    const reportErrors = OptionsListUtils.getAllReportErrors(policyReport, policyReportAction);
+    const redBrickRoadIndicator = Object.keys(reportErrors ?? {}).length !== 0 ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : undefined;


should we name this doesReportContainErrors?

hayata-suenaga · 2023-12-18T22:44:25Z

src/libs/BrickRoadsUtils.ts

+    const reportErrors = OptionsListUtils.getAllReportErrors(policyReport, policyReportAction);
+    const redBrickRoadIndicator = Object.keys(reportErrors ?? {}).length !== 0 ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : undefined;
+    if (redBrickRoadIndicator) {
+        return 'RBR';


is there a constant for RBR?

hayata-suenaga · 2023-12-18T22:44:40Z

src/libs/BrickRoadsUtils.ts

+    }
+    const optionFromPolicyReport = {...policyReport, isUnread: ReportUtils.isUnread(policyReport), isUnreadWithMention: ReportUtils.isUnreadWithMention(policyReport)};
+    const shouldShowGreenDotIndicator = ReportUtils.requiresAttentionFromCurrentUser(optionFromPolicyReport, itemParentReportAction);
+    return shouldShowGreenDotIndicator ? 'GBR' : undefined;


is there a constant for GBR?

hayata-suenaga · 2023-12-18T22:46:52Z

src/libs/BrickRoadsUtils.ts

+        return {};
+    }
+
+    const brickRoadsMap: Record<string, BrickRoad> = {};


can you add a comment here that the key of this object should be a report ID?

mountiny

@WojtekBoman this seems like a method that might really take performance hit for the heavy accounts.

Could you please test this with the heavy account SWM got for auditing?

Also could you add reassure tests for these two methods using the measureFunction as we need to make sure the performance does not regress here. Feel free to ask @OlimpiaZurek or @adhorodyski for help with those if needed

src/libs/BrickRoadsUtils.ts

hayata-suenaga · 2023-12-20T21:13:52Z

@WojtekBoman by the way, I'm still working on the backend API. I'll update you once the backend API PR is near completion 🙇

hayata-suenaga · 2024-01-08T23:04:13Z

is this hold on the backend API?

mountiny

@hayata-suenaga I dont think this needs to wait for the backedn api as its not used in the app. We can then use these methods and test them in another PR which will get use of it

mountiny · 2024-01-10T14:53:31Z

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

This is currently not used in the App and will be tested with the rest of the ideal nav implementation

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

hayata-suenaga

in that case, the code looks good to me

OSBotify · 2024-01-10T18:07:07Z

✋ 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-11T09:58:49Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.24-4 🚀

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

OSBotify · 2024-01-15T11:40:09Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.24-8 🚀

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

WojtekBoman added 5 commits December 18, 2023 16:21

Add BrickRoadsUtils

735fba5

Refactor getBrickRoadForPolicy return type

5cc3046

Refactor getBrickRoadForPolicy function

27f5e48

Refactor getWorkspacesBrickRoads function

0064b11

Add export type BrickRoad

7af0ac7

WojtekBoman marked this pull request as ready for review December 18, 2023 16:33

WojtekBoman requested a review from a team as a code owner December 18, 2023 16:33

melvin-bot bot requested review from fedirjh and removed request for a team December 18, 2023 16:33

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

hayata-suenaga reviewed Dec 18, 2023

View reviewed changes

WojtekBoman added 2 commits December 19, 2023 17:05

Refactor BrickRoad type, add commments in BrickRoadsUtils

e6f5941

Fix lint in BrickRoadsUtils

2f3b3bb

mountiny assigned WojtekBoman Dec 20, 2023

mountiny requested changes Dec 20, 2023

View reviewed changes

Refactor BrickRoadsUtils

e53d0c2

mountiny previously approved these changes Jan 10, 2024

View reviewed changes

Merge branch 'main' into workspaces-rbr-gbr

d655c78

WojtekBoman dismissed mountiny’s stale review via d655c78 January 10, 2024 14:30

Fix lint in BrickRoadsUtils

000049e

mountiny approved these changes Jan 10, 2024

View reviewed changes

hayata-suenaga approved these changes Jan 10, 2024

View reviewed changes

mountiny merged commit 4d2054e into Expensify:main Jan 10, 2024
16 of 17 checks passed

mountiny changed the title ~~Add BrickRoadsUtils~~ [NoQA] Add BrickRoadsUtils Jan 10, 2024

github-actions bot mentioned this pull request Jan 11, 2024

Deploy Checklist: New Expensify 2024-01-11 #34327

Closed

54 tasks

melvin-bot bot mentioned this pull request Jan 15, 2024

[HOLD for payment 2024-01-22] Check for the presence of reports that require attention and reports with errors in a given workspace. #31878

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] Add BrickRoadsUtils #33239

[NoQA] Add BrickRoadsUtils #33239

WojtekBoman commented Dec 18, 2023 •

edited

Loading

melvin-bot bot commented Dec 18, 2023

hayata-suenaga Dec 18, 2023

hayata-suenaga Dec 18, 2023

hayata-suenaga Dec 18, 2023

hayata-suenaga Dec 18, 2023

mountiny left a comment

hayata-suenaga commented Dec 20, 2023

hayata-suenaga commented Jan 8, 2024

mountiny left a comment

mountiny commented Jan 10, 2024 •

edited

Loading

hayata-suenaga left a comment

OSBotify commented Jan 10, 2024

OSBotify commented Jan 11, 2024

OSBotify commented Jan 15, 2024

[NoQA] Add BrickRoadsUtils #33239

[NoQA] Add BrickRoadsUtils #33239

Conversation

WojtekBoman commented Dec 18, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 18, 2023

hayata-suenaga Dec 18, 2023

Choose a reason for hiding this comment

hayata-suenaga Dec 18, 2023

Choose a reason for hiding this comment

hayata-suenaga Dec 18, 2023

Choose a reason for hiding this comment

hayata-suenaga Dec 18, 2023

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

hayata-suenaga commented Dec 20, 2023

hayata-suenaga commented Jan 8, 2024

mountiny left a comment

Choose a reason for hiding this comment

mountiny commented Jan 10, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 10, 2024

OSBotify commented Jan 11, 2024

OSBotify commented Jan 15, 2024

WojtekBoman commented Dec 18, 2023 •

edited

Loading

mountiny commented Jan 10, 2024 •

edited

Loading