feat(message-queue): allow confirming and rejecting record externally

docker-compose.dev.yml

@@ -78,7 +78,6 @@ services:
       - NODE_ENV=development
       - FHIR_URL=http://hearth:3447/fhir
       - AUTH_URL=http://auth:4040
-      - CONFIRM_REGISTRATION_URL=http://workflow:5050/confirm/registration
       - CHECK_INVALID_TOKEN=true
     ports:
       - '3040:3040'

packages/client/src/declarations/submissionMiddleware.ts

@@ -43,12 +43,12 @@
 import { updateRegistrarWorkqueue } from '@client/workqueue'
 import { Action, Middleware, createAction } from '@reduxjs/toolkit'
 import { Dispatch } from 'redux'
-// eslint-disable-next-line no-restricted-imports
 import { getReviewForm } from '@client/forms/register/review-selectors'
 import { IOfflineData } from '@client/offline/reducer'
 import { getOfflineData } from '@client/offline/selectors'
 import type { MutationToRequestRegistrationCorrectionArgs } from '@client/utils/gateway-deprecated-do-not-use'
 import { UserDetails } from '@client/utils/userUtils'
+// eslint-disable-next-line no-restricted-imports
 import { captureException } from '@sentry/browser'
 import { submitAndWaitUntilRecordInWorkqueue } from './createRecord'
 
@@ -352,7 +352,7 @@
         captureException(error)
         return
       }
       console.log(error)
 
       updateDeclaration(dispatch, {
         ...declaration,

packages/gateway/src/features/registration/root-resolvers.ts

@@ -31,6 +31,7 @@ import {
 import {
   archiveRegistration,
   certifyRegistration,
+  confirmRegistration,
   createRegistration,
   duplicateRegistration,
   fetchRegistrationForDownloading,
@@ -634,6 +635,20 @@ export const resolvers: GQLResolver = {
       )
 
       return taskEntry.resource.id
+    },
+    async confirmRegistration(_, { id, details }, { headers: authHeader }) {
+      if (!inScope(authHeader, ['register', 'validate'])) {
+        throw new Error('User does not have a register or validate scope')
+      }
+
+      return confirmRegistration(id, authHeader, details as any) // Type 'string' is not assignable to type '"PASSPORT" | "NATIONAL_ID" | "MOSIP_PSUT_TOKEN_ID" | "DECEASED_PATIENT_ENTRY" | "BIRTH_PA...
+    },
+    async rejectRegistration(_, { id, details }, { headers: authHeader }) {
+      if (!inScope(authHeader, ['register', 'validate'])) {
+        throw new Error('User does not have a register or validate scope')
+      }
+
+      return rejectDeclaration(id, authHeader, details.comment, details.reason)
     }
   }
 }

packages/gateway/src/features/registration/schema.graphql

@@ -563,6 +563,26 @@ input CorrectionRejectionInput {
   timeLoggedMS: Int!
 }
 
+input IdentifierInput {
+  type: String!
+  value: String!
+}
+input ConfirmRegistrationInput {
+  childIdentifiers: [IdentifierInput!]
+  registrationNumber: String
+  trackingId: String
+}
+
+enum RejectionReason {
+  other
+  duplicate
+}
+
+input RejectRegistrationInput {
+  reason: RejectionReason!
+  comment: String!
+}
+
 type Mutation {
   # Generic correction handlers for all event types
   # Applying a correction request is made on a event level as payload is dependant on event type
@@ -639,4 +659,6 @@ type Mutation {
     comment: String
     duplicateTrackingId: String
   ): ID!
+  confirmRegistration(id: ID!, details: ConfirmRegistrationInput!): ID!
+  rejectRegistration(id: ID!, details: RejectRegistrationInput!): ID!
 }

packages/gateway/src/graphql/schema.d.ts

@@ -87,6 +87,8 @@ export interface GQLMutation {
   markMarriageAsCertified: string
   markMarriageAsIssued: string
   markEventAsDuplicate: string
+  confirmRegistration: string
+  rejectRegistration: string
   createOrUpdateUser: GQLUser
   activateUser?: string
   changePassword?: string
@@ -613,6 +615,17 @@ export interface GQLReinstated {
   registrationStatus?: GQLRegStatus
 }
 
+export interface GQLConfirmRegistrationInput {
+  childIdentifiers?: Array<GQLIdentifierInput>
+  registrationNumber?: string
+  trackingId?: string
+}
+
+export interface GQLRejectRegistrationInput {
+  reason: GQLRejectionReason
+  comment: string
+}
+
 export interface GQLUserInput {
   id?: string
   name: Array<GQLHumanNameInput>
@@ -1221,6 +1234,16 @@ export const enum GQLRegStatus {
   ISSUED = 'ISSUED'
 }
 
+export interface GQLIdentifierInput {
+  type: string
+  value: string
+}
+
+export const enum GQLRejectionReason {
+  other = 'other',
+  duplicate = 'duplicate'
+}
+
 export interface GQLHumanNameInput {
   use?: string
   firstNames?: string
@@ -2551,6 +2574,8 @@ export interface GQLMutationTypeResolver<TParent = any> {
   markMarriageAsCertified?: MutationToMarkMarriageAsCertifiedResolver<TParent>
   markMarriageAsIssued?: MutationToMarkMarriageAsIssuedResolver<TParent>
   markEventAsDuplicate?: MutationToMarkEventAsDuplicateResolver<TParent>
+  confirmRegistration?: MutationToConfirmRegistrationResolver<TParent>
+  rejectRegistration?: MutationToRejectRegistrationResolver<TParent>
   createOrUpdateUser?: MutationToCreateOrUpdateUserResolver<TParent>
   activateUser?: MutationToActivateUserResolver<TParent>
   changePassword?: MutationToChangePasswordResolver<TParent>
@@ -3083,6 +3108,38 @@ export interface MutationToMarkEventAsDuplicateResolver<
   ): TResult
 }
 
+export interface MutationToConfirmRegistrationArgs {
+  id: string
+  details: GQLConfirmRegistrationInput
+}
+export interface MutationToConfirmRegistrationResolver<
+  TParent = any,
+  TResult = any
+> {
+  (
+    parent: TParent,
+    args: MutationToConfirmRegistrationArgs,
+    context: Context,
+    info: GraphQLResolveInfo
+  ): TResult
+}
+
+export interface MutationToRejectRegistrationArgs {
+  id: string
+  details: GQLRejectRegistrationInput
+}
+export interface MutationToRejectRegistrationResolver<
+  TParent = any,
+  TResult = any
+> {
+  (
+    parent: TParent,
+    args: MutationToRejectRegistrationArgs,
+    context: Context,
+    info: GraphQLResolveInfo
+  ): TResult
+}
+
 export interface MutationToCreateOrUpdateUserArgs {
   user: GQLUserInput
 }

packages/gateway/src/graphql/schema.graphql

@@ -223,6 +223,8 @@ type Mutation {
     comment: String
     duplicateTrackingId: String
   ): ID!
+  confirmRegistration(id: ID!, details: ConfirmRegistrationInput!): ID!
+  rejectRegistration(id: ID!, details: RejectRegistrationInput!): ID!
   createOrUpdateUser(user: UserInput!): User!
   activateUser(
     userId: String!
@@ -728,6 +730,17 @@ type Reinstated {
   registrationStatus: RegStatus
 }
 
+input ConfirmRegistrationInput {
+  childIdentifiers: [IdentifierInput!]
+  registrationNumber: String
+  trackingId: String
+}
+
+input RejectRegistrationInput {
+  reason: RejectionReason!
+  comment: String!
+}
+
 input UserInput {
   id: ID
   name: [HumanNameInput!]!
@@ -1312,6 +1325,16 @@ enum RegStatus {
   ISSUED
 }
 
+input IdentifierInput {
+  type: String!
+  value: String!
+}
+
+enum RejectionReason {
+  other
+  duplicate
+}
+
 input HumanNameInput {
   use: String
   firstNames: String

packages/gateway/src/workflow/index.ts

@@ -37,11 +37,12 @@ import {
   RejectedRecord,
   Resource,
   SavedBundle,
+  SupportedPatientIdentifierCode,
   ValidRecord
 } from '@opencrvs/commons/types'
 
 const createRequest = async <T = any>(
-  method: 'POST' | 'GET' | 'PUT' | 'DELETE',
+  method: 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE',
   path: string,
   authHeader: IAuthHeader,
   body?: Record<string, any>
@@ -393,3 +394,38 @@ export async function createHospitalNotification(
     bundle
   )
 }
+
+type ConfirmRegistrationDetails = {
+  childIdentifiers?: {
+    type: SupportedPatientIdentifierCode
+    value: string
+  }[]
+}
+export async function confirmRegistration(
+  id: string,
+  authHeader: IAuthHeader,
+  details: ConfirmRegistrationDetails
+) {
+  return createRequest<undefined>(
+    'POST',
+    `/records/${id}/confirm`,
+    authHeader,
+    details
+  )
+}
+
+type RejectRegistrationDetails = {
+  error: string
+}
+export async function rejectRegistration(
+  id: string,
+  authHeader: IAuthHeader,
+  details: RejectRegistrationDetails
+) {
+  return createRequest<undefined>(
+    'POST',
+    `/records/${id}/reject`,
+    authHeader,
+    details
+  )
+}

packages/workflow/src/config/routes.ts

@@ -8,9 +8,9 @@
  *
  * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
  */
-import { markEventAsRegisteredCallbackHandler } from '@workflow/features/registration/handler'
 import { archiveRoute } from '@workflow/records/handler/archive'
 import { certifyRoute } from '@workflow/records/handler/certify'
+import { confirmRegistrationHandler } from '@workflow/records/handler/confirm'
 import { approveCorrectionRoute } from '@workflow/records/handler/correction/approve'
 import { makeCorrectionRoute } from '@workflow/records/handler/correction/make-correction'
 import { rejectCorrectionRoute } from '@workflow/records/handler/correction/reject'
@@ -60,12 +60,11 @@ export const getRoutes = () => {
     },
     {
       method: 'POST',
-      path: '/confirm/registration',
-      handler: markEventAsRegisteredCallbackHandler,
+      path: '/records/{id}/confirm',
+      handler: confirmRegistrationHandler,
       config: {
         tags: ['api'],
-        description:
-          'Register event based on tracking id and registration number.'
+        description: 'Confirm registration after external validation'
       }
     },
     {

packages/workflow/src/features/registration/handler.ts

@@ -8,17 +8,9 @@
  *
  * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
  */
-import * as Hapi from '@hapi/hapi'
 import { toTokenWithBearer } from '@opencrvs/commons'
-import {
-  RecordValidatedPayload,
-  useExternalValidationQueue
-} from '@opencrvs/commons/message-queue'
-import {
-  isWaitingExternalValidation,
-  SupportedPatientIdentifierCode
-} from '@opencrvs/commons/types'
-import { REDIS_HOST } from '@workflow/constants'
+import { RecordValidatedPayload } from '@opencrvs/commons/message-queue'
+import { isWaitingExternalValidation } from '@opencrvs/commons/types'
 import { writeMetricsEvent } from '@workflow/records/audit'
 import { getRecordById } from '@workflow/records/index'
 import {
@@ -28,7 +20,6 @@ import {
 import { indexBundleWithTransaction } from '@workflow/records/search'
 import { toRegistered } from '@workflow/records/state-transitions'
 import { invokeWebhooks } from '@workflow/records/webhooks'
-import { getToken } from '@workflow/utils/auth-utils'
 import { getEventType } from './utils'
 
 export async function markEventAsRegistered({
@@ -73,31 +64,3 @@ export async function markEventAsRegistered({
 
   return
 }
-
-const { recordValidated } = useExternalValidationQueue(REDIS_HOST)
-
-type RecordValidatedHTTPPayload = {
-  registrationNumber: string
-  childIdentifiers: { type: SupportedPatientIdentifierCode; value: string }[]
-  compositionId: string
-  trackingId: string
-}
-
-export async function markEventAsRegisteredCallbackHandler(
-  request: Hapi.Request,
-  h: Hapi.ResponseToolkit
-) {
-  const token = getToken(request)
-  const { registrationNumber, childIdentifiers, compositionId, trackingId } =
-    request.payload as RecordValidatedHTTPPayload
-
-  await recordValidated({
-    recordId: compositionId,
-    identifiers: childIdentifiers || [],
-    registrationNumber,
-    trackingId,
-    token
-  })
-
-  return h.response().code(200)
-}