@squiz/dxp-cli-next 5.6.0-develop.5 → 5.6.0-develop.7

package/lib/job-runner/job/listJobs/listJobs.js

@@ -21,7 +21,10 @@ const createListJobsCommand = () => {
     const listJobsCommand = new commander_1.Command('listJobs')
         .name('listJobs')
         .description('List all jobs')
-        .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to deploy to. If not provided will use configured tenant from login'))
+        .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'))
         .configureOutput({
         outputError(str, write) {
             write(chalk_1.default.red(str));
@@ -32,22 +35,21 @@ const createListJobsCommand = () => {
         const spinner = (0, ora_1.default)('Retrieving jobs').start();
         try {
             const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
-            const listJobsUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/job`;
+            let listJobsUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/job/latest?`;
+            listJobsUrl = (0, utils_1.addPaginationToUrl)(listJobsUrl, {
+                before: options.before,
+                after: options.after,
+                size: options.size,
+            });
             const res = yield apiService.client.get(listJobsUrl);
-            if (Array.isArray(res.data) && res.data.length > 0) {
-                spinner.succeed(`Retrieved ${res.data.length} jobs`);
-                (0, utils_1.writeLineSeparator)();
-                res.data.forEach((element) => {
-                    Object.keys(element).forEach(key => {
-                        console.log(`${key}: ${element[key]}`);
-                    });
-                    (0, utils_1.writeLineSeparator)();
-                });
-                return;
+            if (Array.isArray(res.data.data) && res.data.data.length > 0) {
+                spinner.succeed(`Retrieved ${res.data.data.length} jobs`);
+                yield (0, utils_1.logArrayResults)(res.data.data, res.data.links);
             }
             else {
                 spinner.succeed('No jobs found');
             }
+            return;
         }
         catch (error) {
             spinner.fail();

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

@@ -14,13 +14,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const nock_1 = __importDefault(require("nock"));
 const listJobs_1 = __importDefault(require("./listJobs"));
-const chalk_1 = __importDefault(require("chalk"));
 const logSpy = jest.spyOn(global.console, 'log');
 describe('listJobs', () => {
     it('correctly lists the job', () => __awaiter(void 0, void 0, void 0, function* () {
         process.env.ENABLE_OVERRIDE_JOB_RUNNER_URL = 'true';
         (0, nock_1.default)('http://localhost:9999')
-            .get('/job')
+            .get('/job/latest?&page[size]=5')
             .reply(200, [{ name: 'simple-job', type: 'job', version: '1.0.0' }]);
         const program = (0, listJobs_1.default)();
         yield program.parseAsync([
@@ -28,6 +27,8 @@ describe('listJobs', () => {
             'dxp-cli',
             'job-runner',
             'listJobs',
+            '-s',
+            'tiny',
             '-t',
             'myTenant',
             '-ou',
@@ -36,10 +37,6 @@ describe('listJobs', () => {
         const opts = program.opts();
         expect(opts.tenant).toEqual('myTenant');
         expect(opts.overrideUrl).toEqual('http://localhost:9999');
-        expect(logSpy).toHaveBeenCalledTimes(5);
-        expect(logSpy).toHaveBeenCalledWith('name: simple-job');
-        expect(logSpy).toHaveBeenCalledWith('type: job');
-        expect(logSpy).toHaveBeenCalledWith('version: 1.0.0');
-        expect(logSpy).toHaveBeenCalledWith(chalk_1.default.cyan('------------------------------'));
+        expect(opts.size).toEqual('tiny');
     }));
 });

package/lib/job-runner/jobContext/listJobContexts.js

@@ -21,7 +21,10 @@ const createListJobContextsCommand = () => {
     const listJobContextsCommand = new commander_1.Command('listJobContexts')
         .name('listJobContexts')
         .description('List all job contexts')
-        .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to deploy to. If not provided will use configured tenant from login'))
+        .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'))
         .configureOutput({
         outputError(str, write) {
             write(chalk_1.default.red(str));
@@ -32,7 +35,12 @@ const createListJobContextsCommand = () => {
         const spinner = (0, ora_1.default)('Retrieving job contexts\r\n').start();
         try {
             const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
-            const listJobContextsUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/job-context`;
+            let listJobContextsUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/job-context?`;
+            listJobContextsUrl = (0, utils_1.addPaginationToUrl)(listJobContextsUrl, {
+                before: options.before,
+                after: options.after,
+                size: options.size,
+            });
             const res = yield apiService.client.get(listJobContextsUrl);
             if (Array.isArray(res.data) && res.data.length > 0) {
                 spinner.succeed(`${res.data.length} contexts successfully retrieved`);

package/lib/job-runner/jobContext/listJobContexts.spec.js

@@ -20,7 +20,7 @@ describe('listJobContexts', () => {
     process.env.ENABLE_OVERRIDE_JOB_RUNNER_URL = 'true';
     it('correctly lists the job contexts', () => __awaiter(void 0, void 0, void 0, function* () {
         (0, nock_1.default)('http://localhost:9999')
-            .get('/job-context')
+            .get('/job-context?')
             .reply(200, [
             {
                 contextName: 'dev',

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

@@ -21,7 +21,7 @@ const createBeginJobCommand = () => {
     const beginJobCommand = new commander_1.Command('beginJob')
         .name('beginJob')
         .description('Add a job to the queue')
-        .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to deploy to. If not provided will use configured tenant from login'))
+        .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('-i, --inputFile <string>', 'Path to the .json input file for the job execution e.g. documents/inputs/myInput.json'))
         .addArgument(new commander_1.Argument('<jobName>', 'Name of the job to pass to the request'))
         .addArgument(new commander_1.Argument('<contextName>', 'Name of the job context to pass to the request'))

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

@@ -21,28 +21,34 @@ const createListJobExecutionsCommand = () => {
     const listJobExecutionsCommand = new commander_1.Command('listJobExecutions')
         .name('listJobExecutions')
         .description('List all job executions')
-        .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to deploy to. If not provided will use configured tenant from login'))
+        .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((options) => __awaiter(void 0, void 0, void 0, function* () {
+        .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);
-            const listJobsUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/executions`;
-            const res = yield apiService.client.get(listJobsUrl);
-            if (Array.isArray(res.data) && res.data.length > 0) {
-                spinner.succeed(`Retrieved ${res.data.length} executions`);
-                (0, utils_1.writeLineSeparator)();
-                res.data.forEach((execution) => {
-                    for (const [key, value] of Object.entries(execution)) {
-                        console.log(`${chalk_1.default.bold([key])}: ${JSON.stringify(value)}`);
-                    }
-                    (0, utils_1.writeLineSeparator)();
-                });
+            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;
         }

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

@@ -14,13 +14,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const nock_1 = __importDefault(require("nock"));
 const listJobExecutions_1 = __importDefault(require("./listJobExecutions"));
-const chalk_1 = __importDefault(require("chalk"));
 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')
+            .get('/executions/jobName/job-runner?&page[size]=5')
             .reply(200, [
             {
                 context: 'dev',
@@ -49,6 +48,8 @@ describe('listJobExecutions', () => {
             'dxp-cli',
             'job-runner',
             'listJobExecutions',
+            '-s',
+            'tiny',
             '-t',
             'myTenant',
             '-ou',
@@ -57,10 +58,6 @@ describe('listJobExecutions', () => {
         const opts = program.opts();
         expect(opts.tenant).toEqual('myTenant');
         expect(opts.overrideUrl).toEqual('http://localhost:9999');
-        expect(logSpy).toHaveBeenCalled();
-        expect(logSpy).toHaveBeenCalledTimes(19);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('status')}: ${JSON.stringify('successfully-completed')}`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('jobName')}: ${JSON.stringify('simple-job')}`);
-        expect(logSpy).toHaveBeenCalledWith(chalk_1.default.cyan('------------------------------'));
+        expect(opts.size).toBe('tiny');
     }));
 });

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

@@ -21,7 +21,7 @@ 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 deploy to. If not provided will use configured tenant from login'))
+        .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'))

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

@@ -5,3 +5,15 @@ export declare function buildJobRunnerUrl(tenantID?: string, overrideUrl?: strin
 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

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateAxiosStatus = exports.writeLineSeparator = exports.readInputFile = exports.buildJobRunnerUrl = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = void 0;
+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");
@@ -92,3 +92,53 @@ 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.js

@@ -90,3 +90,27 @@ describe('readInputFile', () => {
         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.5",
+  "version": "5.6.0-develop.7",
   "repository": {
     "url": "https://gitlab.squiz.net/developer-experience/dxp-cli-next"
   },
@@ -39,7 +39,7 @@
     "codecov"
   ],
   "dependencies": {
-    "@squiz/component-cli-lib": "^1.41.1-alpha",
+    "@squiz/component-cli-lib": "^1.45.1-alpha",
     "axios": "1.1.3",
     "cli-color": "2.0.3",
     "commander": "9.4.0",