chore: param obj instead of scalars

Author: tstephen-nhs

packages/nhsNotifyLambda/src/utils/notify.ts

@@ -14,6 +14,12 @@ import {loadSecrets, NotifySecrets} from "./secrets"
 import {tokenExchange} from "./auth"
 import {NOTIFY_REQUEST_MAX_BYTES, NOTIFY_REQUEST_MAX_ITEMS, DUMMY_NOTIFY_DELAY_MS} from "./constants"
 
+export interface NotifyConfig {
+  routingPlanId: string
+  notifyApiBaseUrl: string
+  notifySecrets: NotifySecrets
+}
+
 /**
  * Returns the original array, chunked in batches of up to <size>
  *
@@ -75,7 +81,12 @@ export async function handleNotifyRequests(
     throw new Error("NOTIFY_API_BASE_URL is not defined in the environment variables!")
   } else {
     const notifySecrets = await loadSecrets()
-    return await makeRealNotifyRequest(logger, routingPlanId, notifyApiBaseUrl, notifySecrets, data, messages)
+    const config: NotifyConfig = {
+      routingPlanId,
+      notifyApiBaseUrl,
+      notifySecrets
+    }
+    return await makeRealNotifyRequest(logger, config, data, messages)
   }
 }
 
@@ -120,18 +131,15 @@ async function makeFakeNotifyRequest(
  * Handles splitting large batches into smaller ones as needed.
  *
  * @param logger - AWS logging object
- * @param routingPlanId - The Notify routing plan ID with which to process the data
- * @param notifyBaseUrl - The base URL for the Notify endpoint to use
+ * @param config - configuration for talking to NHS Notify
  * @param data - PSU SQS messages to process
  * @param messages - The data being sent to NHS Notify
  * @param bearerToken - lazy initialised Bearer token to communicate with Notify
  * @param axiosInstance - lazy initialised HTTP client
  */
 export async function makeRealNotifyRequest(
   logger: Logger,
-  routingPlanId: string,
-  notifyBaseUrl: string,
-  notifySecrets: NotifySecrets,
+  config: NotifyConfig,
   data: Array<NotifyDataItemMessage>,
   messages: Array<MessageBatchItem>,
   bearerToken?: string,
@@ -145,16 +153,16 @@ export async function makeRealNotifyRequest(
     data: {
       type: "MessageBatch" as const,
       attributes: {
-        routingPlanId,
+        routingPlanId: config.routingPlanId,
         messageBatchReference,
         messages
       }
     }
   }
 
   // Lazily get the bearer token and axios instance, so we only do it once even if we recurse
-  axiosInstance ??= setupAxios(logger, notifyBaseUrl)
-  bearerToken ??= await tokenExchange(logger, axiosInstance, notifyBaseUrl, notifySecrets)
+  axiosInstance ??= setupAxios(logger, config.notifyApiBaseUrl)
+  bearerToken ??= await tokenExchange(logger, axiosInstance, config.notifyApiBaseUrl, config.notifySecrets)
 
   // Recursive split if too large
   if (messages.length >= NOTIFY_REQUEST_MAX_ITEMS || estimateSize(body) > NOTIFY_REQUEST_MAX_BYTES) {
@@ -168,16 +176,16 @@ export async function makeRealNotifyRequest(
     // send both halves in parallel
     const [res1, res2] = await Promise.all([
       makeRealNotifyRequest(
-        logger, routingPlanId, notifyBaseUrl, notifySecrets, data, firstHalf, bearerToken, axiosInstance
+        logger, config, data, firstHalf, bearerToken, axiosInstance
       ),
       makeRealNotifyRequest(
-        logger, routingPlanId, notifyBaseUrl, notifySecrets, data, secondHalf, bearerToken, axiosInstance
+        logger, config, data, secondHalf, bearerToken, axiosInstance
       )
     ])
     return [...res1, ...res2]
   }
 
-  logger.info("Making a request for notifications to NHS notify", {count: messages.length, routingPlanId})
+  logger.info("Request notifications of NHS notify", {count: messages.length, routingPlanId: config.routingPlanId})
 
   try {
     const headers = {

packages/nhsNotifyLambda/tests/testUtils.test.ts

@@ -795,11 +795,11 @@ describe("NHS notify lambda helper functions", () => {
 
       // Two calls
       expect(infoSpy).toHaveBeenCalledWith(
-        "Making a request for notifications to NHS notify",
+        expect.anything(), // not a reporting msg
         {count: 3, routingPlanId: "plan-large"}
       )
       expect(infoSpy).toHaveBeenCalledWith(
-        "Making a request for notifications to NHS notify",
+        expect.anything(), // not a reporting msg
         {count: 4, routingPlanId: "plan-large"}
       )
     })