@redocly/cli 1.18.1 → 1.19.0

package/src/__tests__/utils.test.ts

@@ -474,6 +474,7 @@ describe('checkIfRulesetExist', () => {
       oas3_0: {},
       oas3_1: {},
       async2: {},
+      async3: {},
       arazzo: {},
     };
     expect(() => checkIfRulesetExist(rules)).toThrowError(

package/src/__tests__/wrapper.test.ts

@@ -4,6 +4,7 @@ import { commandWrapper } from '../wrapper';
 import { handleLint } from '../commands/lint';
 import { Arguments } from 'yargs';
 import { handlePush, PushOptions } from '../commands/push';
+import { detectSpec } from '@redocly/openapi-core';
 
 jest.mock('node-fetch');
 jest.mock('../utils/miscellaneous', () => ({
@@ -11,7 +12,9 @@ jest.mock('../utils/miscellaneous', () => ({
   loadConfigAndHandleErrors: jest.fn(),
 }));
 jest.mock('../commands/lint', () => ({
-  handleLint: jest.fn(),
+  handleLint: jest.fn().mockImplementation(({ collectSpecData }) => {
+    collectSpecData({ openapi: '3.1.0' });
+  }),
   lintConfigCallback: jest.fn(),
 }));
 
@@ -20,13 +23,32 @@ describe('commandWrapper', () => {
     (loadConfigAndHandleErrors as jest.Mock).mockImplementation(() => {
       return { telemetry: 'on', styleguide: { recommendedFallback: true } };
     });
+    (detectSpec as jest.Mock).mockImplementationOnce(() => {
+      return 'oas3_1';
+    });
+    process.env.REDOCLY_TELEMETRY = 'on';
+
+    const wrappedHandler = commandWrapper(handleLint);
+    await wrappedHandler({} as any);
+    expect(handleLint).toHaveBeenCalledTimes(1);
+    expect(sendTelemetry).toHaveBeenCalledTimes(1);
+    expect(sendTelemetry).toHaveBeenCalledWith({}, 0, false, 'oas3_1', 'openapi', '3.1.0');
+  });
+
+  it('should not collect spec version if the file is not parsed to json', async () => {
+    (loadConfigAndHandleErrors as jest.Mock).mockImplementation(() => {
+      return { telemetry: 'on', styleguide: { recommendedFallback: true } };
+    });
+    (handleLint as jest.Mock).mockImplementation(({ collectSpecData }) => {
+      collectSpecData();
+    });
     process.env.REDOCLY_TELEMETRY = 'on';
 
     const wrappedHandler = commandWrapper(handleLint);
     await wrappedHandler({} as any);
     expect(handleLint).toHaveBeenCalledTimes(1);
     expect(sendTelemetry).toHaveBeenCalledTimes(1);
-    expect(sendTelemetry).toHaveBeenCalledWith({}, 0, false);
+    expect(sendTelemetry).toHaveBeenCalledWith({}, 0, false, undefined, undefined, undefined);
   });
 
   it('should NOT send telemetry if there is "telemetry: off" in the config', async () => {

package/src/cms/commands/__tests__/push-status.test.ts

@@ -85,15 +85,16 @@ describe('handlePushStatus()', () => {
 
   it('should throw error if organization not provided', async () => {
     await expect(
-      handlePushStatus(
-        {
+      handlePushStatus({
+        argv: {
           domain: 'test-domain',
           organization: '',
           project: 'test-project',
           pushId: 'test-push-id',
         },
-        mockConfig
-      )
+        config: mockConfig,
+        version: 'cli-version',
+      })
     ).rejects.toThrowErrorMatchingInlineSnapshot(
       `"No organization provided, please use --organization option or specify the 'organization' field in the config file."`
     );
@@ -108,15 +109,16 @@ describe('handlePushStatus()', () => {
     process.env.REDOCLY_AUTHORIZATION = 'test-api-key';
     remotes.getPush.mockResolvedValueOnce(pushResponseStub);
 
-    await handlePushStatus(
-      {
+    await handlePushStatus({
+      argv: {
         domain: 'test-domain',
         organization: 'test-org',
         project: 'test-project',
         pushId: 'test-push-id',
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
     expect(process.stdout.write).toHaveBeenCalledTimes(1);
     expect(process.stdout.write).toHaveBeenCalledWith(
       '🚀 Preview deploy success.\nPreview URL: https://preview-test-url\n'
@@ -127,15 +129,16 @@ describe('handlePushStatus()', () => {
     process.env.REDOCLY_AUTHORIZATION = 'test-api-key';
     remotes.getPush.mockResolvedValue({ ...pushResponseStub, isMainBranch: true });
 
-    await handlePushStatus(
-      {
+    await handlePushStatus({
+      argv: {
         domain: 'test-domain',
         organization: 'test-org',
         project: 'test-project',
         pushId: 'test-push-id',
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
     expect(process.stdout.write).toHaveBeenCalledTimes(2);
     expect(process.stdout.write).toHaveBeenCalledWith(
       '🚀 Preview deploy success.\nPreview URL: https://preview-test-url\n'
@@ -157,15 +160,16 @@ describe('handlePushStatus()', () => {
     });
 
     await expect(
-      handlePushStatus(
-        {
+      handlePushStatus({
+        argv: {
           domain: 'test-domain',
           organization: 'test-org',
           project: 'test-project',
           pushId: 'test-push-id',
         },
-        mockConfig
-      )
+        config: mockConfig,
+        version: 'cli-version',
+      })
     ).rejects.toThrowErrorMatchingInlineSnapshot(`
       "❌ Preview deploy fail.
       Preview URL: https://preview-test-url"
@@ -197,15 +201,16 @@ describe('handlePushStatus()', () => {
       },
     });
 
-    await handlePushStatus(
-      {
+    await handlePushStatus({
+      argv: {
         domain: 'test-domain',
         organization: 'test-org',
         project: 'test-project',
         pushId: 'test-push-id',
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
     expect(process.stdout.write).toHaveBeenCalledTimes(4);
     expect(process.stdout.write).toHaveBeenCalledWith(
       '🚀 Preview deploy success.\nPreview URL: https://preview-test-url\n'
@@ -232,16 +237,17 @@ describe('handlePushStatus()', () => {
       },
     });
 
-    await handlePushStatus(
-      {
+    await handlePushStatus({
+      argv: {
         domain: 'test-domain',
         organization: 'test-org',
         project: 'test-project',
         pushId: 'test-push-id',
         wait: true,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(process.stderr.write).toHaveBeenCalledWith(
       'Files not added to your project. Reason: no changes.\n'
@@ -253,15 +259,16 @@ describe('handlePushStatus()', () => {
       process.env.REDOCLY_AUTHORIZATION = 'test-api-key';
       remotes.getPush.mockResolvedValue({ ...pushResponseStub, isMainBranch: false });
 
-      const result = await handlePushStatus(
-        {
+      const result = await handlePushStatus({
+        argv: {
           domain: 'test-domain',
           organization: 'test-org',
           project: 'test-project',
           pushId: 'test-push-id',
         },
-        mockConfig
-      );
+        config: mockConfig,
+        version: 'cli-version',
+      });
 
       expect(result).toEqual({
         preview: {
@@ -280,15 +287,16 @@ describe('handlePushStatus()', () => {
       process.env.REDOCLY_AUTHORIZATION = 'test-api-key';
       remotes.getPush.mockResolvedValue({ ...pushResponseStub, isMainBranch: true });
 
-      const result = await handlePushStatus(
-        {
+      const result = await handlePushStatus({
+        argv: {
           domain: 'test-domain',
           organization: 'test-org',
           project: 'test-project',
           pushId: 'test-push-id',
         },
-        mockConfig
-      );
+        config: mockConfig,
+        version: 'cli-version',
+      });
 
       expect(result).toEqual({
         preview: {
@@ -344,8 +352,8 @@ describe('handlePushStatus()', () => {
         },
       });
 
-      const result = await handlePushStatus(
-        {
+      const result = await handlePushStatus({
+        argv: {
           domain: 'test-domain',
           organization: 'test-org',
           project: 'test-project',
@@ -353,8 +361,9 @@ describe('handlePushStatus()', () => {
           'retry-interval': 0.5, // 500 ms
           wait: true,
         },
-        mockConfig
-      );
+        config: mockConfig,
+        version: 'cli-version',
+      });
 
       expect(result).toEqual({
         preview: {
@@ -417,8 +426,8 @@ describe('handlePushStatus()', () => {
         },
       });
 
-      const result = await handlePushStatus(
-        {
+      const result = await handlePushStatus({
+        argv: {
           domain: 'test-domain',
           organization: 'test-org',
           project: 'test-project',
@@ -426,8 +435,9 @@ describe('handlePushStatus()', () => {
           'retry-interval': 0.5, // 500 ms
           wait: true,
         },
-        mockConfig
-      );
+        config: mockConfig,
+        version: 'cli-version',
+      });
 
       expect(result).toEqual({
         preview: {
@@ -458,16 +468,17 @@ describe('handlePushStatus()', () => {
       });
 
       await expect(
-        handlePushStatus(
-          {
+        handlePushStatus({
+          argv: {
             domain: 'test-domain',
             organization: 'test-org',
             project: 'test-project',
             pushId: 'test-push-id',
             'continue-on-deploy-failures': false,
           },
-          mockConfig
-        )
+          config: mockConfig,
+          version: 'cli-version',
+        })
       ).rejects.toThrowErrorMatchingInlineSnapshot(`
         "❌ Preview deploy fail.
         Preview URL: https://preview-test-url"
@@ -488,16 +499,17 @@ describe('handlePushStatus()', () => {
       });
 
       await expect(
-        handlePushStatus(
-          {
+        handlePushStatus({
+          argv: {
             domain: 'test-domain',
             organization: 'test-org',
             project: 'test-project',
             pushId: 'test-push-id',
             'continue-on-deploy-failures': true,
           },
-          mockConfig
-        )
+          config: mockConfig,
+          version: 'cli-version',
+        })
       ).resolves.toStrictEqual({
         preview: {
           deploy: { status: 'failed', url: 'https://preview-test-url' },
@@ -545,8 +557,8 @@ describe('handlePushStatus()', () => {
 
       const onRetrySpy = jest.fn();
 
-      const result = await handlePushStatus(
-        {
+      const result = await handlePushStatus({
+        argv: {
           domain: 'test-domain',
           organization: 'test-org',
           project: 'test-project',
@@ -555,8 +567,9 @@ describe('handlePushStatus()', () => {
           'retry-interval': 0.5, // 500 ms
           onRetry: onRetrySpy,
         },
-        mockConfig
-      );
+        config: mockConfig,
+        version: 'cli-version',
+      });
 
       expect(onRetrySpy).toBeCalledTimes(2);
 
@@ -617,8 +630,8 @@ describe('handlePushStatus()', () => {
       });
 
       await expect(
-        handlePushStatus(
-          {
+        handlePushStatus({
+          argv: {
             domain: 'test-domain',
             organization: 'test-org',
             project: 'test-project',
@@ -627,8 +640,9 @@ describe('handlePushStatus()', () => {
             'max-execution-time': 1, // seconds
             wait: true,
           },
-          mockConfig
-        )
+          config: mockConfig,
+          version: 'cli-version',
+        })
       ).rejects.toThrowErrorMatchingInlineSnapshot(`
         "✗ Failed to get push status. Reason: Timeout exceeded
         "

package/src/cms/commands/__tests__/push.test.ts

@@ -63,8 +63,8 @@ describe('handlePush()', () => {
     pathRelativeSpy.mockImplementationOnce((_, p) => p);
     pathDirnameSpy.mockImplementation((_: string) => '.');
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         domain: 'test-domain',
         'mount-path': 'test-mount-path',
         organization: 'test-org',
@@ -81,8 +81,9 @@ describe('handlePush()', () => {
         files: ['test-file'],
         'max-execution-time': 10,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(remotes.getDefaultBranch).toHaveBeenCalledWith('test-org', 'test-project');
     expect(remotes.upsert).toHaveBeenCalledWith('test-org', 'test-project', {
@@ -132,8 +133,8 @@ describe('handlePush()', () => {
     pathRelativeSpy.mockImplementationOnce((_, p) => p);
     pathDirnameSpy.mockImplementation((_: string) => '.');
 
-    const result = await handlePush(
-      {
+    const result = await handlePush({
+      argv: {
         domain: 'test-domain',
         'mount-path': 'test-mount-path',
         organization: 'test-org',
@@ -150,8 +151,9 @@ describe('handlePush()', () => {
         files: ['test-file'],
         'max-execution-time': 10,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(result).toEqual({ pushId: 'test-id' });
   });
@@ -188,8 +190,8 @@ describe('handlePush()', () => {
       throw new Error('Not a directory');
     });
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         domain: 'test-domain',
         'mount-path': 'test-mount-path',
         organization: 'test-org',
@@ -201,8 +203,9 @@ describe('handlePush()', () => {
         files: ['test-folder'],
         'max-execution-time': 10,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(remotes.push).toHaveBeenCalledWith(
       expect.anything(),
@@ -230,8 +233,8 @@ describe('handlePush()', () => {
     const mockConfig = { apis: {} } as any;
     process.env.REDOCLY_AUTHORIZATION = 'test-api-key';
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         domain: 'test-domain',
         'mount-path': 'test-mount-path',
         organization: 'test-org',
@@ -243,8 +246,9 @@ describe('handlePush()', () => {
         files: [],
         'max-execution-time': 10,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(remotes.getDefaultBranch).not.toHaveBeenCalled();
     expect(remotes.upsert).not.toHaveBeenCalled();
@@ -265,8 +269,8 @@ describe('handlePush()', () => {
     pathRelativeSpy.mockImplementationOnce((_, p) => p);
     pathDirnameSpy.mockImplementation((_: string) => '.');
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         domain: 'test-domain',
         'mount-path': 'test-mount-path',
         project: 'test-project',
@@ -277,8 +281,9 @@ describe('handlePush()', () => {
         'default-branch': 'main',
         'max-execution-time': 10,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(remotes.getDefaultBranch).toHaveBeenCalledWith(
       'test-org-from-config',
@@ -312,8 +317,8 @@ describe('handlePush()', () => {
     pathRelativeSpy.mockImplementationOnce((_, p) => p);
     pathDirnameSpy.mockImplementation((_: string) => '.');
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         'mount-path': 'test-mount-path',
         project: 'test-project',
         branch: 'test-branch',
@@ -323,8 +328,9 @@ describe('handlePush()', () => {
         files: ['test-file'],
         'max-execution-time': 10,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(ReuniteApiClient).toBeCalledWith('test-domain-from-env', 'test-api-key');
   });

package/src/cms/commands/push-status.ts

@@ -1,18 +1,19 @@
 import * as colors from 'colorette';
-import type { Config, OutputFormat } from '@redocly/openapi-core';
-
 import { exitWithError, printExecutionTime } from '../../utils/miscellaneous';
 import { Spinner } from '../../utils/spinner';
 import { DeploymentError } from '../utils';
 import { ReuniteApiClient, getApiKeys, getDomain } from '../api';
 import { capitalize } from '../../utils/js-utils';
+import { retryUntilConditionMet } from './utils';
+
+import type { OutputFormat } from '@redocly/openapi-core';
+import type { CommandArgs } from '../../wrapper';
 import type {
   DeploymentStatus,
   DeploymentStatusResponse,
   PushResponse,
   ScorecardItem,
 } from '../api/types';
-import { retryUntilConditionMet } from './utils';
 
 const RETRY_INTERVAL_MS = 5000; // 5 sec
 
@@ -37,10 +38,10 @@ export interface PushStatusSummary {
   commit: PushResponse['commit'];
 }
 
-export async function handlePushStatus(
-  argv: PushStatusOptions,
-  config: Config
-): Promise<PushStatusSummary | undefined> {
+export async function handlePushStatus({
+  argv,
+  config,
+}: CommandArgs<PushStatusOptions>): Promise<PushStatusSummary | undefined> {
   const startedAt = performance.now();
   const spinner = new Spinner();
 

package/src/cms/commands/push.ts

@@ -11,7 +11,8 @@ import {
 import { handlePushStatus } from './push-status';
 import { ReuniteApiClient, getDomain, getApiKeys } from '../api';
 
-import type { OutputFormat, Config } from '@redocly/openapi-core';
+import type { OutputFormat } from '@redocly/openapi-core';
+import type { CommandArgs } from '../../wrapper';
 
 export type PushOptions = {
   apis?: string[];
@@ -42,10 +43,11 @@ export type PushOptions = {
 
 type FileToUpload = { name: string; path: string };
 
-export async function handlePush(
-  argv: PushOptions,
-  config: Config
-): Promise<{ pushId: string } | void> {
+export async function handlePush({
+  argv,
+  config,
+  version,
+}: CommandArgs<PushOptions>): Promise<{ pushId: string } | void> {
   const startedAt = performance.now(); // for printing execution time
   const startTime = Date.now(); // for push-status command
 
@@ -131,8 +133,8 @@ export async function handlePush(
     if (waitForDeployment) {
       process.stdout.write('\n');
 
-      await handlePushStatus(
-        {
+      await handlePushStatus({
+        argv: {
           organization: orgId,
           project: projectId,
           pushId: id,
@@ -142,8 +144,9 @@ export async function handlePush(
           'start-time': startTime,
           'continue-on-deploy-failures': argv['continue-on-deploy-failures'],
         },
-        config
-      );
+        config,
+        version,
+      });
     }
     verbose &&
       printExecutionTime(

package/src/commands/build-docs/index.ts

@@ -2,17 +2,21 @@ import { loadAndBundleSpec } from 'redoc';
 import { dirname, resolve } from 'path';
 import { writeFileSync, mkdirSync } from 'fs';
 import { performance } from 'perf_hooks';
-
+import { getMergedConfig, isAbsoluteUrl } from '@redocly/openapi-core';
 import { getObjectOrJSON, getPageHTML } from './utils';
-import type { BuildDocsArgv } from './types';
-import { Config, getMergedConfig, isAbsoluteUrl } from '@redocly/openapi-core';
 import { exitWithError, getExecutionTime, getFallbackApisOrExit } from '../../utils/miscellaneous';
 
-export const handlerBuildCommand = async (argv: BuildDocsArgv, configFromFile: Config) => {
+import type { BuildDocsArgv } from './types';
+import type { CommandArgs } from '../../wrapper';
+
+export const handlerBuildCommand = async ({
+  argv,
+  config: configFromFile,
+  collectSpecData,
+}: CommandArgs<BuildDocsArgv>) => {
   const startedAt = performance.now();
 
   const config = getMergedConfig(configFromFile, argv.api);
-
   const apis = await getFallbackApisOrExit(argv.api ? [argv.api] : [], config);
   const { path: pathToApi } = apis[0];
 
@@ -31,6 +35,7 @@ export const handlerBuildCommand = async (argv: BuildDocsArgv, configFromFile: C
     const elapsed = getExecutionTime(startedAt);
 
     const api = await loadAndBundleSpec(isAbsoluteUrl(pathToApi) ? pathToApi : resolve(pathToApi));
+    collectSpecData?.(api);
     const pageHTML = await getPageHTML(
       api,
       pathToApi,

package/src/commands/bundle.ts

@@ -1,4 +1,7 @@
-import { formatProblems, getTotals, getMergedConfig, bundle, Config } from '@redocly/openapi-core';
+import { performance } from 'perf_hooks';
+import { blue, gray, green, yellow } from 'colorette';
+import { writeFileSync } from 'fs';
+import { formatProblems, getTotals, getMergedConfig, bundle } from '@redocly/openapi-core';
 import {
   dumpBundle,
   getExecutionTime,
@@ -8,12 +11,11 @@ import {
   printUnusedWarnings,
   saveBundle,
   sortTopLevelKeysForOas,
+  checkForDeprecatedOptions,
 } from '../utils/miscellaneous';
+
 import type { OutputExtensions, Skips, Totals } from '../types';
-import { performance } from 'perf_hooks';
-import { blue, gray, green, yellow } from 'colorette';
-import { writeFileSync } from 'fs';
-import { checkForDeprecatedOptions } from '../utils/miscellaneous';
+import type { CommandArgs } from '../wrapper';
 
 export type BundleOptions = {
   apis?: string[];
@@ -28,7 +30,12 @@ export type BundleOptions = {
   'keep-url-references'?: boolean;
 } & Skips;
 
-export async function handleBundle(argv: BundleOptions, config: Config, version: string) {
+export async function handleBundle({
+  argv,
+  config,
+  version,
+  collectSpecData,
+}: CommandArgs<BundleOptions>) {
   const removeUnusedComponents =
     argv['remove-unused-components'] ||
     config.rawConfig?.styleguide?.decorators?.hasOwnProperty('remove-unused-components');
@@ -59,6 +66,7 @@ export async function handleBundle(argv: BundleOptions, config: Config, version:
         dereference: argv.dereferenced,
         removeUnusedComponents,
         keepUrlRefs: argv['keep-url-references'],
+        collectSpecData,
       });
 
       const fileTotals = getTotals(problems);