Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add violation logic for multi level tags #37461

Merged
merged 24 commits into from
Mar 8, 2024
Merged

Add violation logic for multi level tags #37461

merged 24 commits into from
Mar 8, 2024

Conversation

cead22
Copy link
Contributor

@cead22 cead22 commented Feb 29, 2024

Details

Fixed Issues

$ #37117
PROPOSAL:

Tests

  • In old dot, in the workspace editor > tags tab, switch on the Use multiple levels of tags toggle
  • Click import from spreadsheet, and upload the file in this issue description
  • On new dot, tap big plus sign > request money
  • Select Manual tab (from Manual | Scan | Distance)
  • Enter $15 as the amount amount and tap next
  • Tap the workspace from the pre-testing steps (tap the row, not the split button in the row)
  • Tap the merchant row and enter a merchant
  • Tap the Request $15 button
  • Confirm the report preview has RBR
  • Tap the report preview
  • Confirm the money request preview has RBR and shows “Review Required”
  • Tap the money request preview
    • Verify you see Missing Region, Missing Project, and Missing Department violations
  • Tap the Region menu item, and select a region
    • Verify that the Missing Region violation disappears right away
  • Repeat for Department and Project
  • Tap the Region menu item, and unselect the selected region
    • Verify that the Missing Region violation appears right away
  • 🛜 Switch to new dot and go offline
  • Repeat steps 1-16. The report preview, money request preview should be grayed out
  • Go online, and confirm everything looks the same, except nothing is grayed out
  • Click on the link in the transaction thread header to go back to the expense report
    • Verify the money request preview says Missing Region next to the RBR
  • Verify that no errors appear in the JS console

Offline tests

Covered in tests

QA Steps

Same as tests

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

Screenshots/Videos

Android: Native
nativeandroid.mp4
Android: mWeb Chrome

I'm having issues running the app on android web, so will rely on reviewer testing this platform

iOS: Native
nativeios.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari

Online

desktopweboffline.mp4

Offline

https://github.com/Expensify/App/assets/165133/363e8b52-b5c9-4b36-b8b0-1ad9f3cb02b3 x

MacOS: Desktop
desktop.mp4

@cead22 cead22 self-assigned this Feb 29, 2024
@cead22 cead22 marked this pull request as ready for review March 5, 2024 00:57
@cead22 cead22 requested a review from a team as a code owner March 5, 2024 00:57
@melvin-bot melvin-bot bot removed the request for review from a team March 5, 2024 00:57
Copy link

melvin-bot bot commented Mar 5, 2024

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

@melvin-bot melvin-bot bot requested a review from DylanDylann March 5, 2024 00:57
@cead22
Copy link
Contributor Author

cead22 commented Mar 5, 2024

cc @yuwenmemon @allroundexperts since you reviewed #34983

@cead22 cead22 requested review from parasharrajat and removed request for parasharrajat March 5, 2024 01:09
@cead22
Copy link
Contributor Author

cead22 commented Mar 5, 2024

Sorry for the back and forth @parasharrajat , I thought I had linked to this PR in this issue #36441, which you had asked to be a reviewer on, but I had linked a different PR

@DylanDylann
Copy link
Contributor

@cead22 I was assigned to this PR by Melvin. Should I review this PR?

@allroundexperts
Copy link
Contributor

I think it would be better if I review this since I have good context on this.

@cead22 cead22 requested review from allroundexperts and removed request for DylanDylann March 5, 2024 16:48
@cead22
Copy link
Contributor Author

cead22 commented Mar 7, 2024

Updated

Comment on lines 124 to 126
newTransactionViolations = reject(newTransactionViolations, {
name: CONST.VIOLATIONS.TAG_OUT_OF_POLICY,
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

filter can be used here as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no difference here since we're only calling reject once, so it should go over the array only once, right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but aren't we preferring native JS methods for filtering after TS migration?

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good other than a NAB change that is upon the engineers discretion to fix.

@melvin-bot melvin-bot bot requested a review from blimpich March 8, 2024 13:55
Copy link

melvin-bot bot commented Mar 8, 2024

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

blimpich
blimpich previously approved these changes Mar 8, 2024
Copy link
Contributor

@blimpich blimpich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB comments, otherwise looks good 👍

errorIndexes.push(i);
}
}
if (errorIndexes.length !== 0) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB: since 0 is falsy in JS this can be simplified.

Suggested change
if (errorIndexes.length !== 0) {
if (errorIndexes.length) {

required: true,
},
};
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB: can we add a line break in between tests?

result = ViolationsUtils.getViolationsOnyxData(transaction, transactionViolations, policyRequiresTags, policyTags, policyRequiresCategories, policyCategories);
expect(result.value).toEqual([]);
});
it('should return tagOutOfPolicy when a tag is not enabled in the policy but is set in the transaction', () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB: can we add a line break in between tests?

@@ -201,4 +196,77 @@ describe('getViolationsOnyxData', () => {
expect(result.value).not.toContainEqual([missingTagViolation]);
});
});
describe('policy has multi level tags', () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB: can we add a line break in between describe statements?

hasInvalidTag = true;
break;
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB Can we add some line breaks to the new code for readability?

@@ -78,6 +79,53 @@ const ViolationsUtils = {
if (!hasMissingTagViolation && !updatedTransaction.tag && policyRequiresTags) {
newTransactionViolations.push({name: CONST.VIOLATIONS.MISSING_TAG, type: 'violation'});
}
} else {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB: can we consider extracting some part of this new code into a helper function? I find the logic hard to follow with all the if/else/for statements nested together. Abstracting out some of the logic would make this a lot more readable IMO.

@cead22
Copy link
Contributor Author

cead22 commented Mar 8, 2024

Updated! Please re-review. @blimpich I'm taking the NAB that I didn't reply to as non-blockers

  • I kinda like the explicitness of errorIndexes.length !== 0
  • Our style guide says not to add blank lines to separate code, and only add blank lines that are going to be followed by comments. Is searched usages of it and describe and it looks like we have a combination of having blank lines and no blank lines

@blimpich
Copy link
Contributor

blimpich commented Mar 8, 2024

Sounds good! @cead22 can you help me find that style guide? I can't find one that mentions that we prefer to not use newlines to separate code.

@blimpich blimpich merged commit 4ada067 into main Mar 8, 2024
15 checks passed
@blimpich blimpich deleted the carlos-multitags branch March 8, 2024 20:03
@OSBotify
Copy link
Contributor

OSBotify commented Mar 8, 2024

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@cead22
Copy link
Contributor Author

cead22 commented Mar 9, 2024

Yes, but aren't we preferring native JS methods for filtering after TS migration?

I meant to address this but forgot 😬

@cead22
Copy link
Contributor Author

cead22 commented Mar 9, 2024

@blimpich I thought it was in our general style guides, but it looks like it's on our php style guide https://github.com/Expensify/Style-Guides/blob/4a2750183223b1f84398e0c1c633fa95a7512841/php.md#blank-lines

Unnecessary blank lines without comments should be avoided

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.50-5 🚀

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

/**
* Calculates some tag levels required and missing tag violations for the given transaction
*/
function getTagViolationsForMultiLevelTags(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi team, come from #38095, this function was missing to handle multilevel dependent tags cases.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This wasn't really missing, as much as it just hadn't been implemented yet. When we added support for multi level tags, we broke the violations for tags, and this PR was meant to fix that.

We then added support for dependent tags, and then implemented getTagViolationsForDependentTags and getTagViolationForIndependentTags in https://github.com/Expensify/App/pull/40741/files

policyTagList: PolicyTagList,
): TransactionViolation[] {
const policyTagKeys = Object.keys(policyTagList);
const selectedTags = updatedTransaction.tag?.split(CONST.COLON) ?? [];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should have split the tags using getTagArrayFromName method instead. The split function fails if a tag contains more than one :. This caused #50105

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants