@asyncapi/cli 1.7.3 → 1.8.1

package/lib/commands/generate/fromTemplate.js

@@ -14,6 +14,7 @@ const flags_1 = require("../../flags");
 const generator_2 = require("../../utils/generator");
 const validation_error_1 = require("../../errors/validation-error");
 const generator_error_1 = require("../../errors/generator-error");
+const parser_1 = require("@asyncapi/parser");
 const red = (text) => `\x1b[31m${text}\x1b[0m`;
 const magenta = (text) => `\x1b[35m${text}\x1b[0m`;
 const yellow = (text) => `\x1b[33m${text}\x1b[0m`;
@@ -43,6 +44,7 @@ function verifyTemplateSupportForV3(template) {
 class Template extends base_1.default {
     constructor() {
         super(...arguments);
+        this.parser = new parser_1.Parser();
         this.getMapBaseUrlToFolderResolver = (urlToFolder) => {
             return {
                 order: 1,
@@ -90,6 +92,8 @@ class Template extends base_1.default {
                 disabledHooks: parsedFlags.disableHooks,
             };
             const asyncapiInput = (yield (0, SpecificationFile_1.load)(asyncapi)) || (yield (0, SpecificationFile_1.load)());
+            this.specFile = asyncapiInput;
+            this.metricsMetadata.template = template;
             const watchTemplate = flags['watch'];
             const genOption = {};
             if (flags['map-base-url']) {

package/lib/commands/new/file.js

@@ -7,6 +7,7 @@ const base_1 = tslib_1.__importDefault(require("../../base"));
 const inquirer = tslib_1.__importStar(require("inquirer"));
 const Studio_1 = require("../../models/Studio");
 const path_1 = require("path");
+const SpecificationFile_1 = require("../../models/SpecificationFile");
 const { writeFile, readFile } = fs_1.promises;
 const DEFAULT_ASYNCAPI_FILE_NAME = 'asyncapi.yaml';
 const DEFAULT_ASYNCAPI_TEMPLATE = 'default-example.yaml';
@@ -143,6 +144,8 @@ class NewFile extends base_1.default {
             }
             yield writeFile(fileNameToWriteToDisk, asyncApiFile, { encoding: 'utf8' });
             console.log(`Created file ${fileNameToWriteToDisk}...`);
+            this.specFile = yield (0, SpecificationFile_1.load)(fileNameToWriteToDisk);
+            this.metricsMetadata.selected_template = selectedTemplate;
         });
     }
 }

package/lib/commands/optimize.d.ts

@@ -1,9 +1,10 @@
 import Command from '../base';
 import { Example } from '@oclif/core/lib/interfaces';
+import { Parser } from '@asyncapi/parser';
 export declare enum Optimizations {
     REMOVE_COMPONENTS = "remove-components",
     REUSE_COMPONENTS = "reuse-components",
-    MOVE_TO_COMPONETS = "move-to-components"
+    MOVE_TO_COMPONENTS = "move-to-components"
 }
 export declare enum Outputs {
     TERMINAL = "terminal",
@@ -13,7 +14,7 @@ export declare enum Outputs {
 export default class Optimize extends Command {
     static description: string;
     isInteractive: boolean;
-    optimizations?: Optimizations[];
+    selectedOptimizations?: Optimizations[];
     outputMethod?: Outputs;
     static examples: Example[];
     static flags: {
@@ -27,7 +28,9 @@ export default class Optimize extends Command {
         description: string;
         required: boolean;
     }[];
+    parser: Parser;
     run(): Promise<void>;
     private showOptimizations;
     private interactiveRun;
+    private collectMetricsData;
 }

package/lib/commands/optimize.js

@@ -10,12 +10,13 @@ const SpecificationFile_1 = require("../models/SpecificationFile");
 const inquirer = tslib_1.__importStar(require("inquirer"));
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const fs_1 = require("fs");
+const parser_1 = require("@asyncapi/parser");
 const { writeFile } = fs_1.promises;
 var Optimizations;
 (function (Optimizations) {
     Optimizations["REMOVE_COMPONENTS"] = "remove-components";
     Optimizations["REUSE_COMPONENTS"] = "reuse-components";
-    Optimizations["MOVE_TO_COMPONETS"] = "move-to-components";
+    Optimizations["MOVE_TO_COMPONENTS"] = "move-to-components";
 })(Optimizations = exports.Optimizations || (exports.Optimizations = {}));
 var Outputs;
 (function (Outputs) {
@@ -27,15 +28,15 @@ class Optimize extends base_1.default {
     constructor() {
         super(...arguments);
         this.isInteractive = false;
+        this.parser = new parser_1.Parser();
     }
     run() {
         var _a, _b, _c, _d;
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const { args, flags } = yield this.parse(Optimize); //NOSONAR
             const filePath = args['spec-file'];
-            let specFile;
             try {
-                specFile = yield (0, SpecificationFile_1.load)(filePath);
+                this.specFile = yield (0, SpecificationFile_1.load)(filePath);
             }
             catch (err) {
                 this.error(new validation_error_1.ValidationError({
@@ -43,13 +44,13 @@ class Optimize extends base_1.default {
                     filepath: filePath,
                 }));
             }
-            if (specFile.isAsyncAPI3()) {
+            if (this.specFile.isAsyncAPI3()) {
                 this.error('Optimize command does not support AsyncAPI v3 yet, please checkout https://github.com/asyncapi/optimizer/issues/168');
             }
             let optimizer;
             let report;
             try {
-                optimizer = new optimizer_1.Optimizer(specFile.text());
+                optimizer = new optimizer_1.Optimizer(this.specFile.text());
                 report = yield optimizer.getReport();
             }
             catch (err) {
@@ -59,10 +60,11 @@ class Optimize extends base_1.default {
                 }));
             }
             this.isInteractive = !flags['no-tty'];
-            this.optimizations = flags.optimization;
+            this.selectedOptimizations = flags.optimization;
             this.outputMethod = flags.output;
+            this.metricsMetadata.optimized = false;
             if (!(((_a = report.moveToComponents) === null || _a === void 0 ? void 0 : _a.length) || ((_b = report.removeComponents) === null || _b === void 0 ? void 0 : _b.length) || ((_c = report.reuseComponents) === null || _c === void 0 ? void 0 : _c.length))) {
-                this.log(`No optimization has been applied since ${(_d = specFile.getFilePath()) !== null && _d !== void 0 ? _d : specFile.getFileURL()} looks optimized!`);
+                this.log(`No optimization has been applied since ${(_d = this.specFile.getFilePath()) !== null && _d !== void 0 ? _d : this.specFile.getFileURL()} looks optimized!`);
                 return;
             }
             const isTTY = process.stdout.isTTY;
@@ -71,11 +73,12 @@ class Optimize extends base_1.default {
             }
             try {
                 const optimizedDocument = optimizer.getOptimizedDocument({ rules: {
-                        moveToComponents: this.optimizations.includes(Optimizations.MOVE_TO_COMPONETS),
-                        removeComponents: this.optimizations.includes(Optimizations.REMOVE_COMPONENTS),
-                        reuseComponents: this.optimizations.includes(Optimizations.REUSE_COMPONENTS)
+                        moveToComponents: this.selectedOptimizations.includes(Optimizations.MOVE_TO_COMPONENTS),
+                        removeComponents: this.selectedOptimizations.includes(Optimizations.REMOVE_COMPONENTS),
+                        reuseComponents: this.selectedOptimizations.includes(Optimizations.REUSE_COMPONENTS)
                     }, output: optimizer_1.Output.YAML });
-                const specPath = specFile.getFilePath();
+                this.collectMetricsData(report);
+                const specPath = this.specFile.getFilePath();
                 let newPath = '';
                 if (specPath) {
                     const pos = specPath.lastIndexOf('.');
@@ -84,16 +87,18 @@ class Optimize extends base_1.default {
                 else {
                     newPath = 'optimized-asyncapi.yaml';
                 }
-                if (this.outputMethod === Outputs.TERMINAL) {
-                    this.log(optimizedDocument);
-                }
-                else if (this.outputMethod === Outputs.NEW_FILE) {
-                    yield writeFile(newPath, optimizedDocument, { encoding: 'utf8' });
-                    this.log(`Created file ${newPath}...`);
-                }
-                else if (this.outputMethod === Outputs.OVERWRITE) {
-                    yield writeFile(specPath !== null && specPath !== void 0 ? specPath : 'asyncapi.yaml', optimizedDocument, { encoding: 'utf8' });
-                    this.log(`Updated file ${specPath}...`);
+                switch (this.outputMethod) {
+                    case Outputs.TERMINAL:
+                        this.log(optimizedDocument);
+                        break;
+                    case Outputs.NEW_FILE:
+                        yield writeFile(newPath, optimizedDocument, { encoding: 'utf8' });
+                        this.log(`Created file ${newPath}...`);
+                        break;
+                    case Outputs.OVERWRITE:
+                        yield writeFile(specPath !== null && specPath !== void 0 ? specPath : 'asyncapi.yaml', optimizedDocument, { encoding: 'utf8' });
+                        this.log(`Updated file ${specPath}...`);
+                        break;
                 }
             }
             catch (error) {
@@ -133,7 +138,7 @@ class Optimize extends base_1.default {
                 const totalMove = (_d = report.moveToComponents) === null || _d === void 0 ? void 0 : _d.filter((e) => e.action === 'move').length;
                 this.log(`\n${chalk_1.default.green(totalMove)} components can be moved to the components sections.\nthe following changes will be made:`);
                 this.showOptimizations(report.moveToComponents);
-                choices.push({ name: 'move to components section', value: Optimizations.MOVE_TO_COMPONETS });
+                choices.push({ name: 'move to components section', value: Optimizations.MOVE_TO_COMPONENTS });
             }
             if (canRemove) {
                 const totalMove = (_e = report.removeComponents) === null || _e === void 0 ? void 0 : _e.length;
@@ -154,7 +159,7 @@ class Optimize extends base_1.default {
                     default: 'all',
                     choices
                 }]);
-            this.optimizations = optimizationRes.optimization;
+            this.selectedOptimizations = optimizationRes.optimization;
             const outputRes = yield inquirer.prompt([{
                     name: 'output',
                     message: 'where do you want to save the result:',
@@ -165,14 +170,24 @@ class Optimize extends base_1.default {
             this.outputMethod = outputRes.output;
         });
     }
+    collectMetricsData(report) {
+        var _a;
+        for (const availableOptimization in report) {
+            const availableOptimizationKebabCase = availableOptimization.replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase(); // optimization flags are kebab case
+            if (availableOptimization.length && ((_a = this.selectedOptimizations) === null || _a === void 0 ? void 0 : _a.includes(availableOptimizationKebabCase))) {
+                this.metricsMetadata[`optimization_${availableOptimization}`] = true;
+                this.metricsMetadata.optimized = true;
+            }
+        }
+    }
 }
 exports.default = Optimize;
 Optimize.description = 'optimize asyncapi specification file';
 Optimize.examples = [
     'asyncapi optimize ./asyncapi.yaml',
     'asyncapi optimize ./asyncapi.yaml --no-tty',
-    'asyncapi optimize ./asyncapi.yaml --optimization=remove-components,reuse-components,move-to-components --no-tty',
-    'asyncapi optimize ./asyncapi.yaml --optimization=remove-components,reuse-components,move-to-components --output=terminal --no-tty',
+    'asyncapi optimize ./asyncapi.yaml --optimization=remove-components --optimization=reuse-components --optimization=move-to-components --no-tty',
+    'asyncapi optimize ./asyncapi.yaml --optimization=remove-components --output=terminal --no-tty',
 ];
 Optimize.flags = {
     help: core_1.Flags.help({ char: 'h' }),

package/lib/commands/validate.js

@@ -13,12 +13,13 @@ class Validate extends base_1.default {
             const { args, flags } = yield this.parse(Validate); //NOSONAR
             const filePath = args['spec-file'];
             const watchMode = flags.watch;
-            const specFile = yield (0, SpecificationFile_1.load)(filePath);
+            this.specFile = yield (0, SpecificationFile_1.load)(filePath);
             if (watchMode) {
-                (0, globals_1.specWatcher)({ spec: specFile, handler: this, handlerName: 'validate' });
+                (0, globals_1.specWatcher)({ spec: this.specFile, handler: this, handlerName: 'validate' });
             }
-            const validationResult = yield (0, parser_1.validate)(this, specFile, flags);
-            if (validationResult === 'invalid') {
+            const result = yield (0, parser_1.validate)(this, this.specFile, flags);
+            this.metricsMetadata.validation_result = result;
+            if (result === 'invalid') {
                 process.exitCode = 1;
             }
         });

package/oclif.manifest.json

@@ -259,8 +259,8 @@
       "examples": [
         "asyncapi optimize ./asyncapi.yaml",
         "asyncapi optimize ./asyncapi.yaml --no-tty",
-        "asyncapi optimize ./asyncapi.yaml --optimization=remove-components,reuse-components,move-to-components --no-tty",
-        "asyncapi optimize ./asyncapi.yaml --optimization=remove-components,reuse-components,move-to-components --output=terminal --no-tty"
+        "asyncapi optimize ./asyncapi.yaml --optimization=remove-components --optimization=reuse-components --optimization=move-to-components --no-tty",
+        "asyncapi optimize ./asyncapi.yaml --optimization=remove-components --output=terminal --no-tty"
       ],
       "flags": {
         "help": {
@@ -402,6 +402,48 @@
         "validate.js"
       ]
     },
+    "config:analytics": {
+      "aliases": [],
+      "args": {},
+      "description": "Enable or disable analytics for metrics collection",
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "disable": {
+          "char": "d",
+          "description": "disable analytics",
+          "name": "disable",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "enable": {
+          "char": "e",
+          "description": "enable analytics",
+          "name": "enable",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "config:analytics",
+      "pluginAlias": "@asyncapi/cli",
+      "pluginName": "@asyncapi/cli",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "config",
+        "analytics.js"
+      ]
+    },
     "config": {
       "aliases": [],
       "args": {},
@@ -1436,5 +1478,5 @@
       ]
     }
   },
-  "version": "1.7.3"
+  "version": "1.8.1"
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "1.7.3",
+  "version": "1.8.1",
   "author": "@asyncapi",
   "bin": {
-    "asyncapi": "./bin/run"
+    "asyncapi": "./bin/run_bin"
   },
   "bugs": "https://github.com/asyncapi/cli/issues",
   "dependencies": {
@@ -12,18 +12,19 @@
     "@asyncapi/bundler": "^0.4.0",
     "@asyncapi/converter": "^1.4.15",
     "@asyncapi/diff": "^0.4.1",
-    "@asyncapi/generator": "^1.17.13",
+    "@asyncapi/generator": "^1.17.14",
     "@asyncapi/modelina": "^3.4.5",
     "@asyncapi/openapi-schema-parser": "^3.0.16",
     "@asyncapi/optimizer": "^0.2.7",
-    "@asyncapi/parser": "^3.0.9",
+    "@asyncapi/parser": "^3.0.12",
     "@asyncapi/protobuf-schema-parser": "^3.2.8",
     "@asyncapi/raml-dt-schema-parser": "^4.0.14",
     "@asyncapi/studio": "^0.20.0",
     "@oclif/core": "^1.26.2",
     "@oclif/errors": "^1.3.6",
     "@oclif/plugin-not-found": "^2.3.22",
-    "@smoya/multi-parser": "^4.0.0",
+    "@smoya/asyncapi-adoption-metrics": "^2.4.4",
+    "@smoya/multi-parser": "^5.0.5",
     "@stoplight/spectral-cli": "6.9.0",
     "ajv": "^8.12.0",
     "chalk": "^4.1.0",
@@ -42,6 +43,7 @@
     "serve-handler": "^6.1.3",
     "strip-ansi": "^6.0.0",
     "unzipper": "^0.10.11",
+    "uuid": "^9.0.1",
     "wrap-ansi": "^9.0.0",
     "ws": "^8.2.3"
   },
@@ -61,6 +63,7 @@
     "@types/node-fetch": "^2.5.12",
     "@types/rimraf": "^3.0.2",
     "@types/serve-handler": "^6.1.1",
+    "@types/uuid": "^9.0.8",
     "@types/wrap-ansi": "^8.0.1",
     "@types/ws": "^8.2.0",
     "@typescript-eslint/eslint-plugin": "^5.38.1",
@@ -139,7 +142,7 @@
     "dev": "tsc --watch",
     "docker:build": "docker build -t asyncapi/cli:latest .",
     "generate:readme:create": "printf '\n\n# Usage\n\n<!-- usage -->\n\n# Commands\n\n<!-- commands -->\n' > scripts/README.md",
-    "generate:readme:commands": "npm run build && cd scripts && DEBUG=* oclif readme",
+    "generate:readme:commands": "npm run build && cd scripts && cross-env DEBUG=* oclif readme",
     "generate:assets": "npm run generate:readme:toc && npm run generate:commands",
     "generate:commands": "npm run generate:readme:create && npm run generate:readme:commands && node ./scripts/updateUsageDocs.js && rimraf ./scripts/README.md",
     "generate:readme:toc": "markdown-toc -i README.md",