@microsoft.azure/openapi-validator-core/src/runner.ts

Azure OpenAPI Validator

import { LintCallBack, LintOptions } from "./api"
import { OpenapiDocument } from "./document"
import { nodes } from "./jsonpath"
import { IRuleLoader } from "./ruleLoader"
import { SwaggerInventory } from "./swaggerInventory"
import { OpenApiTypes, ValidationMessage, LintResultMessage, IRule, IRuleSet, RuleScope } from "./types"

import { getRange, convertJsonPath } from "./utils"

const isLegacyRule = (rule: IRule<any>) => {
  return rule.then.execute.name === "run"
}

export class LintRunner<T> {
  constructor(private loader: IRuleLoader, private inventory: SwaggerInventory) {}

  runRules = async (
    document: string,
    openapiDefinition: any,
    sendMessage: (m: LintResultMessage) => void,
    openapiType: OpenApiTypes,
    ruleset: IRuleSet,
    inventory: SwaggerInventory,
    scope: RuleScope = "File"
  ) => {
    const rulesToRun = Object.entries(ruleset.rules).filter(
      (rule) => rule[1].openapiType & openapiType && (rule[1].scope || "File") === scope
    )
    const getArgs = (rule: IRule<any>, section: any, doc: any, location: string[]) => {
      if (isLegacyRule(rule)) {
        return [doc, section, location, { specPath: document, inventory }]
      } else {
        return [
          section,
          rule.then.options,
          {
            document: doc,
            location,
            specPath: document,
            inventory,
          },
        ]
      }
    }
    for (const [ruleName, rule] of rulesToRun) {
      let givens = rule.given || "$"
      if (!Array.isArray(givens)) {
        givens = [givens]
      }
      const targetDefinition = openapiDefinition
      for (const given of givens) {
        for (const section of nodes(targetDefinition, given)) {
          const fieldMatch = rule.then.fieldMatch
          if (fieldMatch) {
            for (const subSection of nodes(section.value, fieldMatch)) {
              const location: string[] = section.path.slice(1).concat(subSection.path.slice(1))
              await processRule(ruleName, rule, subSection.value, targetDefinition, location)
            }
          } else {
            const location: string[] = section.path.slice(1)
            await processRule(ruleName, rule, section.value, targetDefinition, location)
          }
        }
      }
    }

    async function processRule(ruleName: string, rule: IRule<any>, section: any, targetDefinition: any, location: string[]): Promise<void> {
      try {
        const args = getArgs(rule, section, targetDefinition, location)
        // Note: Legacy rules, like UniqueXmsEnumName, are converted to the 'rule.then.execute' format
        // via createFromLegacyRules() in packages/rulesets/src/native/rulesets/common.ts
        for await (const message of (rule.then.execute as any)(...args)) {
          emitResult(ruleName, rule, message)
        }
      } catch (error) {
        error.message =
          `azure-openapi-validator/core/src/runner.ts/LintRunner.runRules/processRule error. ` +
          `ruleName: ${ruleName}, specFilePath: ${document}, ` +
          `jsonPath: ${convertJsonPath(openapiDefinition, location as string[])}, ` +
          `errorName: ${error?.name}, errorMessage: ${error?.message}`
        throw error
      }
    }

    function emitResult(ruleName: string, rule: IRule<any>, message: ValidationMessage) {
      const readableCategory = rule.category
      const range = getRange(inventory, document, message.location)
      const msg: LintResultMessage = {
        id: rule.id,
        type: rule.severity,
        category: readableCategory,
        message: message.message,
        code: ruleName,
        sources: [document],
        jsonpath: convertJsonPath(openapiDefinition, message.location as string[]),
        range,
      }
      sendMessage(msg)
    }
  }

  async execute(swaggerPaths: string[], options: LintOptions, cb?: LintCallBack) {
    const specsPromises = []
    for (const spec of swaggerPaths) {
      specsPromises.push(this.inventory.loadDocument(spec))
    }
    const documents = (await Promise.all(specsPromises)) as OpenapiDocument[]
    const msgs: LintResultMessage[] = []
    const sendMessage = (msg: LintResultMessage) => {
      msgs.push(msg)
      if (cb) {
        cb(msg)
      }
    }
    const runPromises = []
    let runGlobalRuleFlag = false
    for (const doc of documents) {
      for (const scope of ["Global", "File"]) {
        if (scope === "Global" && runGlobalRuleFlag) {
          continue
        } else {
          runGlobalRuleFlag = true
        }
        const promise = this.runRules(
          doc.getDocumentPath(),
          doc.getObj(),
          sendMessage,
          options.openapiType,
          await this.loader.getRuleSet(),
          this.inventory,
          scope as RuleScope
        )
        runPromises.push(promise)
      }
    }
    await Promise.all(runPromises)
    return msgs
  }
}