@backstage/plugin-events-backend 0.2.3 → 0.2.4-next.1
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 +21 -0
- package/alpha/package.json +3 -3
- package/dist/alpha.cjs.js +240 -0
- package/dist/alpha.cjs.js.map +1 -0
- package/dist/alpha.d.ts +10 -0
- package/dist/index.cjs.js +12 -106
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +5 -17
- package/package.json +28 -18
- package/dist/index.alpha.d.ts +0 -66
- package/dist/index.beta.d.ts +0 -61
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# @backstage/plugin-events-backend
|
|
2
2
|
|
|
3
|
+
## 0.2.4-next.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/backend-common@0.18.3-next.1
|
|
9
|
+
- @backstage/backend-plugin-api@0.4.1-next.1
|
|
10
|
+
- @backstage/config@1.0.7-next.0
|
|
11
|
+
- @backstage/plugin-events-node@0.2.4-next.1
|
|
12
|
+
|
|
13
|
+
## 0.2.4-next.0
|
|
14
|
+
|
|
15
|
+
### Patch Changes
|
|
16
|
+
|
|
17
|
+
- 928a12a9b3: Internal refactor of `/alpha` exports.
|
|
18
|
+
- Updated dependencies
|
|
19
|
+
- @backstage/backend-plugin-api@0.4.1-next.0
|
|
20
|
+
- @backstage/backend-common@0.18.3-next.0
|
|
21
|
+
- @backstage/plugin-events-node@0.2.4-next.0
|
|
22
|
+
- @backstage/config@1.0.6
|
|
23
|
+
|
|
3
24
|
## 0.2.3
|
|
4
25
|
|
|
5
26
|
### Patch Changes
|
package/alpha/package.json
CHANGED
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
6
|
+
var backendCommon = require('@backstage/backend-common');
|
|
7
|
+
var alpha = require('@backstage/plugin-events-node/alpha');
|
|
8
|
+
var Router = require('express-promise-router');
|
|
9
|
+
var express = require('express');
|
|
10
|
+
|
|
11
|
+
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
12
|
+
|
|
13
|
+
var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
|
|
14
|
+
var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
|
|
15
|
+
|
|
16
|
+
class InMemoryEventBroker {
|
|
17
|
+
constructor(logger) {
|
|
18
|
+
this.logger = logger;
|
|
19
|
+
this.subscribers = {};
|
|
20
|
+
}
|
|
21
|
+
async publish(params) {
|
|
22
|
+
var _a;
|
|
23
|
+
this.logger.debug(
|
|
24
|
+
`Event received: topic=${params.topic}, metadata=${JSON.stringify(
|
|
25
|
+
params.metadata
|
|
26
|
+
)}, payload=${JSON.stringify(params.eventPayload)}`
|
|
27
|
+
);
|
|
28
|
+
const subscribed = (_a = this.subscribers[params.topic]) != null ? _a : [];
|
|
29
|
+
await Promise.all(
|
|
30
|
+
subscribed.map(async (subscriber) => {
|
|
31
|
+
try {
|
|
32
|
+
await subscriber.onEvent(params);
|
|
33
|
+
} catch (error) {
|
|
34
|
+
this.logger.error(
|
|
35
|
+
`Subscriber "${subscriber.constructor.name}" failed to process event`,
|
|
36
|
+
error
|
|
37
|
+
);
|
|
38
|
+
}
|
|
39
|
+
})
|
|
40
|
+
);
|
|
41
|
+
}
|
|
42
|
+
subscribe(...subscribers) {
|
|
43
|
+
subscribers.flat().forEach((subscriber) => {
|
|
44
|
+
subscriber.supportsEventTopics().forEach((topic) => {
|
|
45
|
+
var _a;
|
|
46
|
+
this.subscribers[topic] = (_a = this.subscribers[topic]) != null ? _a : [];
|
|
47
|
+
this.subscribers[topic].push(subscriber);
|
|
48
|
+
});
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
var __accessCheck$1 = (obj, member, msg) => {
|
|
54
|
+
if (!member.has(obj))
|
|
55
|
+
throw TypeError("Cannot " + msg);
|
|
56
|
+
};
|
|
57
|
+
var __privateGet$1 = (obj, member, getter) => {
|
|
58
|
+
__accessCheck$1(obj, member, "read from private field");
|
|
59
|
+
return getter ? getter.call(obj) : member.get(obj);
|
|
60
|
+
};
|
|
61
|
+
var __privateAdd$1 = (obj, member, value) => {
|
|
62
|
+
if (member.has(obj))
|
|
63
|
+
throw TypeError("Cannot add the same private member more than once");
|
|
64
|
+
member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
|
|
65
|
+
};
|
|
66
|
+
var __privateSet$1 = (obj, member, value, setter) => {
|
|
67
|
+
__accessCheck$1(obj, member, "write to private field");
|
|
68
|
+
setter ? setter.call(obj, value) : member.set(obj, value);
|
|
69
|
+
return value;
|
|
70
|
+
};
|
|
71
|
+
var _rejectionDetails;
|
|
72
|
+
class RequestValidationContextImpl {
|
|
73
|
+
constructor() {
|
|
74
|
+
__privateAdd$1(this, _rejectionDetails, void 0);
|
|
75
|
+
}
|
|
76
|
+
reject(details) {
|
|
77
|
+
var _a, _b;
|
|
78
|
+
__privateSet$1(this, _rejectionDetails, {
|
|
79
|
+
status: (_a = details == null ? void 0 : details.status) != null ? _a : 403,
|
|
80
|
+
payload: (_b = details == null ? void 0 : details.payload) != null ? _b : {}
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
wasRejected() {
|
|
84
|
+
return __privateGet$1(this, _rejectionDetails) !== void 0;
|
|
85
|
+
}
|
|
86
|
+
get rejectionDetails() {
|
|
87
|
+
return __privateGet$1(this, _rejectionDetails);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
_rejectionDetails = new WeakMap();
|
|
91
|
+
|
|
92
|
+
class HttpPostIngressEventPublisher {
|
|
93
|
+
constructor(logger, ingresses) {
|
|
94
|
+
this.logger = logger;
|
|
95
|
+
this.ingresses = ingresses;
|
|
96
|
+
}
|
|
97
|
+
static fromConfig(env) {
|
|
98
|
+
var _a, _b;
|
|
99
|
+
const topics = (_a = env.config.getOptionalStringArray("events.http.topics")) != null ? _a : [];
|
|
100
|
+
const ingresses = (_b = env.ingresses) != null ? _b : {};
|
|
101
|
+
topics.forEach((topic) => {
|
|
102
|
+
if (!ingresses[topic]) {
|
|
103
|
+
ingresses[topic] = {};
|
|
104
|
+
}
|
|
105
|
+
});
|
|
106
|
+
return new HttpPostIngressEventPublisher(env.logger, ingresses);
|
|
107
|
+
}
|
|
108
|
+
bind(router) {
|
|
109
|
+
router.use("/http", this.createRouter(this.ingresses));
|
|
110
|
+
}
|
|
111
|
+
async setEventBroker(eventBroker) {
|
|
112
|
+
this.eventBroker = eventBroker;
|
|
113
|
+
}
|
|
114
|
+
createRouter(ingresses) {
|
|
115
|
+
const router = Router__default["default"]();
|
|
116
|
+
router.use(express__default["default"].json());
|
|
117
|
+
Object.keys(ingresses).forEach(
|
|
118
|
+
(topic) => this.addRouteForTopic(router, topic, ingresses[topic].validator)
|
|
119
|
+
);
|
|
120
|
+
router.use(backendCommon.errorHandler());
|
|
121
|
+
return router;
|
|
122
|
+
}
|
|
123
|
+
addRouteForTopic(router, topic, validator) {
|
|
124
|
+
const path = `/${topic}`;
|
|
125
|
+
router.post(path, async (request, response) => {
|
|
126
|
+
const requestDetails = {
|
|
127
|
+
body: request.body,
|
|
128
|
+
headers: request.headers
|
|
129
|
+
};
|
|
130
|
+
const context = new RequestValidationContextImpl();
|
|
131
|
+
await (validator == null ? void 0 : validator(requestDetails, context));
|
|
132
|
+
if (context.wasRejected()) {
|
|
133
|
+
response.status(context.rejectionDetails.status).json(context.rejectionDetails.payload);
|
|
134
|
+
return;
|
|
135
|
+
}
|
|
136
|
+
const eventPayload = request.body;
|
|
137
|
+
await this.eventBroker.publish({
|
|
138
|
+
topic,
|
|
139
|
+
eventPayload,
|
|
140
|
+
metadata: request.headers
|
|
141
|
+
});
|
|
142
|
+
response.status(202).json({ status: "accepted" });
|
|
143
|
+
});
|
|
144
|
+
this.logger.info(`Registered /api/events/http${path} to receive events`);
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
var __accessCheck = (obj, member, msg) => {
|
|
149
|
+
if (!member.has(obj))
|
|
150
|
+
throw TypeError("Cannot " + msg);
|
|
151
|
+
};
|
|
152
|
+
var __privateGet = (obj, member, getter) => {
|
|
153
|
+
__accessCheck(obj, member, "read from private field");
|
|
154
|
+
return getter ? getter.call(obj) : member.get(obj);
|
|
155
|
+
};
|
|
156
|
+
var __privateAdd = (obj, member, value) => {
|
|
157
|
+
if (member.has(obj))
|
|
158
|
+
throw TypeError("Cannot add the same private member more than once");
|
|
159
|
+
member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
|
|
160
|
+
};
|
|
161
|
+
var __privateSet = (obj, member, value, setter) => {
|
|
162
|
+
__accessCheck(obj, member, "write to private field");
|
|
163
|
+
setter ? setter.call(obj, value) : member.set(obj, value);
|
|
164
|
+
return value;
|
|
165
|
+
};
|
|
166
|
+
var _eventBroker, _httpPostIngresses, _publishers, _subscribers;
|
|
167
|
+
class EventsExtensionPointImpl {
|
|
168
|
+
constructor() {
|
|
169
|
+
__privateAdd(this, _eventBroker, void 0);
|
|
170
|
+
__privateAdd(this, _httpPostIngresses, []);
|
|
171
|
+
__privateAdd(this, _publishers, []);
|
|
172
|
+
__privateAdd(this, _subscribers, []);
|
|
173
|
+
}
|
|
174
|
+
setEventBroker(eventBroker) {
|
|
175
|
+
__privateSet(this, _eventBroker, eventBroker);
|
|
176
|
+
}
|
|
177
|
+
addPublishers(...publishers) {
|
|
178
|
+
__privateGet(this, _publishers).push(...publishers.flat());
|
|
179
|
+
}
|
|
180
|
+
addSubscribers(...subscribers) {
|
|
181
|
+
__privateGet(this, _subscribers).push(...subscribers.flat());
|
|
182
|
+
}
|
|
183
|
+
addHttpPostIngress(options) {
|
|
184
|
+
__privateGet(this, _httpPostIngresses).push(options);
|
|
185
|
+
}
|
|
186
|
+
get eventBroker() {
|
|
187
|
+
return __privateGet(this, _eventBroker);
|
|
188
|
+
}
|
|
189
|
+
get publishers() {
|
|
190
|
+
return __privateGet(this, _publishers);
|
|
191
|
+
}
|
|
192
|
+
get subscribers() {
|
|
193
|
+
return __privateGet(this, _subscribers);
|
|
194
|
+
}
|
|
195
|
+
get httpPostIngresses() {
|
|
196
|
+
return __privateGet(this, _httpPostIngresses);
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
_eventBroker = new WeakMap();
|
|
200
|
+
_httpPostIngresses = new WeakMap();
|
|
201
|
+
_publishers = new WeakMap();
|
|
202
|
+
_subscribers = new WeakMap();
|
|
203
|
+
const eventsPlugin = backendPluginApi.createBackendPlugin({
|
|
204
|
+
pluginId: "events",
|
|
205
|
+
register(env) {
|
|
206
|
+
const extensionPoint = new EventsExtensionPointImpl();
|
|
207
|
+
env.registerExtensionPoint(alpha.eventsExtensionPoint, extensionPoint);
|
|
208
|
+
env.registerInit({
|
|
209
|
+
deps: {
|
|
210
|
+
config: backendPluginApi.coreServices.config,
|
|
211
|
+
logger: backendPluginApi.coreServices.logger,
|
|
212
|
+
router: backendPluginApi.coreServices.httpRouter
|
|
213
|
+
},
|
|
214
|
+
async init({ config, logger, router }) {
|
|
215
|
+
var _a;
|
|
216
|
+
const winstonLogger = backendCommon.loggerToWinstonLogger(logger);
|
|
217
|
+
const ingresses = Object.fromEntries(
|
|
218
|
+
extensionPoint.httpPostIngresses.map((ingress) => [
|
|
219
|
+
ingress.topic,
|
|
220
|
+
ingress
|
|
221
|
+
])
|
|
222
|
+
);
|
|
223
|
+
const http = HttpPostIngressEventPublisher.fromConfig({
|
|
224
|
+
config,
|
|
225
|
+
ingresses,
|
|
226
|
+
logger: winstonLogger
|
|
227
|
+
});
|
|
228
|
+
const eventsRouter = Router__default["default"]();
|
|
229
|
+
http.bind(eventsRouter);
|
|
230
|
+
router.use(eventsRouter);
|
|
231
|
+
const eventBroker = (_a = extensionPoint.eventBroker) != null ? _a : new InMemoryEventBroker(winstonLogger);
|
|
232
|
+
eventBroker.subscribe(extensionPoint.subscribers);
|
|
233
|
+
[extensionPoint.publishers, http].flat().forEach((publisher) => publisher.setEventBroker(eventBroker));
|
|
234
|
+
}
|
|
235
|
+
});
|
|
236
|
+
}
|
|
237
|
+
});
|
|
238
|
+
|
|
239
|
+
exports.eventsPlugin = eventsPlugin;
|
|
240
|
+
//# sourceMappingURL=alpha.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"alpha.cjs.js","sources":["../src/service/InMemoryEventBroker.ts","../src/service/http/validation/RequestValidationContextImpl.ts","../src/service/http/HttpPostIngressEventPublisher.ts","../src/service/EventsPlugin.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 {\n EventBroker,\n EventParams,\n EventSubscriber,\n} from '@backstage/plugin-events-node';\nimport { Logger } from 'winston';\n\n/**\n * In-memory event broker which will pass the event to all registered subscribers\n * interested in it.\n * Events will not be persisted in any form.\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class InMemoryEventBroker implements EventBroker {\n constructor(private readonly logger: Logger) {}\n\n private readonly subscribers: {\n [topic: string]: EventSubscriber[];\n } = {};\n\n async publish(params: EventParams): Promise<void> {\n this.logger.debug(\n `Event received: topic=${params.topic}, metadata=${JSON.stringify(\n params.metadata,\n )}, payload=${JSON.stringify(params.eventPayload)}`,\n );\n\n const subscribed = this.subscribers[params.topic] ?? [];\n await Promise.all(\n subscribed.map(async subscriber => {\n try {\n await subscriber.onEvent(params);\n } catch (error) {\n this.logger.error(\n `Subscriber \"${subscriber.constructor.name}\" failed to process event`,\n error,\n );\n }\n }),\n );\n }\n\n subscribe(\n ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n ): void {\n subscribers.flat().forEach(subscriber => {\n subscriber.supportsEventTopics().forEach(topic => {\n this.subscribers[topic] = this.subscribers[topic] ?? [];\n this.subscribers[topic].push(subscriber);\n });\n });\n }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n RequestRejectionDetails,\n RequestValidationContext,\n} from '@backstage/plugin-events-node';\n\nexport class RequestValidationContextImpl implements RequestValidationContext {\n #rejectionDetails: RequestRejectionDetails | undefined;\n\n reject(details?: Partial<RequestRejectionDetails>): void {\n this.#rejectionDetails = {\n status: details?.status ?? 403,\n payload: details?.payload ?? {},\n };\n }\n\n wasRejected(): boolean {\n return this.#rejectionDetails !== undefined;\n }\n\n get rejectionDetails() {\n return this.#rejectionDetails;\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 { errorHandler } from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport {\n EventBroker,\n EventPublisher,\n HttpPostIngressOptions,\n RequestValidator,\n} from '@backstage/plugin-events-node';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { Logger } from 'winston';\nimport { RequestValidationContextImpl } from './validation';\n\n/**\n * Publishes events received from their origin (e.g., webhook events from an SCM system)\n * via HTTP POST endpoint and passes the request body as event payload to the registered subscribers.\n *\n * @public\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class HttpPostIngressEventPublisher implements EventPublisher {\n private eventBroker?: EventBroker;\n\n static fromConfig(env: {\n config: Config;\n ingresses?: { [topic: string]: Omit<HttpPostIngressOptions, 'topic'> };\n logger: Logger;\n }): HttpPostIngressEventPublisher {\n const topics =\n env.config.getOptionalStringArray('events.http.topics') ?? [];\n\n const ingresses = env.ingresses ?? {};\n topics.forEach(topic => {\n // don't overwrite topic settings\n // (e.g., added at the config as well as argument)\n if (!ingresses[topic]) {\n ingresses[topic] = {};\n }\n });\n\n return new HttpPostIngressEventPublisher(env.logger, ingresses);\n }\n\n private constructor(\n private readonly logger: Logger,\n private readonly ingresses: {\n [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n },\n ) {}\n\n bind(router: express.Router): void {\n router.use('/http', this.createRouter(this.ingresses));\n }\n\n async setEventBroker(eventBroker: EventBroker): Promise<void> {\n this.eventBroker = eventBroker;\n }\n\n private createRouter(ingresses: {\n [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n }): express.Router {\n const router = Router();\n router.use(express.json());\n\n Object.keys(ingresses).forEach(topic =>\n this.addRouteForTopic(router, topic, ingresses[topic].validator),\n );\n\n router.use(errorHandler());\n return router;\n }\n\n private addRouteForTopic(\n router: express.Router,\n topic: string,\n validator?: RequestValidator,\n ): void {\n const path = `/${topic}`;\n\n router.post(path, async (request, response) => {\n const requestDetails = {\n body: request.body,\n headers: request.headers,\n };\n const context = new RequestValidationContextImpl();\n await validator?.(requestDetails, context);\n if (context.wasRejected()) {\n response\n .status(context.rejectionDetails!.status)\n .json(context.rejectionDetails!.payload);\n return;\n }\n\n const eventPayload = request.body;\n await this.eventBroker!.publish({\n topic,\n eventPayload,\n metadata: request.headers,\n });\n\n response.status(202).json({ status: 'accepted' });\n });\n\n // TODO(pjungermann): We don't really know the externally defined path prefix here,\n // however it is more useful for users to have it. Is there a better way?\n this.logger.info(`Registered /api/events/http${path} to receive events`);\n }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n createBackendPlugin,\n coreServices,\n} from '@backstage/backend-plugin-api';\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n eventsExtensionPoint,\n EventsExtensionPoint,\n} from '@backstage/plugin-events-node/alpha';\nimport {\n EventBroker,\n EventPublisher,\n EventSubscriber,\n HttpPostIngressOptions,\n} from '@backstage/plugin-events-node';\nimport { InMemoryEventBroker } from './InMemoryEventBroker';\nimport Router from 'express-promise-router';\nimport { HttpPostIngressEventPublisher } from './http';\n\nclass EventsExtensionPointImpl implements EventsExtensionPoint {\n #eventBroker: EventBroker | undefined;\n #httpPostIngresses: HttpPostIngressOptions[] = [];\n #publishers: EventPublisher[] = [];\n #subscribers: EventSubscriber[] = [];\n\n setEventBroker(eventBroker: EventBroker): void {\n this.#eventBroker = eventBroker;\n }\n\n addPublishers(\n ...publishers: Array<EventPublisher | Array<EventPublisher>>\n ): void {\n this.#publishers.push(...publishers.flat());\n }\n\n addSubscribers(\n ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n ): void {\n this.#subscribers.push(...subscribers.flat());\n }\n\n addHttpPostIngress(options: HttpPostIngressOptions) {\n this.#httpPostIngresses.push(options);\n }\n\n get eventBroker() {\n return this.#eventBroker;\n }\n\n get publishers() {\n return this.#publishers;\n }\n\n get subscribers() {\n return this.#subscribers;\n }\n\n get httpPostIngresses() {\n return this.#httpPostIngresses;\n }\n}\n\n/**\n * Events plugin\n *\n * @alpha\n */\nexport const eventsPlugin = createBackendPlugin({\n pluginId: 'events',\n register(env) {\n const extensionPoint = new EventsExtensionPointImpl();\n env.registerExtensionPoint(eventsExtensionPoint, extensionPoint);\n\n env.registerInit({\n deps: {\n config: coreServices.config,\n logger: coreServices.logger,\n router: coreServices.httpRouter,\n },\n async init({ config, logger, router }) {\n const winstonLogger = loggerToWinstonLogger(logger);\n\n const ingresses = Object.fromEntries(\n extensionPoint.httpPostIngresses.map(ingress => [\n ingress.topic,\n ingress as Omit<HttpPostIngressOptions, 'topic'>,\n ]),\n );\n\n const http = HttpPostIngressEventPublisher.fromConfig({\n config,\n ingresses,\n logger: winstonLogger,\n });\n const eventsRouter = Router();\n http.bind(eventsRouter);\n router.use(eventsRouter);\n\n const eventBroker =\n extensionPoint.eventBroker ?? new InMemoryEventBroker(winstonLogger);\n\n eventBroker.subscribe(extensionPoint.subscribers);\n [extensionPoint.publishers, http]\n .flat()\n .forEach(publisher => publisher.setEventBroker(eventBroker));\n },\n });\n },\n});\n"],"names":["__privateAdd","__privateSet","__privateGet","Router","express","errorHandler","createBackendPlugin","eventsExtensionPoint","coreServices","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;;;AA6BO,MAAM,mBAA2C,CAAA;AAAA,EACtD,YAA6B,MAAgB,EAAA;AAAhB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAE7B,IAAA,IAAA,CAAiB,cAEb,EAAC,CAAA;AAAA,GAJyC;AAAA,EAM9C,MAAM,QAAQ,MAAoC,EAAA;AApCpD,IAAA,IAAA,EAAA,CAAA;AAqCI,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,sBAAA,EAAyB,MAAO,CAAA,KAAA,CAAA,WAAA,EAAmB,IAAK,CAAA,SAAA;AAAA,QACtD,MAAO,CAAA,QAAA;AAAA,OACK,CAAA,UAAA,EAAA,IAAA,CAAK,SAAU,CAAA,MAAA,CAAO,YAAY,CAAA,CAAA,CAAA;AAAA,KAClD,CAAA;AAEA,IAAA,MAAM,cAAa,EAAK,GAAA,IAAA,CAAA,WAAA,CAAY,OAAO,KAAK,CAAA,KAA7B,YAAkC,EAAC,CAAA;AACtD,IAAA,MAAM,OAAQ,CAAA,GAAA;AAAA,MACZ,UAAA,CAAW,GAAI,CAAA,OAAM,UAAc,KAAA;AACjC,QAAI,IAAA;AACF,UAAM,MAAA,UAAA,CAAW,QAAQ,MAAM,CAAA,CAAA;AAAA,iBACxB,KAAP,EAAA;AACA,UAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,YACV,CAAA,YAAA,EAAe,WAAW,WAAY,CAAA,IAAA,CAAA,yBAAA,CAAA;AAAA,YACtC,KAAA;AAAA,WACF,CAAA;AAAA,SACF;AAAA,OACD,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,aACK,WACG,EAAA;AACN,IAAY,WAAA,CAAA,IAAA,EAAO,CAAA,OAAA,CAAQ,CAAc,UAAA,KAAA;AACvC,MAAW,UAAA,CAAA,mBAAA,EAAsB,CAAA,OAAA,CAAQ,CAAS,KAAA,KAAA;AA9DxD,QAAA,IAAA,EAAA,CAAA;AA+DQ,QAAK,IAAA,CAAA,WAAA,CAAY,KAAK,CAAI,GAAA,CAAA,EAAA,GAAA,IAAA,CAAK,YAAY,KAAK,CAAA,KAAtB,YAA2B,EAAC,CAAA;AACtD,QAAA,IAAA,CAAK,WAAY,CAAA,KAAK,CAAE,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AAAA,OACxC,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;;;;;;;;;;;;;;;;;;;ACpEA,IAAA,iBAAA,CAAA;AAqBO,MAAM,4BAAiE,CAAA;AAAA,EAAvE,WAAA,GAAA;AACL,IAAAA,cAAA,CAAA,IAAA,EAAA,iBAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAEA,OAAO,OAAkD,EAAA;AAxB3D,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAyBI,IAAAC,cAAA,CAAA,IAAA,EAAK,iBAAoB,EAAA;AAAA,MACvB,MAAA,EAAA,CAAQ,EAAS,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAA,MAAA,KAAT,IAAmB,GAAA,EAAA,GAAA,GAAA;AAAA,MAC3B,OAAS,EAAA,CAAA,EAAA,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,OAAT,KAAA,IAAA,GAAA,EAAA,GAAoB,EAAC;AAAA,KAChC,CAAA,CAAA;AAAA,GACF;AAAA,EAEA,WAAuB,GAAA;AACrB,IAAA,OAAOC,qBAAK,iBAAsB,CAAA,KAAA,KAAA,CAAA,CAAA;AAAA,GACpC;AAAA,EAEA,IAAI,gBAAmB,GAAA;AACrB,IAAA,OAAOA,cAAK,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AAhBE,iBAAA,GAAA,IAAA,OAAA,EAAA;;ACcK,MAAM,6BAAwD,CAAA;AAAA,EAuB3D,WAAA,CACW,QACA,SAGjB,EAAA;AAJiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AAAA,GAGhB;AAAA,EAzBH,OAAO,WAAW,GAIgB,EAAA;AA3CpC,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AA4CI,IAAA,MAAM,UACJ,EAAI,GAAA,GAAA,CAAA,MAAA,CAAO,uBAAuB,oBAAoB,CAAA,KAAtD,YAA2D,EAAC,CAAA;AAE9D,IAAA,MAAM,SAAY,GAAA,CAAA,EAAA,GAAA,GAAA,CAAI,SAAJ,KAAA,IAAA,GAAA,EAAA,GAAiB,EAAC,CAAA;AACpC,IAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAGtB,MAAI,IAAA,CAAC,SAAU,CAAA,KAAK,CAAG,EAAA;AACrB,QAAU,SAAA,CAAA,KAAK,IAAI,EAAC,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,OAAO,IAAI,6BAAA,CAA8B,GAAI,CAAA,MAAA,EAAQ,SAAS,CAAA,CAAA;AAAA,GAChE;AAAA,EASA,KAAK,MAA8B,EAAA;AACjC,IAAA,MAAA,CAAO,IAAI,OAAS,EAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,SAAS,CAAC,CAAA,CAAA;AAAA,GACvD;AAAA,EAEA,MAAM,eAAe,WAAyC,EAAA;AAC5D,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AAAA,GACrB;AAAA,EAEQ,aAAa,SAEF,EAAA;AACjB,IAAA,MAAM,SAASC,0BAAO,EAAA,CAAA;AACtB,IAAO,MAAA,CAAA,GAAA,CAAIC,2BAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,IAAO,MAAA,CAAA,IAAA,CAAK,SAAS,CAAE,CAAA,OAAA;AAAA,MAAQ,CAAA,KAAA,KAC7B,KAAK,gBAAiB,CAAA,MAAA,EAAQ,OAAO,SAAU,CAAA,KAAK,EAAE,SAAS,CAAA;AAAA,KACjE,CAAA;AAEA,IAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEQ,gBAAA,CACN,MACA,EAAA,KAAA,EACA,SACM,EAAA;AACN,IAAA,MAAM,OAAO,CAAI,CAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAEjB,IAAA,MAAA,CAAO,IAAK,CAAA,IAAA,EAAM,OAAO,OAAA,EAAS,QAAa,KAAA;AAC7C,MAAA,MAAM,cAAiB,GAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,SAAS,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA;AACA,MAAM,MAAA,OAAA,GAAU,IAAI,4BAA6B,EAAA,CAAA;AACjD,MAAA,OAAM,uCAAY,cAAgB,EAAA,OAAA,CAAA,CAAA,CAAA;AAClC,MAAI,IAAA,OAAA,CAAQ,aAAe,EAAA;AACzB,QACG,QAAA,CAAA,MAAA,CAAO,QAAQ,gBAAkB,CAAA,MAAM,EACvC,IAAK,CAAA,OAAA,CAAQ,iBAAkB,OAAO,CAAA,CAAA;AACzC,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,MAAM,eAAe,OAAQ,CAAA,IAAA,CAAA;AAC7B,MAAM,MAAA,IAAA,CAAK,YAAa,OAAQ,CAAA;AAAA,QAC9B,KAAA;AAAA,QACA,YAAA;AAAA,QACA,UAAU,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA,CAAA;AAED,MAAA,QAAA,CAAS,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,MAAA,EAAQ,YAAY,CAAA,CAAA;AAAA,KACjD,CAAA,CAAA;AAID,IAAK,IAAA,CAAA,MAAA,CAAO,IAAK,CAAA,CAAA,2BAAA,EAA8B,IAAwB,CAAA,kBAAA,CAAA,CAAA,CAAA;AAAA,GACzE;AACF;;;;;;;;;;;;;;;;;;;;AC3HA,IAAA,YAAA,EAAA,kBAAA,EAAA,WAAA,EAAA,YAAA,CAAA;AAmCA,MAAM,wBAAyD,CAAA;AAAA,EAA/D,WAAA,GAAA;AACE,IAAA,YAAA,CAAA,IAAA,EAAA,YAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,kBAAA,EAA+C,EAAC,CAAA,CAAA;AAChD,IAAA,YAAA,CAAA,IAAA,EAAA,WAAA,EAAgC,EAAC,CAAA,CAAA;AACjC,IAAA,YAAA,CAAA,IAAA,EAAA,YAAA,EAAkC,EAAC,CAAA,CAAA;AAAA,GAAA;AAAA,EAEnC,eAAe,WAAgC,EAAA;AAC7C,IAAA,YAAA,CAAA,IAAA,EAAK,YAAe,EAAA,WAAA,CAAA,CAAA;AAAA,GACtB;AAAA,EAEA,iBACK,UACG,EAAA;AACN,IAAA,YAAA,CAAA,IAAA,EAAK,WAAY,CAAA,CAAA,IAAA,CAAK,GAAG,UAAA,CAAW,MAAM,CAAA,CAAA;AAAA,GAC5C;AAAA,EAEA,kBACK,WACG,EAAA;AACN,IAAA,YAAA,CAAA,IAAA,EAAK,YAAa,CAAA,CAAA,IAAA,CAAK,GAAG,WAAA,CAAY,MAAM,CAAA,CAAA;AAAA,GAC9C;AAAA,EAEA,mBAAmB,OAAiC,EAAA;AAClD,IAAK,YAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAmB,KAAK,OAAO,CAAA,CAAA;AAAA,GACtC;AAAA,EAEA,IAAI,WAAc,GAAA;AAChB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,UAAa,GAAA;AACf,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,WAAc,GAAA;AAChB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,iBAAoB,GAAA;AACtB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AAxCE,YAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,kBAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,WAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,YAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AA4CK,MAAM,eAAeC,oCAAoB,CAAA;AAAA,EAC9C,QAAU,EAAA,QAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,cAAA,GAAiB,IAAI,wBAAyB,EAAA,CAAA;AACpD,IAAI,GAAA,CAAA,sBAAA,CAAuBC,4BAAsB,cAAc,CAAA,CAAA;AAE/D,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,MAAQ,EAAA,MAAA,EAAQ,QAAU,EAAA;AA/F7C,QAAA,IAAA,EAAA,CAAA;AAgGQ,QAAM,MAAA,aAAA,GAAgBC,oCAAsB,MAAM,CAAA,CAAA;AAElD,QAAA,MAAM,YAAY,MAAO,CAAA,WAAA;AAAA,UACvB,cAAA,CAAe,iBAAkB,CAAA,GAAA,CAAI,CAAW,OAAA,KAAA;AAAA,YAC9C,OAAQ,CAAA,KAAA;AAAA,YACR,OAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAEA,QAAM,MAAA,IAAA,GAAO,8BAA8B,UAAW,CAAA;AAAA,UACpD,MAAA;AAAA,UACA,SAAA;AAAA,UACA,MAAQ,EAAA,aAAA;AAAA,SACT,CAAA,CAAA;AACD,QAAA,MAAM,eAAeN,0BAAO,EAAA,CAAA;AAC5B,QAAA,IAAA,CAAK,KAAK,YAAY,CAAA,CAAA;AACtB,QAAA,MAAA,CAAO,IAAI,YAAY,CAAA,CAAA;AAEvB,QAAA,MAAM,eACJ,EAAe,GAAA,cAAA,CAAA,WAAA,KAAf,IAA8B,GAAA,EAAA,GAAA,IAAI,oBAAoB,aAAa,CAAA,CAAA;AAErE,QAAY,WAAA,CAAA,SAAA,CAAU,eAAe,WAAW,CAAA,CAAA;AAChD,QAAC,CAAA,cAAA,CAAe,UAAY,EAAA,IAAI,CAC7B,CAAA,IAAA,EACA,CAAA,OAAA,CAAQ,CAAa,SAAA,KAAA,SAAA,CAAU,cAAe,CAAA,WAAW,CAAC,CAAA,CAAA;AAAA,OAC/D;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
|
package/dist/alpha.d.ts
ADDED
package/dist/index.cjs.js
CHANGED
|
@@ -2,16 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
|
-
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
6
5
|
var backendCommon = require('@backstage/backend-common');
|
|
7
|
-
var pluginEventsNode = require('@backstage/plugin-events-node');
|
|
8
|
-
var Router = require('express-promise-router');
|
|
9
6
|
var express = require('express');
|
|
7
|
+
var Router = require('express-promise-router');
|
|
10
8
|
|
|
11
9
|
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
12
10
|
|
|
13
|
-
var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
|
|
14
11
|
var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
|
|
12
|
+
var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
|
|
15
13
|
|
|
16
14
|
class InMemoryEventBroker {
|
|
17
15
|
constructor(logger) {
|
|
@@ -79,41 +77,41 @@ class EventsBackend {
|
|
|
79
77
|
}
|
|
80
78
|
}
|
|
81
79
|
|
|
82
|
-
var __accessCheck
|
|
80
|
+
var __accessCheck = (obj, member, msg) => {
|
|
83
81
|
if (!member.has(obj))
|
|
84
82
|
throw TypeError("Cannot " + msg);
|
|
85
83
|
};
|
|
86
|
-
var __privateGet
|
|
87
|
-
__accessCheck
|
|
84
|
+
var __privateGet = (obj, member, getter) => {
|
|
85
|
+
__accessCheck(obj, member, "read from private field");
|
|
88
86
|
return getter ? getter.call(obj) : member.get(obj);
|
|
89
87
|
};
|
|
90
|
-
var __privateAdd
|
|
88
|
+
var __privateAdd = (obj, member, value) => {
|
|
91
89
|
if (member.has(obj))
|
|
92
90
|
throw TypeError("Cannot add the same private member more than once");
|
|
93
91
|
member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
|
|
94
92
|
};
|
|
95
|
-
var __privateSet
|
|
96
|
-
__accessCheck
|
|
93
|
+
var __privateSet = (obj, member, value, setter) => {
|
|
94
|
+
__accessCheck(obj, member, "write to private field");
|
|
97
95
|
setter ? setter.call(obj, value) : member.set(obj, value);
|
|
98
96
|
return value;
|
|
99
97
|
};
|
|
100
98
|
var _rejectionDetails;
|
|
101
99
|
class RequestValidationContextImpl {
|
|
102
100
|
constructor() {
|
|
103
|
-
__privateAdd
|
|
101
|
+
__privateAdd(this, _rejectionDetails, void 0);
|
|
104
102
|
}
|
|
105
103
|
reject(details) {
|
|
106
104
|
var _a, _b;
|
|
107
|
-
__privateSet
|
|
105
|
+
__privateSet(this, _rejectionDetails, {
|
|
108
106
|
status: (_a = details == null ? void 0 : details.status) != null ? _a : 403,
|
|
109
107
|
payload: (_b = details == null ? void 0 : details.payload) != null ? _b : {}
|
|
110
108
|
});
|
|
111
109
|
}
|
|
112
110
|
wasRejected() {
|
|
113
|
-
return __privateGet
|
|
111
|
+
return __privateGet(this, _rejectionDetails) !== void 0;
|
|
114
112
|
}
|
|
115
113
|
get rejectionDetails() {
|
|
116
|
-
return __privateGet
|
|
114
|
+
return __privateGet(this, _rejectionDetails);
|
|
117
115
|
}
|
|
118
116
|
}
|
|
119
117
|
_rejectionDetails = new WeakMap();
|
|
@@ -174,98 +172,6 @@ class HttpPostIngressEventPublisher {
|
|
|
174
172
|
}
|
|
175
173
|
}
|
|
176
174
|
|
|
177
|
-
var __accessCheck = (obj, member, msg) => {
|
|
178
|
-
if (!member.has(obj))
|
|
179
|
-
throw TypeError("Cannot " + msg);
|
|
180
|
-
};
|
|
181
|
-
var __privateGet = (obj, member, getter) => {
|
|
182
|
-
__accessCheck(obj, member, "read from private field");
|
|
183
|
-
return getter ? getter.call(obj) : member.get(obj);
|
|
184
|
-
};
|
|
185
|
-
var __privateAdd = (obj, member, value) => {
|
|
186
|
-
if (member.has(obj))
|
|
187
|
-
throw TypeError("Cannot add the same private member more than once");
|
|
188
|
-
member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
|
|
189
|
-
};
|
|
190
|
-
var __privateSet = (obj, member, value, setter) => {
|
|
191
|
-
__accessCheck(obj, member, "write to private field");
|
|
192
|
-
setter ? setter.call(obj, value) : member.set(obj, value);
|
|
193
|
-
return value;
|
|
194
|
-
};
|
|
195
|
-
var _eventBroker, _httpPostIngresses, _publishers, _subscribers;
|
|
196
|
-
class EventsExtensionPointImpl {
|
|
197
|
-
constructor() {
|
|
198
|
-
__privateAdd(this, _eventBroker, void 0);
|
|
199
|
-
__privateAdd(this, _httpPostIngresses, []);
|
|
200
|
-
__privateAdd(this, _publishers, []);
|
|
201
|
-
__privateAdd(this, _subscribers, []);
|
|
202
|
-
}
|
|
203
|
-
setEventBroker(eventBroker) {
|
|
204
|
-
__privateSet(this, _eventBroker, eventBroker);
|
|
205
|
-
}
|
|
206
|
-
addPublishers(...publishers) {
|
|
207
|
-
__privateGet(this, _publishers).push(...publishers.flat());
|
|
208
|
-
}
|
|
209
|
-
addSubscribers(...subscribers) {
|
|
210
|
-
__privateGet(this, _subscribers).push(...subscribers.flat());
|
|
211
|
-
}
|
|
212
|
-
addHttpPostIngress(options) {
|
|
213
|
-
__privateGet(this, _httpPostIngresses).push(options);
|
|
214
|
-
}
|
|
215
|
-
get eventBroker() {
|
|
216
|
-
return __privateGet(this, _eventBroker);
|
|
217
|
-
}
|
|
218
|
-
get publishers() {
|
|
219
|
-
return __privateGet(this, _publishers);
|
|
220
|
-
}
|
|
221
|
-
get subscribers() {
|
|
222
|
-
return __privateGet(this, _subscribers);
|
|
223
|
-
}
|
|
224
|
-
get httpPostIngresses() {
|
|
225
|
-
return __privateGet(this, _httpPostIngresses);
|
|
226
|
-
}
|
|
227
|
-
}
|
|
228
|
-
_eventBroker = new WeakMap();
|
|
229
|
-
_httpPostIngresses = new WeakMap();
|
|
230
|
-
_publishers = new WeakMap();
|
|
231
|
-
_subscribers = new WeakMap();
|
|
232
|
-
const eventsPlugin = backendPluginApi.createBackendPlugin({
|
|
233
|
-
pluginId: "events",
|
|
234
|
-
register(env) {
|
|
235
|
-
const extensionPoint = new EventsExtensionPointImpl();
|
|
236
|
-
env.registerExtensionPoint(pluginEventsNode.eventsExtensionPoint, extensionPoint);
|
|
237
|
-
env.registerInit({
|
|
238
|
-
deps: {
|
|
239
|
-
config: backendPluginApi.coreServices.config,
|
|
240
|
-
logger: backendPluginApi.coreServices.logger,
|
|
241
|
-
router: backendPluginApi.coreServices.httpRouter
|
|
242
|
-
},
|
|
243
|
-
async init({ config, logger, router }) {
|
|
244
|
-
var _a;
|
|
245
|
-
const winstonLogger = backendCommon.loggerToWinstonLogger(logger);
|
|
246
|
-
const ingresses = Object.fromEntries(
|
|
247
|
-
extensionPoint.httpPostIngresses.map((ingress) => [
|
|
248
|
-
ingress.topic,
|
|
249
|
-
ingress
|
|
250
|
-
])
|
|
251
|
-
);
|
|
252
|
-
const http = HttpPostIngressEventPublisher.fromConfig({
|
|
253
|
-
config,
|
|
254
|
-
ingresses,
|
|
255
|
-
logger: winstonLogger
|
|
256
|
-
});
|
|
257
|
-
const eventsRouter = Router__default["default"]();
|
|
258
|
-
http.bind(eventsRouter);
|
|
259
|
-
router.use(eventsRouter);
|
|
260
|
-
const eventBroker = (_a = extensionPoint.eventBroker) != null ? _a : new InMemoryEventBroker(winstonLogger);
|
|
261
|
-
eventBroker.subscribe(extensionPoint.subscribers);
|
|
262
|
-
[extensionPoint.publishers, http].flat().forEach((publisher) => publisher.setEventBroker(eventBroker));
|
|
263
|
-
}
|
|
264
|
-
});
|
|
265
|
-
}
|
|
266
|
-
});
|
|
267
|
-
|
|
268
175
|
exports.EventsBackend = EventsBackend;
|
|
269
176
|
exports.HttpPostIngressEventPublisher = HttpPostIngressEventPublisher;
|
|
270
|
-
exports.eventsPlugin = eventsPlugin;
|
|
271
177
|
//# sourceMappingURL=index.cjs.js.map
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/service/InMemoryEventBroker.ts","../src/service/EventsBackend.ts","../src/service/http/validation/RequestValidationContextImpl.ts","../src/service/http/HttpPostIngressEventPublisher.ts","../src/service/EventsPlugin.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 {\n EventBroker,\n EventParams,\n EventSubscriber,\n} from '@backstage/plugin-events-node';\nimport { Logger } from 'winston';\n\n/**\n * In-memory event broker which will pass the event to all registered subscribers\n * interested in it.\n * Events will not be persisted in any form.\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class InMemoryEventBroker implements EventBroker {\n constructor(private readonly logger: Logger) {}\n\n private readonly subscribers: {\n [topic: string]: EventSubscriber[];\n } = {};\n\n async publish(params: EventParams): Promise<void> {\n this.logger.debug(\n `Event received: topic=${params.topic}, metadata=${JSON.stringify(\n params.metadata,\n )}, payload=${JSON.stringify(params.eventPayload)}`,\n );\n\n const subscribed = this.subscribers[params.topic] ?? [];\n await Promise.all(\n subscribed.map(async subscriber => {\n try {\n await subscriber.onEvent(params);\n } catch (error) {\n this.logger.error(\n `Subscriber \"${subscriber.constructor.name}\" failed to process event`,\n error,\n );\n }\n }),\n );\n }\n\n subscribe(\n ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n ): void {\n subscribers.flat().forEach(subscriber => {\n subscriber.supportsEventTopics().forEach(topic => {\n this.subscribers[topic] = this.subscribers[topic] ?? [];\n this.subscribers[topic].push(subscriber);\n });\n });\n }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n EventBroker,\n EventPublisher,\n EventSubscriber,\n} from '@backstage/plugin-events-node';\nimport { Logger } from 'winston';\nimport { InMemoryEventBroker } from './InMemoryEventBroker';\n\n/**\n * A builder that helps wire up all component parts of the event management.\n *\n * @public\n */\nexport class EventsBackend {\n private eventBroker: EventBroker;\n private publishers: EventPublisher[] = [];\n private subscribers: EventSubscriber[] = [];\n\n constructor(logger: Logger) {\n this.eventBroker = new InMemoryEventBroker(logger);\n }\n\n setEventBroker(eventBroker: EventBroker): EventsBackend {\n this.eventBroker = eventBroker;\n return this;\n }\n\n addPublishers(\n ...publishers: Array<EventPublisher | Array<EventPublisher>>\n ): EventsBackend {\n this.publishers.push(...publishers.flat());\n return this;\n }\n\n addSubscribers(\n ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n ): EventsBackend {\n this.subscribers.push(...subscribers.flat());\n return this;\n }\n\n /**\n * Wires up and returns all component parts of the event management.\n */\n async start(): Promise<void> {\n this.eventBroker.subscribe(this.subscribers);\n this.publishers.forEach(publisher =>\n publisher.setEventBroker(this.eventBroker),\n );\n }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n RequestRejectionDetails,\n RequestValidationContext,\n} from '@backstage/plugin-events-node';\n\nexport class RequestValidationContextImpl implements RequestValidationContext {\n #rejectionDetails: RequestRejectionDetails | undefined;\n\n reject(details?: Partial<RequestRejectionDetails>): void {\n this.#rejectionDetails = {\n status: details?.status ?? 403,\n payload: details?.payload ?? {},\n };\n }\n\n wasRejected(): boolean {\n return this.#rejectionDetails !== undefined;\n }\n\n get rejectionDetails() {\n return this.#rejectionDetails;\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 { errorHandler } from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport {\n EventBroker,\n EventPublisher,\n HttpPostIngressOptions,\n RequestValidator,\n} from '@backstage/plugin-events-node';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { Logger } from 'winston';\nimport { RequestValidationContextImpl } from './validation';\n\n/**\n * Publishes events received from their origin (e.g., webhook events from an SCM system)\n * via HTTP POST endpoint and passes the request body as event payload to the registered subscribers.\n *\n * @public\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class HttpPostIngressEventPublisher implements EventPublisher {\n private eventBroker?: EventBroker;\n\n static fromConfig(env: {\n config: Config;\n ingresses?: { [topic: string]: Omit<HttpPostIngressOptions, 'topic'> };\n logger: Logger;\n }): HttpPostIngressEventPublisher {\n const topics =\n env.config.getOptionalStringArray('events.http.topics') ?? [];\n\n const ingresses = env.ingresses ?? {};\n topics.forEach(topic => {\n // don't overwrite topic settings\n // (e.g., added at the config as well as argument)\n if (!ingresses[topic]) {\n ingresses[topic] = {};\n }\n });\n\n return new HttpPostIngressEventPublisher(env.logger, ingresses);\n }\n\n private constructor(\n private readonly logger: Logger,\n private readonly ingresses: {\n [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n },\n ) {}\n\n bind(router: express.Router): void {\n router.use('/http', this.createRouter(this.ingresses));\n }\n\n async setEventBroker(eventBroker: EventBroker): Promise<void> {\n this.eventBroker = eventBroker;\n }\n\n private createRouter(ingresses: {\n [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n }): express.Router {\n const router = Router();\n router.use(express.json());\n\n Object.keys(ingresses).forEach(topic =>\n this.addRouteForTopic(router, topic, ingresses[topic].validator),\n );\n\n router.use(errorHandler());\n return router;\n }\n\n private addRouteForTopic(\n router: express.Router,\n topic: string,\n validator?: RequestValidator,\n ): void {\n const path = `/${topic}`;\n\n router.post(path, async (request, response) => {\n const requestDetails = {\n body: request.body,\n headers: request.headers,\n };\n const context = new RequestValidationContextImpl();\n await validator?.(requestDetails, context);\n if (context.wasRejected()) {\n response\n .status(context.rejectionDetails!.status)\n .json(context.rejectionDetails!.payload);\n return;\n }\n\n const eventPayload = request.body;\n await this.eventBroker!.publish({\n topic,\n eventPayload,\n metadata: request.headers,\n });\n\n response.status(202).json({ status: 'accepted' });\n });\n\n // TODO(pjungermann): We don't really know the externally defined path prefix here,\n // however it is more useful for users to have it. Is there a better way?\n this.logger.info(`Registered /api/events/http${path} to receive events`);\n }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n createBackendPlugin,\n coreServices,\n} from '@backstage/backend-plugin-api';\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n EventBroker,\n EventPublisher,\n EventSubscriber,\n eventsExtensionPoint,\n EventsExtensionPoint,\n HttpPostIngressOptions,\n} from '@backstage/plugin-events-node';\nimport { InMemoryEventBroker } from './InMemoryEventBroker';\nimport Router from 'express-promise-router';\nimport { HttpPostIngressEventPublisher } from './http';\n\nclass EventsExtensionPointImpl implements EventsExtensionPoint {\n #eventBroker: EventBroker | undefined;\n #httpPostIngresses: HttpPostIngressOptions[] = [];\n #publishers: EventPublisher[] = [];\n #subscribers: EventSubscriber[] = [];\n\n setEventBroker(eventBroker: EventBroker): void {\n this.#eventBroker = eventBroker;\n }\n\n addPublishers(\n ...publishers: Array<EventPublisher | Array<EventPublisher>>\n ): void {\n this.#publishers.push(...publishers.flat());\n }\n\n addSubscribers(\n ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n ): void {\n this.#subscribers.push(...subscribers.flat());\n }\n\n addHttpPostIngress(options: HttpPostIngressOptions) {\n this.#httpPostIngresses.push(options);\n }\n\n get eventBroker() {\n return this.#eventBroker;\n }\n\n get publishers() {\n return this.#publishers;\n }\n\n get subscribers() {\n return this.#subscribers;\n }\n\n get httpPostIngresses() {\n return this.#httpPostIngresses;\n }\n}\n\n/**\n * Events plugin\n *\n * @alpha\n */\nexport const eventsPlugin = createBackendPlugin({\n pluginId: 'events',\n register(env) {\n const extensionPoint = new EventsExtensionPointImpl();\n env.registerExtensionPoint(eventsExtensionPoint, extensionPoint);\n\n env.registerInit({\n deps: {\n config: coreServices.config,\n logger: coreServices.logger,\n router: coreServices.httpRouter,\n },\n async init({ config, logger, router }) {\n const winstonLogger = loggerToWinstonLogger(logger);\n\n const ingresses = Object.fromEntries(\n extensionPoint.httpPostIngresses.map(ingress => [\n ingress.topic,\n ingress as Omit<HttpPostIngressOptions, 'topic'>,\n ]),\n );\n\n const http = HttpPostIngressEventPublisher.fromConfig({\n config,\n ingresses,\n logger: winstonLogger,\n });\n const eventsRouter = Router();\n http.bind(eventsRouter);\n router.use(eventsRouter);\n\n const eventBroker =\n extensionPoint.eventBroker ?? new InMemoryEventBroker(winstonLogger);\n\n eventBroker.subscribe(extensionPoint.subscribers);\n [extensionPoint.publishers, http]\n .flat()\n .forEach(publisher => publisher.setEventBroker(eventBroker));\n },\n });\n },\n});\n"],"names":["__privateAdd","__privateSet","__privateGet","Router","express","errorHandler","createBackendPlugin","eventsExtensionPoint","coreServices","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;;;AA6BO,MAAM,mBAA2C,CAAA;AAAA,EACtD,YAA6B,MAAgB,EAAA;AAAhB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAE7B,IAAA,IAAA,CAAiB,cAEb,EAAC,CAAA;AAAA,GAJyC;AAAA,EAM9C,MAAM,QAAQ,MAAoC,EAAA;AApCpD,IAAA,IAAA,EAAA,CAAA;AAqCI,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,sBAAA,EAAyB,MAAO,CAAA,KAAA,CAAA,WAAA,EAAmB,IAAK,CAAA,SAAA;AAAA,QACtD,MAAO,CAAA,QAAA;AAAA,OACK,CAAA,UAAA,EAAA,IAAA,CAAK,SAAU,CAAA,MAAA,CAAO,YAAY,CAAA,CAAA,CAAA;AAAA,KAClD,CAAA;AAEA,IAAA,MAAM,cAAa,EAAK,GAAA,IAAA,CAAA,WAAA,CAAY,OAAO,KAAK,CAAA,KAA7B,YAAkC,EAAC,CAAA;AACtD,IAAA,MAAM,OAAQ,CAAA,GAAA;AAAA,MACZ,UAAA,CAAW,GAAI,CAAA,OAAM,UAAc,KAAA;AACjC,QAAI,IAAA;AACF,UAAM,MAAA,UAAA,CAAW,QAAQ,MAAM,CAAA,CAAA;AAAA,iBACxB,KAAP,EAAA;AACA,UAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,YACV,CAAA,YAAA,EAAe,WAAW,WAAY,CAAA,IAAA,CAAA,yBAAA,CAAA;AAAA,YACtC,KAAA;AAAA,WACF,CAAA;AAAA,SACF;AAAA,OACD,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,aACK,WACG,EAAA;AACN,IAAY,WAAA,CAAA,IAAA,EAAO,CAAA,OAAA,CAAQ,CAAc,UAAA,KAAA;AACvC,MAAW,UAAA,CAAA,mBAAA,EAAsB,CAAA,OAAA,CAAQ,CAAS,KAAA,KAAA;AA9DxD,QAAA,IAAA,EAAA,CAAA;AA+DQ,QAAK,IAAA,CAAA,WAAA,CAAY,KAAK,CAAI,GAAA,CAAA,EAAA,GAAA,IAAA,CAAK,YAAY,KAAK,CAAA,KAAtB,YAA2B,EAAC,CAAA;AACtD,QAAA,IAAA,CAAK,WAAY,CAAA,KAAK,CAAE,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AAAA,OACxC,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;ACvCO,MAAM,aAAc,CAAA;AAAA,EAKzB,YAAY,MAAgB,EAAA;AAH5B,IAAA,IAAA,CAAQ,aAA+B,EAAC,CAAA;AACxC,IAAA,IAAA,CAAQ,cAAiC,EAAC,CAAA;AAGxC,IAAK,IAAA,CAAA,WAAA,GAAc,IAAI,mBAAA,CAAoB,MAAM,CAAA,CAAA;AAAA,GACnD;AAAA,EAEA,eAAe,WAAyC,EAAA;AACtD,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AACnB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,iBACK,UACY,EAAA;AACf,IAAA,IAAA,CAAK,UAAW,CAAA,IAAA,CAAK,GAAG,UAAA,CAAW,MAAM,CAAA,CAAA;AACzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,kBACK,WACY,EAAA;AACf,IAAA,IAAA,CAAK,WAAY,CAAA,IAAA,CAAK,GAAG,WAAA,CAAY,MAAM,CAAA,CAAA;AAC3C,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAuB,GAAA;AAC3B,IAAK,IAAA,CAAA,WAAA,CAAY,SAAU,CAAA,IAAA,CAAK,WAAW,CAAA,CAAA;AAC3C,IAAA,IAAA,CAAK,UAAW,CAAA,OAAA;AAAA,MAAQ,CACtB,SAAA,KAAA,SAAA,CAAU,cAAe,CAAA,IAAA,CAAK,WAAW,CAAA;AAAA,KAC3C,CAAA;AAAA,GACF;AACF;;;;;;;;;;;;;;;;;;;;AClEA,IAAA,iBAAA,CAAA;AAqBO,MAAM,4BAAiE,CAAA;AAAA,EAAvE,WAAA,GAAA;AACL,IAAAA,cAAA,CAAA,IAAA,EAAA,iBAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAEA,OAAO,OAAkD,EAAA;AAxB3D,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAyBI,IAAAC,cAAA,CAAA,IAAA,EAAK,iBAAoB,EAAA;AAAA,MACvB,MAAA,EAAA,CAAQ,EAAS,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAA,MAAA,KAAT,IAAmB,GAAA,EAAA,GAAA,GAAA;AAAA,MAC3B,OAAS,EAAA,CAAA,EAAA,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,OAAT,KAAA,IAAA,GAAA,EAAA,GAAoB,EAAC;AAAA,KAChC,CAAA,CAAA;AAAA,GACF;AAAA,EAEA,WAAuB,GAAA;AACrB,IAAA,OAAOC,qBAAK,iBAAsB,CAAA,KAAA,KAAA,CAAA,CAAA;AAAA,GACpC;AAAA,EAEA,IAAI,gBAAmB,GAAA;AACrB,IAAA,OAAOA,cAAK,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AAhBE,iBAAA,GAAA,IAAA,OAAA,EAAA;;ACcK,MAAM,6BAAwD,CAAA;AAAA,EAuB3D,WAAA,CACW,QACA,SAGjB,EAAA;AAJiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AAAA,GAGhB;AAAA,EAzBH,OAAO,WAAW,GAIgB,EAAA;AA3CpC,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AA4CI,IAAA,MAAM,UACJ,EAAI,GAAA,GAAA,CAAA,MAAA,CAAO,uBAAuB,oBAAoB,CAAA,KAAtD,YAA2D,EAAC,CAAA;AAE9D,IAAA,MAAM,SAAY,GAAA,CAAA,EAAA,GAAA,GAAA,CAAI,SAAJ,KAAA,IAAA,GAAA,EAAA,GAAiB,EAAC,CAAA;AACpC,IAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAGtB,MAAI,IAAA,CAAC,SAAU,CAAA,KAAK,CAAG,EAAA;AACrB,QAAU,SAAA,CAAA,KAAK,IAAI,EAAC,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,OAAO,IAAI,6BAAA,CAA8B,GAAI,CAAA,MAAA,EAAQ,SAAS,CAAA,CAAA;AAAA,GAChE;AAAA,EASA,KAAK,MAA8B,EAAA;AACjC,IAAA,MAAA,CAAO,IAAI,OAAS,EAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,SAAS,CAAC,CAAA,CAAA;AAAA,GACvD;AAAA,EAEA,MAAM,eAAe,WAAyC,EAAA;AAC5D,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AAAA,GACrB;AAAA,EAEQ,aAAa,SAEF,EAAA;AACjB,IAAA,MAAM,SAASC,0BAAO,EAAA,CAAA;AACtB,IAAO,MAAA,CAAA,GAAA,CAAIC,2BAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,IAAO,MAAA,CAAA,IAAA,CAAK,SAAS,CAAE,CAAA,OAAA;AAAA,MAAQ,CAAA,KAAA,KAC7B,KAAK,gBAAiB,CAAA,MAAA,EAAQ,OAAO,SAAU,CAAA,KAAK,EAAE,SAAS,CAAA;AAAA,KACjE,CAAA;AAEA,IAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEQ,gBAAA,CACN,MACA,EAAA,KAAA,EACA,SACM,EAAA;AACN,IAAA,MAAM,OAAO,CAAI,CAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAEjB,IAAA,MAAA,CAAO,IAAK,CAAA,IAAA,EAAM,OAAO,OAAA,EAAS,QAAa,KAAA;AAC7C,MAAA,MAAM,cAAiB,GAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,SAAS,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA;AACA,MAAM,MAAA,OAAA,GAAU,IAAI,4BAA6B,EAAA,CAAA;AACjD,MAAA,OAAM,uCAAY,cAAgB,EAAA,OAAA,CAAA,CAAA,CAAA;AAClC,MAAI,IAAA,OAAA,CAAQ,aAAe,EAAA;AACzB,QACG,QAAA,CAAA,MAAA,CAAO,QAAQ,gBAAkB,CAAA,MAAM,EACvC,IAAK,CAAA,OAAA,CAAQ,iBAAkB,OAAO,CAAA,CAAA;AACzC,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,MAAM,eAAe,OAAQ,CAAA,IAAA,CAAA;AAC7B,MAAM,MAAA,IAAA,CAAK,YAAa,OAAQ,CAAA;AAAA,QAC9B,KAAA;AAAA,QACA,YAAA;AAAA,QACA,UAAU,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA,CAAA;AAED,MAAA,QAAA,CAAS,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,MAAA,EAAQ,YAAY,CAAA,CAAA;AAAA,KACjD,CAAA,CAAA;AAID,IAAK,IAAA,CAAA,MAAA,CAAO,IAAK,CAAA,CAAA,2BAAA,EAA8B,IAAwB,CAAA,kBAAA,CAAA,CAAA,CAAA;AAAA,GACzE;AACF;;;;;;;;;;;;;;;;;;;;AC3HA,IAAA,YAAA,EAAA,kBAAA,EAAA,WAAA,EAAA,YAAA,CAAA;AAiCA,MAAM,wBAAyD,CAAA;AAAA,EAA/D,WAAA,GAAA;AACE,IAAA,YAAA,CAAA,IAAA,EAAA,YAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,kBAAA,EAA+C,EAAC,CAAA,CAAA;AAChD,IAAA,YAAA,CAAA,IAAA,EAAA,WAAA,EAAgC,EAAC,CAAA,CAAA;AACjC,IAAA,YAAA,CAAA,IAAA,EAAA,YAAA,EAAkC,EAAC,CAAA,CAAA;AAAA,GAAA;AAAA,EAEnC,eAAe,WAAgC,EAAA;AAC7C,IAAA,YAAA,CAAA,IAAA,EAAK,YAAe,EAAA,WAAA,CAAA,CAAA;AAAA,GACtB;AAAA,EAEA,iBACK,UACG,EAAA;AACN,IAAA,YAAA,CAAA,IAAA,EAAK,WAAY,CAAA,CAAA,IAAA,CAAK,GAAG,UAAA,CAAW,MAAM,CAAA,CAAA;AAAA,GAC5C;AAAA,EAEA,kBACK,WACG,EAAA;AACN,IAAA,YAAA,CAAA,IAAA,EAAK,YAAa,CAAA,CAAA,IAAA,CAAK,GAAG,WAAA,CAAY,MAAM,CAAA,CAAA;AAAA,GAC9C;AAAA,EAEA,mBAAmB,OAAiC,EAAA;AAClD,IAAK,YAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAmB,KAAK,OAAO,CAAA,CAAA;AAAA,GACtC;AAAA,EAEA,IAAI,WAAc,GAAA;AAChB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,UAAa,GAAA;AACf,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,WAAc,GAAA;AAChB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,iBAAoB,GAAA;AACtB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AAxCE,YAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,kBAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,WAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,YAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AA4CK,MAAM,eAAeC,oCAAoB,CAAA;AAAA,EAC9C,QAAU,EAAA,QAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,cAAA,GAAiB,IAAI,wBAAyB,EAAA,CAAA;AACpD,IAAI,GAAA,CAAA,sBAAA,CAAuBC,uCAAsB,cAAc,CAAA,CAAA;AAE/D,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,MAAQ,EAAA,MAAA,EAAQ,QAAU,EAAA;AA7F7C,QAAA,IAAA,EAAA,CAAA;AA8FQ,QAAM,MAAA,aAAA,GAAgBC,oCAAsB,MAAM,CAAA,CAAA;AAElD,QAAA,MAAM,YAAY,MAAO,CAAA,WAAA;AAAA,UACvB,cAAA,CAAe,iBAAkB,CAAA,GAAA,CAAI,CAAW,OAAA,KAAA;AAAA,YAC9C,OAAQ,CAAA,KAAA;AAAA,YACR,OAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAEA,QAAM,MAAA,IAAA,GAAO,8BAA8B,UAAW,CAAA;AAAA,UACpD,MAAA;AAAA,UACA,SAAA;AAAA,UACA,MAAQ,EAAA,aAAA;AAAA,SACT,CAAA,CAAA;AACD,QAAA,MAAM,eAAeN,0BAAO,EAAA,CAAA;AAC5B,QAAA,IAAA,CAAK,KAAK,YAAY,CAAA,CAAA;AACtB,QAAA,MAAA,CAAO,IAAI,YAAY,CAAA,CAAA;AAEvB,QAAA,MAAM,eACJ,EAAe,GAAA,cAAA,CAAA,WAAA,KAAf,IAA8B,GAAA,EAAA,GAAA,IAAI,oBAAoB,aAAa,CAAA,CAAA;AAErE,QAAY,WAAA,CAAA,SAAA,CAAU,eAAe,WAAW,CAAA,CAAA;AAChD,QAAC,CAAA,cAAA,CAAe,UAAY,EAAA,IAAI,CAC7B,CAAA,IAAA,EACA,CAAA,OAAA,CAAQ,CAAa,SAAA,KAAA,SAAA,CAAU,cAAe,CAAA,WAAW,CAAC,CAAA,CAAA;AAAA,OAC/D;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/service/InMemoryEventBroker.ts","../src/service/EventsBackend.ts","../src/service/http/validation/RequestValidationContextImpl.ts","../src/service/http/HttpPostIngressEventPublisher.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 {\n EventBroker,\n EventParams,\n EventSubscriber,\n} from '@backstage/plugin-events-node';\nimport { Logger } from 'winston';\n\n/**\n * In-memory event broker which will pass the event to all registered subscribers\n * interested in it.\n * Events will not be persisted in any form.\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class InMemoryEventBroker implements EventBroker {\n constructor(private readonly logger: Logger) {}\n\n private readonly subscribers: {\n [topic: string]: EventSubscriber[];\n } = {};\n\n async publish(params: EventParams): Promise<void> {\n this.logger.debug(\n `Event received: topic=${params.topic}, metadata=${JSON.stringify(\n params.metadata,\n )}, payload=${JSON.stringify(params.eventPayload)}`,\n );\n\n const subscribed = this.subscribers[params.topic] ?? [];\n await Promise.all(\n subscribed.map(async subscriber => {\n try {\n await subscriber.onEvent(params);\n } catch (error) {\n this.logger.error(\n `Subscriber \"${subscriber.constructor.name}\" failed to process event`,\n error,\n );\n }\n }),\n );\n }\n\n subscribe(\n ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n ): void {\n subscribers.flat().forEach(subscriber => {\n subscriber.supportsEventTopics().forEach(topic => {\n this.subscribers[topic] = this.subscribers[topic] ?? [];\n this.subscribers[topic].push(subscriber);\n });\n });\n }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n EventBroker,\n EventPublisher,\n EventSubscriber,\n} from '@backstage/plugin-events-node';\nimport { Logger } from 'winston';\nimport { InMemoryEventBroker } from './InMemoryEventBroker';\n\n/**\n * A builder that helps wire up all component parts of the event management.\n *\n * @public\n */\nexport class EventsBackend {\n private eventBroker: EventBroker;\n private publishers: EventPublisher[] = [];\n private subscribers: EventSubscriber[] = [];\n\n constructor(logger: Logger) {\n this.eventBroker = new InMemoryEventBroker(logger);\n }\n\n setEventBroker(eventBroker: EventBroker): EventsBackend {\n this.eventBroker = eventBroker;\n return this;\n }\n\n addPublishers(\n ...publishers: Array<EventPublisher | Array<EventPublisher>>\n ): EventsBackend {\n this.publishers.push(...publishers.flat());\n return this;\n }\n\n addSubscribers(\n ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n ): EventsBackend {\n this.subscribers.push(...subscribers.flat());\n return this;\n }\n\n /**\n * Wires up and returns all component parts of the event management.\n */\n async start(): Promise<void> {\n this.eventBroker.subscribe(this.subscribers);\n this.publishers.forEach(publisher =>\n publisher.setEventBroker(this.eventBroker),\n );\n }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n RequestRejectionDetails,\n RequestValidationContext,\n} from '@backstage/plugin-events-node';\n\nexport class RequestValidationContextImpl implements RequestValidationContext {\n #rejectionDetails: RequestRejectionDetails | undefined;\n\n reject(details?: Partial<RequestRejectionDetails>): void {\n this.#rejectionDetails = {\n status: details?.status ?? 403,\n payload: details?.payload ?? {},\n };\n }\n\n wasRejected(): boolean {\n return this.#rejectionDetails !== undefined;\n }\n\n get rejectionDetails() {\n return this.#rejectionDetails;\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 { errorHandler } from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport {\n EventBroker,\n EventPublisher,\n HttpPostIngressOptions,\n RequestValidator,\n} from '@backstage/plugin-events-node';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { Logger } from 'winston';\nimport { RequestValidationContextImpl } from './validation';\n\n/**\n * Publishes events received from their origin (e.g., webhook events from an SCM system)\n * via HTTP POST endpoint and passes the request body as event payload to the registered subscribers.\n *\n * @public\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class HttpPostIngressEventPublisher implements EventPublisher {\n private eventBroker?: EventBroker;\n\n static fromConfig(env: {\n config: Config;\n ingresses?: { [topic: string]: Omit<HttpPostIngressOptions, 'topic'> };\n logger: Logger;\n }): HttpPostIngressEventPublisher {\n const topics =\n env.config.getOptionalStringArray('events.http.topics') ?? [];\n\n const ingresses = env.ingresses ?? {};\n topics.forEach(topic => {\n // don't overwrite topic settings\n // (e.g., added at the config as well as argument)\n if (!ingresses[topic]) {\n ingresses[topic] = {};\n }\n });\n\n return new HttpPostIngressEventPublisher(env.logger, ingresses);\n }\n\n private constructor(\n private readonly logger: Logger,\n private readonly ingresses: {\n [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n },\n ) {}\n\n bind(router: express.Router): void {\n router.use('/http', this.createRouter(this.ingresses));\n }\n\n async setEventBroker(eventBroker: EventBroker): Promise<void> {\n this.eventBroker = eventBroker;\n }\n\n private createRouter(ingresses: {\n [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n }): express.Router {\n const router = Router();\n router.use(express.json());\n\n Object.keys(ingresses).forEach(topic =>\n this.addRouteForTopic(router, topic, ingresses[topic].validator),\n );\n\n router.use(errorHandler());\n return router;\n }\n\n private addRouteForTopic(\n router: express.Router,\n topic: string,\n validator?: RequestValidator,\n ): void {\n const path = `/${topic}`;\n\n router.post(path, async (request, response) => {\n const requestDetails = {\n body: request.body,\n headers: request.headers,\n };\n const context = new RequestValidationContextImpl();\n await validator?.(requestDetails, context);\n if (context.wasRejected()) {\n response\n .status(context.rejectionDetails!.status)\n .json(context.rejectionDetails!.payload);\n return;\n }\n\n const eventPayload = request.body;\n await this.eventBroker!.publish({\n topic,\n eventPayload,\n metadata: request.headers,\n });\n\n response.status(202).json({ status: 'accepted' });\n });\n\n // TODO(pjungermann): We don't really know the externally defined path prefix here,\n // however it is more useful for users to have it. Is there a better way?\n this.logger.info(`Registered /api/events/http${path} to receive events`);\n }\n}\n"],"names":["Router","express","errorHandler"],"mappings":";;;;;;;;;;;;;AA6BO,MAAM,mBAA2C,CAAA;AAAA,EACtD,YAA6B,MAAgB,EAAA;AAAhB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAE7B,IAAA,IAAA,CAAiB,cAEb,EAAC,CAAA;AAAA,GAJyC;AAAA,EAM9C,MAAM,QAAQ,MAAoC,EAAA;AApCpD,IAAA,IAAA,EAAA,CAAA;AAqCI,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,sBAAA,EAAyB,MAAO,CAAA,KAAA,CAAA,WAAA,EAAmB,IAAK,CAAA,SAAA;AAAA,QACtD,MAAO,CAAA,QAAA;AAAA,OACK,CAAA,UAAA,EAAA,IAAA,CAAK,SAAU,CAAA,MAAA,CAAO,YAAY,CAAA,CAAA,CAAA;AAAA,KAClD,CAAA;AAEA,IAAA,MAAM,cAAa,EAAK,GAAA,IAAA,CAAA,WAAA,CAAY,OAAO,KAAK,CAAA,KAA7B,YAAkC,EAAC,CAAA;AACtD,IAAA,MAAM,OAAQ,CAAA,GAAA;AAAA,MACZ,UAAA,CAAW,GAAI,CAAA,OAAM,UAAc,KAAA;AACjC,QAAI,IAAA;AACF,UAAM,MAAA,UAAA,CAAW,QAAQ,MAAM,CAAA,CAAA;AAAA,iBACxB,KAAP,EAAA;AACA,UAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,YACV,CAAA,YAAA,EAAe,WAAW,WAAY,CAAA,IAAA,CAAA,yBAAA,CAAA;AAAA,YACtC,KAAA;AAAA,WACF,CAAA;AAAA,SACF;AAAA,OACD,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,aACK,WACG,EAAA;AACN,IAAY,WAAA,CAAA,IAAA,EAAO,CAAA,OAAA,CAAQ,CAAc,UAAA,KAAA;AACvC,MAAW,UAAA,CAAA,mBAAA,EAAsB,CAAA,OAAA,CAAQ,CAAS,KAAA,KAAA;AA9DxD,QAAA,IAAA,EAAA,CAAA;AA+DQ,QAAK,IAAA,CAAA,WAAA,CAAY,KAAK,CAAI,GAAA,CAAA,EAAA,GAAA,IAAA,CAAK,YAAY,KAAK,CAAA,KAAtB,YAA2B,EAAC,CAAA;AACtD,QAAA,IAAA,CAAK,WAAY,CAAA,KAAK,CAAE,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AAAA,OACxC,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;ACvCO,MAAM,aAAc,CAAA;AAAA,EAKzB,YAAY,MAAgB,EAAA;AAH5B,IAAA,IAAA,CAAQ,aAA+B,EAAC,CAAA;AACxC,IAAA,IAAA,CAAQ,cAAiC,EAAC,CAAA;AAGxC,IAAK,IAAA,CAAA,WAAA,GAAc,IAAI,mBAAA,CAAoB,MAAM,CAAA,CAAA;AAAA,GACnD;AAAA,EAEA,eAAe,WAAyC,EAAA;AACtD,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AACnB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,iBACK,UACY,EAAA;AACf,IAAA,IAAA,CAAK,UAAW,CAAA,IAAA,CAAK,GAAG,UAAA,CAAW,MAAM,CAAA,CAAA;AACzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,kBACK,WACY,EAAA;AACf,IAAA,IAAA,CAAK,WAAY,CAAA,IAAA,CAAK,GAAG,WAAA,CAAY,MAAM,CAAA,CAAA;AAC3C,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAuB,GAAA;AAC3B,IAAK,IAAA,CAAA,WAAA,CAAY,SAAU,CAAA,IAAA,CAAK,WAAW,CAAA,CAAA;AAC3C,IAAA,IAAA,CAAK,UAAW,CAAA,OAAA;AAAA,MAAQ,CACtB,SAAA,KAAA,SAAA,CAAU,cAAe,CAAA,IAAA,CAAK,WAAW,CAAA;AAAA,KAC3C,CAAA;AAAA,GACF;AACF;;;;;;;;;;;;;;;;;;;;AClEA,IAAA,iBAAA,CAAA;AAqBO,MAAM,4BAAiE,CAAA;AAAA,EAAvE,WAAA,GAAA;AACL,IAAA,YAAA,CAAA,IAAA,EAAA,iBAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAEA,OAAO,OAAkD,EAAA;AAxB3D,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAyBI,IAAA,YAAA,CAAA,IAAA,EAAK,iBAAoB,EAAA;AAAA,MACvB,MAAA,EAAA,CAAQ,EAAS,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAA,MAAA,KAAT,IAAmB,GAAA,EAAA,GAAA,GAAA;AAAA,MAC3B,OAAS,EAAA,CAAA,EAAA,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,OAAT,KAAA,IAAA,GAAA,EAAA,GAAoB,EAAC;AAAA,KAChC,CAAA,CAAA;AAAA,GACF;AAAA,EAEA,WAAuB,GAAA;AACrB,IAAA,OAAO,mBAAK,iBAAsB,CAAA,KAAA,KAAA,CAAA,CAAA;AAAA,GACpC;AAAA,EAEA,IAAI,gBAAmB,GAAA;AACrB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AAhBE,iBAAA,GAAA,IAAA,OAAA,EAAA;;ACcK,MAAM,6BAAwD,CAAA;AAAA,EAuB3D,WAAA,CACW,QACA,SAGjB,EAAA;AAJiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AAAA,GAGhB;AAAA,EAzBH,OAAO,WAAW,GAIgB,EAAA;AA3CpC,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AA4CI,IAAA,MAAM,UACJ,EAAI,GAAA,GAAA,CAAA,MAAA,CAAO,uBAAuB,oBAAoB,CAAA,KAAtD,YAA2D,EAAC,CAAA;AAE9D,IAAA,MAAM,SAAY,GAAA,CAAA,EAAA,GAAA,GAAA,CAAI,SAAJ,KAAA,IAAA,GAAA,EAAA,GAAiB,EAAC,CAAA;AACpC,IAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAGtB,MAAI,IAAA,CAAC,SAAU,CAAA,KAAK,CAAG,EAAA;AACrB,QAAU,SAAA,CAAA,KAAK,IAAI,EAAC,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,OAAO,IAAI,6BAAA,CAA8B,GAAI,CAAA,MAAA,EAAQ,SAAS,CAAA,CAAA;AAAA,GAChE;AAAA,EASA,KAAK,MAA8B,EAAA;AACjC,IAAA,MAAA,CAAO,IAAI,OAAS,EAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,SAAS,CAAC,CAAA,CAAA;AAAA,GACvD;AAAA,EAEA,MAAM,eAAe,WAAyC,EAAA;AAC5D,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AAAA,GACrB;AAAA,EAEQ,aAAa,SAEF,EAAA;AACjB,IAAA,MAAM,SAASA,0BAAO,EAAA,CAAA;AACtB,IAAO,MAAA,CAAA,GAAA,CAAIC,2BAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,IAAO,MAAA,CAAA,IAAA,CAAK,SAAS,CAAE,CAAA,OAAA;AAAA,MAAQ,CAAA,KAAA,KAC7B,KAAK,gBAAiB,CAAA,MAAA,EAAQ,OAAO,SAAU,CAAA,KAAK,EAAE,SAAS,CAAA;AAAA,KACjE,CAAA;AAEA,IAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEQ,gBAAA,CACN,MACA,EAAA,KAAA,EACA,SACM,EAAA;AACN,IAAA,MAAM,OAAO,CAAI,CAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAEjB,IAAA,MAAA,CAAO,IAAK,CAAA,IAAA,EAAM,OAAO,OAAA,EAAS,QAAa,KAAA;AAC7C,MAAA,MAAM,cAAiB,GAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,SAAS,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA;AACA,MAAM,MAAA,OAAA,GAAU,IAAI,4BAA6B,EAAA,CAAA;AACjD,MAAA,OAAM,uCAAY,cAAgB,EAAA,OAAA,CAAA,CAAA,CAAA;AAClC,MAAI,IAAA,OAAA,CAAQ,aAAe,EAAA;AACzB,QACG,QAAA,CAAA,MAAA,CAAO,QAAQ,gBAAkB,CAAA,MAAM,EACvC,IAAK,CAAA,OAAA,CAAQ,iBAAkB,OAAO,CAAA,CAAA;AACzC,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,MAAM,eAAe,OAAQ,CAAA,IAAA,CAAA;AAC7B,MAAM,MAAA,IAAA,CAAK,YAAa,OAAQ,CAAA;AAAA,QAC9B,KAAA;AAAA,QACA,YAAA;AAAA,QACA,UAAU,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA,CAAA;AAED,MAAA,QAAA,CAAS,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,MAAA,EAAQ,YAAY,CAAA,CAAA;AAAA,KACjD,CAAA,CAAA;AAID,IAAK,IAAA,CAAA,MAAA,CAAO,IAAK,CAAA,CAAA,2BAAA,EAA8B,IAAwB,CAAA,kBAAA,CAAA,CAAA,CAAA;AAAA,GACzE;AACF;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,24 +1,14 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
*
|
|
4
|
-
* @packageDocumentation
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
import { BackendFeature } from '@backstage/backend-plugin-api';
|
|
1
|
+
import { EventBroker, EventPublisher, EventSubscriber, HttpPostIngressOptions } from '@backstage/plugin-events-node';
|
|
2
|
+
import { Logger } from 'winston';
|
|
8
3
|
import { Config } from '@backstage/config';
|
|
9
|
-
import { EventBroker } from '@backstage/plugin-events-node';
|
|
10
|
-
import { EventPublisher } from '@backstage/plugin-events-node';
|
|
11
|
-
import { EventSubscriber } from '@backstage/plugin-events-node';
|
|
12
4
|
import express from 'express';
|
|
13
|
-
import { HttpPostIngressOptions } from '@backstage/plugin-events-node';
|
|
14
|
-
import { Logger } from 'winston';
|
|
15
5
|
|
|
16
6
|
/**
|
|
17
7
|
* A builder that helps wire up all component parts of the event management.
|
|
18
8
|
*
|
|
19
9
|
* @public
|
|
20
10
|
*/
|
|
21
|
-
|
|
11
|
+
declare class EventsBackend {
|
|
22
12
|
private eventBroker;
|
|
23
13
|
private publishers;
|
|
24
14
|
private subscribers;
|
|
@@ -32,15 +22,13 @@ export declare class EventsBackend {
|
|
|
32
22
|
start(): Promise<void>;
|
|
33
23
|
}
|
|
34
24
|
|
|
35
|
-
/* Excluded from this release type: eventsPlugin */
|
|
36
|
-
|
|
37
25
|
/**
|
|
38
26
|
* Publishes events received from their origin (e.g., webhook events from an SCM system)
|
|
39
27
|
* via HTTP POST endpoint and passes the request body as event payload to the registered subscribers.
|
|
40
28
|
*
|
|
41
29
|
* @public
|
|
42
30
|
*/
|
|
43
|
-
|
|
31
|
+
declare class HttpPostIngressEventPublisher implements EventPublisher {
|
|
44
32
|
private readonly logger;
|
|
45
33
|
private readonly ingresses;
|
|
46
34
|
private eventBroker?;
|
|
@@ -58,4 +46,4 @@ export declare class HttpPostIngressEventPublisher implements EventPublisher {
|
|
|
58
46
|
private addRouteForTopic;
|
|
59
47
|
}
|
|
60
48
|
|
|
61
|
-
export { }
|
|
49
|
+
export { EventsBackend, HttpPostIngressEventPublisher };
|
package/package.json
CHANGED
|
@@ -1,21 +1,31 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-events-backend",
|
|
3
|
-
"version": "0.2.
|
|
4
|
-
"main": "dist/index.cjs.js",
|
|
5
|
-
"types": "dist/index.d.ts",
|
|
3
|
+
"version": "0.2.4-next.1",
|
|
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
|
-
|
|
10
|
-
|
|
11
|
-
"
|
|
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"
|
|
15
25
|
},
|
|
16
26
|
"scripts": {
|
|
17
27
|
"start": "backstage-cli package start",
|
|
18
|
-
"build": "backstage-cli package build
|
|
28
|
+
"build": "backstage-cli package build",
|
|
19
29
|
"lint": "backstage-cli package lint",
|
|
20
30
|
"test": "backstage-cli package test",
|
|
21
31
|
"clean": "backstage-cli package clean",
|
|
@@ -23,26 +33,26 @@
|
|
|
23
33
|
"postpack": "backstage-cli package postpack"
|
|
24
34
|
},
|
|
25
35
|
"dependencies": {
|
|
26
|
-
"@backstage/backend-common": "^0.18.
|
|
27
|
-
"@backstage/backend-plugin-api": "^0.4.
|
|
28
|
-
"@backstage/config": "^1.0.
|
|
29
|
-
"@backstage/plugin-events-node": "^0.2.
|
|
36
|
+
"@backstage/backend-common": "^0.18.3-next.1",
|
|
37
|
+
"@backstage/backend-plugin-api": "^0.4.1-next.1",
|
|
38
|
+
"@backstage/config": "^1.0.7-next.0",
|
|
39
|
+
"@backstage/plugin-events-node": "^0.2.4-next.1",
|
|
30
40
|
"@types/express": "^4.17.6",
|
|
31
41
|
"express": "^4.17.1",
|
|
32
42
|
"express-promise-router": "^4.1.0",
|
|
33
43
|
"winston": "^3.2.1"
|
|
34
44
|
},
|
|
35
45
|
"devDependencies": {
|
|
36
|
-
"@backstage/backend-common": "^0.18.
|
|
37
|
-
"@backstage/backend-test-utils": "^0.1.
|
|
38
|
-
"@backstage/cli": "^0.22.
|
|
39
|
-
"@backstage/plugin-events-backend-test-utils": "^0.1.
|
|
46
|
+
"@backstage/backend-common": "^0.18.3-next.1",
|
|
47
|
+
"@backstage/backend-test-utils": "^0.1.35-next.1",
|
|
48
|
+
"@backstage/cli": "^0.22.4-next.1",
|
|
49
|
+
"@backstage/plugin-events-backend-test-utils": "^0.1.5-next.1",
|
|
40
50
|
"supertest": "^6.1.3"
|
|
41
51
|
},
|
|
42
52
|
"files": [
|
|
43
|
-
"alpha",
|
|
44
53
|
"config.d.ts",
|
|
45
|
-
"dist"
|
|
54
|
+
"dist",
|
|
55
|
+
"alpha"
|
|
46
56
|
],
|
|
47
57
|
"configSchema": "config.d.ts"
|
|
48
58
|
}
|
package/dist/index.alpha.d.ts
DELETED
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The Backstage backend plugin "events" that provides the event management.
|
|
3
|
-
*
|
|
4
|
-
* @packageDocumentation
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
import { BackendFeature } from '@backstage/backend-plugin-api';
|
|
8
|
-
import { Config } from '@backstage/config';
|
|
9
|
-
import { EventBroker } from '@backstage/plugin-events-node';
|
|
10
|
-
import { EventPublisher } from '@backstage/plugin-events-node';
|
|
11
|
-
import { EventSubscriber } from '@backstage/plugin-events-node';
|
|
12
|
-
import express from 'express';
|
|
13
|
-
import { HttpPostIngressOptions } from '@backstage/plugin-events-node';
|
|
14
|
-
import { Logger } from 'winston';
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* A builder that helps wire up all component parts of the event management.
|
|
18
|
-
*
|
|
19
|
-
* @public
|
|
20
|
-
*/
|
|
21
|
-
export declare class EventsBackend {
|
|
22
|
-
private eventBroker;
|
|
23
|
-
private publishers;
|
|
24
|
-
private subscribers;
|
|
25
|
-
constructor(logger: Logger);
|
|
26
|
-
setEventBroker(eventBroker: EventBroker): EventsBackend;
|
|
27
|
-
addPublishers(...publishers: Array<EventPublisher | Array<EventPublisher>>): EventsBackend;
|
|
28
|
-
addSubscribers(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): EventsBackend;
|
|
29
|
-
/**
|
|
30
|
-
* Wires up and returns all component parts of the event management.
|
|
31
|
-
*/
|
|
32
|
-
start(): Promise<void>;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
/**
|
|
36
|
-
* Events plugin
|
|
37
|
-
*
|
|
38
|
-
* @alpha
|
|
39
|
-
*/
|
|
40
|
-
export declare const eventsPlugin: () => BackendFeature;
|
|
41
|
-
|
|
42
|
-
/**
|
|
43
|
-
* Publishes events received from their origin (e.g., webhook events from an SCM system)
|
|
44
|
-
* via HTTP POST endpoint and passes the request body as event payload to the registered subscribers.
|
|
45
|
-
*
|
|
46
|
-
* @public
|
|
47
|
-
*/
|
|
48
|
-
export declare class HttpPostIngressEventPublisher implements EventPublisher {
|
|
49
|
-
private readonly logger;
|
|
50
|
-
private readonly ingresses;
|
|
51
|
-
private eventBroker?;
|
|
52
|
-
static fromConfig(env: {
|
|
53
|
-
config: Config;
|
|
54
|
-
ingresses?: {
|
|
55
|
-
[topic: string]: Omit<HttpPostIngressOptions, 'topic'>;
|
|
56
|
-
};
|
|
57
|
-
logger: Logger;
|
|
58
|
-
}): HttpPostIngressEventPublisher;
|
|
59
|
-
private constructor();
|
|
60
|
-
bind(router: express.Router): void;
|
|
61
|
-
setEventBroker(eventBroker: EventBroker): Promise<void>;
|
|
62
|
-
private createRouter;
|
|
63
|
-
private addRouteForTopic;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
export { }
|
package/dist/index.beta.d.ts
DELETED
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The Backstage backend plugin "events" that provides the event management.
|
|
3
|
-
*
|
|
4
|
-
* @packageDocumentation
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
import { BackendFeature } from '@backstage/backend-plugin-api';
|
|
8
|
-
import { Config } from '@backstage/config';
|
|
9
|
-
import { EventBroker } from '@backstage/plugin-events-node';
|
|
10
|
-
import { EventPublisher } from '@backstage/plugin-events-node';
|
|
11
|
-
import { EventSubscriber } from '@backstage/plugin-events-node';
|
|
12
|
-
import express from 'express';
|
|
13
|
-
import { HttpPostIngressOptions } from '@backstage/plugin-events-node';
|
|
14
|
-
import { Logger } from 'winston';
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* A builder that helps wire up all component parts of the event management.
|
|
18
|
-
*
|
|
19
|
-
* @public
|
|
20
|
-
*/
|
|
21
|
-
export declare class EventsBackend {
|
|
22
|
-
private eventBroker;
|
|
23
|
-
private publishers;
|
|
24
|
-
private subscribers;
|
|
25
|
-
constructor(logger: Logger);
|
|
26
|
-
setEventBroker(eventBroker: EventBroker): EventsBackend;
|
|
27
|
-
addPublishers(...publishers: Array<EventPublisher | Array<EventPublisher>>): EventsBackend;
|
|
28
|
-
addSubscribers(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): EventsBackend;
|
|
29
|
-
/**
|
|
30
|
-
* Wires up and returns all component parts of the event management.
|
|
31
|
-
*/
|
|
32
|
-
start(): Promise<void>;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
/* Excluded from this release type: eventsPlugin */
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* Publishes events received from their origin (e.g., webhook events from an SCM system)
|
|
39
|
-
* via HTTP POST endpoint and passes the request body as event payload to the registered subscribers.
|
|
40
|
-
*
|
|
41
|
-
* @public
|
|
42
|
-
*/
|
|
43
|
-
export declare class HttpPostIngressEventPublisher implements EventPublisher {
|
|
44
|
-
private readonly logger;
|
|
45
|
-
private readonly ingresses;
|
|
46
|
-
private eventBroker?;
|
|
47
|
-
static fromConfig(env: {
|
|
48
|
-
config: Config;
|
|
49
|
-
ingresses?: {
|
|
50
|
-
[topic: string]: Omit<HttpPostIngressOptions, 'topic'>;
|
|
51
|
-
};
|
|
52
|
-
logger: Logger;
|
|
53
|
-
}): HttpPostIngressEventPublisher;
|
|
54
|
-
private constructor();
|
|
55
|
-
bind(router: express.Router): void;
|
|
56
|
-
setEventBroker(eventBroker: EventBroker): Promise<void>;
|
|
57
|
-
private createRouter;
|
|
58
|
-
private addRouteForTopic;
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
export { }
|