@backstage/plugin-catalog-backend-module-gerrit 0.1.8-next.1 → 0.1.8

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @backstage/plugin-catalog-backend-module-gerrit
 
+## 0.1.8
+
+### Patch Changes
+
+- 9f2b786fc9: Provide context for logged errors.
+- 8e06f3cf00: Switched imports of `loggerToWinstonLogger` to `@backstage/backend-common`.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.3.0
+  - @backstage/backend-common@0.18.0
+  - @backstage/catalog-model@1.1.5
+  - @backstage/backend-tasks@0.4.1
+  - @backstage/plugin-catalog-node@1.3.1
+  - @backstage/plugin-catalog-backend@1.7.0
+  - @backstage/config@1.0.6
+  - @backstage/errors@1.1.4
+  - @backstage/integration@1.4.2
+
+## 0.1.8-next.2
+
+### Patch Changes
+
+- 9f2b786fc9: Provide context for logged errors.
+- 8e06f3cf00: Switched imports of `loggerToWinstonLogger` to `@backstage/backend-common`.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.3.0-next.1
+  - @backstage/backend-common@0.18.0-next.1
+  - @backstage/backend-tasks@0.4.1-next.1
+  - @backstage/plugin-catalog-backend@1.7.0-next.2
+  - @backstage/plugin-catalog-node@1.3.1-next.2
+  - @backstage/catalog-model@1.1.5-next.1
+  - @backstage/config@1.0.6-next.0
+  - @backstage/errors@1.1.4
+  - @backstage/integration@1.4.2-next.0
+
 ## 0.1.8-next.1
 
 ### Patch Changes

package/dist/index.alpha.d.ts

@@ -29,6 +29,6 @@ export declare class GerritEntityProvider implements EntityProvider {
 /**
  * @alpha
  */
-export declare const gerritEntityProviderCatalogModule: (options?: undefined) => BackendFeature;
+export declare const gerritEntityProviderCatalogModule: () => BackendFeature;
 
 export { }

package/dist/index.cjs.js

@@ -8,6 +8,7 @@ var fetch = require('node-fetch');
 var integration = require('@backstage/integration');
 var uuid = require('uuid');
 var backendTasks = require('@backstage/backend-tasks');
+var backendCommon = require('@backstage/backend-common');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var pluginCatalogNode = require('@backstage/plugin-catalog-node');
 
@@ -122,7 +123,7 @@ class GerritEntityProvider {
           try {
             await this.refresh(logger);
           } catch (error) {
-            logger.error(error);
+            logger.error(`${this.getProviderName()} refresh failed`, error);
           }
         }
       });
@@ -180,7 +181,7 @@ const gerritEntityProviderCatalogModule = backendPluginApi.createBackendModule({
         scheduler: backendPluginApi.coreServices.scheduler
       },
       async init({ catalog, config, logger, scheduler }) {
-        const winstonLogger = backendPluginApi.loggerToWinstonLogger(logger);
+        const winstonLogger = backendCommon.loggerToWinstonLogger(logger);
         const providers = GerritEntityProvider.fromConfig(config, {
           logger: winstonLogger,
           scheduler

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/providers/config.ts","../src/providers/GerritEntityProvider.ts","../src/service/GerritEntityProviderCatalogModule.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { readTaskScheduleDefinitionFromConfig } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { GerritProviderConfig } from './types';\n\nfunction readGerritConfig(id: string, config: Config): GerritProviderConfig {\n  const branch = config.getOptionalString('branch') ?? 'master';\n  const host = config.getString('host');\n  const query = config.getString('query');\n\n  const schedule = config.has('schedule')\n    ? readTaskScheduleDefinitionFromConfig(config.getConfig('schedule'))\n    : undefined;\n\n  return {\n    branch,\n    host,\n    id,\n    query,\n    schedule,\n  };\n}\n\nexport function readGerritConfigs(config: Config): GerritProviderConfig[] {\n  const configs: GerritProviderConfig[] = [];\n\n  const providerConfigs = config.getOptionalConfig('catalog.providers.gerrit');\n\n  if (!providerConfigs) {\n    return configs;\n  }\n\n  for (const id of providerConfigs.keys()) {\n    configs.push(readGerritConfig(id, providerConfigs.getConfig(id)));\n  }\n\n  return configs;\n}\n","/*\n * Copyright 2022 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 { PluginTaskScheduler, TaskRunner } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n  LocationSpec,\n  locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-backend';\nimport fetch, { Response } from 'node-fetch';\nimport {\n  GerritIntegration,\n  getGerritProjectsApiUrl,\n  getGerritRequestOptions,\n  parseGerritJsonResponse,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport * as uuid from 'uuid';\nimport { Logger } from 'winston';\n\nimport { readGerritConfigs } from './config';\nimport { GerritProjectQueryResult, GerritProviderConfig } from './types';\n\n/** @public */\nexport class GerritEntityProvider implements EntityProvider {\n  private readonly config: GerritProviderConfig;\n  private readonly integration: GerritIntegration;\n  private readonly logger: Logger;\n  private readonly scheduleFn: () => Promise<void>;\n  private connection?: EntityProviderConnection;\n\n  static fromConfig(\n    configRoot: Config,\n    options: {\n      logger: Logger;\n      schedule?: TaskRunner;\n      scheduler?: PluginTaskScheduler;\n    },\n  ): GerritEntityProvider[] {\n    if (!options.schedule && !options.scheduler) {\n      throw new Error('Either schedule or scheduler must be provided.');\n    }\n\n    const providerConfigs = readGerritConfigs(configRoot);\n    const integrations = ScmIntegrations.fromConfig(configRoot).gerrit;\n    const providers: GerritEntityProvider[] = [];\n\n    providerConfigs.forEach(providerConfig => {\n      const integration = integrations.byHost(providerConfig.host);\n      if (!integration) {\n        throw new InputError(\n          `No gerrit integration found that matches host ${providerConfig.host}`,\n        );\n      }\n\n      if (!options.schedule && !providerConfig.schedule) {\n        throw new Error(\n          `No schedule provided neither via code nor config for gerrit-provider:${providerConfig.id}.`,\n        );\n      }\n\n      const taskRunner =\n        options.schedule ??\n        options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n      providers.push(\n        new GerritEntityProvider(\n          providerConfig,\n          integration,\n          options.logger,\n          taskRunner,\n        ),\n      );\n    });\n    return providers;\n  }\n\n  private constructor(\n    config: GerritProviderConfig,\n    integration: GerritIntegration,\n    logger: Logger,\n    taskRunner: TaskRunner,\n  ) {\n    this.config = config;\n    this.integration = integration;\n    this.logger = logger.child({\n      target: this.getProviderName(),\n    });\n    this.scheduleFn = this.createScheduleFn(taskRunner);\n  }\n\n  getProviderName(): string {\n    return `gerrit-provider:${this.config.id}`;\n  }\n\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    await this.scheduleFn();\n  }\n\n  private createScheduleFn(taskRunner: TaskRunner): () => 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: GerritEntityProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\n          });\n\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(error);\n          }\n        },\n      });\n    };\n  }\n\n  async refresh(logger: Logger): Promise<void> {\n    if (!this.connection) {\n      throw new Error('Gerrit discovery connection not initialized');\n    }\n\n    let response: Response;\n\n    const baseProjectApiUrl = getGerritProjectsApiUrl(this.integration.config);\n    const projectQueryUrl = `${baseProjectApiUrl}?${this.config.query}`;\n    try {\n      response = await fetch(projectQueryUrl, {\n        method: 'GET',\n        ...getGerritRequestOptions(this.integration.config),\n      });\n    } catch (e) {\n      throw new Error(\n        `Failed to list Gerrit projects for query ${this.config.query}, ${e}`,\n      );\n    }\n    const gerritProjectsResponse = (await parseGerritJsonResponse(\n      response as any,\n    )) as GerritProjectQueryResult;\n    const projects = Object.keys(gerritProjectsResponse);\n\n    const locations = projects.map(project => this.createLocationSpec(project));\n    await this.connection.applyMutation({\n      type: 'full',\n      entities: locations.map(location => ({\n        locationKey: this.getProviderName(),\n        entity: locationSpecToLocationEntity({ location }),\n      })),\n    });\n    logger.info(`Found ${locations.length} locations.`);\n  }\n\n  private createLocationSpec(project: string): LocationSpec {\n    return {\n      type: 'url',\n      target: `${this.integration.config.gitilesBaseUrl}/${project}/+/refs/heads/${this.config.branch}/catalog-info.yaml`,\n      presence: 'optional',\n    };\n  }\n}\n","/*\n * Copyright 2022 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  coreServices,\n  createBackendModule,\n  loggerToWinstonLogger,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';\nimport { GerritEntityProvider } from '../providers/GerritEntityProvider';\n\n/**\n * @alpha\n */\nexport const gerritEntityProviderCatalogModule = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'gerritEntityProvider',\n  register(env) {\n    env.registerInit({\n      deps: {\n        catalog: catalogProcessingExtensionPoint,\n        config: coreServices.config,\n        logger: coreServices.logger,\n        scheduler: coreServices.scheduler,\n      },\n      async init({ catalog, config, logger, scheduler }) {\n        const winstonLogger = loggerToWinstonLogger(logger);\n        const providers = GerritEntityProvider.fromConfig(config, {\n          logger: winstonLogger,\n          scheduler,\n        });\n\n        catalog.addEntityProvider(providers);\n      },\n    });\n  },\n});\n"],"names":["readTaskScheduleDefinitionFromConfig","ScmIntegrations","InputError","uuid","getGerritProjectsApiUrl","fetch","getGerritRequestOptions","parseGerritJsonResponse","locationSpecToLocationEntity","createBackendModule","catalogProcessingExtensionPoint","coreServices","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoBA,SAAS,gBAAA,CAAiB,IAAY,MAAsC,EAAA;AApB5E,EAAA,IAAA,EAAA,CAAA;AAqBE,EAAA,MAAM,MAAS,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,QAAQ,MAAjC,IAAsC,GAAA,EAAA,GAAA,QAAA,CAAA;AACrD,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AACpC,EAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,SAAA,CAAU,OAAO,CAAA,CAAA;AAEtC,EAAM,MAAA,QAAA,GAAW,MAAO,CAAA,GAAA,CAAI,UAAU,CAAA,GAClCA,kDAAqC,MAAO,CAAA,SAAA,CAAU,UAAU,CAAC,CACjE,GAAA,KAAA,CAAA,CAAA;AAEJ,EAAO,OAAA;AAAA,IACL,MAAA;AAAA,IACA,IAAA;AAAA,IACA,EAAA;AAAA,IACA,KAAA;AAAA,IACA,QAAA;AAAA,GACF,CAAA;AACF,CAAA;AAEO,SAAS,kBAAkB,MAAwC,EAAA;AACxE,EAAA,MAAM,UAAkC,EAAC,CAAA;AAEzC,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA,CAAA;AAE3E,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAEA,EAAW,KAAA,MAAA,EAAA,IAAM,eAAgB,CAAA,IAAA,EAAQ,EAAA;AACvC,IAAA,OAAA,CAAQ,KAAK,gBAAiB,CAAA,EAAA,EAAI,gBAAgB,SAAU,CAAA,EAAE,CAAC,CAAC,CAAA,CAAA;AAAA,GAClE;AAEA,EAAO,OAAA,OAAA,CAAA;AACT;;ACZO,MAAM,oBAA+C,CAAA;AAAA,EAO1D,OAAO,UACL,CAAA,UAAA,EACA,OAKwB,EAAA;AACxB,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,QAAQ,SAAW,EAAA;AAC3C,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KAClE;AAEA,IAAM,MAAA,eAAA,GAAkB,kBAAkB,UAAU,CAAA,CAAA;AACpD,IAAA,MAAM,YAAe,GAAAC,2BAAA,CAAgB,UAAW,CAAA,UAAU,CAAE,CAAA,MAAA,CAAA;AAC5D,IAAA,MAAM,YAAoC,EAAC,CAAA;AAE3C,IAAA,eAAA,CAAgB,QAAQ,CAAkB,cAAA,KAAA;AA/D9C,MAAA,IAAA,EAAA,CAAA;AAgEM,MAAA,MAAM,WAAc,GAAA,YAAA,CAAa,MAAO,CAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAC3D,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,iDAAiD,cAAe,CAAA,IAAA,CAAA,CAAA;AAAA,SAClE,CAAA;AAAA,OACF;AAEA,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,wEAAwE,cAAe,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,SACzF,CAAA;AAAA,OACF;AAEA,MAAM,MAAA,UAAA,GAAA,CACJ,aAAQ,QAAR,KAAA,IAAA,GAAA,EAAA,GACA,QAAQ,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA,CAAA;AAEvE,MAAU,SAAA,CAAA,IAAA;AAAA,QACR,IAAI,oBAAA;AAAA,UACF,cAAA;AAAA,UACA,WAAA;AAAA,UACA,OAAQ,CAAA,MAAA;AAAA,UACR,UAAA;AAAA,SACF;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AACD,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEQ,WACN,CAAA,MAAA,EACA,WACA,EAAA,MAAA,EACA,UACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AACD,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,gBAAA,EAAmB,KAAK,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,GACxC;AAAA,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEQ,iBAAiB,UAA6C,EAAA;AACpE,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,MAAA,GAAS,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAA,CAAA,QAAA,CAAA,CAAA;AACvC,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,EAAO,oBAAqB,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAClD,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAP,EAAA;AACA,YAAA,MAAA,CAAO,MAAM,KAAK,CAAA,CAAA;AAAA,WACpB;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAQ,MAA+B,EAAA;AAC3C,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,6CAA6C,CAAA,CAAA;AAAA,KAC/D;AAEA,IAAI,IAAA,QAAA,CAAA;AAEJ,IAAA,MAAM,iBAAoB,GAAAC,mCAAA,CAAwB,IAAK,CAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AACzE,IAAA,MAAM,eAAkB,GAAA,CAAA,EAAG,iBAAqB,CAAA,CAAA,EAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAA,CAAA,CAAA;AAC5D,IAAI,IAAA;AACF,MAAW,QAAA,GAAA,MAAMC,0BAAM,eAAiB,EAAA;AAAA,QACtC,MAAQ,EAAA,KAAA;AAAA,QACR,GAAGC,mCAAA,CAAwB,IAAK,CAAA,WAAA,CAAY,MAAM,CAAA;AAAA,OACnD,CAAA,CAAA;AAAA,aACM,CAAP,EAAA;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,yCAAA,EAA4C,IAAK,CAAA,MAAA,CAAO,KAAU,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA;AAAA,OACpE,CAAA;AAAA,KACF;AACA,IAAA,MAAM,yBAA0B,MAAMC,mCAAA;AAAA,MACpC,QAAA;AAAA,KACF,CAAA;AACA,IAAM,MAAA,QAAA,GAAW,MAAO,CAAA,IAAA,CAAK,sBAAsB,CAAA,CAAA;AAEnD,IAAA,MAAM,YAAY,QAAS,CAAA,GAAA,CAAI,aAAW,IAAK,CAAA,kBAAA,CAAmB,OAAO,CAAC,CAAA,CAAA;AAC1E,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,SAAU,CAAA,GAAA,CAAI,CAAa,QAAA,MAAA;AAAA,QACnC,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAQ,EAAAC,iDAAA,CAA6B,EAAE,QAAA,EAAU,CAAA;AAAA,OACjD,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AACD,IAAO,MAAA,CAAA,IAAA,CAAK,CAAS,MAAA,EAAA,SAAA,CAAU,MAAmB,CAAA,WAAA,CAAA,CAAA,CAAA;AAAA,GACpD;AAAA,EAEQ,mBAAmB,OAA+B,EAAA;AACxD,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,MAAA,EAAQ,GAAG,IAAK,CAAA,WAAA,CAAY,OAAO,cAAkB,CAAA,CAAA,EAAA,OAAA,CAAA,cAAA,EAAwB,KAAK,MAAO,CAAA,MAAA,CAAA,kBAAA,CAAA;AAAA,MACzF,QAAU,EAAA,UAAA;AAAA,KACZ,CAAA;AAAA,GACF;AACF;;ACzJO,MAAM,oCAAoCC,oCAAoB,CAAA;AAAA,EACnE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,sBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,iDAAA;AAAA,QACT,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,SAAS,MAAQ,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAM,MAAA,aAAA,GAAgBC,uCAAsB,MAAM,CAAA,CAAA;AAClD,QAAM,MAAA,SAAA,GAAY,oBAAqB,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACxD,MAAQ,EAAA,aAAA;AAAA,UACR,SAAA;AAAA,SACD,CAAA,CAAA;AAED,QAAA,OAAA,CAAQ,kBAAkB,SAAS,CAAA,CAAA;AAAA,OACrC;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/providers/config.ts","../src/providers/GerritEntityProvider.ts","../src/service/GerritEntityProviderCatalogModule.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { readTaskScheduleDefinitionFromConfig } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { GerritProviderConfig } from './types';\n\nfunction readGerritConfig(id: string, config: Config): GerritProviderConfig {\n  const branch = config.getOptionalString('branch') ?? 'master';\n  const host = config.getString('host');\n  const query = config.getString('query');\n\n  const schedule = config.has('schedule')\n    ? readTaskScheduleDefinitionFromConfig(config.getConfig('schedule'))\n    : undefined;\n\n  return {\n    branch,\n    host,\n    id,\n    query,\n    schedule,\n  };\n}\n\nexport function readGerritConfigs(config: Config): GerritProviderConfig[] {\n  const configs: GerritProviderConfig[] = [];\n\n  const providerConfigs = config.getOptionalConfig('catalog.providers.gerrit');\n\n  if (!providerConfigs) {\n    return configs;\n  }\n\n  for (const id of providerConfigs.keys()) {\n    configs.push(readGerritConfig(id, providerConfigs.getConfig(id)));\n  }\n\n  return configs;\n}\n","/*\n * Copyright 2022 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 { PluginTaskScheduler, TaskRunner } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n  LocationSpec,\n  locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-backend';\nimport fetch, { Response } from 'node-fetch';\nimport {\n  GerritIntegration,\n  getGerritProjectsApiUrl,\n  getGerritRequestOptions,\n  parseGerritJsonResponse,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport * as uuid from 'uuid';\nimport { Logger } from 'winston';\n\nimport { readGerritConfigs } from './config';\nimport { GerritProjectQueryResult, GerritProviderConfig } from './types';\n\n/** @public */\nexport class GerritEntityProvider implements EntityProvider {\n  private readonly config: GerritProviderConfig;\n  private readonly integration: GerritIntegration;\n  private readonly logger: Logger;\n  private readonly scheduleFn: () => Promise<void>;\n  private connection?: EntityProviderConnection;\n\n  static fromConfig(\n    configRoot: Config,\n    options: {\n      logger: Logger;\n      schedule?: TaskRunner;\n      scheduler?: PluginTaskScheduler;\n    },\n  ): GerritEntityProvider[] {\n    if (!options.schedule && !options.scheduler) {\n      throw new Error('Either schedule or scheduler must be provided.');\n    }\n\n    const providerConfigs = readGerritConfigs(configRoot);\n    const integrations = ScmIntegrations.fromConfig(configRoot).gerrit;\n    const providers: GerritEntityProvider[] = [];\n\n    providerConfigs.forEach(providerConfig => {\n      const integration = integrations.byHost(providerConfig.host);\n      if (!integration) {\n        throw new InputError(\n          `No gerrit integration found that matches host ${providerConfig.host}`,\n        );\n      }\n\n      if (!options.schedule && !providerConfig.schedule) {\n        throw new Error(\n          `No schedule provided neither via code nor config for gerrit-provider:${providerConfig.id}.`,\n        );\n      }\n\n      const taskRunner =\n        options.schedule ??\n        options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n      providers.push(\n        new GerritEntityProvider(\n          providerConfig,\n          integration,\n          options.logger,\n          taskRunner,\n        ),\n      );\n    });\n    return providers;\n  }\n\n  private constructor(\n    config: GerritProviderConfig,\n    integration: GerritIntegration,\n    logger: Logger,\n    taskRunner: TaskRunner,\n  ) {\n    this.config = config;\n    this.integration = integration;\n    this.logger = logger.child({\n      target: this.getProviderName(),\n    });\n    this.scheduleFn = this.createScheduleFn(taskRunner);\n  }\n\n  getProviderName(): string {\n    return `gerrit-provider:${this.config.id}`;\n  }\n\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    await this.scheduleFn();\n  }\n\n  private createScheduleFn(taskRunner: TaskRunner): () => 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: GerritEntityProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\n          });\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: Logger): Promise<void> {\n    if (!this.connection) {\n      throw new Error('Gerrit discovery connection not initialized');\n    }\n\n    let response: Response;\n\n    const baseProjectApiUrl = getGerritProjectsApiUrl(this.integration.config);\n    const projectQueryUrl = `${baseProjectApiUrl}?${this.config.query}`;\n    try {\n      response = await fetch(projectQueryUrl, {\n        method: 'GET',\n        ...getGerritRequestOptions(this.integration.config),\n      });\n    } catch (e) {\n      throw new Error(\n        `Failed to list Gerrit projects for query ${this.config.query}, ${e}`,\n      );\n    }\n    const gerritProjectsResponse = (await parseGerritJsonResponse(\n      response as any,\n    )) as GerritProjectQueryResult;\n    const projects = Object.keys(gerritProjectsResponse);\n\n    const locations = projects.map(project => this.createLocationSpec(project));\n    await this.connection.applyMutation({\n      type: 'full',\n      entities: locations.map(location => ({\n        locationKey: this.getProviderName(),\n        entity: locationSpecToLocationEntity({ location }),\n      })),\n    });\n    logger.info(`Found ${locations.length} locations.`);\n  }\n\n  private createLocationSpec(project: string): LocationSpec {\n    return {\n      type: 'url',\n      target: `${this.integration.config.gitilesBaseUrl}/${project}/+/refs/heads/${this.config.branch}/catalog-info.yaml`,\n      presence: 'optional',\n    };\n  }\n}\n","/*\n * Copyright 2022 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 { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';\nimport { GerritEntityProvider } from '../providers/GerritEntityProvider';\n\n/**\n * @alpha\n */\nexport const gerritEntityProviderCatalogModule = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'gerritEntityProvider',\n  register(env) {\n    env.registerInit({\n      deps: {\n        catalog: catalogProcessingExtensionPoint,\n        config: coreServices.config,\n        logger: coreServices.logger,\n        scheduler: coreServices.scheduler,\n      },\n      async init({ catalog, config, logger, scheduler }) {\n        const winstonLogger = loggerToWinstonLogger(logger);\n        const providers = GerritEntityProvider.fromConfig(config, {\n          logger: winstonLogger,\n          scheduler,\n        });\n\n        catalog.addEntityProvider(providers);\n      },\n    });\n  },\n});\n"],"names":["readTaskScheduleDefinitionFromConfig","ScmIntegrations","InputError","uuid","getGerritProjectsApiUrl","fetch","getGerritRequestOptions","parseGerritJsonResponse","locationSpecToLocationEntity","createBackendModule","catalogProcessingExtensionPoint","coreServices","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoBA,SAAS,gBAAA,CAAiB,IAAY,MAAsC,EAAA;AApB5E,EAAA,IAAA,EAAA,CAAA;AAqBE,EAAA,MAAM,MAAS,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,QAAQ,MAAjC,IAAsC,GAAA,EAAA,GAAA,QAAA,CAAA;AACrD,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AACpC,EAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,SAAA,CAAU,OAAO,CAAA,CAAA;AAEtC,EAAM,MAAA,QAAA,GAAW,MAAO,CAAA,GAAA,CAAI,UAAU,CAAA,GAClCA,kDAAqC,MAAO,CAAA,SAAA,CAAU,UAAU,CAAC,CACjE,GAAA,KAAA,CAAA,CAAA;AAEJ,EAAO,OAAA;AAAA,IACL,MAAA;AAAA,IACA,IAAA;AAAA,IACA,EAAA;AAAA,IACA,KAAA;AAAA,IACA,QAAA;AAAA,GACF,CAAA;AACF,CAAA;AAEO,SAAS,kBAAkB,MAAwC,EAAA;AACxE,EAAA,MAAM,UAAkC,EAAC,CAAA;AAEzC,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA,CAAA;AAE3E,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAEA,EAAW,KAAA,MAAA,EAAA,IAAM,eAAgB,CAAA,IAAA,EAAQ,EAAA;AACvC,IAAA,OAAA,CAAQ,KAAK,gBAAiB,CAAA,EAAA,EAAI,gBAAgB,SAAU,CAAA,EAAE,CAAC,CAAC,CAAA,CAAA;AAAA,GAClE;AAEA,EAAO,OAAA,OAAA,CAAA;AACT;;ACZO,MAAM,oBAA+C,CAAA;AAAA,EAO1D,OAAO,UACL,CAAA,UAAA,EACA,OAKwB,EAAA;AACxB,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,QAAQ,SAAW,EAAA;AAC3C,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KAClE;AAEA,IAAM,MAAA,eAAA,GAAkB,kBAAkB,UAAU,CAAA,CAAA;AACpD,IAAA,MAAM,YAAe,GAAAC,2BAAA,CAAgB,UAAW,CAAA,UAAU,CAAE,CAAA,MAAA,CAAA;AAC5D,IAAA,MAAM,YAAoC,EAAC,CAAA;AAE3C,IAAA,eAAA,CAAgB,QAAQ,CAAkB,cAAA,KAAA;AA/D9C,MAAA,IAAA,EAAA,CAAA;AAgEM,MAAA,MAAM,WAAc,GAAA,YAAA,CAAa,MAAO,CAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAC3D,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,iDAAiD,cAAe,CAAA,IAAA,CAAA,CAAA;AAAA,SAClE,CAAA;AAAA,OACF;AAEA,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,wEAAwE,cAAe,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,SACzF,CAAA;AAAA,OACF;AAEA,MAAM,MAAA,UAAA,GAAA,CACJ,aAAQ,QAAR,KAAA,IAAA,GAAA,EAAA,GACA,QAAQ,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA,CAAA;AAEvE,MAAU,SAAA,CAAA,IAAA;AAAA,QACR,IAAI,oBAAA;AAAA,UACF,cAAA;AAAA,UACA,WAAA;AAAA,UACA,OAAQ,CAAA,MAAA;AAAA,UACR,UAAA;AAAA,SACF;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AACD,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEQ,WACN,CAAA,MAAA,EACA,WACA,EAAA,MAAA,EACA,UACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AACD,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,gBAAA,EAAmB,KAAK,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,GACxC;AAAA,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEQ,iBAAiB,UAA6C,EAAA;AACpE,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,MAAA,GAAS,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAA,CAAA,QAAA,CAAA,CAAA;AACvC,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,EAAO,oBAAqB,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAClD,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAP,EAAA;AACA,YAAA,MAAA,CAAO,KAAM,CAAA,CAAA,EAAG,IAAK,CAAA,eAAA,qBAAoC,KAAK,CAAA,CAAA;AAAA,WAChE;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAQ,MAA+B,EAAA;AAC3C,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,6CAA6C,CAAA,CAAA;AAAA,KAC/D;AAEA,IAAI,IAAA,QAAA,CAAA;AAEJ,IAAA,MAAM,iBAAoB,GAAAC,mCAAA,CAAwB,IAAK,CAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AACzE,IAAA,MAAM,eAAkB,GAAA,CAAA,EAAG,iBAAqB,CAAA,CAAA,EAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAA,CAAA,CAAA;AAC5D,IAAI,IAAA;AACF,MAAW,QAAA,GAAA,MAAMC,0BAAM,eAAiB,EAAA;AAAA,QACtC,MAAQ,EAAA,KAAA;AAAA,QACR,GAAGC,mCAAA,CAAwB,IAAK,CAAA,WAAA,CAAY,MAAM,CAAA;AAAA,OACnD,CAAA,CAAA;AAAA,aACM,CAAP,EAAA;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,yCAAA,EAA4C,IAAK,CAAA,MAAA,CAAO,KAAU,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA;AAAA,OACpE,CAAA;AAAA,KACF;AACA,IAAA,MAAM,yBAA0B,MAAMC,mCAAA;AAAA,MACpC,QAAA;AAAA,KACF,CAAA;AACA,IAAM,MAAA,QAAA,GAAW,MAAO,CAAA,IAAA,CAAK,sBAAsB,CAAA,CAAA;AAEnD,IAAA,MAAM,YAAY,QAAS,CAAA,GAAA,CAAI,aAAW,IAAK,CAAA,kBAAA,CAAmB,OAAO,CAAC,CAAA,CAAA;AAC1E,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,SAAU,CAAA,GAAA,CAAI,CAAa,QAAA,MAAA;AAAA,QACnC,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAQ,EAAAC,iDAAA,CAA6B,EAAE,QAAA,EAAU,CAAA;AAAA,OACjD,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AACD,IAAO,MAAA,CAAA,IAAA,CAAK,CAAS,MAAA,EAAA,SAAA,CAAU,MAAmB,CAAA,WAAA,CAAA,CAAA,CAAA;AAAA,GACpD;AAAA,EAEQ,mBAAmB,OAA+B,EAAA;AACxD,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,MAAA,EAAQ,GAAG,IAAK,CAAA,WAAA,CAAY,OAAO,cAAkB,CAAA,CAAA,EAAA,OAAA,CAAA,cAAA,EAAwB,KAAK,MAAO,CAAA,MAAA,CAAA,kBAAA,CAAA;AAAA,MACzF,QAAU,EAAA,UAAA;AAAA,KACZ,CAAA;AAAA,GACF;AACF;;ACzJO,MAAM,oCAAoCC,oCAAoB,CAAA;AAAA,EACnE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,sBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,iDAAA;AAAA,QACT,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,SAAS,MAAQ,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAM,MAAA,aAAA,GAAgBC,oCAAsB,MAAM,CAAA,CAAA;AAClD,QAAM,MAAA,SAAA,GAAY,oBAAqB,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACxD,MAAQ,EAAA,aAAA;AAAA,UACR,SAAA;AAAA,SACD,CAAA,CAAA;AAED,QAAA,OAAA,CAAQ,kBAAkB,SAAS,CAAA,CAAA;AAAA,OACrC;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-gerrit",
-  "version": "0.1.8-next.1",
+  "version": "0.1.8",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -29,23 +29,23 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.18.0-next.0",
-    "@backstage/backend-plugin-api": "^0.2.1-next.0",
-    "@backstage/backend-tasks": "^0.4.1-next.0",
-    "@backstage/catalog-model": "^1.1.5-next.1",
-    "@backstage/config": "^1.0.6-next.0",
+    "@backstage/backend-common": "^0.18.0",
+    "@backstage/backend-plugin-api": "^0.3.0",
+    "@backstage/backend-tasks": "^0.4.1",
+    "@backstage/catalog-model": "^1.1.5",
+    "@backstage/config": "^1.0.6",
     "@backstage/errors": "^1.1.4",
-    "@backstage/integration": "^1.4.2-next.0",
-    "@backstage/plugin-catalog-backend": "^1.7.0-next.1",
-    "@backstage/plugin-catalog-node": "^1.3.1-next.1",
+    "@backstage/integration": "^1.4.2",
+    "@backstage/plugin-catalog-backend": "^1.7.0",
+    "@backstage/plugin-catalog-node": "^1.3.1",
     "fs-extra": "10.1.0",
     "node-fetch": "^2.6.7",
     "uuid": "^8.0.0",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.32-next.1",
-    "@backstage/cli": "^0.22.1-next.1",
+    "@backstage/backend-test-utils": "^0.1.32",
+    "@backstage/cli": "^0.22.1",
     "@types/fs-extra": "^9.0.1",
     "luxon": "^3.0.0",
     "msw": "^0.49.0"