feat: add POC for measuring adoption

bin/run

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 
+process.env.NODE_ENV = 'development';
+
 const oclif = require('@oclif/core');
 
 oclif.run()

bin/run_bin

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+// Only the binary installed through NPM is considered production environment. See "bin" in package.json.
+process.env.NODE_ENV = 'production';
+
+const oclif = require('@oclif/core');
+
+oclif.run()
+  .then(require('@oclif/core/flush'))
+  .catch((err) => {
+    const oclifHandler = require('@oclif/core/handle');
+    return oclifHandler(err.message);
+  });
+

bin/run_bin.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run_bin" %*

package.json

@@ -4,7 +4,7 @@
   "version": "1.2.35",
   "author": "@asyncapi",
   "bin": {
-    "asyncapi": "./bin/run"
+    "asyncapi": "./bin/run_bin"
   },
   "bugs": "https://github.com/asyncapi/cli/issues",
   "dependencies": {
@@ -23,6 +23,7 @@
     "@oclif/core": "^1.26.2",
     "@oclif/errors": "^1.3.6",
     "@oclif/plugin-not-found": "^2.3.22",
+    "@smoya/asyncapi-adoption-metrics": "^2.3.0",
     "@smoya/multi-parser": "^4.0.0",
     "@stoplight/spectral-cli": "6.9.0",
     "ajv": "^8.12.0",

src/base.ts

@@ -1,6 +1,26 @@
 import { Command } from '@oclif/core';
+import { MetadataFromDocument, MetricMetadata, NewRelicSink, Recorder, Sink, StdOutSink } from '@smoya/asyncapi-adoption-metrics';
+import { Parser } from '@asyncapi/parser';
+import { Specification } from 'models/SpecificationFile';
+
+class DiscardSink implements Sink {
+  async send() {
+    // noop
+  }
+}
 
 export default abstract class extends Command {
+  recorder = this.recorderFromEnv('asyncapi_adoption');
+  parser = new Parser();
+  metricsMetadata: MetricMetadata = {};
+  specFile: Specification | undefined;
+
+  async init(): Promise<void> {
+    await super.init();
+    const commandName : string = this.id || '';
+    await this.recordActionInvoked(commandName);
+  }
+
   async catch(err: Error & { exitCode?: number; }): Promise<any> {
     try {
       return await super.catch(err);
@@ -11,4 +31,73 @@ export default abstract class extends Command {
       }
     }
   }
+
+  async recordActionExecuted(action: string, metadata: MetricMetadata = {}, rawDocument?: string) {
+    if (rawDocument !== undefined) {
+      try {
+        const {document} = await this.parser.parse(rawDocument);
+        if (document !== undefined) {
+          metadata = MetadataFromDocument(document, metadata);
+        }
+      } catch (e: any) {
+        if (e instanceof Error) {
+          this.log(`Skipping submitting anonymous metrics due to the following error: ${e.name}: ${e.message}`);
+        }
+      }
+    }
+
+    const callable = async function(recorder: Recorder) {
+      await recorder.recordActionExecuted(action, metadata);
+    };
+
+    await this.recordActionMetric(callable);
+  }
+
+  async recordActionInvoked(action: string, metadata?: MetricMetadata) {
+    const callable = async function(recorder: Recorder) {
+      await recorder.recordActionInvoked(action, metadata);
+    };
+
+    await this.recordActionMetric(callable);
+  }
+
+  async recordActionMetric(recordFunc: (recorder: Recorder) => Promise<void>) {
+    try {
+      await recordFunc(this.recorder);
+      await this.recorder.flush();
+    } catch (e: any) {
+      if (e instanceof Error) {
+        this.log(`Skipping submitting anonymous metrics due to the following error: ${e.name}: ${e.message}`);
+      }
+    }
+  }
+
+  async finally(error: Error | undefined): Promise<any> {
+    await super.finally(error);
+    this.metricsMetadata['success'] = error === undefined;
+    await this.recordActionExecuted(this.id as string, this.metricsMetadata, this.specFile?.text());
+  }
+
+  recorderFromEnv(prefix: string): Recorder {
+    let sink: Sink = new DiscardSink();
+    if (process.env.ASYNCAPI_METRICS !== 'false') {
+      switch (process.env.NODE_ENV) {
+      case 'development':
+        // NODE_ENV set to `development` in bin/run
+        if (!process.env.TEST) {
+          // Do not pollute stdout when running tests
+          sink = new StdOutSink();
+        }
+        break;
+      case 'production':
+        // NODE_ENV set to `production` in bin/run_bin, which is specified in 'bin' package.json section
+        sink = new NewRelicSink(process.env.ASYNCAPI_METRICS_NEWRELIC_KEY || 'eu01xx73a8521047150dd9414f6aedd2FFFFNRAL');
+        this.warn('AsyncAPI anonymously tracks command executions to improve the specification and tools, ensuring no sensitive data reaches our servers. It aids in comprehending how AsyncAPI tools are used and adopted, facilitating ongoing improvements to our specifications and tools.\n\nTo disable tracking, set the "ASYNCAPI_METRICS" env variable to "false" when executing the command. For instance:\n\nASYNCAPI_METRICS=false asyncapi validate spec_file.yaml');
+        break;
+      }
+    }
+
+    return new Recorder(prefix, sink);
+  }
 }
+

src/commands/bundle.ts

@@ -5,6 +5,8 @@ import bundle from '@asyncapi/bundler';
 import { promises } from 'fs';
 import path from 'path';
 import { Specification, load } from '../models/SpecificationFile';
+import { Parser } from '@asyncapi/parser';
+import { Document } from '@asyncapi/bundler/lib/document';
 
 const { writeFile } = promises;
 
@@ -26,13 +28,17 @@ export default class Bundle extends Command {
     base: Flags.string({ char: 'b', description: 'Path to the file which will act as a base. This is required when some properties are to needed to be overwritten.' }),
   };
 
+  parser = new Parser();
+
   async run() {
     const { argv, flags } = await this.parse(Bundle);
     const output = flags.output;
     let baseFile;
     const outputFormat = path.extname(argv[0]);
     const AsyncAPIFiles = await this.loadFiles(argv);
 
+    this.metricsMetadata.files = AsyncAPIFiles.length;
+
     const containsAsyncAPI3 = AsyncAPIFiles.filter((file) => {
       return file.isAsyncAPI3();
     });
@@ -50,6 +56,8 @@ export default class Bundle extends Command {
         base: baseFile
       }
     );
+
+    await this.collectMetricsData(document);
 
     if (!output) {
       if (outputFormat === '.yaml' || outputFormat === '.yml') {
@@ -75,6 +83,17 @@ export default class Bundle extends Command {
     }
   }
 
+  private async collectMetricsData(document: Document) {
+    try {
+      // We collect the metadata from the final output so it contains all the files
+      this.specFile = await load(new Specification(document.string()).text());
+    } catch (e: any) {
+      if (e instanceof Error) {
+        this.log(`Skipping submitting anonymous metrics due to the following error: ${e.name}: ${e.message}`);
+      }
+    }
+  }
+
   async loadFiles(filepaths: string[]): Promise<Specification[]> {
     const files = [];
     for (const filepath of filepaths) {

src/commands/convert.ts

@@ -6,7 +6,6 @@ import { ValidationError } from '../errors/validation-error';
 import { load } from '../models/SpecificationFile';
 import { SpecificationFileNotFound } from '../errors/specification-file';
 import { convert } from '@asyncapi/converter';
-
 import type { ConvertVersion } from '@asyncapi/converter';
 
 // @ts-ignore
@@ -30,21 +29,21 @@ export default class Convert extends Command {
   async run() {
     const { args, flags } = await this.parse(Convert);
     const filePath = args['spec-file'];
-    let specFile;
     let convertedFile;
     let convertedFileFormatted;
 
     try {
       // LOAD FILE
-      specFile = await load(filePath);
+      this.specFile = await load(filePath);
+      this.metricsMetadata.to_version = flags['target-version'];
 
       // CONVERSION
-      convertedFile = convert(specFile.text(), flags['target-version'] as ConvertVersion);
+      convertedFile = convert(this.specFile.text(), flags['target-version'] as ConvertVersion);
       if (convertedFile) {
-        if (specFile.getFilePath()) {
-          this.log(`File ${specFile.getFilePath()} successfully converted!`);
-        } else if (specFile.getFileURL()) {
-          this.log(`URL ${specFile.getFileURL()} successfully converted!`);
+        if (this.specFile.getFilePath()) {
+          this.log(`File ${this.specFile.getFilePath()} successfully converted!`);
+        } else if (this.specFile.getFileURL()) {
+          this.log(`URL ${this.specFile.getFileURL()} successfully converted!`);
         }
       }
 

src/commands/generate/fromTemplate.ts

@@ -11,7 +11,7 @@ import { watchFlag } from '../../flags';
 import { isLocalTemplate, Watcher } from '../../utils/generator';
 import { ValidationError } from '../../errors/validation-error';
 import { GeneratorError } from '../../errors/generator-error';
-
+import { Parser } from '@asyncapi/parser';
 import type { Example } from '@oclif/core/lib/interfaces';
 
 const red = (text: string) => `\x1b[31m${text}\x1b[0m`;
@@ -107,6 +107,8 @@ export default class Template extends Command {
     { name: 'template', description: '- Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template', required: true }
   ];
 
+  parser = new Parser();
+
   async run() {
     const { args, flags } = await this.parse(Template); // NOSONAR
 
@@ -124,6 +126,9 @@ export default class Template extends Command {
       disabledHooks: parsedFlags.disableHooks,
     };
     const asyncapiInput = (await load(asyncapi)) || (await load());
+
+    this.specFile = asyncapiInput;
+    this.metricsMetadata.template = template;
 
     const watchTemplate = flags['watch'];
     const genOption: any = {};