@backstage/plugin-catalog-backend-module-gerrit 0.1.30 → 0.1.32

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @backstage/plugin-catalog-backend-module-gerrit
 
+## 0.1.32
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.10.0
+  - @backstage/backend-common@0.21.5
+  - @backstage/backend-tasks@0.5.20
+  - @backstage/backend-plugin-api@0.6.15
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/integration@1.9.1
+
+## 0.1.31
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.9.0
+
 ## 0.1.30
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-gerrit",
-  "version": "0.1.30",
+  "version": "0.1.32",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var backendCommon = require('@backstage/backend-common');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha = require('@backstage/plugin-catalog-node/alpha');
-var GerritEntityProvider = require('./cjs/GerritEntityProvider-a0e590cc.cjs.js');
+var GerritEntityProvider = require('./cjs/GerritEntityProvider-C2LfDFQ9.cjs.js');
 require('@backstage/errors');
 require('@backstage/plugin-catalog-node');
 require('node-fetch');
@@ -36,5 +36,5 @@ const catalogModuleGerritEntityProvider = backendPluginApi.createBackendModule({
   }
 });
 
-exports["default"] = catalogModuleGerritEntityProvider;
+exports.default = catalogModuleGerritEntityProvider;
 //# sourceMappingURL=alpha.cjs.js.map

package/dist/cjs/{GerritEntityProvider-a0e590cc.cjs.js → GerritEntityProvider-C2LfDFQ9.cjs.js}

@@ -7,10 +7,10 @@ var integration = require('@backstage/integration');
 var uuid = require('uuid');
 var backendTasks = require('@backstage/backend-tasks');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
-function _interopNamespace(e) {
-  if (e && e.__esModule) return e;
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
   var n = Object.create(null);
   if (e) {
     Object.keys(e).forEach(function (k) {
@@ -23,12 +23,12 @@ function _interopNamespace(e) {
       }
     });
   }
-  n["default"] = e;
+  n.default = e;
   return Object.freeze(n);
 }
 
-var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
-var uuid__namespace = /*#__PURE__*/_interopNamespace(uuid);
+var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
+var uuid__namespace = /*#__PURE__*/_interopNamespaceCompat(uuid);
 
 function readGerritConfig(id, config) {
   var _a;
@@ -146,7 +146,7 @@ class GerritEntityProvider {
     const baseProjectApiUrl = integration.getGerritProjectsApiUrl(this.integration.config);
     const projectQueryUrl = `${baseProjectApiUrl}?${this.config.query}`;
     try {
-      response = await fetch__default["default"](projectQueryUrl, {
+      response = await fetch__default.default(projectQueryUrl, {
         method: "GET",
         ...integration.getGerritRequestOptions(this.integration.config)
       });
@@ -179,4 +179,4 @@ class GerritEntityProvider {
 }
 
 exports.GerritEntityProvider = GerritEntityProvider;
-//# sourceMappingURL=GerritEntityProvider-a0e590cc.cjs.js.map
+//# sourceMappingURL=GerritEntityProvider-C2LfDFQ9.cjs.js.map

package/dist/cjs/{GerritEntityProvider-a0e590cc.cjs.js.map → GerritEntityProvider-C2LfDFQ9.cjs.js.map}

@@ -1 +1 @@
-{"version":3,"file":"GerritEntityProvider-a0e590cc.cjs.js","sources":["../../src/providers/config.ts","../../src/providers/GerritEntityProvider.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-node';\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(\n              `${this.getProviderName()} refresh failed, ${error}`,\n              error,\n            );\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"],"names":["readTaskScheduleDefinitionFromConfig","ScmIntegrations","InputError","uuid","getGerritProjectsApiUrl","fetch","getGerritRequestOptions","parseGerritJsonResponse","locationSpecToLocationEntity"],"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,EAqDlD,WACN,CAAA,MAAA,EACA,WACA,EAAA,MAAA,EACA,UACA,EAAA;AAzDF,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AACjB,IAAQ,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AAsDN,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,EA1DA,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,CAAA,8CAAA,EAAiD,eAAe,IAAI,CAAA,CAAA;AAAA,SACtE,CAAA;AAAA,OACF;AAEA,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,qEAAA,EAAwE,eAAe,EAAE,CAAA,CAAA,CAAA;AAAA,SAC3F,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,EAgBA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,gBAAA,EAAmB,IAAK,CAAA,MAAA,CAAO,EAAE,CAAA,CAAA,CAAA;AAAA,GAC1C;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,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA,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,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,KAAO,EAAA;AACd,YAAO,MAAA,CAAA,KAAA;AAAA,cACL,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,oBAAoB,KAAK,CAAA,CAAA;AAAA,cAClD,KAAA;AAAA,aACF,CAAA;AAAA,WACF;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,kBAAkB,CAAG,EAAA,iBAAiB,CAAI,CAAA,EAAA,IAAA,CAAK,OAAO,KAAK,CAAA,CAAA,CAAA;AACjE,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,CAAG,EAAA;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAA4C,yCAAA,EAAA,IAAA,CAAK,MAAO,CAAA,KAAK,KAAK,CAAC,CAAA,CAAA;AAAA,OACrE,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,8CAAA,CAA6B,EAAE,QAAA,EAAU,CAAA;AAAA,OACjD,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AACD,IAAA,MAAA,CAAO,IAAK,CAAA,CAAA,MAAA,EAAS,SAAU,CAAA,MAAM,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,CAAG,EAAA,IAAA,CAAK,WAAY,CAAA,MAAA,CAAO,cAAc,CAAA,CAAA,EAAI,OAAO,CAAA,cAAA,EAAiB,IAAK,CAAA,MAAA,CAAO,MAAM,CAAA,kBAAA,CAAA;AAAA,MAC/F,QAAU,EAAA,UAAA;AAAA,KACZ,CAAA;AAAA,GACF;AACF;;;;"}
+{"version":3,"file":"GerritEntityProvider-C2LfDFQ9.cjs.js","sources":["../../src/providers/config.ts","../../src/providers/GerritEntityProvider.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-node';\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(\n              `${this.getProviderName()} refresh failed, ${error}`,\n              error,\n            );\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"],"names":["readTaskScheduleDefinitionFromConfig","ScmIntegrations","InputError","uuid","getGerritProjectsApiUrl","fetch","getGerritRequestOptions","parseGerritJsonResponse","locationSpecToLocationEntity"],"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,EAqDlD,WACN,CAAA,MAAA,EACA,WACA,EAAA,MAAA,EACA,UACA,EAAA;AAzDF,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AACjB,IAAQ,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AAsDN,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,EA1DA,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,CAAA,8CAAA,EAAiD,eAAe,IAAI,CAAA,CAAA;AAAA,SACtE,CAAA;AAAA,OACF;AAEA,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,qEAAA,EAAwE,eAAe,EAAE,CAAA,CAAA,CAAA;AAAA,SAC3F,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,EAgBA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,gBAAA,EAAmB,IAAK,CAAA,MAAA,CAAO,EAAE,CAAA,CAAA,CAAA;AAAA,GAC1C;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,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA,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,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,KAAO,EAAA;AACd,YAAO,MAAA,CAAA,KAAA;AAAA,cACL,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,oBAAoB,KAAK,CAAA,CAAA;AAAA,cAClD,KAAA;AAAA,aACF,CAAA;AAAA,WACF;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,kBAAkB,CAAG,EAAA,iBAAiB,CAAI,CAAA,EAAA,IAAA,CAAK,OAAO,KAAK,CAAA,CAAA,CAAA;AACjE,IAAI,IAAA;AACF,MAAW,QAAA,GAAA,MAAMC,uBAAM,eAAiB,EAAA;AAAA,QACtC,MAAQ,EAAA,KAAA;AAAA,QACR,GAAGC,mCAAA,CAAwB,IAAK,CAAA,WAAA,CAAY,MAAM,CAAA;AAAA,OACnD,CAAA,CAAA;AAAA,aACM,CAAG,EAAA;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAA4C,yCAAA,EAAA,IAAA,CAAK,MAAO,CAAA,KAAK,KAAK,CAAC,CAAA,CAAA;AAAA,OACrE,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,8CAAA,CAA6B,EAAE,QAAA,EAAU,CAAA;AAAA,OACjD,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AACD,IAAA,MAAA,CAAO,IAAK,CAAA,CAAA,MAAA,EAAS,SAAU,CAAA,MAAM,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,CAAG,EAAA,IAAA,CAAK,WAAY,CAAA,MAAA,CAAO,cAAc,CAAA,CAAA,EAAI,OAAO,CAAA,cAAA,EAAiB,IAAK,CAAA,MAAA,CAAO,MAAM,CAAA,kBAAA,CAAA;AAAA,MAC/F,QAAU,EAAA,UAAA;AAAA,KACZ,CAAA;AAAA,GACF;AACF;;;;"}

package/dist/index.cjs.js

@@ -1,8 +1,6 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var GerritEntityProvider = require('./cjs/GerritEntityProvider-a0e590cc.cjs.js');
+var GerritEntityProvider = require('./cjs/GerritEntityProvider-C2LfDFQ9.cjs.js');
 require('@backstage/errors');
 require('@backstage/plugin-catalog-node');
 require('node-fetch');

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-gerrit",
-  "version": "0.1.30",
+  "version": "0.1.32",
   "backstage": {
     "role": "backend-plugin-module"
   },
@@ -44,21 +44,21 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.21.4",
-    "@backstage/backend-plugin-api": "^0.6.14",
-    "@backstage/backend-tasks": "^0.5.19",
+    "@backstage/backend-common": "^0.21.5",
+    "@backstage/backend-plugin-api": "^0.6.15",
+    "@backstage/backend-tasks": "^0.5.20",
     "@backstage/config": "^1.2.0",
     "@backstage/errors": "^1.2.4",
     "@backstage/integration": "^1.9.1",
-    "@backstage/plugin-catalog-node": "^1.8.0",
+    "@backstage/plugin-catalog-node": "^1.10.0",
     "fs-extra": "^11.2.0",
     "node-fetch": "^2.6.7",
     "uuid": "^9.0.0",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.3.4",
-    "@backstage/cli": "^0.26.0",
+    "@backstage/backend-test-utils": "^0.3.5",
+    "@backstage/cli": "^0.26.1",
     "@types/fs-extra": "^11.0.0",
     "luxon": "^3.0.0",
     "msw": "^1.0.0"