Client-side violations for money request updates

src/libs/ViolationsUtils.ts

@@ -2,7 +2,7 @@ import reject from 'lodash/reject';
 import Onyx from 'react-native-onyx';
 import type {TranslationPaths} from '@src/languages/types';
 import ONYXKEYS from '@src/ONYXKEYS';
-import type {PolicyCategories, PolicyTags, Transaction, TransactionViolation} from '@src/types/onyx';
+import type {MaybePolicyTagList, PolicyCategories, Transaction, TransactionViolation} from '@src/types/onyx';
 import type {Phrase, PhraseParameters} from './Localize';
 
 const ViolationsUtils = {
@@ -11,10 +11,10 @@ const ViolationsUtils = {
      * violations.
      */
     getViolationsOnyxData(
-        transaction: Transaction,
+        updatedTransaction: Transaction,
         transactionViolations: TransactionViolation[],
         policyRequiresTags: boolean,
-        policyTags: PolicyTags,
+        policyTagList: MaybePolicyTagList,
         policyRequiresCategories: boolean,
         policyCategories: PolicyCategories,
     ): {
@@ -27,15 +27,15 @@ const ViolationsUtils = {
         if (policyRequiresCategories) {
             const hasCategoryOutOfPolicyViolation = transactionViolations.some((violation) => violation.name === 'categoryOutOfPolicy');
             const hasMissingCategoryViolation = transactionViolations.some((violation) => violation.name === 'missingCategory');
-            const isCategoryInPolicy = Boolean(policyCategories[transaction.category]?.enabled);
+            const isCategoryInPolicy = Boolean(policyCategories[updatedTransaction.category]?.enabled);
 
             // Add 'categoryOutOfPolicy' violation if category is not in policy
-            if (!hasCategoryOutOfPolicyViolation && transaction.category && !isCategoryInPolicy) {
+            if (!hasCategoryOutOfPolicyViolation && updatedTransaction.category && !isCategoryInPolicy) {
                 newTransactionViolations.push({name: 'categoryOutOfPolicy', type: 'violation', userMessage: ''});
             }
 
             // Remove 'categoryOutOfPolicy' violation if category is in policy
-            if (hasCategoryOutOfPolicyViolation && transaction.category && isCategoryInPolicy) {
+            if (hasCategoryOutOfPolicyViolation && updatedTransaction.category && isCategoryInPolicy) {
                 newTransactionViolations = reject(newTransactionViolations, {name: 'categoryOutOfPolicy'});
             }
 
@@ -45,23 +45,25 @@ const ViolationsUtils = {
             }
 
             // Add 'missingCategory' violation if category is required and not set
-            if (!hasMissingCategoryViolation && policyRequiresCategories && !transaction.category) {
+            if (!hasMissingCategoryViolation && policyRequiresCategories && !updatedTransaction.category) {
                 newTransactionViolations.push({name: 'missingCategory', type: 'violation', userMessage: ''});
             }
         }
 
         if (policyRequiresTags) {
+            const policyTagListName = Object.keys(policyTagList)[0];
+            const policyTags = policyTagList[policyTagListName]?.tags;
             const hasTagOutOfPolicyViolation = transactionViolations.some((violation) => violation.name === 'tagOutOfPolicy');
             const hasMissingTagViolation = transactionViolations.some((violation) => violation.name === 'missingTag');
-            const isTagInPolicy = Boolean(policyTags[transaction.tag]?.enabled);
+            const isTagInPolicy = Boolean(policyTags?.[updatedTransaction.tag]?.enabled);
 
             // Add 'tagOutOfPolicy' violation if tag is not in policy
-            if (!hasTagOutOfPolicyViolation && transaction.tag && !isTagInPolicy) {
+            if (!hasTagOutOfPolicyViolation && updatedTransaction.tag && !isTagInPolicy) {
                 newTransactionViolations.push({name: 'tagOutOfPolicy', type: 'violation', userMessage: ''});
             }
 
             // Remove 'tagOutOfPolicy' violation if tag is in policy
-            if (hasTagOutOfPolicyViolation && transaction.tag && isTagInPolicy) {
+            if (hasTagOutOfPolicyViolation && updatedTransaction.tag && isTagInPolicy) {
                 newTransactionViolations = reject(newTransactionViolations, {name: 'tagOutOfPolicy'});
             }
 
@@ -71,14 +73,14 @@ const ViolationsUtils = {
             }
 
             // Add 'missingTag violation' if tag is required and not set
-            if (!hasMissingTagViolation && !transaction.tag && policyRequiresTags) {
+            if (!hasMissingTagViolation && !updatedTransaction.tag && policyRequiresTags) {
                 newTransactionViolations.push({name: 'missingTag', type: 'violation', userMessage: ''});
             }
         }
 
         return {
             onyxMethod: Onyx.METHOD.SET,
-            key: `${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${transaction.transactionID}`,
+            key: `${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${updatedTransaction.transactionID}`,
             value: newTransactionViolations,
         };
     },

src/libs/actions/IOU.js

@@ -341,7 +341,7 @@ function buildOnyxDataForMoneyRequest(
     optimisticPolicyRecentlyUsedTags,
     isNewChatReport,
     isNewIOUReport,
-    policy,
+    policy = {},
     policyTags,
     policyCategories,
     hasOutstandingChildRequest = false,
@@ -918,13 +918,16 @@ function createDistanceRequest(report, participant, comment, created, category,
  * @param {String} transactionThreadReportID
  * @param {Object} transactionChanges
  * @param {String} [transactionChanges.created] Present when updated the date field
+ * @param {Object} policy - May be undefined, an empty object, or an object matching the Policy type (src/types/onyx/Policy.ts)
+ * @param {Array} policyTags
+ * @param {Array} policyCategories
  * @param {Boolean} onlyIncludeChangedFields
  *                      When 'true', then the returned params will only include the transaction details for the fields that were changed.
  *                      When `false`, then the returned params will include all the transaction details, regardless of which fields were changed.
  *                      This setting is necessary while the UpdateDistanceRequest API is refactored to be fully 1:1:1 in https://github.com/Expensify/App/issues/28358
  * @returns {object}
  */
-function getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, onlyIncludeChangedFields) {
+function getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, policy = {}, policyTags, policyCategories, onlyIncludeChangedFields) {
     const optimisticData = [];
     const successData = [];
     const failureData = [];
@@ -1050,6 +1053,14 @@ function getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, t
         }
     }
 
+    // Add optimistic transaction violations if there is a policy
+    const currentTransactionViolations = allTransactionViolations[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${transactionID}`];
+    if (policy && policy.id) {
+        optimisticData.push(
+            ViolationsUtils.getViolationsOnyxData(updatedTransaction, currentTransactionViolations, policy.requiresTag, policyTags, policy.requiresCategory, policyCategories),
+        );
+    }
+
     // Clear out the error fields and loading states on success
     successData.push({
         onyxMethod: Onyx.METHOD.MERGE,
@@ -1088,6 +1099,15 @@ function getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, t
         value: iouReport,
     });
 
+    // If there is a policy, restore transaction violations to their original state
+    if (policy && policy.id) {
+        failureData.push({
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: `${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${transactionID}`,
+            value: currentTransactionViolations,
+        });
+    }
+
     return {
         params,
         onyxData: {optimisticData, successData, failureData},
@@ -1100,12 +1120,15 @@ function getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, t
  * @param {String} transactionID
  * @param {String} transactionThreadReportID
  * @param {String} val
+ * @param {Object} policy - May be undefined, an empty object, or an object matching the Policy type (src/types/onyx/Policy.ts)
+ * @param {Array} policyTags
+ * @param {Array} policyCategories
  */
-function updateMoneyRequestDate(transactionID, transactionThreadReportID, val) {
+function updateMoneyRequestDate(transactionID, transactionThreadReportID, val, policy, policyTags, policyCategories) {
     const transactionChanges = {
         created: val,
     };
-    const {params, onyxData} = getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, true);
+    const {params, onyxData} = getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, policy, policyTags, policyCategories, true);
     API.write('UpdateMoneyRequestDate', params, onyxData);
 }
 
@@ -1130,12 +1153,15 @@ function updateMoneyRequestBillable(transactionID, transactionThreadReportID, va
  * @param {String} transactionID
  * @param {Number} transactionThreadReportID
  * @param {String} val
+ * @param {Object} policy - May be undefined, an empty object, or an object matching the Policy type (src/types/onyx/Policy.ts)
+ * @param {Array} policyTags
+ * @param {Array} policyCategories
  */
-function updateMoneyRequestMerchant(transactionID, transactionThreadReportID, val) {
+function updateMoneyRequestMerchant(transactionID, transactionThreadReportID, val, policy, policyTags, policyCategories) {
     const transactionChanges = {
         merchant: val,
     };
-    const {params, onyxData} = getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, true);
+    const {params, onyxData} = getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, policy, policyTags, policyCategories, true);
     API.write('UpdateMoneyRequestMerchant', params, onyxData);
 }
 
@@ -1145,12 +1171,15 @@ function updateMoneyRequestMerchant(transactionID, transactionThreadReportID, va
  * @param {String} transactionID
  * @param {Number} transactionThreadReportID
  * @param {String} tag
+ * @param {Object} policy - May be undefined, an empty object, or an object matching the Policy type (src/types/onyx/Policy.ts)
+ * @param {Array} policyTags
+ * @param {Array} policyCategories
  */
-function updateMoneyRequestTag(transactionID, transactionThreadReportID, tag) {
+function updateMoneyRequestTag(transactionID, transactionThreadReportID, tag, policy, policyTags, policyCategories) {
     const transactionChanges = {
         tag,
     };
-    const {params, onyxData} = getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, true);
+    const {params, onyxData} = getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, policy, policyTags, policyCategories, true);
     API.write('UpdateMoneyRequestTag', params, onyxData);
 }
 
@@ -1164,10 +1193,12 @@ function updateMoneyRequestTag(transactionID, transactionThreadReportID, tag) {
  * @param {Number} [transactionChanges.amount]
  * @param {Object} [transactionChanges.comment]
  * @param {Object} [transactionChanges.waypoints]
- *
+ * @param {Object} policy - May be undefined, an empty object, or an object matching the Policy type (src/types/onyx/Policy.ts)
+ * @param {Array} policyTags
+ * @param {Array} policyCategories
  */
-function updateDistanceRequest(transactionID, transactionThreadReportID, transactionChanges) {
-    const {params, onyxData} = getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, false);
+function updateDistanceRequest(transactionID, transactionThreadReportID, transactionChanges, policy, policyTags, policyCategories) {
+    const {params, onyxData} = getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, policy, policyTags, policyCategories, false);
     API.write('UpdateDistanceRequest', params, onyxData);
 }
 
@@ -2185,8 +2216,11 @@ function setDraftSplitTransaction(transactionID, transactionChanges = {}) {
  * @param {String} transactionID
  * @param {Number} transactionThreadReportID
  * @param {Object} transactionChanges
+ * @param {Object} policy - May be undefined, an empty object, or an object matching the Policy type (src/types/onyx/Policy.ts)
+ * @param {Array} policyTags
+ * @param {Array} policyCategories
  */
-function editRegularMoneyRequest(transactionID, transactionThreadReportID, transactionChanges) {
+function editRegularMoneyRequest(transactionID, transactionThreadReportID, transactionChanges, policy = {}, policyTags, policyCategories) {
     // STEP 1: Get all collections we're updating
     const transactionThread = allReports[`${ONYXKEYS.COLLECTION.REPORT}${transactionThreadReportID}`];
     const transaction = allTransactions[`${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`];
@@ -2396,6 +2430,25 @@ function editRegularMoneyRequest(transactionID, transactionThreadReportID, trans
         },
     ];
 
+    // Add transaction violations if there is a policy
+    if (policy && policy.id) {
+        const currentTransactionViolations = allTransactionViolations[`${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${transactionID}`];
+        const updatedViolationsOnyxData = ViolationsUtils.getViolationsOnyxData(
+            updatedTransaction,
+            currentTransactionViolations,
+            policy.requiresTag,
+            policyTags,
+            policy.requiresCategory,
+            policyCategories,
+        );
+        optimisticData.push(updatedViolationsOnyxData);
+        failureData.push({
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: `${ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS}${transactionID}`,
+            value: currentTransactionViolations,
+        });
+    }
+
     // STEP 6: Call the API endpoint
     const {created, amount, currency, comment, merchant, category, billable, tag} = ReportUtils.getTransactionDetails(updatedTransaction);
     API.write(
@@ -2420,12 +2473,15 @@ function editRegularMoneyRequest(transactionID, transactionThreadReportID, trans
  * @param {object} transaction
  * @param {String} transactionThreadReportID
  * @param {Object} transactionChanges
+ * @param {Object} policy - May be undefined, an empty object, or an object matching the Policy type (src/types/onyx/Policy.ts)
+ * @param {Array} policyTags
+ * @param {Array} policyCategories
  */
-function editMoneyRequest(transaction, transactionThreadReportID, transactionChanges) {
+function editMoneyRequest(transaction, transactionThreadReportID, transactionChanges, policy, policyTags, policyCategories) {
     if (TransactionUtils.isDistanceRequest(transaction)) {
-        updateDistanceRequest(transaction.transactionID, transactionThreadReportID, transactionChanges);
+        updateDistanceRequest(transaction.transactionID, transactionThreadReportID, transactionChanges, policy, policyTags, policyCategories);
     } else {
-        editRegularMoneyRequest(transaction.transactionID, transactionThreadReportID, transactionChanges);
+        editRegularMoneyRequest(transaction.transactionID, transactionThreadReportID, transactionChanges, policy, policyTags, policyCategories);
     }
 }
 
@@ -2436,13 +2492,16 @@ function editMoneyRequest(transaction, transactionThreadReportID, transactionCha
  * @param {String} transactionThreadReportID
  * @param {String} currency
  * @param {Number} amount
+ * @param {Object} policy - May be undefined, an empty object, or an object matching the Policy type (src/types/onyx/Policy.ts)
+ * @param {Array} policyTags
+ * @param {Array} policyCategories
  */
-function updateMoneyRequestAmountAndCurrency(transactionID, transactionThreadReportID, currency, amount) {
+function updateMoneyRequestAmountAndCurrency(transactionID, transactionThreadReportID, currency, amount, policy, policyTags, policyCategories) {
     const transactionChanges = {
         amount,
         currency,
     };
-    const {params, onyxData} = getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, true);
+    const {params, onyxData} = getUpdateMoneyRequestParams(transactionID, transactionThreadReportID, transactionChanges, policy, policyTags, policyCategories, true);
     API.write('UpdateMoneyRequestAmountAndCurrency', params, onyxData);
 }