chore: unify logic for metrics collection when any command is executed

src/base.ts

@@ -1,6 +1,7 @@
 import { Command } from '@oclif/core';
-import { MetadataFromDocument, MetricMetadata, NewRelicSink, Recorder, Sink, StdOutSink } from '@smoya/asyncapi-adoption-metrics';
+import { 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() {
@@ -11,6 +12,14 @@ class DiscardSink implements Sink {
 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 {
@@ -23,20 +32,7 @@ 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}`);
-        }
-      }
-    }
-
+  async recordActionExecuted(action: string, metadata: MetricMetadata = {}) {
     const callable = async function(recorder: Recorder) {
       await recorder.recordActionExecuted(action, metadata);
     };
@@ -63,12 +59,6 @@ export default abstract class extends Command {
     }
   }
 
-  async init(): Promise<void> {
-    await super.init();
-    const commandName : string = this.id || '';
-    await this.recordActionInvoked(commandName);
-  }
-
   recorderFromEnv(prefix: string): Recorder {
     let sink: Sink = new DiscardSink();
     if (process.env.ASYNCAPI_METRICS !== 'false') {
@@ -90,5 +80,11 @@ export default abstract class extends Command {
 
     return new Recorder(prefix, sink);
   }
+
+  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);
+  }
 }
 

src/commands/bundle.ts

@@ -6,6 +6,7 @@
 import path from 'path';
 import { Specification, load } from '../models/SpecificationFile';
 import { Parser } from '@asyncapi/parser';
+import { MetadataFromDocument } from '@smoya/asyncapi-adoption-metrics';
 
 const { writeFile } = promises;
 
@@ -29,7 +30,7 @@
 
   parser = new Parser();
 
   async run() {
     const { argv, flags } = await this.parse(Bundle);
     const output = flags.output;
     let baseFile;
@@ -80,7 +81,17 @@
     const result = await load(output);
 
     // Metrics recording.
-    await this.recordActionExecuted(result.text(), {success: true, files: AsyncAPIFiles.length});
+    this.metricsMetadata = {success: true, files: AsyncAPIFiles.length};
+    try {
+      const {document} = await this.parser.parse(result.text());
+      if (document !== undefined) {
+        this.metricsMetadata = MetadataFromDocument(document, this.metricsMetadata);
+      }
+    } 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[]> {

src/commands/convert.ts

@@ -6,7 +6,7 @@
 import { load } from '../models/SpecificationFile';
 import { SpecificationFileNotFound } from '../errors/specification-file';
 import { convert } from '@asyncapi/converter';
-import { MetadataFromDocument, MetricMetadata } from '@smoya/asyncapi-adoption-metrics';
+import { MetadataFromDocument } from '@smoya/asyncapi-adoption-metrics';
 
 import type { ConvertVersion } from '@asyncapi/converter';
 
@@ -28,7 +28,7 @@
     { name: 'spec-file', description: 'spec path, url, or context-name', required: false },
   ];
 
   async run() {
     const { args, flags } = await this.parse(Convert);
     const filePath = args['spec-file'];
     let specFile;
@@ -72,19 +72,17 @@
     }
 
     // Metrics recording.
-    let metadata: MetricMetadata = {success: true, to_version: flags['target-version']};
+    this.metricsMetadata = {success: true, to_version: flags['target-version']};
     try {
       const {document} = await this.parser.parse(specFile.text());
       if (document !== undefined) {
-        metadata = MetadataFromDocument(document, metadata);
-        metadata['from_version'] = document.version();
+        this.metricsMetadata = MetadataFromDocument(document, this.metricsMetadata);
+        this.metricsMetadata['from_version'] = document.version();
       }
     } catch (e: any) {
       if (e instanceof Error) {
         this.log(`Skipping submitting anonymous metrics due to the following error: ${e.name}: ${e.message}`);
       }
     }
-
-    await this.recordActionExecuted('convert', metadata);
   }
 }

src/commands/generate/fromTemplate.ts

@@ -12,6 +12,7 @@ import { isLocalTemplate, Watcher } from '../../utils/generator';
 import { ValidationError } from '../../errors/validation-error';
 import { GeneratorError } from '../../errors/generator-error';
 import { Parser } from '@asyncapi/parser';
+import { MetadataFromDocument } from '@smoya/asyncapi-adoption-metrics';
 
 import type { Example } from '@oclif/core/lib/interfaces';
 
@@ -147,7 +148,17 @@ export default class Template extends Command {
     }
 
     // Metrics recording.
-    await this.recordActionExecuted('generate_from_template', {success: true, template}, asyncapiInput.text());
+    this.metricsMetadata = {success: true, template};
+    try {
+      const {document} = await this.parser.parse(asyncapiInput.text());
+      if (document !== undefined) {
+        this.metricsMetadata = MetadataFromDocument(document, this.metricsMetadata);
+      }
+    } catch (e: any) {
+      if (e instanceof Error) {
+        this.log(`Skipping submitting anonymous metrics due to the following error: ${e.name}: ${e.message}`);
+      }
+    }
   }
 
   private parseFlags(disableHooks?: string[], params?: string[], mapBaseUrl?: string): ParsedFlags {

src/commands/optimize.ts

@@ -8,13 +8,14 @@
 import { promises } from 'fs';
 import { Example } from '@oclif/core/lib/interfaces';
 import { Parser } from '@asyncapi/parser';
+import { MetadataFromDocument } from '@smoya/asyncapi-adoption-metrics';
 
 const { writeFile } = promises;
 
 export enum Optimizations {
   REMOVE_COMPONENTS='remove-components',
   REUSE_COMPONENTS='reuse-components',
-  MOVE_TO_COMPONETS='move-to-components'
+  MOVE_TO_COMPONENTS='move-to-components'
 }
 
 export enum Outputs {
@@ -48,7 +49,7 @@
 
   parser = new Parser();
 
   async run() {
     const { args, flags } = await this.parse(Optimize); //NOSONAR
     const filePath = args['spec-file'];
     let specFile: Specification;
@@ -96,7 +97,7 @@
 
     try {
       const optimizedDocument = optimizer.getOptimizedDocument({rules: {
-        moveToComponents: this.optimizations.includes(Optimizations.MOVE_TO_COMPONETS),
+        moveToComponents: this.optimizations.includes(Optimizations.MOVE_TO_COMPONENTS),
         removeComponents: this.optimizations.includes(Optimizations.REMOVE_COMPONENTS),
         reuseComponents: this.optimizations.includes(Optimizations.REUSE_COMPONENTS)
       }, output: Output.YAML});
@@ -129,7 +130,17 @@
     }
 
     // Metrics recording.
-    await this.recordActionExecuted('optimize', {success: true, optimizations: this.optimizations}, specFile.text());
+    this.metricsMetadata = {success: true, optimizations: this.optimizations};
+    try {
+      const {document} = await this.parser.parse(specFile.text());
+      if (document !== undefined) {
+        this.metricsMetadata = MetadataFromDocument(document, this.metricsMetadata);
+      }
+    } catch (e: any) {
+      if (e instanceof Error) {
+        this.log(`Skipping submitting anonymous metrics due to the following error: ${e.name}: ${e.message}`);
+      }
+    }
   }
 
   private showOptimizations(elements: ReportElement[] | undefined) {
@@ -159,7 +170,7 @@
       const totalMove = report.moveToComponents?.filter((e: ReportElement) => e.action === 'move').length;
       this.log(`\n${chalk.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 = report.removeComponents?.length;

src/commands/validate.ts

@@ -1,10 +1,10 @@
 import { Flags } from '@oclif/core';
-
 import Command from '../base';
 import { validate, validationFlags } from '../parser';
 import { load } from '../models/SpecificationFile';
 import { specWatcher } from '../globals';
 import { watchFlag } from '../flags';
+import { MetadataFromDocument } from '@smoya/asyncapi-adoption-metrics';
 
 export default class Validate extends Command {
   static description = 'validate asyncapi file';
@@ -32,6 +32,16 @@ export default class Validate extends Command {
     const result = await validate(this, specFile, flags);
 
     // Metrics recording.
-    await this.recordActionExecuted('validate', {success: true, validation_result: result}, specFile.text());
+    this.metricsMetadata = {success: true, validation_result: result};
+    try {
+      const {document} = await this.parser.parse(specFile.text());
+      if (document !== undefined) {
+        this.metricsMetadata = MetadataFromDocument(document, this.metricsMetadata);
+      }
+    } catch (e: any) {
+      if (e instanceof Error) {
+        this.log(`Skipping submitting anonymous metrics due to the following error: ${e.name}: ${e.message}`);
+      }
+    }
   }
 }