@adobe/aio-cli-plugin-api-mesh 5.2.3 → 5.2.4-alpha.1

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

@@ -1,8 +1,8 @@
 const { Command } = require('@oclif/core');
 
 const logger = require('../../classes/logger');
-const { initRequestId, initSdk } = require('../../helpers');
-const { getMeshId, getMesh, getMeshDeployments } = require('../../lib/devConsole');
+const { initSdk } = require('../../helpers');
+const { getMeshId, getMesh, getMeshDeployments } = require('../../lib/smsClient');
 const { ignoreCacheFlag } = require('../../utils');
 
 require('dotenv').config();
@@ -13,7 +13,6 @@ class StatusCommand extends Command {
 	};
 
 	async run() {
-		await initRequestId();
 		logger.info(`RequestId: ${global.requestId}`);
 
 		const { flags } = await this.parse(StatusCommand);

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

@@ -10,9 +10,10 @@ governing permissions and limitations under the License.
 */
 
 const { Command } = require('@oclif/command');
+const chalk = require('chalk');
 
 const logger = require('../../classes/logger');
-const { initSdk, initRequestId, promptConfirm, importFiles } = require('../../helpers');
+const { initSdk, promptConfirm, importFiles } = require('../../helpers');
 const {
 	ignoreCacheFlag,
 	autoConfirmActionFlag,
@@ -26,7 +27,7 @@ const {
 	validateSecretsFile,
 	encryptSecrets,
 } = require('../../utils');
-const { getMeshId, updateMesh, getPublicEncryptionKey } = require('../../lib/devConsole');
+const { getMeshId, updateMesh, getPublicEncryptionKey } = require('../../lib/smsClient');
 
 class UpdateCommand extends Command {
 	static args = [{ name: 'file' }];
@@ -38,8 +39,6 @@ class UpdateCommand extends Command {
 	};
 
 	async run() {
-		await initRequestId();
-
 		logger.info(`RequestId: ${global.requestId}`);
 
 		const { args, flags } = await this.parse(UpdateCommand);
@@ -129,6 +128,23 @@ class UpdateCommand extends Command {
 		if (meshId) {
 			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 the meshConfig.`,
+				);
+			}
+
 			if (!autoConfirmAction) {
 				shouldContinue = await promptConfirm(
 					`Are you sure you want to update the mesh: ${meshId}?`,

package/src/helpers.js

@@ -437,10 +437,38 @@ async function initSdk(options) {
 /**
  * Generates a static global requestid for the lifecycle of this command request
  */
-async function initRequestId() {
+function initRequestId() {
 	global.requestId = UUID.newUuid().toString();
 }
 
+/**
+ *
+ * This function initializes the metadata headers for the command execution
+ *
+ * @param {*} config
+ */
+function initMetadata(config) {
+	try {
+		const { version, plugins, userAgent, platform, arch } = config;
+		const currentIntalledVersion = getCurrentInstalledPluginVersion(plugins);
+
+		const metadataHeaders = {
+			'x-aio-cli-version': version,
+			'x-aio-cli-user-agent': userAgent,
+			'x-aio-cli-platform': platform,
+			'x-aio-cli-arch': arch,
+			'x-aio-cli-plugin-api-mesh-version': currentIntalledVersion,
+		};
+
+		global.metadataHeaders = metadataHeaders;
+	} catch (error) {
+		logger.error('Unable to initialize metadata headers');
+		logger.error(error.message);
+
+		global.metadataHeaders = {};
+	}
+}
+
 /**
  * Function to run the CLI Y/N prompt to confirm the user's action
  *
@@ -519,6 +547,24 @@ async function promptInput(message) {
 	return selected.item;
 }
 
+/**
+ * Function to prompt for a secret/password input that masks the characters
+ *
+ * @param {string} message - prompt message
+ * @returns {Promise<string>} - the entered secret value
+ */
+async function promptInputSecret(message) {
+	const selected = await inquirer.prompt([
+		{
+			name: 'item',
+			message,
+			type: 'password',
+		},
+	]);
+
+	return selected.item;
+}
+
 /**
  * Import the files in the files array in meshConfig
  *
@@ -894,17 +940,36 @@ async function writeSecretsFile(secretsData, meshId) {
 
 /**
  *
- * This function fetches current installed version the system and the latest version from npm
+ * This function gets the current installed version of the plugin
  *
  * @param {*} installedPlugins
- * @returns { currentVersion: string, latestVersion: string }
+ * @returns {string || null} - current installed version of the plugin
  */
-async function getPluginVersionDetails(installedPlugins) {
+function getCurrentInstalledPluginVersion(installedPlugins) {
 	try {
 		const meshPlugin = installedPlugins.find(
 			({ name }) => name === '@adobe/aio-cli-plugin-api-mesh',
 		);
-		const currentVersion = meshPlugin.version;
+
+		return meshPlugin.version;
+	} catch (err) {
+		logger.error('Unable to get current installed version');
+		logger.error(err.message);
+
+		return null;
+	}
+}
+
+/**
+ *
+ * This function fetches current installed version the system and the latest version from npm
+ *
+ * @param {*} installedPlugins
+ * @returns { currentVersion: string, latestVersion: string }
+ */
+async function getPluginVersionDetails(installedPlugins) {
+	try {
+		const currentVersion = getCurrentInstalledPluginVersion(installedPlugins);
 
 		let config = {
 			method: 'get',
@@ -959,10 +1024,12 @@ module.exports = {
 	objToString,
 	promptInput,
 	promptConfirm,
+	promptInputSecret,
 	getLibConsoleCLI,
 	getDevConsoleConfig,
 	initSdk,
 	initRequestId,
+	initMetadata,
 	promptSelect,
 	promptMultiselect,
 	importFiles,

package/src/hooks/initMetadata.js

@@ -0,0 +1,8 @@
+const { initMetadata, initRequestId } = require('../helpers');
+
+const hook = async function () {
+	initRequestId();
+	initMetadata(this.config);
+};
+
+module.exports = hook;

package/src/lib/{devConsole.js → smsClient.js}

@@ -119,6 +119,7 @@ const listLogs = async (organizationCode, projectId, workspaceId, meshId, fileNa
 		method: 'get',
 		url: fileName ? url + `?filename=${fileName}` : url,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
 			'x-api-key': SMS_API_KEY,
@@ -147,6 +148,7 @@ const getMesh = async (organizationId, projectId, workspaceId, workspaceName, me
 		method: 'get',
 		url: `${SMS_BASE_URL}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
 			'workspaceName': workspaceName,
@@ -238,6 +240,7 @@ const createMesh = async (
 		method: 'post',
 		url: `${SMS_BASE_URL}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'Content-Type': 'application/json',
 			'x-request-id': global.requestId,
@@ -350,6 +353,7 @@ const updateMesh = async (
 		method: 'put',
 		url: `${SMS_BASE_URL}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'Content-Type': 'application/json',
 			'x-request-id': global.requestId,
@@ -441,6 +445,7 @@ const deleteMesh = async (organizationId, projectId, workspaceId, meshId) => {
 		method: 'delete',
 		url: `${SMS_BASE_URL}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
 			'x-api-key': SMS_API_KEY,
@@ -527,6 +532,7 @@ const cachePurge = async (organizationId, projectId, workspaceId, meshId) => {
 		method: 'post',
 		url: `${SMS_BASE_URL}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}/cache/purge`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'Content-Type': 'application/json',
 			'x-request-id': global.requestId,
@@ -617,6 +623,7 @@ const getMeshId = async (organizationCode, projectId, workspaceId, workspaceName
 		method: 'get',
 		url: `${SMS_BASE_URL}/organizations/${organizationCode}/projects/${projectId}/workspaces/${workspaceId}/mesh`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
 			'workspaceName': workspaceName,
@@ -903,6 +910,7 @@ const getMeshArtifact = async (organizationId, projectId, workspaceId, workspace
 		method: 'get',
 		url: `${SMS_BASE_URL}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}/artifact`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
 			'workspaceName': workspaceName,
@@ -961,6 +969,7 @@ const getTenantFeatures = async organizationCode => {
 		method: 'get',
 		url: `${SMS_BASE_URL}/organizations/${organizationCode}/features`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
 			'x-api-key': SMS_API_KEY,
@@ -1016,6 +1025,7 @@ const getMeshDeployments = async (organizationCode, projectId, workspaceId, mesh
 		method: 'get',
 		url: `${SMS_BASE_URL}/organizations/${organizationCode}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}/deployments/latest`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
 			'x-api-key': SMS_API_KEY,
@@ -1072,6 +1082,7 @@ const getPublicEncryptionKey = async organizationCode => {
 		method: 'get',
 		url: `${SMS_BASE_URL}/organizations/${organizationCode}/getPublicKey`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
 			'x-api-key': SMS_API_KEY,
@@ -1117,6 +1128,7 @@ const getPresignedUrls = async (
 		method: 'get',
 		url: `${SMS_BASE_URL}/organizations/${organizationCode}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}/logs?startDateTime=${startTime}&endDateTime=${endTime}`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
 			'x-api-key': SMS_API_KEY,
@@ -1156,6 +1168,7 @@ const getLogsByRayId = async (organizationCode, projectId, workspaceId, meshId,
 		method: 'get',
 		url: `${SMS_BASE_URL}/organizations/${organizationCode}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}/logs/${rayId}`,
 		headers: {
+			...global?.metadataHeaders,
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
 			'x-api-key': SMS_API_KEY,
@@ -1201,6 +1214,289 @@ const getLogsByRayId = async (organizationCode, projectId, workspaceId, meshId,
 	}
 };
 
+/**
+ * @param {string} organizationCode - The IMS org code
+ * @param {string} projectId - The project ID
+ * @param {string} workspaceId - The workspace ID
+ * @param {string} meshId - The mesh ID
+ * @param {Object} logConfig - The log forwarding configuration
+ */
+const setLogForwarding = async (organizationCode, projectId, workspaceId, meshId, logConfig) => {
+	const { accessToken } = await getDevConsoleConfig();
+	const config = {
+		method: 'POST',
+		url: `${SMS_BASE_URL}/organizations/${organizationCode}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}/log/forwarding`,
+		headers: {
+			'Authorization': `Bearer ${accessToken}`,
+			'Content-Type': 'application/json',
+			'x-request-id': global.requestId,
+			'x-api-key': SMS_API_KEY,
+		},
+		data: JSON.stringify(logConfig),
+	};
+
+	logger.info(
+		'Initiating POST %s',
+		`${SMS_BASE_URL}/organizations/${organizationCode}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}/log/forwarding`,
+	);
+
+	try {
+		const response = await axios(config);
+
+		logger.info('Response from POST %s', response.status);
+
+		if (response?.status === 200) {
+			logger.info(`Log forwarding configuration: ${objToString(response, ['data'])}`);
+			return {
+				result: response.data.result,
+				message: response.data.message,
+			};
+		} else {
+			// not 200 response
+			logger.error(
+				`Something went wrong: ${objToString(
+					response,
+					['data'],
+					'Unable to set log forwarding details.',
+				)}. Received ${response.status}, expected 200`,
+			);
+			throw new Error(response.data.message);
+		}
+	} catch (error) {
+		if (error.response && error.response.status === 400) {
+			// The request was made and the server responded with a 400 status code
+			logger.error('Error setting log forwarding configuration: %j', error.response.data);
+
+			throw new Error('Invalid input parameters.');
+		}
+		// request made but no response received
+		else if (error.request && !error.response) {
+			logger.error('No response received from server when setting log forwarding configuration');
+			throw new Error('Unable to set log forwarding details. Check the details and try again.');
+		}
+		// response received with error
+		else if (error.response && error.response.data) {
+			logger.error(
+				'Error setting log forwarding configuration: %s',
+				objToString(error, ['response', 'data'], 'Unable to set log forwarding'),
+			);
+
+			// response a message or messages field
+
+			if (error.response.data.message || error.response.data.messages) {
+				const message = objToString(
+					error,
+					['response', 'data', 'message' || 'messages'],
+					'Unable to set log forwarding',
+				);
+				throw new Error(message);
+			}
+			// response contains error but no specific message field
+			else {
+				const message = objToString(error, ['response', 'data'], 'Unable to set log forwarding');
+				throw new Error(message);
+			}
+		} else {
+			// Something else happened while setting up the request
+			logger.error('Error setting log forwarding configuration: %s', error.message);
+			throw new Error(`Something went wrong while setting log forwarding. ${error.message}`);
+		}
+	}
+};
+
+/**
+ * @param {string} organizationCode - The IMS org code
+ * @param {string} projectId - The project ID
+ * @param {string} workspaceId - The workspace ID
+ * @param {string} meshId - The mesh ID
+ */
+const getLogForwarding = async (organizationCode, projectId, workspaceId, meshId) => {
+	const { accessToken } = await getDevConsoleConfig();
+	const config = {
+		method: 'GET',
+		url: `${SMS_BASE_URL}/organizations/${organizationCode}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}/log/forwarding`,
+		headers: {
+			'Authorization': `Bearer ${accessToken}`,
+			'Content-Type': 'application/json',
+			'x-request-id': global.requestId,
+			'x-api-key': SMS_API_KEY,
+		},
+	};
+
+	logger.info(
+		'Initiating POST %s',
+		`${SMS_BASE_URL}/organizations/${organizationCode}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}/log/forwarding`,
+	);
+
+	try {
+		const response = await axios(config);
+
+		logger.info('Response from GET %s', response.status);
+
+		if (response?.status === 200) {
+			logger.info(`Get log forwarding configuration: ${objToString(response, ['data'])}`);
+			return {
+				data: response.data,
+			};
+		} else {
+			// not 200 response
+			logger.error(
+				`Something went wrong: ${objToString(
+					response,
+					['data'],
+					'Unable to get log forwarding details.',
+				)}. Received ${response.status}, expected 200`,
+			);
+			throw new Error(response.data.message);
+		}
+	} catch (error) {
+		if (error.response && error.response.status === 400) {
+			// The request was made and the server responded with a 400 status code
+			logger.error('Error getting the log forwarding configuration: %j', error.response.data);
+
+			throw new Error('Invalid input parameters.');
+		} else if (error.response && error.response.status === 404) {
+			logger.error('Log forwarding details not found');
+
+			return null;
+		}
+		// request made but no response received
+		else if (error.request && !error.response) {
+			logger.error('No response from server when getting the log forwarding configuration');
+			throw new Error('Unable to get log forwarding details. Check the details and try again.');
+		}
+		// response received with error
+		else if (error.response && error.response.data) {
+			logger.error(
+				'Error getting the log forwarding configuration: %s',
+				objToString(error, ['response', 'data'], 'Unable to get log forwarding'),
+			);
+
+			// response a message or messages field
+
+			if (error.response.data.message || error.response.data.messages) {
+				const message = objToString(
+					error,
+					['response', 'data', 'message' || 'messages'],
+					'Unable to get log forwarding',
+				);
+				throw new Error(message);
+			}
+			// response contains error but no specific message field
+			else {
+				const message = objToString(error, ['response', 'data'], 'Unable to get log forwarding');
+				throw new Error(message);
+			}
+		} else {
+			// Something else happened while setting up the request
+			logger.error('Error getting the log forwarding configuration: %s', error.message);
+			throw new Error(
+				`Something went wrong while getting the log forwarding configuration. ${error.message}`,
+			);
+		}
+	}
+};
+
+/**
+ * Deletes the log forwarding configuration for a given mesh.
+ *
+ * @param {string} organizationCode - The IMS org code
+ * @param {string} projectId - The project ID
+ * @param {string} workspaceId - The workspace ID
+ * @param {string} meshId - The mesh ID
+ */
+const deleteLogForwarding = async (organizationCode, projectId, workspaceId, meshId) => {
+	const { accessToken } = await getDevConsoleConfig();
+	const config = {
+		method: 'DELETE',
+		url: `${SMS_BASE_URL}/organizations/${organizationCode}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}/log/forwarding`,
+		headers: {
+			'Authorization': `Bearer ${accessToken}`,
+			'x-request-id': global.requestId,
+			'x-api-key': SMS_API_KEY,
+		},
+	};
+
+	logger.info(
+		'Initiating DELETE %s',
+		`${SMS_BASE_URL}/organizations/${organizationCode}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}/log/forwarding`,
+	);
+
+	try {
+		const response = await axios(config);
+
+		logger.info('Response from DELETE %s', response.status);
+
+		if (response && response?.status === 204) {
+			return response;
+		} else {
+			logger.error(
+				`Unable to delete log forwarding config: ${objToString(
+					response,
+					['data'],
+					'Error',
+				)}. Received ${response.status}, expected 204`,
+			);
+			throw new Error(
+				`something went wrong: ${objToString(
+					response,
+					['data'],
+					'Unable to delete log forwarding',
+				)}`,
+			);
+		}
+	} catch (error) {
+		logger.info('Response from DELETE %s', error.response.status);
+
+		if (error.response.status === 404) {
+			// The request was made and the server responded with a 404 status code
+			logger.error('log forwarding details not found');
+
+			throw new Error('log forwarding details not found');
+		} else if (error.response && error.response.data) {
+			// The request was made and the server responded with an unsupported status code
+			logger.error(
+				'Error while deleting log forwarding details. Response: %s',
+				objToString(error, ['response', 'data'], 'Unable to delete log forwarding details'),
+			);
+
+			if (error.response.data.messages) {
+				const message = objToString(
+					error,
+					['response', 'data', 'messages', '0', 'message'],
+					'Unable to delete log forwarding details',
+				);
+
+				throw new Error(message);
+			} else if (error.response.data.message) {
+				const message = objToString(
+					error,
+					['response', 'data', 'message'],
+					'Unable to delete log forwarding details',
+				);
+
+				throw new Error(message);
+			} else {
+				const message = objToString(
+					error,
+					['response', 'data'],
+					'Unable to delete log forwarding details',
+				);
+
+				throw new Error(message);
+			}
+		} else {
+			// The request was made but no response was received
+			logger.error(
+				'Error while deleting log forwarding details. No response received from the server: %s',
+				objToString(error, [], 'Unable to delete log forwarding details'),
+			);
+
+			throw new Error('Unable to delete log forwarding details: %s', error.message);
+		}
+	}
+};
+
 module.exports = {
 	getApiKeyCredential,
 	describeMesh,
@@ -1222,4 +1518,7 @@ module.exports = {
 	getPresignedUrls,
 	getLogsByRayId,
 	cachePurge,
+	setLogForwarding,
+	getLogForwarding,
+	deleteLogForwarding,
 };