chore: mask nric (#401)

* chore: mask nric * fix: lint * chore: code review * chore: reuse existing types Co-authored-by: Kyle Huang Junyuan <[email protected]>
Notarise-gov-sg · Dec 16, 2021 · d4a5c52 · d4a5c52
1 parent 4e8140e
commit d4a5c52
Show file tree

Hide file tree

Showing 8 changed files with 1,382 additions and 1,298 deletions.
diff --git a/src/common/maskNricFin.test.ts b/src/common/maskNricFin.test.ts
@@ -0,0 +1,37 @@
+import { R4 } from "@ahryman40k/ts-fhir-types";
+import { fhirBundleV1, Patient } from "../types";
+import { maskNricInFhirBundleV1, maskNricInFhirBundle } from "./maskNricFin";
+import pdtUnwrappedSampleV1 from "../../test/fixtures/v1/example_healthcert_with_nric_unwrapped.json";
+import pdtUnwrappedSampleV2 from "../../test/fixtures/v2/pdt_pcr_with_nric_unwrapped.json";
+
+describe("test maskNricFinInPlace function", () => {
+  it("nric should be masked for V1 Healthcert", () => {
+    const { fhirBundle } = pdtUnwrappedSampleV1;
+
+    const maskedFhirBundle = maskNricInFhirBundleV1(fhirBundle as any);
+    const patient = (maskedFhirBundle as fhirBundleV1).entry.find(
+      (entry) => entry.resourceType === "Patient"
+    );
+    const nricIdentifier = (patient as Patient).identifier.find(
+      (i) => i.type !== "PPN" && i.type.text.toUpperCase() === "NRIC"
+    );
+
+    expect(fhirBundle).not.toEqual(maskNricInFhirBundle);
+    expect(nricIdentifier?.value).toStrictEqual("S****989Z");
+  });
+
+  it("nric should be masked for V2 Healthcert", () => {
+    const { fhirBundle } = pdtUnwrappedSampleV2;
+
+    const maskedFhirBundle = maskNricInFhirBundle(fhirBundle as any);
+    const patient = (maskedFhirBundle as R4.IBundle).entry?.find(
+      (entry: any) => entry?.resource?.resourceType === "Patient"
+    )?.resource as R4.IPatient;
+    const nricIdentifier = patient.identifier?.find(
+      (i) => i.id?.toUpperCase() === "NRIC-FIN"
+    );
+
+    expect(fhirBundle).not.toEqual(maskNricInFhirBundle);
+    expect(nricIdentifier?.value).toStrictEqual("S****989Z");
+  });
+});
diff --git a/src/common/maskNricFin.ts b/src/common/maskNricFin.ts
@@ -0,0 +1,45 @@
+import { R4 } from "@ahryman40k/ts-fhir-types";
+import { fhirBundleV1, Patient, PDTHealthCertV2 } from "../types";
+
+// Get the reference to the nested nric identifier object
+// mask the value in place
+
+const maskNric = (nric: string) => `${nric[0]}****${nric.slice(5)}`;
+
+/**
+ * @deprecated This function should be removed when PDT HealthCert v1.0 is deprecated.
+ */
+export const maskNricInFhirBundleV1 = (
+  fhirBundle: fhirBundleV1 | R4.IBundle
+) => {
+  const patient = (fhirBundle as fhirBundleV1).entry.find(
+    (entry) => entry.resourceType === "Patient"
+  );
+  const nricIdentifier = (patient as Patient).identifier.find(
+    (i) => i.type !== "PPN" && i.type.text.toUpperCase() === "NRIC"
+  );
+
+  // Mask NRIC by reference
+  if (nricIdentifier?.value)
+    nricIdentifier.value = maskNric(nricIdentifier.value);
+
+  return fhirBundle;
+};
+
+export const maskNricInFhirBundle = (
+  fhirBundle: PDTHealthCertV2["fhirBundle"]
+) => {
+  // PDTHealthCertV2["fhirBundle"] and R4.IBundle can be used interchangeably
+  const patient = (fhirBundle as R4.IBundle).entry?.find(
+    (entry: any) => entry?.resource?.resourceType === "Patient"
+  )?.resource as R4.IPatient;
+  const nricIdentifier = patient.identifier?.find(
+    (i) => i.id?.toUpperCase() === "NRIC-FIN"
+  );
+
+  // Mask NRIC by reference
+  if (nricIdentifier?.value)
+    nricIdentifier.value = maskNric(nricIdentifier.value);
+
+  return fhirBundle;
+};
diff --git a/src/models/notarizedHealthCert/createNotarizedHealthCert/createNotarizedHealthCert.test.ts b/src/models/notarizedHealthCert/createNotarizedHealthCert/createNotarizedHealthCert.test.ts
@@ -63,7 +63,7 @@ it("should wrap a document and sign the document", async () => {
                 "type": Object {
                   "text": "NRIC",
                 },
-                "value": "S9098989Z",
+                "value": "S****989Z",
               },
             ],
             "name": Array [
@@ -255,7 +255,7 @@ it("should wrap a document and sign the document with signedEuHealthCert", async
                 "type": Object {
                   "text": "NRIC",
                 },
-                "value": "S9098989Z",
+                "value": "S****989Z",
               },
             ],
             "name": Array [

diff --git a/src/models/notarizedHealthCert/createNotarizedHealthCert/createUnwrappedHealthCert.test.ts b/src/models/notarizedHealthCert/createNotarizedHealthCert/createUnwrappedHealthCert.test.ts
diff --git a/src/models/notarizedHealthCert/createNotarizedHealthCert/createUnwrappedHealthCert.ts b/src/models/notarizedHealthCert/createNotarizedHealthCert/createUnwrappedHealthCert.ts
@@ -1,5 +1,6 @@
 import { getData, v2, WrappedDocument } from "@govtechsg/open-attestation";
 import { notarise } from "@govtechsg/oa-schemata";
+import { maskNricInFhirBundleV1 } from "../../../common/maskNricFin";
 import { config } from "../../../config";
 import { HealthCertDocument, NotarizedHealthCert } from "../../../types";
 import { getParticularsFromHealthCert } from "../../healthCert";
@@ -66,7 +67,7 @@ export const createUnwrappedDocument = (
     name: documentName,
     validFrom: certificateData.validFrom,
     fhirVersion,
-    fhirBundle,
+    fhirBundle: maskNricInFhirBundleV1(fhirBundle),
     issuers,
     $template,
     notarisationMetadata,

diff --git a/src/models/notarizedHealthCertV2/createNotarizedHealthCert/createNotarizedHealthCert.test.ts b/src/models/notarizedHealthCertV2/createNotarizedHealthCert/createNotarizedHealthCert.test.ts
@@ -91,7 +91,7 @@ it("should wrap a v2 document and sign the document", async () => {
                 },
                 Object {
                   "id": "NRIC-FIN",
-                  "value": "S9098989Z",
+                  "value": "S****989Z",
                 },
               ],
               "name": Array [
@@ -450,7 +450,7 @@ it("should wrap a v2 document and sign the document with signedEuHealthCert", as
                 },
                 Object {
                   "id": "NRIC-FIN",
-                  "value": "S9098989Z",
+                  "value": "S****989Z",
                 },
               ],
               "name": Array [

diff --git a/src/models/notarizedHealthCertV2/createNotarizedHealthCert/createUnwrappedHealthCert.test.ts b/src/models/notarizedHealthCertV2/createNotarizedHealthCert/createUnwrappedHealthCert.test.ts
diff --git a/src/models/notarizedHealthCertV2/createNotarizedHealthCert/createUnwrappedHealthCert.ts b/src/models/notarizedHealthCertV2/createNotarizedHealthCert/createUnwrappedHealthCert.ts
@@ -1,5 +1,6 @@
 import { getData, v2, WrappedDocument } from "@govtechsg/open-attestation";
 import { notarise } from "@govtechsg/oa-schemata";
+import { maskNricInFhirBundle } from "../../../common/maskNricFin";
 import { ParsedBundle } from "../../fhir/types";
 import { config } from "../../../config";
 import { PDTHealthCertV2, EndorsedPDTHealthCertV2 } from "../../../types";
@@ -68,7 +69,7 @@ export const createUnwrappedDocument = (
     type,
     validFrom: certificateData.validFrom,
     fhirVersion,
-    fhirBundle,
+    fhirBundle: maskNricInFhirBundle(fhirBundle),
     issuers,
     $template,
     notarisationMetadata,