@redocly/openapi-core 1.0.0-beta.93 → 1.0.0-beta.96

package/src/config/__tests__/fixtures/resolve-config/api/plugin.js

@@ -0,0 +1,67 @@
+const id = 'test-plugin-nested';
+
+/** @type {import('../../config').PreprocessorsConfig} */
+const preprocessors = {
+  oas2: {
+    'description-preprocessor': () => {
+      return {
+        Info(info) {
+          const title = info.title || 'API title';
+          info.description = `# ${title}\n\n${info.description || ''}`;
+        },
+      };
+    },
+  },
+};
+
+/** @type {import('../../config').CustomRulesConfig} */
+const rules = {
+  oas3: {
+    'openid-connect-url-well-known': () => {
+      return {
+        SecurityScheme(scheme, { location, report }) {
+          if (scheme.type === 'openIdConnect') {
+            if (scheme.openIdConnectUrl && !scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')) {
+              report({
+                message:
+                  'openIdConnectUrl must be a URL that ends with /.well-known/openid-configuration',
+                location: location.child('openIdConnectUrl'),
+              });
+            }
+          }
+        },
+      };
+    },
+  },
+};
+
+/** @type {import('../../config').DecoratorsConfig} */
+const decorators = {
+  oas3: {
+    'inject-x-stats': () => {
+      return {
+        Info(info) {
+          info['x-stats'] = { test: 1 };
+        },
+      };
+    },
+  },
+};
+
+const configs = {
+  all: {
+    rules: {
+      'local/operation-id-not-test': 'error',
+      'boolean-parameter-prefixes': 'error',
+    },
+  },
+};
+
+
+module.exports = {
+  id,
+  preprocessors,
+  rules,
+  decorators,
+  configs,
+};

package/src/config/__tests__/fixtures/resolve-config/local-config-with-circular.yaml

@@ -0,0 +1,8 @@
+lint:
+  extends:
+    - local-config-with-circular.yaml
+  rules:
+    no-invalid-media-type-examples: error
+    operation-description: error
+    path-http-verbs-order: error
+    operation-2xx-response: off

package/src/config/__tests__/fixtures/resolve-config/local-config-with-file.yaml

@@ -0,0 +1,12 @@
+lint:
+  rules:
+    no-invalid-media-type-examples: warn
+    operation-4xx-response: off
+  plugins:
+    - plugin.js
+    - api/plugin.js
+  extends:
+    - recommended
+    - api/nested-config.yaml
+    - test-plugin-nested/all
+    - test-plugin/all

package/src/config/__tests__/fixtures/resolve-config/local-config.yaml

@@ -0,0 +1,10 @@
+lint:
+  plugins:
+    - plugin.js
+  extends:
+    - test-plugin/all
+  rules:
+    no-invalid-media-type-examples: error
+    operation-description: error
+    path-http-verbs-order: error
+    operation-2xx-response: off

package/src/config/__tests__/fixtures/resolve-config/plugin.js

@@ -0,0 +1,66 @@
+const id = 'test-plugin';
+
+/** @type {import('../../config').PreprocessorsConfig} */
+const preprocessors = {
+  oas2: {
+    'description-preprocessor': () => {
+      return {
+        Info(info) {
+          const title = info.title || 'API title';
+          info.description = `# ${title}\n\n${info.description || ''}`;
+        },
+      };
+    },
+  },
+};
+
+/** @type {import('../../config').CustomRulesConfig} */
+const rules = {
+  oas3: {
+    'openid-connect-url-well-known': () => {
+      return {
+        SecurityScheme(scheme, { location, report }) {
+          if (scheme.type === 'openIdConnect') {
+            if (scheme.openIdConnectUrl && !scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')) {
+              report({
+                message:
+                  'openIdConnectUrl must be a URL that ends with /.well-known/openid-configuration',
+                location: location.child('openIdConnectUrl'),
+              });
+            }
+          }
+        },
+      };
+    },
+  },
+};
+
+/** @type {import('../../config').DecoratorsConfig} */
+const decorators = {
+  oas3: {
+    'inject-x-stats': () => {
+      return {
+        Info(info) {
+          info['x-stats'] = { test: 1 };
+        },
+      };
+    },
+  },
+};
+
+const configs = {
+  all: {
+    rules: {
+      'local/operation-id-not-test': 'error',
+      'boolean-parameter-prefixes': 'error',
+    },
+  },
+};
+
+module.exports = {
+  id,
+  preprocessors,
+  rules,
+  decorators,
+  configs,
+};

package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml

@@ -0,0 +1,4 @@
+lint:
+  rules:
+    operation-2xx-response: off
+    operation-4xx-response: error

package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml

@@ -0,0 +1,5 @@
+lint:
+  extends:
+    - nested-remote-config.yaml
+  rules:
+    operation-2xx-response: error

package/src/config/__tests__/load.test.ts

@@ -1,4 +1,4 @@
-import { loadConfig, findConfig } from '../load';
+import { loadConfig, findConfig, getConfig } from '../load';
 import { RedoclyClient } from '../../redocly';
 
 const fs = require('fs');
@@ -74,3 +74,10 @@ describe('findConfig', () => {
     expect(configName).toStrictEqual('dir/redocly.yaml');
   });
 });
+
+describe('getConfig', () => {
+  jest.spyOn(fs, 'hasOwnProperty').mockImplementation(() => false);
+  it('should return empty object if there is no configPath and config file is not found', () => {
+    expect(getConfig()).toEqual(Promise.resolve({}));
+  });
+});

package/src/config/all.ts

@@ -1,4 +1,5 @@
-import { LintRawConfig } from './config';
+import type { PluginLintConfig } from "./types";
+
 
 export default {
   rules: {
@@ -61,4 +62,4 @@ export default {
     'no-undefined-server-variable': 'error',
     'no-servers-empty-enum': 'error',
   },
-} as LintRawConfig;
+} as PluginLintConfig;

package/src/config/builtIn.ts

@@ -1,7 +1,6 @@
 import recommended from './recommended';
 import all from './all';
 import minimal from './minimal';
-import { CustomRulesConfig, LintRawConfig, Plugin } from './config';
 import { rules as oas3Rules } from '../rules/oas3';
 import { rules as oas2Rules } from '../rules/oas2';
 import { preprocessors as oas3Preprocessors } from '../rules/oas3';
@@ -9,6 +8,8 @@ import { preprocessors as oas2Preprocessors } from '../rules/oas2';
 import { decorators as oas3Decorators } from '../decorators/oas3';
 import { decorators as oas2Decorators } from '../decorators/oas2';
 
+import type { CustomRulesConfig, LintRawConfig, Plugin } from './types';
+
 export const builtInConfigs: Record<string, LintRawConfig> = {
   recommended,
   minimal,

package/src/config/config-resolvers.ts

@@ -0,0 +1,304 @@
+import * as path from 'path';
+import { blue, red } from 'colorette';
+import { isAbsoluteUrl } from '../ref-utils';
+import { BaseResolver } from '../resolve';
+import { defaultPlugin } from './builtIn';
+import {
+  getResolveConfig,
+  getUniquePlugins,
+  mergeExtends,
+  parsePresetName,
+  prefixRules,
+  transformConfig,
+} from './utils';
+import type { LintRawConfig, Plugin, RawConfig, ResolvedApi, ResolvedLintConfig } from './types';
+import { isNotString, isString, notUndefined, parseYaml } from '../utils';
+import { Config } from './config';
+
+export async function resolveConfig(rawConfig: RawConfig, configPath?: string) {
+  if (rawConfig.lint?.extends?.some(isNotString)) {
+    throw new Error(
+      `Error configuration format not detected in extends value must contain strings`,
+    );
+  }
+
+  const resolver = new BaseResolver(getResolveConfig(rawConfig.resolve));
+  const configExtends = rawConfig?.lint?.extends ?? ['recommended'];
+  const recommendedFallback = !rawConfig?.lint?.extends;
+  const lintConfig = {
+    ...rawConfig?.lint,
+    extends: configExtends,
+    recommendedFallback,
+  };
+
+  const apis = await resolveApis({
+    rawConfig: {
+      ...rawConfig,
+      lint: lintConfig,
+    },
+    configPath,
+    resolver,
+  });
+
+  const lint = await resolveLint({
+    lintConfig,
+    configPath,
+    resolver,
+  });
+
+  return new Config(
+    {
+      ...rawConfig,
+      apis,
+      lint,
+    },
+    configPath,
+  );
+}
+
+export function resolvePlugins(
+  plugins: (string | Plugin)[] | null,
+  configPath: string = '',
+): Plugin[] {
+  if (!plugins) return [];
+
+  // @ts-ignore
+  const requireFunc = typeof __webpack_require__ === 'function' ? __non_webpack_require__ : require;
+
+  const seenPluginIds = new Map<string, string>();
+
+  return plugins
+    .map((p) => {
+      if (isString(p) && isAbsoluteUrl(p)) {
+        throw new Error(red(`We don't support remote plugins yet.`));
+      }
+
+      // TODO: resolve npm packages similar to eslint
+      const pluginModule = isString(p)
+        ? (requireFunc(path.resolve(path.dirname(configPath), p)) as Plugin)
+        : p;
+
+      const id = pluginModule.id;
+      if (typeof id !== 'string') {
+        throw new Error(red(`Plugin must define \`id\` property in ${blue(p.toString())}.`));
+      }
+
+      if (seenPluginIds.has(id)) {
+        const pluginPath = seenPluginIds.get(id)!;
+        throw new Error(
+          red(
+            `Plugin "id" must be unique. Plugin ${blue(p.toString())} uses id "${blue(
+              id,
+            )}" already seen in ${blue(pluginPath)}`,
+          ),
+        );
+      }
+
+      seenPluginIds.set(id, p.toString());
+
+      const plugin: Plugin = {
+        id,
+        ...(pluginModule.configs ? { configs: pluginModule.configs } : {}),
+        ...(pluginModule.typeExtension ? { typeExtension: pluginModule.typeExtension } : {}),
+      };
+
+      if (pluginModule.rules) {
+        if (!pluginModule.rules.oas3 && !pluginModule.rules.oas2) {
+          throw new Error(`Plugin rules must have \`oas3\` or \`oas2\` rules "${p}.`);
+        }
+        plugin.rules = {};
+        if (pluginModule.rules.oas3) {
+          plugin.rules.oas3 = prefixRules(pluginModule.rules.oas3, id);
+        }
+        if (pluginModule.rules.oas2) {
+          plugin.rules.oas2 = prefixRules(pluginModule.rules.oas2, id);
+        }
+      }
+      if (pluginModule.preprocessors) {
+        if (!pluginModule.preprocessors.oas3 && !pluginModule.preprocessors.oas2) {
+          throw new Error(
+            `Plugin \`preprocessors\` must have \`oas3\` or \`oas2\` preprocessors "${p}.`,
+          );
+        }
+        plugin.preprocessors = {};
+        if (pluginModule.preprocessors.oas3) {
+          plugin.preprocessors.oas3 = prefixRules(pluginModule.preprocessors.oas3, id);
+        }
+        if (pluginModule.preprocessors.oas2) {
+          plugin.preprocessors.oas2 = prefixRules(pluginModule.preprocessors.oas2, id);
+        }
+      }
+
+      if (pluginModule.decorators) {
+        if (!pluginModule.decorators.oas3 && !pluginModule.decorators.oas2) {
+          throw new Error(`Plugin \`decorators\` must have \`oas3\` or \`oas2\` decorators "${p}.`);
+        }
+        plugin.decorators = {};
+        if (pluginModule.decorators.oas3) {
+          plugin.decorators.oas3 = prefixRules(pluginModule.decorators.oas3, id);
+        }
+        if (pluginModule.decorators.oas2) {
+          plugin.decorators.oas2 = prefixRules(pluginModule.decorators.oas2, id);
+        }
+      }
+
+      return plugin;
+    })
+    .filter(notUndefined);
+}
+
+export async function resolveApis({
+  rawConfig,
+  configPath = '',
+  resolver,
+}: {
+  rawConfig: RawConfig;
+  configPath?: string;
+  resolver?: BaseResolver;
+}): Promise<Record<string, ResolvedApi>> {
+  const { apis = {}, lint: lintConfig = {} } = rawConfig;
+  let resolvedApis: Record<string, ResolvedApi> = {};
+  for (const [apiName, apiContent] of Object.entries(apis || {})) {
+    if (apiContent.lint?.extends?.some(isNotString)) {
+      throw new Error(
+        `Error configuration format not detected in extends value must contain strings`,
+      );
+    }
+    const rawLintConfig = getMergedLintRawConfig(lintConfig, apiContent.lint);
+    const apiLint = await resolveLint({
+      lintConfig: rawLintConfig,
+      configPath,
+      resolver,
+    });
+    resolvedApis[apiName] = { ...apiContent, lint: apiLint };
+  }
+  return resolvedApis;
+}
+
+export async function resolveLint(
+  {
+    lintConfig,
+    configPath = '',
+    resolver = new BaseResolver(),
+  }: {
+    lintConfig?: LintRawConfig;
+    configPath?: string;
+    resolver?: BaseResolver;
+  },
+  parentConfigPaths: string[] = [],
+  extendPaths: string[] = [],
+): Promise<ResolvedLintConfig> {
+  if (parentConfigPaths.includes(configPath)) {
+    throw new Error(`Circular dependency in config file: "${configPath}"`);
+  }
+  const plugins = getUniquePlugins(
+    resolvePlugins([...(lintConfig?.plugins || []), defaultPlugin], configPath),
+  );
+  const pluginPaths = lintConfig?.plugins
+    ?.filter(isString)
+    .map((p) => path.resolve(path.dirname(configPath), p));
+
+  const resolvedConfigPath = isAbsoluteUrl(configPath)
+    ? configPath
+    : configPath && path.resolve(configPath);
+
+  const extendConfigs: ResolvedLintConfig[] = await Promise.all(
+    lintConfig?.extends?.map(async (presetItem) => {
+      if (!isAbsoluteUrl(presetItem) && !path.extname(presetItem)) {
+        return resolvePreset(presetItem, plugins);
+      }
+      const pathItem = isAbsoluteUrl(presetItem)
+        ? presetItem
+        : isAbsoluteUrl(configPath)
+        ? new URL(presetItem, configPath).href
+        : path.resolve(path.dirname(configPath), presetItem);
+      const extendedLintConfig = await loadExtendLintConfig(pathItem, resolver);
+      return await resolveLint(
+        {
+          lintConfig: extendedLintConfig,
+          configPath: pathItem,
+          resolver: resolver,
+        },
+        [...parentConfigPaths, resolvedConfigPath],
+        extendPaths,
+      );
+    }) || [],
+  );
+
+  const { plugins: mergedPlugins = [], ...lint } = mergeExtends([
+    ...extendConfigs,
+    {
+      ...lintConfig,
+      plugins,
+      extends: undefined,
+      extendPaths: [...parentConfigPaths, resolvedConfigPath],
+      pluginPaths,
+    },
+  ]);
+
+  return {
+    ...lint,
+    extendPaths: lint.extendPaths?.filter((path) => path && !isAbsoluteUrl(path)),
+    plugins: getUniquePlugins(mergedPlugins),
+    recommendedFallback: lintConfig?.recommendedFallback,
+    doNotResolveExamples: lintConfig?.doNotResolveExamples,
+  };
+}
+
+export function resolvePreset(presetName: string, plugins: Plugin[]): ResolvedLintConfig {
+  const { pluginId, configName } = parsePresetName(presetName);
+  const plugin = plugins.find((p) => p.id === pluginId);
+  if (!plugin) {
+    throw new Error(`Invalid config ${red(presetName)}: plugin ${pluginId} is not included.`);
+  }
+
+  const preset = plugin.configs?.[configName]! as ResolvedLintConfig;
+  if (!preset) {
+    throw new Error(
+      pluginId
+        ? `Invalid config ${red(
+            presetName,
+          )}: plugin ${pluginId} doesn't export config with name ${configName}.`
+        : `Invalid config ${red(presetName)}: there is no such built-in config.`,
+    );
+  }
+  return preset;
+}
+
+async function loadExtendLintConfig(
+  filePath: string,
+  resolver: BaseResolver,
+): Promise<LintRawConfig> {
+  try {
+    const fileSource = await resolver.loadExternalRef(filePath);
+    const rawConfig = transformConfig(parseYaml(fileSource.body) as RawConfig);
+    if (!rawConfig.lint) {
+      throw new Error(`Lint configuration format not detected: "${filePath}"`);
+    }
+
+    return rawConfig.lint;
+  } catch (error) {
+    throw new Error(`Failed to load "${filePath}": ${error.message}`);
+  }
+}
+
+function getMergedLintRawConfig(configLint: LintRawConfig, apiLint?: LintRawConfig) {
+  const resultLint = {
+    ...configLint,
+    ...apiLint,
+    rules: { ...configLint?.rules, ...apiLint?.rules },
+    oas2Rules: { ...configLint?.oas2Rules, ...apiLint?.oas2Rules },
+    oas3_0Rules: { ...configLint?.oas3_0Rules, ...apiLint?.oas3_0Rules },
+    oas3_1Rules: { ...configLint?.oas3_1Rules, ...apiLint?.oas3_1Rules },
+    preprocessors: { ...configLint?.preprocessors, ...apiLint?.preprocessors },
+    oas2Preprocessors: { ...configLint?.oas2Preprocessors, ...apiLint?.oas2Preprocessors },
+    oas3_0Preprocessors: { ...configLint?.oas3_0Preprocessors, ...apiLint?.oas3_0Preprocessors },
+    oas3_1Preprocessors: { ...configLint?.oas3_1Preprocessors, ...apiLint?.oas3_1Preprocessors },
+    decorators: { ...configLint?.decorators, ...apiLint?.decorators },
+    oas2Decorators: { ...configLint?.oas2Decorators, ...apiLint?.oas2Decorators },
+    oas3_0Decorators: { ...configLint?.oas3_0Decorators, ...apiLint?.oas3_0Decorators },
+    oas3_1Decorators: { ...configLint?.oas3_1Decorators, ...apiLint?.oas3_1Decorators },
+    recommendedFallback: apiLint?.extends ? false : configLint.recommendedFallback,
+  };
+  return resultLint;
+}