refactor(e2e-tests): use matchGroup to type matches

Thanks @pudkrong for reminding me of my own code!

Author: coderbyheart

feature-runner/steps/device.ts

@@ -1,11 +1,13 @@
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
 import {
 	codeBlockOrThrow,
+	matchGroups,
 	noMatch,
 	type StepRunResult,
 	type StepRunner,
 	type StepRunnerArgs,
 } from '@nordicsemiconductor/bdd-markdown'
+import { Type } from '@sinclair/typebox'
 import mqtt from 'mqtt'
 import { randomUUID } from 'node:crypto'
 import { readFileSync } from 'node:fs'
@@ -29,15 +31,17 @@ const createDeviceForModel =
 	}: StepRunnerArgs<
 		World & Record<string, string>
 	>): Promise<StepRunResult> => {
-		const match =
-			/^I have the fingerprint for a `(?<model>[^`]+)` device in `(?<storageName>[^`]+)`$/.exec(
-				step.title,
-			)
+		const match = matchGroups(
+			Type.Object({
+				model: Type.String(),
+				storageName: Type.String(),
+			}),
+		)(
+			/^I have the fingerprint for a `(?<model>[^`]+)` device in `(?<storageName>[^`]+)`$/,
+			step.title,
+		)
 		if (match === null) return noMatch
-		const { model, storageName } = match.groups as {
-			model: string
-			storageName: string
-		}
+		const { model, storageName } = match
 
 		const fingerprint = `92b.${generateCode()}`
 		const id = randomUUID()
@@ -97,25 +101,28 @@ const publishDeviceMessage =
 			step: { progress, error },
 		},
 	}: StepRunnerArgs<World>): Promise<StepRunResult> => {
-		const match =
-			/^the device `(?<id>[^`]+)` publishes this message to the topic `(?<topic>[^`]+)`$/.exec(
-				step.title,
-			)
+		const match = matchGroups(
+			Type.Object({
+				id: Type.String(),
+				topic: Type.String(),
+			}),
+		)(
+			/^the device `(?<id>[^`]+)` publishes this message to the topic `(?<topic>[^`]+)`$/,
+			step.title,
+		)
 		if (match === null) return noMatch
 
 		const message = JSON.parse(codeBlockOrThrow(step).code)
 
-		progress(
-			`Device id ${match.groups?.id} publishes to topic ${match.groups?.topic}`,
-		)
+		progress(`Device id ${match.id} publishes to topic ${match.topic}`)
 		await new Promise((resolve, reject) => {
 			const mqttClient = mqtt.connect({
 				host: bridgeInfo.mqttEndpoint,
 				port: 8883,
 				protocol: 'mqtts',
 				protocolVersion: 4,
 				clean: true,
-				clientId: match.groups?.id ?? '',
+				clientId: match.id,
 				key: bridgeInfo.accountDevicePrivateKey,
 				cert: bridgeInfo.accountDeviceClientCert,
 				ca: readFileSync(
@@ -126,9 +133,7 @@ const publishDeviceMessage =
 
 			mqttClient.on('connect', () => {
 				progress('connected')
-				const topic = `${bridgeInfo.mqttTopicPrefix}${
-					match.groups?.topic ?? ''
-				}`
+				const topic = `${bridgeInfo.mqttTopicPrefix}${match.topic}`
 				progress('publishing', message, topic)
 				mqttClient.publish(topic, JSON.stringify(message), (error) => {
 					if (error) return reject(error)

feature-runner/steps/mocknRFCloud.ts

@@ -1,11 +1,13 @@
 import { DynamoDBClient, PutItemCommand } from '@aws-sdk/client-dynamodb'
 import {
 	codeBlockOrThrow,
+	matchGroups,
 	noMatch,
 	type StepRunResult,
 	type StepRunner,
 	type StepRunnerArgs,
 } from '@nordicsemiconductor/bdd-markdown'
+import { Type } from '@sinclair/typebox'
 import type { World } from '../run-features.js'
 
 export const steps = ({ db }: { db: DynamoDBClient }): StepRunner<World>[] => {
@@ -16,10 +18,14 @@ export const steps = ({ db }: { db: DynamoDBClient }): StepRunner<World>[] => {
 		},
 		context: { responsesTableName },
 	}: StepRunnerArgs<World>): Promise<StepRunResult> => {
-		const match =
-			/^there is this device shadow data for `(?<deviceId>[^`]+)` in nRF Cloud$/.exec(
-				step.title,
-			)
+		const match = matchGroups(
+			Type.Object({
+				deviceId: Type.String(),
+			}),
+		)(
+			/^there is this device shadow data for `(?<deviceId>[^`]+)` in nRF Cloud$/,
+			step.title,
+		)
 		if (match === null) return noMatch
 
 		const data = codeBlockOrThrow(step).code
@@ -50,7 +56,7 @@ ${data}
 							includeState: { BOOL: true },
 							includeStateMeta: { BOOL: true },
 							pageLimit: { N: `100` },
-							deviceIds: { S: `/\\b${match.groups?.deviceId}\\b/` },
+							deviceIds: { S: `/\\b${match.deviceId}\\b/` },
 						},
 					},
 					ttl: {

feature-runner/steps/websocket.ts

@@ -1,10 +1,12 @@
 import {
 	codeBlockOrThrow,
+	matchGroups,
 	noMatch,
 	type StepRunner,
 	type StepRunnerArgs,
 	type StepRunResult,
 } from '@nordicsemiconductor/bdd-markdown'
+import { Type } from '@sinclair/typebox'
 import assert from 'assert/strict'
 import * as chai from 'chai'
 import { expect } from 'chai'
@@ -27,29 +29,29 @@ const wsConnect = async ({
 	},
 	context,
 }: StepRunnerArgs<World>): Promise<StepRunResult> => {
-	const match =
-		/^I (?<reconnect>re)?connect to the websocket using fingerprint `(?<fingerprint>[^`]+)`$/.exec(
-			step.title,
-		)
+	const match = matchGroups(
+		Type.Object({
+			reconnect: Type.Optional(Type.Literal('re')),
+			fingerprint: Type.String(),
+		}),
+	)(
+		/^I (?<reconnect>re)?connect to the websocket using fingerprint `(?<fingerprint>[^`]+)`$/,
+		step.title,
+	)
 	if (match === null) return noMatch
 
-	const { fingerprint, reconnect } = match.groups as {
-		fingerprint: string
-		reconnect?: string
-	}
-
 	const { websocketUri } = context
-	const wsURL = `${websocketUri}?fingerprint=${fingerprint}`
+	const wsURL = `${websocketUri}?fingerprint=${match.fingerprint}`
 
-	if (reconnect !== undefined && wsClients[wsURL] === undefined) {
+	if (match.reconnect !== undefined && wsClients[wsURL] === undefined) {
 		wsClients[wsURL]?.close()
 		delete wsClients[wsURL]
 	}
 
 	if (wsClients[wsURL] === undefined) {
 		progress(`Connect websocket to ${websocketUri}`)
 		wsClients[wsURL] = createWebsocketClient({
-			id: fingerprint,
+			id: match.fingerprint,
 			url: wsURL,
 			debug: (...args) => featureProgress('[ws]', ...args),
 		})
@@ -66,14 +68,19 @@ const receive = async ({
 	},
 	context: { wsClient },
 }: StepRunnerArgs<World>): Promise<StepRunResult> => {
-	const match =
-		/^I should receive a message on the websocket that (?<equalOrMatch>is equal to|matches)$/.exec(
-			step.title,
-		)
+	const match = matchGroups(
+		Type.Object({
+			equalOrMatch: Type.Union([
+				Type.Literal('is equal to'),
+				Type.Literal('matches'),
+			]),
+		}),
+	)(
+		/^I should receive a message on the websocket that (?<equalOrMatch>is equal to|matches)$/,
+		step.title,
+	)
 	if (match === null) return noMatch
-	const { equalOrMatch } = match.groups as {
-		equalOrMatch: 'is equal to' | 'matches'
-	}
+	const { equalOrMatch } = match
 
 	const expected = JSON.parse(codeBlockOrThrow(step).code)
 	const found = Object.entries(wsClient?.messages ?? {}).find(