@squiz/dxp-cli-next 5.6.0-develop.2 → 5.6.0-develop.4

package/lib/cmp/init.js

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -16,6 +27,7 @@ const commander_1 = require("commander");
 const cli_color_1 = __importDefault(require("cli-color"));
 const component_cli_lib_1 = require("@squiz/component-cli-lib");
 const child_process_1 = require("child_process");
+const inquirer_1 = require("inquirer");
 var componentTypes;
 (function (componentTypes) {
     componentTypes["basic"] = "basic";
@@ -29,7 +41,13 @@ const initCommand = new commander_1.Command()
     .choices(['basic', 'advanced'])
     .default('basic'))
     .addOption(new commander_1.Option('-i, --install', 'Install dependencies after creating component').default(false))
-    .action((destination, { type: componentType, install }) => __awaiter(void 0, void 0, void 0, function* () {
+    .addOption(new commander_1.Option('--name <string>', 'Name of the component'))
+    .addOption(new commander_1.Option('--display-name <string>', 'Display name of the component'))
+    .addOption(new commander_1.Option('--description <string>', 'Description of the component'))
+    .addOption(new commander_1.Option('--namespace <string>', 'Namespace of the component'))
+    .addOption(new commander_1.Option('--ci', 'Skip user prompts').default(false))
+    .action((destination, _a) => __awaiter(void 0, void 0, void 0, function* () {
+    var { type: componentType, install, ci } = _a, prompts = __rest(_a, ["type", "install", "ci"]);
     if (!componentType || componentTypeIsValid(componentType) === false) {
         initCommand.error(cli_color_1.default.red('Invalid component type. Must be one of: basic, advanced'));
         return;
@@ -38,9 +56,15 @@ const initCommand = new commander_1.Command()
         initCommand.error(cli_color_1.default.red('Component type "basic" does not come with a package.json file, install is not a valid option'));
         return;
     }
+    if (!ci)
+        prompts = yield handleManifestPrompts(prompts);
     console.log(`Creating ${componentType} component in ${destination}...`);
     try {
-        yield (0, component_cli_lib_1.componentInit)({ componentType, destination });
+        yield (0, component_cli_lib_1.componentInit)({
+            componentType,
+            destination,
+            prompts,
+        });
         if (install) {
             console.log('Installing dependencies');
             (0, child_process_1.execSync)('npm i', {
@@ -65,3 +89,17 @@ function componentTypeIsValid(componentType) {
     return componentType === 'basic' || componentType == 'advanced';
 }
 exports.default = initCommand;
+function handleManifestPrompts(existingPrompts) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const promptKeys = ['name', 'displayName', 'description', 'namespace'];
+        const prompts = promptKeys
+            .filter(key => key in existingPrompts === false)
+            .map(key => ({
+            type: 'input',
+            name: key,
+            message: `What is the component ${key}?`,
+        }));
+        const response = yield (0, inquirer_1.prompt)(prompts);
+        return Object.assign(Object.assign({}, response), existingPrompts);
+    });
+}

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

@@ -21,7 +21,7 @@ describe('upload job', () => {
         yield program.parseAsync([
             'node',
             'dxp-cli',
-            './src/__tests__/jobrunner/simple-job',
+            './src/__tests__/job-runner/simple-job',
             '-t',
             'myTenant',
             '-ou',
@@ -29,7 +29,7 @@ describe('upload job', () => {
         ]);
         const opts = program.opts();
         const args = program.args;
-        expect(args[0]).toEqual('./src/__tests__/jobrunner/simple-job');
+        expect(args[0]).toEqual('./src/__tests__/job-runner/simple-job');
         expect(opts.tenant).toEqual('myTenant');
         expect(opts.overrideUrl).toEqual('http://localhost:9999');
         expect(logSpy).toHaveBeenCalledTimes(4);

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

@@ -40,7 +40,7 @@ const createListJobContextsCommand = () => {
                 res.data.forEach((context) => {
                     console.log(`${chalk_1.default.green(chalk_1.default.bold(context.contextName))}: ${chalk_1.default.green(context.description)}`);
                     for (const [key, value] of Object.entries(context.environment)) {
-                        console.log(`${chalk_1.default.bold(key)}: ${value}`);
+                        console.log(`${chalk_1.default.bold(key)}: ${JSON.stringify(value)}`);
                     }
                     (0, utils_1.writeLineSeparator)();
                 });

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

@@ -57,8 +57,8 @@ describe('listJobContexts', () => {
         expect(opts.overrideUrl).toEqual('http://localhost:9999');
         expect(logSpy).toHaveBeenCalledTimes(9);
         expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.green(chalk_1.default.bold('dev'))}: ${chalk_1.default.green('dev context')}`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('something')}: cool`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('somethingElse')}: cooler`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('something')}: ${JSON.stringify('cool')}`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('somethingElse')}: ${JSON.stringify('cooler')}`);
         expect(logSpy).toHaveBeenCalledWith(chalk_1.default.cyan('------------------------------'));
     }));
 });

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

@@ -22,29 +22,34 @@ const createBeginJobCommand = () => {
         .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('-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'))
-        .addArgument(new commander_1.Argument('<inputSource>', 'Path to the .json input file for the job execution'))
         .configureOutput({
         outputError(str, write) {
             write(chalk_1.default.red(str));
         },
     })
-        .action((jobName, contextName, inputSource, options) => __awaiter(void 0, void 0, void 0, function* () {
+        .action((jobName, contextName, options) => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, utils_1.throwErrorIfNotLoggedIn)(beginJobCommand);
         const spinner = (0, ora_1.default)('Queueing job').start();
         console.log('');
+        let input;
         try {
+            if (options.inputFile) {
+                input = yield (0, utils_1.readInputFile)(options.inputFile);
+            }
             const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
             const beginJobUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/executions/begin`;
             const res = yield apiService.client.post(beginJobUrl, {
                 jobName: jobName,
                 context: contextName,
+                input: input ? input : null,
             });
             spinner.succeed('Job queued successfully');
             (0, utils_1.writeLineSeparator)();
             for (const [key, value] of Object.entries(res.data)) {
-                console.log(`${chalk_1.default.bold([key])}: ${value}`);
+                console.log(`${chalk_1.default.bold([key])}: ${JSON.stringify(value)}`);
             }
             return;
         }

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

@@ -15,6 +15,7 @@ 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* () {
@@ -37,7 +38,8 @@ describe('beginJob', () => {
             'dxp-cli',
             'simple-job',
             'dev',
-            'myinputs/input',
+            '-i',
+            path_1.default.join('./src/__tests__/job-runner/inputs/input.json'),
             '-t',
             'myTenant',
             '-ou',
@@ -47,15 +49,14 @@ describe('beginJob', () => {
         const args = program.args;
         expect(args[0]).toEqual('simple-job');
         expect(args[1]).toEqual('dev');
-        expect(args[2]).toEqual('myinputs/input');
+        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.bold('status')}: queued`);
-        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('status')}: queued`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('timeQueued')}: 2023-06-23T01:36:44.792Z`);
         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.js

@@ -39,7 +39,7 @@ const createListJobExecutionsCommand = () => {
                 (0, utils_1.writeLineSeparator)();
                 res.data.forEach((execution) => {
                     for (const [key, value] of Object.entries(execution)) {
-                        console.log(`${chalk_1.default.bold([key])}: ${value}`);
+                        console.log(`${chalk_1.default.bold([key])}: ${JSON.stringify(value)}`);
                     }
                     (0, utils_1.writeLineSeparator)();
                 });

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

@@ -59,8 +59,8 @@ describe('listJobExecutions', () => {
         expect(opts.overrideUrl).toEqual('http://localhost:9999');
         expect(logSpy).toHaveBeenCalled();
         expect(logSpy).toHaveBeenCalledTimes(19);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('status')}: successfully-completed`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('jobName')}: simple-job`);
+        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('------------------------------'));
     }));
 });

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

@@ -25,12 +25,13 @@ const createTerminateJobCommand = () => {
         .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, options) => __awaiter(void 0, void 0, void 0, function* () {
+        .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('');
@@ -39,10 +40,11 @@ const createTerminateJobCommand = () => {
             const terminateJobUrl = `${yield (0, utils_1.buildJobRunnerUrl)(options.tenant, options.overrideUrl)}/executions/terminate`;
             const res = yield apiService.client.post(terminateJobUrl, {
                 jobName: jobName,
-                id: executionId,
+                executionId: executionId,
+                reason: reason,
             });
             for (const [key, value] of Object.entries(res.data)) {
-                console.log(`${chalk_1.default.bold([key])}: ${value}`);
+                console.log(`${chalk_1.default.bold([key])}: ${JSON.stringify(value)}`);
             }
             spinner.succeed('Job terminated');
             return;

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

@@ -37,6 +37,7 @@ describe('terminateJob', () => {
             'dxp-cli',
             'simple-job',
             '907fc4e5-8b4a-4e47-bab0-e95e45385347',
+            'test termination',
             '-t',
             'myTenant',
             '-ou',
@@ -49,11 +50,11 @@ describe('terminateJob', () => {
         expect(opts.tenant).toEqual('myTenant');
         expect(opts.overrideUrl).toEqual('http://localhost:9999');
         expect(logSpy).toHaveBeenCalledTimes(11);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('status')}: terminated`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('jobName')}: simple-job`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('id')}: simple-job-d6a418eb-dd63-4594-b299-07410ccd30d5`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('context')}: dev`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('timeFinished')}: 2023-06-23T01:49:09.433Z`);
-        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('version')}: 1.0.1`);
+        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

@@ -2,5 +2,6 @@ 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;

package/lib/job-runner/utils.js

@@ -12,15 +12,23 @@ 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.buildJobRunnerUrl = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = void 0;
+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;
+    var _a, _b, _c, _d;
     if (axios_1.default.isAxiosError(error)) {
-        command.error(chalk_1.default.red(`${error.message}: ${(_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message}`));
+        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) {
@@ -55,6 +63,27 @@ function buildJobRunnerUrl(tenantID, 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('------------------------------'));
 }

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

@@ -16,6 +16,7 @@ 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
@@ -38,12 +39,13 @@ describe('handleCommandError', () => {
         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 },
+            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}`);
+        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();
@@ -72,3 +74,19 @@ describe('buildJobRunnerUrl', () => {
         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`);
+    }));
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.6.0-develop.2",
+  "version": "5.6.0-develop.4",
   "repository": {
     "url": "https://gitlab.squiz.net/developer-experience/dxp-cli-next"
   },
@@ -39,7 +39,7 @@
     "codecov"
   ],
   "dependencies": {
-    "@squiz/component-cli-lib": "^1.39.1-alpha.7",
+    "@squiz/component-cli-lib": "^1.40.1-alpha",
     "axios": "1.1.3",
     "cli-color": "2.0.3",
     "commander": "9.4.0",