Release/5.6.0

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@adobe/aio-cli-plugin-api-mesh",
-	"version": "5.5.0",
+	"version": "5.6.0",
 	"description": "Adobe I/O CLI plugin to develop and manage API mesh sources",
 	"keywords": [
 		"oclif-plugin"
@@ -38,13 +38,13 @@
 		"version": "oclif-dev readme && git add README.md"
 	},
 	"dependencies": {
-		"@adobe-apimesh/mesh-builder": "2.2.0",
+		"@adobe-apimesh/mesh-builder": "2.3.1",
 		"@adobe/aio-cli-lib-console": "^5.0.0",
 		"@adobe/aio-lib-core-config": "^5.0.0",
 		"@adobe/aio-lib-core-logging": "^3.0.0",
 		"@adobe/aio-lib-env": "^3.0.0",
 		"@adobe/aio-lib-ims": "^7.0.1",
-		"@adobe/plugin-hooks": "0.3.4",
+		"@adobe/plugin-hooks": "0.4.0",
 		"@adobe/plugin-on-fetch": "0.1.1",
 		"@adobe/plugin-source-headers": "^0.0.2",
 		"@envelop/disable-introspection": "^6.0.0",

src/meshArtifact.js

@@ -70,8 +70,8 @@ function resolveComposerAsTypeScriptModule(data) {
  * ```
  */
 function resolveComposerAsJavaScriptModule(data) {
-	return data.replace(
-		/"composer":\s*"((?!https:\/\/)[^#]+)#([^"]+)"/,
+	return data.replaceAll(
+		/"composer":\s*"((?!https:\/\/)[^#]+)#([^"]+)"/g,
 		`"module": __importStar(require("$1")), "fn": "$2"`,
 	);
 }

src/server.js

@@ -1,5 +1,7 @@
 import { getMesh } from '@graphql-mesh/runtime';
 
+import { KvStateApiImpl } from './state';
+
 const { getCorsOptions } = require('./cors');
 const { createYoga } = require('graphql-yoga');
 const { GraphQLError } = require('graphql/error');
@@ -46,13 +48,14 @@ async function getBuiltMesh(meshArtifacts, meshConfig) {
 }
 
 const buildServer = async (loggerInstance, env, meshArtifacts, meshConfig) => {
-	const { Secret: secret } = env;
+	const { SECRETS } = env;
 	const tenantMesh = await getBuiltMesh(meshArtifacts, meshConfig);
-	const meshSecrets = loadMeshSecrets(loggerInstance, secret);
+	const meshSecrets = loadMeshSecrets(loggerInstance, SECRETS);
 	return await buildYogaServer(env, tenantMesh, meshConfig, meshSecrets);
 };
 
 async function buildYogaServer(env, tenantMesh, meshConfig, meshSecrets) {
+	const stateApi = new KvStateApiImpl(env, meshConfig);
 	const secretsProxy = new Proxy(meshSecrets, getSecretsHandler);
 	return createYoga({
 		plugins: tenantMesh.plugins,
@@ -61,6 +64,7 @@ async function buildYogaServer(env, tenantMesh, meshConfig, meshSecrets) {
 		context: initialContext => ({
 			...initialContext,
 			secrets: secretsProxy,
+			state: stateApi,
 		}),
 		maskedErrors: {
 			maskError: maskError,

src/state.js

@@ -0,0 +1,155 @@
+import { GraphQLError } from 'graphql/error';
+
+/**
+ * Whether string is empty.
+ * @param value {string | null | undefined} String value.
+ */
+const isEmptyString = value => {
+	return value === '' || value === null || value === undefined;
+};
+
+/**
+ * Get byte length of a string.
+ * @param value {string} String value.
+ */
+const getByteLength = value => {
+	return new TextEncoder().encode(value).length;
+};
+
+/**
+ * Abstract class for state API implementations.
+ */
+class StateApiAbstract {
+	#env;
+
+	constructor(env) {
+		this.#env = env;
+	}
+
+	getEnv() {
+		return this.#env;
+	}
+
+	/**
+	 * Validate a key.
+	 * @param key {string} Key to validate.
+	 */
+	validateKey(key) {
+		if (isEmptyString(key)) {
+			throw new Error(`Invalid key: ${key}`);
+		}
+		const keyBytes = getByteLength(key);
+		const env = this.getEnv();
+		if (keyBytes > env.MAX_STATE_KEY_SIZE_BYTES) {
+			throw new Error(
+				`Key ${key} exceeds maximum key size of ${env.MAX_STATE_KEY_SIZE_BYTES}. Received ${keyBytes} B.`,
+			);
+		}
+	}
+
+	/**
+	 * Validate a value
+	 * @param key {string} Key.
+	 * @param value {string} Value to validate.
+	 */
+	validateValue(key, value) {
+		if (isEmptyString(value)) {
+			throw new Error(`Invalid value for key: ${key}`);
+		}
+		const valueBytes = getByteLength(value);
+		const env = this.getEnv();
+		if (valueBytes > env.MAX_STATE_VALUE_SIZE_BYTES) {
+			throw new Error(
+				`Key ${key} value exceeds maximum key size of ${env.MAX_STATE_VALUE_SIZE_BYTES}. Received ${valueBytes} B.`,
+			);
+		}
+	}
+
+	/**
+	 * Get the TTL in milliseconds based on the provided config or environment defaults.
+	 * @param config {{ ttl?: number } | undefined} Configuration object that may contain a TTL value.
+	 */
+	getTtl(config) {
+		const env = this.getEnv();
+		// Default to maximum ttl if not provided
+		let useTtl = config?.ttl || env.MAX_STATE_TTL_SECONDS;
+		// Set TTL to max when over maximum TTL
+		if (useTtl > env.MAX_STATE_TTL_SECONDS) {
+			useTtl = env.MAX_STATE_TTL_SECONDS;
+		}
+		// Set TTL to min seconds when under minimum TTL
+		if (useTtl < env.MIN_STATE_TTL_SECONDS) {
+			useTtl = env.MIN_STATE_TTL_SECONDS;
+		}
+		return useTtl;
+	}
+}
+
+/**
+ * State API implementation using Cloudflare's KV as the backing store. KV is a distributed key-value store that allows
+ * for storing and retrieving key-value pairs across different worker instances with eventual consistency.
+ */
+class KvStateApiImpl extends StateApiAbstract {
+	meshConfig;
+
+	constructor(env, meshConfig) {
+		super(env);
+		this.meshConfig = meshConfig;
+	}
+
+	/**
+	 * Ensure that the KV namespace is configured in the environment.
+	 * @throws {GraphQLError} when the KV namespace is not configured.
+	 */
+	ensureKvConfigured() {
+		if (!this.getEnv().MESH_KV_NAMESPACE || !this.meshConfig?.state?.enabled) {
+			throw new GraphQLError(
+				'Context state is not configured for this mesh. Please check your mesh configuration and try again.',
+				{
+					extensions: {
+						code: 'ERROR_CONTEXT_STATE_NOT_CONFIGURED',
+					},
+				},
+			);
+		}
+	}
+
+	/**
+	 * Get a value by key.
+	 * @param key {key} Key to retrieve.
+	 * @return {Promise<string | null>}
+	 */
+	async get(key) {
+		this.ensureKvConfigured();
+		this.validateKey(key);
+		return this.getEnv().MESH_KV_NAMESPACE.get(key);
+	}
+
+	/**
+	 * Put a key-value pair with optional TTL.
+	 * @param key {string} Key to store.
+	 * @param value {string} Value to store.
+	 * @param config {{ ttl?: number } | undefined} Optional configuration object that may contain a TTL value in seconds.
+	 * @return {Promise<void>}
+	 */
+	async put(key, value, config) {
+		this.ensureKvConfigured();
+		this.validateKey(key);
+		this.validateValue(key, value);
+		const ttl = this.getTtl(config);
+		return this.getEnv().MESH_KV_NAMESPACE.put(key, value, { expirationTtl: ttl });
+	}
+
+	/**
+	 * Delete a key-value pair.
+	 * @param key {string} Key to delete.
+	 * @return {Promise<void>}
+	 */
+	async delete(key) {
+		this.ensureKvConfigured();
+		this.validateKey(key);
+		return this.getEnv().MESH_KV_NAMESPACE.delete(key);
+	}
+}
+
+module.exports = { KvStateApiImpl };

src/templates/gitignore

@@ -1,5 +1,13 @@
+# Dependencies
 node_modules
+
+# Temporary files
+.wrangler
+.mesh
+tenantFiles
+tempfiles
 mesh-artifact
 meshes
-tempfiles
-*.txt
+
+# Template files from @adobe/aio-cli-plugin-api-mesh
+wrangler.toml

src/templates/package.json

@@ -26,7 +26,7 @@
 		"@graphql-mesh/soap": "0.14.25",
 		"@graphql-mesh/http": "^0.96.9",
 		"graphql": "^16.6.0",
-		"@adobe/plugin-hooks": "0.3.3",
+		"@adobe/plugin-hooks": "0.4.0",
 		"@adobe/plugin-on-fetch": "0.1.1",
 		"eslint-plugin-no-loops": "^0.3.0",
 		"eslint-plugin-node": "^11.1.0",

src/templates/wrangler.toml

@@ -1,14 +1,20 @@
 # Tenant worker core definition. For platform workers metadata configs are used to set bindings.
 name = "tenant-worker-core"
 compatibility_date = "2024-06-03"
-node_compat = false
 
 find_additional_modules = true
 base_dir = ".mesh"
 rules = [
   { type = "CommonJS", globs = ["tenantFiles/**/*.js"] }
 ]
 
+kv_namespaces = [
+  { binding = "MESH_KV_NAMESPACE", id = "local-kv" }
+]
 
-[[migrations]]
-tag = "v1"
+[vars]
+# State configuration
+MAX_STATE_KEY_SIZE_BYTES="512" # 512 bytes
+MAX_STATE_VALUE_SIZE_BYTES="1048576" # 1 MiB
+MIN_STATE_TTL_SECONDS="60" # 1 minute
+MAX_STATE_TTL_SECONDS="604800" # 7 days

src/utils.js

@@ -227,6 +227,38 @@ function getFilesInMeshConfig(data, meshConfigName) {
 					filesList.push(filename);
 				}
 			}
+
+			if (plugin.hooks.afterAll) {
+				const composer = plugin.hooks.afterAll.composer;
+				if (composer && !fileURLRegex.test(composer)) {
+					const [filename] = composer.split('#');
+					filesList.push(filename);
+				}
+			}
+
+			if (plugin.hooks.beforeSource) {
+				Object.values(plugin.hooks.beforeSource).forEach(beforeSourceHooks => {
+					beforeSourceHooks?.forEach(hook => {
+						const composer = hook.composer;
+						if (composer && !fileURLRegex.test(composer)) {
+							const [filename] = composer.split('#');
+							filesList.push(filename);
+						}
+					});
+				});
+			}
+
+			if (plugin.hooks.afterSource) {
+				Object.values(plugin.hooks.afterSource).forEach(afterSourceHooks => {
+					afterSourceHooks?.forEach(hook => {
+						const composer = hook.composer;
+						if (composer && !fileURLRegex.test(composer)) {
+							const [filename] = composer.split('#');
+							filesList.push(filename);
+						}
+					});
+				});
+			}
 		}
 	});
 

src/wranglerCli.js

@@ -2,6 +2,7 @@ const { spawn } = require('child_process');
 const { readSecretsFile } = require('./serverUtils');
 const packageData = require('../package.json');
 const { join } = require('node:path');
+const fs = require('node:fs');
 
 /**
  * Starts the wrangler dev server
@@ -13,7 +14,10 @@ const { join } = require('node:path');
 const start = (command, port, debug, inspectPort) => {
 	const wranglerPackageNumber = packageData.dependencies.wrangler;
 	const wranglerVersion = `wrangler@${wranglerPackageNumber.replace(/^[\^~]/, '')}`;
-	const wranglerToml = join(__dirname, '..', 'wrangler.toml');
+	// Project wrangler.toml must be used to avoid issues w/ Wrangler. Ensure it is up to date.
+	const wranglerTomlTemplate = join(__dirname, '..', 'wrangler.toml');
+	const wranglerToml = join(process.cwd(), 'wrangler.toml');
+	fs.cpSync(wranglerTomlTemplate, wranglerToml);
 	const meshDir = '.mesh';
 	const secrets = readSecretsFile(meshDir);
 	const entrypoint = join(__dirname, 'worker.js');
@@ -29,7 +33,7 @@ const start = (command, port, debug, inspectPort) => {
 		'--show-interactive-dev-session',
 		'false',
 		'--var',
-		`Secret:${JSON.stringify(secrets)}`,
+		`SECRETS:${JSON.stringify(secrets)}`,
 		'--port',
 		port,
 		'--inspector-port',

wrangler.toml

@@ -8,6 +8,13 @@ rules = [
   { type = "CommonJS", globs = ["tenantFiles/**/*.js"] }
 ]
 
+kv_namespaces = [
+  { binding = "MESH_KV_NAMESPACE", id = "local-kv" }
+]
 
-[[migrations]]
-tag = "v1"
+[vars]
+# State configuration
+MAX_STATE_KEY_SIZE_BYTES="512" # 512 bytes
+MAX_STATE_VALUE_SIZE_BYTES="1048576" # 1 MiB
+MIN_STATE_TTL_SECONDS="60" # 1 minute
+MAX_STATE_TTL_SECONDS="604800" # 7 days