feat(cdk): enable API logging in tests

Author: coderbyheart

cdk/resources/ApiLogging.ts

@@ -0,0 +1,81 @@
+import {
+	aws_apigateway as ApiGateway,
+	aws_apigatewayv2 as ApiGatewayV2,
+	aws_iam as IAM,
+	aws_logs as Logs,
+	RemovalPolicy,
+	Stack,
+} from 'aws-cdk-lib'
+import { Construct } from 'constructs'
+
+export class ApiLogging extends Construct {
+	constructor(
+		parent: Construct,
+		api: ApiGatewayV2.CfnApi,
+		stage: ApiGatewayV2.CfnStage,
+	) {
+		super(parent, 'apiLogging')
+
+		const role = new IAM.Role(this, 'CloudWatchRole', {
+			assumedBy: new IAM.ServicePrincipal('apigateway.amazonaws.com'),
+			managedPolicies: [
+				IAM.ManagedPolicy.fromAwsManagedPolicyName(
+					'service-role/AmazonAPIGatewayPushToCloudWatchLogs',
+				),
+			],
+		})
+		const cloudWatchAccount = new ApiGateway.CfnAccount(this, 'Account', {
+			cloudWatchRoleArn: role.roleArn,
+		})
+		cloudWatchAccount.node.addDependency(api)
+		const apiLogs = new Logs.LogGroup(this, `apiLogs`, {
+			removalPolicy: RemovalPolicy.DESTROY,
+			logGroupName: `/${Stack.of(this).stackName}/websocket`,
+			retention: Logs.RetentionDays.ONE_DAY,
+		})
+		stage.accessLogSettings = {
+			destinationArn: apiLogs.logGroupArn,
+			format: JSON.stringify({
+				requestId: '$context.requestId',
+				awsEndpointRequestId: '$context.awsEndpointRequestId',
+				requestTime: '$context.requestTime',
+				ip: '$context.identity.sourceIp',
+				protocol: '$context.protocol',
+				routeKey: '$context.routeKey',
+				status: '$context.status',
+				responseLength: '$context.responseLength',
+				responseLatency: '$context.responseLatency',
+				integrationLatency: '$context.integrationLatency',
+				integrationStatus: '$context.integrationStatus',
+				integrationErrorMessage: '$context.integrationErrorMessage',
+				integration: {
+					error: '$context.integration.error',
+					status: '$context.integration.status',
+					requestId: '$context.integration.requestId',
+					integrationStatus: '$context.integration.integrationStatus',
+					latency: '$context.integration.latency', // The integration latency in ms. Equivalent to $context.integrationLatency.
+				},
+				authorize: {
+					error: '$context.authorize.error',
+					latency: '$context.authorize.latency',
+					status: '$context.authorize.status', // The status code returned from an authorization attempt.
+				},
+				authorizer: {
+					error: '$context.authorizer.error',
+					integrationLatency: '$context.authorizer.integrationLatency',
+					integrationStatus: '$context.authorizer.integrationStatus',
+					latency: '$context.authorizer.latency',
+					requestId: '$context.authorizer.requestId',
+					status: '$context.authorizer.status', // The status code returned from an authorizer.
+				},
+				authenticate: {
+					error: '$context.authenticate.error',
+					latency: '$context.authenticate.latency',
+					status: '$context.authenticate.status', // The status code returned from an authentication attempt.
+				},
+				xrayTraceId: '$context.xrayTraceId', // The trace ID for the X-Ray trace. For more information, see Setting up AWS X-Ray with API Gateway REST APIs.
+			}),
+		}
+		stage.node.addDependency(apiLogs)
+	}
+}

cdk/resources/WebsocketAPI.ts

@@ -1,5 +1,5 @@
 import {
-	aws_apigatewayv2 as ApiGateway,
+	aws_apigatewayv2 as ApiGatewayV2,
 	Duration,
 	aws_dynamodb as DynamoDB,
 	aws_events as Events,
@@ -12,6 +12,7 @@ import {
 } from 'aws-cdk-lib'
 import { Construct } from 'constructs'
 import type { PackedLambda } from '../helpers/lambdas/packLambda'
+import { ApiLogging } from './ApiLogging.js'
 import type { DeviceStorage } from './DeviceStorage.js'
 
 export const integrationUri = (
@@ -159,12 +160,12 @@ export class WebsocketAPI extends Construct {
 		})
 
 		// API
-		const api = new ApiGateway.CfnApi(this, 'api', {
+		const api = new ApiGatewayV2.CfnApi(this, 'api', {
 			name: 'websocketGateway',
 			protocolType: 'WEBSOCKET',
 			routeSelectionExpression: '$request.body.message',
 		})
-		const authorizer = new ApiGateway.CfnAuthorizer(this, 'authorizer', {
+		const authorizer = new ApiGatewayV2.CfnAuthorizer(this, 'authorizer', {
 			apiId: api.ref,
 			authorizerType: 'REQUEST',
 			name: `authorizer`,
@@ -174,7 +175,7 @@ export class WebsocketAPI extends Construct {
 			principal: new IAM.ServicePrincipal('apigateway.amazonaws.com'),
 		})
 		// API on connect
-		const connectIntegration = new ApiGateway.CfnIntegration(
+		const connectIntegration = new ApiGatewayV2.CfnIntegration(
 			this,
 			'connectIntegration',
 			{
@@ -184,7 +185,7 @@ export class WebsocketAPI extends Construct {
 				integrationUri: integrationUri(this, onConnect),
 			},
 		)
-		const connectRoute = new ApiGateway.CfnRoute(this, 'connectRoute', {
+		const connectRoute = new ApiGatewayV2.CfnRoute(this, 'connectRoute', {
 			apiId: api.ref,
 			routeKey: '$connect',
 			authorizationType: 'CUSTOM',
@@ -193,7 +194,7 @@ export class WebsocketAPI extends Construct {
 			authorizerId: authorizer?.ref,
 		})
 		// API on message
-		const onMessageIntegration = new ApiGateway.CfnIntegration(
+		const onMessageIntegration = new ApiGatewayV2.CfnIntegration(
 			this,
 			'onMessageIntegration',
 			{
@@ -203,15 +204,15 @@ export class WebsocketAPI extends Construct {
 				integrationUri: integrationUri(this, onMessage),
 			},
 		)
-		const onMessageRoute = new ApiGateway.CfnRoute(this, 'onMessageRoute', {
+		const onMessageRoute = new ApiGatewayV2.CfnRoute(this, 'onMessageRoute', {
 			apiId: api.ref,
 			routeKey: 'message',
 			authorizationType: 'NONE',
 			operationName: 'OnMessageRoute',
 			target: `integrations/${onMessageIntegration.ref}`,
 		})
 		// API on disconnect
-		const disconnectIntegration = new ApiGateway.CfnIntegration(
+		const disconnectIntegration = new ApiGatewayV2.CfnIntegration(
 			this,
 			'disconnectIntegration',
 			{
@@ -221,21 +222,21 @@ export class WebsocketAPI extends Construct {
 				integrationUri: integrationUri(this, onDisconnect),
 			},
 		)
-		const disconnectRoute = new ApiGateway.CfnRoute(this, 'disconnectRoute', {
+		const disconnectRoute = new ApiGatewayV2.CfnRoute(this, 'disconnectRoute', {
 			apiId: api.ref,
 			routeKey: '$disconnect',
 			authorizationType: 'NONE',
 			operationName: 'DisconnectRoute',
 			target: `integrations/${disconnectIntegration.ref}`,
 		})
 		// API deploy
-		const deployment = new ApiGateway.CfnDeployment(this, 'apiDeployment', {
+		const deployment = new ApiGatewayV2.CfnDeployment(this, 'apiDeployment', {
 			apiId: api.ref,
 		})
 		deployment.node.addDependency(connectRoute)
 		deployment.node.addDependency(onMessageRoute)
 		deployment.node.addDependency(disconnectRoute)
-		const prodStage = new ApiGateway.CfnStage(this, 'prodStage', {
+		const prodStage = new ApiGatewayV2.CfnStage(this, 'prodStage', {
 			stageName: '2023-06-22',
 			deploymentId: deployment.ref,
 			apiId: api.ref,
@@ -269,13 +270,22 @@ export class WebsocketAPI extends Construct {
 			}:${api.ref}/${prodStage.stageName}/$disconnect`,
 		})
 
+		// Construct URLs
+		this.websocketURI = `wss://${api.ref}.execute-api.${
+			Stack.of(this).region
+		}.amazonaws.com/${prodStage.ref}`
 		this.websocketAPIArn = `arn:aws:execute-api:${Stack.of(this).region}:${
 			Stack.of(this).account
 		}:${api.ref}/${prodStage.stageName}/POST/@connections/*`
 		this.websocketManagementAPIURL = `https://${api.ref}.execute-api.${
 			Stack.of(this).region
 		}.amazonaws.com/${prodStage.stageName}`
 
+		// Logging
+		if (this.node.tryGetContext('isTest') === true) {
+			new ApiLogging(this, api, prodStage)
+		}
+
 		// Publish event to sockets
 		const publishToWebsocketClients = new Lambda.Function(
 			this,