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

package/CHANGELOG.md

@@ -1,5 +1,49 @@
 # @backstage/plugin-catalog-backend-module-gerrit
 
+## 0.3.0
+
+### Minor Changes
+
+- 89db8b8: **BREAKING** The optional `branch` configuration parameter now defaults to the default branch of the project (where `HEAD` points to).
+  This parameter was previously using `master` as the default value. In most cases this change should be transparent as Gerrit defaults to using `master`.
+
+  This change also allow to specify a custom `catalogPath` in the `catalog.providers.gerrit` configuration.
+  If not set, it defaults to `catalog-info.yaml` files at the root of repositories. This default was the value before this change.
+
+  With the changes made in the `GerritUrlReader`, `catalogPath` allows to use `minimatch`'s glob-patterns.
+
+  ```diff
+  catalog:
+    providers:
+      gerrit:
+        all: # identifies your dataset / provider independent of config changes
+          host: gerrit.company.com
+          query: 'state=ACTIVE&type=CODE'
+  +       # This will search for catalog manifests anywhere in the repositories
+  +       catalogPath: '**/catalog-info.{yml,yaml}'
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/integration@1.16.2
+  - @backstage/backend-plugin-api@1.2.1
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/plugin-catalog-common@1.1.3
+  - @backstage/plugin-catalog-node@1.16.1
+
+## 0.2.8-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/integration@1.16.2-next.0
+  - @backstage/backend-plugin-api@1.2.1-next.1
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/plugin-catalog-node@1.16.1-next.1
+
 ## 0.2.8-next.1
 
 ### Patch Changes

package/config.d.ts

@@ -40,9 +40,15 @@ export interface Config {
           query: string;
           /**
            * (Optional) Branch.
-           * The branch where the provider will try to find entities. Defaults to "master".
+           * The branch where the provider will try to find entities. Uses the default branch where HEAD points to.
            */
           branch?: string;
+          /**
+           * (Optional) Path where the catalog YAML manifest file is expected in the repository.
+           * Can contain glob patterns supported by minimatch.
+           * Defaults to "catalog-info.yaml".
+           */
+          catalogPath?: string;
           /**
            * (Optional) TaskScheduleDefinition for the discovery.
            */

package/dist/providers/GerritEntityProvider.cjs.js

@@ -4,8 +4,11 @@ var errors = require('@backstage/errors');
 var pluginCatalogNode = require('@backstage/plugin-catalog-node');
 var integration = require('@backstage/integration');
 var uuid = require('uuid');
+var pLimit = require('p-limit');
 var config = require('./config.cjs.js');
 
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
 function _interopNamespaceCompat(e) {
   if (e && typeof e === 'object' && 'default' in e) return e;
   var n = Object.create(null);
@@ -25,6 +28,7 @@ function _interopNamespaceCompat(e) {
 }
 
 var uuid__namespace = /*#__PURE__*/_interopNamespaceCompat(uuid);
+var pLimit__default = /*#__PURE__*/_interopDefaultCompat(pLimit);
 
 class GerritEntityProvider {
   config;
@@ -122,7 +126,10 @@ class GerritEntityProvider {
       response
     );
     const projects = Object.keys(gerritProjectsResponse);
-    const locations = projects.map((project) => this.createLocationSpec(project));
+    const limit = pLimit__default.default(5);
+    const locations = await Promise.all(
+      projects.map((project) => limit(() => this.createLocationSpec(project)))
+    );
     await this.connection.applyMutation({
       type: "full",
       entities: locations.map((location) => ({
@@ -132,10 +139,36 @@ class GerritEntityProvider {
     });
     logger.info(`Found ${locations.length} locations.`);
   }
-  createLocationSpec(project) {
+  async createLocationSpec(project) {
+    if (this.config.branch) {
+      return {
+        type: "url",
+        target: `${this.integration.config.gitilesBaseUrl}/${project}/+/refs/heads/${this.config.branch}/${this.config.catalogPath}`,
+        presence: "optional"
+      };
+    }
+    let response;
+    const baseProjectApiUrl = integration.getGerritProjectsApiUrl(this.integration.config);
+    const projectGetHeadUrl = `${baseProjectApiUrl}${encodeURIComponent(
+      project
+    )}/HEAD`;
+    try {
+      response = await fetch(projectGetHeadUrl, {
+        method: "GET",
+        ...integration.getGerritRequestOptions(this.integration.config)
+      });
+    } catch (e) {
+      throw new Error(`Failed to get project's HEAD for ${project}, ${e}`);
+    }
+    if (!response.ok) {
+      throw await errors.ResponseError.fromResponse(response);
+    }
+    const projectHeadResponse = await integration.parseGerritJsonResponse(
+      response
+    );
     return {
       type: "url",
-      target: `${this.integration.config.gitilesBaseUrl}/${project}/+/refs/heads/${this.config.branch}/catalog-info.yaml`,
+      target: `${this.integration.config.gitilesBaseUrl}/${project}/+/${projectHeadResponse}/${this.config.catalogPath}`,
       presence: "optional"
     };
   }

package/dist/providers/GerritEntityProvider.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"GerritEntityProvider.cjs.js","sources":["../../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 { 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 {\n  GerritIntegration,\n  getGerritProjectsApiUrl,\n  getGerritRequestOptions,\n  parseGerritJsonResponse,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport * as uuid from 'uuid';\n\nimport { readGerritConfigs } from './config';\nimport { GerritProjectQueryResult, GerritProviderConfig } from './types';\nimport {\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\n\n/** @public */\nexport class GerritEntityProvider implements EntityProvider {\n  private readonly config: GerritProviderConfig;\n  private readonly integration: GerritIntegration;\n  private readonly logger: LoggerService;\n  private readonly scheduleFn: () => Promise<void>;\n  private connection?: EntityProviderConnection;\n\n  static fromConfig(\n    configRoot: Config,\n    options: {\n      logger: LoggerService;\n      schedule?: SchedulerServiceTaskRunner;\n      scheduler?: SchedulerService;\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: LoggerService,\n    taskRunner: SchedulerServiceTaskRunner,\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(\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: 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: LoggerService): 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":["readGerritConfigs","ScmIntegrations","InputError","uuid","getGerritProjectsApiUrl","getGerritRequestOptions","parseGerritJsonResponse","locationSpecToLocationEntity"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CO,MAAM,oBAA+C,CAAA;AAAA,EACzC,MAAA;AAAA,EACA,WAAA;AAAA,EACA,MAAA;AAAA,EACA,UAAA;AAAA,EACT,UAAA;AAAA,EAER,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;AAAA;AAGlE,IAAM,MAAA,eAAA,GAAkBA,yBAAkB,UAAU,CAAA;AACpD,IAAA,MAAM,YAAe,GAAAC,2BAAA,CAAgB,UAAW,CAAA,UAAU,CAAE,CAAA,MAAA;AAC5D,IAAA,MAAM,YAAoC,EAAC;AAE3C,IAAA,eAAA,CAAgB,QAAQ,CAAkB,cAAA,KAAA;AACxC,MAAA,MAAM,WAAc,GAAA,YAAA,CAAa,MAAO,CAAA,cAAA,CAAe,IAAI,CAAA;AAC3D,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,CAAA,8CAAA,EAAiD,eAAe,IAAI,CAAA;AAAA,SACtE;AAAA;AAGF,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;AAAA,SAC3F;AAAA;AAGF,MAAA,MAAM,aACJ,OAAQ,CAAA,QAAA,IACR,QAAQ,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA;AAEvE,MAAU,SAAA,CAAA,IAAA;AAAA,QACR,IAAI,oBAAA;AAAA,UACF,cAAA;AAAA,UACA,WAAA;AAAA,UACA,OAAQ,CAAA,MAAA;AAAA,UACR;AAAA;AACF,OACF;AAAA,KACD,CAAA;AACD,IAAO,OAAA,SAAA;AAAA;AACT,EAEQ,WACN,CAAA,MAAA,EACA,WACA,EAAA,MAAA,EACA,UACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA;AACd,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB;AAAA,KAC9B,CAAA;AACD,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA;AAAA;AACpD,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,gBAAA,EAAmB,IAAK,CAAA,MAAA,CAAO,EAAE,CAAA,CAAA;AAAA;AAC1C,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA;AAAA;AACxB,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,EAAO,oBAAqB,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAClD,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG;AAAA,WACzB,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAO,MAAA,CAAA,KAAA;AAAA,cACL,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,oBAAoB,KAAK,CAAA,CAAA;AAAA,cAClD;AAAA,aACF;AAAA;AACF;AACF,OACD,CAAA;AAAA,KACH;AAAA;AACF,EAEA,MAAM,QAAQ,MAAsC,EAAA;AAClD,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,6CAA6C,CAAA;AAAA;AAG/D,IAAI,IAAA,QAAA;AAEJ,IAAA,MAAM,iBAAoB,GAAAC,mCAAA,CAAwB,IAAK,CAAA,WAAA,CAAY,MAAM,CAAA;AACzE,IAAA,MAAM,kBAAkB,CAAG,EAAA,iBAAiB,CAAI,CAAA,EAAA,IAAA,CAAK,OAAO,KAAK,CAAA,CAAA;AACjE,IAAI,IAAA;AACF,MAAW,QAAA,GAAA,MAAM,MAAM,eAAiB,EAAA;AAAA,QACtC,MAAQ,EAAA,KAAA;AAAA,QACR,GAAGC,mCAAA,CAAwB,IAAK,CAAA,WAAA,CAAY,MAAM;AAAA,OACnD,CAAA;AAAA,aACM,CAAG,EAAA;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAA4C,yCAAA,EAAA,IAAA,CAAK,MAAO,CAAA,KAAK,KAAK,CAAC,CAAA;AAAA,OACrE;AAAA;AAEF,IAAA,MAAM,yBAA0B,MAAMC,mCAAA;AAAA,MACpC;AAAA,KACF;AACA,IAAM,MAAA,QAAA,GAAW,MAAO,CAAA,IAAA,CAAK,sBAAsB,CAAA;AAEnD,IAAA,MAAM,YAAY,QAAS,CAAA,GAAA,CAAI,aAAW,IAAK,CAAA,kBAAA,CAAmB,OAAO,CAAC,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;AAAA,OACjD,CAAA;AAAA,KACH,CAAA;AACD,IAAA,MAAA,CAAO,IAAK,CAAA,CAAA,MAAA,EAAS,SAAU,CAAA,MAAM,CAAa,WAAA,CAAA,CAAA;AAAA;AACpD,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;AAAA,KACZ;AAAA;AAEJ;;;;"}
+{"version":3,"file":"GerritEntityProvider.cjs.js","sources":["../../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 { Config } from '@backstage/config';\nimport { InputError, ResponseError } from '@backstage/errors';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n  locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport {\n  GerritIntegration,\n  getGerritProjectsApiUrl,\n  getGerritRequestOptions,\n  parseGerritJsonResponse,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport * as uuid from 'uuid';\nimport pLimit from 'p-limit';\n\nimport { readGerritConfigs } from './config';\nimport { GerritProjectQueryResult, GerritProviderConfig } from './types';\nimport {\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\n\n/** @public */\nexport class GerritEntityProvider implements EntityProvider {\n  private readonly config: GerritProviderConfig;\n  private readonly integration: GerritIntegration;\n  private readonly logger: LoggerService;\n  private readonly scheduleFn: () => Promise<void>;\n  private connection?: EntityProviderConnection;\n\n  static fromConfig(\n    configRoot: Config,\n    options: {\n      logger: LoggerService;\n      schedule?: SchedulerServiceTaskRunner;\n      scheduler?: SchedulerService;\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: LoggerService,\n    taskRunner: SchedulerServiceTaskRunner,\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(\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: 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: LoggerService): 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,\n    )) as GerritProjectQueryResult;\n    const projects = Object.keys(gerritProjectsResponse);\n\n    const limit = pLimit(5);\n    const locations = await Promise.all(\n      projects.map(project => limit(() => this.createLocationSpec(project))),\n    );\n\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 async createLocationSpec(project: string): Promise<LocationSpec> {\n    // If a branch has been configured, we can use it directly\n    if (this.config.branch) {\n      return {\n        type: 'url',\n        target: `${this.integration.config.gitilesBaseUrl}/${project}/+/refs/heads/${this.config.branch}/${this.config.catalogPath}`,\n        presence: 'optional',\n      };\n    }\n\n    // Else we call Gerrit API to know on which branch HEAD is pointing to\n    let response: Response;\n    const baseProjectApiUrl = getGerritProjectsApiUrl(this.integration.config);\n    const projectGetHeadUrl = `${baseProjectApiUrl}${encodeURIComponent(\n      project,\n    )}/HEAD`;\n\n    try {\n      response = await fetch(projectGetHeadUrl, {\n        method: 'GET',\n        ...getGerritRequestOptions(this.integration.config),\n      });\n    } catch (e) {\n      throw new Error(`Failed to get project's HEAD for ${project}, ${e}`);\n    }\n\n    if (!response.ok) {\n      throw await ResponseError.fromResponse(response);\n    }\n\n    // Gerrit responds with something like `refs/heads/master`\n    const projectHeadResponse = (await parseGerritJsonResponse(\n      response,\n    )) as string;\n\n    return {\n      type: 'url',\n      target: `${this.integration.config.gitilesBaseUrl}/${project}/+/${projectHeadResponse}/${this.config.catalogPath}`,\n      presence: 'optional',\n    };\n  }\n}\n"],"names":["readGerritConfigs","ScmIntegrations","InputError","uuid","getGerritProjectsApiUrl","getGerritRequestOptions","parseGerritJsonResponse","pLimit","locationSpecToLocationEntity","ResponseError"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CO,MAAM,oBAA+C,CAAA;AAAA,EACzC,MAAA;AAAA,EACA,WAAA;AAAA,EACA,MAAA;AAAA,EACA,UAAA;AAAA,EACT,UAAA;AAAA,EAER,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;AAAA;AAGlE,IAAM,MAAA,eAAA,GAAkBA,yBAAkB,UAAU,CAAA;AACpD,IAAA,MAAM,YAAe,GAAAC,2BAAA,CAAgB,UAAW,CAAA,UAAU,CAAE,CAAA,MAAA;AAC5D,IAAA,MAAM,YAAoC,EAAC;AAE3C,IAAA,eAAA,CAAgB,QAAQ,CAAkB,cAAA,KAAA;AACxC,MAAA,MAAM,WAAc,GAAA,YAAA,CAAa,MAAO,CAAA,cAAA,CAAe,IAAI,CAAA;AAC3D,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,CAAA,8CAAA,EAAiD,eAAe,IAAI,CAAA;AAAA,SACtE;AAAA;AAGF,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;AAAA,SAC3F;AAAA;AAGF,MAAA,MAAM,aACJ,OAAQ,CAAA,QAAA,IACR,QAAQ,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA;AAEvE,MAAU,SAAA,CAAA,IAAA;AAAA,QACR,IAAI,oBAAA;AAAA,UACF,cAAA;AAAA,UACA,WAAA;AAAA,UACA,OAAQ,CAAA,MAAA;AAAA,UACR;AAAA;AACF,OACF;AAAA,KACD,CAAA;AACD,IAAO,OAAA,SAAA;AAAA;AACT,EAEQ,WACN,CAAA,MAAA,EACA,WACA,EAAA,MAAA,EACA,UACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA;AACd,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB;AAAA,KAC9B,CAAA;AACD,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA;AAAA;AACpD,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,gBAAA,EAAmB,IAAK,CAAA,MAAA,CAAO,EAAE,CAAA,CAAA;AAAA;AAC1C,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA;AAAA;AACxB,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,EAAO,oBAAqB,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAClD,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG;AAAA,WACzB,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAO,MAAA,CAAA,KAAA;AAAA,cACL,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,oBAAoB,KAAK,CAAA,CAAA;AAAA,cAClD;AAAA,aACF;AAAA;AACF;AACF,OACD,CAAA;AAAA,KACH;AAAA;AACF,EAEA,MAAM,QAAQ,MAAsC,EAAA;AAClD,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,6CAA6C,CAAA;AAAA;AAG/D,IAAI,IAAA,QAAA;AAEJ,IAAA,MAAM,iBAAoB,GAAAC,mCAAA,CAAwB,IAAK,CAAA,WAAA,CAAY,MAAM,CAAA;AACzE,IAAA,MAAM,kBAAkB,CAAG,EAAA,iBAAiB,CAAI,CAAA,EAAA,IAAA,CAAK,OAAO,KAAK,CAAA,CAAA;AACjE,IAAI,IAAA;AACF,MAAW,QAAA,GAAA,MAAM,MAAM,eAAiB,EAAA;AAAA,QACtC,MAAQ,EAAA,KAAA;AAAA,QACR,GAAGC,mCAAA,CAAwB,IAAK,CAAA,WAAA,CAAY,MAAM;AAAA,OACnD,CAAA;AAAA,aACM,CAAG,EAAA;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAA4C,yCAAA,EAAA,IAAA,CAAK,MAAO,CAAA,KAAK,KAAK,CAAC,CAAA;AAAA,OACrE;AAAA;AAEF,IAAA,MAAM,yBAA0B,MAAMC,mCAAA;AAAA,MACpC;AAAA,KACF;AACA,IAAM,MAAA,QAAA,GAAW,MAAO,CAAA,IAAA,CAAK,sBAAsB,CAAA;AAEnD,IAAM,MAAA,KAAA,GAAQC,wBAAO,CAAC,CAAA;AACtB,IAAM,MAAA,SAAA,GAAY,MAAM,OAAQ,CAAA,GAAA;AAAA,MAC9B,QAAA,CAAS,IAAI,CAAW,OAAA,KAAA,KAAA,CAAM,MAAM,IAAK,CAAA,kBAAA,CAAmB,OAAO,CAAC,CAAC;AAAA,KACvE;AAEA,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;AAAA,OACjD,CAAA;AAAA,KACH,CAAA;AACD,IAAA,MAAA,CAAO,IAAK,CAAA,CAAA,MAAA,EAAS,SAAU,CAAA,MAAM,CAAa,WAAA,CAAA,CAAA;AAAA;AACpD,EAEA,MAAc,mBAAmB,OAAwC,EAAA;AAEvE,IAAI,IAAA,IAAA,CAAK,OAAO,MAAQ,EAAA;AACtB,MAAO,OAAA;AAAA,QACL,IAAM,EAAA,KAAA;AAAA,QACN,MAAQ,EAAA,CAAA,EAAG,IAAK,CAAA,WAAA,CAAY,OAAO,cAAc,CAAA,CAAA,EAAI,OAAO,CAAA,cAAA,EAAiB,KAAK,MAAO,CAAA,MAAM,CAAI,CAAA,EAAA,IAAA,CAAK,OAAO,WAAW,CAAA,CAAA;AAAA,QAC1H,QAAU,EAAA;AAAA,OACZ;AAAA;AAIF,IAAI,IAAA,QAAA;AACJ,IAAA,MAAM,iBAAoB,GAAAJ,mCAAA,CAAwB,IAAK,CAAA,WAAA,CAAY,MAAM,CAAA;AACzE,IAAM,MAAA,iBAAA,GAAoB,CAAG,EAAA,iBAAiB,CAAG,EAAA,kBAAA;AAAA,MAC/C;AAAA,KACD,CAAA,KAAA,CAAA;AAED,IAAI,IAAA;AACF,MAAW,QAAA,GAAA,MAAM,MAAM,iBAAmB,EAAA;AAAA,QACxC,MAAQ,EAAA,KAAA;AAAA,QACR,GAAGC,mCAAA,CAAwB,IAAK,CAAA,WAAA,CAAY,MAAM;AAAA,OACnD,CAAA;AAAA,aACM,CAAG,EAAA;AACV,MAAA,MAAM,IAAI,KAAM,CAAA,CAAA,iCAAA,EAAoC,OAAO,CAAA,EAAA,EAAK,CAAC,CAAE,CAAA,CAAA;AAAA;AAGrE,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAMI,oBAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAIjD,IAAA,MAAM,sBAAuB,MAAMH,mCAAA;AAAA,MACjC;AAAA,KACF;AAEA,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,MAAQ,EAAA,CAAA,EAAG,IAAK,CAAA,WAAA,CAAY,MAAO,CAAA,cAAc,CAAI,CAAA,EAAA,OAAO,CAAM,GAAA,EAAA,mBAAmB,CAAI,CAAA,EAAA,IAAA,CAAK,OAAO,WAAW,CAAA,CAAA;AAAA,MAChH,QAAU,EAAA;AAAA,KACZ;AAAA;AAEJ;;;;"}

package/dist/providers/config.cjs.js

@@ -3,7 +3,8 @@
 var backendPluginApi = require('@backstage/backend-plugin-api');
 
 function readGerritConfig(id, config) {
-  const branch = config.getOptionalString("branch") ?? "master";
+  const branch = config.getOptionalString("branch");
+  const catalogPath = config.getOptionalString("catalogPath") ?? "catalog-info.yaml";
   const host = config.getString("host");
   const query = config.getString("query");
   const schedule = config.has("schedule") ? backendPluginApi.readSchedulerServiceTaskScheduleDefinitionFromConfig(
@@ -11,6 +12,7 @@ function readGerritConfig(id, config) {
   ) : void 0;
   return {
     branch,
+    catalogPath,
     host,
     id,
     query,

package/dist/providers/config.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.cjs.js","sources":["../../src/providers/config.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 { readSchedulerServiceTaskScheduleDefinitionFromConfig } from '@backstage/backend-plugin-api';\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    ? readSchedulerServiceTaskScheduleDefinitionFromConfig(\n        config.getConfig('schedule'),\n      )\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"],"names":["readSchedulerServiceTaskScheduleDefinitionFromConfig"],"mappings":";;;;AAoBA,SAAS,gBAAA,CAAiB,IAAY,MAAsC,EAAA;AAC1E,EAAA,MAAM,MAAS,GAAA,MAAA,CAAO,iBAAkB,CAAA,QAAQ,CAAK,IAAA,QAAA;AACrD,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA;AACpC,EAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,SAAA,CAAU,OAAO,CAAA;AAEtC,EAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,UAAU,CAClC,GAAAA,qEAAA;AAAA,IACE,MAAA,CAAO,UAAU,UAAU;AAAA,GAE7B,GAAA,KAAA,CAAA;AAEJ,EAAO,OAAA;AAAA,IACL,MAAA;AAAA,IACA,IAAA;AAAA,IACA,EAAA;AAAA,IACA,KAAA;AAAA,IACA;AAAA,GACF;AACF;AAEO,SAAS,kBAAkB,MAAwC,EAAA;AACxE,EAAA,MAAM,UAAkC,EAAC;AAEzC,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA;AAE3E,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAO,OAAA,OAAA;AAAA;AAGT,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;AAAA;AAGlE,EAAO,OAAA,OAAA;AACT;;;;"}
+{"version":3,"file":"config.cjs.js","sources":["../../src/providers/config.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 { readSchedulerServiceTaskScheduleDefinitionFromConfig } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { GerritProviderConfig } from './types';\n\nfunction readGerritConfig(id: string, config: Config): GerritProviderConfig {\n  const branch = config.getOptionalString('branch');\n  const catalogPath =\n    config.getOptionalString('catalogPath') ?? 'catalog-info.yaml';\n  const host = config.getString('host');\n  const query = config.getString('query');\n\n  const schedule = config.has('schedule')\n    ? readSchedulerServiceTaskScheduleDefinitionFromConfig(\n        config.getConfig('schedule'),\n      )\n    : undefined;\n\n  return {\n    branch,\n    catalogPath,\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"],"names":["readSchedulerServiceTaskScheduleDefinitionFromConfig"],"mappings":";;;;AAoBA,SAAS,gBAAA,CAAiB,IAAY,MAAsC,EAAA;AAC1E,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,iBAAA,CAAkB,QAAQ,CAAA;AAChD,EAAA,MAAM,WACJ,GAAA,MAAA,CAAO,iBAAkB,CAAA,aAAa,CAAK,IAAA,mBAAA;AAC7C,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA;AACpC,EAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,SAAA,CAAU,OAAO,CAAA;AAEtC,EAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,UAAU,CAClC,GAAAA,qEAAA;AAAA,IACE,MAAA,CAAO,UAAU,UAAU;AAAA,GAE7B,GAAA,KAAA,CAAA;AAEJ,EAAO,OAAA;AAAA,IACL,MAAA;AAAA,IACA,WAAA;AAAA,IACA,IAAA;AAAA,IACA,EAAA;AAAA,IACA,KAAA;AAAA,IACA;AAAA,GACF;AACF;AAEO,SAAS,kBAAkB,MAAwC,EAAA;AACxE,EAAA,MAAM,UAAkC,EAAC;AAEzC,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA;AAE3E,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAO,OAAA,OAAA;AAAA;AAGT,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;AAAA;AAGlE,EAAO,OAAA,OAAA;AACT;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-gerrit",
-  "version": "0.2.8-next.1",
+  "version": "0.3.0",
   "backstage": {
     "role": "backend-plugin-module",
     "pluginId": "catalog",
@@ -39,7 +39,7 @@
   "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
-      "index": [
+      "*": [
         "dist/index.d.ts"
       ],
       "alpha": [
@@ -61,17 +61,19 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.2.1-next.1",
-    "@backstage/config": "1.3.2",
-    "@backstage/errors": "1.2.7",
-    "@backstage/integration": "1.16.1",
-    "@backstage/plugin-catalog-node": "1.16.1-next.1",
+    "@backstage/backend-plugin-api": "^1.2.1",
+    "@backstage/config": "^1.3.2",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/integration": "^1.16.2",
+    "@backstage/plugin-catalog-common": "^1.1.3",
+    "@backstage/plugin-catalog-node": "^1.16.1",
     "fs-extra": "^11.2.0",
+    "p-limit": "^3.1.0",
     "uuid": "^11.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.3.1-next.1",
-    "@backstage/cli": "0.30.1-next.0",
+    "@backstage/backend-test-utils": "^1.3.1",
+    "@backstage/cli": "^0.31.0",
     "@types/fs-extra": "^11.0.0",
     "luxon": "^3.0.0",
     "msw": "^1.0.0"