@backstage/plugin-catalog-backend-module-backstage-openapi 0.4.5 → 0.5.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/plugin-catalog-backend-module-backstage-openapi
 
+## 0.5.0-next.1
+
+### Minor Changes
+
+- 62842ee: feat: Improve JSON format of OpenAPI definition, allow YAML format
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-openapi-utils@0.5.1-next.1
+  - @backstage/backend-plugin-api@1.2.1-next.1
+  - @backstage/catalog-model@1.7.3
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/plugin-catalog-node@1.16.1-next.1
+
+## 0.4.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.2.1-next.0
+  - @backstage/plugin-catalog-node@1.16.1-next.0
+  - @backstage/backend-openapi-utils@0.5.1-next.0
+
 ## 0.4.5
 
 ### Patch Changes

package/README.md

@@ -28,6 +28,7 @@ catalog:
         - catalog
         - events
         - search
+      definitionFormat: 'yaml"' # Optional, defaults to 'json'
       entityOverrides: # All optional
         metadata:
           name: 'my-name'

package/config.d.ts

@@ -29,6 +29,11 @@ export interface Config {
          * Properties to override on the final entity object.
          */
         entityOverrides?: object;
+        /**
+         * The format of the definition.
+         * @defaultValue json
+         */
+        definitionFormat?: 'json' | 'yaml';
       };
     };
   };

package/dist/InternalOpenApiDocumentationProvider.cjs.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var yaml = require('yaml');
 var catalogModel = require('@backstage/catalog-model');
 var errors = require('@backstage/errors');
 var openapiMerge = require('openapi-merge');
@@ -28,6 +29,7 @@ function _interopNamespaceCompat(e) {
   return Object.freeze(n);
 }
 
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
 var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
 var uuid__namespace = /*#__PURE__*/_interopNamespaceCompat(uuid);
 var lodash__default = /*#__PURE__*/_interopDefaultCompat(lodash);
@@ -127,6 +129,15 @@ const loadSpecs = async ({
   }
   return mergeSpecs({ baseUrl, specs });
 };
+const formatDefinition = (definition, format) => {
+  if (format === "json") {
+    return JSON.stringify(definition, null, 2);
+  }
+  if (format === "yaml") {
+    return yaml__default.default.stringify(definition);
+  }
+  throw new Error(`Unsupported format type: ${format}`);
+};
 class InternalOpenApiDocumentationProvider {
   constructor(config, discovery, logger, auth, taskRunner) {
     this.config = config;
@@ -190,6 +201,9 @@ class InternalOpenApiDocumentationProvider {
     const configToMerge = this.config.getOptional(
       "catalog.providers.backstageOpenapi.entityOverrides"
     );
+    const formatConfig = this.config.getOptionalString(
+      "catalog.providers.backstageOpenapi.definitionFormat"
+    ) ?? "json";
     const baseConfig = {
       metadata: {
         name: "internal_backstage_openapi_doc",
@@ -212,14 +226,15 @@ class InternalOpenApiDocumentationProvider {
       },
       spec: {
         type: "openapi",
-        definition: JSON.stringify(
+        definition: formatDefinition(
           await loadSpecs({
             baseUrl: this.config.getString("backend.baseUrl"),
             discovery: this.discovery,
             auth: this.auth,
             plugins: pluginsToMerge,
             logger
-          })
+          }),
+          formatConfig
         )
       }
     };

package/dist/InternalOpenApiDocumentationProvider.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"InternalOpenApiDocumentationProvider.cjs.js","sources":["../src/InternalOpenApiDocumentationProvider.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  ANNOTATION_LOCATION,\n  ANNOTATION_ORIGIN_LOCATION,\n  type ApiEntity,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { ForwardedError } from '@backstage/errors';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\nimport { merge, isErrorResult } from 'openapi-merge';\nimport { getOpenApiSpecRoute } from '@backstage/backend-openapi-utils';\nimport type {\n  OpenAPIObject,\n  OperationObject,\n  PathItemObject,\n} from 'openapi3-ts';\nimport fetch from 'cross-fetch';\nimport {\n  AuthService,\n  DiscoveryService,\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\nimport * as uuid from 'uuid';\nimport lodash from 'lodash';\n\nconst HTTP_VERBS: (keyof PathItemObject)[] = [\n  'get',\n  'post',\n  'put',\n  'delete',\n  'patch',\n  'trace',\n  'options',\n  'head',\n];\n\nconst addTagsToSpec = (spec: OpenAPIObject, tag: string) => {\n  Object.values(spec?.paths).forEach((path: PathItemObject) => {\n    HTTP_VERBS.forEach(verb => {\n      if (verb in path) {\n        if (!('tags' in path[verb])) {\n          (path[verb] as OperationObject).tags = [];\n        }\n        if (!(path[verb] as OperationObject).tags?.includes(tag)) {\n          (path[verb] as OperationObject).tags?.push(tag);\n        }\n      }\n    });\n  });\n};\n\nconst mergeSpecs = async ({\n  baseUrl,\n  specs,\n}: {\n  baseUrl: string;\n  specs: OpenAPIObject[];\n}) => {\n  const mergeResult = merge([\n    // Add the full API information as the first item for other items to merge against it with.\n    {\n      oas: {\n        openapi: '3.0.3',\n        info: {\n          title: 'Backstage API',\n          version: '1',\n        },\n        servers: [{ url: baseUrl }],\n        paths: {},\n      },\n    },\n    // For each plugin, load its spec and the known endpoint that it sits under.\n    ...specs.map(\n      spec =>\n        ({\n          oas: spec,\n          // Weird typing differences between this package and the client package's openapi 3.\n        } as any),\n    ),\n  ]);\n\n  if (isErrorResult(mergeResult)) {\n    throw new ForwardedError(\n      `${mergeResult.message} (${mergeResult.type})`,\n      mergeResult,\n    );\n  } else {\n    return mergeResult.output;\n  }\n};\n\nconst loadSpecs = async ({\n  baseUrl,\n  discovery,\n  plugins,\n  logger,\n  auth,\n}: {\n  baseUrl: string;\n  plugins: string[];\n  discovery: DiscoveryService;\n  logger: LoggerService;\n  auth: AuthService;\n}) => {\n  const specs: OpenAPIObject[] = [];\n  for (const pluginId of plugins) {\n    const url = await discovery.getBaseUrl(pluginId);\n    const openApiUrl = getOpenApiSpecRoute(url);\n    const { token } = await auth.getPluginRequestToken({\n      onBehalfOf: await auth.getOwnServiceCredentials(),\n      targetPluginId: pluginId,\n    });\n    const response = await fetch(openApiUrl, {\n      method: 'GET',\n      headers: {\n        Authorization: `Bearer ${token}`,\n      },\n    });\n    if (response.ok) {\n      const spec = await response.json();\n      addTagsToSpec(spec, pluginId);\n      specs.push(spec);\n    } else if (response.status === 404) {\n      logger.error(\n        `Plugin=${pluginId} does not have an OpenAPI spec at '${openApiUrl}'.`,\n      );\n    } else {\n      logger.error(\n        `Failed to load spec for plugin=${pluginId} at ${openApiUrl}. Error (${\n          response.status\n        }): ${response.body ? await response.text() : response.statusText}`,\n      );\n    }\n  }\n  return mergeSpecs({ baseUrl, specs });\n};\n\nexport class InternalOpenApiDocumentationProvider implements EntityProvider {\n  private connection?: EntityProviderConnection;\n  private readonly scheduleFn: () => Promise<void>;\n\n  constructor(\n    public readonly config: Config,\n    public readonly discovery: DiscoveryService,\n    public readonly logger: LoggerService,\n    public readonly auth: AuthService,\n    taskRunner: SchedulerServiceTaskRunner,\n  ) {\n    this.scheduleFn = this.createScheduleFn(taskRunner);\n  }\n\n  static fromConfig(\n    config: Config,\n    options: {\n      discovery: DiscoveryService;\n      logger: LoggerService;\n      schedule: SchedulerService;\n      auth: AuthService;\n    },\n  ) {\n    const taskRunner = options.schedule.createScheduledTaskRunner({\n      frequency: {\n        minutes: 1,\n      },\n      timeout: {\n        minutes: 1,\n      },\n    });\n    return new InternalOpenApiDocumentationProvider(\n      config,\n      options.discovery,\n      options.logger,\n      options.auth,\n      taskRunner,\n    );\n  }\n  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */\n  getProviderName() {\n    return `InternalOpenApiDocumentationProvider`;\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */\n  async connect(connection: EntityProviderConnection) {\n    this.connection = connection;\n    return await this.scheduleFn();\n  }\n\n  private createScheduleFn(\n    taskRunner: SchedulerServiceTaskRunner,\n  ): () => Promise<void> {\n    return async () => {\n      const taskId = `${this.getProviderName()}:refresh`;\n      return taskRunner.run({\n        id: taskId,\n        fn: async () => {\n          const logger = this.logger.child({\n            class:\n              InternalOpenApiDocumentationProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\n          });\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(`${this.getProviderName()} refresh failed`, error);\n          }\n        },\n      });\n    };\n  }\n\n  async refresh(logger: LoggerService) {\n    const pluginsToMerge = this.config.getStringArray(\n      'catalog.providers.backstageOpenapi.plugins',\n    );\n    const configToMerge = this.config.getOptional(\n      'catalog.providers.backstageOpenapi.entityOverrides',\n    );\n\n    const baseConfig = {\n      metadata: {\n        name: 'internal_backstage_openapi_doc',\n        title: 'Backstage API',\n      },\n      spec: {\n        lifecycle: 'production',\n        owner: 'backstage',\n      },\n    };\n\n    logger.info(`Loading specs from ${pluginsToMerge}.`);\n    const requiredConfig = {\n      apiVersion: 'backstage.io/v1beta1',\n      kind: 'API',\n      metadata: {\n        annotations: {\n          [ANNOTATION_LOCATION]:\n            'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n          [ANNOTATION_ORIGIN_LOCATION]:\n            'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n        },\n      },\n      spec: {\n        type: 'openapi',\n        definition: JSON.stringify(\n          await loadSpecs({\n            baseUrl: this.config.getString('backend.baseUrl'),\n            discovery: this.discovery,\n            auth: this.auth,\n            plugins: pluginsToMerge,\n            logger,\n          }),\n        ),\n      },\n    };\n\n    // Overwrite baseConfig with options from config file.\n    const mergedConfig = lodash.merge(baseConfig, configToMerge);\n\n    // Overwite mergedConfig with requiredConfig (i.e., spec.type and spec.definition) to avoid bad configuration.\n    const documentationEntity = lodash.merge(\n      mergedConfig,\n      requiredConfig,\n    ) as ApiEntity;\n\n    await this.connection?.applyMutation({\n      type: 'full',\n      entities: [\n        {\n          entity: documentationEntity,\n          locationKey: 'internal-api-doc',\n        },\n      ],\n    });\n  }\n}\n"],"names":["merge","isErrorResult","ForwardedError","getOpenApiSpecRoute","fetch","uuid","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","lodash"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CA,MAAM,UAAuC,GAAA;AAAA,EAC3C,KAAA;AAAA,EACA,MAAA;AAAA,EACA,KAAA;AAAA,EACA,QAAA;AAAA,EACA,OAAA;AAAA,EACA,OAAA;AAAA,EACA,SAAA;AAAA,EACA;AACF,CAAA;AAEA,MAAM,aAAA,GAAgB,CAAC,IAAA,EAAqB,GAAgB,KAAA;AAC1D,EAAA,MAAA,CAAO,OAAO,IAAM,EAAA,KAAK,CAAE,CAAA,OAAA,CAAQ,CAAC,IAAyB,KAAA;AAC3D,IAAA,UAAA,CAAW,QAAQ,CAAQ,IAAA,KAAA;AACzB,MAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,QAAA,IAAI,EAAE,MAAA,IAAU,IAAK,CAAA,IAAI,CAAI,CAAA,EAAA;AAC3B,UAAC,IAAK,CAAA,IAAI,CAAsB,CAAA,IAAA,GAAO,EAAC;AAAA;AAE1C,QAAA,IAAI,CAAE,IAAK,CAAA,IAAI,EAAsB,IAAM,EAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AACxD,UAAC,IAAK,CAAA,IAAI,CAAsB,CAAA,IAAA,EAAM,KAAK,GAAG,CAAA;AAAA;AAChD;AACF,KACD,CAAA;AAAA,GACF,CAAA;AACH,CAAA;AAEA,MAAM,aAAa,OAAO;AAAA,EACxB,OAAA;AAAA,EACA;AACF,CAGM,KAAA;AACJ,EAAA,MAAM,cAAcA,kBAAM,CAAA;AAAA;AAAA,IAExB;AAAA,MACE,GAAK,EAAA;AAAA,QACH,OAAS,EAAA,OAAA;AAAA,QACT,IAAM,EAAA;AAAA,UACJ,KAAO,EAAA,eAAA;AAAA,UACP,OAAS,EAAA;AAAA,SACX;AAAA,QACA,OAAS,EAAA,CAAC,EAAE,GAAA,EAAK,SAAS,CAAA;AAAA,QAC1B,OAAO;AAAC;AACV,KACF;AAAA;AAAA,IAEA,GAAG,KAAM,CAAA,GAAA;AAAA,MACP,CACG,IAAA,MAAA;AAAA,QACC,GAAK,EAAA;AAAA;AAAA,OAEP;AAAA;AACJ,GACD,CAAA;AAED,EAAI,IAAAC,0BAAA,CAAc,WAAW,CAAG,EAAA;AAC9B,IAAA,MAAM,IAAIC,qBAAA;AAAA,MACR,CAAG,EAAA,WAAA,CAAY,OAAO,CAAA,EAAA,EAAK,YAAY,IAAI,CAAA,CAAA,CAAA;AAAA,MAC3C;AAAA,KACF;AAAA,GACK,MAAA;AACL,IAAA,OAAO,WAAY,CAAA,MAAA;AAAA;AAEvB,CAAA;AAEA,MAAM,YAAY,OAAO;AAAA,EACvB,OAAA;AAAA,EACA,SAAA;AAAA,EACA,OAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAMM,KAAA;AACJ,EAAA,MAAM,QAAyB,EAAC;AAChC,EAAA,KAAA,MAAW,YAAY,OAAS,EAAA;AAC9B,IAAA,MAAM,GAAM,GAAA,MAAM,SAAU,CAAA,UAAA,CAAW,QAAQ,CAAA;AAC/C,IAAM,MAAA,UAAA,GAAaC,wCAAoB,GAAG,CAAA;AAC1C,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,MACjD,UAAA,EAAY,MAAM,IAAA,CAAK,wBAAyB,EAAA;AAAA,MAChD,cAAgB,EAAA;AAAA,KACjB,CAAA;AACD,IAAM,MAAA,QAAA,GAAW,MAAMC,sBAAA,CAAM,UAAY,EAAA;AAAA,MACvC,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,UAAU,KAAK,CAAA;AAAA;AAChC,KACD,CAAA;AACD,IAAA,IAAI,SAAS,EAAI,EAAA;AACf,MAAM,MAAA,IAAA,GAAO,MAAM,QAAA,CAAS,IAAK,EAAA;AACjC,MAAA,aAAA,CAAc,MAAM,QAAQ,CAAA;AAC5B,MAAA,KAAA,CAAM,KAAK,IAAI,CAAA;AAAA,KACjB,MAAA,IAAW,QAAS,CAAA,MAAA,KAAW,GAAK,EAAA;AAClC,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAA,OAAA,EAAU,QAAQ,CAAA,mCAAA,EAAsC,UAAU,CAAA,EAAA;AAAA,OACpE;AAAA,KACK,MAAA;AACL,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAkC,+BAAA,EAAA,QAAQ,CAAO,IAAA,EAAA,UAAU,YACzD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,OAAO,MAAM,QAAA,CAAS,IAAK,EAAA,GAAI,SAAS,UAAU,CAAA;AAAA,OACnE;AAAA;AACF;AAEF,EAAA,OAAO,UAAW,CAAA,EAAE,OAAS,EAAA,KAAA,EAAO,CAAA;AACtC,CAAA;AAEO,MAAM,oCAA+D,CAAA;AAAA,EAI1E,WACkB,CAAA,MAAA,EACA,SACA,EAAA,MAAA,EACA,MAChB,UACA,EAAA;AALgB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAGhB,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA;AAAA;AACpD,EAXQ,UAAA;AAAA,EACS,UAAA;AAAA,EAYjB,OAAO,UACL,CAAA,MAAA,EACA,OAMA,EAAA;AACA,IAAM,MAAA,UAAA,GAAa,OAAQ,CAAA,QAAA,CAAS,yBAA0B,CAAA;AAAA,MAC5D,SAAW,EAAA;AAAA,QACT,OAAS,EAAA;AAAA,OACX;AAAA,MACA,OAAS,EAAA;AAAA,QACP,OAAS,EAAA;AAAA;AACX,KACD,CAAA;AACD,IAAA,OAAO,IAAI,oCAAA;AAAA,MACT,MAAA;AAAA,MACA,OAAQ,CAAA,SAAA;AAAA,MACR,OAAQ,CAAA,MAAA;AAAA,MACR,OAAQ,CAAA,IAAA;AAAA,MACR;AAAA,KACF;AAAA;AACF;AAAA,EAEA,eAAkB,GAAA;AAChB,IAAO,OAAA,CAAA,oCAAA,CAAA;AAAA;AACT;AAAA,EAGA,MAAM,QAAQ,UAAsC,EAAA;AAClD,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA;AAClB,IAAO,OAAA,MAAM,KAAK,UAAW,EAAA;AAAA;AAC/B,EAEQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EACE,oCAAqC,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC7D,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG;AAAA,WACzB,CAAA;AACD,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAA,MAAA,CAAO,MAAM,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,mBAAmB,KAAK,CAAA;AAAA;AAChE;AACF,OACD,CAAA;AAAA,KACH;AAAA;AACF,EAEA,MAAM,QAAQ,MAAuB,EAAA;AACnC,IAAM,MAAA,cAAA,GAAiB,KAAK,MAAO,CAAA,cAAA;AAAA,MACjC;AAAA,KACF;AACA,IAAM,MAAA,aAAA,GAAgB,KAAK,MAAO,CAAA,WAAA;AAAA,MAChC;AAAA,KACF;AAEA,IAAA,MAAM,UAAa,GAAA;AAAA,MACjB,QAAU,EAAA;AAAA,QACR,IAAM,EAAA,gCAAA;AAAA,QACN,KAAO,EAAA;AAAA,OACT;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,SAAW,EAAA,YAAA;AAAA,QACX,KAAO,EAAA;AAAA;AACT,KACF;AAEA,IAAO,MAAA,CAAA,IAAA,CAAK,CAAsB,mBAAA,EAAA,cAAc,CAAG,CAAA,CAAA,CAAA;AACnD,IAAA,MAAM,cAAiB,GAAA;AAAA,MACrB,UAAY,EAAA,sBAAA;AAAA,MACZ,IAAM,EAAA,KAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR,WAAa,EAAA;AAAA,UACX,CAACC,gCAAmB,GAClB,6EAAA;AAAA,UACF,CAACC,uCAA0B,GACzB;AAAA;AACJ,OACF;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,IAAM,EAAA,SAAA;AAAA,QACN,YAAY,IAAK,CAAA,SAAA;AAAA,UACf,MAAM,SAAU,CAAA;AAAA,YACd,OAAS,EAAA,IAAA,CAAK,MAAO,CAAA,SAAA,CAAU,iBAAiB,CAAA;AAAA,YAChD,WAAW,IAAK,CAAA,SAAA;AAAA,YAChB,MAAM,IAAK,CAAA,IAAA;AAAA,YACX,OAAS,EAAA,cAAA;AAAA,YACT;AAAA,WACD;AAAA;AACH;AACF,KACF;AAGA,IAAA,MAAM,YAAe,GAAAC,uBAAA,CAAO,KAAM,CAAA,UAAA,EAAY,aAAa,CAAA;AAG3D,IAAA,MAAM,sBAAsBA,uBAAO,CAAA,KAAA;AAAA,MACjC,YAAA;AAAA,MACA;AAAA,KACF;AAEA,IAAM,MAAA,IAAA,CAAK,YAAY,aAAc,CAAA;AAAA,MACnC,IAAM,EAAA,MAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR;AAAA,UACE,MAAQ,EAAA,mBAAA;AAAA,UACR,WAAa,EAAA;AAAA;AACf;AACF,KACD,CAAA;AAAA;AAEL;;;;"}
+{"version":3,"file":"InternalOpenApiDocumentationProvider.cjs.js","sources":["../src/InternalOpenApiDocumentationProvider.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport yaml from 'yaml';\nimport {\n  ANNOTATION_LOCATION,\n  ANNOTATION_ORIGIN_LOCATION,\n  type ApiEntity,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { ForwardedError } from '@backstage/errors';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\nimport { merge, isErrorResult } from 'openapi-merge';\nimport { getOpenApiSpecRoute } from '@backstage/backend-openapi-utils';\nimport type {\n  OpenAPIObject,\n  OperationObject,\n  PathItemObject,\n} from 'openapi3-ts';\nimport fetch from 'cross-fetch';\nimport {\n  AuthService,\n  DiscoveryService,\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\nimport * as uuid from 'uuid';\nimport lodash from 'lodash';\n\nconst HTTP_VERBS: (keyof PathItemObject)[] = [\n  'get',\n  'post',\n  'put',\n  'delete',\n  'patch',\n  'trace',\n  'options',\n  'head',\n];\n\nconst addTagsToSpec = (spec: OpenAPIObject, tag: string) => {\n  Object.values(spec?.paths).forEach((path: PathItemObject) => {\n    HTTP_VERBS.forEach(verb => {\n      if (verb in path) {\n        if (!('tags' in path[verb])) {\n          (path[verb] as OperationObject).tags = [];\n        }\n        if (!(path[verb] as OperationObject).tags?.includes(tag)) {\n          (path[verb] as OperationObject).tags?.push(tag);\n        }\n      }\n    });\n  });\n};\n\nconst mergeSpecs = async ({\n  baseUrl,\n  specs,\n}: {\n  baseUrl: string;\n  specs: OpenAPIObject[];\n}) => {\n  const mergeResult = merge([\n    // Add the full API information as the first item for other items to merge against it with.\n    {\n      oas: {\n        openapi: '3.0.3',\n        info: {\n          title: 'Backstage API',\n          version: '1',\n        },\n        servers: [{ url: baseUrl }],\n        paths: {},\n      },\n    },\n    // For each plugin, load its spec and the known endpoint that it sits under.\n    ...specs.map(\n      spec =>\n        ({\n          oas: spec,\n          // Weird typing differences between this package and the client package's openapi 3.\n        } as any),\n    ),\n  ]);\n\n  if (isErrorResult(mergeResult)) {\n    throw new ForwardedError(\n      `${mergeResult.message} (${mergeResult.type})`,\n      mergeResult,\n    );\n  } else {\n    return mergeResult.output;\n  }\n};\n\nconst loadSpecs = async ({\n  baseUrl,\n  discovery,\n  plugins,\n  logger,\n  auth,\n}: {\n  baseUrl: string;\n  plugins: string[];\n  discovery: DiscoveryService;\n  logger: LoggerService;\n  auth: AuthService;\n}) => {\n  const specs: OpenAPIObject[] = [];\n  for (const pluginId of plugins) {\n    const url = await discovery.getBaseUrl(pluginId);\n    const openApiUrl = getOpenApiSpecRoute(url);\n    const { token } = await auth.getPluginRequestToken({\n      onBehalfOf: await auth.getOwnServiceCredentials(),\n      targetPluginId: pluginId,\n    });\n    const response = await fetch(openApiUrl, {\n      method: 'GET',\n      headers: {\n        Authorization: `Bearer ${token}`,\n      },\n    });\n    if (response.ok) {\n      const spec = await response.json();\n      addTagsToSpec(spec, pluginId);\n      specs.push(spec);\n    } else if (response.status === 404) {\n      logger.error(\n        `Plugin=${pluginId} does not have an OpenAPI spec at '${openApiUrl}'.`,\n      );\n    } else {\n      logger.error(\n        `Failed to load spec for plugin=${pluginId} at ${openApiUrl}. Error (${\n          response.status\n        }): ${response.body ? await response.text() : response.statusText}`,\n      );\n    }\n  }\n  return mergeSpecs({ baseUrl, specs });\n};\n\nconst formatDefinition = (\n  definition: any,\n  format: string | 'json' | 'yaml',\n) => {\n  if (format === 'json') {\n    return JSON.stringify(definition, null, 2);\n  }\n  if (format === 'yaml') {\n    return yaml.stringify(definition);\n  }\n  throw new Error(`Unsupported format type: ${format}`);\n};\n\nexport class InternalOpenApiDocumentationProvider implements EntityProvider {\n  private connection?: EntityProviderConnection;\n  private readonly scheduleFn: () => Promise<void>;\n\n  constructor(\n    public readonly config: Config,\n    public readonly discovery: DiscoveryService,\n    public readonly logger: LoggerService,\n    public readonly auth: AuthService,\n    taskRunner: SchedulerServiceTaskRunner,\n  ) {\n    this.scheduleFn = this.createScheduleFn(taskRunner);\n  }\n\n  static fromConfig(\n    config: Config,\n    options: {\n      discovery: DiscoveryService;\n      logger: LoggerService;\n      schedule: SchedulerService;\n      auth: AuthService;\n    },\n  ) {\n    const taskRunner = options.schedule.createScheduledTaskRunner({\n      frequency: {\n        minutes: 1,\n      },\n      timeout: {\n        minutes: 1,\n      },\n    });\n    return new InternalOpenApiDocumentationProvider(\n      config,\n      options.discovery,\n      options.logger,\n      options.auth,\n      taskRunner,\n    );\n  }\n  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */\n  getProviderName() {\n    return `InternalOpenApiDocumentationProvider`;\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */\n  async connect(connection: EntityProviderConnection) {\n    this.connection = connection;\n    return await this.scheduleFn();\n  }\n\n  private createScheduleFn(\n    taskRunner: SchedulerServiceTaskRunner,\n  ): () => Promise<void> {\n    return async () => {\n      const taskId = `${this.getProviderName()}:refresh`;\n      return taskRunner.run({\n        id: taskId,\n        fn: async () => {\n          const logger = this.logger.child({\n            class:\n              InternalOpenApiDocumentationProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\n          });\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(`${this.getProviderName()} refresh failed`, error);\n          }\n        },\n      });\n    };\n  }\n\n  async refresh(logger: LoggerService) {\n    const pluginsToMerge = this.config.getStringArray(\n      'catalog.providers.backstageOpenapi.plugins',\n    );\n    const configToMerge = this.config.getOptional(\n      'catalog.providers.backstageOpenapi.entityOverrides',\n    );\n    const formatConfig =\n      this.config.getOptionalString(\n        'catalog.providers.backstageOpenapi.definitionFormat',\n      ) ?? 'json';\n\n    const baseConfig = {\n      metadata: {\n        name: 'internal_backstage_openapi_doc',\n        title: 'Backstage API',\n      },\n      spec: {\n        lifecycle: 'production',\n        owner: 'backstage',\n      },\n    };\n\n    logger.info(`Loading specs from ${pluginsToMerge}.`);\n    const requiredConfig = {\n      apiVersion: 'backstage.io/v1beta1',\n      kind: 'API',\n      metadata: {\n        annotations: {\n          [ANNOTATION_LOCATION]:\n            'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n          [ANNOTATION_ORIGIN_LOCATION]:\n            'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n        },\n      },\n      spec: {\n        type: 'openapi',\n        definition: formatDefinition(\n          await loadSpecs({\n            baseUrl: this.config.getString('backend.baseUrl'),\n            discovery: this.discovery,\n            auth: this.auth,\n            plugins: pluginsToMerge,\n            logger,\n          }),\n          formatConfig,\n        ),\n      },\n    };\n\n    // Overwrite baseConfig with options from config file.\n    const mergedConfig = lodash.merge(baseConfig, configToMerge);\n\n    // Overwite mergedConfig with requiredConfig (i.e., spec.type and spec.definition) to avoid bad configuration.\n    const documentationEntity = lodash.merge(\n      mergedConfig,\n      requiredConfig,\n    ) as ApiEntity;\n\n    await this.connection?.applyMutation({\n      type: 'full',\n      entities: [\n        {\n          entity: documentationEntity,\n          locationKey: 'internal-api-doc',\n        },\n      ],\n    });\n  }\n}\n"],"names":["merge","isErrorResult","ForwardedError","getOpenApiSpecRoute","fetch","yaml","uuid","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","lodash"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CA,MAAM,UAAuC,GAAA;AAAA,EAC3C,KAAA;AAAA,EACA,MAAA;AAAA,EACA,KAAA;AAAA,EACA,QAAA;AAAA,EACA,OAAA;AAAA,EACA,OAAA;AAAA,EACA,SAAA;AAAA,EACA;AACF,CAAA;AAEA,MAAM,aAAA,GAAgB,CAAC,IAAA,EAAqB,GAAgB,KAAA;AAC1D,EAAA,MAAA,CAAO,OAAO,IAAM,EAAA,KAAK,CAAE,CAAA,OAAA,CAAQ,CAAC,IAAyB,KAAA;AAC3D,IAAA,UAAA,CAAW,QAAQ,CAAQ,IAAA,KAAA;AACzB,MAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,QAAA,IAAI,EAAE,MAAA,IAAU,IAAK,CAAA,IAAI,CAAI,CAAA,EAAA;AAC3B,UAAC,IAAK,CAAA,IAAI,CAAsB,CAAA,IAAA,GAAO,EAAC;AAAA;AAE1C,QAAA,IAAI,CAAE,IAAK,CAAA,IAAI,EAAsB,IAAM,EAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AACxD,UAAC,IAAK,CAAA,IAAI,CAAsB,CAAA,IAAA,EAAM,KAAK,GAAG,CAAA;AAAA;AAChD;AACF,KACD,CAAA;AAAA,GACF,CAAA;AACH,CAAA;AAEA,MAAM,aAAa,OAAO;AAAA,EACxB,OAAA;AAAA,EACA;AACF,CAGM,KAAA;AACJ,EAAA,MAAM,cAAcA,kBAAM,CAAA;AAAA;AAAA,IAExB;AAAA,MACE,GAAK,EAAA;AAAA,QACH,OAAS,EAAA,OAAA;AAAA,QACT,IAAM,EAAA;AAAA,UACJ,KAAO,EAAA,eAAA;AAAA,UACP,OAAS,EAAA;AAAA,SACX;AAAA,QACA,OAAS,EAAA,CAAC,EAAE,GAAA,EAAK,SAAS,CAAA;AAAA,QAC1B,OAAO;AAAC;AACV,KACF;AAAA;AAAA,IAEA,GAAG,KAAM,CAAA,GAAA;AAAA,MACP,CACG,IAAA,MAAA;AAAA,QACC,GAAK,EAAA;AAAA;AAAA,OAEP;AAAA;AACJ,GACD,CAAA;AAED,EAAI,IAAAC,0BAAA,CAAc,WAAW,CAAG,EAAA;AAC9B,IAAA,MAAM,IAAIC,qBAAA;AAAA,MACR,CAAG,EAAA,WAAA,CAAY,OAAO,CAAA,EAAA,EAAK,YAAY,IAAI,CAAA,CAAA,CAAA;AAAA,MAC3C;AAAA,KACF;AAAA,GACK,MAAA;AACL,IAAA,OAAO,WAAY,CAAA,MAAA;AAAA;AAEvB,CAAA;AAEA,MAAM,YAAY,OAAO;AAAA,EACvB,OAAA;AAAA,EACA,SAAA;AAAA,EACA,OAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAMM,KAAA;AACJ,EAAA,MAAM,QAAyB,EAAC;AAChC,EAAA,KAAA,MAAW,YAAY,OAAS,EAAA;AAC9B,IAAA,MAAM,GAAM,GAAA,MAAM,SAAU,CAAA,UAAA,CAAW,QAAQ,CAAA;AAC/C,IAAM,MAAA,UAAA,GAAaC,wCAAoB,GAAG,CAAA;AAC1C,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,MACjD,UAAA,EAAY,MAAM,IAAA,CAAK,wBAAyB,EAAA;AAAA,MAChD,cAAgB,EAAA;AAAA,KACjB,CAAA;AACD,IAAM,MAAA,QAAA,GAAW,MAAMC,sBAAA,CAAM,UAAY,EAAA;AAAA,MACvC,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,UAAU,KAAK,CAAA;AAAA;AAChC,KACD,CAAA;AACD,IAAA,IAAI,SAAS,EAAI,EAAA;AACf,MAAM,MAAA,IAAA,GAAO,MAAM,QAAA,CAAS,IAAK,EAAA;AACjC,MAAA,aAAA,CAAc,MAAM,QAAQ,CAAA;AAC5B,MAAA,KAAA,CAAM,KAAK,IAAI,CAAA;AAAA,KACjB,MAAA,IAAW,QAAS,CAAA,MAAA,KAAW,GAAK,EAAA;AAClC,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAA,OAAA,EAAU,QAAQ,CAAA,mCAAA,EAAsC,UAAU,CAAA,EAAA;AAAA,OACpE;AAAA,KACK,MAAA;AACL,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAkC,+BAAA,EAAA,QAAQ,CAAO,IAAA,EAAA,UAAU,YACzD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,OAAO,MAAM,QAAA,CAAS,IAAK,EAAA,GAAI,SAAS,UAAU,CAAA;AAAA,OACnE;AAAA;AACF;AAEF,EAAA,OAAO,UAAW,CAAA,EAAE,OAAS,EAAA,KAAA,EAAO,CAAA;AACtC,CAAA;AAEA,MAAM,gBAAA,GAAmB,CACvB,UAAA,EACA,MACG,KAAA;AACH,EAAA,IAAI,WAAW,MAAQ,EAAA;AACrB,IAAA,OAAO,IAAK,CAAA,SAAA,CAAU,UAAY,EAAA,IAAA,EAAM,CAAC,CAAA;AAAA;AAE3C,EAAA,IAAI,WAAW,MAAQ,EAAA;AACrB,IAAO,OAAAC,qBAAA,CAAK,UAAU,UAAU,CAAA;AAAA;AAElC,EAAA,MAAM,IAAI,KAAA,CAAM,CAA4B,yBAAA,EAAA,MAAM,CAAE,CAAA,CAAA;AACtD,CAAA;AAEO,MAAM,oCAA+D,CAAA;AAAA,EAI1E,WACkB,CAAA,MAAA,EACA,SACA,EAAA,MAAA,EACA,MAChB,UACA,EAAA;AALgB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAGhB,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA;AAAA;AACpD,EAXQ,UAAA;AAAA,EACS,UAAA;AAAA,EAYjB,OAAO,UACL,CAAA,MAAA,EACA,OAMA,EAAA;AACA,IAAM,MAAA,UAAA,GAAa,OAAQ,CAAA,QAAA,CAAS,yBAA0B,CAAA;AAAA,MAC5D,SAAW,EAAA;AAAA,QACT,OAAS,EAAA;AAAA,OACX;AAAA,MACA,OAAS,EAAA;AAAA,QACP,OAAS,EAAA;AAAA;AACX,KACD,CAAA;AACD,IAAA,OAAO,IAAI,oCAAA;AAAA,MACT,MAAA;AAAA,MACA,OAAQ,CAAA,SAAA;AAAA,MACR,OAAQ,CAAA,MAAA;AAAA,MACR,OAAQ,CAAA,IAAA;AAAA,MACR;AAAA,KACF;AAAA;AACF;AAAA,EAEA,eAAkB,GAAA;AAChB,IAAO,OAAA,CAAA,oCAAA,CAAA;AAAA;AACT;AAAA,EAGA,MAAM,QAAQ,UAAsC,EAAA;AAClD,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA;AAClB,IAAO,OAAA,MAAM,KAAK,UAAW,EAAA;AAAA;AAC/B,EAEQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EACE,oCAAqC,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC7D,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG;AAAA,WACzB,CAAA;AACD,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAA,MAAA,CAAO,MAAM,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,mBAAmB,KAAK,CAAA;AAAA;AAChE;AACF,OACD,CAAA;AAAA,KACH;AAAA;AACF,EAEA,MAAM,QAAQ,MAAuB,EAAA;AACnC,IAAM,MAAA,cAAA,GAAiB,KAAK,MAAO,CAAA,cAAA;AAAA,MACjC;AAAA,KACF;AACA,IAAM,MAAA,aAAA,GAAgB,KAAK,MAAO,CAAA,WAAA;AAAA,MAChC;AAAA,KACF;AACA,IAAM,MAAA,YAAA,GACJ,KAAK,MAAO,CAAA,iBAAA;AAAA,MACV;AAAA,KACG,IAAA,MAAA;AAEP,IAAA,MAAM,UAAa,GAAA;AAAA,MACjB,QAAU,EAAA;AAAA,QACR,IAAM,EAAA,gCAAA;AAAA,QACN,KAAO,EAAA;AAAA,OACT;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,SAAW,EAAA,YAAA;AAAA,QACX,KAAO,EAAA;AAAA;AACT,KACF;AAEA,IAAO,MAAA,CAAA,IAAA,CAAK,CAAsB,mBAAA,EAAA,cAAc,CAAG,CAAA,CAAA,CAAA;AACnD,IAAA,MAAM,cAAiB,GAAA;AAAA,MACrB,UAAY,EAAA,sBAAA;AAAA,MACZ,IAAM,EAAA,KAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR,WAAa,EAAA;AAAA,UACX,CAACC,gCAAmB,GAClB,6EAAA;AAAA,UACF,CAACC,uCAA0B,GACzB;AAAA;AACJ,OACF;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,IAAM,EAAA,SAAA;AAAA,QACN,UAAY,EAAA,gBAAA;AAAA,UACV,MAAM,SAAU,CAAA;AAAA,YACd,OAAS,EAAA,IAAA,CAAK,MAAO,CAAA,SAAA,CAAU,iBAAiB,CAAA;AAAA,YAChD,WAAW,IAAK,CAAA,SAAA;AAAA,YAChB,MAAM,IAAK,CAAA,IAAA;AAAA,YACX,OAAS,EAAA,cAAA;AAAA,YACT;AAAA,WACD,CAAA;AAAA,UACD;AAAA;AACF;AACF,KACF;AAGA,IAAA,MAAM,YAAe,GAAAC,uBAAA,CAAO,KAAM,CAAA,UAAA,EAAY,aAAa,CAAA;AAG3D,IAAA,MAAM,sBAAsBA,uBAAO,CAAA,KAAA;AAAA,MACjC,YAAA;AAAA,MACA;AAAA,KACF;AAEA,IAAM,MAAA,IAAA,CAAK,YAAY,aAAc,CAAA;AAAA,MACnC,IAAM,EAAA,MAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR;AAAA,UACE,MAAQ,EAAA,mBAAA;AAAA,UACR,WAAa,EAAA;AAAA;AACf;AACF,KACD,CAAA;AAAA;AAEL;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-backstage-openapi",
-  "version": "0.4.5",
+  "version": "0.5.0-next.1",
   "backstage": {
     "role": "backend-plugin-module",
     "pluginId": "catalog",
@@ -36,19 +36,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-openapi-utils": "^0.5.0",
-    "@backstage/backend-plugin-api": "^1.2.0",
-    "@backstage/catalog-model": "^1.7.3",
-    "@backstage/config": "^1.3.2",
-    "@backstage/errors": "^1.2.7",
-    "@backstage/plugin-catalog-node": "^1.16.0",
+    "@backstage/backend-openapi-utils": "0.5.1-next.1",
+    "@backstage/backend-plugin-api": "1.2.1-next.1",
+    "@backstage/catalog-model": "1.7.3",
+    "@backstage/config": "1.3.2",
+    "@backstage/errors": "1.2.7",
+    "@backstage/plugin-catalog-node": "1.16.1-next.1",
     "cross-fetch": "^4.0.0",
     "lodash": "^4.17.21",
     "openapi-merge": "^1.3.2",
-    "uuid": "^11.0.0"
+    "uuid": "^11.0.0",
+    "yaml": "^2.7.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.30.0",
+    "@backstage/cli": "0.30.1-next.0",
     "openapi3-ts": "^3.1.2"
   },
   "configSchema": "config.d.ts",