VIA-331 DB SB Log NHS number as a JSON field rather than embedded in a string, to make querying easier.

Author: acerathereinspirative-nhs-nvir

src/services/eligibility-api/domain/eligibility-filter-service.test.ts

@@ -212,7 +212,7 @@ describe("eligibility-filter-service", () => {
         ])
         .build();
 
-      const result = _generateActions(processedSuggestion);
+      const result = _generateActions(processedSuggestion, VaccineTypes.RSV, nhsNumber);
 
       expect(result).toEqual([
         {
@@ -230,7 +230,7 @@ describe("eligibility-filter-service", () => {
         ])
         .build();
 
-      const result = _generateActions(processedSuggestion);
+      const result = _generateActions(processedSuggestion, VaccineTypes.RSV, nhsNumber);
 
       expect(result).toEqual([
         {
@@ -252,7 +252,7 @@ describe("eligibility-filter-service", () => {
         eligibilityCohorts: [],
       } as unknown as ProcessedSuggestion;
 
-      const result = _generateActions(suggestion);
+      const result = _generateActions(suggestion, VaccineTypes.RSV, nhsNumber);
 
       expect(result).toEqual([]);
     });

src/services/eligibility-api/domain/eligibility-filter-service.ts

@@ -35,9 +35,7 @@ const getEligibilityForPerson = async (
     );
 
     if (!suggestionForVaccine) {
-      log.error(
-        `EliD response validation error: Processed suggestion not found for vaccine type ${vaccineType}, NHS number ${nhsNumber}`,
-      );
+      log.error({ nhsNumber, vaccineType }, "EliD response validation error: Processed suggestion not found");
       return {
         eligibility: undefined,
         eligibilityError: EligibilityErrorTypes.ELIGIBILITY_LOADING_ERROR,
@@ -47,9 +45,7 @@ const getEligibilityForPerson = async (
     let summary: SummaryContent | undefined;
 
     if (!suggestionForVaccine.eligibilityCohorts) {
-      log.error(
-        `EliD response validation error: Missing eligibilityCohorts element for vaccine type ${vaccineType}, NHS number ${nhsNumber}`,
-      );
+      log.error({ nhsNumber, vaccineType }, "EliD response validation error: Missing eligibilityCohorts element");
     } else if (suggestionForVaccine.eligibilityCohorts.length > 0) {
       summary = {
         heading: suggestionForVaccine.statusText as Heading,
@@ -58,7 +54,7 @@ const getEligibilityForPerson = async (
       };
     }
 
-    const actions: Action[] = _generateActions(suggestionForVaccine);
+    const actions: Action[] = _generateActions(suggestionForVaccine, vaccineType, nhsNumber);
 
     return {
       eligibility: {
@@ -77,7 +73,7 @@ const getEligibilityForPerson = async (
         eligibilityError: EligibilityErrorTypes.ELIGIBILITY_LOADING_ERROR,
       };
     } else {
-      log.error(error, "Some random error");
+      log.error({ nhsNumber, vaccineType, error }, "Unexpected error");
       return {
         eligibility: undefined,
         eligibilityError: EligibilityErrorTypes.UNKNOWN,
@@ -104,9 +100,9 @@ const _getStatus = (suggestion: ProcessedSuggestion): EligibilityStatus => {
   throw new Error("not yet implemented");
 };
 
-const _generateActions = (suggestion: ProcessedSuggestion): Action[] => {
+const _generateActions = (suggestion: ProcessedSuggestion, vaccineType: VaccineTypes, nhsNumber: string): Action[] => {
   if (!suggestion.actions) {
-    log.warn("Missing actions array");
+    log.warn({ nhsNumber, vaccineType }, "Missing actions array");
     return [];
   }
 

src/services/eligibility-api/gateway/fetch-eligibility-content.ts

@@ -16,7 +16,7 @@ export const fetchEligibilityContent = async (nhsNumber: string): Promise<Eligib
 
   const uri: string = `${apiEndpoint}${ELIGIBILITY_API_PATH_SUFFIX}${nhsNumber}`;
 
-  log.info("Fetching eligibility status from %s", uri);
+  log.info({ nhsNumber }, "Fetching eligibility status from %s", uri);
   const response: AxiosResponse = await axios
     .get(uri, {
       headers: {