Sonar fixes

Author: MatthewPopat-NHS

packages/cdkConstructs/src/specifications/deployApi.ts

@@ -2,36 +2,54 @@
 import {LambdaClient, InvokeCommand} from "@aws-sdk/client-lambda"
 import {getCFConfigValue, getCloudFormationExports} from "../config"
 
+export type ApiConfig = {
+  specification: string
+  apiName: string
+  version: string
+  apigeeEnvironment: string
+  isPullRequest: boolean
+  awsEnvironment: string
+  stackName: string
+  mtlsSecretName: string
+  clientCertExportName: string
+  clientPrivateKeyExportName: string
+  proxygenPrivateKeyExportName: string
+  proxygenKid: string
+}
+
 export async function deployApi(
-  specification: string,
-  apiName: string,
-  version: string,
-  apigeeEnvironment: string,
-  isPullRequest: boolean,
-  awsEnvironment: string,
-  stackName: string,
-  mtlsSecretName: string,
-  clientCertExportName: string,
-  clientPrivateKeyExportName: string,
-  proxygenPrivateKeyExportName: string,
-  proxygenKid: string,
+  {
+    specification,
+    apiName,
+    version,
+    apigeeEnvironment,
+    isPullRequest,
+    awsEnvironment,
+    stackName,
+    mtlsSecretName,
+    clientCertExportName,
+    clientPrivateKeyExportName,
+    proxygenPrivateKeyExportName,
+    proxygenKid
+  }: ApiConfig,
   dryRun: boolean
 ): Promise<void> {
   const lambda = new LambdaClient({})
   async function invokeLambda(functionName: string, payload: unknown): Promise<void> {
-    if (!dryRun) {
-      const invokeResult = await lambda.send(new InvokeCommand({
-        FunctionName: functionName,
-        Payload: Buffer.from(JSON.stringify(payload))
-      }))
-      const responsePayload = Buffer.from(invokeResult.Payload!).toString()
-      if (invokeResult.FunctionError) {
-        throw new Error(`Error calling lambda ${functionName}: ${responsePayload}`)
-      }
-      console.log(`Lambda ${functionName} invoked successfully. Response:`, responsePayload)
-    } else {
+    if (dryRun) {
       console.log(`Would invoke lambda ${functionName}`)
+      return
+    }
+
+    const invokeResult = await lambda.send(new InvokeCommand({
+      FunctionName: functionName,
+      Payload: Buffer.from(JSON.stringify(payload))
+    }))
+    const responsePayload = Buffer.from(invokeResult.Payload!).toString()
+    if (invokeResult.FunctionError) {
+      throw new Error(`Error calling lambda ${functionName}: ${responsePayload}`)
     }
+    console.log(`Lambda ${functionName} invoked successfully. Response:`, responsePayload)
   }
 
   let instance = apiName

packages/cdkConstructs/src/specifications/writeSchemas.ts

@@ -1,5 +1,5 @@
-import fs from "fs"
-import path from "path"
+import fs from "node:fs"
+import path from "node:path"
 import {JSONSchema} from "json-schema-to-ts"
 
 function isNotJSONSchemaArray(schema: JSONSchema | ReadonlyArray<JSONSchema>): schema is JSONSchema {
@@ -30,7 +30,7 @@ function collapseExamples(schema: JSONSchema): JSONSchema {
   if (schema.properties) {
     const properties: Record<string, JSONSchema> = {}
     for (const key in schema.properties) {
-      if (Object.prototype.hasOwnProperty.call(schema.properties, key)) {
+      if (Object.hasOwn(schema.properties, key)) {
         properties[key] = collapseExamples(schema.properties[key])
       }
     }
@@ -48,7 +48,7 @@ export function writeSchemas(
     fs.mkdirSync(outputDir, {recursive: true})
   }
   for (const name in schemas) {
-    if (Object.prototype.hasOwnProperty.call(schemas, name)) {
+    if (Object.hasOwn(schemas, name)) {
       const schema = schemas[name]
       const fileName = `${name}.json`
       const filePath = path.join(outputDir, fileName)

packages/cdkConstructs/tests/specifications/deployApi.test.ts

@@ -6,6 +6,7 @@ import {
   vi
 } from "vitest"
 import {deployApi} from "../../src/specifications/deployApi"
+import type {ApiConfig} from "../../src/specifications/deployApi"
 
 const lambdaSendMock = vi.fn()
 
@@ -20,8 +21,6 @@ vi.mock("@aws-sdk/client-lambda", () => {
   }
 
   class LambdaClient {
-    constructor() {}
-
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     send(command: any) {
       return lambdaSendMock(command)
@@ -64,39 +63,49 @@ const defaultExportsMap = {
   "account-resources:proxygenKey": "arn:proxygen-key"
 }
 
+function buildConfig(overrides: Partial<ApiConfig> = {}): ApiConfig {
+  return {
+    specification: JSON.stringify(createSpec()),
+    apiName: "eps",
+    version: "1.0.0",
+    apigeeEnvironment: "internal-dev",
+    isPullRequest: false,
+    awsEnvironment: "nonprod",
+    stackName: "eps-stack-001",
+    mtlsSecretName: "mtls/secret",
+    clientCertExportName: "clientCert",
+    clientPrivateKeyExportName: "clientKey",
+    proxygenPrivateKeyExportName: "proxygenKey",
+    proxygenKid: "kid-123",
+    ...overrides
+  }
+}
+
+function payloadFromCall(callIndex: number) {
+  const command = lambdaSendMock.mock.calls[callIndex][0] as {input: {Payload: Buffer}}
+  return JSON.parse(command.input.Payload.toString())
+}
+
+function functionNameFromCall(callIndex: number) {
+  const command = lambdaSendMock.mock.calls[callIndex][0] as {input: {FunctionName: string}}
+  return command.input.FunctionName
+}
+
 describe("deployApi", () => {
   beforeEach(() => {
     lambdaSendMock.mockReset().mockResolvedValue({Payload: Buffer.from('"ok"')})
     getCloudFormationExportsMock.mockReset()
   })
 
-  function payloadFromCall(callIndex: number) {
-    const command = lambdaSendMock.mock.calls[callIndex][0] as {input: {Payload: Buffer}}
-    return JSON.parse(command.input.Payload.toString())
-  }
-
-  function functionNameFromCall(callIndex: number) {
-    const command = lambdaSendMock.mock.calls[callIndex][0] as {input: {FunctionName: string}}
-    return command.input.FunctionName
-  }
-
   test("stores secrets, deploys instance and publishes spec for internal-dev", async () => {
-    const spec = JSON.stringify(createSpec())
     getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
 
     await deployApi(
-      spec,
-      "eps",
-      "2.0.0",
-      "internal-dev",
-      false,
-      "nonprod",
-      "eps-stack-001",
-      "mtls/secret",
-      "clientCert",
-      "clientKey",
-      "proxygenKey",
-      "kid-123",
+      buildConfig({
+        version: "2.0.0",
+        apigeeEnvironment: "internal-dev",
+        stackName: "eps-stack-001"
+      }),
       false
     )
 
@@ -135,22 +144,16 @@ describe("deployApi", () => {
   })
 
   test("handles pull requests in sandbox without storing secrets", async () => {
-    const spec = JSON.stringify(createSpec())
     getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
 
     await deployApi(
-      spec,
-      "eps",
-      "3.1.4",
-      "sandbox",
-      true,
-      "nonprod",
-      "eps-pr-stack-456",
-      "mtls/secret",
-      "clientCert",
-      "clientKey",
-      "proxygenKey",
-      "kid-789",
+      buildConfig({
+        version: "3.1.4",
+        apigeeEnvironment: "sandbox",
+        isPullRequest: true,
+        stackName: "eps-pr-stack-456",
+        proxygenKid: "kid-789"
+      }),
       false
     )
 
@@ -168,22 +171,16 @@ describe("deployApi", () => {
   })
 
   test("uses prod lambdas and prod security scheme refs", async () => {
-    const spec = JSON.stringify(createSpec())
     getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
 
     await deployApi(
-      spec,
-      "eps",
-      "4.0.0",
-      "prod",
-      false,
-      "prod",
-      "eps-prod-stack",
-      "mtls/secret",
-      "clientCert",
-      "clientKey",
-      "proxygenKey",
-      "kid-prod",
+      buildConfig({
+        version: "4.0.0",
+        apigeeEnvironment: "prod",
+        awsEnvironment: "prod",
+        stackName: "eps-prod-stack",
+        proxygenKid: "kid-prod"
+      }),
       false
     )
 
@@ -199,22 +196,15 @@ describe("deployApi", () => {
   })
 
   test("publishes spec to prod catalogue for int environment", async () => {
-    const spec = JSON.stringify(createSpec())
     getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
 
     await deployApi(
-      spec,
-      "eps",
-      "5.0.0",
-      "int",
-      false,
-      "nonprod",
-      "eps-int-stack",
-      "mtls/secret",
-      "clientCert",
-      "clientKey",
-      "proxygenKey",
-      "kid-int",
+      buildConfig({
+        version: "5.0.0",
+        apigeeEnvironment: "int",
+        stackName: "eps-int-stack",
+        proxygenKid: "kid-int"
+      }),
       false
     )
 
@@ -227,23 +217,15 @@ describe("deployApi", () => {
   })
 
   test("dry run only logs intended invocations", async () => {
-    const spec = JSON.stringify(createSpec())
     getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
     const logSpy = vi.spyOn(console, "log").mockImplementation(() => undefined)
 
     await deployApi(
-      spec,
-      "eps",
-      "1.0.0",
-      "int",
-      false,
-      "nonprod",
-      "eps-int-stack",
-      "mtls/secret",
-      "clientCert",
-      "clientKey",
-      "proxygenKey",
-      "kid-int",
+      buildConfig({
+        apigeeEnvironment: "int",
+        stackName: "eps-int-stack",
+        proxygenKid: "kid-int"
+      }),
       true
     )
 
@@ -255,24 +237,16 @@ describe("deployApi", () => {
   })
 
   test("throws when lambda invocation returns a FunctionError", async () => {
-    const spec = JSON.stringify(createSpec())
     getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
     lambdaSendMock
       .mockResolvedValueOnce({FunctionError: "Handled", Payload: Buffer.from('"bad"')})
 
     await expect(deployApi(
-      spec,
-      "eps",
-      "1.2.3",
-      "int",
-      false,
-      "nonprod",
-      "eps-stack",
-      "mtls/secret",
-      "clientCert",
-      "clientKey",
-      "proxygenKey",
-      "kid",
+      buildConfig({
+        version: "1.2.3",
+        apigeeEnvironment: "int",
+        stackName: "eps-stack"
+      }),
       false
     )).rejects.toThrow("Error calling lambda lambda-resources-ProxygenProdMTLSSecretPut: \"bad\"")
   })

packages/cdkConstructs/tests/specifications/writeSchemas.test.ts

@@ -1,5 +1,5 @@
-import fs from "fs"
-import path from "path"
+import fs from "node:fs"
+import path from "node:path"
 import {
   describe,
   test,

packages/cdkConstructs/tsconfig.json

@@ -12,7 +12,7 @@
     "outDir": "lib",
     "strict": true,
     "lib": [
-      "es2020"
+      "es2022"
     ],
     "noImplicitAny": true,
     "strictNullChecks": true,
@@ -32,6 +32,12 @@
       "../../node_modules/@types"
     ]
   },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "cdk.out", "tests/**/*"]
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "cdk.out",
+    "tests/**/*"
+  ]
 }