feat: notify CC about actions

packages/workflow/src/features/registration/fhir/fhir-bundle-modifier.ts

@@ -11,7 +11,6 @@
 
 import { UUID, logger } from '@opencrvs/commons'
 import {
-  Bundle,
   Composition,
   Patient,
   Practitioner,
@@ -26,7 +25,6 @@ import {
   SupportedPatientIdentifierCode,
   ValidRecord
 } from '@opencrvs/commons/types'
-import { COUNTRY_CONFIG_URL } from '@workflow/constants'
 import {
   OPENCRVS_SPECIFICATION_URL,
   RegStatus
@@ -39,31 +37,6 @@ import {
 import { getPractitionerRef } from '@workflow/features/user/utils'
 import { ITokenPayload } from '@workflow/utils/auth-utils'
 import { isEqual } from 'lodash'
-import fetch from 'node-fetch'
-
-export async function invokeRegistrationValidation(
-  bundle: Saved<Bundle>,
-  headers: Record<string, string>
-): Promise<Bundle> {
-  const res = await fetch(
-    new URL('event-registration', COUNTRY_CONFIG_URL).toString(),
-    {
-      method: 'POST',
-      body: JSON.stringify(bundle),
-      headers: {
-        'Content-Type': 'application/json',
-        ...headers
-      }
-    }
-  )
-  if (!res.ok) {
-    const errorText = await res.text()
-    throw new Error(
-      `Error calling country configuration event-registration [${res.statusText} ${res.status}]: ${errorText}`
-    )
-  }
-  return bundle
-}
 
 export async function setupRegistrationWorkflow(
   taskResource: Task,

packages/workflow/src/records/handler/create.ts

@@ -75,6 +75,7 @@ import {
   toWaitingForExternalValidationState
 } from '@workflow/records/state-transitions'
 import { logger, UUID } from '@opencrvs/commons'
+import { notifyForAction } from '@workflow/utils/country-config-api'
 
 const requestSchema = z.object({
   event: z.custom<EVENT_TYPE>(),
@@ -348,6 +349,8 @@ export default async function createRecordHandler(
   /*
    * We need to initiate registration for a
    * record in waiting validation state
+   *
+   * `initiateRegistration` notifies country configuration about the event which then either confirms or rejects the record.
    */
   if (isWaitingExternalValidation(record)) {
     const rejectedOrWaitingValidationRecord = await initiateRegistration(
@@ -360,6 +363,16 @@ export default async function createRecordHandler(
       await indexBundle(rejectedOrWaitingValidationRecord, token)
       await auditEvent('sent-for-updates', record, token)
     }
+  } else {
+    /*
+     * Notify country configuration about the event so that countries can hook into actions like "sent-for-approval"
+     */
+    await notifyForAction({
+      event,
+      action: eventAction,
+      record,
+      headers: request.headers
+    })
   }
 
   return {

packages/workflow/src/records/state-transitions.ts

@@ -58,7 +58,6 @@ import {
   SECTION_CODE
 } from '@workflow/features/events/utils'
 import {
-  invokeRegistrationValidation,
   setupLastRegOffice,
   setupLastRegUser,
   updatePatientIdentifierWithRN,
@@ -109,6 +108,7 @@ import {
 } from '@workflow/records/fhir'
 import { REG_NUMBER_GENERATION_FAILED } from '@workflow/features/registration/fhir/constants'
 import { tokenExchangeHandler } from './token-exchange-handler'
+import { invokeRegistrationValidation } from '@workflow/utils/country-config-api'
 
 export async function toCorrected(
   record: RegisteredRecord | CertifiedRecord | IssuedRecord,

packages/workflow/src/utils/country-config-api.ts

@@ -0,0 +1,86 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * OpenCRVS is also distributed under the terms of the Civil Registration
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
+ *
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
+ */
+import { logger } from '@opencrvs/commons'
+import { Bundle, EVENT_TYPE, Saved, ValidRecord } from '@opencrvs/commons/types'
+import { COUNTRY_CONFIG_URL } from '@workflow/constants'
+import fetch from 'node-fetch'
+
+const ACTION_NOTIFY_URL = (event: EVENT_TYPE, action: string) =>
+  new URL(
+    `event/${event.toLowerCase() as Lowercase<EVENT_TYPE>}/action/${action}`,
+    COUNTRY_CONFIG_URL
+  )
+
+export async function notifyForAction({
+  event,
+  action,
+  record,
+  headers
+}: {
+  event: EVENT_TYPE
+  action: string
+  record: Saved<ValidRecord>
+  headers: Record<string, string>
+}) {
+  const response = await fetch(ACTION_NOTIFY_URL(event, action), {
+    method: 'POST',
+    body: JSON.stringify(record),
+    headers: {
+      'Content-Type': 'application/json',
+      ...headers
+    }
+  })
+
+  if (response.status === 404) {
+    logger.debug(
+      `Non-issue: No country configuration endpoint for POST ${ACTION_NOTIFY_URL(
+        event,
+        action
+      )}. To optionally hook into this action, you must implement the corresponding action route in your country configuration.`
+    )
+    return
+  }
+
+  if (!response.ok) {
+    throw new Error(
+      `Error notifying country-config as POST ${ACTION_NOTIFY_URL(
+        event,
+        action
+      )} [${response.statusText} ${response.status}]: ${response.text()}`
+    )
+  }
+
+  return response
+}
+
+export async function invokeRegistrationValidation(
+  bundle: Saved<Bundle>,
+  headers: Record<string, string>
+): Promise<Bundle> {
+  const res = await fetch(
+    new URL('event-registration', COUNTRY_CONFIG_URL).toString(),
+    {
+      method: 'POST',
+      body: JSON.stringify(bundle),
+      headers: {
+        'Content-Type': 'application/json',
+        ...headers
+      }
+    }
+  )
+  if (!res.ok) {
+    const errorText = await res.text()
+    throw new Error(
+      `Error calling country configuration event-registration [${res.statusText} ${res.status}]: ${errorText}`
+    )
+  }
+  return bundle
+}