feat: confirm registration via graphql api (#288)

naftis · web-flow · commit 8eb84cfba65b · 2024-11-12T16:44:17.000+02:00
* refactor: remove all graphql related stuff

* chore: remove unused code

* feat: allow graphql type hints

* feat: allow confirming registration via the new graphql api

* refactor: use graphql comment so no package needed

* refactor: use graphql comment in the last query as well

* refactor: throw if the composition doesn't have an id

* fix: throw if the id is not found as the function is _get_

* fix: add required env variables

* fix: use identifiers instead of childIdentifiers

* fix: remove posting tracking id
diff --git a/.gitignore b/.gitignore
@@ -19,7 +19,6 @@ data
 
 .history
 
-graphql.schema.json
 *.tar.gz
 .secrets
 .env*
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "apollographql.vscode-apollo"
+  ]
+}
diff --git a/apollo.config.json b/apollo.config.json
@@ -0,0 +1,8 @@
+{
+  "client": {
+    "service": {
+      "name": "@opencrvs/gateway",
+      "url": "http://localhost:7070/graphql"
+    }
+  }
+}
diff --git a/codegen.yml b/codegen.yml
diff --git a/package.json b/package.json
@@ -31,14 +31,8 @@
     "sort-translations": "cross-env NODE_ENV=development ts-node -r tsconfig-paths/register src/sort-translations.ts"
   },
   "devDependencies": {
-    "@graphql-codegen/add": "^3.1.1",
-    "@graphql-codegen/cli": "^3.3.1",
-    "@graphql-codegen/introspection": "^3.0.1",
-    "@graphql-codegen/typescript": "^3.0.4",
-    "@graphql-codegen/typescript-operations": "^3.0.4",
     "@inquirer/editor": "^1.2.13",
     "@octokit/core": "4.2.1",
-    "@types/google-libphonenumber": "^7.4.23",
     "@types/handlebars": "^4.1.0",
     "@types/hapi__inert": "5.2.1",
     "@types/inquirer": "^9.0.7",
@@ -91,9 +85,6 @@
     "dotenv": "^16.4.5",
     "envalid": "^8.0.0",
     "esbuild": "^0.18.9",
-    "google-libphonenumber": "^3.2.32",
-    "graphql": "^16.3.0",
-    "graphql-tag": "^2.12.6",
     "handlebars": "^4.7.7",
     "hapi-auth-jwt2": "10.4.0",
     "hapi-pino": "^9.0.0",
diff --git a/src/api/event-registration/handler.ts b/src/api/event-registration/handler.ts
@@ -9,11 +9,13 @@
  * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
  */
 import * as Hapi from '@hapi/hapi'
-import fetch from 'node-fetch'
 import { logger } from '@countryconfig/logger'
-import { CONFIRM_REGISTRATION_URL } from '@countryconfig/constants'
 import { createUniqueRegistrationNumberFromBundle } from '@countryconfig/api/event-registration/service'
 import { badImplementation } from '@hapi/boom'
+import {
+  confirmRegistration
+  // rejectRegistration
+} from '@countryconfig/utils/gateway-api'
 
 export async function eventRegistrationHandler(
   request: Hapi.Request,
@@ -33,15 +35,28 @@ export async function eventRegistrationHandler(
     const bundle = request.payload as fhir.Bundle
 
     const eventRegistrationIdentifiersResponse =
-      await createUniqueRegistrationNumberFromBundle(bundle)
+      createUniqueRegistrationNumberFromBundle(bundle)
 
-    await fetch(CONFIRM_REGISTRATION_URL, {
-      method: 'POST',
-      body: JSON.stringify(eventRegistrationIdentifiersResponse),
-      headers: request.headers
-    })
+    await confirmRegistration(
+      eventRegistrationIdentifiersResponse.compositionId,
+      eventRegistrationIdentifiersResponse,
+      {
+        headers: request.headers
+      }
+    )
   } catch (err) {
-    // IF ANY ERROR OCCURS IN THIS API, THE REGISTRATION WILL BE REJECTED AND MUST BE RE-SUBMITTED BY A REGISTRAR ONCE THE ISSUE IS RESOLVED
+    // If the confirm registration endpoint throws an error, the registration will be retried through country-config
+    // If you don't want the registration to retry, you can call `rejectRegistration` from here and return 202 Accepted
+
+    // await confirmRegistration(
+    //   eventRegistrationIdentifiersResponse.compositionId,
+    //   {
+    //     reason: 'other', // Refer to the GraphQL schema for other options
+    //     comment: 'The comment that will be visible on audit log.'
+    //   },
+    //   { headers: request.headers }
+    // )
+
     logger.error(err)
 
     const boomError = badImplementation()
diff --git a/src/api/event-registration/service.ts b/src/api/event-registration/service.ts
@@ -24,9 +24,7 @@ function generateRegistrationNumber(trackingId: string): string {
   return brn
 }
 
-export async function createUniqueRegistrationNumberFromBundle(
-  bundle: fhir.Bundle
-) {
+export function createUniqueRegistrationNumberFromBundle(bundle: fhir.Bundle) {
   const taskResource = getTaskResource(bundle)
 
   if (!taskResource || !taskResource.extension) {
@@ -36,11 +34,12 @@ export async function createUniqueRegistrationNumberFromBundle(
   }
 
   const trackingId = getTrackingIdFromTaskResource(taskResource)
+  const compositionId = getCompositionId(bundle)
 
   return {
     trackingId,
+    compositionId,
     registrationNumber: generateRegistrationNumber(trackingId),
-    compositionId: getCompositionId(bundle),
     ...(taskResource.code?.coding?.[0].code === 'BIRTH' && {
       // Some countries desire to create multiple identifiers for citizens at the point of birth registration using external systems.
       // OpenCRVS supports up to 3 additional, custom identifiers that can be created
diff --git a/src/constants.ts b/src/constants.ts
@@ -28,6 +28,5 @@ export const APPLICATION_CONFIG_URL = env.APPLICATION_CONFIG_URL
 export const SENTRY_DSN = env.SENTRY_DSN
 export const CHECK_INVALID_TOKEN = env.CHECK_INVALID_TOKEN
 
-export const CONFIRM_REGISTRATION_URL = env.CONFIRM_REGISTRATION_URL
 export const PRODUCTION = env.isProd
 export const QA_ENV = env.QA_ENV
diff --git a/src/environment.ts b/src/environment.ts
@@ -16,13 +16,14 @@ export const env = cleanEnv(process.env, {
   LOGIN_URL: url({ devDefault: 'http://localhost:3020/' }),
   CLIENT_APP_URL: url({ devDefault: 'http://localhost:3000/' }),
   FHIR_URL: url({ devDefault: 'http://localhost:3447/fhir' }),
-  COUNTRY_CONFIG_HOST: str({ devDefault: '0.0.0.0' }),
+  COUNTRY_CONFIG_HOST: str({ default: '0.0.0.0' }),
   COUNTRY_CONFIG_PORT: port({ default: 3040 }),
   AUTH_URL: url({ devDefault: 'http://localhost:4040' }),
   COUNTRY_CONFIG_URL: url({ devDefault: 'http://localhost:3040' }),
   APPLICATION_CONFIG_URL: url({ devDefault: 'http://localhost:2021/' }),
   SENTRY_DSN: str({ default: undefined }),
   CHECK_INVALID_TOKEN: bool({
+    default: true,
     devDefault: false,
     desc: 'Check if the token has been invalidated in the auth service before it has expired'
   }),
diff --git a/src/form/index.ts b/src/form/index.ts
@@ -14,12 +14,12 @@ import { birthForm } from './birth'
 import { deathForm } from './death'
 import { marriageForm } from './marriage'
 import { IForms, Event } from './types/types'
-import { fetchUserLocationHierarchy } from '@countryconfig/utils/users'
+import { fetchUserLocationHierarchy } from '@countryconfig/utils/gateway-api'
 
 export async function formHandler(req: Request): Promise<IForms> {
   const addressHierarchy = await fetchUserLocationHierarchy(
-    req.headers.authorization,
-    req.auth.credentials.sub as string
+    req.auth.credentials.sub as string,
+    { headers: req.headers }
   )
   // ====================== NOTE REGARDING MIGRATING FROM OPNCRVS v1.2 OR EARLIER ======================
 
diff --git a/src/utils/gateway-api.ts b/src/utils/gateway-api.ts
@@ -0,0 +1,127 @@
+/*
+ * 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 { GATEWAY_URL } from '@countryconfig/constants'
+import { URL } from 'url'
+import fetch from 'node-fetch'
+
+const GRAPHQL_GATEWAY_URL = new URL('graphql', GATEWAY_URL)
+
+/** Communicates with opencrvs-core's GraphQL gateway */
+const post = async <T = any>({
+  query,
+  variables,
+  headers
+}: {
+  query: string
+  variables: Record<string, any>
+  headers: Record<string, any>
+}) => {
+  const response = await fetch(GRAPHQL_GATEWAY_URL, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      ...headers
+    },
+    body: JSON.stringify({
+      variables,
+      query
+    })
+  })
+
+  if (!response.ok) {
+    throw new Error(`not ok: ${await response.text()}`)
+  }
+
+  return response.json() as Promise<{ data: T }>
+}
+
+export const confirmRegistration = (
+  id: string,
+  variables: {
+    childIdentifiers?: Array<{ type: string; value: string }>
+    registrationNumber: string
+  },
+  { headers }: { headers: Record<string, any> }
+) =>
+  post({
+    query: /* GraphQL */ `
+      mutation confirmRegistration(
+        $id: ID!
+        $details: ConfirmRegistrationInput!
+      ) {
+        confirmRegistration(id: $id, details: $details)
+      }
+    `,
+    variables: {
+      id,
+      details: {
+        identifiers: variables.childIdentifiers,
+        registrationNumber: variables.registrationNumber
+      }
+    },
+    headers
+  })
+
+export const rejectRegistration = (
+  id: string,
+  { reason, comment }: { reason: string; comment: string },
+  { headers }: { headers: Record<string, any> }
+) =>
+  post({
+    query: /* GraphQL */ `
+      mutation rejectRegistration(
+        $id: ID!
+        $details: RejectRegistrationInput!
+      ) {
+        rejectRegistration(id: $id, details: $details)
+      }
+    `,
+    variables: {
+      id,
+      details: {
+        reason,
+        comment
+      }
+    },
+    headers
+  })
+
+type GetUser = {
+  getUser: {
+    primaryOffice: {
+      hierarchy: Array<{
+        id: string
+      }>
+    }
+  }
+}
+
+export const fetchUserLocationHierarchy = async (
+  userId: string,
+  { headers }: { headers: Record<string, any> }
+) => {
+  const res = await post<GetUser>({
+    query: /* GraphQL */ `
+      query fetchUser($userId: String!) {
+        getUser(userId: $userId) {
+          primaryOffice {
+            hierarchy {
+              id
+            }
+          }
+        }
+      }
+    `,
+    variables: { userId },
+    headers
+  })
+  return res.data.getUser.primaryOffice.hierarchy.map(({ id }) => id)
+}
diff --git a/src/utils/index.ts b/src/utils/index.ts
@@ -11,11 +11,9 @@
 
 import fetch from 'node-fetch'
 import { APPLICATION_CONFIG_URL, FHIR_URL } from '@countryconfig/constants'
-import { callingCountries } from 'country-data'
 import csv2json from 'csv2json'
 import { createReadStream } from 'fs'
 import fs from 'fs'
-import { PhoneNumberFormat, PhoneNumberUtil } from 'google-libphonenumber'
 import { URL } from 'url'
 import { build } from 'esbuild'
 import { memoize } from 'lodash'
@@ -64,9 +62,15 @@ export interface IApplicationConfigResponse {
 }
 
 export function getCompositionId(resBody: fhir.Bundle) {
-  return resBody.entry
+  const id = resBody.entry
     ?.map((e) => e.resource)
     .find((res) => res?.resourceType === 'Composition')?.id
+
+  if (!id) {
+    throw new Error('Could not find composition id in FHIR Bundle')
+  }
+
+  return id
 }
 
 export function getTaskResource(
@@ -160,21 +164,6 @@ export async function updateResourceInHearth(resource: fhir.ResourceBase) {
   return res.text()
 }
 
-export const convertToMSISDN = (phone: string, countryAlpha3: string) => {
-  const countryCode = callingCountries[countryAlpha3.toUpperCase()].alpha2
-
-  const phoneUtil = PhoneNumberUtil.getInstance()
-  const number = phoneUtil.parse(phone, countryCode)
-
-  return (
-    phoneUtil
-      .format(number, PhoneNumberFormat.INTERNATIONAL)
-      // libphonenumber adds spaces and dashes to phone numbers,
-      // which we do not want to keep for now
-      .replace(/[\s-]/g, '')
-  )
-}
-
 const csvStringify = promisify<Array<Record<string, any>>, Options>(stringify)
 export async function writeJSONToCSV(
   filename: string,
diff --git a/src/utils/users.ts b/src/utils/users.ts
diff --git a/typings/country-data.d.ts b/typings/country-data.d.ts
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "recommendations": [
 +    "apollographql.vscode-apollo"
 +  ]
 +}