feat: add expanded version of spec version in telemetry

Author: AlbinaBlazhko17

packages/cli/src/__tests__/utils/telemetry.test.ts

@@ -1,4 +1,4 @@
-import { collectXSecurityAuthTypes } from '../../utils/telemetry.js';
+import { collectXSecurityAuthTypes, transformSpecVersionError } from '../../utils/telemetry.js';
 
 import type { ArazzoDefinition } from '@redocly/openapi-core';
 
@@ -87,3 +87,57 @@ describe('collectXSecurityAuthTypes', () => {
     ]);
   });
 });
+
+describe('transformSpecVersionError', () => {
+  it('should transform "Unsupported specification" error', () => {
+    const result = transformSpecVersionError('Unsupported specification');
+    expect(result).toBe('unsupported');
+  });
+
+  it('should transform AsyncAPI version errors', () => {
+    const result1 = transformSpecVersionError('Unsupported AsyncAPI version: 2.1.1');
+    expect(result1).toBe('unsupported-async-2.1.1');
+
+    const result2 = transformSpecVersionError('Unsupported AsyncAPI version: 1.2.0');
+    expect(result2).toBe('unsupported-async-1.2.0');
+  });
+
+  it('should transform OpenAPI version errors', () => {
+    const result1 = transformSpecVersionError('Unsupported OpenAPI version: 3.2.0');
+    expect(result1).toBe('unsupported-openapi-3.2.0');
+
+    const result2 = transformSpecVersionError('Unsupported OpenAPI version: 2.1');
+    expect(result2).toBe('unsupported-openapi-2.1');
+  });
+
+  it('should handle generic unsupported version errors', () => {
+    const result = transformSpecVersionError('Unsupported Some API version: 1.0');
+    expect(result).toBe('unsupported');
+  });
+
+  it('should transform invalid document errors', () => {
+    const result = transformSpecVersionError('Document must be JSON object, got string');
+    expect(result).toBe('unknown');
+  });
+
+  it('should transform invalid OpenAPI version format errors', () => {
+    const result = transformSpecVersionError(
+      'Invalid OpenAPI version: should be a string but got "number"'
+    );
+    expect(result).toBe('invalid-openapi-version');
+  });
+
+  it('should return "unknown" for empty or invalid input', () => {
+    expect(transformSpecVersionError('')).toBe('unknown');
+    expect(transformSpecVersionError(null as any)).toBe('unknown');
+    expect(transformSpecVersionError(undefined as any)).toBe('unknown');
+  });
+
+  it('should be case insensitive', () => {
+    const result1 = transformSpecVersionError('UNSUPPORTED SPECIFICATION');
+    expect(result1).toBe('unsupported');
+
+    const result2 = transformSpecVersionError('unsupported asyncapi version: 2.1.1');
+    expect(result2).toBe('unsupported-async-2.1.1');
+  });
+});

packages/cli/src/utils/telemetry.ts

@@ -102,6 +102,42 @@ export async function sendTelemetry({
   }
 }
 
+export function transformSpecVersionError(errorMessage: string): string {
+  if (!errorMessage || typeof errorMessage !== 'string') {
+    return 'unknown';
+  }
+
+  const lowerMessage = errorMessage.toLowerCase();
+
+  if (lowerMessage.includes('invalid openapi version')) {
+    return 'invalid-openapi-version';
+  }
+
+  if (
+    (lowerMessage.includes('unsupported') && lowerMessage.includes('version')) ||
+    lowerMessage.includes('specification')
+  ) {
+    const extractUnsupportedVersion = (apiType: string, prefix: string) => {
+      const match = errorMessage.match(new RegExp(`Unsupported ${apiType} version:\\s*(.+)`, 'i'));
+      if (match && match[1]) {
+        const version = match[1].trim();
+        return `unsupported-${prefix}-${version}`;
+      }
+      return null;
+    };
+
+    const asyncApiResult = extractUnsupportedVersion('AsyncAPI', 'async');
+    if (asyncApiResult) return asyncApiResult;
+
+    const openApiResult = extractUnsupportedVersion('OpenAPI', 'openapi');
+    if (openApiResult) return openApiResult;
+
+    return 'unsupported';
+  }
+
+  return 'unknown';
+}
+
 export function collectXSecurityAuthTypes(
   document: Partial<ArazzoDefinition>,
   respectXSecurityAuthTypesAndSchemeName: string[]

packages/cli/src/wrapper.ts

@@ -7,7 +7,11 @@ import {
 } from '@redocly/openapi-core';
 import { version } from './utils/package.js';
 import { loadConfigAndHandleErrors } from './utils/miscellaneous.js';
-import { sendTelemetry, collectXSecurityAuthTypes } from './utils/telemetry.js';
+import {
+  sendTelemetry,
+  collectXSecurityAuthTypes,
+  transformSpecVersionError,
+} from './utils/telemetry.js';
 import { AbortFlowError, exitWithError } from './utils/error.js';
 
 import type { Arguments } from 'yargs';
@@ -34,7 +38,11 @@ export function commandWrapper<T extends CommandArgv>(
     let config: Config | undefined;
     const respectXSecurityAuthTypes: string[] = [];
     const collectSpecData: CollectFn = (document) => {
-      specVersion = detectSpec(document);
+      try {
+        specVersion = detectSpec(document);
+      } catch (err) {
+        specVersion = transformSpecVersionError(err.message);
+      }
       if (!isPlainObject(document)) return;
       specKeyword = document?.openapi
         ? 'openapi'
@@ -71,7 +79,6 @@ export function commandWrapper<T extends CommandArgv>(
       if (err instanceof AbortFlowError) {
         // do nothing
       } else if (err instanceof HandledError) {
-        if (err.message.includes('Unsupported specification')) specVersion = 'undefined';
         logger.error(err.message + '\n\n');
       } else {
         logger.error(