refactor fastly client into class based api

Author: Jakeii

ab-testing/dictionary-deploy-lambda/src/deploy-dictionary.ts

@@ -1,9 +1,5 @@
-import {
-	calculateUpdates,
-	getDictionaryItems,
-	updateDictionaryItems,
-	verifyDictionaryName,
-} from "../../lib/fastly-api.ts";
+import type { FastlyDictionary } from "../../lib/fastly/dictionary.ts";
+import { calculateUpdates } from "../../lib/fastly/utils.ts";
 import type { KeyValue } from "./fetch-artifact.ts";
 
 /**
@@ -14,49 +10,27 @@ import type { KeyValue } from "./fetch-artifact.ts";
  * @param keyValues An array of key-value pairs to deploy to the dictionary.
  */
 export const deployDictionary = async (
-	{
-		dictionaryName,
-		dictionaryId,
-		serviceId,
-		activeVersion,
-	}: {
-		dictionaryName: string;
-		dictionaryId: string;
-		serviceId: string;
-		activeVersion: number;
-	},
+	dictionary: FastlyDictionary,
 	keyValues: KeyValue[],
 ) => {
-	await verifyDictionaryName({
-		serviceId,
-		activeVersion,
-		dictionaryName,
-		dictionaryId,
-	});
-
-	const currentKeyValues = await getDictionaryItems({
-		dictionaryId,
-	});
+	const currentKeyValues = await dictionary.getItems();
 
 	const updates = calculateUpdates(keyValues, currentKeyValues);
 
 	if (updates.length === 0) {
-		console.log(`No key-values need updating in '${dictionaryName}'`);
+		console.log(`No key-values need updating in '${dictionary.name}'`);
 	} else {
 		Map.groupBy(updates, (item) => item.op).forEach((items, op) => {
 			console.log(
-				`Performing ${items.length} ${op} operations in '${dictionaryName}'`,
+				`Performing ${items.length} ${op} operations in '${dictionary.name}'`,
 			);
 		});
 
 		console.log(
-			`Performing ${updates.length} total operations in '${dictionaryName}'`,
+			`Performing ${updates.length} total operations in '${dictionary.name}'`,
 		);
 
-		const response = await updateDictionaryItems({
-			dictionaryId,
-			items: updates,
-		});
+		const response = await dictionary.updateItems(updates);
 
 		if (response.status !== "ok") {
 			throw new Error(`Failed to update mvt groups dictionary`);

ab-testing/dictionary-deploy-lambda/src/deploy.ts

@@ -1,3 +1,4 @@
+import type { FastlyDictionary } from "../../lib/fastly/dictionary.ts";
 import { deployDictionary } from "./deploy-dictionary.ts";
 import { fetchDictionaryArtifact } from "./fetch-artifact.ts";
 
@@ -6,42 +7,25 @@ const STAGE = process.env.STAGE ?? "CODE";
 
 const CONFIG_PREFIX = `/${STAGE}/config/ab-testing`;
 
-type ServiceInfo = {
-	activeVersion: { number: number };
-	serviceId: string;
-};
-
 type ArtifactInfo = {
 	artifact: string;
-	dictionaryName: string;
-	dictionaryId: string;
+	dictionary: FastlyDictionary;
 };
 
 /**
  * Fetches dictionary artifacts from S3 and deploys them to Fastly dictionaries in parallel.
  * @param serviceInfo The Fastly service information including active version and service ID.
  * @param deployments An array of artifact deployment information.
  */
-export const fetchAndDeployArtifacts = async (
-	{ activeVersion, serviceId }: ServiceInfo,
-	deployments: ArtifactInfo[],
-) => {
+export const fetchAndDeployArtifacts = async (deployments: ArtifactInfo[]) => {
 	try {
 		await Promise.all(
-			deployments.map(({ artifact, dictionaryName, dictionaryId }) =>
+			deployments.map(({ artifact, dictionary }) =>
 				fetchDictionaryArtifact(
 					ARTIFACT_BUCKET_NAME,
 					`${CONFIG_PREFIX}/${artifact}`,
 				).then((abTestGroups) =>
-					deployDictionary(
-						{
-							serviceId,
-							activeVersion: activeVersion.number,
-							dictionaryName,
-							dictionaryId,
-						},
-						abTestGroups,
-					),
+					deployDictionary(dictionary, abTestGroups),
 				),
 			),
 		);

ab-testing/dictionary-deploy-lambda/src/index.ts

@@ -1,3 +1,4 @@
+import { GetParameterCommand, SSMClient } from "@aws-sdk/client-ssm";
 import type { Handler } from "aws-cdk-lib/aws-lambda";
 import type { CloudFormationCustomResourceEvent, Context } from "aws-lambda";
 import { send } from "cfn-response";
@@ -9,48 +10,57 @@ import {
 	serviceId,
 	serviceName,
 } from "../../lib/config.ts";
-import { getService } from "../../lib/fastly-api.ts";
+import { FastlyClient } from "../../lib/fastly/client.ts";
 import { fetchAndDeployArtifacts } from "./deploy.ts";
 
+const ssmClient = new SSMClient({ region: "eu-west-1" });
+
+const getSecureString = async (name: string) => {
+	const response = await ssmClient.send(
+		new GetParameterCommand({
+			Name: name,
+			WithDecryption: true,
+		}),
+	);
+	return response.Parameter?.Value;
+};
+
 export const handler: Handler = async (
 	event: CloudFormationCustomResourceEvent,
 	context: Context,
 ): Promise<void> => {
-	const service = await getService(serviceId);
-	if (service.name !== serviceName) {
-		throw new Error(
-			`Service ID ${serviceId} does not match the expected service name ${serviceName}`,
-		);
-	}
-
-	const activeVersion = service.versions.find(
-		(v: { active: boolean }) => v.active,
+	const apiToken = await getSecureString(
+		`/ab-testing-deploy/${process.env.STAGE}/fastly-api-token`,
 	);
 
-	if (!activeVersion) {
-		throw new Error(`No active version found for service ${service.name}`);
+	if (!apiToken) {
+		throw new Error("Fastly API token not found in SSM Parameter Store");
 	}
 
+	const fastly = new FastlyClient(apiToken);
+	const service = await fastly.getService(serviceId, serviceName);
+
+	const abTestsDictionary = await service.getDictionary(
+		abTestsDictionaryId,
+		abTestsDictionaryName,
+	);
+	const mvtDictionary = await service.getDictionary(
+		mvtDictionaryId,
+		mvtDictionaryName,
+	);
+
 	if (event.RequestType === "Create" || event.RequestType === "Update") {
 		try {
-			await fetchAndDeployArtifacts(
+			await fetchAndDeployArtifacts([
+				{
+					artifact: "ab-test-groups.json",
+					dictionary: abTestsDictionary,
+				},
 				{
-					activeVersion,
-					serviceId,
+					artifact: "mvt-groups.json",
+					dictionary: mvtDictionary,
 				},
-				[
-					{
-						artifact: "ab-test-groups.json",
-						dictionaryName: abTestsDictionaryName,
-						dictionaryId: abTestsDictionaryId,
-					},
-					{
-						artifact: "mvt-groups.json",
-						dictionaryName: mvtDictionaryName,
-						dictionaryId: mvtDictionaryId,
-					},
-				],
-			);
+			]);
 
 			send(event, context, "SUCCESS");
 		} catch (error) {