@adobe/aio-cli-plugin-api-mesh 1.0.1-beta → 1.0.2-beta

package/README.md

@@ -24,7 +24,7 @@ $ aio discover -i
 Install project dependencies. `npm install`
 
 ```
-aio plugins:link commerce-gateway/tenant
+aio plugins:link api-mesh
 ```
 
 ### Configuration

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.0.1-beta","commands":{"PLUGINNAME":{"id":"PLUGINNAME","description":"Your description here","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"examples":["$ aio PLUGINNAME:some_command"],"flags":{"someflag":{"name":"someflag","type":"option","char":"f","description":"this is some flag"}},"args":[]},"api-mesh:create":{"id":"api-mesh:create","description":"Create a mesh with the given config.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"file"}]},"api-mesh:delete":{"id":"api-mesh:delete","description":"Delete the config of a given mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"meshId"}]},"api-mesh:get":{"id":"api-mesh:get","description":"Get the config of a given mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"meshId"},{"name":"file"}]},"api-mesh:update":{"id":"api-mesh:update","description":"Update a mesh with the given config.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"meshId"},{"name":"file"}]}}}
+{"version":"1.0.2-beta","commands":{"PLUGINNAME":{"id":"PLUGINNAME","description":"Your description here","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"examples":["$ aio PLUGINNAME:some_command"],"flags":{"someflag":{"name":"someflag","type":"option","char":"f","description":"this is some flag"}},"args":[]},"api-mesh:create":{"id":"api-mesh:create","description":"Create a mesh with the given config.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"file"}]},"api-mesh:delete":{"id":"api-mesh:delete","description":"Delete the config of a given mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"meshId"}]},"api-mesh:get":{"id":"api-mesh:get","description":"Get the config of a given mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"meshId"},{"name":"file"}]},"api-mesh:update":{"id":"api-mesh:update","description":"Update a mesh with the given config.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"meshId"},{"name":"file"}]}}}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@adobe/aio-cli-plugin-api-mesh",
-	"version": "1.0.1-beta",
+	"version": "1.0.2-beta",
 	"publishConfig": {
 		"access": "public"
 	},
@@ -15,6 +15,7 @@
 		"@oclif/errors": "^1.1.2",
 		"axios": "^0.23.0",
 		"dotenv": "^16.0.1",
+		"inquirer": "^8.2.4",
 		"pino": "^7.9.2",
 		"pino-pretty": "^7.6.0",
 		"uuid": "^8.3.2"

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

@@ -13,6 +13,8 @@ governing permissions and limitations under the License.
 jest.mock('@adobe/aio-lib-env');
 jest.mock('@adobe/aio-cli-lib-console');
 
+const inquirer = require('inquirer');
+
 const mockConsoleCLIInstance = {};
 
 const orgs = [{ id: '1234', code: 'CODE1234@AdobeOrg', name: 'ORG01', type: 'entp' }];
@@ -42,8 +44,17 @@ jest.mock('@adobe/aio-cli-lib-console', () => ({
 	init: jest.fn().mockResolvedValue(mockConsoleCLIInstance),
 	cleanStdOut: jest.fn(),
 }));
+
 jest.mock('@adobe/aio-lib-ims');
 
+jest.mock('inquirer', () => ({
+	createPromptModule: jest.fn().mockReturnValue(
+		jest.fn().mockResolvedValue({
+			res: true,
+		}),
+	),
+}));
+
 const DeleteCommand = require('../delete');
 const { SchemaServiceClient } = require('../../../classes/SchemaServiceClient');
 
@@ -79,4 +90,17 @@ describe('delete command tests', () => {
 
 		await expect(runResult).resolves.toEqual({});
 	});
+
+	test('should not delete if user prompt returns false', async () => {
+		inquirer.createPromptModule.mockReturnValue(
+			jest.fn().mockResolvedValue({
+				res: false,
+			}),
+		);
+
+		const meshId = 'sample_merchant';
+		const runResult = await DeleteCommand.run([meshId]);
+
+		expect(runResult).toBe('Delete cancelled');
+	});
 });

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

@@ -10,6 +10,8 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
+const inquirer = require('inquirer');
+
 const mockConsoleCLIInstance = {};
 jest.mock('@adobe/aio-lib-env');
 const orgs = [{ id: '1234', code: 'CODE1234@AdobeOrg', name: 'ORG01', type: 'entp' }];
@@ -35,11 +37,20 @@ function setDefaultMockConsoleCLI() {
 	mockConsoleCLIInstance.promptForSelectWorkspace = jest.fn().mockResolvedValue(selectedWorkspace);
 }
 
+jest.mock('inquirer', () => ({
+	createPromptModule: jest.fn().mockReturnValue(
+		jest.fn().mockResolvedValue({
+			res: true,
+		}),
+	),
+}));
+
 jest.mock('@adobe/aio-cli-lib-console', () => ({
 	init: jest.fn().mockResolvedValue(mockConsoleCLIInstance),
 	cleanStdOut: jest.fn(),
 }));
 jest.mock('@adobe/aio-lib-ims');
+
 const UpdateCommand = require('../update');
 const { SchemaServiceClient } = require('../../../classes/SchemaServiceClient');
 const mockUpdateMesh = require('../../__fixtures__/sample_mesh.json');
@@ -65,6 +76,7 @@ describe('update command tests', () => {
 			),
 		);
 	});
+
 	test('update-mesh-with-configuration', async () => {
 		expect.assertions(2);
 		const runResult = UpdateCommand.run([
@@ -74,4 +86,19 @@ describe('update command tests', () => {
 		await expect(runResult instanceof Promise).toBeTruthy();
 		await expect(runResult).resolves.toEqual(mockUpdateMesh);
 	});
+
+	test('should not delete if user prompt returns false', async () => {
+		inquirer.createPromptModule.mockReturnValue(
+			jest.fn().mockResolvedValue({
+				res: false,
+			}),
+		);
+
+		const runResult = await UpdateCommand.run([
+			'sample_merchant',
+			'src/commands/__fixtures__/sample_mesh.json',
+		]);
+
+		expect(runResult).toBe('Update cancelled');
+	});
 });

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

@@ -10,8 +10,9 @@ governing permissions and limitations under the License.
 */
 
 const { Command } = require('@oclif/command');
+
 const logger = require('../../classes/logger');
-const { initSdk, initRequestId } = require('../../helpers');
+const { initSdk, initRequestId, promptConfirm } = require('../../helpers');
 
 require('dotenv').config();
 
@@ -27,23 +28,33 @@ class DeleteCommand extends Command {
 
 		const { schemaServiceClient, imsOrgId, projectId, workspaceId } = await initSdk();
 
-		try {
-			const response = await schemaServiceClient.deleteMesh(
-				imsOrgId,
-				projectId,
-				workspaceId,
-				args.meshId,
-			);
+		const shouldContinue = await promptConfirm(
+			`Are you sure you want to delete the mesh: ${args.meshId}?`,
+		);
+
+		if (shouldContinue) {
+			try {
+				const response = await schemaServiceClient.deleteMesh(
+					imsOrgId,
+					projectId,
+					workspaceId,
+					args.meshId,
+				);
+
+				this.log('Successfully deleted mesh %s', args.meshId);
 
-			this.log('Successfully deleted mesh %s', args.meshId);
+				return response;
+			} catch (error) {
+				this.log(error.message);
 
-			return response;
-		} catch (error) {
-			this.log(error.message);
+				this.error(
+					`Unable to delete mesh. Please check the details and try again. If the error persists please contact support. RequestId: ${global.requestId}`,
+				);
+			}
+		} else {
+			this.log('Delete cancelled');
 
-			this.error(
-				`Unable to delete mesh. Please check the details and try again. If the error persists please contact support. RequestId: ${global.requestId}`,
-			);
+			return 'Delete cancelled';
 		}
 	}
 }

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

@@ -11,8 +11,9 @@ governing permissions and limitations under the License.
 
 const { Command } = require('@oclif/command');
 const { readFile } = require('fs/promises');
+
 const logger = require('../../classes/logger');
-const { initSdk, initRequestId } = require('../../helpers');
+const { initSdk, initRequestId, promptConfirm } = require('../../helpers');
 
 class UpdateCommand extends Command {
 	static args = [{ name: 'meshId' }, { name: 'file' }];
@@ -38,24 +39,34 @@ class UpdateCommand extends Command {
 			);
 		}
 
-		try {
-			const response = await schemaServiceClient.updateMesh(
-				imsOrgId,
-				projectId,
-				workspaceId,
-				args.meshId,
-				data,
-			);
+		const shouldContinue = await promptConfirm(
+			`Are you sure you want to update the mesh: ${args.meshId}?`,
+		);
 
-			this.log('Successfully updated the mesh with the id: %s', args.meshId);
+		if (shouldContinue) {
+			try {
+				const response = await schemaServiceClient.updateMesh(
+					imsOrgId,
+					projectId,
+					workspaceId,
+					args.meshId,
+					data,
+				);
 
-			return response;
-		} catch (error) {
-			this.log(error.message);
+				this.log('Successfully updated the mesh with the id: %s', args.meshId);
 
-			this.error(
-				`Unable to update the mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: ${global.requestId}`,
-			);
+				return response;
+			} catch (error) {
+				this.log(error.message);
+
+				this.error(
+					`Unable to update the mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: ${global.requestId}`,
+				);
+			}
+		} else {
+			this.log('Update cancelled');
+
+			return 'Update cancelled';
 		}
 	}
 }

package/src/helpers.js

@@ -9,19 +9,21 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
+const fs = require('fs');
+const inquirer = require('inquirer');
+
 const Config = require('@adobe/aio-lib-core-config');
 const { getToken, context } = require('@adobe/aio-lib-ims');
 const { CLI } = require('@adobe/aio-lib-ims/src/context');
-const fs = require('fs');
 const libConsoleCLI = require('@adobe/aio-cli-lib-console');
-const { SchemaServiceClient } = require('./classes/SchemaServiceClient');
 const { getCliEnv } = require('@adobe/aio-lib-env');
+const aioConsoleLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-api-mesh', {
+	provider: 'debug',
+});
+
+const { SchemaServiceClient } = require('./classes/SchemaServiceClient');
 const logger = require('../src/classes/logger');
 const { UUID } = require('./classes/UUID');
-const aioConsoleLogger = require('@adobe/aio-lib-core-logging')(
-	'@adobe/aio-cli-plugin-api-mesh',
-	{ provider: 'debug' },
-);
 
 const CONSOLE_API_KEYS = {
 	prod: 'aio-cli-console-auth',
@@ -190,7 +192,30 @@ async function initRequestId() {
 	global.requestId = UUID.newUuid().toString();
 }
 
+/**
+ * Function to run the CLI Y/N prompt to confirm the user's action
+ *
+ * @param {string} message
+ *
+ * @returns boolean
+ */
+async function promptConfirm(message) {
+	const prompt = inquirer.createPromptModule({ output: process.stderr });
+
+	const confirm = await prompt([
+		{
+			type: 'confirm',
+			name: 'res',
+			message,
+		},
+	]);
+
+	return confirm.res;
+}
+
 module.exports = {
+	promptConfirm,
+	getLibConsoleCLI,
 	getDevConsoleConfig,
 	initSdk,
 	initRequestId,