test(e2e): disable metrics in tests

coderbyheart · coderbyheart · commit a556d3ead62f · 2023-06-29T13:35:39.000+02:00
diff --git a/.github/workflows/test-and-release.yaml b/.github/workflows/test-and-release.yaml
@@ -75,6 +75,8 @@ jobs:
           ./cli.sh configure thirdParty nrfcloud apiKey apiKey
 
       - name: Deploy solution stack
+        env:
+          IS_TEST: 1
         run: npx cdk deploy --require-approval never
 
       - name: Run End-to-End Tests
diff --git a/cdk/BackendApp.ts b/cdk/BackendApp.ts
@@ -2,9 +2,16 @@ import { App } from 'aws-cdk-lib'
 import { BackendStack } from './stacks/BackendStack.js'
 
 export class BackendApp extends App {
-	public constructor(args: ConstructorParameters<typeof BackendStack>[1]) {
-		super()
+	public constructor({
+		isTest,
+		...rest
+	}: ConstructorParameters<typeof BackendStack>[1] & { isTest: boolean }) {
+		super({
+			context: {
+				isTest,
+			},
+		})
 
-		new BackendStack(this, args)
+		new BackendStack(this, rest)
 	}
 }
diff --git a/cdk/backend.ts b/cdk/backend.ts
@@ -103,4 +103,5 @@ new BackendApp({
 		iam,
 	}),
 	env: accountEnv,
+	isTest: process.env.IS_TEST === '1',
 })
diff --git a/cdk/resources/ConvertDeviceMessages.ts b/cdk/resources/ConvertDeviceMessages.ts
@@ -49,6 +49,7 @@ export class ConvertDeviceMessages extends Construct {
 				DEVICES_TABLE_NAME: deviceStorage.devicesTable.tableName,
 				DEVICES_INDEX_NAME: deviceStorage.devicesTableFingerprintIndexName,
 				NODE_NO_WARNINGS: '1',
+				DISABLE_METRICS: this.node.tryGetContext('isTest') === true ? '1' : '0',
 			},
 			layers,
 			logRetention: Logs.RetentionDays.ONE_WEEK,
diff --git a/cdk/resources/DeviceShadow.ts b/cdk/resources/DeviceShadow.ts
@@ -82,6 +82,8 @@ export class DeviceShadow extends Construct {
 					QUEUE_URL: shadowQueue.queueUrl,
 					LOG_LEVEL: this.node.tryGetContext('logLevel'),
 					NODE_NO_WARNINGS: '1',
+					DISABLE_METRICS:
+						this.node.tryGetContext('isTest') === true ? '1' : '0',
 				},
 				initialPolicy: [],
 				layers,
@@ -108,6 +110,7 @@ export class DeviceShadow extends Construct {
 				LOG_LEVEL: this.node.tryGetContext('logLevel'),
 				STACK_NAME: Stack.of(this).stackName,
 				NODE_NO_WARNINGS: '1',
+				DISABLE_METRICS: this.node.tryGetContext('isTest') === true ? '1' : '0',
 			},
 			initialPolicy: [
 				new IAM.PolicyStatement({
diff --git a/cdk/resources/HealthCheckMqttBridge.ts b/cdk/resources/HealthCheckMqttBridge.ts
@@ -55,6 +55,7 @@ export class HealthCheckMqttBridge extends Construct {
 				STACK_NAME: Stack.of(this).stackName,
 				DEVICES_TABLE_NAME: deviceStorage.devicesTable.tableName,
 				WEBSOCKET_URL: websocketAPI.websocketURI,
+				DISABLE_METRICS: this.node.tryGetContext('isTest') === true ? '1' : '0',
 			},
 			initialPolicy: [],
 			layers,
diff --git a/cdk/resources/HistoricalData.ts b/cdk/resources/HistoricalData.ts
@@ -66,6 +66,8 @@ export class HistoricalData extends Construct {
 					LOG_LEVEL: this.node.tryGetContext('logLevel'),
 					HISTORICAL_DATA_TABLE_INFO: this.table.ref,
 					NODE_NO_WARNINGS: '1',
+					DISABLE_METRICS:
+						this.node.tryGetContext('isTest') === true ? '1' : '0',
 				},
 				layers,
 				initialPolicy: [
diff --git a/cdk/resources/WebsocketAPI.ts b/cdk/resources/WebsocketAPI.ts
@@ -85,6 +85,7 @@ export class WebsocketAPI extends Construct {
 				EVENTBUS_NAME: this.eventBus.eventBusName,
 				LOG_LEVEL: this.node.tryGetContext('logLevel'),
 				NODE_NO_WARNINGS: '1',
+				DISABLE_METRICS: this.node.tryGetContext('isTest') === true ? '1' : '0',
 			},
 			layers,
 			logRetention: Logs.RetentionDays.ONE_WEEK,
@@ -106,6 +107,7 @@ export class WebsocketAPI extends Construct {
 				WEBSOCKET_CONNECTIONS_TABLE_NAME: this.connectionsTable.tableName,
 				LOG_LEVEL: this.node.tryGetContext('logLevel'),
 				NODE_NO_WARNINGS: '1',
+				DISABLE_METRICS: this.node.tryGetContext('isTest') === true ? '1' : '0',
 			},
 			layers,
 			logRetention: Logs.RetentionDays.ONE_WEEK,
@@ -127,6 +129,7 @@ export class WebsocketAPI extends Construct {
 				EVENTBUS_NAME: this.eventBus.eventBusName,
 				LOG_LEVEL: this.node.tryGetContext('logLevel'),
 				NODE_NO_WARNINGS: '1',
+				DISABLE_METRICS: this.node.tryGetContext('isTest') === true ? '1' : '0',
 			},
 			layers,
 			logRetention: Logs.RetentionDays.ONE_WEEK,
@@ -151,6 +154,7 @@ export class WebsocketAPI extends Construct {
 				DEVICES_INDEX_NAME: deviceStorage.devicesTableFingerprintIndexName,
 				LOG_LEVEL: this.node.tryGetContext('logLevel'),
 				NODE_NO_WARNINGS: '1',
+				DISABLE_METRICS: this.node.tryGetContext('isTest') === true ? '1' : '0',
 			},
 			initialPolicy: [
 				new IAM.PolicyStatement({
@@ -305,6 +309,8 @@ export class WebsocketAPI extends Construct {
 					EVENTBUS_NAME: this.eventBus.eventBusName,
 					LOG_LEVEL: this.node.tryGetContext('logLevel'),
 					NODE_NO_WARNINGS: '1',
+					DISABLE_METRICS:
+						this.node.tryGetContext('isTest') === true ? '1' : '0',
 				},
 				initialPolicy: [
 					new IAM.PolicyStatement({
diff --git a/lambda/authorizer.ts b/lambda/authorizer.ts
@@ -1,13 +1,10 @@
-import {
-	MetricUnits,
-	Metrics,
-	logMetrics,
-} from '@aws-lambda-powertools/metrics'
+import { MetricUnits, logMetrics } from '@aws-lambda-powertools/metrics'
 import { DynamoDBClient, QueryCommand } from '@aws-sdk/client-dynamodb'
 import { unmarshall } from '@aws-sdk/util-dynamodb'
 import middy from '@middy/core'
 import { fromEnv } from '@nordicsemiconductor/from-env'
 import type { PolicyDocument } from 'aws-lambda'
+import { metricsForComponent } from './metrics/metrics.js'
 import { logger } from './util/logger.js'
 import type { WebsocketConnectionContext } from './ws/AuthorizedEvent.js'
 
@@ -19,10 +16,7 @@ const { DevicesTableName, DevicesIndexName } = fromEnv({
 const log = logger('connect')
 const db = new DynamoDBClient({})
 
-const metrics = new Metrics({
-	namespace: 'hello-nrfcloud-backend',
-	serviceName: 'websocket',
-})
+const { track, metrics } = metricsForComponent('websocket')
 
 /**
  * Verifies the fingerprint passed as a query parameter and creates a context for the websocket connect that includes the deviceId and the model.
@@ -57,7 +51,7 @@ const h = async (event: {
 	const fingerprint = event.queryStringParameters?.fingerprint
 	if (fingerprint === undefined) {
 		log.error(`Fingerprint cannot be empty`)
-		metrics.addMetric('authorizer:badRequest', MetricUnits.Count, 1)
+		track('authorizer:badRequest', MetricUnits.Count, 1)
 		return deny
 	}
 	const res = await db.send(
@@ -79,12 +73,12 @@ const h = async (event: {
 	const device = res.Items?.[0] !== undefined ? unmarshall(res.Items[0]) : null
 	if (device === null) {
 		log.error(`DeviceId is not found with`, { fingerprint })
-		metrics.addMetric('authorizer:badFingerprint', MetricUnits.Count, 1)
+		track('authorizer:badFingerprint', MetricUnits.Count, 1)
 		return deny
 	}
 
 	log.debug(`Connection request for fingerprint ${fingerprint} authorized.`)
-	metrics.addMetric('authorizer:success', MetricUnits.Count, 1)
+	track('authorizer:success', MetricUnits.Count, 1)
 
 	const { model, deviceId } = device
 
diff --git a/lambda/fetchDeviceShadow.ts b/lambda/fetchDeviceShadow.ts
@@ -1,8 +1,4 @@
-import {
-	logMetrics,
-	Metrics,
-	MetricUnits,
-} from '@aws-lambda-powertools/metrics'
+import { logMetrics, MetricUnits } from '@aws-lambda-powertools/metrics'
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
 import {
 	EventBridgeClient,
@@ -19,14 +15,12 @@ import {
 	type WebsocketDeviceConnectionShadowInfo,
 } from '../websocket/connectionsRepository.js'
 import { createLock } from '../websocket/lock.js'
+import { metricsForComponent } from './metrics/metrics.js'
 import type { WebsocketPayload } from './publishToWebsocketClients.js'
 import { configureDeviceShadowFetcher } from './shadow/configureDeviceShadowFetcher.js'
 import { logger } from './util/logger.js'
 
-const metrics = new Metrics({
-	namespace: 'hello-nrfcloud-backend',
-	serviceName: 'shadowFetcher',
-})
+const { track, metrics } = metricsForComponent('shadowFetcher')
 
 const {
 	websocketDeviceConnectionsTableName,
@@ -69,7 +63,7 @@ const h = async (): Promise<void> => {
 		const deviceShadow = await getShadowFetcher()
 		const connections = await connectionsRepo.getAll()
 		log.info(`Found ${connections.length} active connections`)
-		metrics.addMetric('connections', MetricUnits.Count, connections.length)
+		track('connections', MetricUnits.Count, connections.length)
 		const deviceConnectionsMap = connections.reduce(
 			(map, connection) => ({
 				...map,
@@ -90,7 +84,7 @@ const h = async (): Promise<void> => {
 						const res = await deviceShadow(
 							devices.map((device) => device.deviceId),
 						)
-						metrics.addMetric(
+						track(
 							'apiResponseTime',
 							MetricUnits.Milliseconds,
 							Date.now() - start,
@@ -113,7 +107,7 @@ const h = async (): Promise<void> => {
 					isChanged: d.version !== deviceShadow.state.version,
 				})
 
-				metrics.addMetric(
+				track(
 					'shadowVersionDelta',
 					MetricUnits.Count,
 					deviceShadow.state.version - (d.version ?? 0),
@@ -125,12 +119,12 @@ const h = async (): Promise<void> => {
 				)
 
 				if (!isUpdated) {
-					metrics.addMetric('shadowStale', MetricUnits.Count, 1)
+					track('shadowStale', MetricUnits.Count, 1)
 					continue
 				}
 
-				metrics.addMetric('shadowUpdated', MetricUnits.Count, 1)
-				metrics.addMetric(
+				track('shadowUpdated', MetricUnits.Count, 1)
+				track(
 					'shadowAge',
 					MetricUnits.Seconds,
 					Math.round(Date.now() / 1000) -
@@ -145,7 +139,7 @@ const h = async (): Promise<void> => {
 								message,
 							)} from model ${model}: ${error}`,
 						)
-						metrics.addMetric('shadowConversionFailed', MetricUnits.Count, 1)
+						track('shadowConversionFailed', MetricUnits.Count, 1)
 					},
 				})(model, deviceShadow.state)
 
diff --git a/lambda/healthCheck.ts b/lambda/healthCheck.ts
@@ -1,8 +1,4 @@
-import {
-	MetricUnits,
-	Metrics,
-	logMetrics,
-} from '@aws-lambda-powertools/metrics'
+import { MetricUnits, logMetrics } from '@aws-lambda-powertools/metrics'
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
 import { SSMClient } from '@aws-sdk/client-ssm'
 import middy from '@middy/core'
@@ -17,6 +13,7 @@ import {
 	type Settings,
 } from '../nrfcloud/settings.js'
 import { defer } from '../util/defer.js'
+import { metricsForComponent } from './metrics/metrics.js'
 import { logger } from './util/logger.js'
 
 const { DevicesTableName, stackName, websocketUrl } = fromEnv({
@@ -29,10 +26,7 @@ const log = logger('healthCheck')
 const db = new DynamoDBClient({})
 const ssm = new SSMClient({})
 
-const metrics = new Metrics({
-	namespace: 'hello-nrfcloud-backend',
-	serviceName: 'healthCheck',
-})
+const { track, metrics } = metricsForComponent('healthCheck')
 
 const amazonRootCA1 =
 	'-----BEGIN CERTIFICATE-----\n' +
@@ -165,7 +159,7 @@ await registerDevice({
 const h = async (): Promise<void> => {
 	let ts: number
 	let gain: number
-	metrics.addMetric('checkMessageFromWebsocket', MetricUnits.Count, 1)
+	track('checkMessageFromWebsocket', MetricUnits.Count, 1)
 	try {
 		await checkMessageFromWebsocket({
 			endpoint: `${websocketUrl}?fingerprint=${fingerprint}`,
@@ -199,7 +193,7 @@ const h = async (): Promise<void> => {
 					if (messageObj['@context'] !== expectedMessage['@context'])
 						return ValidateResponse.skip
 
-					metrics.addMetric(
+					track(
 						`receivingMessageDuration`,
 						MetricUnits.Seconds,
 						(Date.now() - ts) / 1000,
@@ -213,10 +207,10 @@ const h = async (): Promise<void> => {
 				}
 			},
 		})
-		metrics.addMetric('success', MetricUnits.Count, 1)
+		track('success', MetricUnits.Count, 1)
 	} catch (error) {
 		log.error(`health check error`, { error })
-		metrics.addMetric('fail', MetricUnits.Count, 1)
+		track('fail', MetricUnits.Count, 1)
 	}
 }
 
diff --git a/lambda/metrics/metrics.ts b/lambda/metrics/metrics.ts
@@ -0,0 +1,33 @@
+import { Metrics } from '@aws-lambda-powertools/metrics'
+
+const registry: Record<string, Metrics> = {}
+
+const metricsEnabled = process.env.DISABLE_METRICS !== '1'
+console.debug(`[Metrics]`, metricsEnabled ? `Enabled` : `Disabled`)
+
+/**
+ * Manages the instantiation of a Metrics object (unless Metrics are disabled)
+ */
+export const metricsForComponent = (
+	component: string,
+): {
+	metrics: Metrics
+	track: (...args: Parameters<Metrics['addMetric']>) => void
+} => {
+	if (registry[component] === undefined) {
+		registry[component] = new Metrics({
+			namespace: 'hello-nrfcloud-backend',
+			serviceName: component,
+		})
+	}
+	const metrics = registry[component] as Metrics
+	return {
+		metrics,
+		track: (...args) => {
+			if (!metricsEnabled) {
+				return
+			}
+			metrics.addMetric(...args)
+		},
+	}
+}
diff --git a/lambda/onConnect.ts b/lambda/onConnect.ts
@@ -1,8 +1,6 @@
-import { Metrics, logMetrics } from '@aws-lambda-powertools/metrics'
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
 import { EventBridge } from '@aws-sdk/client-eventbridge'
 import { Context, DeviceIdentity } from '@hello.nrfcloud.com/proto/hello'
-import middy from '@middy/core'
 import { fromEnv } from '@nordicsemiconductor/from-env'
 import type { Static } from '@sinclair/typebox'
 import type { APIGatewayProxyStructuredResultV2 } from 'aws-lambda'
@@ -20,14 +18,9 @@ const log = logger('connect')
 const eventBus = new EventBridge({})
 const db = new DynamoDBClient({})
 
-const metrics = new Metrics({
-	namespace: 'hello-nrfcloud-backend',
-	serviceName: 'websocket',
-})
-
 const repo = connectionsRepository(db, TableName)
 
-const h = async (
+export const handler = async (
 	event: AuthorizedEvent,
 ): Promise<APIGatewayProxyStructuredResultV2> => {
 	log.debug('event', { event })
@@ -67,5 +60,3 @@ const h = async (
 		statusCode: 200,
 	}
 }
-
-export const handler = middy(h).use(logMetrics(metrics))
diff --git a/lambda/onDeviceMessage.ts b/lambda/onDeviceMessage.ts
