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

package/lib/porter/utils/DoesPathExist/DoesPathExist.spec.js

@@ -0,0 +1,40 @@
+"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 promises_1 = __importDefault(require("fs/promises"));
+const DoesPathExist_1 = require("./DoesPathExist");
+jest.mock('fs/promises', () => {
+    return {
+        readdir: jest.fn(),
+    };
+});
+describe('doesPathExist', () => {
+    const projectPath = 'project-path';
+    it('should return false if path does not exist', () => __awaiter(void 0, void 0, void 0, function* () {
+        jest.spyOn(promises_1.default, 'readdir').mockImplementationOnce(() => {
+            throw new Error();
+        });
+        const pathExists = yield (0, DoesPathExist_1.doesPathExist)(projectPath);
+        expect(pathExists).toBe(false);
+        expect(promises_1.default.readdir).toHaveBeenCalled();
+    }));
+    it('should return true if path exists', () => __awaiter(void 0, void 0, void 0, function* () {
+        jest
+            .spyOn(promises_1.default, 'readdir')
+            .mockImplementationOnce(() => Promise.resolve([]));
+        const pathExists = yield (0, DoesPathExist_1.doesPathExist)(projectPath);
+        expect(pathExists).toBe(true);
+        expect(promises_1.default.readdir).toHaveBeenCalled();
+    }));
+});

package/lib/porter/utils/ErrorUtils/ErrorUtils.d.ts

@@ -0,0 +1,4 @@
+import { Command } from 'commander';
+export declare function handleCommandError(command: Command, error: Error): undefined;
+export declare function handleError(command: Command, errorMessage: string): void;
+export declare function throwErrorIfNotLoggedIn(command: Command): Promise<undefined>;

package/lib/porter/utils/ErrorUtils/ErrorUtils.js

@@ -0,0 +1,68 @@
+"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 });
+exports.throwErrorIfNotLoggedIn = exports.handleError = exports.handleCommandError = void 0;
+const axios_1 = __importDefault(require("axios"));
+const chalk_1 = __importDefault(require("chalk"));
+const ApplicationStore_1 = require("../../../ApplicationStore");
+const CheckAuthorisation_1 = require("../AuthUtils/CheckAuthorisation");
+function handleCommandError(command, error) {
+    if (!axios_1.default.isAxiosError(error)) {
+        if (!!process.env.DEBUG && error.stack) {
+            return command.error(error.stack);
+        }
+        if (error.message) {
+            return command.error(chalk_1.default.red(error.message));
+        }
+        return command.error(chalk_1.default.red('An unknown error occurred'));
+    }
+    if (!error.response) {
+        return command.error(chalk_1.default.red(error.message));
+    }
+    if (error.response.status === 401 || error.response.status === 403) {
+        const errorMessage = 'You must be logged in as a DXP super admin or Squiz support staff to use this service';
+        return command.error(chalk_1.default.red(errorMessage));
+    }
+    if (error.response.status >= 500) {
+        const errorMessage = `Action failed. Service responded with "${error.response.status}" response code`;
+        return command.error(chalk_1.default.red(errorMessage));
+    }
+    if (error.response.data) {
+        let errorMessage;
+        if (error.response.data['invalid-params']) {
+            errorMessage = JSON.stringify(error.response.data['invalid-params']);
+        }
+        else {
+            errorMessage = error.response.data.title;
+        }
+        return command.error(chalk_1.default.red(errorMessage));
+    }
+}
+exports.handleCommandError = handleCommandError;
+function handleError(command, errorMessage) {
+    command.error(chalk_1.default.red(errorMessage));
+}
+exports.handleError = handleError;
+function throwErrorIfNotLoggedIn(command) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!(yield (0, ApplicationStore_1.getApplicationFile)(ApplicationStore_1.STORE_FILES.sessionCookie))) {
+            return command.error(chalk_1.default.red('You must login to interact with the porter service. See `dxp-next auth login`'));
+        }
+        const isAuthorised = yield (0, CheckAuthorisation_1.checkAuthorisation)();
+        if (!isAuthorised) {
+            command.error(chalk_1.default.red('You must login to interact with the porter service. See `dxp-next auth login`'));
+        }
+    });
+}
+exports.throwErrorIfNotLoggedIn = throwErrorIfNotLoggedIn;

package/lib/porter/utils/ErrorUtils/ErrorUtils.spec.d.ts

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

package/lib/porter/utils/ErrorUtils/ErrorUtils.spec.js

@@ -0,0 +1,175 @@
+"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 commander_1 = require("commander");
+const GetApplicationFile = __importStar(require("../../../ApplicationStore"));
+const CheckAuthorisation = __importStar(require("../AuthUtils/CheckAuthorisation"));
+const ErrorUtils_1 = require("./ErrorUtils");
+describe('handleCommandError', () => {
+    let stderrSpy;
+    beforeEach(() => {
+        jest.resetAllMocks();
+        stderrSpy = jest.spyOn(process.stderr, 'write');
+        jest.spyOn(process, 'exit').mockImplementation();
+    });
+    it('correctly displays the console logs for command error', () => __awaiter(void 0, void 0, void 0, function* () {
+        process.env.DEBUG = 'true';
+        const command = new commander_1.Command();
+        const message = 'Something bad happened';
+        (0, ErrorUtils_1.handleCommandError)(command, new Error(message));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain(message);
+    }));
+    it('correctly displays the console logs for command error', () => __awaiter(void 0, void 0, void 0, function* () {
+        delete process.env.DEBUG;
+        const command = new commander_1.Command();
+        const message = 'Something bad happened';
+        (0, ErrorUtils_1.handleCommandError)(command, new Error(message));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain(message);
+    }));
+    it('correctly displays the console logs for error without a message', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        (0, ErrorUtils_1.handleCommandError)(command, new Error());
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain('An unknown error occurred');
+    }));
+    it('correctly displays the console logs for axios error without a proper response', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        const message = 'Something bad happened';
+        (0, ErrorUtils_1.handleCommandError)(command, new axios_1.AxiosError(message, '500', undefined, undefined, undefined));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain(message);
+    }));
+    it('correctly displays the console logs for axios 500 error from the porter service', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        const message = 'Internal server error';
+        (0, ErrorUtils_1.handleCommandError)(command, new axios_1.AxiosError(message, '500', undefined, undefined, {
+            status: 500,
+        }));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain('Action failed. Service responded with "500" response code');
+    }));
+    it.each([401, 403])('correctly displays the console logs for axios %s error from the porter service', (status) => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        const message = 'Unauthorized';
+        (0, ErrorUtils_1.handleCommandError)(command, new axios_1.AxiosError(message, `${status}`, undefined, undefined, {
+            status,
+        }));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain('You must be logged in as a DXP super admin or Squiz support staff to use this service');
+    }));
+    it('correctly displays the console logs for axios errors from the porter service', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        const errorStatus = 400;
+        const errorTitle = 'Bad request';
+        const errorResponse = {
+            data: {
+                title: errorTitle,
+                'invalid-params': [
+                    {
+                        name: 'name',
+                        reason: 'reason',
+                    },
+                ],
+            },
+        };
+        (0, ErrorUtils_1.handleCommandError)(command, new axios_1.AxiosError(errorTitle, `${errorStatus}`, undefined, undefined, errorResponse));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain(JSON.stringify(errorResponse.data['invalid-params']));
+    }));
+});
+describe('handleError', () => {
+    let stderrSpy;
+    beforeEach(() => {
+        jest.resetAllMocks();
+        stderrSpy = jest.spyOn(process.stderr, 'write');
+    });
+    it('correctly displays the console logs for command error', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        const message = 'Something bad happened';
+        (0, ErrorUtils_1.handleError)(command, message);
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain(message);
+    }));
+});
+describe('throwErrorIfNotLoggedIn', () => {
+    let stderrSpy;
+    let command;
+    beforeEach(() => {
+        jest.resetAllMocks();
+        command = new commander_1.Command();
+        stderrSpy = jest.spyOn(process.stderr, 'write');
+        jest.spyOn(process, 'exit').mockImplementation();
+    });
+    it('should call the command error if cookie cannot be retrieved', () => __awaiter(void 0, void 0, void 0, function* () {
+        jest
+            .spyOn(GetApplicationFile, 'getApplicationFile')
+            .mockImplementationOnce(() => Promise.resolve(undefined));
+        yield (0, ErrorUtils_1.throwErrorIfNotLoggedIn)(command);
+        expect(stderrSpy.mock.calls[0][0]).toContain('You must login to interact with the porter service. See `dxp-next auth login');
+        expect(process.exit).toHaveBeenCalled();
+    }));
+    it('should call the command error if unauthorised', () => __awaiter(void 0, void 0, void 0, function* () {
+        jest
+            .spyOn(GetApplicationFile, 'getApplicationFile')
+            .mockImplementationOnce(() => Promise.resolve('cookie'));
+        jest
+            .spyOn(CheckAuthorisation, 'checkAuthorisation')
+            .mockImplementationOnce(() => Promise.resolve(false));
+        yield (0, ErrorUtils_1.throwErrorIfNotLoggedIn)(command);
+        expect(stderrSpy.mock.calls[0][0]).toContain('You must login to interact with the porter service. See `dxp-next auth login');
+        expect(process.exit).toHaveBeenCalled();
+    }));
+    it('should not call the command error if logged in', () => __awaiter(void 0, void 0, void 0, function* () {
+        jest
+            .spyOn(GetApplicationFile, 'getApplicationFile')
+            .mockImplementationOnce(() => Promise.resolve('cookie'));
+        jest
+            .spyOn(CheckAuthorisation, 'checkAuthorisation')
+            .mockImplementationOnce(() => Promise.resolve(true));
+        yield (0, ErrorUtils_1.throwErrorIfNotLoggedIn)(command);
+        expect(stderrSpy).not.toHaveBeenCalled();
+        expect(process.exit).not.toHaveBeenCalled();
+    }));
+});

package/lib/porter/utils/GetProjectConfig/GetProjectConfig.d.ts

@@ -0,0 +1,2 @@
+import { ProjectConfig } from '../../types';
+export declare function getProjectConfig(): Promise<ProjectConfig>;

package/lib/porter/utils/GetProjectConfig/GetProjectConfig.js

@@ -0,0 +1,32 @@
+"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 });
+exports.getProjectConfig = void 0;
+const path_1 = __importDefault(require("path"));
+const promises_1 = __importDefault(require("fs/promises"));
+const CoreUtils_1 = require("../CoreUtils/CoreUtils");
+function getProjectConfig() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const configFile = path_1.default.resolve('config.json');
+            const config = yield promises_1.default.readFile(configFile, { encoding: 'utf-8' });
+            return JSON.parse(config);
+        }
+        catch (err) {
+            (0, CoreUtils_1.logDebug)(err);
+            throw new Error('You must be within a porter project directory to use this command');
+        }
+    });
+}
+exports.getProjectConfig = getProjectConfig;

package/lib/porter/utils/GetProjectConfig/GetProjectConfig.spec.d.ts

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

package/lib/porter/utils/GetProjectConfig/GetProjectConfig.spec.js

@@ -0,0 +1,49 @@
+"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 GetProjectConfig_1 = require("./GetProjectConfig");
+const promises_1 = __importDefault(require("fs/promises"));
+jest.mock('fs/promises', () => {
+    return {
+        readFile: jest.fn(),
+    };
+});
+describe('getProjectConfig', () => {
+    it('should throw an error if cannot config file does not exist', () => __awaiter(void 0, void 0, void 0, function* () {
+        jest.spyOn(promises_1.default, 'readFile').mockImplementationOnce(() => {
+            throw new Error('ENOENT');
+        });
+        yield expect((0, GetProjectConfig_1.getProjectConfig)()).rejects.toThrowError('You must be within a porter project directory to use this command');
+        expect(promises_1.default.readFile).toHaveBeenCalled();
+    }));
+    it('should throw an error if cannot parse config file', () => __awaiter(void 0, void 0, void 0, function* () {
+        jest
+            .spyOn(promises_1.default, 'readFile')
+            .mockImplementationOnce(() => Promise.resolve('invalid-json'));
+        yield expect((0, GetProjectConfig_1.getProjectConfig)()).rejects.toThrowError('You must be within a porter project directory to use this command');
+        expect(promises_1.default.readFile).toHaveBeenCalled();
+    }));
+    it('should return the project config json', () => __awaiter(void 0, void 0, void 0, function* () {
+        const projectConfig = {
+            service: 'dxp-porter',
+            projectName: 'name',
+            version: '0.1.0',
+        };
+        jest
+            .spyOn(promises_1.default, 'readFile')
+            .mockImplementationOnce(() => Promise.resolve(JSON.stringify(projectConfig)));
+        const parsedConfig = yield (0, GetProjectConfig_1.getProjectConfig)();
+        expect(parsedConfig).toStrictEqual(projectConfig);
+    }));
+});

package/lib/porter/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * from './AuthUtils/CheckAuthorisation';
+export * from './BuildPorterUrl/BuildPorterUrl';
+export * from './CoreUtils/CoreUtils';
+export * from './DoesPathExist/DoesPathExist';
+export * from './ErrorUtils/ErrorUtils';
+export * from './GetProjectConfig/GetProjectConfig';

package/lib/porter/utils/index.js

@@ -0,0 +1,22 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AuthUtils/CheckAuthorisation"), exports);
+__exportStar(require("./BuildPorterUrl/BuildPorterUrl"), exports);
+__exportStar(require("./CoreUtils/CoreUtils"), exports);
+__exportStar(require("./DoesPathExist/DoesPathExist"), exports);
+__exportStar(require("./ErrorUtils/ErrorUtils"), exports);
+__exportStar(require("./GetProjectConfig/GetProjectConfig"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.14.0",
+  "version": "5.15.0-develop.1",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },
@@ -41,18 +41,21 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "10.1.0",
     "@squiz/component-cli-lib": "1.65.1",
+    "@squiz/dxp-porter-shared": "0.2.7",
     "axios": "1.1.3",
     "cli-color": "2.0.3",
     "commander": "9.4.0",
     "dotenv": "^16.3.1",
     "env-paths": "2.2.1",
+    "esbuild": "^0.21.4",
     "inquirer": "8.2.5",
     "opener": "1.5.2",
     "ora": "^5.4.1",
     "prompt": "^1.3.0",
     "tough-cookie": "4.1.2",
     "update-notifier": "5.1.0",
-    "yaml": "^2.3.4"
+    "yaml": "^2.3.4",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@semantic-release/git": "10.0.1",
@@ -84,7 +87,7 @@
     "prettier": "2.7.1",
     "semantic-release": "19.0.3",
     "ts-jest": "28.0.7",
-    "ts-node": "10.9.1",
+    "ts-node": "^10.9.1",
     "typescript": "4.7.4"
   },
   "config": {