@adobe/aio-cli-plugin-api-mesh 1.0.3-beta → 1.1.0

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

@@ -11,60 +11,80 @@ governing permissions and limitations under the License.
 
 const { Command } = require('@oclif/command');
 const { writeFile } = require('fs/promises');
+
 const logger = require('../../classes/logger');
 const { initSdk, initRequestId } = require('../../helpers');
+const { ignoreCacheFlag } = require('../../utils');
+const { getMeshId, getMesh } = require('../../lib/devConsole');
 
 require('dotenv').config();
 
 class GetCommand extends Command {
-	static args = [{ name: 'meshId' }, { name: 'file' }];
+	static args = [{ name: 'file' }];
+	static flags = {
+		ignoreCache: ignoreCacheFlag,
+	};
 
 	async run() {
 		await initRequestId();
 
 		logger.info(`RequestId: ${global.requestId}`);
 
-		const { args } = this.parse(GetCommand);
+		const { args, flags } = await this.parse(GetCommand);
 
-		if (!args.meshId) {
-			this.error('Missing Mesh ID. Run aio api-mesh get --help for more info.');
+		const ignoreCache = await flags.ignoreCache;
 
-			return;
-		}
+		const { imsOrgId, projectId, workspaceId } = await initSdk({
+			ignoreCache,
+		});
 
-		const { schemaServiceClient, imsOrgId, projectId, workspaceId } = await initSdk();
+		let meshId = null;
 
 		try {
-			const mesh = await schemaServiceClient.getMesh(imsOrgId, projectId, workspaceId, args.meshId);
+			meshId = await getMeshId(imsOrgId, projectId, workspaceId);
+		} catch (err) {
+			this.error(
+				`Unable to get mesh ID. Please check the details and try again. RequestId: ${global.requestId}`,
+			);
+		}
+
+		if (meshId) {
+			try {
+				const mesh = await getMesh(imsOrgId, projectId, workspaceId, meshId);
 
-			if (mesh) {
-				this.log('Successfully retrieved mesh %s', JSON.stringify(mesh, null, 2));
+				if (mesh) {
+					this.log('Successfully retrieved mesh %s', JSON.stringify(mesh, null, 2));
 
-				if (args.file) {
-					try {
-						const { meshConfig } = mesh;
-						await writeFile(args.file, JSON.stringify({ meshConfig }, null, 2));
+					if (args.file) {
+						try {
+							const { meshConfig } = mesh;
+							await writeFile(args.file, JSON.stringify({ meshConfig }, null, 2));
 
-						this.log('Successfully wrote mesh to file %s', args.file);
-					} catch (error) {
-						this.log('Unable to write mesh to file %s', args.file);
+							this.log('Successfully wrote mesh to file %s', args.file);
+						} catch (error) {
+							this.log('Unable to write mesh to file %s', args.file);
 
-						logger.error(error);
+							logger.error(error);
+						}
 					}
+
+					return mesh;
+				} else {
+					this.error(
+						`Unable to get mesh with the ID ${meshId}. Please check the mesh ID and try again. RequestId: ${global.requestId}`,
+						{ exit: false },
+					);
 				}
+			} catch (error) {
+				this.log(error.message);
 
-				return mesh;
-			} else {
 				this.error(
-					`Unable to get mesh with the ID ${args.meshId}. Please check the mesh ID and try again. RequestId: ${global.requestId}`,
-					{ exit: false },
+					`Unable to get mesh. Please check the details and try again. If the error persists please contact support. RequestId: ${global.requestId}`,
 				);
 			}
-		} catch (error) {
-			this.log(error.message);
-
+		} else {
 			this.error(
-				`Unable to get mesh. Please check the details and try again. If the error persists please contact support. RequestId: ${global.requestId}`,
+				`Unable to get mesh config. No mesh found for Org(${imsOrgId}) -> Project(${projectId}) -> Workspace(${workspaceId}). Please check the details and try again.`,
 			);
 		}
 	}

package/src/commands/api-mesh/source/__fixtures__/0.0.1-test-01.json

@@ -0,0 +1,44 @@
+{
+	"name": "Test 01",
+	"version": "0.0.1",
+	"description": "Mock for valid connector",
+	"author": "VZ",
+	"provider": {
+		"name": "Commerce",
+		"handler": {
+			"graphql": {
+				"endpoint": "https://venia.magento.com/graphql/"
+			}
+		},
+		"transforms": [
+			{
+				"rename": {
+					"mode": "bare | wrap",
+					"renames": [
+						{
+							"from": {
+								"type": "Query",
+								"field": "compareList"
+							},
+							"to": {
+								"type": "Query",
+								"field": "productCompareList"
+							}
+						}
+					]
+				}
+			},
+			{
+				"filterSchema": {
+					"mode": "bare | wrap",
+					"filters": [
+						"Query.!category",
+						"Query.!customerOrders",
+						"Query.!urlResolver",
+						"Query.!wishlist"
+					]
+				}
+			}
+		]
+	}
+}

package/src/commands/api-mesh/source/__fixtures__/0.0.1-test-02.json

@@ -0,0 +1,44 @@
+{
+	"name": "Test 02",
+	"version": "0.0.1",
+	"description": "Mock for valid connector",
+	"author": "VZ",
+	"provider": {
+		"name": "Commerce",
+		"handler": {
+			"graphql": {
+				"endpoint": "https://venia.magento.com/graphql/"
+			}
+		},
+		"transforms": [
+			{
+				"rename": {
+					"mode": "bare | wrap",
+					"renames": [
+						{
+							"from": {
+								"type": "Query",
+								"field": "compareList"
+							},
+							"to": {
+								"type": "Query",
+								"field": "productCompareList"
+							}
+						}
+					]
+				}
+			},
+			{
+				"filterSchema": {
+					"mode": "bare | wrap",
+					"filters": [
+						"Query.!category",
+						"Query.!customerOrders",
+						"Query.!urlResolver",
+						"Query.!wishlist"
+					]
+				}
+			}
+		]
+	}
+}

package/src/commands/api-mesh/source/__fixtures__/connectors-metadata.json

@@ -0,0 +1,16 @@
+{
+	"test-01": {
+		"name": "test-01",
+		"description": "Mock for valid connector",
+		"author": "VZ",
+		"latest": "0.0.2",
+		"versions": ["0.0.1", "0.0.2"]
+	},
+	"test-02": {
+		"name": "test-02",
+		"description": "Mock for valid connector",
+		"author": "VZ",
+		"latest": "0.0.1",
+		"versions": ["0.0.1"]
+	}
+}

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

@@ -0,0 +1,58 @@
+/*
+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 mockMetadataFixture = require('../__fixtures__/connectors-metadata.json');
+const mockAdapter = require('source-registry-storage-adapter');
+const { promptConfirm } = require('../../../../helpers');
+const GetCommand = require('../get');
+const { CliUx } = require('@oclif/core');
+const DiscoverCommand = require('../discover');
+jest.mock('source-registry-storage-adapter');
+jest.mock('../../../../helpers');
+jest.mock('../get');
+jest.mock('@oclif/core', () => ({
+	...jest.requireActual('@oclif/core'),
+	CliUx: {
+		Table: {
+			table: jest.fn().mockImplementation(data => data),
+		},
+	},
+}));
+
+mockAdapter.mockImplementation(() => ({
+	getList: jest.fn().mockImplementation(() => mockMetadataFixture),
+}));
+
+describe('source:discover command tests', () => {
+	test('Snapshot create command description', () => {
+		expect(DiscoverCommand.description).toMatchInlineSnapshot(
+			`"Return the list of avaliable sources"`,
+		);
+		expect(DiscoverCommand.aliases).toMatchInlineSnapshot(`Array []`);
+	});
+	test('Check table render is executed', async () => {
+		await DiscoverCommand.run([]);
+		expect(CliUx.Table.table).toHaveBeenCalledTimes(1);
+	});
+	test('Check that "source:get -m" command is called', async () => {
+		GetCommand.run = jest.fn().mockImplementation(() => 'source:get -m');
+		promptConfirm.mockResolvedValue(true);
+		await DiscoverCommand.run([]);
+		expect(GetCommand.run).toHaveBeenCalledTimes(1);
+	});
+	test('Check that "source:get -m" command is not called', async () => {
+		GetCommand.run = jest.fn().mockImplementation(() => 'source:get -m');
+		promptConfirm.mockResolvedValue(false);
+		await DiscoverCommand.run([]);
+		expect(GetCommand.run).toHaveBeenCalledTimes(0);
+	});
+});

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

@@ -0,0 +1,123 @@
+/*
+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 mockMetadataFixture = require('../__fixtures__/connectors-metadata.json');
+const mockSourceTest01v1Fixture = require('../__fixtures__/0.0.1-test-01.json');
+const mockSourceTest02v1Fixture = require('../__fixtures__/0.0.1-test-02.json');
+const mockAdapter = require('source-registry-storage-adapter');
+const chalk = require('chalk');
+const ncp = require('node-clipboardy');
+const { promptMultiselect, promptSelect, promptConfirm } = require('../../../../helpers');
+const mockSources = {
+	'0.0.1-test-01': mockSourceTest01v1Fixture,
+	'0.0.1-test-02': mockSourceTest02v1Fixture,
+};
+jest.mock('source-registry-storage-adapter');
+jest.mock('../../../../helpers');
+const GetCommand = require('../get');
+const logSpy = jest.spyOn(GetCommand.prototype, 'log');
+const expectedResultForSuccessScenarios = JSON.stringify(
+	[mockSourceTest01v1Fixture.provider, mockSourceTest02v1Fixture.provider],
+	null,
+	4,
+);
+mockAdapter.mockImplementation(() => ({
+	get: jest
+		.fn()
+		.mockResolvedValueOnce(mockSources[`0.0.1-test-01`])
+		.mockResolvedValueOnce(mockSources[`0.0.1-test-02`]),
+	getList: jest.fn().mockImplementation(() => mockMetadataFixture),
+}));
+promptMultiselect.mockResolvedValue(Object.values(mockMetadataFixture));
+promptConfirm.mockResolvedValue(true);
+promptSelect
+	.mockResolvedValueOnce(
+		`${mockMetadataFixture['test-01'].name}@${mockMetadataFixture['test-01'].latest}`,
+	)
+	.mockResolvedValueOnce(
+		`${mockMetadataFixture['test-02'].name}@${mockMetadataFixture['test-02'].latest}`,
+	);
+
+describe('source:get command tests', () => {
+	test('Snapshot create command description', () => {
+		expect(GetCommand.description).toMatchInlineSnapshot(
+			`"Command returns the content of a specific source."`,
+		);
+		expect(GetCommand.flags).toMatchInlineSnapshot(`
+		Object {
+		  "multiple": Object {
+		    "allowNo": false,
+		    "char": "m",
+		    "description": "Select multiple sources",
+		    "exclusive": Array [
+		      "name",
+		    ],
+		    "parse": [Function],
+		    "type": "boolean",
+		  },
+		  "source": Object {
+		    "char": "s",
+		    "description": "Source name",
+		    "input": Array [],
+		    "multiple": true,
+		    "parse": [Function],
+		    "type": "option",
+		  },
+		}
+	`);
+		expect(GetCommand.aliases).toMatchInlineSnapshot(`Array []`);
+	});
+	test('Check executing without parameters', async () => {
+		await GetCommand.run([]).catch(err => {
+			expect(err.message).toEqual(`The "aio api-mesh:source:get" command requires additional parameters` +
+				`\nUse "aio api-mesh:source:get --help" to see parameters information.`)
+		});
+	});
+	test('Check executing success with multiple, copied to clipboard and logged to console', async () => {
+		await GetCommand.run(['-m']);
+		expect(ncp.readSync()).toEqual(expectedResultForSuccessScenarios);
+		expect(logSpy.mock.calls.pop()[0]).toEqual(expectedResultForSuccessScenarios);
+	});
+	test('Check executing success with provided name and version, copied to clipboard and logged to console', async () => {
+		await GetCommand.run(['-s=test-01@0.0.1', '-s=test-02@0.0.1']);
+		expect(ncp.readSync()).toEqual(expectedResultForSuccessScenarios);
+		expect(logSpy.mock.calls.pop()[0]).toEqual(expectedResultForSuccessScenarios);
+	});
+	test('Check executing success with provided name and without version, copied to clipboard and logged to console', async () => {
+		await GetCommand.run(['-s=test-01', '-s=test-02']);
+		expect(ncp.readSync()).toEqual(expectedResultForSuccessScenarios);
+		expect(logSpy.mock.calls.pop()[0]).toEqual(expectedResultForSuccessScenarios);
+	});
+	test('Check executing failed due to requested source does not exist', async () => {
+		const name = 'test-99';
+		await GetCommand.run([`-s=${name}`]).catch(err => {
+			expect(err.message).toEqual(
+				chalk.red(
+					`The source with the name "${name}" doesn't exist.` +
+					`\nUse "aio api-mesh:source:discover" command to see avaliable sources.`,
+				),
+			);
+		});
+	});
+	test('Check executing failed due to requested version does not exist', async () => {
+		const name = 'test-01';
+		const version = '1.1.1';
+		await GetCommand.run([`-s=${name}@${version}`]).catch(err => {
+			expect(err.message).toEqual(
+				chalk.red(
+					`The version "${version}" for source name "${name}" doesn't exist.` +
+					`\nUse "aio api-mesh:source:discover" command to see avaliable source versions.`,
+				),
+			);
+		});
+	});
+});

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

@@ -0,0 +1,70 @@
+/*
+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, CliUx } = require('@oclif/core');
+const { promptConfirm, initRequestId } = require('../../../helpers');
+const GetCommand = require('./get');
+const SourceRegistryStorage = require('source-registry-storage-adapter');
+const config = require('@adobe/aio-lib-core-config');
+const logger = require('../../../classes/logger');
+
+
+class DiscoverCommand extends Command {
+	async run() {
+		try {
+			await initRequestId();
+
+			logger.info(`RequestId: ${global.requestId}`);
+			const srs = new SourceRegistryStorage(config.get('api-mesh.sourceRegistry.path'));
+			let list;
+			try {
+				list = await srs.getList();
+			} catch (error) {
+				logger.error(error);
+				this.error(`Cannot get the list of sources: ${error}`);
+			}
+
+			this.generateSourcesTable(list);
+			const needInstall = await promptConfirm(`Are you want to install sources?`);
+			if (needInstall) {
+				GetCommand.run(['-m']);
+			}
+		} catch (error) {
+			logger.error(error);
+			this.error(`
+				Something went wrong with "discover" command. Please try again later. 
+				${error}
+			`);
+		}
+	}
+
+	async generateSourcesTable(data) {
+		const columns = {
+			name: {
+				get: row => `${row.name}`,
+			},
+			current: {
+				get: row => `${row.latest}`,
+			},
+			description: {
+				get: row => `${row.description}`,
+			},
+			versions: {
+				get: row => row.versions.reduce((prev, next) => `${prev}, ${next}`),
+			},
+		};
+		CliUx.Table.table(Object.values(data), columns);
+	}
+}
+
+DiscoverCommand.description = 'Return the list of avaliable sources';
+
+module.exports = DiscoverCommand;

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

@@ -0,0 +1,138 @@
+/*
+Copyright 2020 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, Flags } = require('@oclif/core');
+const SourceRegistryStorage = require('source-registry-storage-adapter');
+const { promptMultiselect, promptSelect, promptConfirm, initRequestId } = require('../../../helpers');
+const ncp = require('node-clipboardy');
+const chalk = require('chalk');
+const config = require('@adobe/aio-lib-core-config');
+const logger = require('../../../classes/logger');
+
+class GetCommand extends Command {
+	constructor() {
+		super(...arguments);
+		this.sourceRegistryStorage = new SourceRegistryStorage(
+			config.get('api-mesh.sourceRegistry.path'),
+		);
+	}
+
+	async run() {
+		try {
+			await initRequestId();
+
+			logger.info(`RequestId: ${global.requestId}`);
+			let list
+			try {
+				list = await this.sourceRegistryStorage.getList();
+			} catch (err) {
+				this.log(err)
+				this.error(`Cannot get the list of sources: ${err}`)
+			}
+			const { flags } = await this.parse(GetCommand);
+			if (!flags.source && !flags.multiple) {
+				this.error(
+					`The "aio api-mesh:source:get" command requires additional parameters` +
+					`\nUse "aio api-mesh:source:get --help" to see parameters information.`,
+				);
+			}
+			const sources = flags.multiple ? await this.handleMultiple(list) : flags.source;
+			const sourceConfigs = [];
+			for (const source of sources) {
+				let [name, version] = source.split('@');
+				const normalizedName = this.normalizeName(name);
+				if (!list[normalizedName]) {
+					this.error(
+						chalk.red(
+							`The source with the name "${name}" doesn't exist.` +
+							`\nUse "aio api-mesh:source:discover" command to see avaliable sources.`,
+						),
+					);
+				}
+				version = version || list[normalizedName].latest;
+				if (!list[normalizedName].versions.includes(version)) {
+					this.error(
+						chalk.red(
+							`The version "${version}" for source name "${name}" doesn't exist.` +
+							`\nUse "aio api-mesh:source:discover" command to see avaliable source versions.`,
+						),
+					);
+				}
+				const sourceConfig = await this.sourceRegistryStorage.get(name, version);
+				sourceConfigs.push(sourceConfig.provider);
+			}
+			const sourceConfigsString = JSON.stringify(sourceConfigs, null, 4);
+			await ncp.writeSync(sourceConfigsString);
+			this.log(
+				chalk.green.bold.underline(
+					'The sources are copied to the clipboard, please paste them to your API Mesh configuration',
+				),
+			);
+			const print = await promptConfirm(`Do you want to print Source configurations in console?`);
+			if (print) {
+				this.log(sourceConfigsString);
+			}
+		} catch (error) {
+			logger.error(error);
+			this.error(`
+				Something went wrong with "get" command. Please try again later. 
+				${error}
+			`);
+		}
+	}
+
+	async handleMultiple(data) {
+		const result = [];
+		const selectedList = await promptMultiselect(
+			'Select sources to install',
+			Object.values(data).map(elem => ({ name: elem.name, value: elem })),
+		);
+		for (const selected of selectedList) {
+			if (selected.versions.length > 1) {
+				const version = await promptSelect(
+					`Please choose the version of "${selected.name}" source`,
+					selected.versions.map(v => ({ name: `v${v}`, value: `${selected.name}@${v}` })),
+				);
+				result.push(version);
+			} else {
+				result.push(`${selected.name}@${selected.latest}`);
+			}
+		}
+		return result;
+	}
+
+	normalizeName(name) {
+		return name.toLowerCase().split(' ').join('-');
+	}
+}
+
+GetCommand.flags = {
+	source: Flags.string({
+		char: 's',
+		description: 'Source name',
+		multiple: true,
+	}),
+	multiple: Flags.boolean({
+		char: 'm',
+		description: 'Select multiple sources',
+		exclusive: ['name'],
+	}),
+};
+
+GetCommand.description = 'Command returns the content of a specific source.';
+GetCommand.examples = [
+	'$ aio api-mesh:source:get <version>@<source_name>',
+	'$ aio api-mesh:source:get <source_name>',
+	'$ aio api-mesh:source:get -m',
+];
+
+module.exports = GetCommand;