@redocly/cli 1.34.0 → 1.34.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @redocly/cli
 
+## 1.34.1
+
+### Patch Changes
+
+- Improved OpenTelemetry data serialization.
+- Updated @redocly/respect-core to v1.34.1.
+
 ## 1.34.0
 
 ### Minor Changes

package/README.md

@@ -16,7 +16,7 @@ Supports OpenAPI 3.1, 3.0 and OpenAPI 2.0 (legacy Swagger), AsyncAPI 3.0 and 2.6
 ### Node
 
 ```sh
-npx @redocly/cli lint path-to-root-file.yaml
+npx @redocly/cli@latest lint path-to-root-file.yaml
 ```
 
 Alternatively, install it globally with `npm`:

package/lib/__tests__/utils.test.js

@@ -441,8 +441,8 @@ describe('cleanArgs', () => {
     afterEach(() => {
         jest.clearAllMocks();
     });
-    it('should remove potentially sensitive data from args', () => {
-        const testArgs = {
+    it('should remove potentially sensitive data from parsed args', () => {
+        const parsedArgs = {
             config: './fixtures/redocly.yaml',
             apis: ['main@v1', 'fixtures/openapi.yaml', 'http://some.url/openapi.yaml'],
             format: 'codeframe',
@@ -451,7 +451,21 @@ describe('cleanArgs', () => {
             'client-key': 'some-client-key',
             'ca-cert': 'some-ca-cert',
         };
-        expect((0, miscellaneous_1.cleanArgs)(testArgs)).toEqual({
+        const rawArgs = [
+            'redocly',
+            'bundle',
+            'main@v1',
+            'fixtures/openapi.yaml',
+            'http://some.url/openapi.yaml',
+            '--config=fixtures/redocly.yaml',
+            '--format=codeframe',
+            '--input=some-input',
+            '--client-cert=some-client-cert',
+            '--client-key=some-client-key',
+            '--ca-cert=some-ca-cert',
+        ];
+        const result = (0, miscellaneous_1.cleanArgs)(parsedArgs, rawArgs);
+        expect(result.arguments).toEqual(JSON.stringify({
             config: 'file-yaml',
             apis: ['api-name@api-version', 'file-yaml', 'http://url'],
             format: 'codeframe',
@@ -459,30 +473,19 @@ describe('cleanArgs', () => {
             'client-cert': '***',
             'client-key': '***',
             'ca-cert': '***',
-        });
+        }));
     });
     it('should remove potentially sensitive data from a push destination', () => {
-        const testArgs = {
+        const parsedArgs = {
             destination: '@org/name@version',
         };
-        expect((0, miscellaneous_1.cleanArgs)(testArgs)).toEqual({
+        const rawArgs = ['redocly', 'push', '--destination=@org/name@version'];
+        const result = (0, miscellaneous_1.cleanArgs)(parsedArgs, rawArgs);
+        expect(result.arguments).toEqual(JSON.stringify({
             destination: '@organization/api-name@api-version',
-        });
-    });
-});
-describe('cleanRawInput', () => {
-    beforeEach(() => {
-        // @ts-ignore
-        openapi_core_1.isAbsoluteUrl = jest.requireActual('@redocly/openapi-core').isAbsoluteUrl;
-        // @ts-ignore
-        fs_1.existsSync = (value) => jest.requireActual('fs').existsSync(path.resolve(__dirname, value));
-        // @ts-ignore
-        fs_1.statSync = (value) => jest.requireActual('fs').statSync(path.resolve(__dirname, value));
+        }));
     });
-    afterEach(() => {
-        jest.clearAllMocks();
-    });
-    it('should remove  potentially sensitive data from raw CLI input', () => {
+    it('should remove potentially sensitive data from raw CLI input', () => {
         const rawInput = [
             'redocly',
             'bundle',
@@ -492,8 +495,41 @@ describe('cleanRawInput', () => {
             '--config=fixtures/redocly.yaml',
             '--output',
             'fixtures',
+            '--client-cert',
+            'fixtures/client-cert.pem',
+            '--client-key',
+            'fixtures/client-key.pem',
+            '--ca-cert',
+            'fixtures/ca-cert.pem',
+            '--organization',
+            'my-org',
+            '--input',
+            'timeout=10000',
+            '--input',
+            '{"apiKey":"some=111=1111"}',
         ];
-        expect((0, miscellaneous_1.cleanRawInput)(rawInput)).toEqual('redocly bundle api-name@api-version file-yaml http://url --config=file-yaml --output folder');
+        const parsedArgs = {
+            apis: ['./fixtures/openapi.yaml', 'http://some.url/openapi.yaml'],
+            input: ['timeout=10000', '{"apiKey":"some=111=1111"}'],
+            organization: 'my-org',
+            'client-cert': 'fixtures/client-cert.pem',
+            'client-key': 'fixtures/client-key.pem',
+            'ca-cert': 'fixtures/ca-cert.pem',
+            config: 'fixtures/redocly.yaml',
+            output: 'fixtures',
+        };
+        const result = (0, miscellaneous_1.cleanArgs)(parsedArgs, rawInput);
+        expect(result.raw_input).toEqual('redocly bundle api-name@api-version file-yaml http://url --config=file-yaml --output folder --client-cert *** --client-key *** --ca-cert *** --organization *** --input *** --input ***');
+        expect(result.arguments).toEqual(JSON.stringify({
+            apis: ['file-yaml', 'http://url'],
+            input: '***',
+            organization: '***',
+            'client-cert': '***',
+            'client-key': '***',
+            'ca-cert': '***',
+            config: 'file-yaml',
+            output: 'folder',
+        }));
     });
     it('should preserve safe data from raw CLI input', () => {
         const rawInput = [
@@ -506,18 +542,31 @@ describe('cleanRawInput', () => {
             '--skip-rule',
             'operation-4xx-response',
         ];
-        expect((0, miscellaneous_1.cleanRawInput)(rawInput)).toEqual('redocly lint file-json --format stylish --extends=minimal --skip-rule operation-4xx-response');
+        const parsedArgs = {
+            apis: ['./fixtures/openapi.json'],
+            format: 'stylish',
+            extends: 'minimal',
+            'skip-rule': ['operation-4xx-response'],
+        };
+        const result = (0, miscellaneous_1.cleanArgs)(parsedArgs, rawInput);
+        expect(result.raw_input).toEqual('redocly lint file-json --format stylish --extends=minimal --skip-rule operation-4xx-response');
+        expect(result.arguments).toEqual(JSON.stringify({
+            apis: ['file-json'],
+            format: 'stylish',
+            extends: 'minimal',
+            'skip-rule': ['operation-4xx-response'],
+        }));
     });
-    describe('validateFileExtension', () => {
-        it('should return current file extension', () => {
-            expect((0, miscellaneous_1.getAndValidateFileExtension)('test.json')).toEqual('json');
-        });
-        it('should return yaml and print warning if file extension does not supported', () => {
-            const stderrMock = jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
-            colorette_1.yellow.mockImplementation((text) => text);
-            expect((0, miscellaneous_1.getAndValidateFileExtension)('test.xml')).toEqual('yaml');
-            expect(stderrMock).toHaveBeenCalledWith(`Unsupported file extension: xml. Using yaml.\n`);
-        });
+});
+describe('validateFileExtension', () => {
+    it('should return current file extension', () => {
+        expect((0, miscellaneous_1.getAndValidateFileExtension)('test.json')).toEqual('json');
+    });
+    it('should return yaml and print warning if file extension does not supported', () => {
+        const stderrMock = jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
+        colorette_1.yellow.mockImplementation((text) => text);
+        expect((0, miscellaneous_1.getAndValidateFileExtension)('test.xml')).toEqual('yaml');
+        expect(stderrMock).toHaveBeenCalledWith(`Unsupported file extension: xml. Using yaml.\n`);
     });
 });
 describe('writeToFileByExtension', () => {

package/lib/utils/miscellaneous.d.ts

@@ -75,8 +75,10 @@ export type Analytics = {
     spec_keyword?: string;
     spec_full_version?: string;
 };
-export declare function cleanArgs(args: CommandOptions): Record<string, unknown>;
-export declare function cleanRawInput(argv: string[]): string;
+export declare function cleanArgs(parsedArgs: CommandOptions, rawArgv: string[]): {
+    arguments: string;
+    raw_input: string;
+};
 export declare function checkForDeprecatedOptions<T>(argv: T, deprecatedOptions: Array<keyof T>): void;
 export declare function notifyAboutIncompatibleConfigOptions(themeOpenapiOptions: Record<string, unknown> | undefined): void;
 export declare function formatPath(path: string): string;

package/lib/utils/miscellaneous.js

@@ -28,7 +28,6 @@ exports.checkIfRulesetExist = checkIfRulesetExist;
 exports.cleanColors = cleanColors;
 exports.sendTelemetry = sendTelemetry;
 exports.cleanArgs = cleanArgs;
-exports.cleanRawInput = cleanRawInput;
 exports.checkForDeprecatedOptions = checkForDeprecatedOptions;
 exports.notifyAboutIncompatibleConfigOptions = notifyAboutIncompatibleConfigOptions;
 exports.formatPath = formatPath;
@@ -458,7 +457,7 @@ async function sendTelemetry(argv, exit_code, has_config, spec_version, spec_key
             event_time,
             logged_in: logged_in ? 'yes' : 'no',
             command: `${command}`,
-            arguments: JSON.stringify(cleanArgs(args)),
+            ...cleanArgs(args, process.argv.slice(2)),
             node_version: process.version,
             npm_version: (0, child_process_1.execSync)('npm -v').toString().replace('\n', ''),
             os_platform: os.platform(),
@@ -466,7 +465,6 @@ async function sendTelemetry(argv, exit_code, has_config, spec_version, spec_key
             exit_code,
             environment: process.env.REDOCLY_ENVIRONMENT,
             environment_ci: process.env.CI,
-            raw_input: cleanRawInput(process.argv.slice(2)),
             has_config: has_config ? 'yes' : 'no',
             spec_version,
             spec_keyword,
@@ -504,27 +502,41 @@ function cleanString(value) {
     }
     return value;
 }
-function cleanArgs(args) {
-    const keysToClean = ['organization', 'o', 'input', 'i', 'client-cert', 'client-key', 'ca-cert'];
-    const result = {};
-    for (const [key, value] of Object.entries(args)) {
-        if (keysToClean.includes(key)) {
-            result[key] = '***';
+function replaceArgs(commandInput, targets, replacement) {
+    const targetValues = Array.isArray(targets) ? targets : [targets];
+    for (const target of targetValues) {
+        commandInput = commandInput.replaceAll(target, replacement);
+    }
+    return commandInput;
+}
+function cleanArgs(parsedArgs, rawArgv) {
+    const KEYS_TO_CLEAN = ['organization', 'o', 'input', 'i', 'client-cert', 'client-key', 'ca-cert'];
+    let commandInput = rawArgv.join(' ');
+    const commandArguments = {};
+    for (const [key, value] of Object.entries(parsedArgs)) {
+        if (KEYS_TO_CLEAN.includes(key)) {
+            commandArguments[key] = '***';
+            commandInput = replaceArgs(commandInput, value, '***');
         }
         else if (typeof value === 'string') {
-            result[key] = cleanString(value);
+            const cleanedValue = cleanString(value);
+            commandArguments[key] = cleanedValue;
+            commandInput = replaceArgs(commandInput, value, cleanedValue);
         }
         else if (Array.isArray(value)) {
-            result[key] = value.map(cleanString);
+            commandArguments[key] = value.map(cleanString);
+            for (const replacedValue of value) {
+                const newValue = cleanString(replacedValue);
+                if (commandInput.includes(replacedValue)) {
+                    commandInput = commandInput.replaceAll(replacedValue, newValue);
+                }
+            }
         }
         else {
-            result[key] = value;
+            commandArguments[key] = value;
         }
     }
-    return result;
-}
-function cleanRawInput(argv) {
-    return argv.map((entry) => entry.split('=').map(cleanString).join('=')).join(' ');
+    return { arguments: JSON.stringify(commandArguments), raw_input: commandInput };
 }
 function checkForDeprecatedOptions(argv, deprecatedOptions) {
     for (const option of deprecatedOptions) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.34.0",
+  "version": "1.34.1",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -38,8 +38,8 @@
   ],
   "dependencies": {
     "@redocly/config": "^0.22.0",
-    "@redocly/openapi-core": "1.34.0",
-    "@redocly/respect-core": "1.34.0",
+    "@redocly/openapi-core": "1.34.1",
+    "@redocly/respect-core": "1.34.1",
     "abort-controller": "^3.0.0",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",

package/src/__tests__/utils.test.ts

@@ -11,7 +11,6 @@ import {
   cleanColors,
   HandledError,
   cleanArgs,
-  cleanRawInput,
   getAndValidateFileExtension,
   writeToFileByExtension,
 } from '../utils/miscellaneous';
@@ -28,7 +27,6 @@ import { blue, red, yellow } from 'colorette';
 import { existsSync, statSync } from 'fs';
 import * as path from 'path';
 import * as process from 'process';
-import { ConfigApis } from '../types';
 
 jest.mock('os');
 jest.mock('colorette');
@@ -540,8 +538,8 @@ describe('cleanArgs', () => {
   afterEach(() => {
     jest.clearAllMocks();
   });
-  it('should remove potentially sensitive data from args', () => {
-    const testArgs = {
+  it('should remove potentially sensitive data from parsed args', () => {
+    const parsedArgs = {
       config: './fixtures/redocly.yaml',
       apis: ['main@v1', 'fixtures/openapi.yaml', 'http://some.url/openapi.yaml'],
       format: 'codeframe',
@@ -550,39 +548,46 @@ describe('cleanArgs', () => {
       'client-key': 'some-client-key',
       'ca-cert': 'some-ca-cert',
     };
-    expect(cleanArgs(testArgs)).toEqual({
-      config: 'file-yaml',
-      apis: ['api-name@api-version', 'file-yaml', 'http://url'],
-      format: 'codeframe',
-      input: '***',
-      'client-cert': '***',
-      'client-key': '***',
-      'ca-cert': '***',
-    });
+    const rawArgs = [
+      'redocly',
+      'bundle',
+      'main@v1',
+      'fixtures/openapi.yaml',
+      'http://some.url/openapi.yaml',
+      '--config=fixtures/redocly.yaml',
+      '--format=codeframe',
+      '--input=some-input',
+      '--client-cert=some-client-cert',
+      '--client-key=some-client-key',
+      '--ca-cert=some-ca-cert',
+    ];
+    const result = cleanArgs(parsedArgs, rawArgs);
+    expect(result.arguments).toEqual(
+      JSON.stringify({
+        config: 'file-yaml',
+        apis: ['api-name@api-version', 'file-yaml', 'http://url'],
+        format: 'codeframe',
+        input: '***',
+        'client-cert': '***',
+        'client-key': '***',
+        'ca-cert': '***',
+      })
+    );
   });
   it('should remove potentially sensitive data from a push destination', () => {
-    const testArgs = {
+    const parsedArgs = {
       destination: '@org/name@version',
     };
-    expect(cleanArgs(testArgs)).toEqual({
-      destination: '@organization/api-name@api-version',
-    });
+    const rawArgs = ['redocly', 'push', '--destination=@org/name@version'];
+    const result = cleanArgs(parsedArgs, rawArgs);
+    expect(result.arguments).toEqual(
+      JSON.stringify({
+        destination: '@organization/api-name@api-version',
+      })
+    );
   });
-});
 
-describe('cleanRawInput', () => {
-  beforeEach(() => {
-    // @ts-ignore
-    isAbsoluteUrl = jest.requireActual('@redocly/openapi-core').isAbsoluteUrl;
-    // @ts-ignore
-    existsSync = (value) => jest.requireActual('fs').existsSync(path.resolve(__dirname, value));
-    // @ts-ignore
-    statSync = (value) => jest.requireActual('fs').statSync(path.resolve(__dirname, value));
-  });
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-  it('should remove  potentially sensitive data from raw CLI input', () => {
+  it('should remove potentially sensitive data from raw CLI input', () => {
     const rawInput = [
       'redocly',
       'bundle',
@@ -592,11 +597,47 @@ describe('cleanRawInput', () => {
       '--config=fixtures/redocly.yaml',
       '--output',
       'fixtures',
+      '--client-cert',
+      'fixtures/client-cert.pem',
+      '--client-key',
+      'fixtures/client-key.pem',
+      '--ca-cert',
+      'fixtures/ca-cert.pem',
+      '--organization',
+      'my-org',
+      '--input',
+      'timeout=10000',
+      '--input',
+      '{"apiKey":"some=111=1111"}',
     ];
-    expect(cleanRawInput(rawInput)).toEqual(
-      'redocly bundle api-name@api-version file-yaml http://url --config=file-yaml --output folder'
+    const parsedArgs = {
+      apis: ['./fixtures/openapi.yaml', 'http://some.url/openapi.yaml'],
+      input: ['timeout=10000', '{"apiKey":"some=111=1111"}'],
+      organization: 'my-org',
+      'client-cert': 'fixtures/client-cert.pem',
+      'client-key': 'fixtures/client-key.pem',
+      'ca-cert': 'fixtures/ca-cert.pem',
+      config: 'fixtures/redocly.yaml',
+      output: 'fixtures',
+    };
+    const result = cleanArgs(parsedArgs, rawInput);
+    expect(result.raw_input).toEqual(
+      'redocly bundle api-name@api-version file-yaml http://url --config=file-yaml --output folder --client-cert *** --client-key *** --ca-cert *** --organization *** --input *** --input ***'
+    );
+    expect(result.arguments).toEqual(
+      JSON.stringify({
+        apis: ['file-yaml', 'http://url'],
+        input: '***',
+        organization: '***',
+        'client-cert': '***',
+        'client-key': '***',
+        'ca-cert': '***',
+        config: 'file-yaml',
+        output: 'folder',
+      })
     );
   });
+
   it('should preserve safe data from raw CLI input', () => {
     const rawInput = [
       'redocly',
@@ -608,23 +649,40 @@ describe('cleanRawInput', () => {
       '--skip-rule',
       'operation-4xx-response',
     ];
-    expect(cleanRawInput(rawInput)).toEqual(
+    const parsedArgs = {
+      apis: ['./fixtures/openapi.json'],
+      format: 'stylish',
+      extends: 'minimal',
+      'skip-rule': ['operation-4xx-response'],
+    };
+    const result = cleanArgs(parsedArgs, rawInput);
+
+    expect(result.raw_input).toEqual(
       'redocly lint file-json --format stylish --extends=minimal --skip-rule operation-4xx-response'
     );
+
+    expect(result.arguments).toEqual(
+      JSON.stringify({
+        apis: ['file-json'],
+        format: 'stylish',
+        extends: 'minimal',
+        'skip-rule': ['operation-4xx-response'],
+      })
+    );
   });
+});
 
-  describe('validateFileExtension', () => {
-    it('should return current file extension', () => {
-      expect(getAndValidateFileExtension('test.json')).toEqual('json');
-    });
+describe('validateFileExtension', () => {
+  it('should return current file extension', () => {
+    expect(getAndValidateFileExtension('test.json')).toEqual('json');
+  });
 
-    it('should return yaml and print warning if file extension does not supported', () => {
-      const stderrMock = jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
-      (yellow as jest.Mock<any, any>).mockImplementation((text: string) => text);
+  it('should return yaml and print warning if file extension does not supported', () => {
+    const stderrMock = jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
+    (yellow as jest.Mock<any, any>).mockImplementation((text: string) => text);
 
-      expect(getAndValidateFileExtension('test.xml')).toEqual('yaml');
-      expect(stderrMock).toHaveBeenCalledWith(`Unsupported file extension: xml. Using yaml.\n`);
-    });
+    expect(getAndValidateFileExtension('test.xml')).toEqual('yaml');
+    expect(stderrMock).toHaveBeenCalledWith(`Unsupported file extension: xml. Using yaml.\n`);
   });
 });
 

package/src/utils/miscellaneous.ts

@@ -575,7 +575,7 @@ export async function sendTelemetry(
       event_time,
       logged_in: logged_in ? 'yes' : 'no',
       command: `${command}`,
-      arguments: JSON.stringify(cleanArgs(args)),
+      ...cleanArgs(args, process.argv.slice(2)),
       node_version: process.version,
       npm_version: execSync('npm -v').toString().replace('\n', ''),
       os_platform: os.platform(),
@@ -583,7 +583,6 @@ export async function sendTelemetry(
       exit_code,
       environment: process.env.REDOCLY_ENVIRONMENT,
       environment_ci: process.env.CI,
-      raw_input: cleanRawInput(process.argv.slice(2)),
       has_config: has_config ? 'yes' : 'no',
       spec_version,
       spec_keyword,
@@ -627,7 +626,7 @@ function isDirectory(value: string) {
   return fs.existsSync(value) && fs.statSync(value).isDirectory();
 }
 
-function cleanString(value?: string): string | undefined {
+function cleanString(value: string): string {
   if (!value) {
     return value;
   }
@@ -646,27 +645,44 @@ function cleanString(value?: string): string | undefined {
   return value;
 }
 
-export function cleanArgs(args: CommandOptions) {
-  const keysToClean = ['organization', 'o', 'input', 'i', 'client-cert', 'client-key', 'ca-cert'];
+function replaceArgs(
+  commandInput: string,
+  targets: string | string[],
+  replacement: string
+): string {
+  const targetValues = Array.isArray(targets) ? targets : [targets];
+  for (const target of targetValues) {
+    commandInput = commandInput.replaceAll(target, replacement);
+  }
+  return commandInput;
+}
 
-  const result: Record<string, unknown> = {};
-  for (const [key, value] of Object.entries(args)) {
-    if (keysToClean.includes(key)) {
-      result[key] = '***';
+export function cleanArgs(parsedArgs: CommandOptions, rawArgv: string[]) {
+  const KEYS_TO_CLEAN = ['organization', 'o', 'input', 'i', 'client-cert', 'client-key', 'ca-cert'];
+  let commandInput = rawArgv.join(' ');
+  const commandArguments: Record<string, string | string[]> = {};
+  for (const [key, value] of Object.entries(parsedArgs)) {
+    if (KEYS_TO_CLEAN.includes(key)) {
+      commandArguments[key] = '***';
+      commandInput = replaceArgs(commandInput, value, '***');
     } else if (typeof value === 'string') {
-      result[key] = cleanString(value);
+      const cleanedValue = cleanString(value);
+      commandArguments[key] = cleanedValue;
+      commandInput = replaceArgs(commandInput, value, cleanedValue);
     } else if (Array.isArray(value)) {
-      result[key] = value.map(cleanString);
+      commandArguments[key] = value.map(cleanString);
+      for (const replacedValue of value) {
+        const newValue = cleanString(replacedValue);
+        if (commandInput.includes(replacedValue)) {
+          commandInput = commandInput.replaceAll(replacedValue, newValue);
+        }
+      }
     } else {
-      result[key] = value;
+      commandArguments[key] = value;
     }
   }
 
-  return result;
-}
-
-export function cleanRawInput(argv: string[]) {
-  return argv.map((entry) => entry.split('=').map(cleanString).join('=')).join(' ');
+  return { arguments: JSON.stringify(commandArguments), raw_input: commandInput };
 }
 
 export function checkForDeprecatedOptions<T>(argv: T, deprecatedOptions: Array<keyof T>) {