@squiz/dxp-cli-next 5.6.0-develop.1 → 5.6.0-develop.11

package/lib/job-runner/jobExecution/beginJob/beginJob.spec.js

@@ -0,0 +1,62 @@
+"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 nock_1 = __importDefault(require("nock"));
+const beginJob_1 = __importDefault(require("./beginJob"));
+const chalk_1 = __importDefault(require("chalk"));
+const path_1 = __importDefault(require("path"));
+const logSpy = jest.spyOn(global.console, 'log');
+describe('beginJob', () => {
+    it('correctly displays the console logs for beginning a job', () => __awaiter(void 0, void 0, void 0, function* () {
+        process.env.ENABLE_OVERRIDE_JOB_RUNNER_URL = 'true';
+        (0, nock_1.default)('http://localhost:9999').post('/executions/begin').reply(200, {
+            context: 'dev',
+            ecsTaskId: null,
+            id: 'd0aab852-365e-42de-a642-eac11bb95ccc',
+            jobName: 'simple-job',
+            status: 'queued',
+            timeFinished: null,
+            timeQueued: '2023-06-23T01:36:44.792Z',
+            timeStarted: null,
+            type: 'jobExecution',
+            version: null,
+        });
+        const program = (0, beginJob_1.default)();
+        yield program.parseAsync([
+            'node',
+            'dxp-cli',
+            'simple-job',
+            'dev',
+            '-i',
+            path_1.default.join('./src/__tests__/job-runner/inputs/input.json'),
+            '-t',
+            'myTenant',
+            '-ou',
+            'http://localhost:9999',
+        ]);
+        const opts = program.opts();
+        const args = program.args;
+        expect(args[0]).toEqual('simple-job');
+        expect(args[1]).toEqual('dev');
+        expect(opts.inputFile).toEqual(path_1.default.join('./src/__tests__/job-runner/inputs/input.json'));
+        expect(opts.tenant).toEqual('myTenant');
+        expect(opts.overrideUrl).toEqual('http://localhost:9999');
+        expect(logSpy).toHaveBeenCalledTimes(12);
+        expect(logSpy).toHaveBeenCalledWith(chalk_1.default.cyan('------------------------------'));
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('context')}: "dev"`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('id')}: "d0aab852-365e-42de-a642-eac11bb95ccc"`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('jobName')}: "simple-job"`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('timeQueued')}: "2023-06-23T01:36:44.792Z"`);
+    }));
+});

package/lib/job-runner/jobExecution/listJobExecutions/listJobExecutions.d.ts

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

package/lib/job-runner/jobExecution/listJobExecutions/listJobExecutions.js

@@ -0,0 +1,65 @@
+"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 createListJobExecutionsCommand = () => {
+    const listJobExecutionsCommand = new commander_1.Command('listJobExecutions')
+        .name('listJobExecutions')
+        .description('List all job executions')
+        .addOption(new commander_1.Option('-s, --size <string>', 'Pagination page size. Choices are tiny (5), small (20), medium (50), large (100). If not included, will default to small').choices(['tiny', 'small', 'medium', 'large']))
+        .addOption(new commander_1.Option('-b, --before <string>', 'Pagination page before token'))
+        .addOption(new commander_1.Option('-a, --after <string>', 'Pagination page after token'))
+        .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to run against. If not provided will use configured tenant from login'))
+        .addArgument(new commander_1.Argument('<jobName>', 'Name of the job to pass to the request'))
+        .configureOutput({
+        outputError(str, write) {
+            write(chalk_1.default.red(str));
+        },
+    })
+        .action((jobName, options) => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(listJobExecutionsCommand);
+        const spinner = (0, ora_1.default)('Retrieving job executions').start();
+        try {
+            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            let listExecutionsUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/executions/jobName/${jobName}?`;
+            listExecutionsUrl = (0, utils_1.addPaginationToUrl)(listExecutionsUrl, {
+                before: options.before,
+                after: options.after,
+                size: options.size,
+            });
+            const res = yield apiService.client.get(listExecutionsUrl);
+            if (Array.isArray(res.data.data) && res.data.data.length > 0) {
+                spinner.succeed(`Retrieved ${res.data.data.length} executions`);
+                yield (0, utils_1.logArrayResults)(res.data.data, res.data.links);
+            }
+            else {
+                spinner.succeed('No executions found');
+            }
+            return;
+        }
+        catch (error) {
+            spinner.fail();
+            (0, utils_1.handleCommandError)(listJobExecutionsCommand, error);
+        }
+    }));
+    if (process.env.ENABLE_OVERRIDE_JOB_RUNNER_URL === 'true') {
+        listJobExecutionsCommand.addOption(new commander_1.Option('-ou, --overrideUrl <string>', 'Developer option to override the entire job runner url with a custom value'));
+    }
+    return listJobExecutionsCommand;
+};
+exports.default = createListJobExecutionsCommand;

package/lib/job-runner/jobExecution/listJobExecutions/listJobExecutions.spec.d.ts

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

package/lib/job-runner/jobExecution/listJobExecutions/listJobExecutions.spec.js

@@ -0,0 +1,63 @@
+"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 nock_1 = __importDefault(require("nock"));
+const listJobExecutions_1 = __importDefault(require("./listJobExecutions"));
+const logSpy = jest.spyOn(global.console, 'log');
+describe('listJobExecutions', () => {
+    it('correctly lists the job executions', () => __awaiter(void 0, void 0, void 0, function* () {
+        process.env.ENABLE_OVERRIDE_JOB_RUNNER_URL = 'true';
+        (0, nock_1.default)('http://localhost:9999')
+            .get('/executions/jobName/job-runner?&page[size]=5')
+            .reply(200, [
+            {
+                context: 'dev',
+                id: 'd0aab852-365e-42de-a642-eac11bb95ccc',
+                jobName: 'simple-job',
+                status: 'successfully-completed',
+                timeFinished: '2023-06-23T01:36:48.345Z',
+                timeQueued: '2023-06-23T01:36:44.792Z',
+                timeStarted: '2023-06-23T01:36:44.792Z',
+                type: 'jobExecution',
+            },
+            {
+                context: 'dev',
+                id: 'e7e8de7c-2c5d-4a78-81d9-76c856ed6a85',
+                jobName: 'simple-job',
+                status: 'successfully-completed',
+                timeFinished: '2023-06-23T01:34:24.669Z',
+                timeQueued: '2023-06-23T01:34:23.627Z',
+                timeStarted: '2023-06-23T01:34:23.627Z',
+                type: 'jobExecution',
+            },
+        ]);
+        const program = (0, listJobExecutions_1.default)();
+        yield program.parseAsync([
+            'node',
+            'dxp-cli',
+            'job-runner',
+            'listJobExecutions',
+            '-s',
+            'tiny',
+            '-t',
+            'myTenant',
+            '-ou',
+            'http://localhost:9999',
+        ]);
+        const opts = program.opts();
+        expect(opts.tenant).toEqual('myTenant');
+        expect(opts.overrideUrl).toEqual('http://localhost:9999');
+        expect(opts.size).toBe('tiny');
+    }));
+});

package/lib/job-runner/jobExecution/terminateJob/terminateJob.d.ts

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

package/lib/job-runner/jobExecution/terminateJob/terminateJob.js

@@ -0,0 +1,62 @@
+"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 createTerminateJobCommand = () => {
+    const terminateJobCommand = new commander_1.Command('terminateJob')
+        .name('terminateJob')
+        .description('Terminate a job in the queue')
+        .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to run against. If not provided will use configured tenant from login'))
+        .addOption(new commander_1.Option('-ou, --overrideUrl <string>', 'Developer option to override the entire job runner url with a custom value'))
+        .addArgument(new commander_1.Argument('<jobName>', 'Name of the job to pass to the request'))
+        .addArgument(new commander_1.Argument('<executionId>', 'Name of the job execution id to pass to the request'))
+        .addArgument(new commander_1.Argument('<reason>', 'Reason for job termination, eg "Cancelling due to mistake in inputs"'))
+        .configureOutput({
+        outputError(str, write) {
+            write(chalk_1.default.red(str));
+        },
+    })
+        .action((jobName, executionId, reason, options) => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(terminateJobCommand);
+        const spinner = (0, ora_1.default)('Terminating job').start();
+        console.log('');
+        try {
+            const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+            const terminateJobUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/executions/terminate`;
+            const res = yield apiService.client.post(terminateJobUrl, {
+                jobName: jobName,
+                executionId: executionId,
+                reason: reason,
+            });
+            for (const [key, value] of Object.entries(res.data)) {
+                console.log(`${chalk_1.default.bold([key])}: ${JSON.stringify(value)}`);
+            }
+            spinner.succeed('Job terminated');
+            return;
+        }
+        catch (error) {
+            spinner.fail();
+            (0, utils_1.handleCommandError)(terminateJobCommand, error);
+        }
+    }));
+    if (process.env.ENABLE_OVERRIDE_JOB_RUNNER_URL === 'true') {
+        terminateJobCommand.addOption(new commander_1.Option('-ou, --overrideUrl <string>', 'Developer option to override the entire job runner url with a custom value'));
+    }
+    return terminateJobCommand;
+};
+exports.default = createTerminateJobCommand;

package/lib/job-runner/jobExecution/terminateJob/terminateJob.spec.d.ts

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

package/lib/job-runner/jobExecution/terminateJob/terminateJob.spec.js

@@ -0,0 +1,60 @@
+"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 nock_1 = __importDefault(require("nock"));
+const terminateJob_1 = __importDefault(require("./terminateJob"));
+const chalk_1 = __importDefault(require("chalk"));
+const logSpy = jest.spyOn(global.console, 'log');
+describe('terminateJob', () => {
+    process.env.ENABLE_OVERRIDE_JOB_RUNNER_URL = 'true';
+    it('correctly displays the console logs for terminating the job', () => __awaiter(void 0, void 0, void 0, function* () {
+        (0, nock_1.default)('http://localhost:9999').post('/executions/terminate').reply(200, {
+            context: 'dev',
+            ecsTaskId: '1233445',
+            id: 'simple-job-d6a418eb-dd63-4594-b299-07410ccd30d5',
+            jobName: 'simple-job',
+            status: 'terminated',
+            timeFinished: '2023-06-23T01:49:09.433Z',
+            timeQueued: '2023-06-23T01:49:09.431Z',
+            timeStarted: '2023-06-23T00:49:09.433Z',
+            type: 'jobExecution',
+            version: '1.0.1',
+        });
+        const program = (0, terminateJob_1.default)();
+        yield program.parseAsync([
+            'node',
+            'dxp-cli',
+            'simple-job',
+            '907fc4e5-8b4a-4e47-bab0-e95e45385347',
+            'test termination',
+            '-t',
+            'myTenant',
+            '-ou',
+            'http://localhost:9999',
+        ]);
+        const opts = program.opts();
+        const args = program.args;
+        expect(args[0]).toEqual('simple-job');
+        expect(args[1]).toEqual('907fc4e5-8b4a-4e47-bab0-e95e45385347');
+        expect(opts.tenant).toEqual('myTenant');
+        expect(opts.overrideUrl).toEqual('http://localhost:9999');
+        expect(logSpy).toHaveBeenCalledTimes(11);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('status')}: ${JSON.stringify('terminated')}`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('jobName')}: ${JSON.stringify('simple-job')}`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('id')}: ${JSON.stringify('simple-job-d6a418eb-dd63-4594-b299-07410ccd30d5')}`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('context')}: ${JSON.stringify('dev')}`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('timeFinished')}: ${JSON.stringify('2023-06-23T01:49:09.433Z')}`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('version')}: ${JSON.stringify('1.0.1')}`);
+    }));
+});

package/lib/job-runner/utils.d.ts

@@ -0,0 +1,19 @@
+import { Command } from 'commander';
+export declare function handleCommandError(command: Command, error: Error): void;
+export declare function throwErrorIfNotLoggedIn(command: Command): Promise<void>;
+export declare function buildJobRunnerUrl(tenantID?: string, overrideUrl?: string): Promise<string>;
+export declare function readInputFile(inputPath: string): Promise<any>;
+export declare function writeLineSeparator(): void;
+export declare function validateAxiosStatus(status: number): boolean;
+export declare function addPaginationToUrl(url: string, opts: PaginationOpts): string;
+export declare function logArrayResults(results: Array<any>, links?: PaginationLinks): Promise<void>;
+interface PaginationLinks {
+    prev: string;
+    next: string;
+}
+interface PaginationOpts {
+    before: string;
+    after: string;
+    size: 'tiny' | 'small' | 'medium' | 'large';
+}
+export {};

package/lib/job-runner/utils.js

@@ -0,0 +1,144 @@
+"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.logArrayResults = exports.addPaginationToUrl = exports.validateAxiosStatus = exports.writeLineSeparator = exports.readInputFile = exports.buildJobRunnerUrl = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = void 0;
+const fs_1 = __importDefault(require("fs"));
+const chalk_1 = __importDefault(require("chalk"));
+const ApplicationConfig_1 = require("../ApplicationConfig");
+const axios_1 = __importDefault(require("axios"));
+const ApplicationStore_1 = require("../ApplicationStore");
+function handleCommandError(command, error) {
+    var _a, _b, _c, _d;
+    if (axios_1.default.isAxiosError(error)) {
+        let message = `${error.message}`;
+        if ((_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message) {
+            message += `: ${error.response.data.message}`;
+        }
+        if ((_d = (_c = error.response) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.details) {
+            message += ` - ${error.response.data.details}`;
+        }
+        command.error(chalk_1.default.red(message));
+    }
+    else {
+        if (!!process.env.DEBUG && error.stack) {
+            command.error(error.stack);
+        }
+        if (error.message) {
+            command.error(chalk_1.default.red(error.message));
+        }
+        else {
+            command.error(chalk_1.default.red('An unknown error occurred'));
+        }
+    }
+}
+exports.handleCommandError = handleCommandError;
+function throwErrorIfNotLoggedIn(command) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!(yield (0, ApplicationStore_1.getApplicationFile)(ApplicationStore_1.STORE_FILES.sessionCookie))) {
+            command.error(chalk_1.default.red('You must login to interact with the job runner. See `dxp-next auth login`'));
+        }
+    });
+}
+exports.throwErrorIfNotLoggedIn = throwErrorIfNotLoggedIn;
+function buildJobRunnerUrl(tenantID, overrideUrl) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!overrideUrl) {
+            const existingConfig = yield (0, ApplicationConfig_1.fetchApplicationConfig)(tenantID);
+            return `${existingConfig.baseUrl}/__dxp/${existingConfig.region}/job-runner/${existingConfig.tenant}`;
+        }
+        else {
+            return overrideUrl;
+        }
+    });
+}
+exports.buildJobRunnerUrl = buildJobRunnerUrl;
+function readInputFile(inputPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (inputPath.endsWith('.json')) {
+            if (fs_1.default.existsSync(inputPath)) {
+                try {
+                    return JSON.parse(fs_1.default.readFileSync(inputPath, { encoding: 'utf-8' }));
+                }
+                catch (e) {
+                    throw new Error(`Unable to read file ${inputPath} - ${e.message}`);
+                }
+            }
+            else {
+                throw new Error('Input could not be found');
+            }
+        }
+        else {
+            throw new Error('Input must be a .json file');
+        }
+    });
+}
+exports.readInputFile = readInputFile;
+function writeLineSeparator() {
+    console.log(chalk_1.default.cyan('------------------------------'));
+}
+exports.writeLineSeparator = writeLineSeparator;
+function validateAxiosStatus(status) {
+    return status < 400;
+}
+exports.validateAxiosStatus = validateAxiosStatus;
+function addPaginationToUrl(url, opts) {
+    if (opts.before && opts.after) {
+        throw new Error('Only one of before and after can be set');
+    }
+    if (opts.size) {
+        url += `&page[size]=${PaginationPageLimit[opts.size]}`;
+    }
+    else {
+        `&page[size]=${PaginationPageLimit.small}`;
+    }
+    if (opts.before) {
+        url += `&page[before]=${opts.before}`;
+    }
+    if (opts.after) {
+        url += `&page[after]=${opts.after}`;
+    }
+    return url;
+}
+exports.addPaginationToUrl = addPaginationToUrl;
+function logArrayResults(results, links) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (Array.isArray(results) && results.length > 0) {
+            writeLineSeparator();
+            results.forEach((res) => {
+                for (const [key, value] of Object.entries(res)) {
+                    console.log(`${chalk_1.default.bold([key])}: ${JSON.stringify(value)}`);
+                }
+                writeLineSeparator();
+            });
+        }
+        if (links) {
+            const afterStr = 'page[after]=';
+            console.log(`${chalk_1.default.bold('nextPageToken')}: ${links.next !== null
+                ? links.next.slice(links.next.lastIndexOf(afterStr) + afterStr.length)
+                : null}`);
+            const beforeStr = 'page[before]=';
+            console.log(`${chalk_1.default.bold('prevPageToken')}: ${links.prev !== null
+                ? links.prev.slice(links.prev.lastIndexOf(beforeStr) + beforeStr.length)
+                : null}`);
+        }
+    });
+}
+exports.logArrayResults = logArrayResults;
+var PaginationPageLimit;
+(function (PaginationPageLimit) {
+    PaginationPageLimit[PaginationPageLimit["tiny"] = 5] = "tiny";
+    PaginationPageLimit[PaginationPageLimit["small"] = 20] = "small";
+    PaginationPageLimit[PaginationPageLimit["medium"] = 50] = "medium";
+    PaginationPageLimit[PaginationPageLimit["large"] = 100] = "large";
+})(PaginationPageLimit || (PaginationPageLimit = {}));

package/lib/job-runner/utils.spec.d.ts

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

package/lib/job-runner/utils.spec.js

@@ -0,0 +1,116 @@
+"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 utils_1 = require("./utils");
+const commander_1 = require("commander");
+const axios_1 = require("axios");
+const chalk_1 = __importDefault(require("chalk"));
+const path_1 = __importDefault(require("path"));
+const exitSpy = jest.spyOn(process, 'exit').mockImplementation(() => {
+    return undefined;
+}); // prevent process exit on error
+const stderrSpy = jest.spyOn(process.stderr, 'write');
+const logSpy = jest.spyOn(global.console, 'log');
+beforeEach(() => {
+    jest.resetAllMocks();
+});
+describe('handleCommandError', () => {
+    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, utils_1.handleCommandError)(command, new Error(message));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        console.log(stderrSpy.mock.calls);
+        // 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 error', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        const message = 'Something bad happened';
+        const responseMessage = 'I am an error response';
+        const errDetails = 'i am error details';
+        (0, utils_1.handleCommandError)(command, new axios_1.AxiosError(message, '500', undefined, undefined, {
+            data: { message: responseMessage, details: errDetails },
+        }));
+        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}: ${responseMessage} - ${errDetails}`);
+    }));
+    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, utils_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');
+    }));
+});
+describe('writeLineSeparator', () => {
+    it('correctly displays the console logs for line separator', () => __awaiter(void 0, void 0, void 0, function* () {
+        (0, utils_1.writeLineSeparator)();
+        expect(logSpy).toHaveBeenCalledTimes(1);
+        expect(logSpy).toHaveBeenCalledWith(chalk_1.default.cyan('------------------------------'));
+    }));
+});
+describe('validateAxiosStatus', () => {
+    it('correctly validates the status', () => __awaiter(void 0, void 0, void 0, function* () {
+        expect((0, utils_1.validateAxiosStatus)(200)).toBe(true);
+        expect((0, utils_1.validateAxiosStatus)(400)).toBe(false);
+    }));
+});
+describe('buildJobRunnerUrl', () => {
+    it('correctly builds the url with override set ', () => __awaiter(void 0, void 0, void 0, function* () {
+        const url = yield (0, utils_1.buildJobRunnerUrl)(undefined, 'http://localhost:9999/someTenant');
+        expect(url).toBe('http://localhost:9999/someTenant');
+    }));
+});
+describe('readInputFile', () => {
+    it('correctly reads the file ', () => __awaiter(void 0, void 0, void 0, function* () {
+        const res = yield (0, utils_1.readInputFile)(path_1.default.join('./src/__tests__/job-runner/inputs/input.json'));
+        expect(res).toStrictEqual({ something: 'amazing' });
+    }));
+    it('errors if file extension is not .json', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield expect((0, utils_1.readInputFile)(path_1.default.join('./src/__tests__/job-runner/simple-job/main.js'))).rejects.toThrow('Input must be a .json file');
+    }));
+    it('errors if file does not exist', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield expect((0, utils_1.readInputFile)(path_1.default.join('./src/__tests__/job-runner/simple-job/input.json'))).rejects.toThrow('Input could not be found');
+    }));
+    it('errors if file has json extension but cannot be parsed', () => __awaiter(void 0, void 0, void 0, function* () {
+        const source = './src/__tests__/job-runner/inputs/badInput.json';
+        yield expect((0, utils_1.readInputFile)(path_1.default.join(source))).rejects.toThrow(`Unable to read file ${path_1.default.join(source)} - Unexpected token i in JSON at position 1`);
+    }));
+});
+describe('addPaginationToUrl', () => {
+    it('correctly adds the pagination size param to the url', () => __awaiter(void 0, void 0, void 0, function* () {
+        const url = (0, utils_1.addPaginationToUrl)('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?', { size: 'tiny', before: '', after: '' });
+        expect(url).toBe('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?&page[size]=5');
+    }));
+    it('correctly adds the pagination params to the url', () => __awaiter(void 0, void 0, void 0, function* () {
+        const url = (0, utils_1.addPaginationToUrl)('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?', { size: 'tiny', before: '12345', after: '' });
+        expect(url).toBe('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?&page[size]=5&page[before]=12345');
+    }));
+    it('correctly throws error for before and after params', () => __awaiter(void 0, void 0, void 0, function* () {
+        expect(() => {
+            (0, utils_1.addPaginationToUrl)('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?', { size: 'tiny', before: '12345', after: '54321' });
+        }).toThrow('Only one of before and after can be set');
+    }));
+});
+describe('logArrayResults', () => {
+    it('correctly logs results with links', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, utils_1.logArrayResults)([{ something: 'awesome' }, { somethingElse: 'also awesome' }], { next: 'page[after]=12345', prev: 'page[before]=1234' });
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('something')}: "awesome"`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('somethingElse')}: "also awesome"`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('prevPageToken')}: 1234`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('nextPageToken')}: 12345`);
+    }));
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.6.0-develop.1",
+  "version": "5.6.0-develop.11",
   "repository": {
     "url": "https://gitlab.squiz.net/developer-experience/dxp-cli-next"
   },
@@ -39,12 +39,14 @@
     "codecov"
   ],
   "dependencies": {
-    "@squiz/component-cli-lib": "1.32.1-alpha.17",
+    "@squiz/component-cli-lib": "^1.51.1-alpha",
     "axios": "1.1.3",
     "cli-color": "2.0.3",
     "commander": "9.4.0",
+    "dotenv": "^16.3.1",
     "env-paths": "2.2.1",
     "inquirer": "8.2.5",
+    "ora": "^5.4.1",
     "prompt": "^1.3.0",
     "tough-cookie": "4.1.2",
     "update-notifier": "5.1.0"
@@ -74,6 +76,7 @@
     "husky": "8.0.1",
     "jest": "28.1.3",
     "lint-staged": "13.0.3",
+    "nock": "^13.3.1",
     "prettier": "2.7.1",
     "semantic-release": "19.0.3",
     "ts-jest": "28.0.7",