skuba 8.2.1 → 9.0.0-main-20240918063050

package/template/lambda-sqs-worker-cdk/infra/appStack.test.ts

@@ -50,8 +50,11 @@ it.each(['dev', 'prod'])(
       .replaceAll(
         /workerCurrentVersion([0-9a-zA-Z]+)"/g,
         (_, hash) => `workerCurrentVersion${'x'.repeat(hash.length)}"`,
+      )
+      .replaceAll(
+        /"Value":"\d+\.\d+\.\d+-([^"]+)"/g,
+        (_, hash) => `"Value": "x.x.x-${'x'.repeat(hash.length)}"`,
       );
-
     expect(JSON.parse(json)).toMatchSnapshot();
   },
 );

package/template/lambda-sqs-worker-cdk/infra/appStack.ts

@@ -1,9 +1,8 @@
+import { LambdaDeployment } from '@seek/aws-codedeploy-infra';
 import {
   Duration,
   Stack,
   type StackProps,
-  aws_cloudwatch,
-  aws_codedeploy,
   aws_iam,
   aws_kms,
   aws_lambda,
@@ -99,90 +98,12 @@ export class AppStack extends Stack {
       reservedConcurrentExecutions: config.workerLambda.reservedConcurrency,
     });
 
-    const alias = worker.addAlias('live', {
-      description: 'The Lambda version currently receiving traffic',
+    const workerDeployment = new LambdaDeployment(this, 'workerDeployment', {
+      lambdaFunction: worker,
     });
 
-    alias.addEventSource(
-      new aws_lambda_event_sources.SqsEventSource(queue, {
-        maxConcurrency: config.workerLambda.reservedConcurrency,
-      }),
+    workerDeployment.alias.addEventSource(
+      new aws_lambda_event_sources.SqsEventSource(queue),
     );
-
-    const preHook = new aws_lambda_nodejs.NodejsFunction(
-      this,
-      'worker-pre-hook',
-      {
-        ...defaultWorkerConfig,
-        entry: './src/preHook.ts',
-        timeout: Duration.seconds(120),
-        bundling: defaultWorkerBundlingConfig,
-        functionName: '<%- serviceName %>-pre-hook',
-        environment: {
-          ...defaultWorkerEnvironment,
-          ...config.workerLambda.environment,
-          FUNCTION_NAME_TO_INVOKE: worker.functionName,
-        },
-      },
-    );
-
-    worker.grantInvoke(preHook);
-
-    const postHook = new aws_lambda_nodejs.NodejsFunction(
-      this,
-      'worker-post-hook',
-      {
-        ...defaultWorkerConfig,
-        entry: './src/postHook.ts',
-        timeout: Duration.seconds(30),
-        bundling: defaultWorkerBundlingConfig,
-        functionName: '<%- serviceName %>-post-hook',
-        environment: {
-          ...defaultWorkerEnvironment,
-          ...config.workerLambda.environment,
-          FUNCTION_NAME_TO_PRUNE: worker.functionName,
-        },
-      },
-    );
-
-    const prunePermissions = new aws_iam.PolicyStatement({
-      actions: [
-        'lambda:ListAliases',
-        'lambda:ListVersionsByFunction',
-        'lambda:DeleteFunction',
-      ],
-      resources: [worker.functionArn, `${worker.functionArn}:*`],
-    });
-
-    postHook.addToRolePolicy(prunePermissions);
-
-    const application = new aws_codedeploy.LambdaApplication(
-      this,
-      'codedeploy-application',
-    );
-
-    const deploymentGroup = new aws_codedeploy.LambdaDeploymentGroup(
-      this,
-      'codedeploy-group',
-      {
-        application,
-        alias,
-        deploymentConfig: aws_codedeploy.LambdaDeploymentConfig.ALL_AT_ONCE,
-      },
-    );
-
-    const alarm = new aws_cloudwatch.Alarm(this, 'codedeploy-alarm', {
-      metric: alias.metricErrors({
-        period: Duration.seconds(60),
-      }),
-      threshold: 1,
-      evaluationPeriods: 1,
-    });
-
-    deploymentGroup.addAlarm(alarm);
-
-    deploymentGroup.addPreHook(preHook);
-
-    deploymentGroup.addPostHook(postHook);
   }
 }

package/template/lambda-sqs-worker-cdk/infra/config.ts

@@ -4,7 +4,7 @@ const ENVIRONMENTS = ['dev', 'prod'] as const;
 
 type Environment = (typeof ENVIRONMENTS)[number];
 
-const environment = Env.oneOf(ENVIRONMENTS)('ENVIRONMENT');
+export const environment = Env.oneOf(ENVIRONMENTS)('ENVIRONMENT');
 
 interface Config {
   appName: string;

package/template/lambda-sqs-worker-cdk/infra/index.ts

@@ -1,11 +1,28 @@
+import { HookStack } from '@seek/aws-codedeploy-infra';
 import { App } from 'aws-cdk-lib';
 
 import { AppStack } from './appStack';
-import { config } from './config';
+import { config, environment } from './config';
 
 const app = new App();
 
-// eslint-disable-next-line no-new
-new AppStack(app, 'appStack', {
+const appStack = new AppStack(app, 'appStack', {
   stackName: config.appName,
+  tags: {
+    'seek:env:label': environment,
+    'seek:source:sha': process.env.BUILDKITE_COMMIT ?? 'na',
+    // 'seek:source:url': 'TODO: add source URL',
+    // 'seek:system:name': 'TODO: add system name',
+  },
 });
+
+/**
+ * TODO: If deploying multiple stacks in one AWS account, deploy HookStack centrally rather than here
+ * You can find the envisioned workflow here: {@link https://github.com/seek-oss/skuba/issues/1640#issuecomment-2323854827}
+ */
+const hookStack = new HookStack(app, 'hookStack');
+
+// ensure that hookStack (codedeploy preTraffic) is deployed before appStack
+appStack.addDependency(hookStack);
+
+app.synth();

package/template/lambda-sqs-worker-cdk/package.json

@@ -21,15 +21,16 @@
     "zod": "^3.19.1"
   },
   "devDependencies": {
+    "@seek/aws-codedeploy-infra": "^2.1.0",
     "@types/aws-lambda": "^8.10.82",
-    "@types/node": "^20.9.0",
+    "@types/node": "^20.16.5",
     "aws-cdk": "^2.109.0",
     "aws-cdk-lib": "^2.109.0",
     "constructs": "^10.0.17",
     "pino-pretty": "^11.0.0",
-    "skuba": "*"
+    "skuba": "9.0.0-main-20240918063050"
   },
-  "packageManager": "pnpm@9.4.0",
+  "packageManager": "pnpm@9.10.0",
   "engines": {
     "node": ">=20"
   }

package/template/oss-npm-package/.github/workflows/release.yml

@@ -37,4 +37,4 @@ jobs:
         run: pnpm release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.SEEK_OSS_CI_NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/template/oss-npm-package/_package.json

@@ -34,7 +34,7 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@types/node": "^18.19.8",
+    "@types/node": "^20.16.5",
     "commitizen": "^4.2.4",
     "skuba": "*"
   },

package/template/private-npm-package/_package.json

@@ -34,7 +34,7 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@types/node": "^18.19.8",
+    "@types/node": "^20.16.5",
     "commitizen": "^4.2.4",
     "skuba": "*"
   },

package/template/lambda-sqs-worker-cdk/src/postHook.ts

@@ -1,154 +0,0 @@
-/* eslint-disable no-console */
-/* istanbul ignore file */
-
-import {
-  CodeDeploy,
-  PutLifecycleEventHookExecutionStatusCommand,
-} from '@aws-sdk/client-codedeploy';
-import {
-  type AliasConfiguration,
-  DeleteFunctionCommand,
-  type FunctionConfiguration,
-  LambdaClient,
-  ListAliasesCommand,
-  ListVersionsByFunctionCommand,
-} from '@aws-sdk/client-lambda';
-import { z } from 'zod';
-
-const lambda = new LambdaClient();
-const codeDeploy = new CodeDeploy();
-
-const listLambdaVersions = async (
-  functionName: string,
-  marker?: string,
-): Promise<FunctionConfiguration[]> => {
-  const result = await lambda.send(
-    new ListVersionsByFunctionCommand({
-      FunctionName: functionName,
-      Marker: marker,
-    }),
-  );
-  const versions = result.Versions ?? [];
-  if (result.NextMarker) {
-    return [
-      ...versions,
-      ...(await listLambdaVersions(functionName, result.NextMarker)),
-    ];
-  }
-
-  return versions;
-};
-
-const listAliases = async (
-  functionName: string,
-  marker?: string,
-): Promise<AliasConfiguration[]> => {
-  const result = await lambda.send(
-    new ListAliasesCommand({
-      FunctionName: functionName,
-      Marker: marker,
-    }),
-  );
-  const aliases = result.Aliases ?? [];
-  if (result.NextMarker) {
-    return [
-      ...aliases,
-      ...(await listAliases(functionName, result.NextMarker)),
-    ];
-  }
-
-  return aliases;
-};
-
-const pruneLambdas = async (
-  functionName: string,
-  numberToKeep: number,
-): Promise<void> => {
-  const [aliases, versions] = await Promise.all([
-    listAliases(functionName),
-    listLambdaVersions(functionName),
-  ]);
-
-  const aliasMap = new Map(
-    aliases.flatMap((alias) =>
-      alias.FunctionVersion ? [[alias.FunctionVersion, alias]] : [],
-    ),
-  );
-
-  const versionsToPrune = versions
-    .filter(
-      (version) =>
-        version.Version &&
-        !aliasMap.has(version.Version) &&
-        version.Version !== '$LATEST',
-    )
-    .sort((a, b) => Number(b.Version) - Number(a.Version))
-    .slice(numberToKeep);
-
-  if (!versionsToPrune.length) {
-    console.log('No function versions to prune');
-    return;
-  }
-
-  console.log(
-    `Pruning function versions: ${versionsToPrune
-      .map((version) => version.Version)
-      .join(', ')}`,
-  );
-
-  await Promise.all(
-    versionsToPrune.map((version) =>
-      lambda.send(
-        new DeleteFunctionCommand({
-          FunctionName: version.FunctionName,
-          Qualifier: version.Version,
-        }),
-      ),
-    ),
-  );
-};
-
-const EnvSchema = z.object({
-  FUNCTION_NAME_TO_PRUNE: z.string(),
-  NUMBER_OF_VERSIONS_TO_KEEP: z.coerce.number().default(0),
-});
-
-type Status = 'Succeeded' | 'Failed';
-
-/**
- * The event supplied to a CodeDeploy lifecycle hook Lambda function.
- *
- * {@link https://docs.aws.amazon.com/codedeploy/latest/userguide/tutorial-ecs-with-hooks-create-hooks.html}
- */
-interface CodeDeployLifecycleHookEvent {
-  DeploymentId: string;
-  LifecycleEventHookExecutionId: string;
-}
-
-/**
- * A handler to clean up old Lambda function versions and layers
- */
-export const handler = async (
-  event: CodeDeployLifecycleHookEvent,
-): Promise<void> => {
-  let status: Status = 'Succeeded';
-  try {
-    const {
-      FUNCTION_NAME_TO_PRUNE: functionName,
-      NUMBER_OF_VERSIONS_TO_KEEP: numberToKeep,
-    } = EnvSchema.parse(process.env);
-
-    await pruneLambdas(functionName, numberToKeep);
-  } catch (err) {
-    console.error('Exception:', err);
-    status = 'Failed';
-  }
-
-  await codeDeploy.send(
-    new PutLifecycleEventHookExecutionStatusCommand({
-      deploymentId: event.DeploymentId,
-      lifecycleEventHookExecutionId: event.LifecycleEventHookExecutionId,
-      status,
-    }),
-  );
-};

package/template/lambda-sqs-worker-cdk/src/preHook.ts

@@ -1,95 +0,0 @@
-/* eslint-disable no-console */
-/* istanbul ignore file */
-
-// Use minimal dependencies to reduce the chance of crashes on module load.
-import {
-  CodeDeployClient,
-  PutLifecycleEventHookExecutionStatusCommand,
-} from '@aws-sdk/client-codedeploy';
-import { InvokeCommand, LambdaClient } from '@aws-sdk/client-lambda';
-
-const codeDeploy = new CodeDeployClient({
-  apiVersion: '2014-10-06',
-  maxAttempts: 5,
-});
-
-const lambda = new LambdaClient({
-  apiVersion: '2015-03-31',
-  maxAttempts: 5,
-});
-
-type Status = 'Succeeded' | 'Failed';
-
-/**
- * Synchronously invokes a Lambda function with a smoke test event.
- *
- * Any non-error response is treated as a success.
- */
-const smokeTestLambdaFunction = async (): Promise<Status> => {
-  const functionName = process.env.FUNCTION_NAME_TO_INVOKE;
-
-  if (!functionName) {
-    console.error('Missing process.env.FUNCTION_NAME_TO_INVOKE');
-    return 'Failed';
-  }
-
-  console.info('Function:', functionName);
-
-  const response = await lambda.send(
-    new InvokeCommand({
-      FunctionName: functionName,
-      InvocationType: 'RequestResponse',
-      // Treat an empty object as our smoke test event.
-      Payload: Buffer.from('{}'),
-    }),
-  );
-
-  console.info('Version:', response.ExecutedVersion ?? '?');
-  console.info('Status', response.StatusCode ?? '?');
-
-  if (response.FunctionError) {
-    console.error('Error:', response.FunctionError);
-    if (response.Payload) {
-      console.error(response.Payload.transformToString());
-    }
-    return 'Failed';
-  }
-
-  return response.StatusCode === 200 ? 'Succeeded' : 'Failed';
-};
-
-/**
- * The event supplied to a CodeDeploy lifecycle hook Lambda function.
- *
- * {@link https://docs.aws.amazon.com/codedeploy/latest/userguide/tutorial-ecs-with-hooks-create-hooks.html}
- */
-interface CodeDeployLifecycleHookEvent {
-  DeploymentId: string;
-  LifecycleEventHookExecutionId: string;
-}
-
-/**
- * A handler to smoke test a new Lambda function version before it goes live.
- *
- * This tries to be exception safe so that a status reaches CodeDeploy. If we
- * crash or otherwise fail to report back, the deployment will hang for an hour.
- */
-export const handler = async (
-  event: CodeDeployLifecycleHookEvent,
-): Promise<void> => {
-  let status: Status;
-  try {
-    status = await smokeTestLambdaFunction();
-  } catch (err) {
-    console.error('Exception:', err);
-    status = 'Failed';
-  }
-
-  await codeDeploy.send(
-    new PutLifecycleEventHookExecutionStatusCommand({
-      deploymentId: event.DeploymentId,
-      lifecycleEventHookExecutionId: event.LifecycleEventHookExecutionId,
-      status,
-    }),
-  );
-};