CCM-12875: rename some apim parameters

Author: Ian-Hodges

infrastructure/terraform/components/dl/module_lambda_apim_refresh_token.tf

@@ -37,11 +37,11 @@ module "lambda_lambda_apim_refresh_token" {
   log_subscription_role_arn = local.acct.log_subscription_role_arn
 
   lambda_env_vars = {
-    NHS_AUTH_SERVER_TOKEN_ENDPOINT  = var.apim_auth_token_url
-    SSM_ACCESS_TOKEN_PARAMETER_NAME = local.apim_access_token_ssm_parameter_name
-    SSM_API_KEY_PARAMETER_NAME      = local.apim_api_key_ssm_parameter_name
-    SSM_PRIVATE_KEY_PARAMETER_NAME  = local.apim_private_key_ssm_parameter_name
-    ENVIRONMENT                     = var.environment
+    APIM_AUTH_TOKEN_URL                  = var.apim_auth_token_url
+    APIM_ACCESS_TOKEN_SSM_PARAMETER_NAME = local.apim_access_token_ssm_parameter_name
+    APIM_API_KEY_SSM_PARAMETER_NAME      = local.apim_api_key_ssm_parameter_name
+    APIM_PRIVATE_KEY_SSM_PARAMETER_NAME  = local.apim_private_key_ssm_parameter_name
+    ENVIRONMENT                          = var.environment
   }
 }
 

lambdas/refresh-apim-access-token/README.md

@@ -41,8 +41,9 @@ The application is also exposed via a CLI which is useful for local testing. The
 
 Ensure you have the following environment variables set:
 
-- `NHS_AUTH_SERVER_TOKEN_ENDPOINT`
-- `SSM_ACCESS_TOKEN_PARAMETER_NAME`
-- `SSM_APIM_API_KEY_PARAMETER_NAME`
+- `APIM_AUTH_TOKEN_URL`
+- `APIM_ACCESS_TOKEN_SSM_PARAMETER_NAME`
+- `APIM_API_KEY_SSM_PARAMETER_NAME`
+- `APIM_PRIVATE_KEY_SSM_PARAMETER_NAME`
 
 Then run `pnpm run cli`.

lambdas/refresh-apim-access-token/src/__tests__/infra/container.test.ts

@@ -2,7 +2,7 @@ import { createContainer } from 'infra/container';
 
 jest.mock('infra/config', () => ({
   loadConfig: jest.fn(() => ({
-    ssmPrivateKeyParameterName: 'test-parameter-name',
+    apimPrivateKeySsmParameterName: 'test-parameter-name',
   })),
 }));
 

lambdas/refresh-apim-access-token/src/__tests__/infra/nhs-auth-client.test.ts

@@ -15,7 +15,7 @@ function setup() {
     },
   });
   const config = {
-    nhsAuthServerTokenEndpoint: 'fake_token_endpoint',
+    apimAuthTokenUrl: 'fake_token_url',
   };
 
   const mocks = { axios, config };
@@ -35,7 +35,7 @@ describe('NHSAuthClient', () => {
       expect(mocks.axios.post.mock.calls).toMatchInlineSnapshot(`
         [
           [
-            "fake_token_endpoint",
+            "fake_token_url",
             "grant_type=client_credentials&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&client_assertion=fake_jwt",
             {
               "headers": {

lambdas/refresh-apim-access-token/src/__tests__/infra/ssm-keystore.test.ts

@@ -12,8 +12,8 @@ function setup() {
   const getPrivateKey = jest.fn().mockResolvedValue(key);
 
   const config: Config = {
-    ssmAccessTokenParameterName: 'fake_access_token_parameter_name',
-    ssmApimApiKeyParameterName: 'fake_api_key_parameter_name',
+    apimAccessTokenSsmParameterName: 'fake_access_token_parameter_name',
+    apimApiKeySsmParameterName: 'fake_api_key_parameter_name',
   };
 
   // @ts-ignore

lambdas/refresh-apim-access-token/src/infra/config.ts

@@ -2,17 +2,17 @@ import { defaultConfigReader } from 'utils';
 
 export function loadConfig() {
   return {
-    nhsAuthServerTokenEndpoint: defaultConfigReader.getValue(
-      'NHS_AUTH_SERVER_TOKEN_ENDPOINT',
+    apimAuthTokenUrl: defaultConfigReader.getValue(
+      'APIM_AUTH_TOKEN_URL',
     ),
-    ssmAccessTokenParameterName: defaultConfigReader.getValue(
-      'SSM_ACCESS_TOKEN_PARAMETER_NAME',
+    apimAccessTokenSsmParameterName: defaultConfigReader.getValue(
+      'APIM_ACCESS_TOKEN_SSM_PARAMETER_NAME',
     ),
-    ssmApimApiKeyParameterName: defaultConfigReader.getValue(
-      'SSM_API_KEY_PARAMETER_NAME',
+    apimApiKeySsmParameterName: defaultConfigReader.getValue(
+      'APIM_API_KEY_SSM_PARAMETER_NAME',
     ),
-    ssmPrivateKeyParameterName: defaultConfigReader.getValue(
-      'SSM_PRIVATE_KEY_PARAMETER_NAME',
+    apimPrivateKeySsmParameterName: defaultConfigReader.getValue(
+      'APIM_PRIVATE_KEY_SSM_PARAMETER_NAME',
     ),
   };
 }

lambdas/refresh-apim-access-token/src/infra/container.ts

@@ -11,7 +11,7 @@ import { loadConfig } from 'infra/config';
 export function createContainer() {
   const config = loadConfig();
   const { getPrivateKey } = privateKeyFetcher(
-    config.ssmPrivateKeyParameterName,
+    config.apimPrivateKeySsmParameterName,
   );
 
   return {

lambdas/refresh-apim-access-token/src/infra/nhs-auth-client.ts

@@ -12,7 +12,7 @@ type RawAccessToken = {
 };
 
 type Config = {
-  nhsAuthServerTokenEndpoint: string;
+  apimAuthTokenUrl: string;
 };
 
 export class NHSAuthClient {
@@ -23,7 +23,7 @@ export class NHSAuthClient {
   ) {}
 
   get tokenEndpoint(): string {
-    return this._config.nhsAuthServerTokenEndpoint;
+    return this._config.apimAuthTokenUrl;
   }
 
   async getAccessToken(jwt: string): Promise<ApimAccessToken> {

lambdas/refresh-apim-access-token/src/infra/ssm-keystore.ts

@@ -7,8 +7,8 @@ import {
 import type { ApimAccessToken, Logger } from 'utils';
 
 export type Config = {
-  ssmAccessTokenParameterName: string;
-  ssmApimApiKeyParameterName: string;
+  apimAccessTokenSsmParameterName: string;
+  apimApiKeySsmParameterName: string;
 };
 
 type Key = {
@@ -54,7 +54,7 @@ export class SSMKeyStore {
     try {
       result = await this._client.send(
         new GetParameterCommand({
-          Name: this._config.ssmApimApiKeyParameterName,
+          Name: this._config.apimApiKeySsmParameterName,
           WithDecryption: true,
         }),
       );
@@ -93,7 +93,7 @@ export class SSMKeyStore {
     try {
       await this._client.send(
         new PutParameterCommand({
-          Name: this._config.ssmAccessTokenParameterName,
+          Name: this._config.apimAccessTokenSsmParameterName,
           Value: JSON.stringify(accessToken),
           Overwrite: true,
         }),