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

package/src/classes/SchemaServiceClient.js

@@ -9,7 +9,9 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-const axios = require('axios')
+const axios = require('axios');
+const logger = require('../classes/logger');
+const { objToString } = require('../utils');
 
 /**
  * This class provides methods to call Schema Management Service APIs.
@@ -17,78 +19,398 @@ const axios = require('axios')
  * with valid values for baseUrl, apiKey and accessToken
  */
 class SchemaServiceClient {
-  init (baseUrl, accessToken, apiKey) {
-    this.schemaManagementServiceUrl = baseUrl
-    this.accessToken = accessToken
-    this.apiKey = apiKey
-  }
-
-  async getTenant (tenantId, organizationCode) {
-    console.log(`OrgCode - getTenant: ${organizationCode}`)
-    const config = {
-      method: 'get',
-      url: `${this.schemaManagementServiceUrl}/api-admin/organizations/${organizationCode}/tenants/${tenantId}?api_key=${this.apiKey}`,
-      headers: {
-        Authorization: `Bearer ${this.accessToken}`
-      }
-    }
-    try {
-      const response = await axios(config)
-      console.log(`Config : ${config}`)
-      return response && response.data &&
-      response.status === 200
-        ? response.data
-        : null
-    } catch (error) {
-      throw new Error(JSON.stringify(error.response.data))
-    }
-  }
-
-  async createTenant (data) {
-    const organizationCode = data.imsOrgId
-    console.log(`OrgCode - createTenant: ${organizationCode}`)
-    const config = {
-      method: 'post',
-      url: `${this.schemaManagementServiceUrl}/api-admin/organizations/${organizationCode}/tenants?api_key=${this.apiKey}`,
-      headers: {
-        Authorization: `Bearer ${this.accessToken}`,
-        'Content-Type': 'application/json'
-      },
-      data: JSON.stringify(data)
-    }
-    try {
-      console.log('here')
-      const response = await axios(config)
-      return response && response.status === 201
-        ? response
-        : null
-    } catch (error) {
-      throw new Error(JSON.stringify(error.response.data))
-    }
-  }
-
-  async updateTenant (tenantId, data) {
-    const organizationCode = data.imsOrgId
-    console.log(`OrgCode - updateTenant: ${organizationCode}`)
-    const config = {
-      method: 'put',
-      url: `${this.schemaManagementServiceUrl}/api-admin/organizations/${organizationCode}/tenants/${tenantId}?api_key=${this.apiKey}`,
-      headers: {
-        Authorization: `Bearer ${this.accessToken}`,
-        'Content-Type': 'application/json'
-      },
-      data: JSON.stringify(data)
-    }
-    try {
-      const response = await axios(config)
-      console.log(response.status)
-      return response && response.status === 204
-        ? response
-        : null
-    } catch (error) {
-      throw new Error(JSON.stringify(error.response.data))
-    }
-  }
+	init(baseUrl, accessToken, apiKey) {
+		this.devConsoleUrl = baseUrl;
+		this.accessToken = accessToken;
+		this.apiKey = apiKey;
+	}
+
+	async describeMesh(organizationId, projectId, workspaceId) {
+		const config = {
+			method: 'get',
+			url: `${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/describe?API_KEY=${this.apiKey}`,
+			headers: {
+				'Authorization': `Bearer ${this.accessToken}`,
+				'x-request-id': global.requestId,
+			},
+		};
+
+		logger.info(
+			'Initiating GET %s',
+			`${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/describe?API_KEY=${this.apiKey}`,
+		);
+
+		try {
+			const response = await axios(config);
+
+			logger.info('Response from GET %s', response.status);
+
+			if (response && response.status === 200) {
+				logger.info(`Mesh Config : ${objToString(response, ['data'])}`);
+
+				return response.data;
+			} else {
+				// Non 200 response received
+				logger.error(
+					`Something went wrong: ${objToString(
+						response,
+						['data'],
+						'Unable to get mesh',
+					)}. Received ${response.status} response instead of 200`,
+				);
+
+				throw new Error(
+					`Something went wrong: ${objToString(response, ['data'], 'Unable to get mesh')}`,
+				);
+			}
+		} catch (error) {
+			if (error.response.status === 400) {
+				// The request was made and the server responded with a 400 status code
+				logger.error('Mesh not found');
+
+				return null;
+			} else {
+				// The request was made and the server responded with a different status code
+				logger.error('Error while describing mesh');
+			}
+		}
+	}
+
+	async getMesh(organizationId, projectId, workspaceId, meshId) {
+		const config = {
+			method: 'get',
+			url: `${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}?API_KEY=${this.apiKey}`,
+			headers: {
+				'Authorization': `Bearer ${this.accessToken}`,
+				'x-request-id': global.requestId,
+			},
+		};
+
+		logger.info(
+			'Initiating GET %s',
+			`${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}?API_KEY=${this.apiKey}`,
+		);
+
+		try {
+			const response = await axios(config);
+
+			logger.info('Response from GET %s', response.status);
+
+			if (response && response.status === 200) {
+				logger.info(`Mesh Config : ${objToString(response, ['data'])}`);
+
+				return response.data;
+			} else {
+				// Non 200 response received
+				logger.error(
+					`Something went wrong: ${objToString(
+						response,
+						['data'],
+						'Unable to get mesh',
+					)}. Received ${response.status} response instead of 200`,
+				);
+
+				throw new Error(
+					`Something went wrong: ${objToString(response, ['data'], 'Unable to get mesh')}`,
+				);
+			}
+		} catch (error) {
+			logger.info('Response from GET %s', error.response.status);
+
+			if (error.response.status === 404) {
+				// The request was made and the server responded with a 404 status code
+				logger.error('Mesh not found');
+
+				return null;
+			} else if (error.response && error.response.data) {
+				// The request was made and the server responded with an unsupported status code
+				logger.error(
+					'Error while getting mesh. Response: %s',
+					objToString(error, ['response', 'data'], 'Unable to get mesh'),
+				);
+
+				if (error.response.data.messages) {
+					const message = objToString(
+						error,
+						['response', 'data', 'messages', '0', 'message'],
+						'Unable to get mesh',
+					);
+
+					throw new Error(message);
+				} else if (error.response.data.message) {
+					const message = objToString(error, ['response', 'data', 'message'], 'Unable to get mesh');
+
+					throw new Error(message);
+				} else {
+					const message = objToString(error, ['response', 'data'], 'Unable to get mesh');
+
+					throw new Error(message);
+				}
+			} else {
+				// The request was made but no response was received
+				logger.error(
+					'Error while getting mesh. No response received from the server: %s',
+					objToString(error, [], 'Unable to get mesh'),
+				);
+
+				throw new Error('Unable to get mesh from Schema Management Service: %s', error.message);
+			}
+		}
+	}
+
+	async createMesh(organizationId, projectId, workspaceId, data) {
+		const config = {
+			method: 'post',
+			url: `${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes?API_KEY=${this.apiKey}`,
+			headers: {
+				'Authorization': `Bearer ${this.accessToken}`,
+				'Content-Type': 'application/json',
+				'x-request-id': global.requestId,
+			},
+			data: JSON.stringify(data),
+		};
+
+		logger.info(
+			'Initiating POST %s',
+			`${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes?API_KEY=${this.apiKey}`,
+		);
+
+		try {
+			const response = await axios(config);
+
+			logger.info('Response from POST %s', response.status);
+
+			if (response && response.status === 201) {
+				logger.info(`Mesh Config : ${objToString(response, ['data'])}`);
+
+				return response.data;
+			} else {
+				// Non 201 response received
+				logger.error(
+					`Something went wrong: ${objToString(
+						response,
+						['data'],
+						'Unable to create mesh',
+					)}. Received ${response.status} response instead of 201`,
+				);
+
+				throw new Error(response.data.message);
+			}
+		} catch (error) {
+			if (error.response.status === 409) {
+				// The request was made and the server responded with a 409 status code
+				logger.error('Error while creating mesh: %j', error.response.data);
+
+				throw new Error('Selected org, project and workspace already has a mesh');
+			} else if (error.response && error.response.data) {
+				// The request was made and the server responded with an unsupported status code
+				logger.error(
+					'Error while creating mesh. Response: %s',
+					objToString(error, ['response', 'data'], 'Unable to create mesh'),
+				);
+
+				if (error.response.data.messages) {
+					const message = objToString(
+						error,
+						['response', 'data', 'messages'],
+						'Unable to create mesh',
+					);
+
+					throw new Error(message);
+				} else if (error.response.data.message) {
+					const message = objToString(
+						error,
+						['response', 'data', 'message'],
+						'Unable to create mesh',
+					);
+
+					throw new Error(message);
+				} else {
+					const message = objToString(error, ['response', 'data'], 'Unable to create mesh');
+
+					throw new Error(message);
+				}
+			} else {
+				// The request was made but no response was received
+				logger.error(
+					'Error while creating mesh. No response received from the server: %s',
+					objToString(error, [], 'Unable to create mesh'),
+				);
+
+				throw new Error('Unable to create mesh in Schema Management Service: %s', error.message);
+			}
+		}
+	}
+
+	async updateMesh(organizationId, projectId, workspaceId, meshId, data) {
+		const config = {
+			method: 'put',
+			url: `${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}?API_KEY=${this.apiKey}`,
+			headers: {
+				'Authorization': `Bearer ${this.accessToken}`,
+				'Content-Type': 'application/json',
+				'x-request-id': global.requestId,
+			},
+			data: JSON.stringify(data),
+		};
+
+		logger.info(
+			'Initiating PUT %s',
+			`${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}?API_KEY=${this.apiKey}`,
+		);
+
+		try {
+			const response = await axios(config);
+
+			logger.info('Response from POST %s', response.status);
+
+			if (response && response.status === 204) {
+				return response.data;
+			} else {
+				// Non 204 response received
+				logger.error(
+					`Something went wrong: ${objToString(
+						response,
+						['data'],
+						'Unable to update mesh',
+					)}. Received ${response.status} response instead of 204`,
+				);
+
+				throw new Error(
+					`Something went wrong: ${objToString(response, ['data'], 'Unable to update mesh')}`,
+				);
+			}
+		} catch (error) {
+			logger.info('Response from PUT %s', error.response.status);
+
+			if (error.response.status === 404) {
+				// The request was made and the server responded with a 404 status code
+				logger.error('Mesh not found');
+
+				throw new Error('Mesh 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 updating mesh. Response: %s',
+					objToString(error, ['response', 'data'], 'Unable to update mesh'),
+				);
+
+				if (error.response.data.messages) {
+					const message = objToString(
+						error,
+						['response', 'data', 'messages', '0', 'message'],
+						'Unable to update mesh',
+					);
+
+					throw new Error(message);
+				} else if (error.response.data.message) {
+					const message = objToString(
+						error,
+						['response', 'data', 'message'],
+						'Unable to update mesh',
+					);
+
+					throw new Error(message);
+				} else {
+					const message = objToString(error, ['response', 'data'], 'Unable to update mesh');
+
+					throw new Error(message);
+				}
+			} else {
+				// The request was made but no response was received
+				logger.error(
+					'Error while updating mesh. No response received from the server: %s',
+					objToString(error, [], 'Unable to update mesh'),
+				);
+
+				throw new Error('Unable to update mesh from Schema Management Service: %s', error.message);
+			}
+		}
+	}
+
+	async deleteMesh(organizationId, projectId, workspaceId, meshId) {
+		const config = {
+			method: 'delete',
+			url: `${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}?API_KEY=${this.apiKey}`,
+			headers: {
+				'Authorization': `Bearer ${this.accessToken}`,
+				'x-request-id': global.requestId,
+			},
+		};
+
+		logger.info(
+			'Initiating DELETE %s',
+			`${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/${meshId}?API_KEY=${this.apiKey}`,
+		);
+
+		try {
+			const response = await axios(config);
+
+			logger.info('Response from DELETE %s', response.status);
+
+			if (response && response.status === 204) {
+				return response;
+			} else {
+				// Non 204 response received
+				logger.error(
+					`Something went wrong: ${objToString(
+						response,
+						['data'],
+						'Unable to delete mesh',
+					)}. Received ${response.status} response instead of 204`,
+				);
+
+				throw new Error(
+					`Something went wrong: ${objToString(response, ['data'], 'Unable to delete mesh')}`,
+				);
+			}
+		} 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('Mesh not found');
+
+				throw new Error('Mesh 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 mesh. Response: %s',
+					objToString(error, ['response', 'data'], 'Unable to delete mesh'),
+				);
+
+				if (error.response.data.messages) {
+					const message = objToString(
+						error,
+						['response', 'data', 'messages', '0', 'message'],
+						'Unable to delete mesh',
+					);
+
+					throw new Error(message);
+				} else if (error.response.data.message) {
+					const message = objToString(
+						error,
+						['response', 'data', 'message'],
+						'Unable to delete mesh',
+					);
+
+					throw new Error(message);
+				} else {
+					const message = objToString(error, ['response', 'data'], 'Unable to delete mesh');
+
+					throw new Error(message);
+				}
+			} else {
+				// The request was made but no response was received
+				logger.error(
+					'Error while deleting mesh. No response received from the server: %s',
+					objToString(error, [], 'Unable to delete mesh'),
+				);
+
+				throw new Error('Unable to delete mesh from Schema Management Service: %s', error.message);
+			}
+		}
+	}
 }
 
-module.exports = { SchemaServiceClient }
+module.exports = { SchemaServiceClient };

package/src/classes/UUID.js

@@ -0,0 +1,20 @@
+const { v4: uuidv4 } = require('uuid');
+// Class representing a new unique UUID which is used for request-id tracing
+class UUID {
+	constructor(uuid = '') {
+		this.uuid = uuid;
+	}
+
+	toString() {
+		return this.uuid;
+	}
+
+	static newUuid() {
+		const newUUID = uuidv4();
+		return new UUID(newUUID);
+	}
+}
+
+module.exports = {
+	UUID,
+};

package/src/classes/logger.js

@@ -0,0 +1,19 @@
+const { default: pino } = require('pino');
+
+const logger = pino({
+	level: process.env.LOG_LEVEL || 'info',
+	enabled: process.env.ENABLE_LOGGER === 'true',
+	mixin() {
+		return {
+			requestId: global.requestId,
+		};
+	},
+	transport: {
+		target: 'pino-pretty',
+		options: {
+			colorize: true,
+		},
+	},
+});
+
+module.exports = logger;

package/src/commands/PLUGINNAME/__tests__/index.test.js

@@ -0,0 +1,30 @@
+/*
+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 IndexCommand = require('..');
+
+test('exports', async () => {
+	expect(typeof IndexCommand).toEqual('function');
+});
+
+describe('command tests', () => {
+	let command;
+
+	beforeEach(() => {
+		command = new IndexCommand([]);
+	});
+
+	test('run', async () => {
+		command.argv = [];
+		await expect(command.run()).resolves.not.toThrowError();
+	});
+});

package/src/commands/PLUGINNAME/index.js

@@ -10,25 +10,23 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-const { Command, flags } = require('@oclif/command')
-const aioLogger = require('@adobe/aio-lib-core-logging')('PLUGINNAME', { provider: 'debug' })
+const { Command, flags } = require('@oclif/command');
+const aioLogger = require('@adobe/aio-lib-core-logging')('PLUGINNAME', { provider: 'debug' });
 
 class IndexCommand extends Command {
-  async run () {
-    // const { args, flags } = this.parse(IndexCommand)
-    aioLogger.debug('this is the index command.')
-  }
+	async run() {
+		// const { args, flags } = this.parse(IndexCommand)
+		aioLogger.debug('this is the index command.');
+	}
 }
 
 IndexCommand.flags = {
-  someflag: flags.string({ char: 'f', description: 'this is some flag' })
-}
+	someflag: flags.string({ char: 'f', description: 'this is some flag' }),
+};
 
 // this is set in package.json, see https://github.com/oclif/oclif/issues/120
 // if not set it will get the first (alphabetical) topic's help description
-IndexCommand.description = 'Your description here'
-IndexCommand.examples = [
-  '$ aio PLUGINNAME:some_command'
-]
+IndexCommand.description = 'Your description here';
+IndexCommand.examples = ['$ aio PLUGINNAME:some_command'];
 
-module.exports = IndexCommand
+module.exports = IndexCommand;

package/src/commands/__fixtures__/sample_mesh.json

@@ -0,0 +1,14 @@
+{
+	"meshConfig": {
+		"sources": [
+			{
+				"name": "<api_name>",
+				"handler": {
+					"graphql": {
+						"endpoint": "<gql_endpoint>"
+					}
+				}
+			}
+		]
+	}
+}

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

@@ -0,0 +1,75 @@
+/*
+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 mockConsoleCLIInstance = {};
+
+jest.mock('@adobe/aio-lib-env');
+jest.mock('@adobe/aio-cli-lib-console');
+
+const orgs = [{ id: '1234', code: 'CODE1234@AdobeOrg', name: 'ORG01', type: 'entp' }];
+const selectedOrg = { id: '1234', code: 'CODE1234@AdobeOrg', name: 'ORG01', type: 'entp' };
+
+const projects = [{ id: '5678', title: 'Project01' }];
+const selectedProject = { id: '5678', title: 'Project01' };
+
+const workspaces = [{ id: '123456789', title: 'Workspace01' }];
+const selectedWorkspace = { id: '123456789', title: 'Workspace01' };
+
+function setDefaultMockConsoleCLI() {
+	mockConsoleCLIInstance.getToken = jest.fn().mockReturnValue('test_token');
+	mockConsoleCLIInstance.getCliEnv = jest.fn().mockReturnValue('prod');
+
+	mockConsoleCLIInstance.getOrganizations = jest.fn().mockResolvedValue(orgs);
+	mockConsoleCLIInstance.promptForSelectOrganization = jest.fn().mockResolvedValue(selectedOrg);
+
+	mockConsoleCLIInstance.getProjects = jest.fn().mockResolvedValue(projects);
+	mockConsoleCLIInstance.promptForSelectProject = jest.fn().mockResolvedValue(selectedProject);
+
+	mockConsoleCLIInstance.getWorkspaces = jest.fn().mockResolvedValue(workspaces);
+	mockConsoleCLIInstance.promptForSelectWorkspace = jest.fn().mockResolvedValue(selectedWorkspace);
+}
+jest.mock('@adobe/aio-cli-lib-console', () => ({
+	init: jest.fn().mockResolvedValue(mockConsoleCLIInstance),
+	cleanStdOut: jest.fn(),
+}));
+jest.mock('@adobe/aio-lib-ims');
+const CreateCommand = require('../create');
+const { SchemaServiceClient } = require('../../../classes/SchemaServiceClient');
+const mockCreateMesh = require('../../__fixtures__/sample_mesh.json');
+
+describe('create command tests', () => {
+	beforeEach(() => {
+		setDefaultMockConsoleCLI();
+		const response = mockCreateMesh;
+		jest.spyOn(SchemaServiceClient.prototype, 'createMesh').mockImplementation(data => response);
+	});
+
+	afterEach(() => {
+		jest.restoreAllMocks();
+	});
+
+	test('should fail mesh id is missing', async () => {
+		expect.assertions(2);
+		const runResult = CreateCommand.run([]);
+		await expect(runResult instanceof Promise).toBeTruthy();
+		await expect(runResult).rejects.toEqual(
+			new Error('Missing file path. Run aio api-mesh create --help for more info.'),
+		);
+	});
+
+	test('create-mesh-with-configuration', async () => {
+		expect.assertions(2);
+		const runResult = CreateCommand.run(['src/commands/__fixtures__/sample_mesh.json']);
+		await expect(runResult instanceof Promise).toBeTruthy();
+		await expect(runResult).resolves.toEqual(mockCreateMesh);
+	});
+});