@adobe/aio-cli-plugin-api-mesh 2.0.0 → 2.2.0

package/src/commands/api-mesh/__tests__/update.test.js

@@ -73,134 +73,6 @@ describe('update command tests', () => {
 		});
 	});
 
-	afterEach(() => {
-		jest.restoreAllMocks();
-	});
-
-	test('should fail if mesh id is missing', async () => {
-		getMeshId.mockResolvedValue(null);
-		const runResult = UpdateCommand.run();
-
-		await expect(runResult).rejects.toMatchInlineSnapshot(
-			`[Error: Unable to update. No mesh found for Org(1234) -> Project(5678) -> Workspace(123456789). Please check the details and try again.]`,
-		);
-		expect(logSpy.mock.calls).toMatchInlineSnapshot(`[]`);
-		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
-		[
-		  [
-		    "Unable to update. No mesh found for Org(1234) -> Project(5678) -> Workspace(123456789). Please check the details and try again.",
-		  ],
-		]
-	`);
-	});
-
-	test('should fail if getMeshId api failed', async () => {
-		getMeshId.mockRejectedValue(new Error('getMeshId api failed'));
-		const runResult = UpdateCommand.run();
-
-		await expect(runResult).rejects.toMatchInlineSnapshot(
-			`[Error: Unable to get mesh ID. Please check the details and try again. RequestId: dummy_request_id]`,
-		);
-		expect(logSpy.mock.calls).toMatchInlineSnapshot(`[]`);
-		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
-		[
-		  [
-		    "Unable to get mesh ID. Please check the details and try again. RequestId: dummy_request_id",
-		  ],
-		]
-	`);
-	});
-
-	test('should fail if update file path is missing', async () => {
-		parseSpy.mockResolvedValueOnce({
-			args: { file: null },
-			flags: {
-				ignoreCache: mockIgnoreCacheFlag,
-				autoConfirmAction: mockAutoApproveAction,
-			},
-		});
-		const runResult = UpdateCommand.run();
-
-		await expect(runResult).rejects.toEqual(
-			new Error('Missing required args. Run aio api-mesh update --help for more info.'),
-		);
-		expect(logSpy.mock.calls).toMatchInlineSnapshot(`[]`);
-		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
-		[
-		  [
-		    "Missing required args. Run aio api-mesh update --help for more info.",
-		  ],
-		]
-	`);
-	});
-
-	test('should fail if dummy file path is provided', async () => {
-		readFile.mockRejectedValueOnce(new Error('File not found'));
-		const runResult = UpdateCommand.run();
-
-		await expect(runResult).rejects.toEqual(
-			new Error(
-				'Unable to read the mesh configuration file provided. Please check the file and try again.',
-			),
-		);
-		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
-		[
-		  [
-		    "File not found",
-		  ],
-		]
-	`);
-		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
-		[
-		  [
-		    "Unable to read the mesh configuration file provided. Please check the file and try again.",
-		  ],
-		]
-	`);
-	});
-
-	test('should not update if user prompt returns false', async () => {
-		promptConfirm.mockResolvedValueOnce(false);
-
-		const runResult = await UpdateCommand.run();
-
-		expect(runResult).toMatchInlineSnapshot(`"Update cancelled"`);
-		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
-		[
-		  [
-		    "Update cancelled",
-		  ],
-		]
-	`);
-		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`[]`);
-	});
-
-	test('should fail if updateMesh method failed', async () => {
-		updateMesh.mockRejectedValueOnce(new Error('dummy_error'));
-
-		const runResult = UpdateCommand.run();
-
-		await expect(runResult).rejects.toEqual(
-			new Error(
-				'Unable to update the mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: dummy_request_id',
-			),
-		);
-		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
-		[
-		  [
-		    "dummy_error",
-		  ],
-		]
-	`);
-		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
-		[
-		  [
-		    "Unable to update the mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: dummy_request_id",
-		  ],
-		]
-	`);
-	});
-
 	test('should pass with valid args', async () => {
 		const runResult = await UpdateCommand.run();
 
@@ -322,4 +194,132 @@ describe('update command tests', () => {
 	`);
 		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`[]`);
 	});
+
+	test('should fail if mesh id is missing', async () => {
+		getMeshId.mockResolvedValue(null);
+		const runResult = UpdateCommand.run();
+
+		await expect(runResult).rejects.toMatchInlineSnapshot(
+			`[Error: Unable to update. No mesh found for Org(1234) -> Project(5678) -> Workspace(123456789). Please check the details and try again.]`,
+		);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`[]`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
+		[
+		  [
+		    "Unable to update. No mesh found for Org(1234) -> Project(5678) -> Workspace(123456789). Please check the details and try again.",
+		  ],
+		]
+	`);
+	});
+
+	test('should fail if getMeshId api failed', async () => {
+		getMeshId.mockRejectedValue(new Error('getMeshId api failed'));
+		const runResult = UpdateCommand.run();
+
+		await expect(runResult).rejects.toMatchInlineSnapshot(
+			`[Error: Unable to get mesh ID. Please check the details and try again. RequestId: dummy_request_id]`,
+		);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`[]`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
+		[
+		  [
+		    "Unable to get mesh ID. Please check the details and try again. RequestId: dummy_request_id",
+		  ],
+		]
+	`);
+	});
+
+	test('should fail if updateMesh method failed', async () => {
+		updateMesh.mockRejectedValueOnce(new Error('dummy_error'));
+
+		const runResult = UpdateCommand.run();
+
+		// await expect(runResult).rejects.toEqual(
+		// 	new Error(
+		// 		'Unable to update the mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: dummy_request_id',
+		// 	),
+		// );
+
+		await expect(runResult).rejects.toMatchInlineSnapshot(
+			`[Error: Unable to update the mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: dummy_request_id]`,
+		);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
+		[
+		  [
+		    "dummy_error",
+		  ],
+		]
+	`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
+		[
+		  [
+		    "Unable to update the mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: dummy_request_id",
+		  ],
+		]
+	`);
+	});
+
+	test('should fail if update file path is missing', async () => {
+		parseSpy.mockResolvedValueOnce({
+			args: { file: null },
+			flags: {
+				ignoreCache: mockIgnoreCacheFlag,
+				autoConfirmAction: mockAutoApproveAction,
+			},
+		});
+		const runResult = UpdateCommand.run();
+
+		await expect(runResult).rejects.toEqual(
+			new Error('Missing required args. Run aio api-mesh update --help for more info.'),
+		);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`[]`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
+		[
+		  [
+		    "Missing required args. Run aio api-mesh update --help for more info.",
+		  ],
+		]
+	`);
+	});
+
+	test('should fail if dummy file path is provided', async () => {
+		readFile.mockRejectedValueOnce(new Error('File not found'));
+		const runResult = UpdateCommand.run();
+
+		await expect(runResult).rejects.toEqual(
+			new Error(
+				'Unable to read the mesh configuration file provided. Please check the file and try again.',
+			),
+		);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
+		[
+		  [
+		    "File not found",
+		  ],
+		]
+	`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
+		[
+		  [
+		    "Unable to read the mesh configuration file provided. Please check the file and try again.",
+		  ],
+		]
+	`);
+	});
+
+	test('should not update if user prompt returns false', async () => {
+		promptConfirm.mockResolvedValueOnce(false);
+
+		const runResult = await UpdateCommand.run();
+
+		expect(runResult).toMatchInlineSnapshot(`"Update cancelled"`);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
+		[
+		  [
+		    "Update cancelled",
+		  ],
+		]
+	`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`[]`);
+	});
 });

package/src/commands/api-mesh/create.js

@@ -15,14 +15,16 @@ const { readFile } = require('fs/promises');
 const { initSdk, initRequestId, promptConfirm } = require('../../helpers');
 const logger = require('../../classes/logger');
 const CONSTANTS = require('../../constants');
-const { ignoreCacheFlag, autoConfirmActionFlag, jsonFlag } = require('../../utils');
+const { ignoreCacheFlag, autoConfirmActionFlag, jsonFlag, envFileFlag } = require('../../utils');
 const {
 	createMesh,
 	createAPIMeshCredentials,
 	subscribeCredentialToMeshService,
 } = require('../../lib/devConsole');
 
-require('dotenv').config();
+const meshInterpolation = require('../../meshInterpolation');
+
+const dotenv = require('dotenv');
 
 const { MULTITENANT_GRAPHQL_SERVER_BASE_URL } = CONSTANTS;
 
@@ -32,6 +34,7 @@ class CreateCommand extends Command {
 		ignoreCache: ignoreCacheFlag,
 		autoConfirmAction: autoConfirmActionFlag,
 		json: jsonFlag,
+		env: envFileFlag,
 	};
 
 	static enableJsonFlag = true;
@@ -51,15 +54,16 @@ class CreateCommand extends Command {
 
 		const ignoreCache = await flags.ignoreCache;
 		const autoConfirmAction = await flags.autoConfirmAction;
-
+		const envFilePath=await flags.env;
 		const { imsOrgId, projectId, workspaceId } = await initSdk({
 			ignoreCache,
 		});
 
-		let data;
+		let inputMeshData;
 
+		//Input the mesh data from the input file
 		try {
-			data = JSON.parse(await readFile(args.file, 'utf8'));
+			inputMeshData = await readFile(args.file, 'utf8');
 		} catch (error) {
 			logger.error(error);
 
@@ -69,6 +73,66 @@ class CreateCommand extends Command {
 			);
 		}
 
+		let data;
+
+		if (envFilePath) {
+			let envFileContent;
+
+			//Read the environment file
+			try {
+				envFileContent = await readFile(envFilePath, 'utf8');
+			} catch (error) {
+				this.log(error.message);
+				this.error('Unable to read the env file provided. Please check the file and try again.');
+			}
+
+			//Validate the env file
+			const envFileValidity = meshInterpolation.validateEnvFileFormat(envFileContent);
+			if (envFileValidity.valid) {
+				//load env file into the process.env object
+				meshInterpolation.clearEnv();
+
+				//Added env at start of each environment variable
+				const envObj = { env: dotenv.config({ path: envFilePath }).parsed };
+
+				let {
+					interpolationStatus,
+					missingKeys,
+					interpolatedMeshData,
+				} = await meshInterpolation.interpolateMesh(inputMeshData, envObj);
+
+				//De-duplicate the missing keys array
+				missingKeys = missingKeys.filter(function (item, index, inputArray) {
+					return inputArray.indexOf(item) == index;
+				});
+
+				if (interpolationStatus == 'failed') {
+					this.error(
+						'The mesh file cannot be interpolated due to missing keys : ' + missingKeys.toString(),
+					);
+				}
+
+				try {
+					data = JSON.parse(interpolatedMeshData);
+				} catch (err) {
+					this.log(err.message);
+					this.log(interpolatedMeshData);
+					this.error(
+						'Interpolated mesh is not a valid JSON. Please check the generated json file.',
+					);
+				}
+			} else {
+				this.error(`Issue in ${envFilePath} file - ` + envFileValidity.error);
+			}
+		} else {
+			try {
+				data = JSON.parse(inputMeshData);
+			} catch (err) {
+				this.log(err.message);
+				this.error('Input mesh file is not a valid JSON. Please check the file provided.');
+			}
+		}
+
 		let shouldContinue = true;
 
 		if (!autoConfirmAction) {

package/src/commands/api-mesh/update.js

@@ -14,16 +14,18 @@ const { readFile } = require('fs/promises');
 
 const logger = require('../../classes/logger');
 const { initSdk, initRequestId, promptConfirm } = require('../../helpers');
-const { ignoreCacheFlag, autoConfirmActionFlag } = require('../../utils');
+const { ignoreCacheFlag, autoConfirmActionFlag, envFileFlag } = require('../../utils');
 const { getMeshId, updateMesh } = require('../../lib/devConsole');
+const meshInterpolation = require('../../meshInterpolation');
 
-require('dotenv').config();
+const dotenv = require('dotenv');
 
 class UpdateCommand extends Command {
 	static args = [{ name: 'file' }];
 	static flags = {
 		ignoreCache: ignoreCacheFlag,
 		autoConfirmAction: autoConfirmActionFlag,
+		env: envFileFlag,
 	};
 
 	async run() {
@@ -41,15 +43,17 @@ class UpdateCommand extends Command {
 
 		const ignoreCache = await flags.ignoreCache;
 		const autoConfirmAction = await flags.autoConfirmAction;
+		const envFilePath=await flags.env;
 
 		const { imsOrgId, projectId, workspaceId } = await initSdk({
 			ignoreCache,
 		});
 
-		let data;
+		let inputMeshData;
 
+		//Input the mesh data from the input file
 		try {
-			data = JSON.parse(await readFile(args.file, 'utf8'));
+			inputMeshData = await readFile(args.file, 'utf8');
 		} catch (error) {
 			logger.error(error);
 
@@ -59,7 +63,7 @@ class UpdateCommand extends Command {
 			);
 		}
 
-		let meshId = null;
+		let meshId;
 
 		try {
 			meshId = await getMeshId(imsOrgId, projectId, workspaceId);
@@ -69,6 +73,66 @@ class UpdateCommand extends Command {
 			);
 		}
 
+		let data;
+
+		if (envFilePath) {
+			let envFileContent;
+
+			//Read the environment file
+			try {
+				envFileContent = await readFile(envFilePath, 'utf8');
+			} catch (error) {
+				this.log(error.message);
+				this.error('Unable to read the env file provided. Please check the file and try again.');
+			}
+
+			//Validate the env file
+			const envFileValidity = meshInterpolation.validateEnvFileFormat(envFileContent);
+			if (envFileValidity.valid) {
+				//load env file into the process.env object
+				meshInterpolation.clearEnv();
+
+				//Added env at start of each environment variable
+				const envObj = { env: dotenv.config({ path: envFilePath }).parsed };
+
+				let {
+					interpolationStatus,
+					missingKeys,
+					interpolatedMeshData,
+				} = await meshInterpolation.interpolateMesh(inputMeshData, envObj);
+
+				//De-duplicate the missing keys array
+				missingKeys = missingKeys.filter(function (item, index, inputArray) {
+					return inputArray.indexOf(item) == index;
+				});
+
+				if (interpolationStatus == 'failed') {
+					this.error(
+						'The mesh file cannot be interpolated due to missing keys : ' + missingKeys.toString(),
+					);
+				}
+
+				try {
+					data = JSON.parse(interpolatedMeshData);
+				} catch (err) {
+					this.log(err.message);
+					this.log(interpolatedMeshData);
+					this.error(
+						'Interpolated mesh is not a valid JSON. Please check the generated json file.',
+					);
+				}
+			} else {
+				this.error(`Issue in ${envFilePath} file - ` + envFileValidity.error);
+			}
+		} else {
+			try {
+				data = JSON.parse(inputMeshData);
+			} catch (err) {
+				this.log(err.message);
+				this.error('Input mesh file is not a valid JSON. Please check the input file provided.');
+			}
+		}
+
 		if (meshId) {
 			let shouldContinue = true;
 

package/src/helpers.js

@@ -459,6 +459,112 @@ async function promptInput(message) {
 	return selected.item;
 }
 
+function clearEnv() {
+	for (const key in process.env) {
+		delete process.env[key];
+	}
+}
+
+function lintEnvFileContent(envContent) {
+	//Key should start with a underscore or an alphabet followed by underscore/alphanumeric characters
+	const envKeyRegex = /^[a-zA-Z_]+[a-zA-Z0-9_]*$/;
+
+	const envValueRegex = /^(?:"(?:\\.|[^\\"])*"|'(?:\\.|[^\\'])*'|[^'"\s])+$/;
+
+	/*
+	The above regex matches one or more of below :
+	(?:"(?:\\.|[^\\"])*"|'(?:\\.|[^\\'])*'|[^'"\s])
+	which is 
+	1. ?:"(?:\\.|[^\\"])*" : Non capturing group starts and ends with '"'
+	*/
+	const envDict = {};
+	const lines = envContent.split(/\r?\n/);
+	const errors = [];
+
+	for (let index = 0; index < lines.length; index++) {
+		const line = lines[index];
+		const trimmedLine = line.trim();
+		if (trimmedLine.startsWith('#') || trimmedLine === '') {
+			// ignore comment or empty lines
+			continue;
+		}
+
+		if (!trimmedLine.includes('=')) {
+			errors.push(`Invalid format << ${trimmedLine} >> on line ${index + 1}`);
+		} else {
+			const [key, value] = trimmedLine.split('=', 2);
+			if (!envKeyRegex.test(key) || !envValueRegex.test(value)) {
+				// invalid format: key or value does not match regex
+				errors.push(`Invalid format for key/value << ${trimmedLine} >> on line ${index + 1}`);
+			}
+			if (key in envDict) {
+				// duplicate key found
+				errors.push(`Duplicate key << ${key} >> on line ${index + 1}`);
+			}
+			envDict[key] = value;
+		}
+	}
+	if (errors.length) {
+		return {
+			valid: false,
+			error: errors.toString(),
+		};
+	}
+	return {
+		valid: true,
+	};
+}
+
+async function loadPupa() {
+	try {
+		const pupa = (await import('pupa')).default;
+		return pupa;
+	} catch {
+		console.log('Error while loading pupa module');
+	}
+}
+
+async function interpolateMesh(data, obj) {
+	let missingKeys = [];
+	let interpolatedMesh;
+	await loadPupa().then(pupa => {
+		interpolatedMesh = pupa(data, obj, {
+			ignoreMissing: true,
+			transform: ({ value, key }) => {
+				if (key.startsWith('env.')) {
+					if (value) {
+						return value;
+					} else {
+						// missing value, add to list
+						missingKeys.push(key.split('.')[1]);
+					}
+				} else {
+					//ignore
+					return undefined;
+				}
+				return value;
+			},
+		});
+	});
+
+	if (missingKeys.length) {
+		return {
+			interpolationStatus: 'failed',
+			missingKeys: missingKeys,
+			interpolatedMesh: '',
+		};
+	}
+	return {
+		interpolationStatus: 'success',
+		missingKeys: [],
+		interpolatedMesh: interpolatedMesh,
+	};
+}
+
+async function getname(name, length) {
+	return { name: name, length: length };
+}
+
 module.exports = {
 	promptInput,
 	promptConfirm,
@@ -468,4 +574,8 @@ module.exports = {
 	initRequestId,
 	promptSelect,
 	promptMultiselect,
+	clearEnv,
+	lintEnvFileContent,
+	interpolateMesh,
+	getname,
 };