SPIKE SB Continue replacing usage of eager config object.

Author: acerathereinspirative-nhs-nvir

src/app/api/auth/[...nextauth]/provider.test.ts

@@ -1,17 +1,18 @@
 import NHSLoginAuthProvider from "@src/app/api/auth/[...nextauth]/provider";
-import { configProvider } from "@src/utils/config";
+import lazyConfig from "@src/utils/lazy-config";
+import { AsyncConfigMock, lazyConfigBuilder } from "@test-data/config/builders";
 
 jest.mock("@src/utils/config");
 jest.mock("@src/utils/auth/pem-to-crypto-key");
 jest.mock("sanitize-data", () => ({ sanitize: jest.fn() }));
 
 describe("provider", () => {
-  (configProvider as jest.Mock).mockImplementation(() => ({
-    NHS_LOGIN_URL: "",
-    NHS_LOGIN_CLIENT_ID: "",
-    NHS_LOGIN_SCOPE: "",
-    NHS_LOGIN_PRIVATE_KEY: "",
-  }));
+  const mockedConfig = lazyConfig as AsyncConfigMock;
+
+  beforeEach(() => {
+    const defaultConfig = lazyConfigBuilder().build();
+    Object.assign(mockedConfig, defaultConfig);
+  });
 
   it("should be configured correctly", async () => {
     const provider = await NHSLoginAuthProvider();

src/app/api/auth/[...nextauth]/provider.ts

@@ -1,28 +1,26 @@
 import { OIDCConfig } from "@auth/core/providers";
 import pemToCryptoKey from "@src/utils/auth/pem-to-crypto-key";
-import { AppConfig, configProvider } from "@src/utils/config";
+import lazyConfig from "@src/utils/lazy-config";
 import { Profile } from "next-auth";
 
 export const NHS_LOGIN_PROVIDER_ID = "nhs-login";
 
 const NHSLoginAuthProvider = async (): Promise<OIDCConfig<Profile>> => {
-  const config: AppConfig = await configProvider();
-
   return {
     id: NHS_LOGIN_PROVIDER_ID,
     name: "NHS Login Auth Provider",
     type: "oidc",
-    issuer: config.NHS_LOGIN_URL,
-    clientId: config.NHS_LOGIN_CLIENT_ID,
-    wellKnown: `${config.NHS_LOGIN_URL}/.well-known/openid-configuration`,
+    issuer: (await lazyConfig.NHS_LOGIN_URL) as string,
+    clientId: (await lazyConfig.NHS_LOGIN_CLIENT_ID) as string,
+    wellKnown: `${await lazyConfig.NHS_LOGIN_URL}/.well-known/openid-configuration`,
     authorization: {
       params: {
-        scope: `${config.NHS_LOGIN_SCOPE}`,
+        scope: `${await lazyConfig.NHS_LOGIN_SCOPE}`,
         prompt: "none",
       },
     },
     token: {
-      clientPrivateKey: await pemToCryptoKey(config.NHS_LOGIN_PRIVATE_KEY),
+      clientPrivateKey: await pemToCryptoKey((await lazyConfig.NHS_LOGIN_PRIVATE_KEY) as string),
     },
     client: {
       token_endpoint_auth_method: "private_key_jwt",

src/utils/auth/get-jwt-token.test.ts

@@ -1,7 +1,7 @@
 import { getJwtToken } from "@src/utils/auth/get-jwt-token";
 import { AccessToken } from "@src/utils/auth/types";
-import { configProvider } from "@src/utils/config";
-import { appConfigBuilder } from "@test-data/config/builders";
+import lazyConfig from "@src/utils/lazy-config";
+import { AsyncConfigMock, lazyConfigBuilder } from "@test-data/config/builders";
 import { getToken } from "next-auth/jwt";
 import { cookies, headers } from "next/headers";
 
@@ -13,15 +13,14 @@ jest.mock("next/headers", () => ({
   headers: jest.fn(),
   cookies: jest.fn(),
 }));
-
-jest.mock("@src/utils/config", () => ({
-  configProvider: jest.fn(),
-}));
+jest.mock("sanitize-data", () => ({ sanitize: jest.fn() }));
 
 describe("getJwtToken", () => {
+  const mockedConfig = lazyConfig as AsyncConfigMock;
+
   beforeEach(() => {
-    const mockConfig = appConfigBuilder().withAUTH_SECRET("test-auth-secret");
-    (configProvider as jest.Mock).mockResolvedValue(mockConfig);
+    const defaultConfig = lazyConfigBuilder().withAuthSecret("test-auth-secret").build();
+    Object.assign(mockedConfig, defaultConfig);
   });
 
   const mockGetTokenResult = {

src/utils/auth/get-jwt-token.ts

@@ -1,16 +1,15 @@
-import { AppConfig, configProvider } from "@src/utils/config";
+import lazyConfig from "@src/utils/lazy-config";
 import { JWT, getToken } from "next-auth/jwt";
 import { cookies, headers } from "next/headers";
 
 const getJwtToken = async (): Promise<JWT | null> => {
-  const config: AppConfig = await configProvider();
   const headerEntries = await headers();
   const cookieEntries = await cookies();
   const req = {
     headers: Object.fromEntries(headerEntries),
     cookies: Object.fromEntries(cookieEntries.getAll().map((c) => [c.name, c.value])),
   };
 
-  return await getToken({ req, secret: config.AUTH_SECRET, secureCookie: true });
+  return await getToken({ req, secret: (await lazyConfig.AUTH_SECRET) as string, secureCookie: true });
 };
 export { getJwtToken };

test-data/config/builders.tsx

@@ -88,6 +88,15 @@ class LazyConfigBuilder {
     return this.withNhsLoginClientId(value);
   }
 
+  public withNhsLoginScope(value: string): this {
+    this._configValues.NHS_LOGIN_SCOPE = value;
+    return this;
+  }
+
+  public andNhsLoginScope(value: string): this {
+    return this.withNhsLoginScope(value);
+  }
+
   public withNhsLoginPrivateKey(value: string): this {
     this._configValues.NHS_LOGIN_PRIVATE_KEY = value;
     return this;
@@ -125,6 +134,15 @@ class LazyConfigBuilder {
     return this.withEligibilityApiKey(value);
   }
 
+  public withAuthSecret(value: string): this {
+    this._configValues.AUTH_SECRET = value;
+    return this;
+  }
+
+  public andAuthSecret(value: string): this {
+    return this.withEligibilityApiKey(value);
+  }
+
   public build(): AsyncConfigMock {
     const asyncMock: AsyncConfigMock = {};
     for (const key in this._configValues) {