Added option to disable blue green to deployApi

Author: MatthewPopat-NHS

packages/cdkConstructs/src/specifications/deployApi.ts

@@ -57,18 +57,20 @@ export async function deployApi(
     proxygenKid,
     hiddenPaths
   }: ApiConfig,
-  dryRun: boolean
+  blueGreen: boolean = true,
+  dryRun: boolean = false
 ): Promise<void> {
-  const instance = fixSpec(
+  const instance = fixSpec({
     spec,
     apiName,
     version,
     apigeeEnvironment,
     isPullRequest,
     awsEnvironment,
     stackName,
-    mtlsSecretName
-  )
+    mtlsSecretName,
+    blueGreen
+  })
 
   const exports = await getCloudFormationExports()
   const clientCertArn = getCFConfigValue(exports, `account-resources:${clientCertExportName}`)

packages/cdkConstructs/src/specifications/fixSpec.ts

@@ -1,5 +1,18 @@
 import {calculateVersionedStackName} from "../config"
 
+type SpecConfig = {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  spec: any
+  apiName: string
+  version: string
+  apigeeEnvironment: string
+  isPullRequest: boolean
+  awsEnvironment: string
+  stackName: string
+  mtlsSecretName: string
+  blueGreen: boolean
+}
+
 function replaceSchemeRefs(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   spec: any,
@@ -15,17 +28,17 @@ function replaceSchemeRefs(
   }
 }
 
-export function fixSpec(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  spec: any,
-  apiName: string,
-  version: string,
-  apigeeEnvironment: string,
-  isPullRequest: boolean,
-  awsEnvironment: string,
-  stackName: string,
-  mtlsSecretName: string
-): string {
+export function fixSpec({
+  spec,
+  apiName,
+  version,
+  apigeeEnvironment,
+  isPullRequest,
+  awsEnvironment,
+  stackName,
+  mtlsSecretName,
+  blueGreen
+}: SpecConfig): string {
   let instance = apiName
   let stack = stackName
   if (isPullRequest) {
@@ -35,7 +48,9 @@ export function fixSpec(
     spec["x-nhsd-apim"].monitoring = false
     delete spec["x-nhsd-apim"].target.security.secret
   } else {
-    stack = calculateVersionedStackName(stackName, version)
+    if (blueGreen) {
+      stack = calculateVersionedStackName(stackName, version)
+    }
     spec["x-nhsd-apim"].target.security.secret = mtlsSecretName
   }
   spec.info.version = version

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

@@ -112,6 +112,7 @@ describe("deployApi", () => {
         apigeeEnvironment: "internal-dev",
         stackName: "eps-stack"
       }),
+      true,
       false
     )
 
@@ -150,6 +151,7 @@ describe("deployApi", () => {
         stackName: "eps-pr-stack-456",
         proxygenKid: "kid-789"
       }),
+      true,
       false
     )
 
@@ -169,6 +171,7 @@ describe("deployApi", () => {
         stackName: "eps-prod-stack",
         proxygenKid: "kid-prod"
       }),
+      true,
       false
     )
 
@@ -185,6 +188,7 @@ describe("deployApi", () => {
         stackName: "eps-int-stack",
         proxygenKid: "kid-int"
       }),
+      true,
       false
     )
 
@@ -211,6 +215,7 @@ describe("deployApi", () => {
         proxygenKid: "kid-int",
         hiddenPaths: ["/hidden"]
       }),
+      true,
       false
     )
     const publishPayload = payloadFromCall(2)
@@ -227,6 +232,7 @@ describe("deployApi", () => {
         stackName: "eps-int-stack",
         proxygenKid: "kid-int"
       }),
+      true,
       true
     )
 
@@ -247,6 +253,7 @@ describe("deployApi", () => {
         apigeeEnvironment: "int",
         stackName: "eps-stack"
       }),
+      true,
       false
     )).rejects.toThrow("Error calling lambda lambda-resources-ProxygenProdMTLSSecretPut: \"bad\"")
   })

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

@@ -30,22 +30,23 @@ describe("fixSpec", () => {
   test("sets version, mtls secret, target url and PTL refs for internal-dev", () => {
     const spec = createSpec()
 
-    const instance = fixSpec(
+    const instance = fixSpec({
       spec,
-      "eps",
-      "2.0.0",
-      "internal-dev",
-      false,
-      "nonprod",
-      "eps-stack",
-      "mtls/secret"
-    )
+      apiName: "eps",
+      version: "2.0.0",
+      apigeeEnvironment: "internal-dev",
+      isPullRequest: false,
+      awsEnvironment: "dev",
+      stackName: "eps-stack",
+      mtlsSecretName: "mtls/secret",
+      blueGreen: true
+    })
 
     expect(instance).toBe("eps")
     expect(spec.info.version).toBe("2.0.0")
     expect(spec["x-nhsd-apim"].target.security.secret).toBe("mtls/secret")
     expect(spec["x-nhsd-apim"].target.url)
-      .toBe("https://eps-stack-2-0-0.nonprod.eps.national.nhs.uk")
+      .toBe("https://eps-stack-2-0-0.dev.eps.national.nhs.uk")
     expect(spec.components.securitySchemes["nhs-cis2-aal3"].$ref)
       .toBe("https://proxygen.ptl.api.platform.nhs.uk/components/securitySchemes/nhs-cis2-aal3")
     expect(spec.servers[0].url)
@@ -55,16 +56,17 @@ describe("fixSpec", () => {
   test("handles pull request sandbox specs and removes sandbox-only fields", () => {
     const spec = createSpec()
 
-    const instance = fixSpec(
+    const instance = fixSpec({
       spec,
-      "eps",
-      "3.1.4",
-      "sandbox",
-      true,
-      "nonprod",
-      "eps-pr-stack-456",
-      "mtls/secret"
-    )
+      apiName: "eps",
+      version: "3.1.4",
+      apigeeEnvironment: "sandbox",
+      isPullRequest: true,
+      awsEnvironment: "int",
+      stackName: "eps-pr-stack-456",
+      mtlsSecretName: "mtls/secret",
+      blueGreen: true
+    })
 
     expect(instance).toBe("eps-pr-456")
     expect(spec.info.title).toBe("[PR-456] EPS API")
@@ -85,16 +87,17 @@ describe("fixSpec", () => {
       }
     })
 
-    const instance = fixSpec(
+    const instance = fixSpec({
       spec,
-      "eps",
-      "4.0.0",
-      "prod",
-      false,
-      "prod",
-      "eps-prod-stack",
-      "mtls/secret"
-    )
+      apiName: "eps",
+      version: "4.0.0",
+      apigeeEnvironment: "prod",
+      isPullRequest: false,
+      awsEnvironment: "prod",
+      stackName: "eps-prod-stack",
+      mtlsSecretName: "mtls/secret",
+      blueGreen: true
+    })
 
     expect(instance).toBe("eps")
     expect(spec.servers[0].url).toBe("https://api.service.nhs.uk/eps")
@@ -110,4 +113,24 @@ describe("fixSpec", () => {
         .toBe(`https://proxygen.prod.api.platform.nhs.uk/components/securitySchemes/${scheme}`)
     }
   })
+
+  test("does not version stack name when blueGreen is false", () => {
+    const spec = createSpec()
+
+    const instance = fixSpec({
+      spec,
+      apiName: "eps",
+      version: "1.2.3",
+      apigeeEnvironment: "internal-dev",
+      isPullRequest: false,
+      awsEnvironment: "dev",
+      stackName: "eps-stack",
+      mtlsSecretName: "mtls/secret",
+      blueGreen: false
+    })
+
+    expect(instance).toBe("eps")
+    expect(spec["x-nhsd-apim"].target.url)
+      .toBe("https://eps-stack.dev.eps.national.nhs.uk")
+  })
 })

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

@@ -135,4 +135,24 @@ describe("writeSchemas", () => {
     expect(message).toContain("failing.json")
     expect(err).toBeInstanceOf(Error)
   })
+
+  test("does not modify non-object schemas (collapseExamples type check)", () => {
+    const schemas = {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      primitive: true as any
+    }
+
+    const outputDir = "primitive-schemas"
+    const writes: Record<string, string> = {}
+
+    vi.spyOn(fs, "existsSync").mockReturnValue(true)
+    vi.spyOn(fs, "writeFileSync").mockImplementation((filePath, data) => {
+      writes[filePath.toString()] = data.toString()
+    })
+
+    writeSchemas(schemas, outputDir)
+
+    const writtenSchema = writes[path.join(outputDir, "primitive.json")]
+    expect(writtenSchema).toBe("true")
+  })
 })