Implement ViolationUtils lib #31656

trevor-coleman · 2023-11-21T20:53:47Z

Details

This PR implements the ViolationUtils lib, as specified in this issue.

Notes on Implementation

Created useViolationsHook for use in `get

I wrapped getViolationsForField in a hook to make it more idiomatic for react.

Changes to Onyx Types

Added PolicyCategories type

needed for getViolationsOnyxData
used PolicyTags as an example

Added `TRANSACTION_VIOLATIONS` to `ONXYKEYS.COLLECTION`

used transactionViolations_ to follow the pattern

Created `TransactionViolation` and related types

Created the TransactionViolation type and string literal unions for the various types as discussed here

Fixed Issues

$ #31083

Tests

Unit tests are provided

Verify that no errors appear in the JS console

Offline tests

This code is not called yet by the application, so there is no way to test it.

QA Steps

This code is not called yet by the application, so there is no way to test it.

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 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 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(themeColors.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 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

No visible changes

…ypes/onyx

…xData

…ation-utils Implement ViolationUtils lib Expensify#31083

github-actions · 2023-11-21T20:54:01Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

trevor-coleman · 2023-11-21T20:56:04Z

I have read the CLA Document and I hereby sign the CLA

…ons/violation-utils # Conflicts: # src/ONYXKEYS.ts

…tions/violation-utils

# Conflicts: # src/ONYXKEYS.ts

melvin-bot · 2023-11-22T17:20:06Z

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

situchan · 2023-11-22T17:22:41Z

I see that there is no way to test it but is is possible to have temporary test by manually changing some code locally?

trevor-coleman · 2023-11-27T17:37:15Z

Not really -- it doesn't have any effects on the user interface.

These are essentially helper functions. There are some other PRs coming that will call this code and it will be tested as part of those.

trevor-coleman · 2023-11-27T17:39:31Z

For instance this issue relies on this code and will call it: #31084

cead22

Can you add unit tests for getViolationForField and getViolationsOnyxData?

src/types/onyx/TransactionViolation.ts

src/libs/Violations/index.ts

src/types/onyx/TransactionViolation.ts

src/libs/Violations/ViolationsUtils.ts

Add all possible violations Co-authored-by: Carlos Alvarez <cead22@gmail.com>

situchan · 2023-11-28T16:53:52Z

src/libs/Violations/ViolationsUtils.ts

+
+const ViolationsUtils = {
+    getViolationForField(transactionViolations: TransactionViolation[], field: ViolationField, translate: (key: string) => string): string[] {
+        return transactionViolations.filter((violation) => possibleViolationsByField[field]?.includes(violation.name)).map((violation) => translate(violation.name));


I also don't like using lodash/invertBy

src/libs/Violations/possibleViolationsByField.ts

src/types/onyx/TransactionViolation.ts

src/libs/Violations/ViolationsUtils.ts

fix: improve JSDoc on getViolationsOnyxData Co-authored-by: Carlos Alvarez <cead22@gmail.com>

situchan · 2023-12-02T03:57:03Z

sure, will do during weekend

Co-authored-by: Carlos Alvarez <cead22@gmail.com>

cead22 · 2023-12-04T17:19:49Z

@situchan do you think you'll be able to review today?

situchan · 2023-12-04T17:22:18Z

yes on it now

src/languages/en.ts

src/libs/Violations/useViolations.ts

Co-authored-by: Carlos Alvarez <cead22@gmail.com>

…utils

situchan · 2023-12-04T20:34:17Z

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(themeColors.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 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

test.mov

MacOS: Desktop

situchan

App working fine after injecting useViolations hook in any component rendered during app play

Please update issue title to [No QA] so that QA team won't get confused what to test

melvin-bot · 2023-12-04T20:36:38Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #31083 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

trevor-coleman · 2023-12-04T22:22:51Z

Applied prettier and merged main.

OSBotify · 2023-12-04T23:06:29Z

✋ 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 · 2023-12-05T02:55:56Z

🚀 Cherry-picked to staging by https://github.com/yuwenmemon in version: 1.4.7-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-12-05T13:41:01Z

🚀 Deployed to staging by https://github.com/cead22 in version: 1.4.8-0 🚀

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

OSBotify · 2023-12-06T20:31:06Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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

OSBotify · 2023-12-06T20:40:38Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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

trevor-coleman added 8 commits November 17, 2023 16:37

feat(Violations): Add PolicyCategories type to match PolicyTags

f251978

feat(Violations): Create stub for ViolationUtils

51c2e7e

feat(Violations): Add TRANSACTION_VIOLATION to ONYXKEYS.COLLECTIONS

f001066

feat(Violations): Add TransactionViolation and related types to src/t…

2705280

…ypes/onyx

feat(Violations): create possibleViolationsByField lookup

e2aaa6a

feat(Violations): implement getViolationForField and getViolationsOny…

7f39f5a

…xData

prettier

ccb4206

Merge pull request #73 from infinitered/trevorcoleman/violations/viol…

6a67fb8

…ation-utils Implement ViolationUtils lib Expensify#31083

trevor-coleman added 7 commits November 21, 2023 16:10

feat(Violations): remove unnecessary callback

0a04347

Merge remote-tracking branch 'origin/main' into trevorcoleman/violati…

15f43ba

…ons/violation-utils # Conflicts: # src/ONYXKEYS.ts

update package-lock.json

575ea9b

Merge remote-tracking branch 'upstream/main' into trevorcoleman/viola…

17ef290

…tions/violation-utils

Merge remote-tracking branch 'upstream/main' into violation-utils

cf65dbe

# Conflicts: # src/ONYXKEYS.ts

restore package-lock.json

0353afa

Merge remote-tracking branch 'upstream/main' into violation-utils

8c16f79

trevor-coleman marked this pull request as ready for review November 22, 2023 17:20

trevor-coleman requested a review from a team as a code owner November 22, 2023 17:20

melvin-bot bot requested review from situchan and removed request for a team November 22, 2023 17:20

trevor-coleman mentioned this pull request Nov 22, 2023

Implement ViolationUtils lib #31083

Closed

cead22 requested changes Nov 28, 2023

View reviewed changes

Update src/types/onyx/TransactionViolation.ts

1e2e7c8

Add all possible violations Co-authored-by: Carlos Alvarez <cead22@gmail.com>

situchan reviewed Nov 28, 2023

View reviewed changes

Update src/libs/Violations/ViolationsUtils.ts

0c8d067

fix: improve JSDoc on getViolationsOnyxData Co-authored-by: Carlos Alvarez <cead22@gmail.com>

cead22 mentioned this pull request Dec 2, 2023

Clean up Violation tests #32395

Closed

Update tests/unit/ViolationUtilsTest.js

27cfac1

Co-authored-by: Carlos Alvarez <cead22@gmail.com>

trevor-coleman dismissed cead22’s stale review via 27cfac1 December 4, 2023 16:34

situchan reviewed Dec 4, 2023

View reviewed changes

src/languages/en.ts Show resolved Hide resolved

src/libs/Violations/useViolations.ts Outdated Show resolved Hide resolved

trevor-coleman and others added 4 commits December 4, 2023 13:41

feat(Violations): Suggested changes from PR Review

e5ae614

Co-authored-by: Carlos Alvarez <cead22@gmail.com>

feat(Violations): remove useViolationsTest

8498e80

feat(Violations): fixes from PR Comments

e6e7612

Merge remote-tracking branch 'origin/violation-utils' into violation-…

0aa36b8

…utils

situchan approved these changes Dec 4, 2023

View reviewed changes

melvin-bot bot requested a review from marcaaron December 4, 2023 20:36

cead22 previously approved these changes Dec 4, 2023

View reviewed changes

cead22 removed the request for review from marcaaron December 4, 2023 20:54

prettier

391822c

trevor-coleman dismissed cead22’s stale review via 391822c December 4, 2023 22:01

Merge remote-tracking branch 'upstream/main' into violation-utils

dd48fe1

feat(Violations): remove useViolationsTest

d2cfd33

cead22 approved these changes Dec 4, 2023

View reviewed changes

cead22 merged commit b5e83fa into Expensify:main Dec 4, 2023
15 checks passed

github-actions bot mentioned this pull request Dec 5, 2023

Deploy Checklist: New Expensify 2023-12-05 #32463

Closed

66 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement ViolationUtils lib #31656

Implement ViolationUtils lib #31656

trevor-coleman commented Nov 21, 2023 •

edited

Loading

github-actions bot commented Nov 21, 2023 •

edited

Loading

trevor-coleman commented Nov 21, 2023

melvin-bot bot commented Nov 22, 2023

situchan commented Nov 22, 2023

trevor-coleman commented Nov 27, 2023 •

edited

Loading

trevor-coleman commented Nov 27, 2023

cead22 left a comment

situchan Nov 28, 2023

situchan commented Dec 2, 2023

cead22 commented Dec 4, 2023

situchan commented Dec 4, 2023

situchan commented Dec 4, 2023

situchan left a comment

melvin-bot bot commented Dec 4, 2023

trevor-coleman commented Dec 4, 2023

OSBotify commented Dec 4, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

Implement ViolationUtils lib #31656

Implement ViolationUtils lib #31656

Conversation

trevor-coleman commented Nov 21, 2023 • edited Loading

Details

Notes on Implementation

Changes to Onyx Types

Added TRANSACTION_VIOLATIONS to ONXYKEYS.COLLECTION

Created TransactionViolation and related types

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Nov 21, 2023 • edited Loading

trevor-coleman commented Nov 21, 2023

melvin-bot bot commented Nov 22, 2023

situchan commented Nov 22, 2023

trevor-coleman commented Nov 27, 2023 • edited Loading

trevor-coleman commented Nov 27, 2023

cead22 left a comment

Choose a reason for hiding this comment

situchan Nov 28, 2023

Choose a reason for hiding this comment

situchan commented Dec 2, 2023

cead22 commented Dec 4, 2023

situchan commented Dec 4, 2023

situchan commented Dec 4, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 4, 2023

trevor-coleman commented Dec 4, 2023

OSBotify commented Dec 4, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

trevor-coleman commented Nov 21, 2023 •

edited

Loading

Added `TRANSACTION_VIOLATIONS` to `ONXYKEYS.COLLECTION`

Created `TransactionViolation` and related types

github-actions bot commented Nov 21, 2023 •

edited

Loading

trevor-coleman commented Nov 27, 2023 •

edited

Loading