@backstage/plugin-catalog-backend-module-gerrit 0.1.10 → 0.1.11-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @backstage/plugin-catalog-backend-module-gerrit
2
2
 
3
+ ## 0.1.11-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - 928a12a9b3: Internal refactor of `/alpha` exports.
8
+ - Updated dependencies
9
+ - @backstage/plugin-catalog-backend@1.8.0-next.0
10
+ - @backstage/backend-tasks@0.4.4-next.0
11
+ - @backstage/backend-plugin-api@0.4.1-next.0
12
+ - @backstage/backend-common@0.18.3-next.0
13
+ - @backstage/catalog-model@1.2.1-next.0
14
+ - @backstage/plugin-catalog-node@1.3.4-next.0
15
+ - @backstage/config@1.0.6
16
+ - @backstage/errors@1.1.4
17
+ - @backstage/integration@1.4.2
18
+
3
19
  ## 0.1.10
4
20
 
5
21
  ### Patch Changes
@@ -0,0 +1,6 @@
1
+ {
2
+ "name": "@backstage/plugin-catalog-backend-module-gerrit",
3
+ "version": "0.1.11-next.0",
4
+ "main": "../dist/alpha.cjs.js",
5
+ "types": "../dist/alpha.d.ts"
6
+ }
@@ -0,0 +1,196 @@
1
+ 'use strict';
2
+
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+
5
+ var backendCommon = require('@backstage/backend-common');
6
+ var backendPluginApi = require('@backstage/backend-plugin-api');
7
+ var alpha = require('@backstage/plugin-catalog-node/alpha');
8
+ var errors = require('@backstage/errors');
9
+ var pluginCatalogBackend = require('@backstage/plugin-catalog-backend');
10
+ var fetch = require('node-fetch');
11
+ var integration = require('@backstage/integration');
12
+ var uuid = require('uuid');
13
+ var backendTasks = require('@backstage/backend-tasks');
14
+
15
+ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
16
+
17
+ function _interopNamespace(e) {
18
+ if (e && e.__esModule) return e;
19
+ var n = Object.create(null);
20
+ if (e) {
21
+ Object.keys(e).forEach(function (k) {
22
+ if (k !== 'default') {
23
+ var d = Object.getOwnPropertyDescriptor(e, k);
24
+ Object.defineProperty(n, k, d.get ? d : {
25
+ enumerable: true,
26
+ get: function () { return e[k]; }
27
+ });
28
+ }
29
+ });
30
+ }
31
+ n["default"] = e;
32
+ return Object.freeze(n);
33
+ }
34
+
35
+ var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
36
+ var uuid__namespace = /*#__PURE__*/_interopNamespace(uuid);
37
+
38
+ function readGerritConfig(id, config) {
39
+ var _a;
40
+ const branch = (_a = config.getOptionalString("branch")) != null ? _a : "master";
41
+ const host = config.getString("host");
42
+ const query = config.getString("query");
43
+ const schedule = config.has("schedule") ? backendTasks.readTaskScheduleDefinitionFromConfig(config.getConfig("schedule")) : void 0;
44
+ return {
45
+ branch,
46
+ host,
47
+ id,
48
+ query,
49
+ schedule
50
+ };
51
+ }
52
+ function readGerritConfigs(config) {
53
+ const configs = [];
54
+ const providerConfigs = config.getOptionalConfig("catalog.providers.gerrit");
55
+ if (!providerConfigs) {
56
+ return configs;
57
+ }
58
+ for (const id of providerConfigs.keys()) {
59
+ configs.push(readGerritConfig(id, providerConfigs.getConfig(id)));
60
+ }
61
+ return configs;
62
+ }
63
+
64
+ class GerritEntityProvider {
65
+ static fromConfig(configRoot, options) {
66
+ if (!options.schedule && !options.scheduler) {
67
+ throw new Error("Either schedule or scheduler must be provided.");
68
+ }
69
+ const providerConfigs = readGerritConfigs(configRoot);
70
+ const integrations = integration.ScmIntegrations.fromConfig(configRoot).gerrit;
71
+ const providers = [];
72
+ providerConfigs.forEach((providerConfig) => {
73
+ var _a;
74
+ const integration = integrations.byHost(providerConfig.host);
75
+ if (!integration) {
76
+ throw new errors.InputError(
77
+ `No gerrit integration found that matches host ${providerConfig.host}`
78
+ );
79
+ }
80
+ if (!options.schedule && !providerConfig.schedule) {
81
+ throw new Error(
82
+ `No schedule provided neither via code nor config for gerrit-provider:${providerConfig.id}.`
83
+ );
84
+ }
85
+ const taskRunner = (_a = options.schedule) != null ? _a : options.scheduler.createScheduledTaskRunner(providerConfig.schedule);
86
+ providers.push(
87
+ new GerritEntityProvider(
88
+ providerConfig,
89
+ integration,
90
+ options.logger,
91
+ taskRunner
92
+ )
93
+ );
94
+ });
95
+ return providers;
96
+ }
97
+ constructor(config, integration, logger, taskRunner) {
98
+ this.config = config;
99
+ this.integration = integration;
100
+ this.logger = logger.child({
101
+ target: this.getProviderName()
102
+ });
103
+ this.scheduleFn = this.createScheduleFn(taskRunner);
104
+ }
105
+ getProviderName() {
106
+ return `gerrit-provider:${this.config.id}`;
107
+ }
108
+ async connect(connection) {
109
+ this.connection = connection;
110
+ await this.scheduleFn();
111
+ }
112
+ createScheduleFn(taskRunner) {
113
+ return async () => {
114
+ const taskId = `${this.getProviderName()}:refresh`;
115
+ return taskRunner.run({
116
+ id: taskId,
117
+ fn: async () => {
118
+ const logger = this.logger.child({
119
+ class: GerritEntityProvider.prototype.constructor.name,
120
+ taskId,
121
+ taskInstanceId: uuid__namespace.v4()
122
+ });
123
+ try {
124
+ await this.refresh(logger);
125
+ } catch (error) {
126
+ logger.error(`${this.getProviderName()} refresh failed`, error);
127
+ }
128
+ }
129
+ });
130
+ };
131
+ }
132
+ async refresh(logger) {
133
+ if (!this.connection) {
134
+ throw new Error("Gerrit discovery connection not initialized");
135
+ }
136
+ let response;
137
+ const baseProjectApiUrl = integration.getGerritProjectsApiUrl(this.integration.config);
138
+ const projectQueryUrl = `${baseProjectApiUrl}?${this.config.query}`;
139
+ try {
140
+ response = await fetch__default["default"](projectQueryUrl, {
141
+ method: "GET",
142
+ ...integration.getGerritRequestOptions(this.integration.config)
143
+ });
144
+ } catch (e) {
145
+ throw new Error(
146
+ `Failed to list Gerrit projects for query ${this.config.query}, ${e}`
147
+ );
148
+ }
149
+ const gerritProjectsResponse = await integration.parseGerritJsonResponse(
150
+ response
151
+ );
152
+ const projects = Object.keys(gerritProjectsResponse);
153
+ const locations = projects.map((project) => this.createLocationSpec(project));
154
+ await this.connection.applyMutation({
155
+ type: "full",
156
+ entities: locations.map((location) => ({
157
+ locationKey: this.getProviderName(),
158
+ entity: pluginCatalogBackend.locationSpecToLocationEntity({ location })
159
+ }))
160
+ });
161
+ logger.info(`Found ${locations.length} locations.`);
162
+ }
163
+ createLocationSpec(project) {
164
+ return {
165
+ type: "url",
166
+ target: `${this.integration.config.gitilesBaseUrl}/${project}/+/refs/heads/${this.config.branch}/catalog-info.yaml`,
167
+ presence: "optional"
168
+ };
169
+ }
170
+ }
171
+
172
+ const gerritEntityProviderCatalogModule = backendPluginApi.createBackendModule({
173
+ pluginId: "catalog",
174
+ moduleId: "gerritEntityProvider",
175
+ register(env) {
176
+ env.registerInit({
177
+ deps: {
178
+ catalog: alpha.catalogProcessingExtensionPoint,
179
+ config: backendPluginApi.coreServices.config,
180
+ logger: backendPluginApi.coreServices.logger,
181
+ scheduler: backendPluginApi.coreServices.scheduler
182
+ },
183
+ async init({ catalog, config, logger, scheduler }) {
184
+ const winstonLogger = backendCommon.loggerToWinstonLogger(logger);
185
+ const providers = GerritEntityProvider.fromConfig(config, {
186
+ logger: winstonLogger,
187
+ scheduler
188
+ });
189
+ catalog.addEntityProvider(providers);
190
+ }
191
+ });
192
+ }
193
+ });
194
+
195
+ exports.gerritEntityProviderCatalogModule = gerritEntityProviderCatalogModule;
196
+ //# sourceMappingURL=alpha.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"alpha.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/alpha';\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,qCAAA;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;;;;"}
@@ -0,0 +1,8 @@
1
+ import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
2
+
3
+ /**
4
+ * @alpha
5
+ */
6
+ declare const gerritEntityProviderCatalogModule: () => _backstage_backend_plugin_api.BackendFeature;
7
+
8
+ export { gerritEntityProviderCatalogModule };
package/dist/index.cjs.js CHANGED
@@ -8,9 +8,6 @@ var fetch = require('node-fetch');
8
8
  var integration = require('@backstage/integration');
9
9
  var uuid = require('uuid');
10
10
  var backendTasks = require('@backstage/backend-tasks');
11
- var backendCommon = require('@backstage/backend-common');
12
- var backendPluginApi = require('@backstage/backend-plugin-api');
13
- var pluginCatalogNode = require('@backstage/plugin-catalog-node');
14
11
 
15
12
  function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
16
13
 
@@ -169,29 +166,5 @@ class GerritEntityProvider {
169
166
  }
170
167
  }
171
168
 
172
- const gerritEntityProviderCatalogModule = backendPluginApi.createBackendModule({
173
- pluginId: "catalog",
174
- moduleId: "gerritEntityProvider",
175
- register(env) {
176
- env.registerInit({
177
- deps: {
178
- catalog: pluginCatalogNode.catalogProcessingExtensionPoint,
179
- config: backendPluginApi.coreServices.config,
180
- logger: backendPluginApi.coreServices.logger,
181
- scheduler: backendPluginApi.coreServices.scheduler
182
- },
183
- async init({ catalog, config, logger, scheduler }) {
184
- const winstonLogger = backendCommon.loggerToWinstonLogger(logger);
185
- const providers = GerritEntityProvider.fromConfig(config, {
186
- logger: winstonLogger,
187
- scheduler
188
- });
189
- catalog.addEntityProvider(providers);
190
- }
191
- });
192
- }
193
- });
194
-
195
169
  exports.GerritEntityProvider = GerritEntityProvider;
196
- exports.gerritEntityProviderCatalogModule = gerritEntityProviderCatalogModule;
197
170
  //# sourceMappingURL=index.cjs.js.map
@@ -1 +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(`${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;;;;;"}
1
+ {"version":3,"file":"index.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-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"],"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,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;;;;"}
package/dist/index.d.ts CHANGED
@@ -1,13 +1,10 @@
1
- import { BackendFeature } from '@backstage/backend-plugin-api';
1
+ import { TaskRunner, PluginTaskScheduler } from '@backstage/backend-tasks';
2
2
  import { Config } from '@backstage/config';
3
- import { EntityProvider } from '@backstage/plugin-catalog-backend';
4
- import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
3
+ import { EntityProvider, EntityProviderConnection } from '@backstage/plugin-catalog-backend';
5
4
  import { Logger } from 'winston';
6
- import { PluginTaskScheduler } from '@backstage/backend-tasks';
7
- import { TaskRunner } from '@backstage/backend-tasks';
8
5
 
9
6
  /** @public */
10
- export declare class GerritEntityProvider implements EntityProvider {
7
+ declare class GerritEntityProvider implements EntityProvider {
11
8
  private readonly config;
12
9
  private readonly integration;
13
10
  private readonly logger;
@@ -26,6 +23,4 @@ export declare class GerritEntityProvider implements EntityProvider {
26
23
  private createLocationSpec;
27
24
  }
28
25
 
29
- /* Excluded from this release type: gerritEntityProviderCatalogModule */
30
-
31
- export { }
26
+ export { GerritEntityProvider };
package/package.json CHANGED
@@ -1,14 +1,24 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog-backend-module-gerrit",
3
- "version": "0.1.10",
4
- "main": "dist/index.cjs.js",
5
- "types": "dist/index.d.ts",
3
+ "version": "0.1.11-next.0",
4
+ "main": "./dist/index.cjs.js",
5
+ "types": "./dist/index.d.ts",
6
6
  "license": "Apache-2.0",
7
7
  "publishConfig": {
8
- "access": "public",
9
- "alphaTypes": "dist/index.alpha.d.ts",
10
- "main": "dist/index.cjs.js",
11
- "types": "dist/index.d.ts"
8
+ "access": "public"
9
+ },
10
+ "exports": {
11
+ ".": {
12
+ "require": "./dist/index.cjs.js",
13
+ "types": "./dist/index.d.ts",
14
+ "default": "./dist/index.cjs.js"
15
+ },
16
+ "./alpha": {
17
+ "require": "./dist/alpha.cjs.js",
18
+ "types": "./dist/alpha.d.ts",
19
+ "default": "./dist/alpha.cjs.js"
20
+ },
21
+ "./package.json": "./package.json"
12
22
  },
13
23
  "backstage": {
14
24
  "role": "backend-plugin-module"
@@ -21,7 +31,7 @@
21
31
  },
22
32
  "scripts": {
23
33
  "start": "backstage-cli package start",
24
- "build": "backstage-cli package build --experimental-type-build",
34
+ "build": "backstage-cli package build",
25
35
  "lint": "backstage-cli package lint",
26
36
  "test": "backstage-cli package test",
27
37
  "prepack": "backstage-cli package prepack",
@@ -29,30 +39,31 @@
29
39
  "clean": "backstage-cli package clean"
30
40
  },
31
41
  "dependencies": {
32
- "@backstage/backend-common": "^0.18.2",
33
- "@backstage/backend-plugin-api": "^0.4.0",
34
- "@backstage/backend-tasks": "^0.4.3",
35
- "@backstage/catalog-model": "^1.2.0",
42
+ "@backstage/backend-common": "^0.18.3-next.0",
43
+ "@backstage/backend-plugin-api": "^0.4.1-next.0",
44
+ "@backstage/backend-tasks": "^0.4.4-next.0",
45
+ "@backstage/catalog-model": "^1.2.1-next.0",
36
46
  "@backstage/config": "^1.0.6",
37
47
  "@backstage/errors": "^1.1.4",
38
48
  "@backstage/integration": "^1.4.2",
39
- "@backstage/plugin-catalog-backend": "^1.7.2",
40
- "@backstage/plugin-catalog-node": "^1.3.3",
49
+ "@backstage/plugin-catalog-backend": "^1.8.0-next.0",
50
+ "@backstage/plugin-catalog-node": "^1.3.4-next.0",
41
51
  "fs-extra": "10.1.0",
42
52
  "node-fetch": "^2.6.7",
43
53
  "uuid": "^8.0.0",
44
54
  "winston": "^3.2.1"
45
55
  },
46
56
  "devDependencies": {
47
- "@backstage/backend-test-utils": "^0.1.34",
48
- "@backstage/cli": "^0.22.2",
57
+ "@backstage/backend-test-utils": "^0.1.35-next.0",
58
+ "@backstage/cli": "^0.22.4-next.0",
49
59
  "@types/fs-extra": "^9.0.1",
50
60
  "luxon": "^3.0.0",
51
61
  "msw": "^0.49.0"
52
62
  },
53
63
  "files": [
54
64
  "dist",
55
- "config.d.ts"
65
+ "config.d.ts",
66
+ "alpha"
56
67
  ],
57
68
  "configSchema": "config.d.ts"
58
69
  }
@@ -1,34 +0,0 @@
1
- import { BackendFeature } from '@backstage/backend-plugin-api';
2
- import { Config } from '@backstage/config';
3
- import { EntityProvider } from '@backstage/plugin-catalog-backend';
4
- import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
5
- import { Logger } from 'winston';
6
- import { PluginTaskScheduler } from '@backstage/backend-tasks';
7
- import { TaskRunner } from '@backstage/backend-tasks';
8
-
9
- /** @public */
10
- export declare class GerritEntityProvider implements EntityProvider {
11
- private readonly config;
12
- private readonly integration;
13
- private readonly logger;
14
- private readonly scheduleFn;
15
- private connection?;
16
- static fromConfig(configRoot: Config, options: {
17
- logger: Logger;
18
- schedule?: TaskRunner;
19
- scheduler?: PluginTaskScheduler;
20
- }): GerritEntityProvider[];
21
- private constructor();
22
- getProviderName(): string;
23
- connect(connection: EntityProviderConnection): Promise<void>;
24
- private createScheduleFn;
25
- refresh(logger: Logger): Promise<void>;
26
- private createLocationSpec;
27
- }
28
-
29
- /**
30
- * @alpha
31
- */
32
- export declare const gerritEntityProviderCatalogModule: () => BackendFeature;
33
-
34
- export { }
@@ -1,31 +0,0 @@
1
- import { BackendFeature } from '@backstage/backend-plugin-api';
2
- import { Config } from '@backstage/config';
3
- import { EntityProvider } from '@backstage/plugin-catalog-backend';
4
- import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
5
- import { Logger } from 'winston';
6
- import { PluginTaskScheduler } from '@backstage/backend-tasks';
7
- import { TaskRunner } from '@backstage/backend-tasks';
8
-
9
- /** @public */
10
- export declare class GerritEntityProvider implements EntityProvider {
11
- private readonly config;
12
- private readonly integration;
13
- private readonly logger;
14
- private readonly scheduleFn;
15
- private connection?;
16
- static fromConfig(configRoot: Config, options: {
17
- logger: Logger;
18
- schedule?: TaskRunner;
19
- scheduler?: PluginTaskScheduler;
20
- }): GerritEntityProvider[];
21
- private constructor();
22
- getProviderName(): string;
23
- connect(connection: EntityProviderConnection): Promise<void>;
24
- private createScheduleFn;
25
- refresh(logger: Logger): Promise<void>;
26
- private createLocationSpec;
27
- }
28
-
29
- /* Excluded from this release type: gerritEntityProviderCatalogModule */
30
-
31
- export { }