@squiz/dxp-cli-next 5.15.0-develop.1 → 5.15.0-develop.3

package/lib/porter/constants.d.ts

@@ -3,4 +3,6 @@ export declare const PORTER_REGION = "au";
 export declare const PORTER_ERRORS: {
     projectAlreadyExists: string;
     projectNameMissing: string;
+    projectDirectoryInvalid: string;
+    portIdBlankError: string;
 };

package/lib/porter/constants.js

@@ -6,4 +6,6 @@ exports.PORTER_REGION = 'au';
 exports.PORTER_ERRORS = {
     projectAlreadyExists: 'Project directory already exists. Please choose a project directory that does not exist',
     projectNameMissing: 'Project name is missing from the config.json file',
+    projectDirectoryInvalid: 'You must be within a porter project directory to use this command',
+    portIdBlankError: 'Cannot be blank.',
 };

package/lib/porter/index.js

@@ -4,9 +4,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
+const portCommand_1 = __importDefault(require("./port/portCommand"));
 const projectCommand_1 = __importDefault(require("./project/projectCommand"));
 const porterCommand = new commander_1.Command('porter');
 porterCommand
     .description('Porter Service Commands')
-    .addCommand((0, projectCommand_1.default)());
+    .addCommand((0, projectCommand_1.default)())
+    .addCommand((0, portCommand_1.default)());
 exports.default = porterCommand;

package/lib/porter/port/abort/abort.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const createAbortPortCommand: () => Command;
+export default createAbortPortCommand;

package/lib/porter/port/abort/abort.js

@@ -0,0 +1,77 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const ApiService_1 = require("../../../ApiService");
+const utils_1 = require("../../utils");
+const constants_1 = require("../../constants");
+const createAbortPortCommand = () => {
+    const getCommand = new commander_1.Command('abortPort')
+        .description('Aborts a running website port')
+        .configureOutput({
+        outputError(str, write) {
+            write(chalk_1.default.red(str));
+        },
+    })
+        .addArgument(new commander_1.Argument('UUID', 'ID of the port').argParser((portId) => {
+        const trimmedPortId = portId.trim();
+        if (!trimmedPortId) {
+            throw new commander_1.InvalidArgumentError(constants_1.PORTER_ERRORS.portIdBlankError);
+        }
+        return trimmedPortId;
+    }))
+        .action((uuid) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b, _c, _d;
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(getCommand);
+        const baseUrl = yield (0, utils_1.buildPorterUrl)();
+        const portId = uuid;
+        let projectName = '';
+        const spinner = (0, ora_1.default)();
+        try {
+            projectName = yield (0, utils_1.getProjectName)();
+            spinner.start('Aborting port..');
+            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, baseUrl);
+            const abortRequest = {
+                status: 'abort',
+            };
+            const response = yield apiService.client.patch(`/projects/${projectName}/ports/${portId}`, abortRequest);
+            const jsonResponse = response.data;
+            (0, utils_1.logDebug)(JSON.stringify(jsonResponse));
+            spinner.succeed();
+            console.log('');
+            console.log('Website port aborted');
+        }
+        catch (error) {
+            (0, utils_1.logDebug)(`ERROR: ${error instanceof Error ? `${error.message}` : JSON.stringify(error)}`);
+            if (spinner.isSpinning) {
+                spinner.fail();
+            }
+            if (((_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.status) === 404) {
+                (0, utils_1.logDebug)(error.response.data);
+                const errorMessage = 'Website port execution not found';
+                return (0, utils_1.handleError)(getCommand, errorMessage);
+            }
+            if (((_d = (_c = error.response) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.status) === 409) {
+                (0, utils_1.logDebug)(error.response.data);
+                const errorMessage = 'Website port cannot be aborted as it is already not running';
+                return (0, utils_1.handleError)(getCommand, errorMessage);
+            }
+            (0, utils_1.handleCommandError)(getCommand, error);
+        }
+    }));
+    return getCommand;
+};
+exports.default = createAbortPortCommand;

package/lib/porter/port/abort/abort.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/porter/port/abort/abort.spec.js

@@ -0,0 +1,182 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = require("axios");
+const ApiService = __importStar(require("../../../ApiService"));
+const PorterUtils = __importStar(require("../../utils"));
+const constants_1 = require("../../constants");
+const dxp_porter_shared_1 = require("@squiz/dxp-porter-shared");
+const logSpy = jest.spyOn(global.console, 'log');
+jest.mock('../../utils');
+describe('abortPort', () => {
+    let projectName;
+    let portId;
+    let baseUrl;
+    let mockHandleCommandError;
+    let mockHandleError;
+    let mockBuildPorterUrl;
+    let mockResponse;
+    let mockClient;
+    beforeEach(() => {
+        jest.resetAllMocks();
+        jest.clearAllMocks();
+        projectName = 'mock-project';
+        portId = '1234-5678-1234-5678';
+        baseUrl = 'mock-url';
+        mockHandleCommandError = jest.fn(() => Promise.resolve());
+        mockHandleError = jest.fn();
+        mockBuildPorterUrl = jest.fn(() => Promise.resolve(baseUrl));
+        mockResponse = {
+            data: {},
+            status: 200,
+        };
+        mockClient = {
+            patch: jest.fn().mockImplementationOnce(() => mockResponse),
+        };
+        jest.spyOn(PorterUtils, 'throwErrorIfNotLoggedIn').mockImplementation();
+        jest
+            .spyOn(PorterUtils, 'buildPorterUrl')
+            .mockImplementationOnce(mockBuildPorterUrl);
+        jest
+            .spyOn(PorterUtils, 'getProjectName')
+            .mockImplementation(() => Promise.resolve(projectName));
+        jest
+            .spyOn(PorterUtils, 'handleCommandError')
+            .mockImplementationOnce(mockHandleCommandError);
+        jest
+            .spyOn(PorterUtils, 'handleError')
+            .mockImplementationOnce(mockHandleError);
+        jest.spyOn(process, 'exit').mockImplementation();
+        jest.spyOn(ApiService, 'ApiService').mockImplementationOnce(() => {
+            return {
+                client: mockClient,
+            };
+        });
+    });
+    it('should throw an error if port id is invalid', () => __awaiter(void 0, void 0, void 0, function* () {
+        const portIdInvalid = ' ';
+        const { default: createAbortCommand } = require('./abort');
+        const program = createAbortCommand();
+        yield expect(() => program.parseAsync(['port', 'abortPort', portIdInvalid])).rejects.toThrow(constants_1.PORTER_ERRORS.portIdBlankError);
+    }));
+    it('should throw an error if not logged in', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockError = new Error('Error not logged in');
+        jest
+            .spyOn(PorterUtils, 'throwErrorIfNotLoggedIn')
+            .mockImplementationOnce(() => {
+            throw mockError;
+        });
+        const { default: createAbortCommand } = require('./abort');
+        const program = createAbortCommand();
+        yield expect(() => program.parseAsync(['port', 'abortPort', portId])).rejects.toThrow(mockError);
+        const opts = program.opts();
+        expect(opts).toStrictEqual({});
+        expect(PorterUtils.buildPorterUrl).not.toHaveBeenCalled();
+    }));
+    it('should throw an error if project name could not be found', () => __awaiter(void 0, void 0, void 0, function* () {
+        jest.spyOn(PorterUtils, 'getProjectName').mockImplementationOnce(() => {
+            throw new Error();
+        });
+        const { default: createAbortCommand } = require('./abort');
+        const program = createAbortCommand();
+        yield program.parseAsync(['port', 'abortPort', portId]);
+        expect(PorterUtils.buildPorterUrl).toHaveBeenCalled();
+        expect(mockClient.patch).not.toHaveBeenCalled();
+        expect(PorterUtils.handleCommandError).toHaveBeenCalled();
+    }));
+    it('should handle 404 error when port cannot be found for project', () => __awaiter(void 0, void 0, void 0, function* () {
+        mockClient.patch = jest.fn(() => {
+            throw new axios_1.AxiosError('Port does not exist', '404', undefined, undefined, {
+                data: { status: 404 },
+            });
+        });
+        const { default: createAbortCommand } = require('./abort');
+        const program = createAbortCommand();
+        yield program.parseAsync(['port', 'abortPort', portId]);
+        expect(PorterUtils.buildPorterUrl).toHaveBeenCalled();
+        expect(mockClient.patch).toHaveBeenCalledWith(`/projects/${projectName}/ports/${portId}`, { status: 'abort' });
+        expect(PorterUtils.handleError).toHaveBeenCalled();
+    }));
+    it('should handle 409 error when port is already not running', () => __awaiter(void 0, void 0, void 0, function* () {
+        mockClient.patch = jest.fn(() => {
+            throw new axios_1.AxiosError('Port already not running', '409', undefined, undefined, {
+                data: { status: 409 },
+            });
+        });
+        const { default: createAbortCommand } = require('./abort');
+        const program = createAbortCommand();
+        yield program.parseAsync(['port', 'abortPort', portId]);
+        expect(PorterUtils.buildPorterUrl).toHaveBeenCalled();
+        expect(mockClient.patch).toHaveBeenCalledWith(`/projects/${projectName}/ports/${portId}`, { status: 'abort' });
+        expect(PorterUtils.handleError).toHaveBeenCalled();
+    }));
+    it('should handle unexpected errors', () => __awaiter(void 0, void 0, void 0, function* () {
+        mockClient.patch = jest.fn(() => {
+            throw new axios_1.AxiosError('Internal server error', '500', undefined, undefined, {
+                data: { status: 500 },
+            });
+        });
+        const { default: createAbortCommand } = require('./abort');
+        const program = createAbortCommand();
+        yield program.parseAsync(['port', 'abortPort', portId]);
+        expect(PorterUtils.buildPorterUrl).toHaveBeenCalled();
+        expect(mockClient.patch).toHaveBeenCalledWith(`/projects/${projectName}/ports/${portId}`, { status: 'abort' });
+        expect(PorterUtils.handleError).not.toHaveBeenCalled();
+        expect(PorterUtils.handleCommandError).toHaveBeenCalled();
+    }));
+    it('should successfully abort a running port', () => __awaiter(void 0, void 0, void 0, function* () {
+        // mockClient.patch = jest.fn(() => {
+        // });
+        const mockPatchResponse = {
+            portid: portId,
+            'artifacts-link': null,
+            'report-link': null,
+            'stage-settings': {},
+            stages: {},
+            status: dxp_porter_shared_1.PortStatus.aborted,
+        };
+        mockResponse = {
+            data: mockPatchResponse,
+            status: 200,
+        };
+        const { default: createAbortCommand } = require('./abort');
+        const program = createAbortCommand();
+        yield program.parseAsync(['port', 'abortPort', portId]);
+        expect(PorterUtils.buildPorterUrl).toHaveBeenCalled();
+        expect(mockClient.patch).toHaveBeenCalledWith(`/projects/${projectName}/ports/${portId}`, { status: 'abort' });
+        expect(PorterUtils.handleError).not.toHaveBeenCalled();
+        expect(PorterUtils.handleCommandError).not.toHaveBeenCalled();
+        expect(logSpy).toHaveBeenCalledWith('Website port aborted');
+    }));
+});

package/lib/porter/port/get/get.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const createGetPortCommand: () => Command;
+export default createGetPortCommand;

package/lib/porter/port/get/get.js

@@ -0,0 +1,93 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const ApiService_1 = require("../../../ApiService");
+const utils_1 = require("../../utils");
+const constants_1 = require("../../constants");
+const dxp_porter_shared_1 = require("@squiz/dxp-porter-shared");
+const createGetPortCommand = () => {
+    const getCommand = new commander_1.Command('getPort')
+        .description('Gets the information about a specified website port')
+        .configureOutput({
+        outputError(str, write) {
+            write(chalk_1.default.red(str));
+        },
+    })
+        .addArgument(new commander_1.Argument('UUID', 'ID of the port').argParser((portId) => {
+        const trimmedPortId = portId.trim();
+        if (!trimmedPortId) {
+            throw new commander_1.InvalidArgumentError(constants_1.PORTER_ERRORS.portIdBlankError);
+        }
+        return trimmedPortId;
+    }))
+        .action((uuid) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b, _c, _d;
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(getCommand);
+        const baseUrl = yield (0, utils_1.buildPorterUrl)();
+        const portId = uuid;
+        let projectName = '';
+        const spinner = (0, ora_1.default)();
+        try {
+            projectName = yield (0, utils_1.getProjectName)();
+            spinner.start('Retrieving port..');
+            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, baseUrl);
+            const response = yield apiService.client.get(`/projects/${projectName}/ports/${portId}`);
+            const jsonResponse = response.data;
+            (0, utils_1.logDebug)(JSON.stringify(jsonResponse));
+            const { portid, stages, 'stage-settings': stageSettings, status, } = jsonResponse;
+            const artifactsLink = (_a = jsonResponse['artifacts-link']) !== null && _a !== void 0 ? _a : 'Not generated';
+            const reportLink = (_b = jsonResponse['report-link']) !== null && _b !== void 0 ? _b : 'Not generated';
+            spinner.succeed();
+            console.log('');
+            console.log(`Port ID: ${portid}`);
+            console.log(`Status: ${status}`);
+            console.log(`Download report: ${reportLink}`);
+            console.log(`Download artifacts: ${artifactsLink}`);
+            console.log('');
+            const excludedStages = [
+                dxp_porter_shared_1.Stage['component-transform'],
+                dxp_porter_shared_1.Stage['design-dedupe'],
+                // Hide validation stage from user (PERSONIZE-771)
+                dxp_porter_shared_1.Stage.validation,
+            ];
+            const stagesToLog = Object.values(dxp_porter_shared_1.Stage).filter(stage => !excludedStages.includes(stage));
+            for (const stage of stagesToLog) {
+                const stageString = stage.replace(/-/, ' ');
+                console.log(`Stage ${stageString} status: ${stages[stage].status}`);
+            }
+            console.log('');
+            for (const stage of stagesToLog) {
+                const stageString = stage.replace(/-/, ' ');
+                console.log(`Stage ${stageString} settings:`, stageSettings[stage]);
+            }
+        }
+        catch (error) {
+            (0, utils_1.logDebug)(`ERROR: ${error instanceof Error ? `${error.message}` : JSON.stringify(error)}`);
+            if (spinner.isSpinning) {
+                spinner.fail();
+            }
+            if (((_d = (_c = error.response) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.status) === 404) {
+                (0, utils_1.logDebug)(error.response.data);
+                const errorMessage = 'Website port execution not found';
+                return (0, utils_1.handleError)(getCommand, errorMessage);
+            }
+            (0, utils_1.handleCommandError)(getCommand, error);
+        }
+    }));
+    return getCommand;
+};
+exports.default = createGetPortCommand;

package/lib/porter/port/get/get.spec.d.ts

@@ -0,0 +1 @@
+export {};