@adobe/aio-cli-plugin-api-mesh 3.0.0 → 3.1.0-beta.1

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

@@ -25,7 +25,7 @@ const {
 } = require('../../utils');
 const { getMesh, createMesh } = require('../../lib/devConsole');
 
-const { MULTITENANT_GRAPHQL_SERVER_BASE_URL, TMOConstants } = CONSTANTS;
+const { MULTITENANT_GRAPHQL_SERVER_BASE_URL } = CONSTANTS;
 
 class CreateCommand extends Command {
 	static args = [{ name: 'file' }];
@@ -54,7 +54,7 @@ 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({
+		const { imsOrgId, projectId, workspaceId, workspaceName } = await initSdk({
 			ignoreCache,
 		});
 
@@ -104,7 +104,13 @@ class CreateCommand extends Command {
 
 		if (shouldContinue) {
 			try {
-				const { mesh, apiKey, sdkList } = await createMesh(imsOrgId, projectId, workspaceId, data);
+				const { mesh, apiKey, sdkList } = await createMesh(
+					imsOrgId,
+					projectId,
+					workspaceId,
+					workspaceName,
+					data,
+				);
 
 				if (mesh) {
 					this.log(
@@ -126,23 +132,25 @@ class CreateCommand extends Command {
 						if (sdkList) {
 							this.log('Successfully subscribed API Key %s to API Mesh service', apiKey);
 
-							const { meshURL } = await getMesh(imsOrgId, projectId, workspaceId, mesh.meshId);
+							const { meshURL } = await getMesh(
+								imsOrgId,
+								projectId,
+								workspaceId,
+								workspaceName,
+								mesh.meshId,
+							);
 							const meshUrl =
 								meshURL === '' || meshURL === undefined
 									? MULTITENANT_GRAPHQL_SERVER_BASE_URL
 									: meshURL;
 
-							if (
-								meshUrl === TMOConstants.TMO_STAGE_URL ||
-								meshUrl === TMOConstants.TMO_SANDBOX_URL ||
-								meshUrl === TMOConstants.TMO_PROD_URL
-							) {
-								this.log('Mesh Endpoint: %s\n', `${meshUrl}/${mesh.meshId}/graphql`);
-							} else {
+							if (apiKey && MULTITENANT_GRAPHQL_SERVER_BASE_URL.includes(meshUrl)) {
 								this.log(
 									'Mesh Endpoint: %s\n',
 									`${meshUrl}/${mesh.meshId}/graphql?api_key=${apiKey}`,
 								);
+							} else {
+								this.log('Mesh Endpoint: %s\n', `${meshUrl}/${mesh.meshId}/graphql`);
 							}
 						} else {
 							this.log('Unable to subscribe API Key %s to API Mesh service', apiKey);

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

@@ -19,7 +19,7 @@ const { describeMesh, getMesh } = require('../../lib/devConsole');
 
 require('dotenv').config();
 
-const { MULTITENANT_GRAPHQL_SERVER_BASE_URL, TMOConstants } = CONSTANTS;
+const { MULTITENANT_GRAPHQL_SERVER_BASE_URL } = CONSTANTS;
 
 class DescribeCommand extends Command {
 	static flags = {
@@ -35,12 +35,12 @@ class DescribeCommand extends Command {
 
 		const ignoreCache = await flags.ignoreCache;
 
-		const { imsOrgId, projectId, workspaceId } = await initSdk({
+		const { imsOrgId, projectId, workspaceId, workspaceName } = await initSdk({
 			ignoreCache,
 		});
 
 		try {
-			const meshDetails = await describeMesh(imsOrgId, projectId, workspaceId);
+			const meshDetails = await describeMesh(imsOrgId, projectId, workspaceId, workspaceName);
 
 			if (meshDetails) {
 				const { meshId, apiKey } = meshDetails;
@@ -52,19 +52,20 @@ class DescribeCommand extends Command {
 					this.log('Workspace ID: %s', workspaceId);
 					this.log('Mesh ID: %s', meshId);
 
-					const { meshURL } = await getMesh(imsOrgId, projectId, workspaceId, meshId);
-					const meshUrl = meshURL === '' ? MULTITENANT_GRAPHQL_SERVER_BASE_URL : meshURL;
+					const { meshURL } = await getMesh(
+						imsOrgId,
+						projectId,
+						workspaceId,
+						workspaceName,
+						meshId,
+					);
+					const meshUrl =
+						meshURL === '' || meshURL === undefined ? MULTITENANT_GRAPHQL_SERVER_BASE_URL : meshURL;
 
-					if (
-						apiKey &&
-						(meshUrl === TMOConstants.TMO_STAGE_URL ||
-							meshUrl === TMOConstants.TMO_SANDBOX_URL ||
-							meshUrl === TMOConstants.TMO_PROD_URL)
-					) {
-						this.log('Mesh Endpoint: %s\n', `${meshUrl}/${meshId}/graphql`);
-					} else if (apiKey) {
-						this.log('API Key: %s', apiKey);
+					if (apiKey && MULTITENANT_GRAPHQL_SERVER_BASE_URL.includes(meshUrl)) {
 						this.log('Mesh Endpoint: %s\n', `${meshUrl}/${meshId}/graphql?api_key=${apiKey}`);
+					} else {
+						this.log('Mesh Endpoint: %s\n', `${meshUrl}/${meshId}/graphql`);
 					}
 					return meshDetails;
 				} else {

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

@@ -38,7 +38,7 @@ class GetCommand extends Command {
 		const ignoreCache = await flags.ignoreCache;
 		const json = await flags.json;
 
-		const { imsOrgId, projectId, workspaceId } = await initSdk({
+		const { imsOrgId, projectId, workspaceId, workspaceName } = await initSdk({
 			ignoreCache,
 			verbose: !json,
 		});
@@ -46,7 +46,7 @@ class GetCommand extends Command {
 		let meshId = null;
 
 		try {
-			meshId = await getMeshId(imsOrgId, projectId, workspaceId);
+			meshId = await getMeshId(imsOrgId, projectId, workspaceId, workspaceName);
 		} catch (err) {
 			this.error(
 				`Unable to get mesh ID. Please check the details and try again. RequestId: ${global.requestId}`,
@@ -55,7 +55,7 @@ class GetCommand extends Command {
 
 		if (meshId) {
 			try {
-				const mesh = await getMesh(imsOrgId, projectId, workspaceId, meshId);
+				const mesh = await getMesh(imsOrgId, projectId, workspaceId, workspaceName, meshId);
 
 				if (mesh) {
 					this.log('Successfully retrieved mesh %s', JSON.stringify(mesh, null, 2));

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

@@ -70,6 +70,11 @@ class InitCommand extends Command {
 		await fs.writeFile(filePath, JSON.stringify(pkgJSON, null, 2), 'utf8', { mode: 'w' });
 	}
 
+	async createDotNpmrcFile(templatePath, filePath) {
+		const dotNpmrcFile = await fs.readFile(templatePath, 'utf8');
+		await fs.writeFile(filePath, dotNpmrcFile, 'utf8', { mode: 'w' });
+	}
+
 	async run() {
 		const { args, flags } = await this.parse(InitCommand);
 		const gitFlagOptions = {
@@ -81,6 +86,7 @@ class InitCommand extends Command {
 		let shouldCreateGit = gitFlagOptions[flags.git];
 		let packageManagerChoice = flags.packageManager;
 		const packageJsonTemplate = `${getAppRootDir()}/src/templates/package.json`;
+		const dotNpmrcPath = `${getAppRootDir()}/src/templates/.npmrc`;
 		const shouldCreateWorkspace = await promptConfirm(
 			`Do you want to create the workspace in ${absolutePath}`,
 		);
@@ -144,6 +150,8 @@ class InitCommand extends Command {
 				args.projectName,
 			);
 
+			await this.createDotNpmrcFile(dotNpmrcPath, `${absolutePath}/.npmrc`);
+
 			if (packageManagerChoice === 'npm') {
 				try {
 					await runCliCommand(`npm install`, absolutePath);

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

@@ -0,0 +1,156 @@
+/*
+Copyright 2021 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const { Command } = require('@oclif/core');
+const {
+	portNoFlag,
+	debugFlag,
+	envFileFlag,
+	autoConfirmActionFlag,
+	readFileContents,
+	validateAndInterpolateMesh,
+	checkPlaceholders,
+	getFilesInMeshConfig,
+} = require('../../utils');
+const meshBuilder = require('@adobe-apimesh/mesh-builder');
+const fs = require('fs');
+const UUID = require('../../uuid');
+const path = require('path');
+const { initRequestId, startGraphqlServer, importFiles } = require('../../helpers');
+const logger = require('../../classes/logger');
+require('dotenv').config();
+
+const { validateMesh, buildMesh, compileMesh } = meshBuilder.default;
+
+class RunCommand extends Command {
+	static summary = 'Run local development server';
+	static description = 'Run a local development server that builds and compiles a mesh locally';
+
+	static args = [
+		{
+			name: 'file',
+			description: 'Mesh File',
+		},
+	];
+
+	static flags = {
+		port: portNoFlag,
+		debug: debugFlag,
+		env: envFileFlag,
+		autoConfirmAction: autoConfirmActionFlag,
+	};
+
+	static enableJsonFlag = true;
+
+	static examples = [];
+
+	async run() {
+		await initRequestId();
+
+		logger.info(`RequestId: ${global.requestId}`);
+
+		const { args, flags } = await this.parse(RunCommand);
+
+		if (!args.file) {
+			throw new Error('Missing file path. Run aio api-mesh run --help for more info.');
+		}
+
+		let portNo;
+
+		//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;
+		}
+
+		const envFilePath = await flags.env;
+
+		try {
+			//Ensure that current directory includes package.json
+			if (fs.existsSync(path.join(process.cwd(), 'package.json'))) {
+				//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
+				let meshId = UUID.newUuid().toString();
+
+				await validateMesh(data.meshConfig);
+				await buildMesh(meshId, data.meshConfig);
+				await compileMesh(meshId);
+
+				this.log(`Starting server on port : ${portNo}`);
+				await startGraphqlServer(meshId, portNo, flags.debug);
+			} else {
+				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.',
+				);
+			}
+		} catch (error) {
+			this.error(error.message);
+		}
+	}
+}
+
+module.exports = RunCommand;

package/src/commands/api-mesh/source/__tests__/install.test.js

@@ -39,6 +39,7 @@ initSdk.mockResolvedValue({
 	imsOrgId: selectedOrg.id,
 	projectId: selectedProject.id,
 	workspaceId: selectedWorkspace.id,
+	workspaceName: selectedWorkspace.title,
 });
 initRequestId.mockResolvedValue({});
 promptInput.mockResolvedValueOnce('test-03');
@@ -146,6 +147,7 @@ describe('source:install command tests', () => {
 			selectedOrg.id,
 			selectedProject.id,
 			selectedWorkspace.id,
+			selectedWorkspace.title,
 			'dummy_meshId',
 			res,
 		);

package/src/commands/api-mesh/source/install.js

@@ -36,7 +36,7 @@ class InstallCommand extends Command {
 		await initRequestId();
 		logger.info(`RequestId: ${global.requestId}`);
 		const ignoreCache = await flags.ignoreCache;
-		const { imsOrgId, projectId, workspaceId } = await initSdk({ ignoreCache });
+		const { imsOrgId, projectId, workspaceId, workspaceName } = await initSdk({ ignoreCache });
 		const filepath = flags['variable-file'];
 		let variables = flags.variable
 			? flags.variable.reduce((obj, val) => {
@@ -119,7 +119,7 @@ class InstallCommand extends Command {
 		}
 
 		try {
-			meshId = await getMeshId(imsOrgId, projectId, workspaceId);
+			meshId = await getMeshId(imsOrgId, projectId, workspaceId, workspaceName);
 		} catch (err) {
 			this.error(
 				`Unable to get mesh ID. Please check the details and try again. RequestId: ${global.requestId}`,
@@ -133,7 +133,7 @@ class InstallCommand extends Command {
 		}
 
 		try {
-			const mesh = await getMesh(imsOrgId, projectId, workspaceId, meshId);
+			const mesh = await getMesh(imsOrgId, projectId, workspaceId, meshId, workspaceName);
 
 			if (!mesh) {
 				this.error(
@@ -199,7 +199,7 @@ class InstallCommand extends Command {
 			}
 
 			try {
-				const response = await updateMesh(imsOrgId, projectId, workspaceId, meshId, {
+				const response = await updateMesh(imsOrgId, projectId, workspaceId, workspaceName, meshId, {
 					meshConfig: mesh.meshConfig,
 				});
 

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

@@ -18,14 +18,14 @@ class StatusCommand extends Command {
 		const { flags } = await this.parse(StatusCommand);
 		const ignoreCache = await flags.ignoreCache;
 
-		const { imsOrgId, projectId, workspaceId } = await initSdk({
+		const { imsOrgId, projectId, workspaceId, workspaceName } = await initSdk({
 			ignoreCache,
 		});
 
 		let meshId = null;
 
 		try {
-			meshId = await getMeshId(imsOrgId, projectId, workspaceId);
+			meshId = await getMeshId(imsOrgId, projectId, workspaceId, workspaceName);
 		} catch (err) {
 			this.log(err.message);
 			this.error(
@@ -35,7 +35,7 @@ class StatusCommand extends Command {
 
 		if (meshId) {
 			try {
-				const mesh = await getMesh(imsOrgId, projectId, workspaceId, meshId);
+				const mesh = await getMesh(imsOrgId, projectId, workspaceId, workspaceName, meshId);
 				switch (mesh.meshStatus) {
 					case 'success':
 						this.log(

package/src/constants.js

@@ -19,10 +19,6 @@ const ProdConstants = {
 	AIO_CLI_API_KEY: 'aio-cli-console-auth',
 	SMS_BASE_URL: 'https://graph.adobe.io/api-admin',
 };
-const TMOConstants = {
-	TMO_STAGE_URL: 'https://tigraph-dev.adobe.io/api',
-	TMO_SANDBOX_URL: 'https://tigraph-sandbox.adobe.io/api',
-	TMO_PROD_URL: 'https://tigraph.adobe.io/api',
-};
+
 const envConstants = clientEnv === 'stage' ? StageConstants : ProdConstants;
-module.exports = { ...envConstants, TMOConstants };
+module.exports = { ...envConstants };

package/src/helpers.js

@@ -424,6 +424,7 @@ async function initSdk(options) {
 		imsOrgId: org.id,
 		projectId: project.id,
 		workspaceId: workspace.id,
+		workspaceName: workspace.title,
 	};
 }
 
@@ -521,7 +522,13 @@ async function promptInput(message) {
  * @param meshConfigName MeshConfigName
  * @param autoConfirmActionFlag The user won't be prompted any questions, if this flag is set
  */
-async function importFiles(data, filesListArray, meshConfigName, autoConfirmActionFlag) {
+async function importFiles(
+	data,
+	filesListArray,
+	meshConfigName,
+	autoConfirmActionFlag,
+	shouldMinifyJS = true,
+) {
 	//if autoConfirmActionFlag is passed in the command, it should override by default
 	let shouldOverride = true;
 	let filesNotFound = [];
@@ -557,7 +564,7 @@ async function importFiles(data, filesListArray, meshConfigName, autoConfirmActi
 		} else {
 			//if file does not exist in files array, but exists in filesystem, we append
 			if (fs.existsSync(path.resolve(path.dirname(meshConfigName), file))) {
-				resultData = updateFilesArray(resultData, file, meshConfigName, -1);
+				resultData = updateFilesArray(resultData, file, meshConfigName, -1, shouldMinifyJS);
 			} else {
 				filesNotFound.push(file);
 			}
@@ -587,6 +594,7 @@ async function importFiles(data, filesListArray, meshConfigName, autoConfirmActi
 				overrideArr[i].fileName,
 				meshConfigName,
 				overrideArr[i].index,
+				shouldMinifyJS,
 			);
 		}
 	}
@@ -672,7 +680,7 @@ function runCliCommand(command, workingDirectory = '.') {
  * @param meshConfigName MeshConfig name
  * @param index Append operation if index is -1, else override, it is the index where the override takes place
  */
-function updateFilesArray(data, file, meshConfigName, index) {
+function updateFilesArray(data, file, meshConfigName, index, shouldMinifyJS = true) {
 	try {
 		let readFileData = fs.readFileSync(
 			path.resolve(path.dirname(meshConfigName), file),
@@ -694,8 +702,17 @@ function updateFilesArray(data, file, meshConfigName, index) {
 			throw new Error(`Invalid JSON content in ${path.basename(file)}`);
 		}
 
-		//data to be overridden or appended
-		const dataInFilesArray = jsmin(readFileData);
+		// shouldMinifyJS would be always true for create and update commands
+		// if run command run on debug mode it will be false and js files wont be minified
+		if (shouldMinifyJS) {
+			readFileData = jsmin(readFileData);
+		} else {
+			if (path.extname(file) !== '.js') {
+				readFileData = jsmin(readFileData);
+			}
+		}
+
+		const dataInFilesArray = readFileData;
 
 		if (index >= 0) {
 			data.meshConfig.files[index] = {
@@ -722,6 +739,42 @@ function updateFilesArray(data, file, meshConfigName, index) {
 	}
 }
 
+/**
+ * Start GraphQL server for a particular mesh on a particular port
+ *
+ * @param meshId MeshId of the mesh
+ * @param port Port number at which the server is to be started
+ * @param debug Boolean flag to set the debug mode
+ */
+function startGraphqlServer(meshId, port, debug) {
+	const serverPath = `${__dirname}/server.js ${meshId} ${port}`;
+	const command = debug
+		? `node --inspect-brk --trace-warnings ${serverPath}`
+		: `node ${serverPath}`;
+
+	const server = exec(command);
+
+	server.stdout.on('data', data => {
+		console.log(data);
+	});
+
+	server.stderr.on('data', data => {
+		console.error(data);
+	});
+
+	server.on('close', code => {
+		console.log(`Server closed with code ${code}`);
+	});
+
+	server.on('exit', code => {
+		console.log(`Server exited with code ${code}`);
+	});
+
+	server.on('error', err => {
+		console.error(`Server exited with error ${err}`);
+	});
+}
+
 module.exports = {
 	objToString,
 	promptInput,
@@ -736,4 +789,5 @@ module.exports = {
 	interpolateMesh,
 	runCliCommand,
 	updateFilesArray,
+	startGraphqlServer,
 };

package/src/lib/devConsole.js

@@ -76,11 +76,11 @@ const getApiKeyCredential = async (organizationId, projectId, workspaceId) => {
 	}
 };
 
-const describeMesh = async (organizationId, projectId, workspaceId) => {
+const describeMesh = async (organizationId, projectId, workspaceId, workspaceName) => {
 	logger.info('Initiating Describe Mesh');
 
 	try {
-		const meshId = await getMeshId(organizationId, projectId, workspaceId);
+		const meshId = await getMeshId(organizationId, projectId, workspaceId, workspaceName);
 
 		logger.info('Response from getMeshId %s', meshId);
 
@@ -106,7 +106,7 @@ const describeMesh = async (organizationId, projectId, workspaceId) => {
 	}
 };
 
-const getMesh = async (organizationId, projectId, workspaceId, meshId) => {
+const getMesh = async (organizationId, projectId, workspaceId, workspaceName, meshId) => {
 	const { baseUrl: devConsoleUrl, accessToken, apiKey } = await getDevConsoleConfig();
 	const config = {
 		method: 'get',
@@ -114,6 +114,7 @@ const getMesh = async (organizationId, projectId, workspaceId, meshId) => {
 		headers: {
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
+			'workspaceName': workspaceName,
 		},
 	};
 
@@ -187,7 +188,7 @@ const getMesh = async (organizationId, projectId, workspaceId, meshId) => {
 	}
 };
 
-const createMesh = async (organizationId, projectId, workspaceId, data) => {
+const createMesh = async (organizationId, projectId, workspaceId, workspaceName, data) => {
 	const { baseUrl: devConsoleUrl, accessToken, apiKey } = await getDevConsoleConfig();
 	const config = {
 		method: 'post',
@@ -480,7 +481,7 @@ const deleteMesh = async (organizationId, projectId, workspaceId, meshId) => {
 	}
 };
 
-const getMeshId = async (organizationId, projectId, workspaceId) => {
+const getMeshId = async (organizationId, projectId, workspaceId, workspaceName) => {
 	const { baseUrl: devConsoleUrl, accessToken, apiKey } = await getDevConsoleConfig();
 	logger.info('Initiating Mesh ID request');
 
@@ -490,6 +491,7 @@ const getMeshId = async (organizationId, projectId, workspaceId) => {
 		headers: {
 			'Authorization': `Bearer ${accessToken}`,
 			'x-request-id': global.requestId,
+			'workspaceName': workspaceName,
 		},
 	};