feat: addition check for negative case fulfillment an ditem

ONDC-Official · Nov 22, 2024 · 31fcd83 · 31fcd83
1 parent 4a45b2b
commit 31fcd83
Show file tree

Hide file tree

Showing 13 changed files with 184 additions and 129 deletions.
diff --git a/shared/Actions/metroActions.ts b/shared/Actions/metroActions.ts
@@ -77,7 +77,7 @@ export function validateLogsForMetro(data: any, flowName: string) {
     }
 
     if (data[metroSequence.ON_INIT]) {
-      const searchResp = checkOnInit(data[metroSequence.ON_INIT], msgIdSet)
+      const searchResp = checkOnInit(data[metroSequence.ON_INIT], msgIdSet, flow)
       if (!_.isEmpty(searchResp)) {
         logReport = { ...logReport, [metroSequence.ON_INIT]: searchResp }
       }

diff --git a/utils/metro/cancel.ts b/utils/metro/cancel.ts
@@ -21,7 +21,7 @@ export const checkCancelPayload = (data: any, msgIdSet: any, cancelType: boolean
     const contextRes: any = validateContext(
       context,
       msgIdSet,
-      cancelType ? metroSequence?.SOFT_CANCEL : constants.ON_CONFIRM,
+      cancelType ? metroSequence?.SOFT_ON_CANCEL : constants.ON_CONFIRM,
       cancelType ? metroSequence?.CONFIRM_CANCEL : metroSequence?.SOFT_CANCEL,
     )
     setValue(`${constants.CANCEL}_message`, message)

diff --git a/utils/metro/metroChecks.ts b/utils/metro/metroChecks.ts
@@ -26,7 +26,7 @@ interface Stop {
   parent_stop_id: string
 }
 
-export const validateContext = (context: any, msgIdSet: any, pastCall: any, curentCall: any) => {
+export const validateContext = (context: any, msgIdSet: any, pastCall: any, curentCall: any, searchType?: boolean) => {
   const errorObj: any = {}
 
   const contextRes: any = checkMetroContext(context, curentCall)
@@ -65,13 +65,17 @@ export const validateContext = (context: any, msgIdSet: any, pastCall: any, cure
     }
 
     if (prevContext) {
-      if (pastCall !== 'search') {
-        if (!_.isEqual(prevContext.bpp_id, context.bpp_id)) {
+      if (context?.action !== 'search' || (context?.action === 'search' && searchType)) {
+        if (!context?.bpp_id) {
+          errorObj.bppId = 'context/bpp_id is missing'
+        } else if (prevContext.bpp_id && !_.isEqual(prevContext.bpp_id, context.bpp_id)) {
           errorObj.bppIdContextMismatch = `BPP Id mismatch in /${pastCall} and /${curentCall}`
         }
 
-        if (!_.isEqual(prevContext.bpp_uri, context.bpp_uri)) {
-          errorObj.bppUriContextMismatch = `BPP URI mismatch in /${pastCall} and /${curentCall}`
+        if (!context?.bpp_uri) {
+          errorObj.bppUri = 'context/bpp_uri is missing'
+        } else if (prevContext.bpp_uri && !_.isEqual(prevContext.bpp_uri, context.bpp_uri)) {
+          errorObj.bppUriContextMismatch = `BPP URL mismatch in /${pastCall} and /${curentCall}`
         }
       }
 
@@ -121,19 +125,19 @@ export const validateContext = (context: any, msgIdSet: any, pastCall: any, cure
 
     try {
       logger.info(`Comparing Message Ids of /${pastCall} and /${curentCall}`)
-      if (curentCall.startsWith('on_')) {
+      if (curentCall.startsWith('on_') || curentCall === 'soft_on_cancel' || curentCall === 'confirm_on_cancel') {
         logger.info(`Comparing Message Ids of /${pastCall} and /${curentCall}`)
         if (!_.isEqual(prevContext.message_id, context.message_id)) {
-          errorObj.message_id = `Message Id for /${pastCall} and /${curentCall} api should be same`
+          errorObj.message_id = `Message Id for /${pastCall} and /${curentCall} api should be same.`
         }
       } else {
         logger.info(`Checking if Message Ids are different for /${pastCall} and /${curentCall}`)
         if (
-          pastCall !== 'on_confirm' &&
-          curentCall !== 'cancel' &&
+          pastCall === 'on_confirm' &&
+          curentCall === 'soft_cancel' &&
           _.isEqual(prevContext.message_id, context.message_id)
         ) {
-          errorObj.message_id = `Message Id for /${pastCall} and /${curentCall} api should be different`
+          errorObj.message_id = `Message Id for /${pastCall} and /${curentCall} api should be different.`
         }
       }
     } catch (error: any) {

diff --git a/utils/metro/mobilityChecks.ts b/utils/metro/mobilityChecks.ts
@@ -3,7 +3,14 @@ import { getValue, setValue } from '../../shared/dao'
 import { checkGpsPrecision, checkIdAndUri, checkMobilityContext, timestampCheck } from '../../utils'
 import _, { isNil } from 'lodash'
 
-export const validateContext = (context: any, msgIdSet: any, pastCall: any, curentCall: any, toCheck?: boolean) => {
+export const validateContext = (
+  context: any,
+  msgIdSet: any,
+  pastCall: any,
+  curentCall: any,
+  toCheck?: boolean,
+  searchType?: boolean,
+) => {
   const errorObj: any = {}
 
   const contextRes: any = checkMobilityContext(context, curentCall)
@@ -31,8 +38,7 @@ export const validateContext = (context: any, msgIdSet: any, pastCall: any, cure
     logger.info(`Comparing BAP and BPP in /${curentCall}`)
 
     let bppValidationResult
-    if(toCheck || isNil(toCheck))
-    bppValidationResult = checkIdAndUri(context?.bpp_id, context?.bpp_uri, 'bpp')
+    if (toCheck || isNil(toCheck)) bppValidationResult = checkIdAndUri(context?.bpp_id, context?.bpp_uri, 'bpp')
 
     const bapValidationResult = checkIdAndUri(context?.bap_id, context?.bap_uri, 'bap')
 
@@ -45,12 +51,16 @@ export const validateContext = (context: any, msgIdSet: any, pastCall: any, cure
     }
 
     if (prevContext) {
-      if (pastCall !== 'search') {
-        if (!_.isEqual(prevContext.bpp_id, context.bpp_id)) {
+      if (context?.action !== 'search' || (context?.action === 'search' && searchType)) {
+        if (!context?.bpp_id) {
+          errorObj.bppId = 'context/bpp_id is missing'
+        } else if (prevContext.bpp_id && !_.isEqual(prevContext.bpp_id, context.bpp_id)) {
           errorObj.bppIdContextMismatch = `BPP Id mismatch in /${pastCall} and /${curentCall}`
         }
 
-        if (!_.isEqual(prevContext.bpp_uri, context.bpp_uri)) {
+        if (!context?.bpp_uri) {
+          errorObj.bppUri = 'context/bpp_uri is missing'
+        } else if (prevContext.bpp_uri && !_.isEqual(prevContext.bpp_uri, context.bpp_uri)) {
           errorObj.bppUriContextMismatch = `BPP URL mismatch in /${pastCall} and /${curentCall}`
         }
       }

diff --git a/utils/metro/onCancel.ts b/utils/metro/onCancel.ts
@@ -36,7 +36,7 @@ export const checkOnCancelPayload = (
     const contextRes: any = validateContext(
       context,
       msgIdSet,
-      cancelType ? metroSequence?.SOFT_ON_CANCEL : metroSequence?.CONFIRM_CANCEL,
+      cancelType ? metroSequence?.CONFIRM_CANCEL : metroSequence?.SOFT_CANCEL,
       cancelType ? metroSequence?.CONFIRM_ON_CANCEL : metroSequence?.SOFT_ON_CANCEL,
     )
     setValue(`${constants.ON_CANCEL}_message`, message)

diff --git a/utils/metro/onConfirm.ts b/utils/metro/onConfirm.ts
@@ -11,9 +11,10 @@ import {
   validateStops,
   validateCancellationTerms,
 } from './metroChecks'
-import { validatePaymentTags, validateRouteInfoTags } from './tags'
+import { validatePaymentTags, validateRouteInfoTags, validateTags } from './tags'
+import { isNil } from 'lodash'
 
-const VALID_VEHICLE_CATEGORIES = ['AUTO_RICKSHAW', 'CAB', 'METRO', 'BUS', 'AIRLINE']
+// const VALID_VEHICLE_CATEGORIES = ['AUTO_RICKSHAW', 'CAB', 'METRO', 'BUS', 'AIRLINE']
 const VALID_DESCRIPTOR_CODES = ['RIDE', 'SJT', 'SESJT', 'RUT', 'PASS', 'SEAT', 'NON STOP', 'CONNECT']
 
 export const checkOnConfirm = (data: any, msgIdSet: any, flow: { flow: string; flowSet: string }) => {
@@ -89,7 +90,7 @@ export const checkOnConfirm = (data: any, msgIdSet: any, flow: { flow: string; f
       logger.info(`Validating fulfillments object for /${constants.ON_CONFIRM}`)
       let FULFILLMENT: string[] = []
       on_confirm.fulfillments.forEach((fulfillment: any, index: number) => {
-        FULFILLMENT=[...FULFILLMENT, fulfillment?.id]
+        FULFILLMENT = [...FULFILLMENT, fulfillment?.id]
         const fulfillmentKey = `fulfillments[${index}]`
 
         if (!storedFull.includes(fulfillment?.id)) {
@@ -101,11 +102,11 @@ export const checkOnConfirm = (data: any, msgIdSet: any, flow: { flow: string; f
 
         if (!fulfillment?.vehicle) {
           errorObj['Vehicle'] = 'Vehicle Object Is Missing'
-        } else {
-          if (!VALID_VEHICLE_CATEGORIES.includes(fulfillment.vehicle.category)) {
-            errorObj[`${fulfillmentKey}.vehicleCategory`] =
-              `Vehicle category should be one of ${VALID_VEHICLE_CATEGORIES}`
-          }
+        } else if (
+          fulfillment?.vehicle?.category !== (String(flow?.flow).toUpperCase() !== 'METRO' ? 'BUS' : 'METRO')
+        ) {
+          errorObj[`${fulfillmentKey}.vehicleCategory`] =
+            `Vehicle category should be ${String(flow?.flow).toUpperCase() !== 'METRO' ? 'BUS' : 'METRO'} in Fulfillment.`
         }
 
         if (fulfillment.type !== 'TRIP') {
@@ -119,18 +120,20 @@ export const checkOnConfirm = (data: any, msgIdSet: any, flow: { flow: string; f
         if (Object.keys(getStopsError).length > 0 && Object.keys(errorValue)?.length)
           Object.assign(errorObj, getStopsError)
 
-        if (fulfillment.tags) {
-          // Validate route info tags
-          if (String(flow.flow.toUpperCase()).includes('INTRACITY')) {
-            const tagsValidation = validateRouteInfoTags(fulfillment.tags)
+        if (String(flow?.flow).toUpperCase() !== 'METRO') {
+          if (!fulfillment?.tags)
+            errorObj[`ulfillment_${index}_tags`] = `Tags should be present in Fulfillment in case of Intracity.`
+          else {
+            // Validate route info tags
+            const tagsValidation = validateRouteInfoTags(fulfillment?.tags)
             if (!tagsValidation.isValid) {
               Object.assign(errorObj, { tags: tagsValidation.errors })
             }
           }
         }
       })
 
-       setValue(`${metroSequence.ON_CONFIRM}_storedFulfillments`, FULFILLMENT || [])
+      setValue(`${metroSequence.ON_CONFIRM}_storedFulfillments`, FULFILLMENT || [])
     } catch (error: any) {
       logger.error(`!!Error occcurred while checking fulfillments info in /${constants.ON_INIT},  ${error.message}`)
       return { error: error.message }
@@ -162,8 +165,8 @@ export const checkOnConfirm = (data: any, msgIdSet: any, flow: { flow: string; f
             errorObj[key] = `Price is incomplete in /items[${index}]`
           }
 
-          item.fulfillment_ids &&
-            item.fulfillment_ids.forEach((fulfillmentId: string) => {
+          item?.fulfillment_ids &&
+            item?.fulfillment_ids?.forEach((fulfillmentId: string) => {
               if (!fulfillmentIdsSet.has(fulfillmentId)) {
                 errorObj[`invalidFulfillmentId_${index}`] =
                   `Fulfillment ID should be one of the fulfillment id  '${fulfillmentId}' at index ${index} in /${constants.ON_CONFIRM} is not valid`
@@ -218,7 +221,8 @@ export const checkOnConfirm = (data: any, msgIdSet: any, flow: { flow: string; f
           const { amount, currency, transaction_id } = params
 
           if (!amount) {
-            errorObj[`payments[${i}]_params_amount`] = `payments.params.amount must be present in ${constants.ON_CONFIRM}`
+            errorObj[`payments[${i}]_params_amount`] =
+              `payments.params.amount must be present in ${constants.ON_CONFIRM}`
           } else if (amount !== paymentAmount) {
             errorObj[`payments[${i}]_params_amount`] =
               `payments.params.amount must match with the ${paymentAmount} in ${constants.ON_CONFIRM}`
@@ -228,7 +232,8 @@ export const checkOnConfirm = (data: any, msgIdSet: any, flow: { flow: string; f
             errorObj[`payments[${i}]_params_currency`] =
               `payments.params.currency must be present in ${constants.CONFIRM}`
           } else if (currency !== 'INR') {
-            errorObj[`payments[${i}]_params_currency`] = `payments.params.currency must be INR in ${constants.ON_CONFIRM}`
+            errorObj[`payments[${i}]_params_currency`] =
+              `payments.params.currency must be INR in ${constants.ON_CONFIRM}`
           }
 
           if (!transaction_id) {
@@ -282,8 +287,16 @@ export const checkOnConfirm = (data: any, msgIdSet: any, flow: { flow: string; f
 
     try {
       logger.info(`Checking cancellation terms in /${constants.ON_CONFIRM}`)
-      const cancellationErrors = validateCancellationTerms(on_confirm.cancellation_terms, constants.ON_CONFIRM)
-      Object.assign(errorObj, cancellationErrors)
+      if (String(flow?.flow)?.toUpperCase() === 'METRO') {
+        if (!on_confirm?.cancellation_terms)
+          errorObj.cancellation_terms = `cancellation_terms missing in /${constants.ON_CONFIRM}`
+        else {
+          logger.info(`Checking cancellation terms in /${constants.ON_CONFIRM}`)
+
+          const cancellationErrors = validateCancellationTerms(on_confirm?.cancellation_terms, constants.ON_CONFIRM)
+          if (!isNil(cancellationErrors)) Object.assign(errorObj, cancellationErrors)
+        }
+      }
     } catch (error: any) {
       logger.error(`!!Error while checking cancellation_terms in /${constants.ON_CONFIRM}, ${error.stack}`)
     }
@@ -298,6 +311,11 @@ export const checkOnConfirm = (data: any, msgIdSet: any, flow: { flow: string; f
       logger.error(`!!Error while checking status in message.order object  /${constants.ON_CONFIRM}, ${error.stack}`)
     }
 
+    if (String(flow?.flow)?.toUpperCase() === 'METRO' && on_confirm?.tags) {
+      const tagsValidation: { [key: string]: any } | null = validateTags(on_confirm?.tags ?? [], 0)
+      if (!isNil(tagsValidation)) Object.assign(errorObj, tagsValidation)
+    }
+
     if (!on_confirm?.created_at) errorObj.created_at = `created_at is missing in /${constants.ON_CONFIRM}`
     else if (on_confirm?.created_at !== context?.timestamp)
       errorObj.created_at = `created_at must match with context.timestamp in /${constants.ON_CONFIRM}`

diff --git a/utils/metro/onInit.ts b/utils/metro/onInit.ts
@@ -17,7 +17,6 @@ import { checkItemTime, checkProviderTime } from './validate/helper'
 import { isNil } from 'lodash'
 
 const VALID_DESCRIPTOR_CODES = ['SJT', 'SFSJT', 'RJT', 'PASS']
-const VALID_VEHICLE_CATEGORIES = ['METRO']
 export const checkOnInit = (data: any, msgIdSet: any, flow: { flow: string; flowSet: string }) => {
   try {
     const errorObj: any = {}
@@ -129,9 +128,9 @@ export const checkOnInit = (data: any, msgIdSet: any, flow: { flow: string; flow
             errorObj[`Fulfillment[${index}].id`] = `fulfillment.id missing in /${constants.ON_INIT}`
           }
 
-          if (!VALID_VEHICLE_CATEGORIES.includes(fulfillment.vehicle.category)) {
+          if (fulfillment?.vehicle?.category !== (String(flow?.flow).toUpperCase() !== 'METRO' ? 'BUS' : 'METRO')) {
             errorObj[`${fulfillmentKey}.vehicleCategory`] =
-              `Vehicle category should be one of ${VALID_VEHICLE_CATEGORIES}`
+              `Vehicle category should be ${String(flow?.flow).toUpperCase() !== 'METRO' ? 'BUS' : 'METRO'} in Fulfillment.`
           }
 
           if (fulfillment.type !== 'TRIP') {
@@ -171,7 +170,7 @@ export const checkOnInit = (data: any, msgIdSet: any, flow: { flow: string; flow
       //items null check
       if (!on_init?.items) errorObj.items = `Items missing in /${constants.ON_INIT}`
       else {
-        on_init.items.forEach((item: any, index: number) => {
+        on_init?.items?.forEach((item: any, index: number) => {
           //handle id non-existant check
           if (!item.id) errorObj[`item[${index}].id`] = `Item id missing in /${constants.ON_INIT}`
           else if (!newItemIDSValue.includes(item.id)) {
@@ -239,13 +238,15 @@ export const checkOnInit = (data: any, msgIdSet: any, flow: { flow: string; flow
     //check cancellation_terms
     // revisit & handle external_ref check
     try {
-      if (!on_init?.cancellation_terms)
-        errorObj.cancellation_terms = `cancellation_terms missing in /${constants.ON_INIT}`
-      else {
-        logger.info(`Checking cancellation terms in /${constants.ON_INIT}`)
-
-        const cancellationErrors = validateCancellationTerms(on_init?.cancellation_terms, constants.ON_INIT)
-        if (!isNil(cancellationErrors)) Object.assign(errorObj, cancellationErrors)
+      if (String(flow?.flow)?.toUpperCase() === 'METRO') {
+        if (!on_init?.cancellation_terms)
+          errorObj.cancellation_terms = `cancellation_terms missing in /${constants.ON_INIT}`
+        else {
+          logger.info(`Checking cancellation terms in /${constants.ON_INIT}`)
+
+          const cancellationErrors = validateCancellationTerms(on_init?.cancellation_terms, constants.ON_INIT)
+          if (!isNil(cancellationErrors)) Object.assign(errorObj, cancellationErrors)
+        }
       }
     } catch (error: any) {
       logger.error(`!!Error while checking cancellation_terms in /${constants.ON_INIT}, ${error.stack}`)

diff --git a/utils/metro/search.ts b/utils/metro/search.ts
@@ -25,7 +25,14 @@ export const search = (data: any, msgIdSet: any, secondSearch: boolean, flow: {
     }
 
     const schemaValidation = validateSchema('TRV', constants.SEARCH, data)
-    const contextRes: any = validateContext(context, msgIdSet, constants.ON_SEARCH, constants.SEARCH, false)
+    const contextRes: any = validateContext(
+      context,
+      msgIdSet,
+      constants.ON_SEARCH,
+      constants.SEARCH,
+      false,
+      secondSearch,
+    )
     setValue(`${metroSequence.SEARCH1}_message`, message)
     msgIdSet.add(data.context.message_id)
 
@@ -97,13 +104,29 @@ export const search = (data: any, msgIdSet: any, secondSearch: boolean, flow: {
     try {
       logger.info(`Validating payments object for /${constants.SEARCH}`)
       const payment = data?.message?.intent?.payment
-      if (!payment?.collected_by)
-        errorObj['collected_by'] =
-          `payment.collected_by must be present in ${secondSearch ? metroSequence?.SEARCH2 : metroSequence.SEARCH1}`
 
-      const tagsValidation = validatePaymentTags(payment?.tags, secondSearch ? 'search2' : constants.SEARCH)
-      if (!tagsValidation?.isValid) {
-        Object.assign(errorObj, { tags: tagsValidation?.errors })
+      if (!payment) {
+        errorObj['payment'] = 'payment object is missing.'
+      } else {
+        // Validate `collected_by`
+        if (!payment.collected_by) {
+          errorObj['collected_by'] = `payment.collected_by must be present in ${
+            secondSearch ? metroSequence?.SEARCH2 : metroSequence.SEARCH1
+          }`
+        }
+
+        // Validate `tags`
+        if (!payment.tags) {
+          errorObj['payment.tags'] = `payment.tags is missing in ${
+            secondSearch ? metroSequence?.SEARCH2 : metroSequence.SEARCH1
+          }`
+        } else {
+          // Validate tags using external function
+          const tagsValidation = validatePaymentTags(payment.tags, secondSearch ? 'search2' : constants.SEARCH)
+          if (!tagsValidation?.isValid) {
+            errorObj.tags = tagsValidation.errors
+          }
+        }
       }
     } catch (error: any) {
       logger.error(`!!Error occcurred while validating payments in /${constants.SEARCH},  ${error.message}`)

diff --git a/utils/metro/tags.ts b/utils/metro/tags.ts
@@ -167,7 +167,7 @@ export const validatePaymentTags = (tags: Tag[], action: string): ValidationResu
           break
         }
 
-        tag.list.forEach((item: any, itemIndex) => {
+        tag?.list?.forEach((item: any, itemIndex) => {
           switch (item.descriptor.code) {
             case 'SETTLEMENT_WINDOW':
               if (!/^(P(\d+D)?(T(\d+H)?(\d+M)?(\d+S)?)?)$/.test(item.value)) {
@@ -221,7 +221,7 @@ export const validatePaymentTags = (tags: Tag[], action: string): ValidationResu
                 setValue(`DELAY_INTEREST`, item.value)
               } else {
                 const delayInterest = getValue('DELAY_INTEREST')
-                if (delayInterest !== item?.value)
+                if (delayInterest && delayInterest !== item?.value)
                   errors.push(
                     `SETTLEMENT_TERMS_[${index}], DELAY_INTEREST must be similar to /search value ${delayInterest} instead of ${item?.value} at item[${itemIndex}] in ${action}`,
                   )