@redocly/cli 1.18.0 → 1.19.0

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

@@ -25,8 +25,8 @@ describe('push', () => {
   });
 
   it('pushes definition', async () => {
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: '@org/my-api@1.0.0',
@@ -35,8 +35,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      ConfigFixture as any
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(redoclyClient.registryApi.prepareFileUpload).toBeCalledTimes(1);
     expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
@@ -55,8 +56,8 @@ describe('push', () => {
   });
 
   it('fails if jobId value is an empty string', async () => {
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: '@org/my-api@1.0.0',
@@ -65,15 +66,16 @@ describe('push', () => {
         'job-id': ' ',
         'batch-size': 2,
       },
-      ConfigFixture as any
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toBeCalledTimes(1);
   });
 
   it('fails if batchSize value is less than 2', async () => {
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: '@org/my-api@1.0.0',
@@ -82,8 +84,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 1,
       },
-      ConfigFixture as any
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toBeCalledTimes(1);
   });
@@ -95,16 +98,17 @@ describe('push', () => {
       return { isDirectory: () => false, size: 10 };
     });
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: '@org/my-api@1.0.0',
         public: true,
         files: ['./resouces/1.md', './resouces/2.md'],
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
       filePaths: ['filePath', 'filePath', 'filePath'],
@@ -119,8 +123,8 @@ describe('push', () => {
   });
 
   it('push should fail if organization not provided', async () => {
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: 'test@v1',
@@ -129,8 +133,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      ConfigFixture as any
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toBeCalledTimes(1);
     expect(exitWithError).toBeCalledWith(
@@ -140,8 +145,8 @@ describe('push', () => {
 
   it('push should work with organization in config', async () => {
     const mockConfig = { ...ConfigFixture, organization: 'test_org' } as any;
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: 'my-api@1.0.0',
@@ -150,8 +155,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
     expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
@@ -175,16 +181,17 @@ describe('push', () => {
       apis: { 'my-api@1.0.0': { root: 'path' } },
     } as any;
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         branchName: 'test',
         public: true,
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
   });
@@ -192,16 +199,17 @@ describe('push', () => {
   it('push should fail if apis not provided', async () => {
     const mockConfig = { organization: 'test_org', apis: {} } as any;
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         branchName: 'test',
         public: true,
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toBeCalledTimes(1);
     expect(exitWithError).toHaveBeenLastCalledWith(
@@ -212,8 +220,8 @@ describe('push', () => {
   it('push should fail if destination not provided', async () => {
     const mockConfig = { organization: 'test_org', apis: {} } as any;
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'api.yaml',
         branchName: 'test',
@@ -221,8 +229,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toBeCalledTimes(1);
     expect(exitWithError).toHaveBeenLastCalledWith(
@@ -233,8 +242,8 @@ describe('push', () => {
   it('push should fail if destination format is not valid', async () => {
     const mockConfig = { organization: 'test_org', apis: {} } as any;
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         destination: 'name/v1',
         branchName: 'test',
@@ -242,8 +251,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toHaveBeenCalledWith(
       `Destination argument value is not valid, please use the right format: ${yellow(
@@ -261,8 +271,8 @@ describe('push', () => {
       apis: { 'my test api@v1': { root: 'path' } },
     } as any;
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         destination: 'my test api@v1',
         branchName: 'test',
@@ -270,8 +280,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(encodeURIComponentSpy).toHaveReturnedWith('my%20test%20api');
     expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
@@ -281,130 +292,144 @@ describe('push', () => {
 describe('transformPush', () => {
   it('should adapt the existing syntax', () => {
     const cb = jest.fn();
-    transformPush(cb)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['openapi.yaml', '@testing_org/main@v1'],
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      config: {} as any,
+      version: 'cli-version',
+    });
+    expect(cb).toBeCalledWith({
+      argv: {
         api: 'openapi.yaml',
         destination: '@testing_org/main@v1',
       },
-      {}
-    );
+      config: {},
+      version: 'cli-version',
+    });
   });
   it('should adapt the existing syntax (including branchName)', () => {
     const cb = jest.fn();
-    transformPush(cb)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['openapi.yaml', '@testing_org/main@v1', 'other'],
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      config: {} as any,
+      version: 'cli-version',
+    });
+    expect(cb).toBeCalledWith({
+      argv: {
         api: 'openapi.yaml',
         destination: '@testing_org/main@v1',
         branchName: 'other',
       },
-      {}
-    );
+      config: {},
+      version: 'cli-version',
+    });
   });
   it('should use --branch option firstly', () => {
     const cb = jest.fn();
-    transformPush(cb)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['openapi.yaml', '@testing_org/main@v1', 'other'],
         branch: 'priority-branch',
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      config: {} as any,
+      version: 'cli-version',
+    });
+    expect(cb).toBeCalledWith({
+      argv: {
         api: 'openapi.yaml',
         destination: '@testing_org/main@v1',
         branchName: 'priority-branch',
       },
-      {}
-    );
+      config: {},
+      version: 'cli-version',
+    });
   });
   it('should work for a destination only', () => {
     const cb = jest.fn();
-    transformPush(cb)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['main@v1'],
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      config: {} as any,
+      version: 'cli-version',
+    });
+    expect(cb).toBeCalledWith({
+      argv: {
         destination: 'main@v1',
       },
-      {}
-    );
+      config: {},
+      version: 'cli-version',
+    });
   });
   it('should work for a api only', () => {
     const cb = jest.fn();
-    transformPush(cb)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['test.yaml'],
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      config: {} as any,
+      version: 'cli-version',
+    });
+    expect(cb).toBeCalledWith({
+      argv: {
         api: 'test.yaml',
       },
-      {}
-    );
+      config: {},
+      version: 'cli-version',
+    });
   });
 
   it('should use destination from option', () => {
     const cb = jest.fn();
-    transformPush(cb)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['test.yaml', 'test@v1'],
         destination: 'main@v1',
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      config: {} as any,
+      version: 'cli-version',
+    });
+    expect(cb).toBeCalledWith({
+      argv: {
         destination: 'main@v1',
         api: 'test.yaml',
       },
-      {}
-    );
+      config: {},
+      version: 'cli-version',
+    });
   });
 
   it('should use --job-id option firstly', () => {
     const cb = jest.fn();
-    transformPush(cb)(
-      {
+    transformPush(cb)({
+      argv: {
         'batch-id': 'b-123',
         'job-id': 'j-123',
         apis: ['test'],
         branch: 'test',
         destination: 'main@v1',
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      config: {} as any,
+      version: 'cli-version',
+    });
+    expect(cb).toBeCalledWith({
+      argv: {
         'job-id': 'j-123',
         api: 'test',
         branchName: 'test',
         destination: 'main@v1',
       },
-      {}
-    );
+      config: {},
+      version: 'cli-version',
+    });
   });
   it('should accept no arguments at all', () => {
     const cb = jest.fn();
-    transformPush(cb)({}, {} as any);
-    expect(cb).toBeCalledWith({}, {});
+    transformPush(cb)({ argv: {}, config: {} as any, version: 'cli-version' });
+    expect(cb).toBeCalledWith({ argv: {}, config: {}, version: 'cli-version' });
   });
 });
 

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 () => {