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

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

@@ -1064,7 +1064,7 @@ const getMeshDeployments = async (organizationCode, projectId, workspaceId, mesh
  * As a result, we provide the publicKey used for secrets encryption.
  * The near-term goal is to stop using Dev Console as a proxy for all routes.
  * @param organizationCode
- * @returns Promise<string>
+ * @returns string
  */
 const getPublicEncryptionKey = async organizationCode => {
 	const { accessToken } = await getDevConsoleConfig();
@@ -1201,6 +1201,189 @@ 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}`,
+			);
+		}
+	}
+};
+
 module.exports = {
 	getApiKeyCredential,
 	describeMesh,
@@ -1222,4 +1405,6 @@ module.exports = {
 	getPresignedUrls,
 	getLogsByRayId,
 	cachePurge,
+	setLogForwarding,
+	getLogForwarding,
 };

package/src/server.js

@@ -1,80 +1,38 @@
-import { getMesh } from '@graphql-mesh/runtime';
-
-const { getCorsOptions } = require('./cors');
-const { createYoga } = require('graphql-yoga');
-const { GraphQLError } = require('graphql/error');
-
-const { loadMeshSecrets, getSecretsHandler } = require('./secrets');
-const useComplianceHeaders = require('./plugins/complianceHeaders');
-const UseHttpDetailsExtensions = require('./plugins/httpDetailsExtensions');
-const useSourceHeaders = require('@adobe/plugin-source-headers');
-const { useDisableIntrospection } = require('@envelop/disable-introspection');
-
-let meshInstance$;
-
-async function buildMeshInstance(meshArtifacts, meshConfig) {
-	const { getMeshOptions } = meshArtifacts;
-	const options = await getMeshOptions();
-
-	options.additionalEnvelopPlugins = (options.additionalEnvelopPlugins || []).concat(
-		useComplianceHeaders(),
-		UseHttpDetailsExtensions({
-			// Get the details of responseConfig.includeHTTPDetails and store in Cache
-			if: meshConfig.responseConfig?.includeHTTPDetails || false,
-		}),
-		useSourceHeaders(meshConfig),
-	);
-
-	if (meshConfig.disableIntrospection) {
-		options.additionalEnvelopPlugins.push(useDisableIntrospection());
-	}
-
-	return getMesh(options).then(mesh => {
-		const id = mesh.pubsub.subscribe('destroy', () => {
-			meshInstance$ = undefined;
-			mesh.pubsub.unsubscribe(id);
-		});
-		return mesh;
+const { spawn } = require('child_process');
+const { readSecretsFile } = require('./serverUtils');
+const packageData = require('../package.json');
+
+const runServer = portNo => {
+	const wranglerPackageNumber = packageData.dependencies.wrangler;
+	const wranglerVersion = `wrangler@${wranglerPackageNumber.replace(/^[\^~]/, '')}`;
+	const indexFilePath = `${__dirname}/index.js`;
+	const filePath = '.mesh';
+	const secrets = readSecretsFile(filePath);
+	const commandArgs = [
+		wranglerVersion,
+		'dev',
+		indexFilePath,
+		'--show-interactive-dev-session',
+		'false',
+		'--var',
+		`Secret:${JSON.stringify(secrets)}`,
+		'--port',
+		portNo,
+		'--inspector-port',
+		'9229',
+	];
+
+	const wrangler = spawn('npx', commandArgs, {
+		stdio: 'inherit',
 	});
-}
-
-async function getBuiltMesh(meshArtifacts, meshConfig) {
-	if (meshInstance$ == null) {
-		meshInstance$ = buildMeshInstance(meshArtifacts, meshConfig);
-	}
-	return meshInstance$;
-}
-
-const buildServer = async (loggerInstance, env, meshArtifacts, meshConfig) => {
-	const { Secret: secret } = env;
-	const tenantMesh = await getBuiltMesh(meshArtifacts, meshConfig);
-	const meshSecrets = loadMeshSecrets(loggerInstance, secret);
-	return await buildYogaServer(env, tenantMesh, meshConfig, meshSecrets);
-};
 
-async function buildYogaServer(env, tenantMesh, meshConfig, meshSecrets) {
-	const secretsProxy = new Proxy(meshSecrets, getSecretsHandler);
-	return createYoga({
-		plugins: tenantMesh.plugins,
-		graphqlEndpoint: `/graphql`,
-		cors: getCorsOptions(env, meshConfig),
-		context: initialContext => ({
-			...initialContext,
-			secrets: secretsProxy,
-		}),
-		maskedErrors: {
-			maskError: maskError,
-		},
-		logging: 'debug',
+	wrangler.on('close', code => {
+		console.log(`wrangler dev process exited with code ${code}`);
 	});
-}
-
-const maskError = error => {
-	if (error instanceof GraphQLError && error.extensions?.http?.headers) {
-		delete error.extensions.http.headers;
-	}
 
-	return error;
+	wrangler.on('error', error => {
+		console.error(`Failed to start wrangler dev: ${error.message}`);
+	});
 };
 
-module.exports = { buildServer };
+module.exports = { runServer };

package/src/utils.js

@@ -62,13 +62,6 @@ const secretsFlag = Flags.string({
 const portNoFlag = Flags.integer({
 	char: 'p',
 	description: 'Port number for the local dev server',
-	default: 5000,
-});
-
-const inspectPortNoFlag = Flags.integer({
-	char: 'i',
-	description: 'Port number for the local dev server inspector',
-	default: 9229,
 });
 
 const debugFlag = Flags.boolean({
@@ -106,6 +99,49 @@ const logFilenameFlag = Flags.string({
 	required: true,
 });
 
+// The `destinations` object to hold the configuration for log forwarding destinations.
+// It prompts for the required inputs for the destination.
+// Each destination can have different key/value pairs of configuration credentials.
+// and applies the validation logic accordingly.
+const destinations = {
+	// Configuration for the 'New Relic' destination
+	'New Relic': {
+		name: 'newrelic', // internal value that will be used
+		// Required inputs for the 'New Relic' destination
+		inputs: [
+			{
+				name: 'baseUri',
+				promptMessage: 'Enter base URI:',
+				isSecret: false,
+				validate: value => {
+					if (!value) {
+						throw new Error('Base URI is required');
+					}
+					if (!value.startsWith('https://')) {
+						throw new Error('The URI value must include the protocol (https://)');
+					}
+				},
+			},
+			{
+				name: 'licenseKey',
+				promptMessage: 'Enter license key:',
+				isSecret: true,
+				validate: value => {
+					if (!value) {
+						throw new Error('License key is required');
+					}
+					if (value.length !== 40) {
+						throw new Error(
+							`The license key is in the wrong format. Expected: 40 characters (received: ${value.length})`,
+						);
+					}
+				},
+			},
+		],
+	},
+	// Additional destinations can be added here
+};
+
 /**
  * Parse the meshConfig and get the list of (local) files to be imported
  *
@@ -284,7 +320,7 @@ function checkPlaceholders(mesh) {
  * @param {string} file
  * @param {object} command
  * @param {string} filetype
- * @returns {Promise<string>}
+ * @returns {string}
  */
 async function readFileContents(file, command, filetype) {
 	try {
@@ -352,7 +388,7 @@ function validateFileName(filesList) {
  * @param {string} inputMeshData
  * @param {string} envFilePath
  * @param {object} command
- * @returns {Promise<string>}
+ * @returns {string}
  */
 async function validateAndInterpolateMesh(inputMeshData, envFilePath, command) {
 	//Read the environment file
@@ -767,7 +803,6 @@ module.exports = {
 	validateAndInterpolateMesh,
 	getAppRootDir,
 	portNoFlag,
-	inspectPortNoFlag,
 	debugFlag,
 	selectFlag,
 	secretsFlag,
@@ -786,4 +821,5 @@ module.exports = {
 	validateDateTimeFormat,
 	localToUTCTime,
 	cachePurgeAllActionFlag,
+	destinations,
 };

package/src/wranglerServer.js

@@ -0,0 +1,80 @@
+import { getMesh } from '@graphql-mesh/runtime';
+
+const { getCorsOptions } = require('./cors');
+const { createYoga } = require('graphql-yoga');
+const { GraphQLError } = require('graphql/error');
+
+const { loadMeshSecrets, getSecretsHandler } = require('./secrets');
+const useComplianceHeaders = require('./plugins/complianceHeaders');
+const UseHttpDetailsExtensions = require('./plugins/httpDetailsExtensions');
+const useSourceHeaders = require('@adobe/plugin-source-headers');
+const { useDisableIntrospection } = require('@envelop/disable-introspection');
+
+let meshInstance$;
+
+async function buildMeshInstance(meshArtifacts, meshConfig) {
+	const { getMeshOptions } = meshArtifacts;
+	const options = await getMeshOptions();
+
+	options.additionalEnvelopPlugins = (options.additionalEnvelopPlugins || []).concat(
+		useComplianceHeaders(),
+		UseHttpDetailsExtensions({
+			// Get the details of responseConfig.includeHTTPDetails and store in Cache
+			if: meshConfig.responseConfig?.includeHTTPDetails || false,
+		}),
+		useSourceHeaders(meshConfig),
+	);
+
+	if (meshConfig.disableIntrospection) {
+		options.additionalEnvelopPlugins.push(useDisableIntrospection());
+	}
+
+	return getMesh(options).then(mesh => {
+		const id = mesh.pubsub.subscribe('destroy', () => {
+			meshInstance$ = undefined;
+			mesh.pubsub.unsubscribe(id);
+		});
+		return mesh;
+	});
+}
+
+async function getBuiltMesh(meshArtifacts, meshConfig) {
+	if (meshInstance$ == null) {
+		meshInstance$ = buildMeshInstance(meshArtifacts, meshConfig);
+	}
+	return meshInstance$;
+}
+
+const buildServer = async (loggerInstance, env, meshArtifacts, meshConfig) => {
+	const { Secret: secret } = env;
+	const tenantMesh = await getBuiltMesh(meshArtifacts, meshConfig);
+	const meshSecrets = loadMeshSecrets(loggerInstance, secret);
+	return await buildYogaServer(env, tenantMesh, meshConfig, meshSecrets);
+};
+
+async function buildYogaServer(env, tenantMesh, meshConfig, meshSecrets) {
+	const secretsProxy = new Proxy(meshSecrets, getSecretsHandler);
+	return createYoga({
+		plugins: tenantMesh.plugins,
+		graphqlEndpoint: `/graphql`,
+		cors: getCorsOptions(env, meshConfig),
+		context: initialContext => ({
+			...initialContext,
+			secrets: secretsProxy,
+		}),
+		maskedErrors: {
+			maskError: maskError,
+		},
+		logging: 'debug',
+	});
+}
+
+const maskError = error => {
+	if (error instanceof GraphQLError && error.extensions?.http?.headers) {
+		delete error.extensions.http.headers;
+	}
+
+	return error;
+};
+
+module.exports = { buildServer };