jitsu-cli 0.6.0 → 0.7.0

package/lib/cli/extension/exec.d.ts

@@ -0,0 +1,2 @@
+import { CommandResult } from "../../lib/command/types";
+export declare function execExtension(args: string[]): Promise<CommandResult>;

package/lib/cli/extension/exec.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execExtension = void 0;
+const tslib_1 = require("tslib");
+const commander_1 = (0, tslib_1.__importDefault)(require("commander"));
+const log_1 = (0, tslib_1.__importDefault)(require("../../lib/log"));
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const JSON5_1 = (0, tslib_1.__importDefault)(require("JSON5"));
+const fs_1 = (0, tslib_1.__importDefault)(require("fs"));
+const index_1 = require("./index");
+const indent_1 = require("../../lib/indent");
+const chalk_code_highlight_1 = require("../../lib/chalk-code-highlight");
+const validator_helper_1 = require("../../lib/validator-helper");
+const errors_1 = require("../../lib/errors");
+function getJson(json, file) {
+    if (json) {
+        return JSON5_1.default.parse(json);
+    }
+    else {
+        if (!fs_1.default.existsSync(file)) {
+            throw new Error(`File ${file} does not exist!`);
+        }
+        return JSON5_1.default.parse(fs_1.default.readFileSync(file, "utf-8"));
+    }
+}
+function ellipsis(str, opts = { maxLen: 80 }) {
+    const maxLen = opts?.maxLen || 80;
+    return str.length < maxLen ? str : str.substring(0, maxLen - 3) + "...";
+}
+function toArray(obj) {
+    if (!(typeof obj === "object" && Array.isArray(obj))) {
+        return [obj];
+    }
+    else {
+        return obj;
+    }
+}
+async function execExtension(args) {
+    const program = new commander_1.default.Command();
+    program.option("-f, --file <file path>", "Path to file with jitsu events. Could be either on object, or array of objects");
+    program.option("-c, --config <file path>", "Path to file with config ");
+    program.option("-o, --config-object <file path>", "Config json");
+    program.option("-j, --json <event json>", "Events JSON for processing (alternative to -f). Could be one object, or array of objects");
+    program.option("-d, --dir <project_dir>", "project dir");
+    program.option("-v, --skip-validation", "To skip config validation");
+    program.parse(["dummy", "dummy", ...args]);
+    let cliOpts = program.opts();
+    let directory = cliOpts.dir || ".";
+    let projectBase = path_1.default.isAbsolute(directory) ? directory : path_1.default.resolve(process.cwd() + "/" + directory);
+    let packageFile = path_1.default.resolve(projectBase, "package.json");
+    if (!fs_1.default.existsSync(packageFile)) {
+        return { success: false, message: "Can't find package.json in " + projectBase };
+    }
+    if (!cliOpts.json && !cliOpts.file) {
+        return { success: false, message: "Please specify -j or -f" };
+    }
+    if (cliOpts.json && cliOpts.file) {
+        return { success: false, message: "Both options -f and -j are provided. You should use either, not both" };
+    }
+    if (cliOpts.config && cliOpts.configObject) {
+        return { success: false, message: "Both options -o and -c are provided. You should use either, not both" };
+    }
+    if (!cliOpts.config && !cliOpts.configObject) {
+        return { success: false, message: "Please specify -o or -c" };
+    }
+    (0, log_1.default)().info("🛂 Executing tests destination on " + chalk_1.default.bold(projectBase));
+    let events = toArray(getJson(cliOpts.json, cliOpts.file));
+    let config = getJson(cliOpts.configObject, cliOpts.config);
+    let distFile = path_1.default.resolve(projectBase, (0, index_1.getDistFile)(JSON5_1.default.parse(fs_1.default.readFileSync(packageFile, "utf-8"))));
+    (0, log_1.default)().info("⌛️ Loading destination plugin (don't forget to build it before running exec!). Source: " + chalk_1.default.bold(distFile));
+    if (!fs_1.default.existsSync(path_1.default.resolve(projectBase, distFile))) {
+        return {
+            success: false,
+            message: `Can't find dist file ${chalk_1.default.bold(distFile)}. Does this dir contains jitsu extension? Have you run yarn build? `,
+        };
+    }
+    let extension = (0, index_1.loadBuild)(fs_1.default.readFileSync(distFile, "utf-8"));
+    if (!extension.destination) {
+        return { success: false, message: "Extension doesn't export destination function" };
+    }
+    if (!cliOpts.skipValidation && extension.validator) {
+        (0, log_1.default)().info(`Validating configuration:${chalk_code_highlight_1.chalkCode.json((0, indent_1.align)(JSON.stringify(config, null, 2), { indent: 4, lnBefore: 1, lnAfter: 1 }))}`);
+        let configError = await (0, validator_helper_1.validateConfiguration)(config, extension.validator);
+        if (configError) {
+            return { success: false, message: "Config is not valid: " + configError };
+        }
+        (0, log_1.default)().info("✅ Configuration is valid!");
+    }
+    else {
+        (0, log_1.default)().info("💡 Config validation will be skipped " +
+            (cliOpts.skipValidation ? " as per requested by -v flag" : ": extension does not have an exported validator"));
+    }
+    (0, log_1.default)().info("🏃 Running destination plugin on " + events.length + " events");
+    for (const ev of events) {
+        try {
+            let messages = await extension.destination(ev, {
+                destinationId: "test",
+                destinationType: "test",
+                config: config,
+            });
+            if (!messages) {
+                (0, log_1.default)().info("⚽ Event is skipped: " + ellipsis(JSON.stringify(ev)));
+                continue;
+            }
+            const messagesArray = Array.isArray(messages) ? messages : [messages];
+            (0, log_1.default)().info(`✅ Event emitted ${messagesArray.length} messages. Event JSON: ` + chalk_1.default.italic(ellipsis(JSON.stringify(ev))));
+            messagesArray.forEach(msg => {
+                (0, log_1.default)().info(`    ${chalk_1.default.bold(msg.method)} ${msg.url}`);
+                if (msg.headers && Object.entries(msg).length > 0) {
+                    Object.entries(msg.headers).forEach(([h, v]) => {
+                        (0, log_1.default)().info(`     ${chalk_1.default.bold(h)}: ${v}`);
+                    });
+                }
+                if (msg.body) {
+                    (0, log_1.default)().info("    Body:\n" + chalk_code_highlight_1.chalkCode.json((0, indent_1.align)(JSON.stringify((0, indent_1.jsonify)(msg.body), null, 2), { indent: 8 })));
+                }
+            });
+        }
+        catch (e) {
+            (0, log_1.default)().info(chalk_1.default.red((0, errors_1.appendError)("❌ Failed to process event", e) +
+                (0, indent_1.align)(JSON.stringify(ev, null, 2), { lnBefore: 1, lnAfter: 1, indent: 0 })));
+        }
+    }
+    return { success: true };
+}
+exports.execExtension = execExtension;

package/lib/cli/extension/index.d.ts

@@ -2,7 +2,7 @@ import { CommandRegistry } from "../../lib/command/types";
 import { JitsuExtensionExport } from "@jitsu/types/extension";
 import { Partial } from "rollup-plugin-typescript2/dist/partial";
 export declare const help: string;
-export declare const extensionCommands: CommandRegistry<"test" | "build" | "create" | "validate-config">;
+export declare const extensionCommands: CommandRegistry<"test" | "build" | "create" | "validate-config" | "exec">;
 export declare function validateTsConfig(tsConfigPath: string): void;
 export declare function getDistFile(packageJson: any): any;
 export declare function loadBuild(code: string): Partial<JitsuExtensionExport>;

package/lib/cli/extension/index.js

@@ -12,6 +12,7 @@ const test_1 = require("./test");
 const validate_config_1 = require("./validate-config");
 const template_1 = require("./template");
 const JSON5_1 = (0, tslib_1.__importDefault)(require("JSON5"));
+const exec_1 = require("./exec");
 global.fetch = require("cross-fetch");
 const usage = `
   · ${chalk_1.default.bold("jitsu-cli extension create")}
@@ -56,6 +57,11 @@ ${chalk_1.default.bold("TYPESCRIPT")}
 ${chalk_1.default.bold("COMMANDS")} ${(0, indent_1.align)(usage, { indent: 2, lnBefore: 2 })}
 `;
 exports.extensionCommands = {
+    exec: {
+        exec: exec_1.execExtension,
+        description: "Execute extension of a test data",
+        help: ""
+    },
     test: {
         exec: test_1.test,
         description: "Execute test on extension",

package/lib/cli/extension/validate-config.js

@@ -9,38 +9,39 @@ const fs_1 = (0, tslib_1.__importDefault)(require("fs"));
 const JSON5_1 = (0, tslib_1.__importDefault)(require("JSON5"));
 const log_1 = (0, tslib_1.__importDefault)(require("../../lib/log"));
 const index_1 = require("./index");
+const validator_helper_1 = require("../../lib/validator-helper");
 async function validateConfig(args) {
     const program = new commander_1.default.Command();
     program.option("-d, --dir <project_dir>", "Project directory");
-    program.option("-f, --file <config_file>", "Configuration file");
-    program.option("-j, --json <config_json>", "Inline extension configuration JSON");
+    program.option("-c, --config <config_file>", "Configuration file");
+    program.option("-o, --config-object <config_json>", "Inline extension configuration JSON");
     program.argument("[project_dir]");
     program.parse(["dummy", "dummy", ...args]);
     const opts = program.opts();
-    if (!opts.json && !opts.file) {
+    if (!opts.configObject && !opts.config) {
         return {
             success: false,
             message: 'Please define config object either with -j "{embedded json}", or with -f json_file',
         };
     }
     let configObj;
-    if (opts.json) {
+    if (opts.configObject) {
         try {
-            configObj = JSON5_1.default.parse(opts.json);
+            configObj = JSON5_1.default.parse(opts.configObject);
         }
         catch (e) {
             return { success: false, message: `Malformed json (-j): ${e.message}` };
         }
     }
     else {
-        if (!fs_1.default.existsSync(opts.file)) {
-            return { success: false, message: `${opts.file} (-f) doesn't exist!` };
+        if (!fs_1.default.existsSync(opts.config)) {
+            return { success: false, message: `${opts.config} (-f) doesn't exist!` };
         }
         try {
-            configObj = JSON5_1.default.parse(fs_1.default.readFileSync(opts.file, "utf8"));
+            configObj = JSON5_1.default.parse(fs_1.default.readFileSync(opts.config, "utf8"));
         }
         catch (e) {
-            return { success: false, message: `Malformed json in file ${opts.file} (-f): ${e.message}` };
+            return { success: false, message: `Malformed json in file ${opts.config} (-f): ${e.message}` };
         }
     }
     let projectDir = opts.dir || ".";
@@ -62,16 +63,10 @@ async function validateConfig(args) {
         return { success: false, message: "Build doesn't export validator symbol" };
     }
     (0, log_1.default)().info("🤔 Validating configuration " +
-        (opts.file ? `from file ${path_1.default.resolve(projectDir, opts.file)}` : JSON.stringify(configObj)));
-    let validationResult = await build.validator(configObj);
-    if (typeof validationResult === "boolean" && !validationResult) {
-        return { success: false, message: "❌ Config is not valid, an exact reason isn't specified by validator" };
-    }
-    else if (typeof validationResult === "string") {
-        return { success: false, message: "❌ Config is not valid: " + validationResult };
-    }
-    else if (typeof validationResult === "object" && !validationResult.ok) {
-        return { success: false, message: "❌ Config is not valid: " + validationResult.message };
+        (opts.config ? `from file ${path_1.default.resolve(projectDir, opts.config)}` : JSON.stringify(configObj)));
+    let validationError = await (0, validator_helper_1.validateConfiguration)(configObj, build.validator);
+    if (validationError) {
+        return { success: false, message: `❌ ${validationError}` };
     }
     (0, log_1.default)().info("✅ Config is valid. Hooray!");
     return { success: true };

package/lib/index.js

@@ -1,10 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 const run_1 = require("./run");
-const log_1 = (0, tslib_1.__importDefault)(require("./lib/log"));
 (async function () {
-    (0, log_1.default)().info("Args: " + process.argv);
     const args = [...process.argv.slice(2)];
     process.exit(await (0, run_1.run)(args));
 })();

package/lib/lib/indent.d.ts

@@ -6,3 +6,4 @@ export declare function align(text: string, { indent, lnBefore, lnAfter }?: {
     lnBefore?: number | undefined;
     lnAfter?: number | undefined;
 }): string;
+export declare function jsonify(obj: any): any;

package/lib/lib/indent.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.align = exports.removeIndentation = void 0;
+exports.jsonify = exports.align = exports.removeIndentation = void 0;
 function getIndentSize(line) {
     let idx = 0;
     for (; line.charAt(idx) === " " && idx < line.length; idx++) { }
@@ -27,3 +27,15 @@ function align(text, { indent = 0, lnBefore = 0, lnAfter = 0 } = {}) {
     ].join("\n");
 }
 exports.align = align;
+function jsonify(obj) {
+    if (typeof obj === 'string') {
+        try {
+            return JSON.parse(obj);
+        }
+        catch (e) {
+            return obj;
+        }
+    }
+    return obj;
+}
+exports.jsonify = jsonify;

package/lib/lib/validator-helper.d.ts

@@ -0,0 +1,3 @@
+import { ConfigValidationResult, ConfigValidator } from "@jitsu/types/extension";
+export declare function validationResultToError(validationResult: ConfigValidationResult): string | undefined;
+export declare function validateConfiguration(config: any, validator: ConfigValidator): Promise<(string | undefined)>;

package/lib/lib/validator-helper.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateConfiguration = exports.validationResultToError = void 0;
+function validationResultToError(validationResult) {
+    if (typeof validationResult === "boolean" && !validationResult) {
+        return "Config is not valid, an exact reason isn't specified by validator";
+    }
+    else if (typeof validationResult === "string") {
+        return "Config is not valid: " + validationResult;
+    }
+    else if (typeof validationResult === "object" && !validationResult.ok) {
+        return "Config is not valid: " + validationResult.message;
+    }
+    return undefined;
+}
+exports.validationResultToError = validationResultToError;
+async function validateConfiguration(config, validator) {
+    let validationResult = await validator(config);
+    return validationResultToError(validationResult);
+}
+exports.validateConfiguration = validateConfiguration;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jitsu-cli",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "publishConfig": {
     "access": "public"
   },
@@ -65,5 +65,5 @@
     "typescript": "^4.5.2",
     "validate-npm-package-name": "^3.0.0"
   },
-  "gitHead": "82fbe5d15fbd1308e6c571961f9d4f8cb3644591"
+  "gitHead": "4d54aac819fd941c52c15e1f7716c628d80bbdc5"
 }