@redocly/cli 1.9.0 → 1.10.0

package/lib/commands/split/types.d.ts

@@ -4,14 +4,13 @@ export type Definition = Oas3_1Definition | Oas3Definition | Oas2Definition;
 export interface ComponentsFiles {
     [schemas: string]: any;
 }
-export interface refObj {
+export interface RefObject {
     [$ref: string]: string;
 }
 export declare const COMPONENTS = "components";
 export declare const PATHS = "paths";
 export declare const WEBHOOKS = "webhooks";
 export declare const xWEBHOOKS = "x-webhooks";
-export declare const componentsPath = "#/components/";
 export declare enum OPENAPI3_METHOD {
     get = "get",
     put = "put",

package/lib/commands/split/types.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OPENAPI3_COMPONENT_NAMES = exports.OPENAPI3_COMPONENT = exports.OPENAPI3_METHOD_NAMES = exports.OPENAPI3_METHOD = exports.componentsPath = exports.xWEBHOOKS = exports.WEBHOOKS = exports.PATHS = exports.COMPONENTS = void 0;
+exports.OPENAPI3_COMPONENT_NAMES = exports.OPENAPI3_COMPONENT = exports.OPENAPI3_METHOD_NAMES = exports.OPENAPI3_METHOD = exports.xWEBHOOKS = exports.WEBHOOKS = exports.PATHS = exports.COMPONENTS = void 0;
 exports.COMPONENTS = 'components';
 exports.PATHS = 'paths';
 exports.WEBHOOKS = 'webhooks';
 exports.xWEBHOOKS = 'x-webhooks';
-exports.componentsPath = `#/${exports.COMPONENTS}/`;
 var OPENAPI3_METHOD;
 (function (OPENAPI3_METHOD) {
     OPENAPI3_METHOD["get"] = "get";

package/lib/utils/fetch-with-timeout.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const node_fetch_1 = require("node-fetch");
 const abort_controller_1 = require("abort-controller");
+const openapi_core_1 = require("@redocly/openapi-core");
 const TIMEOUT = 3000;
 exports.default = (url, options = {}) => __awaiter(void 0, void 0, void 0, function* () {
     try {
@@ -18,7 +19,7 @@ exports.default = (url, options = {}) => __awaiter(void 0, void 0, void 0, funct
         const timeout = setTimeout(() => {
             controller.abort();
         }, TIMEOUT);
-        const res = yield (0, node_fetch_1.default)(url, Object.assign({ signal: controller.signal }, options));
+        const res = yield (0, node_fetch_1.default)(url, Object.assign(Object.assign({ signal: controller.signal }, options), { agent: (0, openapi_core_1.getProxyAgent)() }));
         clearTimeout(timeout);
         return res;
     }

package/lib/utils/js-utils.d.ts

@@ -1,4 +1,4 @@
-export declare function isObject(obj: any): boolean;
+export declare function isObject(obj: unknown): obj is Record<string, unknown>;
 export declare function isEmptyObject(obj: any): boolean;
 export declare function isString(str: string): boolean;
 export declare function keysOf<T>(obj: T): (keyof T)[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -36,7 +36,7 @@
     "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.9.0",
+    "@redocly/openapi-core": "1.10.0",
     "abort-controller": "^3.0.0",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",

package/src/__mocks__/@redocly/openapi-core.ts

@@ -1,5 +1,5 @@
 import { ConfigFixture } from './../../__tests__/fixtures/config';
-import { firstDocument, secondDocument } from '../documents';
+import { firstDocument, secondDocument, thirdDocument } from '../documents';
 
 import type { Document } from '@redocly/openapi-core';
 
@@ -21,6 +21,7 @@ export const __redoclyClient = {
 export const RedoclyClient = jest.fn(() => __redoclyClient);
 export const loadConfig = jest.fn(() => ConfigFixture);
 export const getMergedConfig = jest.fn();
+export const getProxyAgent = jest.fn();
 export const lint = jest.fn();
 export const bundle = jest.fn(() => ({ bundle: { parsed: null }, problems: null }));
 export const getTotals = jest.fn(() => ({ errors: 0 }));
@@ -47,6 +48,9 @@ export class BaseResolver {
     )
     .mockImplementationOnce(() =>
       Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: secondDocument })
+    )
+    .mockImplementationOnce(() =>
+      Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: thirdDocument })
     );
 }
 

package/src/__mocks__/documents.ts

@@ -4,7 +4,7 @@ export const firstDocument = {
   info: {
     description: 'example test',
     version: '1.0.0',
-    title: 'Swagger Petstore',
+    title: 'First API',
     termsOfService: 'http://swagger.io/terms/',
     license: {
       name: 'Apache 2.0',
@@ -36,7 +36,7 @@ export const secondDocument = {
   info: {
     description: 'example test',
     version: '1.0.0',
-    title: 'Swagger Petstore',
+    title: 'Second API',
     termsOfService: 'http://swagger.io/terms/',
     license: {
       name: 'Apache 2.0',
@@ -61,3 +61,64 @@ export const secondDocument = {
   },
   components: {},
 };
+
+export const thirdDocument = {
+  openapi: '3.0.0',
+  info: {
+    title: 'Third API',
+    version: '1.0',
+  },
+  servers: [
+    {
+      url: 'https://api.server.test/v1',
+    },
+  ],
+  paths: {},
+  components: {
+    schemas: {
+      SchemaWithNull: {
+        type: 'string',
+        default: null,
+        nullable: true,
+      },
+      SchemaWithRef: {
+        type: 'object',
+        properties: {
+          schemaType: {
+            type: 'string',
+            enum: ['foo'],
+          },
+          foo: {
+            $ref: '#/components/schemas/SchemaWithNull',
+          },
+        },
+      },
+      SchemaWithDiscriminator: {
+        discriminator: {
+          propertyName: 'schemaType',
+          mapping: {
+            foo: '#/components/schemas/SchemaWithRef',
+            bar: '#/components/schemas/SchemaWithNull',
+          },
+        },
+        oneOf: [
+          {
+            $ref: '#/components/schemas/SchemaWithRef',
+          },
+          {
+            type: 'object',
+            properties: {
+              schemaType: {
+                type: 'string',
+                enum: ['bar'],
+              },
+              bar: {
+                type: 'string',
+              },
+            },
+          },
+        ],
+      },
+    },
+  },
+};

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

@@ -1,7 +1,7 @@
-import { handleJoin } from '../../commands/join';
-import { exitWithError, writeToFileByExtension, writeYaml } from '../../utils/miscellaneous';
 import { yellow } from 'colorette';
 import { detectSpec } from '@redocly/openapi-core';
+import { handleJoin } from '../../commands/join';
+import { exitWithError, writeToFileByExtension } from '../../utils/miscellaneous';
 import { loadConfig } from '../../__mocks__/@redocly/openapi-core';
 import { ConfigFixture } from '../fixtures/config';
 
@@ -9,7 +9,7 @@ jest.mock('../../utils/miscellaneous');
 
 jest.mock('colorette');
 
-describe('handleJoin fails', () => {
+describe('handleJoin', () => {
   const colloreteYellowMock = yellow as jest.Mock<any, any>;
   colloreteYellowMock.mockImplementation((string: string) => string);
 
@@ -181,4 +181,138 @@ describe('handleJoin fails', () => {
     expect(config.styleguide.skipDecorators).not.toHaveBeenCalled();
     expect(config.styleguide.skipPreprocessors).not.toHaveBeenCalled();
   });
+
+  it('should handle join with prefix-components-with-info-prop and null values', async () => {
+    (detectSpec as jest.Mock).mockReturnValue('oas3_0');
+
+    await handleJoin(
+      {
+        apis: ['first.yaml', 'second.yaml', 'third.yaml'],
+        'prefix-components-with-info-prop': 'title',
+        output: 'join-result.yaml',
+      },
+      ConfigFixture as any,
+      'cli-version'
+    );
+
+    expect(writeToFileByExtension).toHaveBeenCalledWith(
+      {
+        openapi: '3.0.0',
+        info: {
+          description: 'example test',
+          version: '1.0.0',
+          title: 'First API',
+          termsOfService: 'http://swagger.io/terms/',
+          license: {
+            name: 'Apache 2.0',
+            url: 'http://www.apache.org/licenses/LICENSE-2.0.html',
+          },
+        },
+        servers: [
+          {
+            url: 'http://localhost:8080',
+          },
+          {
+            url: 'https://api.server.test/v1',
+          },
+        ],
+        tags: [
+          {
+            name: 'pet',
+            'x-displayName': 'pet',
+          },
+        ],
+        paths: {
+          '/GETUser/{userId}': {
+            summary: 'get user by id',
+            description: 'user info',
+            servers: [
+              {
+                url: '/user',
+              },
+              {
+                url: '/pet',
+                description: 'pet server',
+              },
+            ],
+            get: {
+              tags: ['pet'],
+              summary: 'Find pet by ID',
+              description: 'Returns a single pet',
+              operationId: 'getPetById',
+              servers: [
+                {
+                  url: '/pet',
+                },
+              ],
+            },
+            parameters: [
+              {
+                name: 'param1',
+                in: 'header',
+                schema: {
+                  description: 'string',
+                },
+              },
+            ],
+          },
+        },
+        components: {
+          schemas: {
+            Third_API_SchemaWithNull: {
+              type: 'string',
+              default: null,
+              nullable: true,
+            },
+            Third_API_SchemaWithRef: {
+              type: 'object',
+              properties: {
+                schemaType: {
+                  type: 'string',
+                  enum: ['foo'],
+                },
+                foo: {
+                  $ref: '#/components/schemas/Third_API_SchemaWithNull',
+                },
+              },
+            },
+            Third_API_SchemaWithDiscriminator: {
+              discriminator: {
+                propertyName: 'schemaType',
+                mapping: {
+                  foo: '#/components/schemas/Third_API_SchemaWithRef',
+                  bar: '#/components/schemas/Third_API_SchemaWithNull',
+                },
+              },
+              oneOf: [
+                {
+                  $ref: '#/components/schemas/Third_API_SchemaWithRef',
+                },
+                {
+                  type: 'object',
+                  properties: {
+                    schemaType: {
+                      type: 'string',
+                      enum: ['bar'],
+                    },
+                    bar: {
+                      type: 'string',
+                    },
+                  },
+                },
+              ],
+            },
+          },
+        },
+        'x-tagGroups': [
+          {
+            name: 'First API',
+            tags: ['pet'],
+          },
+        ],
+      },
+      'join-result.yaml',
+      true
+    );
+  });
 });

package/src/cms/api/__tests__/api.client.test.ts

@@ -42,6 +42,7 @@ describe('ApiClient', () => {
             'Content-Type': 'application/json',
             Authorization: `Bearer ${testToken}`,
           },
+          signal: expect.any(Object),
         }
       );
 
@@ -122,6 +123,8 @@ describe('ApiClient', () => {
             type: 'CICD',
             autoMerge: true,
           }),
+          signal: expect.any(Object),
+          agent: undefined,
         }
       );
 

package/src/cms/api/api-client.ts

@@ -1,7 +1,7 @@
 import fetchWithTimeout from '../../utils/fetch-with-timeout';
 import fetch from 'node-fetch';
 import * as FormData from 'form-data';
-
+import { getProxyAgent } from '@redocly/openapi-core';
 import type { Response } from 'node-fetch';
 import type { ReadStream } from 'fs';
 import type {
@@ -25,7 +25,7 @@ class RemotesApiClient {
   }
 
   async getDefaultBranch(organizationId: string, projectId: string) {
-    const response = await fetch(
+    const response = await fetchWithTimeout(
       `${this.domain}/api/orgs/${organizationId}/projects/${projectId}/source`,
       {
         method: 'GET',
@@ -36,6 +36,10 @@ class RemotesApiClient {
       }
     );
 
+    if (!response) {
+      throw new Error(`Failed to get default branch.`);
+    }
+
     try {
       const source = await this.getParsedResponse<ProjectSourceResponse>(response);
 
@@ -53,7 +57,7 @@ class RemotesApiClient {
       mountBranchName: string;
     }
   ): Promise<UpsertRemoteResponse> {
-    const response = await fetch(
+    const response = await fetchWithTimeout(
       `${this.domain}/api/orgs/${organizationId}/projects/${projectId}/remotes`,
       {
         method: 'POST',
@@ -70,6 +74,10 @@ class RemotesApiClient {
       }
     );
 
+    if (!response) {
+      throw new Error(`Failed to upsert.`);
+    }
+
     try {
       return await this.getParsedResponse<UpsertRemoteResponse>(response);
     } catch (err) {
@@ -110,6 +118,7 @@ class RemotesApiClient {
           Authorization: `Bearer ${this.apiKey}`,
         },
         body: formData,
+        agent: getProxyAgent(),
       }
     );
 
@@ -121,7 +130,7 @@ class RemotesApiClient {
   }
 
   async getRemotesList(organizationId: string, projectId: string, mountPath: string) {
-    const response = await fetch(
+    const response = await fetchWithTimeout(
       `${this.domain}/api/orgs/${organizationId}/projects/${projectId}/remotes?filter=mountPath:/${mountPath}/`,
       {
         method: 'GET',
@@ -132,6 +141,10 @@ class RemotesApiClient {
       }
     );
 
+    if (!response) {
+      throw new Error(`Failed to get remotes list.`);
+    }
+
     try {
       return await this.getParsedResponse<ListRemotesResponse>(response);
     } catch (err) {
@@ -160,7 +173,7 @@ class RemotesApiClient {
     );
 
     if (!response) {
-      throw new Error(`Failed to get push status: Time is up`);
+      throw new Error(`Failed to get push status.`);
     }
 
     try {

package/src/commands/join.ts

@@ -4,22 +4,16 @@ import { performance } from 'perf_hooks';
 const isEqual = require('lodash.isequal');
 import {
   Config,
-  Oas3Definition,
   SpecVersion,
   BaseResolver,
-  Document,
   StyleguideConfig,
-  Oas3Tag,
   formatProblems,
   getTotals,
   lintDocument,
   detectSpec,
   bundleDocument,
-  Referenced,
   isRef,
-  RuleSeverity,
 } from '@redocly/openapi-core';
-
 import {
   getFallbackApisOrExit,
   printExecutionTime,
@@ -32,16 +26,24 @@ import {
   checkForDeprecatedOptions,
 } from '../utils/miscellaneous';
 import { isObject, isString, keysOf } from '../utils/js-utils';
-import {
+import { COMPONENTS, OPENAPI3_METHOD } from './split/types';
+import { crawl, startsWithComponents } from './split';
+
+import type {
+  Oas3Definition,
+  Document,
+  Oas3Tag,
+  Referenced,
+  RuleSeverity,
+} from '@redocly/openapi-core';
+import type { BundleResult } from '@redocly/openapi-core/lib/bundle';
+import type {
   Oas3Parameter,
   Oas3PathItem,
   Oas3Server,
   Oas3_1Definition,
 } from '@redocly/openapi-core/lib/typings/openapi';
-import { OPENAPI3_METHOD } from './split/types';
-import { BundleResult } from '@redocly/openapi-core/lib/bundle';
 
-const COMPONENTS = 'components';
 const Tags = 'tags';
 const xTagGroups = 'x-tagGroups';
 let potentialConflictsTotal = 0;
@@ -756,8 +758,11 @@ function addComponentsPrefix(description: string, componentsPrefix: string) {
 function addSecurityPrefix(security: any, componentsPrefix: string) {
   return componentsPrefix
     ? security?.map((s: any) => {
-        const key = Object.keys(s)[0];
-        return { [componentsPrefix + '_' + key]: s[key] };
+        const joinedSecuritySchema = {};
+        for (const [key, value] of Object.entries(s)) {
+          Object.assign(joinedSecuritySchema, { [componentsPrefix + '_' + key]: value });
+        }
+        return joinedSecuritySchema;
       })
     : security;
 }
@@ -779,7 +784,7 @@ function getInfoPrefix(info: any, prefixArg: string | undefined, type: string) {
         `prefix-${type}-with-info-prop`
       )} argument value length should not exceed 50 characters. \n\n`
     );
-  return info[prefixArg];
+  return info[prefixArg].replaceAll(/\s/g, '_');
 }
 
 async function validateApi(
@@ -798,30 +803,19 @@ async function validateApi(
   }
 }
 
-function crawl(object: any, visitor: any) {
-  if (!isObject(object)) return;
-  for (const key of Object.keys(object)) {
-    visitor(object[key], key);
-    crawl(object[key], visitor);
-  }
-}
-
-function replace$Refs(obj: any, componentsPrefix: string) {
-  crawl(obj, (node: any) => {
-    if (node.$ref && isString(node.$ref) && node.$ref.startsWith(`#/${COMPONENTS}/`)) {
+function replace$Refs(obj: unknown, componentsPrefix: string) {
+  crawl(obj, (node: Record<string, unknown>) => {
+    if (node.$ref && typeof node.$ref === 'string' && startsWithComponents(node.$ref)) {
       const name = path.basename(node.$ref);
       node.$ref = node.$ref.replace(name, componentsPrefix + '_' + name);
-    } else if (
-      node.discriminator &&
-      node.discriminator.mapping &&
-      isObject(node.discriminator.mapping)
-    ) {
+    } else if (isObject(node.discriminator) && isObject(node.discriminator.mapping)) {
       const { mapping } = node.discriminator;
       for (const name of Object.keys(mapping)) {
-        if (isString(mapping[name]) && mapping[name].startsWith(`#/${COMPONENTS}/`)) {
-          mapping[name] = mapping[name]
+        const mappingPointer = mapping[name];
+        if (typeof mappingPointer === 'string' && startsWithComponents(mappingPointer)) {
+          mapping[name] = mappingPointer
             .split('/')
-            .map((name: string, i: number, arr: []) => {
+            .map((name, i, arr) => {
               return arr.length - 1 === i && !name.includes(componentsPrefix)
                 ? componentsPrefix + '_' + name
                 : name;

package/src/commands/push.ts

@@ -14,6 +14,7 @@ import {
   slash,
   Region,
   getMergedConfig,
+  getProxyAgent,
 } from '@redocly/openapi-core';
 import {
   exitWithError,
@@ -62,8 +63,12 @@ export async function handlePush(argv: PushOptions, config: Config): Promise<voi
   const client = new RedoclyClient(config.region);
   const isAuthorized = await client.isAuthorizedWithRedoclyByRegion();
   if (!isAuthorized) {
-    const clientToken = await promptClientToken(client.domain);
-    await client.login(clientToken);
+    try {
+      const clientToken = await promptClientToken(client.domain);
+      await client.login(clientToken);
+    } catch (e) {
+      exitWithError(e);
+    }
   }
 
   const startedAt = performance.now();
@@ -439,6 +444,7 @@ function uploadFileToS3(url: string, filePathOrBuffer: string | Buffer) {
     typeof filePathOrBuffer === 'string'
       ? fs.statSync(filePathOrBuffer).size
       : filePathOrBuffer.byteLength;
+
   const readStream =
     typeof filePathOrBuffer === 'string' ? fs.createReadStream(filePathOrBuffer) : filePathOrBuffer;
 
@@ -448,5 +454,6 @@ function uploadFileToS3(url: string, filePathOrBuffer: string | Buffer) {
       'Content-Length': fileSizeInBytes.toString(),
     },
     body: readStream,
+    agent: getProxyAgent(),
   });
 }