@redocly/cli 1.0.0-beta.129 → 1.0.0-beta.130

package/lib/__tests__/fetch-with-timeout.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/__tests__/fetch-with-timeout.test.js

@@ -0,0 +1,38 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fetch_with_timeout_1 = require("../fetch-with-timeout");
+const node_fetch_1 = require("node-fetch");
+jest.mock('node-fetch');
+describe('fetchWithTimeout', () => {
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+    it('should use bare node-fetch if AbortController is not available', () => __awaiter(void 0, void 0, void 0, function* () {
+        // @ts-ignore
+        global.AbortController = undefined;
+        // @ts-ignore
+        global.setTimeout = jest.fn();
+        yield fetch_with_timeout_1.default('url', { method: 'GET' });
+        expect(node_fetch_1.default).toHaveBeenCalledWith('url', { method: 'GET' });
+        expect(global.setTimeout).toHaveBeenCalledTimes(0);
+    }));
+    it('should call node-fetch with signal if AbortController is  available', () => __awaiter(void 0, void 0, void 0, function* () {
+        global.AbortController = jest.fn().mockImplementation(() => ({ signal: 'something' }));
+        // @ts-ignore
+        global.setTimeout = jest.fn();
+        global.clearTimeout = jest.fn();
+        yield fetch_with_timeout_1.default('url');
+        expect(global.setTimeout).toHaveBeenCalledTimes(1);
+        expect(node_fetch_1.default).toHaveBeenCalledWith('url', { signal: 'something' });
+        expect(global.clearTimeout).toHaveBeenCalledTimes(1);
+    }));
+});

package/lib/__tests__/utils.test.js

@@ -399,16 +399,23 @@ describe('cleanArgs', () => {
     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 args', () => {
         const testArgs = {
-            config: 'some-folder/redocly.yaml',
-            apis: ['main@v1', 'openapi.yaml', 'http://some.url/openapi.yaml'],
+            config: './fixtures/redocly.yaml',
+            apis: ['main@v1', 'fixtures/openapi.yaml', 'http://some.url/openapi.yaml'],
             format: 'codeframe',
         };
         expect(utils_1.cleanArgs(testArgs)).toEqual({
-            config: '***.yaml',
-            apis: ['main@v1', '***.yaml', 'http://***'],
+            config: 'file-yaml',
+            apis: ['api-name@api-version', 'file-yaml', 'http://url'],
             format: 'codeframe',
         });
     });
@@ -417,22 +424,46 @@ describe('cleanArgs', () => {
             destination: '@org/name@version',
         };
         expect(utils_1.cleanArgs(testArgs)).toEqual({
-            destination: '@***/name@version',
+            destination: '@organization/api-name@api-version',
         });
     });
 });
 describe('cleanRawInput', () => {
-    it('should remove  potentially sensitive data from raw CLI input', () => {
+    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', () => {
         const rawInput = [
             'redocly',
-            'lint',
-            'main@v1',
-            'openapi.yaml',
+            'bundle',
+            'api-name@api-version',
+            './fixtures/openapi.yaml',
             'http://some.url/openapi.yaml',
-            '--config=some-folder/redocly.yaml',
+            '--config=fixtures/redocly.yaml',
+            '--output',
+            'fixtures',
+        ];
+        expect(utils_1.cleanRawInput(rawInput)).toEqual('redocly bundle api-name@api-version file-yaml http://url --config=file-yaml --output folder');
+    });
+    it('should preserve safe data from raw CLI input', () => {
+        const rawInput = [
+            'redocly',
+            'lint',
+            './fixtures/openapi.json',
+            '--format',
+            'stylish',
+            '--extends=minimal',
+            '--skip-rule',
+            'operation-4xx-response',
         ];
-        expect(utils_1.cleanRawInput(rawInput)).toEqual('redocly lint main@v1 ***.yaml http://*** --config=***.yaml');
+        expect(utils_1.cleanRawInput(rawInput)).toEqual('redocly lint file-json --format stylish --extends=minimal --skip-rule operation-4xx-response');
     });
 });

package/lib/__tests__/wrapper.test.js

@@ -13,6 +13,7 @@ const utils_1 = require("../utils");
 const process = require("process");
 const wrapper_1 = require("../wrapper");
 const lint_1 = require("../commands/lint");
+const push_1 = require("../commands/push");
 jest.mock('node-fetch');
 jest.mock('../utils', () => ({
     sendTelemetry: jest.fn(),
@@ -44,4 +45,13 @@ describe('commandWrapper', () => {
         expect(lint_1.handleLint).toHaveBeenCalledTimes(1);
         expect(utils_1.sendTelemetry).toHaveBeenCalledTimes(0);
     }));
+    it('should pass files from arguments to config', () => __awaiter(void 0, void 0, void 0, function* () {
+        const filesToPush = ['test1.yaml', 'test2.yaml'];
+        const loadConfigMock = utils_1.loadConfigAndHandleErrors;
+        const argv = {
+            files: filesToPush,
+        };
+        yield wrapper_1.commandWrapper(push_1.handlePush)(argv);
+        expect(loadConfigMock).toHaveBeenCalledWith(expect.objectContaining({ files: filesToPush }));
+    }));
 });

package/lib/fetch-with-timeout.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (url: string, options?: {}) => Promise<import("node-fetch").Response>;
+export default _default;

package/lib/fetch-with-timeout.js

@@ -0,0 +1,25 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fetch_1 = require("node-fetch");
+const TIMEOUT = 3000;
+exports.default = (url, options = {}) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!global.AbortController) {
+        return node_fetch_1.default(url, options);
+    }
+    const controller = new AbortController();
+    const timeout = setTimeout(() => {
+        controller.abort();
+    }, TIMEOUT);
+    const res = yield node_fetch_1.default(url, Object.assign({ signal: controller.signal }, options));
+    clearTimeout(timeout);
+    return res;
+});

package/lib/update-version-notifier.js

@@ -15,7 +15,7 @@ const os_1 = require("os");
 const path_1 = require("path");
 const fs_1 = require("fs");
 const semver_1 = require("semver");
-const node_fetch_1 = require("node-fetch");
+const fetch_with_timeout_1 = require("./fetch-with-timeout");
 const colorette_1 = require("colorette");
 const utils_1 = require("./utils");
 _a = require('../package.json'), exports.version = _a.version, exports.name = _a.name;
@@ -41,7 +41,7 @@ exports.notifyUpdateCliVersion = notifyUpdateCliVersion;
 const isNewVersionAvailable = (current, latest) => semver_1.compare(current, latest) < 0;
 const getLatestVersion = (packageName) => __awaiter(void 0, void 0, void 0, function* () {
     const latestUrl = `http://registry.npmjs.org/${packageName}/latest`;
-    const response = yield node_fetch_1.default(latestUrl);
+    const response = yield fetch_with_timeout_1.default(latestUrl);
     const info = yield response.json();
     return info.version;
 });

package/lib/utils.d.ts

@@ -54,6 +54,7 @@ export declare type Analytics = {
     version: string;
     exit_code: ExitCode;
     environment?: string;
+    environment_ci?: string;
     raw_input: string;
     has_config?: boolean;
 };

package/lib/utils.js

@@ -21,7 +21,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cleanRawInput = exports.cleanArgs = exports.sendTelemetry = exports.cleanColors = exports.checkIfRulesetExist = exports.sortTopLevelKeysForOas = exports.loadConfigAndHandleErrors = exports.isSubdir = exports.exitWithError = exports.printUnusedWarnings = exports.getOutputFileName = exports.printConfigLintTotals = exports.printLintTotals = exports.HandledError = exports.handleError = exports.pluralize = exports.writeYaml = exports.readYaml = exports.promptUser = exports.saveBundle = exports.dumpBundle = exports.CircularJSONNotSupportedError = exports.langToExt = exports.escapeLanguageName = exports.pathToFilename = exports.printExecutionTime = exports.getExecutionTime = exports.getFallbackApisOrExit = void 0;
-const node_fetch_1 = require("node-fetch");
+const fetch_with_timeout_1 = require("./fetch-with-timeout");
 const path_1 = require("path");
 const colorette_1 = require("colorette");
 const perf_hooks_1 = require("perf_hooks");
@@ -417,7 +417,6 @@ function sendTelemetry(argv, exit_code, has_config) {
             const { _: [command], $0: _ } = argv, args = __rest(argv, ["_", "$0"]);
             const event_time = new Date().toISOString();
             const redoclyClient = new openapi_core_1.RedoclyClient();
-            const node_version = process.version;
             const logged_in = yield redoclyClient.isAuthorizedWithRedoclyByRegion();
             const data = {
                 event: 'cli_command',
@@ -425,14 +424,15 @@ function sendTelemetry(argv, exit_code, has_config) {
                 logged_in,
                 command,
                 arguments: cleanArgs(args),
-                node_version,
+                node_version: process.version,
                 version: update_version_notifier_1.version,
                 exit_code,
                 environment: process.env.REDOCLY_ENVIRONMENT,
+                environment_ci: process.env.CI,
                 raw_input: cleanRawInput(process.argv.slice(2)),
                 has_config,
             };
-            yield node_fetch_1.default(`https://api.redocly.com/registry/telemetry/cli`, {
+            yield fetch_with_timeout_1.default(`https://api.redocly.com/registry/telemetry/cli`, {
                 method: 'POST',
                 headers: {
                     'content-type': 'application/json',
@@ -446,18 +446,27 @@ function sendTelemetry(argv, exit_code, has_config) {
     });
 }
 exports.sendTelemetry = sendTelemetry;
+function isFile(value) {
+    return fs.existsSync(value) && fs.statSync(value).isFile();
+}
+function isDirectory(value) {
+    return fs.existsSync(value) && fs.statSync(value).isDirectory();
+}
 function cleanString(value) {
     if (!value) {
         return value;
     }
     if (openapi_core_1.isAbsoluteUrl(value)) {
-        return value.split('://')[0] + '://***';
+        return value.split('://')[0] + '://url';
+    }
+    if (isFile(value)) {
+        return value.replace(/.+\.([^.]+)$/, (_, ext) => 'file-' + ext);
     }
-    if (value.endsWith('.json') || value.endsWith('.yaml') || value.endsWith('.yml')) {
-        return value.replace(/^(.*)\.(yaml|yml|json)$/gi, (_, __, ext) => '***.' + ext);
+    if (isDirectory(value)) {
+        return 'folder';
     }
     if (push_1.DESTINATION_REGEX.test(value)) {
-        return value.replace(/^@[\w\-\s]+\//, () => '@***/');
+        return value.startsWith('@') ? '@organization/api-name@api-version' : 'api-name@api-version';
     }
     return value;
 }

package/lib/wrapper.js

@@ -27,7 +27,7 @@ function commandWrapper(commandHandler) {
                 configPath: argv.config,
                 customExtends: argv.extends,
                 region: argv.region,
-                files: argv.file,
+                files: argv.files,
                 processRawConfig: lint_1.lintConfigCallback(argv, update_version_notifier_1.version),
             }));
             telemetry = config.telemetry;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.0.0-beta.129",
+  "version": "1.0.0-beta.130",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -33,23 +33,25 @@
     "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.0.0-beta.129",
+    "@redocly/openapi-core": "1.0.0-beta.130",
     "assert-node-version": "^1.0.3",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",
     "glob": "^7.1.6",
     "glob-promise": "^3.4.0",
     "handlebars": "^4.7.6",
-    "mobx": "^6.3.2",
     "portfinder": "^1.0.26",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
     "redoc": "~2.0.0",
     "semver": "^7.5.2",
     "simple-websocket": "^9.0.0",
-    "styled-components": "5.3.3",
     "yargs": "17.0.1"
   },
+  "peerDependencies": {
+    "mobx": "^6.0.4",
+    "react": "^16.8.4 || ^17.0.0",
+    "react-dom": "^16.8.4 || ^17.0.0",
+    "styled-components": "^4.1.1 || ^5.1.1"
+  },
   "devDependencies": {
     "@types/configstore": "^5.0.1",
     "@types/react": "^17.0.8",