@squiz/dxp-cli-next 5.15.0 → 5.16.0

package/lib/porter/constants.d.ts

@@ -7,4 +7,5 @@ export declare const PORTER_ERRORS: {
     projectDirectoryInvalid: string;
     portIdBlankError: string;
     loginError: string;
+    loginPermissionError: string;
 };

package/lib/porter/constants.js

@@ -9,5 +9,6 @@ exports.PORTER_ERRORS = {
     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.',
-    loginError: 'To use this service you must be logged in as a DXP super admin, Squiz support staff or be assigned the Migration Agent secondary role for the selected tenant',
+    loginError: 'You must login to interact with the porter service. See `dxp-next auth login`',
+    loginPermissionError: 'To use this service you must be logged in as a DXP super admin, Squiz support staff or be assigned the Migration Agent secondary role for the selected tenant. See `dxp-next auth login`',
 };

package/lib/porter/index.js

@@ -4,11 +4,21 @@ 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 abort_1 = __importDefault(require("./port/abort/abort"));
+const get_1 = __importDefault(require("./port/get/get"));
+const start_1 = __importDefault(require("./port/start/start"));
+const add_1 = __importDefault(require("./project/add/add"));
+const get_2 = __importDefault(require("./project/get/get"));
+const remove_1 = __importDefault(require("./project/remove/remove"));
 const porterCommand = new commander_1.Command('porter');
 porterCommand
     .description('Porter Service Commands')
-    .addCommand((0, projectCommand_1.default)())
-    .addCommand((0, portCommand_1.default)());
+    // project commands
+    .addCommand((0, add_1.default)())
+    .addCommand((0, get_2.default)())
+    .addCommand((0, remove_1.default)())
+    // port commands
+    .addCommand((0, start_1.default)())
+    .addCommand((0, get_1.default)())
+    .addCommand((0, abort_1.default)());
 exports.default = porterCommand;

package/lib/porter/project/add/add.js

@@ -55,6 +55,7 @@ const createAddProjectCommand = () => {
         const projectName = options.projectName;
         const projectPath = options.path;
         const spinner = (0, ora_1.default)();
+        // Local filesystem validation
         const projectDir = path_1.default.resolve(projectPath);
         try {
             const pathExists = yield (0, utils_1.doesPathExist)(projectPath);
@@ -69,6 +70,10 @@ const createAddProjectCommand = () => {
                 throw new Error(`Project parent directory "${parentDir}" does not exist`);
             }
             spinner.start('Creating a new project..');
+            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, baseUrl);
+            const requestBody = { 'new-project': true };
+            const response = yield apiService.client.put(`/projects/${projectName}`, requestBody);
+            (0, utils_1.logDebug)(response.data);
             yield promises_1.default.mkdir(projectDir);
             (0, utils_1.logDebug)(`Directory created successfully at ${projectDir}`);
             const configJsonFile = path_1.default.join(projectDir, 'config.json');
@@ -86,29 +91,31 @@ const createAddProjectCommand = () => {
                 yield promises_1.default.mkdir(stageDir);
                 (0, utils_1.logDebug)(`Directory created successfully at ${stageDir}`);
             })));
-            const crawlConfigExample = path_1.default.join(stageConfigDir, 'crawl', 'config.json.example');
-            yield promises_1.default.writeFile(crawlConfigExample, JSON.stringify({
-                start_urls: ['https://...', 'https://...'],
-                exclude_patterns: ['https://...', 'https://...'],
-                max_download_size: 'MB',
-                request_delay: 'INT',
-                max_dir_depth: 'INT',
-                max_files_stored: 'INT',
-                run: true,
-            }, null, 2));
+            const crawlConfigExample = path_1.default.join(stageConfigDir, dxp_porter_shared_1.Stage.crawl, 'config.json.example');
+            yield promises_1.default.writeFile(crawlConfigExample, `{
+  "start_urls": ["https://...", "https://..."],
+  "exclude_patterns": ["https://...", "https://..."],
+  "max_download_size": INT (MB),
+  "request_delay": INT (ms),
+  "max_dir_depth": INT,
+  "max_files_stored": INT,
+  "run": true,
+}`);
             (0, utils_1.logDebug)(`File created successfully at ${crawlConfigExample}`);
+            const templateDedupeConfigExample = path_1.default.join(stageConfigDir, dxp_porter_shared_1.Stage.templateDedupe, 'config.json.example');
+            yield promises_1.default.writeFile(templateDedupeConfigExample, `{
+  "sensitivity": INT,
+  "run": false,
+}`);
+            (0, utils_1.logDebug)(`File created successfully at ${templateDedupeConfigExample}`);
             // Default example configs for other stages
             stageDirsToCreate
-                .filter(dir => dir !== dxp_porter_shared_1.Stage.crawl)
+                .filter(dir => dir !== dxp_porter_shared_1.Stage.crawl && dir !== dxp_porter_shared_1.Stage.templateDedupe)
                 .map((dir) => __awaiter(void 0, void 0, void 0, function* () {
                 const configExample = path_1.default.join(stageConfigDir, dir, 'config.json.example');
                 yield promises_1.default.writeFile(configExample, JSON.stringify({ run: true }, null, 2));
                 (0, utils_1.logDebug)(`File created successfully at ${configExample}`);
             }));
-            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus, baseUrl);
-            const requestBody = { 'new-project': true };
-            const response = yield apiService.client.put(`/projects/${projectName}`, requestBody);
-            (0, utils_1.logDebug)(response.data);
             spinner.succeed(`Project "${projectName}" created. Project directory initialized`);
         }
         catch (error) {
@@ -117,8 +124,6 @@ const createAddProjectCommand = () => {
                 spinner.fail();
             }
             if (((_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.status) === 409) {
-                (0, utils_1.logDebug)(`Failed to create new project, removing project directory: "${projectDir}"`);
-                yield promises_1.default.rm(projectDir, { recursive: true });
                 const errorMessage = `Project "${projectName}" already exists. Try a different project name`;
                 return (0, utils_1.handleError)(addCommand, errorMessage);
             }

package/lib/porter/project/add/add.spec.js

@@ -106,7 +106,7 @@ describe('addProject', () => {
         const { default: createAddCommand } = require('./add');
         const program = createAddCommand();
         yield expect(() => program.parseAsync([
-            'project',
+            '',
             'addProject',
             '--project-name',
             projectNameInvalid,
@@ -125,7 +125,7 @@ describe('addProject', () => {
         const { default: createAddCommand } = require('./add');
         const program = createAddCommand();
         yield expect(() => program.parseAsync([
-            'project',
+            '',
             'addProject',
             '--project-name',
             projectName,
@@ -145,7 +145,7 @@ describe('addProject', () => {
         const { default: createAddCommand } = require('./add');
         const program = createAddCommand();
         yield program.parseAsync([
-            'project',
+            '',
             'addProject',
             '--project-name',
             projectName,
@@ -167,7 +167,7 @@ describe('addProject', () => {
         const { default: createAddCommand } = require('./add');
         const program = createAddCommand();
         yield program.parseAsync([
-            'project',
+            '',
             'addProject',
             '--project-name',
             projectName,
@@ -183,7 +183,7 @@ describe('addProject', () => {
         expect(mockClient.put).not.toHaveBeenCalled();
         expect(PorterUtils.handleCommandError).toHaveBeenCalled();
     }));
-    it('should clean up the directory if project already exists', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('should handle 409 error if project already exists', () => __awaiter(void 0, void 0, void 0, function* () {
         mockClient.put = jest.fn(() => {
             throw new axios_1.AxiosError('Project already exists', '409', undefined, undefined, {
                 data: { status: 409 },
@@ -192,7 +192,7 @@ describe('addProject', () => {
         const { default: createAddCommand } = require('./add');
         const program = createAddCommand();
         yield program.parseAsync([
-            'project',
+            '',
             'addProject',
             '--project-name',
             projectName,
@@ -205,15 +205,8 @@ describe('addProject', () => {
         expect(PorterUtils.buildPorterUrl).toHaveBeenCalled();
         expect(PorterUtils.doesPathExist).toHaveBeenCalled();
         expect(promises_1.default.access).toHaveBeenCalled();
-        // Create project dir, create "stage-configs" directory, create directories for (crawl, index, template-dedupe, report)
-        // But validation stage is not created (PERSONIZE-771)
-        expect(promises_1.default.mkdir).toHaveBeenCalledTimes(6);
-        // Create project config.json as well as 4 example config.json (for each stage)
-        // But validation stage is not created (PERSONIZE-771)
-        expect(promises_1.default.writeFile).toHaveBeenCalledTimes(5);
-        expect(promises_1.default.writeFile).toHaveBeenNthCalledWith(1, expect.any(String), expect.stringContaining(mockCliVersion));
         expect(mockClient.put).toHaveBeenCalled();
-        expect(promises_1.default.rm).toHaveBeenCalled();
+        expect(promises_1.default.mkdir).not.toHaveBeenCalled();
         expect(PorterUtils.handleError).toHaveBeenCalled();
         expect(PorterUtils.handleCommandError).not.toHaveBeenCalled();
     }));
@@ -221,7 +214,7 @@ describe('addProject', () => {
         const { default: createAddCommand } = require('./add');
         const program = createAddCommand();
         yield program.parseAsync([
-            'project',
+            '',
             'addProject',
             '--project-name',
             projectName,
@@ -248,7 +241,7 @@ describe('addProject', () => {
         const { default: createAddCommand } = require('./add');
         const program = createAddCommand();
         yield program.parseAsync([
-            'project',
+            '',
             'addProject',
             '--project-name',
             projectName,

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

@@ -16,7 +16,6 @@ exports.throwErrorIfNotLoggedIn = exports.handleError = exports.handleCommandErr
 const axios_1 = __importDefault(require("axios"));
 const chalk_1 = __importDefault(require("chalk"));
 const ApplicationStore_1 = require("../../../ApplicationStore");
-const CheckAuthorisation_1 = require("../AuthUtils/CheckAuthorisation");
 const constants_1 = require("../../constants");
 function handleCommandError(command, error) {
     if (!axios_1.default.isAxiosError(error)) {
@@ -32,7 +31,7 @@ function handleCommandError(command, error) {
         return command.error(chalk_1.default.red(error.message));
     }
     if (error.response.status === 401 || error.response.status === 403) {
-        return command.error(chalk_1.default.red(constants_1.PORTER_ERRORS.loginError));
+        return command.error(chalk_1.default.red(constants_1.PORTER_ERRORS.loginPermissionError));
     }
     if (error.response.status >= 500) {
         const errorMessage = `Action failed. Service responded with "${error.response.status}" response code`;
@@ -60,11 +59,7 @@ 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(constants_1.PORTER_ERRORS.loginError));
+            return command.error(chalk_1.default.red(constants_1.PORTER_ERRORS.loginError));
         }
     });
 }

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

@@ -35,7 +35,6 @@ 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");
 const constants_1 = require("../../constants");
 describe('handleCommandError', () => {
@@ -96,7 +95,7 @@ describe('handleCommandError', () => {
         }));
         expect(stderrSpy).toHaveBeenCalledTimes(1);
         // read the mock call strings directly otherwise colours cause test failures with .toEqual()
-        expect(stderrSpy.mock.calls[0][0]).toContain(constants_1.PORTER_ERRORS.loginError);
+        expect(stderrSpy.mock.calls[0][0]).toContain(constants_1.PORTER_ERRORS.loginPermissionError);
     }));
     it('correctly displays the console logs for invalid-params errors from the porter service', () => __awaiter(void 0, void 0, void 0, function* () {
         const command = new commander_1.Command();
@@ -163,17 +162,6 @@ describe('throwErrorIfNotLoggedIn', () => {
             .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(constants_1.PORTER_ERRORS.loginError);
         expect(process.exit).toHaveBeenCalled();
     }));
@@ -181,9 +169,6 @@ describe('throwErrorIfNotLoggedIn', () => {
         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/index.d.ts

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

package/lib/porter/utils/index.js

@@ -14,9 +14,8 @@ 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("./BuildDXPUrl/BuildDXPUrl"), exports);
+__exportStar(require("./BuildPorterUrl/BuildPorterUrl"), exports);
 __exportStar(require("./CoreUtils/CoreUtils"), exports);
 __exportStar(require("./DoesPathExist/DoesPathExist"), exports);
 __exportStar(require("./ErrorUtils/ErrorUtils"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.15.0",
+  "version": "5.16.0",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },

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

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

package/lib/porter/port/portCommand.js

@@ -1,19 +0,0 @@
-"use strict";
-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 abort_1 = __importDefault(require("./abort/abort"));
-const get_1 = __importDefault(require("./get/get"));
-const start_1 = __importDefault(require("./start/start"));
-const createPortCommand = () => {
-    const portCommand = new commander_1.Command('port');
-    portCommand
-        .description('Porter port commands')
-        .addCommand((0, start_1.default)())
-        .addCommand((0, get_1.default)())
-        .addCommand((0, abort_1.default)());
-    return portCommand;
-};
-exports.default = createPortCommand;

package/lib/porter/project/projectCommand.d.ts

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

package/lib/porter/project/projectCommand.js

@@ -1,19 +0,0 @@
-"use strict";
-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 get_1 = __importDefault(require("./get/get"));
-const add_1 = __importDefault(require("./add/add"));
-const remove_1 = __importDefault(require("./remove/remove"));
-const createProjectCommand = () => {
-    const projectCommand = new commander_1.Command('project');
-    projectCommand
-        .description('Porter project commands')
-        .addCommand((0, add_1.default)())
-        .addCommand((0, get_1.default)())
-        .addCommand((0, remove_1.default)());
-    return projectCommand;
-};
-exports.default = createProjectCommand;

package/lib/porter/utils/AuthUtils/CheckAuthorisation.d.ts

@@ -1 +0,0 @@
-export declare function checkAuthorisation(): Promise<boolean>;

package/lib/porter/utils/AuthUtils/CheckAuthorisation.js

@@ -1,32 +0,0 @@
-"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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkAuthorisation = void 0;
-const ApiService_1 = require("../../../ApiService");
-const BuildPorterUrl_1 = require("../BuildPorterUrl/BuildPorterUrl");
-const CoreUtils_1 = require("../CoreUtils/CoreUtils");
-function checkAuthorisation() {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const baseUrl = yield (0, BuildPorterUrl_1.buildPorterUrl)();
-            const apiService = new ApiService_1.ApiService(CoreUtils_1.validateAxiosStatus, baseUrl);
-            const healthEndpoint = '/health';
-            const response = yield apiService.client.get(healthEndpoint);
-            return response.status === 200;
-        }
-        catch (err) {
-            (0, CoreUtils_1.logDebug)('Error while checking auth');
-            (0, CoreUtils_1.logDebug)(err);
-            return false;
-        }
-    });
-}
-exports.checkAuthorisation = checkAuthorisation;

package/lib/porter/utils/AuthUtils/CheckAuthorisation.spec.d.ts

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

package/lib/porter/utils/AuthUtils/CheckAuthorisation.spec.js

@@ -1,77 +0,0 @@
-"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 ApiService = __importStar(require("../../../ApiService"));
-const BuildPorterUrl = __importStar(require("../BuildPorterUrl/BuildPorterUrl"));
-const CheckAuthorisation_1 = require("./CheckAuthorisation");
-describe('checkAuthorisation', () => {
-    beforeEach(() => {
-        jest.resetAllMocks();
-    });
-    it('should return false if failed to construct the porter url', () => __awaiter(void 0, void 0, void 0, function* () {
-        jest.spyOn(BuildPorterUrl, 'buildPorterUrl').mockImplementationOnce(() => {
-            throw new Error();
-        });
-        const isAuthorised = yield (0, CheckAuthorisation_1.checkAuthorisation)();
-        expect(isAuthorised).toEqual(false);
-    }));
-    it('should return false if the health endpoint return with a non-200 status', () => __awaiter(void 0, void 0, void 0, function* () {
-        jest
-            .spyOn(BuildPorterUrl, 'buildPorterUrl')
-            .mockReturnValue(Promise.resolve('1234'));
-        jest.spyOn(ApiService, 'ApiService').mockImplementationOnce(() => {
-            return {
-                client: {
-                    get: jest.fn(() => Promise.resolve({ status: 401 })),
-                },
-            };
-        });
-        const isAuthorised = yield (0, CheckAuthorisation_1.checkAuthorisation)();
-        expect(isAuthorised).toEqual(false);
-    }));
-    it('should return true if the health endpoint returns with 200 status', () => __awaiter(void 0, void 0, void 0, function* () {
-        jest
-            .spyOn(BuildPorterUrl, 'buildPorterUrl')
-            .mockImplementationOnce(() => Promise.resolve('1234'));
-        jest.spyOn(ApiService, 'ApiService').mockImplementationOnce(() => {
-            return {
-                client: {
-                    get: jest.fn(() => Promise.resolve({ status: 200 })),
-                },
-            };
-        });
-        const isAuthorised = yield (0, CheckAuthorisation_1.checkAuthorisation)();
-        expect(isAuthorised).toEqual(true);
-    }));
-});