@adobe/aio-cli-plugin-api-mesh 5.2.4-alpha.0 → 5.3.0-beta.1

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

@@ -10,7 +10,9 @@ governing permissions and limitations under the License.
 */
 
 const { Command } = require('@oclif/core');
-const { initSdk, initRequestId, promptConfirm, importFiles } = require('../../helpers');
+const chalk = require('chalk');
+
+const { initSdk, promptConfirm, importFiles } = require('../../helpers');
 const logger = require('../../classes/logger');
 const {
 	ignoreCacheFlag,
@@ -42,8 +44,6 @@ class CreateCommand extends Command {
 	static enableJsonFlag = true;
 
 	async run() {
-		await initRequestId();
-
 		logger.info(`RequestId: ${global.requestId}`);
 
 		const { args, flags } = await this.parse(CreateCommand);
@@ -99,7 +99,7 @@ class CreateCommand extends Command {
 		// if local files are present, import them in files array in meshConfig
 		if (filesList.length) {
 			try {
-				data = await importFiles(data, filesList, args.file, flags.autoConfirmAction);
+				({ data } = await importFiles(data, filesList, args.file, flags.autoConfirmAction));
 			} catch (err) {
 				this.log(err.message);
 				this.error('Unable to import the files in the mesh config. Check the file and try again.');
@@ -112,8 +112,7 @@ class CreateCommand extends Command {
 				await validateSecretsFile(secretsFilePath);
 				const secretsData = await interpolateSecrets(secretsFilePath, this);
 				const publicKey = await getPublicEncryptionKey(imsOrgCode);
-				const encryptedSecrets = await encryptSecrets(publicKey, secretsData);
-				data.secrets = encryptedSecrets;
+				data.secrets = await encryptSecrets(publicKey, secretsData);
 			} catch (err) {
 				this.log(err.message);
 				this.error('Unable to import secrets. Check the file and try again.');
@@ -122,6 +121,23 @@ class CreateCommand extends Command {
 
 		let shouldContinue = true;
 
+		if (
+			data?.meshConfig?.responseConfig?.includeHTTPDetails &&
+			workspaceName.toLowerCase() === 'production'
+		) {
+			this.warn(
+				`Your mesh has ${chalk.yellowBright('includeHTTPDetails')} set to ${chalk.redBright(
+					'true',
+				)}. This is a security risk and should not be used in production.\n` +
+					`When ${chalk.yellowBright('includeHTTPDetails')} is set to ${chalk.redBright(
+						'true',
+					)} it exposes HTTP request and response details in the mesh logs, which can cause sensitive information to be exposed.\n` +
+					`Consider setting ${chalk.yellowBright('includeHTTPDetails')} to ${chalk.greenBright(
+						'false',
+					)} in your mesh configuration file.`,
+			);
+		}
+
 		if (!autoConfirmAction) {
 			shouldContinue = await promptConfirm(`Are you sure you want to create a mesh?`);
 		}

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

@@ -12,7 +12,7 @@ governing permissions and limitations under the License.
 const { Command } = require('@oclif/command');
 
 const logger = require('../../classes/logger');
-const { initSdk, initRequestId, promptConfirm } = require('../../helpers');
+const { initSdk, promptConfirm } = require('../../helpers');
 const { ignoreCacheFlag, autoConfirmActionFlag } = require('../../utils');
 const { getMeshId, deleteMesh } = require('../../lib/smsClient');
 
@@ -25,8 +25,6 @@ class DeleteCommand extends Command {
 	};
 
 	async run() {
-		await initRequestId();
-
 		logger.info(`RequestId: ${global.requestId}`);
 
 		const { flags } = await this.parse(DeleteCommand);

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

@@ -11,7 +11,7 @@ governing permissions and limitations under the License.
 
 const { Command } = require('@oclif/command');
 const logger = require('../../classes/logger');
-const { initSdk, initRequestId } = require('../../helpers');
+const { initSdk } = require('../../helpers');
 const { ignoreCacheFlag } = require('../../utils');
 const { describeMesh } = require('../../lib/smsClient');
 const { buildMeshUrl } = require('../../urlBuilder');
@@ -24,8 +24,6 @@ class DescribeCommand extends Command {
 	};
 
 	async run() {
-		await initRequestId();
-
 		logger.info(`RequestId: ${global.requestId}`);
 
 		const { flags } = await this.parse(DescribeCommand);

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

@@ -13,7 +13,7 @@ const { Command } = require('@oclif/core');
 const { writeFile } = require('fs/promises');
 
 const logger = require('../../classes/logger');
-const { initSdk, initRequestId } = require('../../helpers');
+const { initSdk } = require('../../helpers');
 const { ignoreCacheFlag, jsonFlag } = require('../../utils');
 const { getMeshId, getMesh } = require('../../lib/smsClient');
 const { buildMeshUrl } = require('../../urlBuilder');
@@ -29,8 +29,6 @@ class GetCommand extends Command {
 	static enableJsonFlag = true;
 
 	async run() {
-		await initRequestId();
-
 		logger.info(`RequestId: ${global.requestId}`);
 
 		const { args, flags } = await this.parse(GetCommand);

package/src/commands/api-mesh/log-get-bulk.js

@@ -1,7 +1,7 @@
 const { Command } = require('@oclif/core');
 const path = require('path');
 const fs = require('fs');
-const { initRequestId, initSdk, promptConfirm } = require('../../helpers');
+const { initSdk, promptConfirm } = require('../../helpers');
 const { getMeshId, getPresignedUrls } = require('../../lib/smsClient');
 const logger = require('../../classes/logger');
 const axios = require('axios');
@@ -11,12 +11,10 @@ const {
 	endTimeFlag,
 	logFilenameFlag,
 	pastFlag,
-	fromFlag,
 	suggestCorrectedDateFormat,
 	parsePastDuration,
 	validateDateTimeRange,
 	validateDateTimeFormat,
-	localToUTCTime,
 } = require('../../utils');
 
 require('dotenv').config();
@@ -28,7 +26,6 @@ class GetBulkLogCommand extends Command {
 		endTime: endTimeFlag,
 		filename: logFilenameFlag,
 		past: pastFlag,
-		from: fromFlag,
 	};
 
 	async run() {
@@ -36,7 +33,6 @@ class GetBulkLogCommand extends Command {
 		const columnHeaders =
 			'EventTimestampMs,Exceptions,Logs,Outcome,MeshId,RayID,URL,Request Method,Response Status,Level';
 
-		await initRequestId();
 		logger.info(`RequestId: ${global.requestId}`);
 		const { flags } = await this.parse(GetBulkLogCommand);
 		const ignoreCache = await flags.ignoreCache;
@@ -90,26 +86,9 @@ class GetBulkLogCommand extends Command {
 			formattedEndTime = flags.endTime.replace(/-|:|Z/g, '').replace('T', 'T');
 		} else if (flags.past) {
 			const pastTimeWindow = parsePastDuration(flags.past);
-			if (flags.from) {
-				let convertedTime;
-				const dateTimeRegex = /^\d{4}-\d{2}-\d{2}:\d{2}:\d{2}:\d{2}$/;
-				if (!dateTimeRegex.test(flags.from)) {
-					this.error('Invalid format. Use the format YYYY-MM-DD:HH:MM:SS for --from.');
-				} else {
-					try {
-						convertedTime = await localToUTCTime(flags.from.toString());
-					} catch (error) {
-						this.error(`Invalid date components passed in --from. Correct the date.`);
-					}
-				}
-				// add the past window to the converted time to get the end time to fetch logs from the past
-				calculatedStartTime = new Date(convertedTime);
-				calculatedEndTime = new Date(calculatedStartTime.getTime() + pastTimeWindow);
-			} else {
-				// subtract the past window from the current time to get the start time to fetch recent logs from now
-				calculatedEndTime = new Date();
-				calculatedStartTime = new Date(calculatedEndTime.getTime() - pastTimeWindow);
-			}
+			// Subtract the past window from the current time to get the start time to fetch recent logs from now
+			calculatedEndTime = new Date();
+			calculatedStartTime = new Date(calculatedEndTime.getTime() - pastTimeWindow);
 
 			// Validate the calculated start and end times range
 			validateDateTimeRange(calculatedStartTime, calculatedEndTime);
@@ -121,7 +100,7 @@ class GetBulkLogCommand extends Command {
 			return;
 		} else {
 			this.error(
-				'Missing required flags. Provide at least one flag --startTime, --endTime, or --past --from or  type `mesh log:get-bulk --help` for more information.',
+				'Missing required flags. Provide a time range with --startTime and  --endTime flags,  or use the --past flag for more recent logs. Use the `mesh log:get-bulk --help` command for more information.',
 			);
 			return;
 		}

package/src/commands/api-mesh/log-get.js

@@ -10,7 +10,7 @@ governing permissions and limitations under the License.
 */
 const { Command } = require('@oclif/core');
 const logger = require('../../classes/logger');
-const { initSdk, initRequestId } = require('../../helpers');
+const { initSdk } = require('../../helpers');
 const { ignoreCacheFlag } = require('../../utils');
 const { getMeshId, getLogsByRayId } = require('../../lib/smsClient');
 require('dotenv').config();
@@ -22,8 +22,6 @@ class FetchLogsCommand extends Command {
 	};
 
 	async run() {
-		await initRequestId();
-
 		logger.info(`RequestId: ${global.requestId}`);
 
 		const { args, flags } = await this.parse(FetchLogsCommand);

package/src/commands/api-mesh/log-list.js

@@ -1,7 +1,7 @@
 const { Command } = require('@oclif/core');
 
 const logger = require('../../classes/logger');
-const { initSdk, initRequestId } = require('../../helpers');
+const { initSdk } = require('../../helpers');
 const { ignoreCacheFlag, fileNameFlag } = require('../../utils');
 const { getMeshId, listLogs } = require('../../lib/smsClient');
 const { appendFileSync, existsSync } = require('fs');
@@ -18,8 +18,6 @@ class ListLogsCommand extends Command {
 	static enableJsonFlag = true;
 
 	async run() {
-		await initRequestId();
-
 		logger.info(`RequestId: ${global.requestId}`);
 
 		const { flags } = await this.parse(ListLogsCommand);

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

@@ -13,6 +13,7 @@ const { Command } = require('@oclif/core');
 const {
 	portNoFlag,
 	debugFlag,
+	inspectPortNoFlag,
 	selectFlag,
 	envFileFlag,
 	secretsFlag,
@@ -27,18 +28,19 @@ const {
 const meshBuilder = require('@adobe-apimesh/mesh-builder');
 const fs = require('fs');
 const path = require('path');
-const {
-	initSdk,
-	initRequestId,
-	importFiles,
-	setUpTenantFiles,
-	writeSecretsFile,
-} = require('../../helpers');
+const { initSdk, importFiles, setUpTenantFiles, writeSecretsFile } = require('../../helpers');
 const logger = require('../../classes/logger');
 const { getMeshId, getMeshArtifact } = require('../../lib/smsClient');
 require('dotenv').config();
-const { runServer } = require('../../server');
-const { fixPlugins } = require('../../fixPlugins');
+const { start } = require('../../wranglerCli');
+const {
+	resolveOriginalSources,
+	copyBuiltMeshToPackage,
+	BUILT_MESH_ARTIFACT_DIRECTORY,
+	safeDelete,
+	getBuiltMeshTenantDirectory,
+} = require('../../project');
+const { resolveRelativeSources } = require('../../meshArtifact');
 
 const { validateMesh, buildMesh, compileMesh } = meshBuilder.default;
 
@@ -55,6 +57,7 @@ class RunCommand extends Command {
 
 	static flags = {
 		port: portNoFlag,
+		inspectPort: inspectPortNoFlag,
 		debug: debugFlag,
 		env: envFileFlag,
 		autoConfirmAction: autoConfirmActionFlag,
@@ -66,182 +69,218 @@ class RunCommand extends Command {
 
 	static examples = [];
 
-	async run() {
-		await initRequestId();
+	/**
+	 * Validate the current working directory to ensure it is set up to run the command
+	 * @returns {Promise<void>}
+	 * @throws {Error} when project is not set up correctly
+	 */
+	async validateCwd() {
+		//Ensure that current directory includes package.json
+		if (!fs.existsSync(path.join(process.cwd(), 'package.json'))) {
+			throw new Error(
+				'`aio api-mesh run` cannot be executed because there is no package.json file in the current directory. Use `aio api-mesh init` to set up a package.',
+			);
+		}
+	}
 
-		logger.info(`RequestId: ${global.requestId}`);
+	/**
+	 * Handle remote mesh artifact
+	 * @returns {Promise<string>} Mesh identifier
+	 * @throws {Error} when failure retrieving remote mesh artifact
+	 */
+	async handleRemoteMeshArtifact() {
+		const { imsOrgCode, projectId, workspaceId, workspaceName } = await initSdk({});
 
-		const { args, flags } = await this.parse(RunCommand);
-		const secretsFilePath = await flags.secrets;
+		// Get the mesh identifier for the workspace
+		let meshId;
+		try {
+			meshId = await getMeshId(imsOrgCode, projectId, workspaceId, workspaceName);
+		} catch (err) {
+			throw new Error(
+				`Unable to get mesh ID. Please check the details and try again. RequestId: ${global.requestId}`,
+			);
+		}
 
-		//Initialize the meshId based on
-		let meshId = null;
+		try {
+			await getMeshArtifact(imsOrgCode, projectId, workspaceId, workspaceName, meshId);
+		} catch (err) {
+			throw new Error(
+				`Unable to retrieve mesh. Please check the details and try again. RequestId: ${global.requestId}`,
+			);
+		}
 
 		try {
-			//Ensure that current directory includes package.json
-			if (fs.existsSync(path.join(process.cwd(), 'package.json'))) {
-				//If select flag is present then getMeshId for the specified org
-				if (flags.select) {
-					const { imsOrgCode, projectId, workspaceId, workspaceName } = await initSdk({});
-
-					try {
-						meshId = await getMeshId(imsOrgCode, projectId, workspaceId, workspaceName);
-					} catch (err) {
-						throw new Error(
-							`Unable to get mesh ID. Please check the details and try again. RequestId: ${global.requestId}`,
-						);
-					}
-
-					try {
-						await getMeshArtifact(imsOrgCode, projectId, workspaceId, workspaceName, meshId);
-					} catch (err) {
-						throw new Error(
-							`Unable to retrieve mesh. Please check the details and try again. RequestId: ${global.requestId}`,
-						);
-					}
-
-					try {
-						await setUpTenantFiles(meshId);
-					} catch (err) {
-						throw new Error('Failed to install downloaded mesh');
-					}
-
-					this.log('Successfully downloaded mesh');
-				} else {
-					if (!args.file) {
-						throw new Error('Missing file path. Run aio api-mesh run --help for more info.');
-					}
-
-					const envFilePath = await flags.env;
-
-					//Read the mesh input file
-					let inputMeshData = await readFileContents(args.file, this, 'mesh');
-					let data;
-
-					if (checkPlaceholders(inputMeshData)) {
-						this.log(
-							'The provided mesh contains placeholders. Starting mesh interpolation process.',
-						);
-						data = await validateAndInterpolateMesh(inputMeshData, envFilePath, this);
-					} else {
-						try {
-							data = JSON.parse(inputMeshData);
-						} catch (err) {
-							this.log(err.message);
-							throw new Error(
-								'Input mesh file is not a valid JSON. Please check the file provided.',
-							);
-						}
-					}
-
-					let filesList = [];
-
-					try {
-						filesList = getFilesInMeshConfig(data, args.file);
-					} catch (err) {
-						this.log(err.message);
-						throw new Error('Input mesh config is not valid.');
-					}
-
-					// if local files are present, import them in files array in meshConfig
-					if (filesList.length) {
-						try {
-							// minification of js will not be done for run command if debugging is enabled
-							data = await importFiles(
-								data,
-								filesList,
-								args.file,
-								flags.autoConfirmAction,
-								!flags.debug,
-							);
-						} catch (err) {
-							this.log(err.message);
-							throw new Error(
-								'Unable to import the files in the mesh config. Please check the file and try again.',
-							);
-						}
-					}
-
-					//Generating unique mesh id
-					meshId = 'testMesh';
-
-					await validateMesh(data.meshConfig);
-					await buildMesh(meshId, data.meshConfig);
-					await compileMesh(meshId);
-				}
-				let portNo;
-				//secrets management
-				if (secretsFilePath) {
-					try {
-						await validateSecretsFile(secretsFilePath);
-						const stringifiedSecrets = await interpolateSecrets(secretsFilePath, this);
-						await writeSecretsFile(stringifiedSecrets, meshId);
-					} catch (error) {
-						this.log(error.message);
-						this.error('Unable to import secrets. Please check the file and try again.');
-					}
-				}
-
-				await this.copyMeshContent(meshId);
-
-				//To set the port number using the environment file
-				if (process.env.PORT !== undefined) {
-					if (isNaN(process.env.PORT) || !Number.isInteger(parseInt(process.env.PORT))) {
-						throw new Error('PORT value in the .env file is not a valid integer');
-					}
-
-					portNo = process.env.PORT;
-				}
-
-				//To set the port number as the provided value in the command
-				if (flags.port !== undefined) {
-					portNo = flags.port;
-				}
-
-				//To set the default port to 5000
-				if (!portNo) {
-					portNo = 5000;
-				}
-				this.log(`Starting server on port : ${portNo}`);
-				await runServer(portNo);
-				this.log(`Server is running on http://localhost:${portNo}/graphql`);
-			} else {
+			await setUpTenantFiles(meshId);
+		} catch (err) {
+			throw new Error('Failed to install downloaded mesh');
+		}
+
+		// Resolve relative sources in built mesh for local development
+		const builtMeshTenantDir = getBuiltMeshTenantDirectory(meshId);
+		await resolveRelativeSources(builtMeshTenantDir);
+
+		this.log('Successfully downloaded mesh');
+
+		return meshId;
+	}
+
+	/**
+	 * Handle local mesh configuration
+	 * @param args {unknown} Arguments
+	 * @param flags {unknown} Flags
+	 * @returns {Promise<string>}
+	 * @throws {Error} when failure building local mesh artifact
+	 */
+	async handleLocalMeshConfig(args, flags) {
+		if (!args.file) {
+			throw new Error('Missing file path. Run aio api-mesh run --help for more info.');
+		}
+
+		const envFilePath = await flags.env;
+
+		//Read the mesh input file
+		let inputMeshData = await readFileContents(args.file, this, 'mesh');
+		let data;
+
+		// TODO: Should we check for secrets in use when no secrets file provided?
+		if (checkPlaceholders(inputMeshData)) {
+			this.log('The provided mesh contains placeholders. Starting mesh interpolation process.');
+			data = await validateAndInterpolateMesh(inputMeshData, envFilePath, this);
+		} else {
+			try {
+				data = JSON.parse(inputMeshData);
+			} catch (err) {
+				this.log(err.message);
+				throw new Error('Input mesh file is not a valid JSON. Please check the file provided.');
+			}
+		}
+
+		let filesList = [];
+
+		try {
+			filesList = getFilesInMeshConfig(data, args.file);
+		} catch (err) {
+			this.log(err.message);
+			throw new Error('Input mesh config is not valid.');
+		}
+
+		// if local files are present, import them in files array in meshConfig
+		let localFileOverrides;
+		if (filesList.length) {
+			try {
+				// minification of js will not be done for run command if debugging is enabled
+				({ data, localFileOverrides } = await importFiles(
+					data,
+					filesList,
+					args.file,
+					flags.autoConfirmAction,
+					!flags.debug,
+				));
+			} catch (err) {
+				this.log(err.message);
 				throw new Error(
-					'`aio api-mesh run` cannot be executed because there is no package.json file in the current directory. Use `aio api-mesh init` to set up a package.',
+					'Unable to import the files in the mesh config. Please check the file and try again.',
 				);
 			}
-		} catch (error) {
-			this.error(error.message);
 		}
+		// Empty mesh-artifact directory
+		safeDelete(BUILT_MESH_ARTIFACT_DIRECTORY);
+
+		//Generating unique mesh id
+		const meshId = 'testMesh';
+		await validateMesh(data.meshConfig);
+		await buildMesh(meshId, data.meshConfig);
+		await compileMesh(meshId);
+
+		// Resolve relative sources in built mesh for local development
+		const builtMeshTenantDir = getBuiltMeshTenantDirectory(meshId);
+		await resolveRelativeSources(builtMeshTenantDir);
+		await resolveOriginalSources(builtMeshTenantDir, localFileOverrides);
+
+		return meshId;
 	}
 
-	async copyMeshContent(meshId) {
-		// Remove mesh artifact directory if exists
-		if (fs.existsSync('.mesh')) {
-			fs.rmSync('.mesh', { recursive: true });
+	updateFlagsFromEnv(flags) {
+		if (process.env.PORT !== undefined) {
+			flags.port = this.parseInt(
+				process.env.PORT,
+				'PORT value in the .env file is not a valid integer',
+			);
+		}
+		if (process.env.INSPECT_PORT !== undefined) {
+			flags.inspectPort = this.parseInt(
+				process.env.INSPECT_PORT,
+				'INSPECT_PORT value in the .env file is not a valid integer',
+			);
 		}
-		// Move built mesh artifact to expect directory
-		fs.renameSync(`mesh-artifact/${meshId}`, '.mesh');
-		// Remove tenant files directory if exists
-		if (fs.existsSync('tenantFiles')) {
-			fs.rmSync('tenantFiles', { recursive: true });
+	}
+
+	/**
+	 * Parse integer from string
+	 * @param value {string} String value
+	 * @param errorMessage {string?} Optional error message when parsing fails
+	 * @returns {number}
+	 * @throws {Error} when value is not a valid integer
+	 */
+	parseInt(value, errorMessage) {
+		const int = parseInt(value);
+		if (isNaN(int) || !Number.isInteger(int)) {
+			throw new Error(errorMessage || `Value is not a valid integer`);
 		}
-		// Move built tenant files if exists
-		if (fs.existsSync('mesh-artifact/tenantFiles')) {
-			// Tenant files included in the bundle for runtime/dynamic imports
-			fs.cpSync('mesh-artifact/tenantFiles', '.mesh/tenantFiles', { recursive: true });
-			fs.renameSync('mesh-artifact/tenantFiles', 'tenantFiles');
+		return int;
+	}
+
+	/**
+	 * Handle secrets feature
+	 * @param secretsFilePath {string} File path to secrets
+	 * @param meshId {string} Mesh identifier
+	 * @returns {Promise<void>}
+	 */
+	async handleSecretsFeature(secretsFilePath, meshId) {
+		if (secretsFilePath) {
+			try {
+				await validateSecretsFile(secretsFilePath);
+				const stringifiedSecrets = await interpolateSecrets(secretsFilePath, this);
+				await writeSecretsFile(stringifiedSecrets, meshId);
+			} catch (error) {
+				this.log(error.message);
+				this.error('Unable to import secrets. Please check the file and try again.');
+			}
 		}
+	}
 
-		await fixPlugins('.mesh/index.js');
+	async run() {
+		try {
+			logger.info(`RequestId: ${global.requestId}`);
+
+			const { args, flags } = await this.parse(RunCommand);
+			await this.validateCwd();
+			this.updateFlagsFromEnv(flags);
+
+			// Use remote or local mesh artifact
+			let meshId;
+			if (flags.select) {
+				meshId = await this.handleRemoteMeshArtifact();
+			} else {
+				meshId = await this.handleLocalMeshConfig(args, flags);
+			}
 
-		if (fs.existsSync(`${__dirname}/../../../.mesh`)) {
-			fs.rmSync(`${__dirname}/../../../.mesh`, { recursive: true });
+			//secrets management
+			const secretsFilePath = await flags.secrets;
+			if (secretsFilePath) {
+				await this.handleSecretsFeature(secretsFilePath, meshId);
+			}
+
+			const builtMeshTenantDir = getBuiltMeshTenantDirectory(meshId);
+			await copyBuiltMeshToPackage(builtMeshTenantDir);
+
+			start(this, flags.port, flags.debug, flags.inspectPort);
+			if (flags.debug) {
+				this.log(`Debugging enabled on inspect port: ${flags.inspectPort}`);
+			}
+		} catch (error) {
+			this.error(error.message);
 		}
-		// At this time the bundle and build files must be copied out to the plugin directory
-		fs.cpSync('.mesh', `${__dirname}/../../../.mesh`, { recursive: true });
-		// Tenant files used at build time
-		fs.cpSync('tenantFiles', `${__dirname}/../../../tenantFiles`, { recursive: true });
 	}
 }