@backstage/plugin-events-node 0.4.0 → 0.4.1-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/README.md +1 -1
- package/alpha/package.json +1 -1
- package/dist/alpha.cjs.js +3 -5
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/api/DefaultEventsService.cjs.js +300 -0
- package/dist/api/DefaultEventsService.cjs.js.map +1 -0
- package/dist/api/EventRouter.cjs.js +40 -0
- package/dist/api/EventRouter.cjs.js.map +1 -0
- package/dist/api/SubTopicEventRouter.cjs.js +19 -0
- package/dist/api/SubTopicEventRouter.cjs.js.map +1 -0
- package/dist/extensions.cjs.js +10 -0
- package/dist/extensions.cjs.js.map +1 -0
- package/dist/generated/apis/DefaultApi.client.cjs.js +95 -0
- package/dist/generated/apis/DefaultApi.client.cjs.js.map +1 -0
- package/dist/generated/pluginId.cjs.js +6 -0
- package/dist/generated/pluginId.cjs.js.map +1 -0
- package/dist/index.cjs.js +9 -137
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +8 -3
- package/dist/service.cjs.js +35 -0
- package/dist/service.cjs.js.map +1 -0
- package/package.json +8 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# @backstage/plugin-events-node
|
|
2
2
|
|
|
3
|
+
## 0.4.1-next.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/backend-plugin-api@1.0.1-next.1
|
|
9
|
+
- @backstage/errors@1.2.4
|
|
10
|
+
- @backstage/types@1.1.1
|
|
11
|
+
|
|
12
|
+
## 0.4.1-next.0
|
|
13
|
+
|
|
14
|
+
### Patch Changes
|
|
15
|
+
|
|
16
|
+
- 094eaa3: Remove references to in-repo backend-common
|
|
17
|
+
- 2f88f88: Updated backend installation instructions.
|
|
18
|
+
- a90ce4a: The default implementation of the `EventsService` now uses the new event bus for distributing events across multiple backend instances if the events backend plugin is installed.
|
|
19
|
+
- Updated dependencies
|
|
20
|
+
- @backstage/backend-plugin-api@1.0.1-next.0
|
|
21
|
+
- @backstage/errors@1.2.4
|
|
22
|
+
- @backstage/types@1.1.1
|
|
23
|
+
|
|
3
24
|
## 0.4.0
|
|
4
25
|
|
|
5
26
|
### Minor Changes
|
package/README.md
CHANGED
package/alpha/package.json
CHANGED
package/dist/alpha.cjs.js
CHANGED
|
@@ -1,10 +1,8 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var extensions = require('./extensions.cjs.js');
|
|
4
4
|
|
|
5
|
-
const eventsExtensionPoint = backendPluginApi.createExtensionPoint({
|
|
6
|
-
id: "events"
|
|
7
|
-
});
|
|
8
5
|
|
|
9
|
-
|
|
6
|
+
|
|
7
|
+
exports.eventsExtensionPoint = extensions.eventsExtensionPoint;
|
|
10
8
|
//# sourceMappingURL=alpha.cjs.js.map
|
package/dist/alpha.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alpha.cjs.js","sources":[
|
|
1
|
+
{"version":3,"file":"alpha.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;"}
|
|
@@ -0,0 +1,300 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var DefaultApi_client = require('../generated/apis/DefaultApi.client.cjs.js');
|
|
4
|
+
var errors = require('@backstage/errors');
|
|
5
|
+
|
|
6
|
+
const POLL_BACKOFF_START_MS = 1e3;
|
|
7
|
+
const POLL_BACKOFF_MAX_MS = 6e4;
|
|
8
|
+
const POLL_BACKOFF_FACTOR = 2;
|
|
9
|
+
class LocalEventBus {
|
|
10
|
+
#logger;
|
|
11
|
+
#subscribers = /* @__PURE__ */ new Map();
|
|
12
|
+
constructor(logger) {
|
|
13
|
+
this.#logger = logger;
|
|
14
|
+
}
|
|
15
|
+
async publish(params) {
|
|
16
|
+
this.#logger.debug(
|
|
17
|
+
`Event received: topic=${params.topic}, metadata=${JSON.stringify(
|
|
18
|
+
params.metadata
|
|
19
|
+
)}, payload=${JSON.stringify(params.eventPayload)}`
|
|
20
|
+
);
|
|
21
|
+
if (!this.#subscribers.has(params.topic)) {
|
|
22
|
+
return { notifiedSubscribers: [] };
|
|
23
|
+
}
|
|
24
|
+
const onEventPromises = [];
|
|
25
|
+
this.#subscribers.get(params.topic)?.forEach((subscription) => {
|
|
26
|
+
onEventPromises.push(
|
|
27
|
+
(async () => {
|
|
28
|
+
try {
|
|
29
|
+
await subscription.onEvent(params);
|
|
30
|
+
} catch (error) {
|
|
31
|
+
this.#logger.warn(
|
|
32
|
+
`Subscriber "${subscription.id}" failed to process event for topic "${params.topic}"`,
|
|
33
|
+
error
|
|
34
|
+
);
|
|
35
|
+
}
|
|
36
|
+
return subscription.id;
|
|
37
|
+
})()
|
|
38
|
+
);
|
|
39
|
+
});
|
|
40
|
+
return { notifiedSubscribers: await Promise.all(onEventPromises) };
|
|
41
|
+
}
|
|
42
|
+
async subscribe(options) {
|
|
43
|
+
options.topics.forEach((topic) => {
|
|
44
|
+
if (!this.#subscribers.has(topic)) {
|
|
45
|
+
this.#subscribers.set(topic, []);
|
|
46
|
+
}
|
|
47
|
+
this.#subscribers.get(topic).push({
|
|
48
|
+
id: options.id,
|
|
49
|
+
onEvent: options.onEvent
|
|
50
|
+
});
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
class PluginEventsService {
|
|
55
|
+
constructor(pluginId, localBus, logger, client, auth) {
|
|
56
|
+
this.pluginId = pluginId;
|
|
57
|
+
this.localBus = localBus;
|
|
58
|
+
this.logger = logger;
|
|
59
|
+
this.client = client;
|
|
60
|
+
this.auth = auth;
|
|
61
|
+
}
|
|
62
|
+
async publish(params) {
|
|
63
|
+
const lock = this.#getShutdownLock();
|
|
64
|
+
try {
|
|
65
|
+
const { notifiedSubscribers } = await this.localBus.publish(params);
|
|
66
|
+
if (!this.client) {
|
|
67
|
+
return;
|
|
68
|
+
}
|
|
69
|
+
const token = await this.#getToken();
|
|
70
|
+
if (!token) {
|
|
71
|
+
return;
|
|
72
|
+
}
|
|
73
|
+
const res = await this.client.postEvent(
|
|
74
|
+
{
|
|
75
|
+
body: {
|
|
76
|
+
event: { payload: params.eventPayload, topic: params.topic },
|
|
77
|
+
notifiedSubscribers
|
|
78
|
+
}
|
|
79
|
+
},
|
|
80
|
+
{ token }
|
|
81
|
+
);
|
|
82
|
+
if (!res.ok) {
|
|
83
|
+
if (res.status === 404) {
|
|
84
|
+
this.logger.warn(
|
|
85
|
+
`Event publish request failed with status 404, events backend not found. Future events will not be persisted.`
|
|
86
|
+
);
|
|
87
|
+
delete this.client;
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
throw await errors.ResponseError.fromResponse(res);
|
|
91
|
+
}
|
|
92
|
+
} finally {
|
|
93
|
+
lock.release();
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
async subscribe(options) {
|
|
97
|
+
const subscriptionId = `${this.pluginId}.${options.id}`;
|
|
98
|
+
await this.localBus.subscribe({
|
|
99
|
+
id: subscriptionId,
|
|
100
|
+
topics: options.topics,
|
|
101
|
+
onEvent: options.onEvent
|
|
102
|
+
});
|
|
103
|
+
if (!this.client) {
|
|
104
|
+
return;
|
|
105
|
+
}
|
|
106
|
+
const token = await this.#getToken();
|
|
107
|
+
if (!token) {
|
|
108
|
+
return;
|
|
109
|
+
}
|
|
110
|
+
const res = await this.client.putSubscription(
|
|
111
|
+
{
|
|
112
|
+
path: { subscriptionId },
|
|
113
|
+
body: { topics: options.topics }
|
|
114
|
+
},
|
|
115
|
+
{ token }
|
|
116
|
+
);
|
|
117
|
+
if (!res.ok) {
|
|
118
|
+
if (res.status === 404) {
|
|
119
|
+
this.logger.warn(
|
|
120
|
+
`Event subscribe request failed with status 404, events backend not found. Will only receive events that were sent locally on this process.`
|
|
121
|
+
);
|
|
122
|
+
delete this.client;
|
|
123
|
+
return;
|
|
124
|
+
}
|
|
125
|
+
throw await errors.ResponseError.fromResponse(res);
|
|
126
|
+
}
|
|
127
|
+
this.#startPolling(subscriptionId, options.topics, options.onEvent);
|
|
128
|
+
}
|
|
129
|
+
#startPolling(subscriptionId, topics, onEvent) {
|
|
130
|
+
let backoffMs = POLL_BACKOFF_START_MS;
|
|
131
|
+
const poll = async () => {
|
|
132
|
+
if (!this.client) {
|
|
133
|
+
return;
|
|
134
|
+
}
|
|
135
|
+
const lock = this.#getShutdownLock();
|
|
136
|
+
try {
|
|
137
|
+
const token = await this.#getToken();
|
|
138
|
+
if (!token) {
|
|
139
|
+
return;
|
|
140
|
+
}
|
|
141
|
+
const res = await this.client.getSubscriptionEvents(
|
|
142
|
+
{
|
|
143
|
+
path: { subscriptionId }
|
|
144
|
+
},
|
|
145
|
+
{ token }
|
|
146
|
+
);
|
|
147
|
+
if (!res.ok) {
|
|
148
|
+
if (res.status === 404) {
|
|
149
|
+
this.logger.info(
|
|
150
|
+
`Polling event subscription resulted in a 404, recreating subscription`
|
|
151
|
+
);
|
|
152
|
+
const putRes = await this.client.putSubscription(
|
|
153
|
+
{
|
|
154
|
+
path: { subscriptionId },
|
|
155
|
+
body: { topics }
|
|
156
|
+
},
|
|
157
|
+
{ token }
|
|
158
|
+
);
|
|
159
|
+
if (!putRes.ok) {
|
|
160
|
+
throw await errors.ResponseError.fromResponse(res);
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
throw await errors.ResponseError.fromResponse(res);
|
|
164
|
+
}
|
|
165
|
+
backoffMs = POLL_BACKOFF_START_MS;
|
|
166
|
+
if (res.status === 202) {
|
|
167
|
+
lock.release();
|
|
168
|
+
await res.body?.getReader()?.closed;
|
|
169
|
+
process.nextTick(poll);
|
|
170
|
+
} else if (res.status === 200) {
|
|
171
|
+
const data = await res.json();
|
|
172
|
+
if (data) {
|
|
173
|
+
for (const event of data.events ?? []) {
|
|
174
|
+
try {
|
|
175
|
+
await onEvent({
|
|
176
|
+
topic: event.topic,
|
|
177
|
+
eventPayload: event.payload
|
|
178
|
+
});
|
|
179
|
+
} catch (error) {
|
|
180
|
+
this.logger.warn(
|
|
181
|
+
`Subscriber "${subscriptionId}" failed to process event for topic "${event.topic}"`,
|
|
182
|
+
error
|
|
183
|
+
);
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
process.nextTick(poll);
|
|
188
|
+
} else {
|
|
189
|
+
this.logger.warn(
|
|
190
|
+
`Unexpected response status ${res.status} from events backend for subscription "${subscriptionId}"`
|
|
191
|
+
);
|
|
192
|
+
}
|
|
193
|
+
} catch (error) {
|
|
194
|
+
this.logger.warn(
|
|
195
|
+
`Poll failed for subscription "${subscriptionId}", retrying in ${backoffMs.toFixed(
|
|
196
|
+
0
|
|
197
|
+
)}ms`,
|
|
198
|
+
error
|
|
199
|
+
);
|
|
200
|
+
setTimeout(poll, backoffMs);
|
|
201
|
+
backoffMs = Math.min(
|
|
202
|
+
backoffMs * POLL_BACKOFF_FACTOR,
|
|
203
|
+
POLL_BACKOFF_MAX_MS
|
|
204
|
+
);
|
|
205
|
+
} finally {
|
|
206
|
+
lock.release();
|
|
207
|
+
}
|
|
208
|
+
};
|
|
209
|
+
poll();
|
|
210
|
+
}
|
|
211
|
+
async #getToken() {
|
|
212
|
+
if (!this.auth) {
|
|
213
|
+
throw new Error("Auth service not available");
|
|
214
|
+
}
|
|
215
|
+
try {
|
|
216
|
+
const { token } = await this.auth.getPluginRequestToken({
|
|
217
|
+
onBehalfOf: await this.auth.getOwnServiceCredentials(),
|
|
218
|
+
targetPluginId: "events"
|
|
219
|
+
});
|
|
220
|
+
return token;
|
|
221
|
+
} catch (error) {
|
|
222
|
+
if (String(error).includes("Unable to generate legacy token")) {
|
|
223
|
+
this.logger.warn(
|
|
224
|
+
`The events backend is not available and neither is legacy auth. Future events will not be persisted.`
|
|
225
|
+
);
|
|
226
|
+
delete this.client;
|
|
227
|
+
return void 0;
|
|
228
|
+
}
|
|
229
|
+
throw error;
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
async shutdown() {
|
|
233
|
+
this.#isShuttingDown = true;
|
|
234
|
+
await Promise.all(this.#shutdownLocks);
|
|
235
|
+
}
|
|
236
|
+
#isShuttingDown = false;
|
|
237
|
+
#shutdownLocks = [];
|
|
238
|
+
// This locking mechanism helps ensure that we are either idle or waiting for
|
|
239
|
+
// a blocked events call before shutting down. It increases out changes of
|
|
240
|
+
// never dropping any events on shutdown.
|
|
241
|
+
#getShutdownLock() {
|
|
242
|
+
if (this.#isShuttingDown) {
|
|
243
|
+
throw new Error("Service is shutting down");
|
|
244
|
+
}
|
|
245
|
+
let release;
|
|
246
|
+
this.#shutdownLocks.push(
|
|
247
|
+
new Promise((resolve) => {
|
|
248
|
+
release = resolve;
|
|
249
|
+
})
|
|
250
|
+
);
|
|
251
|
+
return { release };
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
class DefaultEventsService {
|
|
255
|
+
constructor(logger, localBus) {
|
|
256
|
+
this.logger = logger;
|
|
257
|
+
this.localBus = localBus;
|
|
258
|
+
}
|
|
259
|
+
static create(options) {
|
|
260
|
+
return new DefaultEventsService(
|
|
261
|
+
options.logger,
|
|
262
|
+
new LocalEventBus(options.logger)
|
|
263
|
+
);
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Returns a plugin-scoped context of the `EventService`
|
|
267
|
+
* that ensures to prefix subscriber IDs with the plugin ID.
|
|
268
|
+
*
|
|
269
|
+
* @param pluginId - The plugin that the `EventService` should be created for.
|
|
270
|
+
*/
|
|
271
|
+
forPlugin(pluginId, options) {
|
|
272
|
+
const client = options && new DefaultApi_client.DefaultApiClient({
|
|
273
|
+
discoveryApi: options.discovery,
|
|
274
|
+
fetchApi: { fetch }
|
|
275
|
+
// use native node fetch
|
|
276
|
+
});
|
|
277
|
+
const logger = options?.logger ?? this.logger;
|
|
278
|
+
const service = new PluginEventsService(
|
|
279
|
+
pluginId,
|
|
280
|
+
this.localBus,
|
|
281
|
+
logger,
|
|
282
|
+
client,
|
|
283
|
+
options?.auth
|
|
284
|
+
);
|
|
285
|
+
options?.lifecycle.addShutdownHook(async () => {
|
|
286
|
+
await service.shutdown();
|
|
287
|
+
});
|
|
288
|
+
return service;
|
|
289
|
+
}
|
|
290
|
+
async publish(params) {
|
|
291
|
+
await this.localBus.publish(params);
|
|
292
|
+
}
|
|
293
|
+
async subscribe(options) {
|
|
294
|
+
this.localBus.subscribe(options);
|
|
295
|
+
}
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
exports.DefaultEventsService = DefaultEventsService;
|
|
299
|
+
exports.LocalEventBus = LocalEventBus;
|
|
300
|
+
//# sourceMappingURL=DefaultEventsService.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DefaultEventsService.cjs.js","sources":["../../src/api/DefaultEventsService.ts"],"sourcesContent":["/*\n * Copyright 2024 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 AuthService,\n DiscoveryService,\n LifecycleService,\n LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { EventParams } from './EventParams';\nimport { EventsService, EventsServiceSubscribeOptions } from './EventsService';\nimport { DefaultApiClient } from '../generated';\nimport { ResponseError } from '@backstage/errors';\n\nconst POLL_BACKOFF_START_MS = 1_000;\nconst POLL_BACKOFF_MAX_MS = 60_000;\nconst POLL_BACKOFF_FACTOR = 2;\n\n/**\n * Local event bus for subscribers within the same process.\n *\n * When publishing events we'll keep track of which subscribers we managed to\n * reach locally, and forward those subscriber IDs to the events backend if it\n * is in use. The events backend will then both avoid forwarding the same events\n * to those subscribers again, but also avoid storing the event altogether if\n * there are no other subscribers.\n * @internal\n */\nexport class LocalEventBus {\n readonly #logger: LoggerService;\n\n readonly #subscribers = new Map<\n string,\n Omit<EventsServiceSubscribeOptions, 'topics'>[]\n >();\n\n constructor(logger: LoggerService) {\n this.#logger = logger;\n }\n\n async publish(\n params: EventParams,\n ): Promise<{ notifiedSubscribers: string[] }> {\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 if (!this.#subscribers.has(params.topic)) {\n return { notifiedSubscribers: [] };\n }\n\n const onEventPromises: Promise<string>[] = [];\n this.#subscribers.get(params.topic)?.forEach(subscription => {\n onEventPromises.push(\n (async () => {\n try {\n await subscription.onEvent(params);\n } catch (error) {\n this.#logger.warn(\n `Subscriber \"${subscription.id}\" failed to process event for topic \"${params.topic}\"`,\n error,\n );\n }\n return subscription.id;\n })(),\n );\n });\n\n return { notifiedSubscribers: await Promise.all(onEventPromises) };\n }\n\n async subscribe(options: EventsServiceSubscribeOptions): Promise<void> {\n options.topics.forEach(topic => {\n if (!this.#subscribers.has(topic)) {\n this.#subscribers.set(topic, []);\n }\n\n this.#subscribers.get(topic)!.push({\n id: options.id,\n onEvent: options.onEvent,\n });\n });\n }\n}\n\n/**\n * Plugin specific events bus that delegates to the local bus, as well as the\n * events backend if it is available.\n */\nclass PluginEventsService implements EventsService {\n constructor(\n private readonly pluginId: string,\n private readonly localBus: LocalEventBus,\n private readonly logger: LoggerService,\n private client?: DefaultApiClient,\n private readonly auth?: AuthService,\n ) {}\n\n async publish(params: EventParams): Promise<void> {\n const lock = this.#getShutdownLock();\n try {\n const { notifiedSubscribers } = await this.localBus.publish(params);\n\n if (!this.client) {\n return;\n }\n const token = await this.#getToken();\n if (!token) {\n return;\n }\n const res = await this.client.postEvent(\n {\n body: {\n event: { payload: params.eventPayload, topic: params.topic },\n notifiedSubscribers,\n },\n },\n { token },\n );\n\n if (!res.ok) {\n if (res.status === 404) {\n this.logger.warn(\n `Event publish request failed with status 404, events backend not found. Future events will not be persisted.`,\n );\n delete this.client;\n return;\n }\n throw await ResponseError.fromResponse(res);\n }\n } finally {\n lock.release();\n }\n }\n\n async subscribe(options: EventsServiceSubscribeOptions): Promise<void> {\n const subscriptionId = `${this.pluginId}.${options.id}`;\n\n await this.localBus.subscribe({\n id: subscriptionId,\n topics: options.topics,\n onEvent: options.onEvent,\n });\n\n if (!this.client) {\n return;\n }\n const token = await this.#getToken();\n if (!token) {\n return;\n }\n const res = await this.client.putSubscription(\n {\n path: { subscriptionId },\n body: { topics: options.topics },\n },\n { token },\n );\n if (!res.ok) {\n if (res.status === 404) {\n this.logger.warn(\n `Event subscribe request failed with status 404, events backend not found. Will only receive events that were sent locally on this process.`,\n );\n delete this.client;\n return;\n }\n throw await ResponseError.fromResponse(res);\n }\n\n this.#startPolling(subscriptionId, options.topics, options.onEvent);\n }\n\n #startPolling(\n subscriptionId: string,\n topics: string[],\n onEvent: EventsServiceSubscribeOptions['onEvent'],\n ) {\n let backoffMs = POLL_BACKOFF_START_MS;\n const poll = async () => {\n if (!this.client) {\n return;\n }\n const lock = this.#getShutdownLock();\n try {\n const token = await this.#getToken();\n if (!token) {\n return;\n }\n const res = await this.client.getSubscriptionEvents(\n {\n path: { subscriptionId },\n },\n { token },\n );\n\n if (!res.ok) {\n if (res.status === 404) {\n this.logger.info(\n `Polling event subscription resulted in a 404, recreating subscription`,\n );\n const putRes = await this.client.putSubscription(\n {\n path: { subscriptionId },\n body: { topics },\n },\n { token },\n );\n if (!putRes.ok) {\n throw await ResponseError.fromResponse(res);\n }\n }\n throw await ResponseError.fromResponse(res);\n }\n backoffMs = POLL_BACKOFF_START_MS;\n\n // 202 means there were no immediately available events, but the\n // response will block until either new events are available or the\n // request times out. In both cases we should should try to read events\n // immediately again\n if (res.status === 202) {\n lock.release();\n await res.body?.getReader()?.closed;\n process.nextTick(poll);\n } else if (res.status === 200) {\n const data = await res.json();\n if (data) {\n for (const event of data.events ?? []) {\n try {\n await onEvent({\n topic: event.topic,\n eventPayload: event.payload,\n });\n } catch (error) {\n this.logger.warn(\n `Subscriber \"${subscriptionId}\" failed to process event for topic \"${event.topic}\"`,\n error,\n );\n }\n }\n }\n process.nextTick(poll);\n } else {\n this.logger.warn(\n `Unexpected response status ${res.status} from events backend for subscription \"${subscriptionId}\"`,\n );\n }\n } catch (error) {\n this.logger.warn(\n `Poll failed for subscription \"${subscriptionId}\", retrying in ${backoffMs.toFixed(\n 0,\n )}ms`,\n error,\n );\n setTimeout(poll, backoffMs);\n backoffMs = Math.min(\n backoffMs * POLL_BACKOFF_FACTOR,\n POLL_BACKOFF_MAX_MS,\n );\n } finally {\n lock.release();\n }\n };\n poll();\n }\n\n async #getToken() {\n if (!this.auth) {\n throw new Error('Auth service not available');\n }\n\n try {\n const { token } = await this.auth.getPluginRequestToken({\n onBehalfOf: await this.auth.getOwnServiceCredentials(),\n targetPluginId: 'events',\n });\n return token;\n } catch (error) {\n // This is a bit hacky, but handles the case where new auth is used\n // without legacy auth fallback, and the events backend is not installed\n if (String(error).includes('Unable to generate legacy token')) {\n this.logger.warn(\n `The events backend is not available and neither is legacy auth. Future events will not be persisted.`,\n );\n delete this.client;\n return undefined;\n }\n throw error;\n }\n }\n\n async shutdown() {\n this.#isShuttingDown = true;\n await Promise.all(this.#shutdownLocks);\n }\n\n #isShuttingDown = false;\n #shutdownLocks: Promise<void>[] = [];\n\n // This locking mechanism helps ensure that we are either idle or waiting for\n // a blocked events call before shutting down. It increases out changes of\n // never dropping any events on shutdown.\n #getShutdownLock(): { release(): void } {\n if (this.#isShuttingDown) {\n throw new Error('Service is shutting down');\n }\n\n let release: () => void;\n this.#shutdownLocks.push(\n new Promise<void>(resolve => {\n release = resolve;\n }),\n );\n return { release: release! };\n }\n}\n\n/**\n * In-process 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 * Events will not be passed to subscribers at other instances of the same cluster.\n *\n * @public\n */\n// TODO(pjungermann): add opentelemetry? (see plugins/catalog-backend/src/util/opentelemetry.ts, etc.)\nexport class DefaultEventsService implements EventsService {\n private constructor(\n private readonly logger: LoggerService,\n private readonly localBus: LocalEventBus,\n ) {}\n\n static create(options: { logger: LoggerService }): DefaultEventsService {\n return new DefaultEventsService(\n options.logger,\n new LocalEventBus(options.logger),\n );\n }\n\n /**\n * Returns a plugin-scoped context of the `EventService`\n * that ensures to prefix subscriber IDs with the plugin ID.\n *\n * @param pluginId - The plugin that the `EventService` should be created for.\n */\n forPlugin(\n pluginId: string,\n options?: {\n discovery: DiscoveryService;\n logger: LoggerService;\n auth: AuthService;\n lifecycle: LifecycleService;\n },\n ): EventsService {\n const client =\n options &&\n new DefaultApiClient({\n discoveryApi: options.discovery,\n fetchApi: { fetch }, // use native node fetch\n });\n const logger = options?.logger ?? this.logger;\n const service = new PluginEventsService(\n pluginId,\n this.localBus,\n logger,\n client,\n options?.auth,\n );\n options?.lifecycle.addShutdownHook(async () => {\n await service.shutdown();\n });\n return service;\n }\n\n async publish(params: EventParams): Promise<void> {\n await this.localBus.publish(params);\n }\n\n async subscribe(options: EventsServiceSubscribeOptions): Promise<void> {\n this.localBus.subscribe(options);\n }\n}\n"],"names":["ResponseError","DefaultApiClient"],"mappings":";;;;;AA2BA,MAAM,qBAAwB,GAAA,GAAA,CAAA;AAC9B,MAAM,mBAAsB,GAAA,GAAA,CAAA;AAC5B,MAAM,mBAAsB,GAAA,CAAA,CAAA;AAYrB,MAAM,aAAc,CAAA;AAAA,EAChB,OAAA,CAAA;AAAA,EAEA,YAAA,uBAAmB,GAG1B,EAAA,CAAA;AAAA,EAEF,YAAY,MAAuB,EAAA;AACjC,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AAAA,GACjB;AAAA,EAEA,MAAM,QACJ,MAC4C,EAAA;AAC5C,IAAA,IAAA,CAAK,OAAQ,CAAA,KAAA;AAAA,MACX,CAAyB,sBAAA,EAAA,MAAA,CAAO,KAAK,CAAA,WAAA,EAAc,IAAK,CAAA,SAAA;AAAA,QACtD,MAAO,CAAA,QAAA;AAAA,OACR,CAAa,UAAA,EAAA,IAAA,CAAK,SAAU,CAAA,MAAA,CAAO,YAAY,CAAC,CAAA,CAAA;AAAA,KACnD,CAAA;AAEA,IAAA,IAAI,CAAC,IAAK,CAAA,YAAA,CAAa,GAAI,CAAA,MAAA,CAAO,KAAK,CAAG,EAAA;AACxC,MAAO,OAAA,EAAE,mBAAqB,EAAA,EAAG,EAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAM,kBAAqC,EAAC,CAAA;AAC5C,IAAA,IAAA,CAAK,aAAa,GAAI,CAAA,MAAA,CAAO,KAAK,CAAA,EAAG,QAAQ,CAAgB,YAAA,KAAA;AAC3D,MAAgB,eAAA,CAAA,IAAA;AAAA,QAAA,CACb,YAAY;AACX,UAAI,IAAA;AACF,YAAM,MAAA,YAAA,CAAa,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAC1B,KAAO,EAAA;AACd,YAAA,IAAA,CAAK,OAAQ,CAAA,IAAA;AAAA,cACX,CAAe,YAAA,EAAA,YAAA,CAAa,EAAE,CAAA,qCAAA,EAAwC,OAAO,KAAK,CAAA,CAAA,CAAA;AAAA,cAClF,KAAA;AAAA,aACF,CAAA;AAAA,WACF;AACA,UAAA,OAAO,YAAa,CAAA,EAAA,CAAA;AAAA,SACnB,GAAA;AAAA,OACL,CAAA;AAAA,KACD,CAAA,CAAA;AAED,IAAA,OAAO,EAAE,mBAAqB,EAAA,MAAM,OAAQ,CAAA,GAAA,CAAI,eAAe,CAAE,EAAA,CAAA;AAAA,GACnE;AAAA,EAEA,MAAM,UAAU,OAAuD,EAAA;AACrE,IAAQ,OAAA,CAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAC9B,MAAA,IAAI,CAAC,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,KAAK,CAAG,EAAA;AACjC,QAAA,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,KAAO,EAAA,EAAE,CAAA,CAAA;AAAA,OACjC;AAEA,MAAA,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,KAAK,CAAA,CAAG,IAAK,CAAA;AAAA,QACjC,IAAI,OAAQ,CAAA,EAAA;AAAA,QACZ,SAAS,OAAQ,CAAA,OAAA;AAAA,OAClB,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF,CAAA;AAMA,MAAM,mBAA6C,CAAA;AAAA,EACjD,WACmB,CAAA,QAAA,EACA,QACA,EAAA,MAAA,EACT,QACS,IACjB,EAAA;AALiB,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACT,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACS,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA,CAAA;AAAA,GAChB;AAAA,EAEH,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAM,MAAA,IAAA,GAAO,KAAK,gBAAiB,EAAA,CAAA;AACnC,IAAI,IAAA;AACF,MAAA,MAAM,EAAE,mBAAoB,EAAA,GAAI,MAAM,IAAK,CAAA,QAAA,CAAS,QAAQ,MAAM,CAAA,CAAA;AAElE,MAAI,IAAA,CAAC,KAAK,MAAQ,EAAA;AAChB,QAAA,OAAA;AAAA,OACF;AACA,MAAM,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,SAAU,EAAA,CAAA;AACnC,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAA,OAAA;AAAA,OACF;AACA,MAAM,MAAA,GAAA,GAAM,MAAM,IAAA,CAAK,MAAO,CAAA,SAAA;AAAA,QAC5B;AAAA,UACE,IAAM,EAAA;AAAA,YACJ,OAAO,EAAE,OAAA,EAAS,OAAO,YAAc,EAAA,KAAA,EAAO,OAAO,KAAM,EAAA;AAAA,YAC3D,mBAAA;AAAA,WACF;AAAA,SACF;AAAA,QACA,EAAE,KAAM,EAAA;AAAA,OACV,CAAA;AAEA,MAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACX,QAAI,IAAA,GAAA,CAAI,WAAW,GAAK,EAAA;AACtB,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,YACV,CAAA,4GAAA,CAAA;AAAA,WACF,CAAA;AACA,UAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AACZ,UAAA,OAAA;AAAA,SACF;AACA,QAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA,CAAA;AAAA,OAC5C;AAAA,KACA,SAAA;AACA,MAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AAAA,KACf;AAAA,GACF;AAAA,EAEA,MAAM,UAAU,OAAuD,EAAA;AACrE,IAAA,MAAM,iBAAiB,CAAG,EAAA,IAAA,CAAK,QAAQ,CAAA,CAAA,EAAI,QAAQ,EAAE,CAAA,CAAA,CAAA;AAErD,IAAM,MAAA,IAAA,CAAK,SAAS,SAAU,CAAA;AAAA,MAC5B,EAAI,EAAA,cAAA;AAAA,MACJ,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,SAAS,OAAQ,CAAA,OAAA;AAAA,KAClB,CAAA,CAAA;AAED,IAAI,IAAA,CAAC,KAAK,MAAQ,EAAA;AAChB,MAAA,OAAA;AAAA,KACF;AACA,IAAM,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,SAAU,EAAA,CAAA;AACnC,IAAA,IAAI,CAAC,KAAO,EAAA;AACV,MAAA,OAAA;AAAA,KACF;AACA,IAAM,MAAA,GAAA,GAAM,MAAM,IAAA,CAAK,MAAO,CAAA,eAAA;AAAA,MAC5B;AAAA,QACE,IAAA,EAAM,EAAE,cAAe,EAAA;AAAA,QACvB,IAAM,EAAA,EAAE,MAAQ,EAAA,OAAA,CAAQ,MAAO,EAAA;AAAA,OACjC;AAAA,MACA,EAAE,KAAM,EAAA;AAAA,KACV,CAAA;AACA,IAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACX,MAAI,IAAA,GAAA,CAAI,WAAW,GAAK,EAAA;AACtB,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,CAAA,0IAAA,CAAA;AAAA,SACF,CAAA;AACA,QAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AACZ,QAAA,OAAA;AAAA,OACF;AACA,MAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA,CAAA;AAAA,KAC5C;AAEA,IAAA,IAAA,CAAK,aAAc,CAAA,cAAA,EAAgB,OAAQ,CAAA,MAAA,EAAQ,QAAQ,OAAO,CAAA,CAAA;AAAA,GACpE;AAAA,EAEA,aAAA,CACE,cACA,EAAA,MAAA,EACA,OACA,EAAA;AACA,IAAA,IAAI,SAAY,GAAA,qBAAA,CAAA;AAChB,IAAA,MAAM,OAAO,YAAY;AACvB,MAAI,IAAA,CAAC,KAAK,MAAQ,EAAA;AAChB,QAAA,OAAA;AAAA,OACF;AACA,MAAM,MAAA,IAAA,GAAO,KAAK,gBAAiB,EAAA,CAAA;AACnC,MAAI,IAAA;AACF,QAAM,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,SAAU,EAAA,CAAA;AACnC,QAAA,IAAI,CAAC,KAAO,EAAA;AACV,UAAA,OAAA;AAAA,SACF;AACA,QAAM,MAAA,GAAA,GAAM,MAAM,IAAA,CAAK,MAAO,CAAA,qBAAA;AAAA,UAC5B;AAAA,YACE,IAAA,EAAM,EAAE,cAAe,EAAA;AAAA,WACzB;AAAA,UACA,EAAE,KAAM,EAAA;AAAA,SACV,CAAA;AAEA,QAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACX,UAAI,IAAA,GAAA,CAAI,WAAW,GAAK,EAAA;AACtB,YAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,cACV,CAAA,qEAAA,CAAA;AAAA,aACF,CAAA;AACA,YAAM,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,MAAO,CAAA,eAAA;AAAA,cAC/B;AAAA,gBACE,IAAA,EAAM,EAAE,cAAe,EAAA;AAAA,gBACvB,IAAA,EAAM,EAAE,MAAO,EAAA;AAAA,eACjB;AAAA,cACA,EAAE,KAAM,EAAA;AAAA,aACV,CAAA;AACA,YAAI,IAAA,CAAC,OAAO,EAAI,EAAA;AACd,cAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA,CAAA;AAAA,aAC5C;AAAA,WACF;AACA,UAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA,CAAA;AAAA,SAC5C;AACA,QAAY,SAAA,GAAA,qBAAA,CAAA;AAMZ,QAAI,IAAA,GAAA,CAAI,WAAW,GAAK,EAAA;AACtB,UAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AACb,UAAM,MAAA,GAAA,CAAI,IAAM,EAAA,SAAA,EAAa,EAAA,MAAA,CAAA;AAC7B,UAAA,OAAA,CAAQ,SAAS,IAAI,CAAA,CAAA;AAAA,SACvB,MAAA,IAAW,GAAI,CAAA,MAAA,KAAW,GAAK,EAAA;AAC7B,UAAM,MAAA,IAAA,GAAO,MAAM,GAAA,CAAI,IAAK,EAAA,CAAA;AAC5B,UAAA,IAAI,IAAM,EAAA;AACR,YAAA,KAAA,MAAW,KAAS,IAAA,IAAA,CAAK,MAAU,IAAA,EAAI,EAAA;AACrC,cAAI,IAAA;AACF,gBAAA,MAAM,OAAQ,CAAA;AAAA,kBACZ,OAAO,KAAM,CAAA,KAAA;AAAA,kBACb,cAAc,KAAM,CAAA,OAAA;AAAA,iBACrB,CAAA,CAAA;AAAA,uBACM,KAAO,EAAA;AACd,gBAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,kBACV,CAAe,YAAA,EAAA,cAAc,CAAwC,qCAAA,EAAA,KAAA,CAAM,KAAK,CAAA,CAAA,CAAA;AAAA,kBAChF,KAAA;AAAA,iBACF,CAAA;AAAA,eACF;AAAA,aACF;AAAA,WACF;AACA,UAAA,OAAA,CAAQ,SAAS,IAAI,CAAA,CAAA;AAAA,SAChB,MAAA;AACL,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,YACV,CAA8B,2BAAA,EAAA,GAAA,CAAI,MAAM,CAAA,uCAAA,EAA0C,cAAc,CAAA,CAAA,CAAA;AAAA,WAClG,CAAA;AAAA,SACF;AAAA,eACO,KAAO,EAAA;AACd,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,CAAA,8BAAA,EAAiC,cAAc,CAAA,eAAA,EAAkB,SAAU,CAAA,OAAA;AAAA,YACzE,CAAA;AAAA,WACD,CAAA,EAAA,CAAA;AAAA,UACD,KAAA;AAAA,SACF,CAAA;AACA,QAAA,UAAA,CAAW,MAAM,SAAS,CAAA,CAAA;AAC1B,QAAA,SAAA,GAAY,IAAK,CAAA,GAAA;AAAA,UACf,SAAY,GAAA,mBAAA;AAAA,UACZ,mBAAA;AAAA,SACF,CAAA;AAAA,OACA,SAAA;AACA,QAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AAAA,OACf;AAAA,KACF,CAAA;AACA,IAAK,IAAA,EAAA,CAAA;AAAA,GACP;AAAA,EAEA,MAAM,SAAY,GAAA;AAChB,IAAI,IAAA,CAAC,KAAK,IAAM,EAAA;AACd,MAAM,MAAA,IAAI,MAAM,4BAA4B,CAAA,CAAA;AAAA,KAC9C;AAEA,IAAI,IAAA;AACF,MAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,QACtD,UAAY,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAAA,QACrD,cAAgB,EAAA,QAAA;AAAA,OACjB,CAAA,CAAA;AACD,MAAO,OAAA,KAAA,CAAA;AAAA,aACA,KAAO,EAAA;AAGd,MAAA,IAAI,MAAO,CAAA,KAAK,CAAE,CAAA,QAAA,CAAS,iCAAiC,CAAG,EAAA;AAC7D,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,CAAA,oGAAA,CAAA;AAAA,SACF,CAAA;AACA,QAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AACZ,QAAO,OAAA,KAAA,CAAA,CAAA;AAAA,OACT;AACA,MAAM,MAAA,KAAA,CAAA;AAAA,KACR;AAAA,GACF;AAAA,EAEA,MAAM,QAAW,GAAA;AACf,IAAA,IAAA,CAAK,eAAkB,GAAA,IAAA,CAAA;AACvB,IAAM,MAAA,OAAA,CAAQ,GAAI,CAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AAAA,GACvC;AAAA,EAEA,eAAkB,GAAA,KAAA,CAAA;AAAA,EAClB,iBAAkC,EAAC,CAAA;AAAA;AAAA;AAAA;AAAA,EAKnC,gBAAwC,GAAA;AACtC,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAM,MAAA,IAAI,MAAM,0BAA0B,CAAA,CAAA;AAAA,KAC5C;AAEA,IAAI,IAAA,OAAA,CAAA;AACJ,IAAA,IAAA,CAAK,cAAe,CAAA,IAAA;AAAA,MAClB,IAAI,QAAc,CAAW,OAAA,KAAA;AAC3B,QAAU,OAAA,GAAA,OAAA,CAAA;AAAA,OACX,CAAA;AAAA,KACH,CAAA;AACA,IAAA,OAAO,EAAE,OAAkB,EAAA,CAAA;AAAA,GAC7B;AACF,CAAA;AAWO,MAAM,oBAA8C,CAAA;AAAA,EACjD,WAAA,CACW,QACA,QACjB,EAAA;AAFiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AAAA,GAChB;AAAA,EAEH,OAAO,OAAO,OAA0D,EAAA;AACtE,IAAA,OAAO,IAAI,oBAAA;AAAA,MACT,OAAQ,CAAA,MAAA;AAAA,MACR,IAAI,aAAc,CAAA,OAAA,CAAQ,MAAM,CAAA;AAAA,KAClC,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,SAAA,CACE,UACA,OAMe,EAAA;AACf,IAAM,MAAA,MAAA,GACJ,OACA,IAAA,IAAIC,kCAAiB,CAAA;AAAA,MACnB,cAAc,OAAQ,CAAA,SAAA;AAAA,MACtB,QAAA,EAAU,EAAE,KAAM,EAAA;AAAA;AAAA,KACnB,CAAA,CAAA;AACH,IAAM,MAAA,MAAA,GAAS,OAAS,EAAA,MAAA,IAAU,IAAK,CAAA,MAAA,CAAA;AACvC,IAAA,MAAM,UAAU,IAAI,mBAAA;AAAA,MAClB,QAAA;AAAA,MACA,IAAK,CAAA,QAAA;AAAA,MACL,MAAA;AAAA,MACA,MAAA;AAAA,MACA,OAAS,EAAA,IAAA;AAAA,KACX,CAAA;AACA,IAAS,OAAA,EAAA,SAAA,CAAU,gBAAgB,YAAY;AAC7C,MAAA,MAAM,QAAQ,QAAS,EAAA,CAAA;AAAA,KACxB,CAAA,CAAA;AACD,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAM,MAAA,IAAA,CAAK,QAAS,CAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AAAA,GACpC;AAAA,EAEA,MAAM,UAAU,OAAuD,EAAA;AACrE,IAAK,IAAA,CAAA,QAAA,CAAS,UAAU,OAAO,CAAA,CAAA;AAAA,GACjC;AACF;;;;;"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
class EventRouter {
|
|
4
|
+
events;
|
|
5
|
+
topics;
|
|
6
|
+
subscribed = false;
|
|
7
|
+
constructor(options) {
|
|
8
|
+
this.events = options.events;
|
|
9
|
+
this.topics = options.topics;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Subscribes itself to the topic(s),
|
|
13
|
+
* after which events potentially can be received
|
|
14
|
+
* and processed by {@link EventRouter.onEvent}.
|
|
15
|
+
*/
|
|
16
|
+
async subscribe() {
|
|
17
|
+
if (this.subscribed) {
|
|
18
|
+
return;
|
|
19
|
+
}
|
|
20
|
+
this.subscribed = true;
|
|
21
|
+
await this.events.subscribe({
|
|
22
|
+
id: this.getSubscriberId(),
|
|
23
|
+
topics: this.topics,
|
|
24
|
+
onEvent: this.onEvent.bind(this)
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
async onEvent(params) {
|
|
28
|
+
const topic = this.determineDestinationTopic(params);
|
|
29
|
+
if (!topic) {
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
await this.events.publish({
|
|
33
|
+
...params,
|
|
34
|
+
topic
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
exports.EventRouter = EventRouter;
|
|
40
|
+
//# sourceMappingURL=EventRouter.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EventRouter.cjs.js","sources":["../../src/api/EventRouter.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 { EventParams } from './EventParams';\nimport { EventsService } from './EventsService';\n\n/**\n * Subscribes to a topic and - depending on a set of conditions -\n * republishes the event to another topic.\n *\n * @see {@link https://www.enterpriseintegrationpatterns.com/MessageRouter.html | Message Router pattern}.\n * @public\n */\nexport abstract class EventRouter {\n private readonly events: EventsService;\n private readonly topics: string[];\n private subscribed: boolean = false;\n\n protected constructor(options: { events: EventsService; topics: string[] }) {\n this.events = options.events;\n this.topics = options.topics;\n }\n\n protected abstract getSubscriberId(): string;\n\n protected abstract determineDestinationTopic(\n params: EventParams,\n ): string | undefined;\n\n /**\n * Subscribes itself to the topic(s),\n * after which events potentially can be received\n * and processed by {@link EventRouter.onEvent}.\n */\n async subscribe(): Promise<void> {\n if (this.subscribed) {\n return;\n }\n\n this.subscribed = true;\n\n await this.events.subscribe({\n id: this.getSubscriberId(),\n topics: this.topics,\n onEvent: this.onEvent.bind(this),\n });\n }\n\n async onEvent(params: EventParams): Promise<void> {\n const topic = this.determineDestinationTopic(params);\n\n if (!topic) {\n return;\n }\n\n // republish to different topic\n await this.events.publish({\n ...params,\n topic,\n });\n }\n}\n"],"names":[],"mappings":";;AA0BO,MAAe,WAAY,CAAA;AAAA,EACf,MAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACT,UAAsB,GAAA,KAAA,CAAA;AAAA,EAEpB,YAAY,OAAsD,EAAA;AAC1E,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,SAA2B,GAAA;AAC/B,IAAA,IAAI,KAAK,UAAY,EAAA;AACnB,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,IAAA,CAAK,UAAa,GAAA,IAAA,CAAA;AAElB,IAAM,MAAA,IAAA,CAAK,OAAO,SAAU,CAAA;AAAA,MAC1B,EAAA,EAAI,KAAK,eAAgB,EAAA;AAAA,MACzB,QAAQ,IAAK,CAAA,MAAA;AAAA,MACb,OAAS,EAAA,IAAA,CAAK,OAAQ,CAAA,IAAA,CAAK,IAAI,CAAA;AAAA,KAChC,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAM,MAAA,KAAA,GAAQ,IAAK,CAAA,yBAAA,CAA0B,MAAM,CAAA,CAAA;AAEnD,IAAA,IAAI,CAAC,KAAO,EAAA;AACV,MAAA,OAAA;AAAA,KACF;AAGA,IAAM,MAAA,IAAA,CAAK,OAAO,OAAQ,CAAA;AAAA,MACxB,GAAG,MAAA;AAAA,MACH,KAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF;;;;"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var EventRouter = require('./EventRouter.cjs.js');
|
|
4
|
+
|
|
5
|
+
class SubTopicEventRouter extends EventRouter.EventRouter {
|
|
6
|
+
constructor(options) {
|
|
7
|
+
super({
|
|
8
|
+
events: options.events,
|
|
9
|
+
topics: [options.topic]
|
|
10
|
+
});
|
|
11
|
+
}
|
|
12
|
+
determineDestinationTopic(params) {
|
|
13
|
+
const subTopic = this.determineSubTopic(params);
|
|
14
|
+
return subTopic ? `${params.topic}.${subTopic}` : void 0;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
exports.SubTopicEventRouter = SubTopicEventRouter;
|
|
19
|
+
//# sourceMappingURL=SubTopicEventRouter.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SubTopicEventRouter.cjs.js","sources":["../../src/api/SubTopicEventRouter.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 { EventParams } from './EventParams';\nimport { EventRouter } from './EventRouter';\nimport { EventsService } from './EventsService';\n\n/**\n * Subscribes to the provided (generic) topic\n * and publishes the events under the more concrete sub-topic\n * depending on the implemented logic for determining it.\n * Implementing classes might use information from `metadata`\n * and/or properties within the payload.\n *\n * @public\n */\nexport abstract class SubTopicEventRouter extends EventRouter {\n protected constructor(options: { events: EventsService; topic: string }) {\n super({\n events: options.events,\n topics: [options.topic],\n });\n }\n\n protected abstract determineSubTopic(params: EventParams): string | undefined;\n\n protected determineDestinationTopic(params: EventParams): string | undefined {\n const subTopic = this.determineSubTopic(params);\n return subTopic ? `${params.topic}.${subTopic}` : undefined;\n }\n}\n"],"names":["EventRouter"],"mappings":";;;;AA6BO,MAAe,4BAA4BA,uBAAY,CAAA;AAAA,EAClD,YAAY,OAAmD,EAAA;AACvE,IAAM,KAAA,CAAA;AAAA,MACJ,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,MAAA,EAAQ,CAAC,OAAA,CAAQ,KAAK,CAAA;AAAA,KACvB,CAAA,CAAA;AAAA,GACH;AAAA,EAIU,0BAA0B,MAAyC,EAAA;AAC3E,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA,CAAA;AAC9C,IAAA,OAAO,WAAW,CAAG,EAAA,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,QAAQ,CAAK,CAAA,GAAA,KAAA,CAAA,CAAA;AAAA,GACpD;AACF;;;;"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
4
|
+
|
|
5
|
+
const eventsExtensionPoint = backendPluginApi.createExtensionPoint({
|
|
6
|
+
id: "events"
|
|
7
|
+
});
|
|
8
|
+
|
|
9
|
+
exports.eventsExtensionPoint = eventsExtensionPoint;
|
|
10
|
+
//# sourceMappingURL=extensions.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport {\n EventBroker,\n EventPublisher,\n EventSubscriber,\n HttpPostIngressOptions,\n} from '@backstage/plugin-events-node';\n\n/**\n * @alpha\n */\nexport interface EventsExtensionPoint {\n /**\n * @deprecated use `eventsServiceRef` and `eventsServiceFactory` instead\n */\n setEventBroker(eventBroker: EventBroker): void;\n\n /**\n * @deprecated use `EventsService.publish` instead\n */\n addPublishers(\n ...publishers: Array<EventPublisher | Array<EventPublisher>>\n ): void;\n\n /**\n * @deprecated use `EventsService.subscribe` instead\n */\n addSubscribers(\n ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n ): void;\n\n addHttpPostIngress(options: HttpPostIngressOptions): void;\n}\n\n/**\n * @alpha\n */\nexport const eventsExtensionPoint = createExtensionPoint<EventsExtensionPoint>({\n id: 'events',\n});\n"],"names":["createExtensionPoint"],"mappings":";;;;AAqDO,MAAM,uBAAuBA,qCAA2C,CAAA;AAAA,EAC7E,EAAI,EAAA,QAAA;AACN,CAAC;;;;"}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var crossFetch = require('cross-fetch');
|
|
4
|
+
var pluginId = require('../pluginId.cjs.js');
|
|
5
|
+
var parser = require('uri-template');
|
|
6
|
+
|
|
7
|
+
function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
|
|
8
|
+
|
|
9
|
+
function _interopNamespaceCompat(e) {
|
|
10
|
+
if (e && typeof e === 'object' && 'default' in e) return e;
|
|
11
|
+
var n = Object.create(null);
|
|
12
|
+
if (e) {
|
|
13
|
+
Object.keys(e).forEach(function (k) {
|
|
14
|
+
if (k !== 'default') {
|
|
15
|
+
var d = Object.getOwnPropertyDescriptor(e, k);
|
|
16
|
+
Object.defineProperty(n, k, d.get ? d : {
|
|
17
|
+
enumerable: true,
|
|
18
|
+
get: function () { return e[k]; }
|
|
19
|
+
});
|
|
20
|
+
}
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
n.default = e;
|
|
24
|
+
return Object.freeze(n);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
var crossFetch__default = /*#__PURE__*/_interopDefaultCompat(crossFetch);
|
|
28
|
+
var parser__namespace = /*#__PURE__*/_interopNamespaceCompat(parser);
|
|
29
|
+
|
|
30
|
+
class DefaultApiClient {
|
|
31
|
+
discoveryApi;
|
|
32
|
+
fetchApi;
|
|
33
|
+
constructor(options) {
|
|
34
|
+
this.discoveryApi = options.discoveryApi;
|
|
35
|
+
this.fetchApi = options.fetchApi || { fetch: crossFetch__default.default };
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Get new events for the provided subscription
|
|
39
|
+
* @param subscriptionId
|
|
40
|
+
*/
|
|
41
|
+
async getSubscriptionEvents(request, options) {
|
|
42
|
+
const baseUrl = await this.discoveryApi.getBaseUrl(pluginId.pluginId);
|
|
43
|
+
const uriTemplate = `/bus/v1/subscriptions/{subscriptionId}/events`;
|
|
44
|
+
const uri = parser__namespace.parse(uriTemplate).expand({
|
|
45
|
+
subscriptionId: request.path.subscriptionId
|
|
46
|
+
});
|
|
47
|
+
return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
|
|
48
|
+
headers: {
|
|
49
|
+
"Content-Type": "application/json",
|
|
50
|
+
...options?.token && { Authorization: `Bearer ${options?.token}` }
|
|
51
|
+
},
|
|
52
|
+
method: "GET"
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Publish a new event
|
|
57
|
+
* @param postEventRequest
|
|
58
|
+
*/
|
|
59
|
+
async postEvent(request, options) {
|
|
60
|
+
const baseUrl = await this.discoveryApi.getBaseUrl(pluginId.pluginId);
|
|
61
|
+
const uriTemplate = `/bus/v1/events`;
|
|
62
|
+
const uri = parser__namespace.parse(uriTemplate).expand({});
|
|
63
|
+
return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
|
|
64
|
+
headers: {
|
|
65
|
+
"Content-Type": "application/json",
|
|
66
|
+
...options?.token && { Authorization: `Bearer ${options?.token}` }
|
|
67
|
+
},
|
|
68
|
+
method: "POST",
|
|
69
|
+
body: JSON.stringify(request.body)
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Ensures that the subscription exists with the provided configuration
|
|
74
|
+
* @param subscriptionId
|
|
75
|
+
* @param putSubscriptionRequest
|
|
76
|
+
*/
|
|
77
|
+
async putSubscription(request, options) {
|
|
78
|
+
const baseUrl = await this.discoveryApi.getBaseUrl(pluginId.pluginId);
|
|
79
|
+
const uriTemplate = `/bus/v1/subscriptions/{subscriptionId}`;
|
|
80
|
+
const uri = parser__namespace.parse(uriTemplate).expand({
|
|
81
|
+
subscriptionId: request.path.subscriptionId
|
|
82
|
+
});
|
|
83
|
+
return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
|
|
84
|
+
headers: {
|
|
85
|
+
"Content-Type": "application/json",
|
|
86
|
+
...options?.token && { Authorization: `Bearer ${options?.token}` }
|
|
87
|
+
},
|
|
88
|
+
method: "PUT",
|
|
89
|
+
body: JSON.stringify(request.body)
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
exports.DefaultApiClient = DefaultApiClient;
|
|
95
|
+
//# sourceMappingURL=DefaultApi.client.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DefaultApi.client.cjs.js","sources":["../../../src/generated/apis/DefaultApi.client.ts"],"sourcesContent":["/*\n * Copyright 2024 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\n// ******************************************************************\n// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *\n// ******************************************************************\nimport { DiscoveryApi } from '../types/discovery';\nimport { FetchApi } from '../types/fetch';\nimport crossFetch from 'cross-fetch';\nimport { pluginId } from '../pluginId';\nimport * as parser from 'uri-template';\n\nimport { GetSubscriptionEvents200Response } from '../models/GetSubscriptionEvents200Response.model';\nimport { PostEventRequest } from '../models/PostEventRequest.model';\nimport { PutSubscriptionRequest } from '../models/PutSubscriptionRequest.model';\n\n/**\n * Wraps the Response type to convey a type on the json call.\n *\n * @public\n */\nexport type TypedResponse<T> = Omit<Response, 'json'> & {\n json: () => Promise<T>;\n};\n\n/**\n * Options you can pass into a request for additional information.\n *\n * @public\n */\nexport interface RequestOptions {\n token?: string;\n}\n\n/**\n * no description\n */\nexport class DefaultApiClient {\n private readonly discoveryApi: DiscoveryApi;\n private readonly fetchApi: FetchApi;\n\n constructor(options: {\n discoveryApi: { getBaseUrl(pluginId: string): Promise<string> };\n fetchApi?: { fetch: typeof fetch };\n }) {\n this.discoveryApi = options.discoveryApi;\n this.fetchApi = options.fetchApi || { fetch: crossFetch };\n }\n\n /**\n * Get new events for the provided subscription\n * @param subscriptionId\n */\n public async getSubscriptionEvents(\n // @ts-ignore\n request: {\n path: {\n subscriptionId: string;\n };\n },\n options?: RequestOptions,\n ): Promise<TypedResponse<void | GetSubscriptionEvents200Response>> {\n const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);\n\n const uriTemplate = `/bus/v1/subscriptions/{subscriptionId}/events`;\n\n const uri = parser.parse(uriTemplate).expand({\n subscriptionId: request.path.subscriptionId,\n });\n\n return await this.fetchApi.fetch(`${baseUrl}${uri}`, {\n headers: {\n 'Content-Type': 'application/json',\n ...(options?.token && { Authorization: `Bearer ${options?.token}` }),\n },\n method: 'GET',\n });\n }\n\n /**\n * Publish a new event\n * @param postEventRequest\n */\n public async postEvent(\n // @ts-ignore\n request: {\n body: PostEventRequest;\n },\n options?: RequestOptions,\n ): Promise<TypedResponse<void>> {\n const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);\n\n const uriTemplate = `/bus/v1/events`;\n\n const uri = parser.parse(uriTemplate).expand({});\n\n return await this.fetchApi.fetch(`${baseUrl}${uri}`, {\n headers: {\n 'Content-Type': 'application/json',\n ...(options?.token && { Authorization: `Bearer ${options?.token}` }),\n },\n method: 'POST',\n body: JSON.stringify(request.body),\n });\n }\n\n /**\n * Ensures that the subscription exists with the provided configuration\n * @param subscriptionId\n * @param putSubscriptionRequest\n */\n public async putSubscription(\n // @ts-ignore\n request: {\n path: {\n subscriptionId: string;\n };\n body: PutSubscriptionRequest;\n },\n options?: RequestOptions,\n ): Promise<TypedResponse<void>> {\n const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);\n\n const uriTemplate = `/bus/v1/subscriptions/{subscriptionId}`;\n\n const uri = parser.parse(uriTemplate).expand({\n subscriptionId: request.path.subscriptionId,\n });\n\n return await this.fetchApi.fetch(`${baseUrl}${uri}`, {\n headers: {\n 'Content-Type': 'application/json',\n ...(options?.token && { Authorization: `Bearer ${options?.token}` }),\n },\n method: 'PUT',\n body: JSON.stringify(request.body),\n });\n }\n}\n"],"names":["crossFetch","pluginId","parser"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkDO,MAAM,gBAAiB,CAAA;AAAA,EACX,YAAA,CAAA;AAAA,EACA,QAAA,CAAA;AAAA,EAEjB,YAAY,OAGT,EAAA;AACD,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAA,IAAA,CAAK,QAAW,GAAA,OAAA,CAAQ,QAAY,IAAA,EAAE,OAAOA,2BAAW,EAAA,CAAA;AAAA,GAC1D;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAa,qBAEX,CAAA,OAAA,EAKA,OACiE,EAAA;AACjE,IAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAWC,iBAAQ,CAAA,CAAA;AAE3D,IAAA,MAAM,WAAc,GAAA,CAAA,6CAAA,CAAA,CAAA;AAEpB,IAAA,MAAM,GAAM,GAAAC,iBAAA,CAAO,KAAM,CAAA,WAAW,EAAE,MAAO,CAAA;AAAA,MAC3C,cAAA,EAAgB,QAAQ,IAAK,CAAA,cAAA;AAAA,KAC9B,CAAA,CAAA;AAED,IAAO,OAAA,MAAM,KAAK,QAAS,CAAA,KAAA,CAAM,GAAG,OAAO,CAAA,EAAG,GAAG,CAAI,CAAA,EAAA;AAAA,MACnD,OAAS,EAAA;AAAA,QACP,cAAgB,EAAA,kBAAA;AAAA,QAChB,GAAI,SAAS,KAAS,IAAA,EAAE,eAAe,CAAU,OAAA,EAAA,OAAA,EAAS,KAAK,CAAG,CAAA,EAAA;AAAA,OACpE;AAAA,MACA,MAAQ,EAAA,KAAA;AAAA,KACT,CAAA,CAAA;AAAA,GACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAa,SAEX,CAAA,OAAA,EAGA,OAC8B,EAAA;AAC9B,IAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAWD,iBAAQ,CAAA,CAAA;AAE3D,IAAA,MAAM,WAAc,GAAA,CAAA,cAAA,CAAA,CAAA;AAEpB,IAAA,MAAM,MAAMC,iBAAO,CAAA,KAAA,CAAM,WAAW,CAAE,CAAA,MAAA,CAAO,EAAE,CAAA,CAAA;AAE/C,IAAO,OAAA,MAAM,KAAK,QAAS,CAAA,KAAA,CAAM,GAAG,OAAO,CAAA,EAAG,GAAG,CAAI,CAAA,EAAA;AAAA,MACnD,OAAS,EAAA;AAAA,QACP,cAAgB,EAAA,kBAAA;AAAA,QAChB,GAAI,SAAS,KAAS,IAAA,EAAE,eAAe,CAAU,OAAA,EAAA,OAAA,EAAS,KAAK,CAAG,CAAA,EAAA;AAAA,OACpE;AAAA,MACA,MAAQ,EAAA,MAAA;AAAA,MACR,IAAM,EAAA,IAAA,CAAK,SAAU,CAAA,OAAA,CAAQ,IAAI,CAAA;AAAA,KAClC,CAAA,CAAA;AAAA,GACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,eAEX,CAAA,OAAA,EAMA,OAC8B,EAAA;AAC9B,IAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAWD,iBAAQ,CAAA,CAAA;AAE3D,IAAA,MAAM,WAAc,GAAA,CAAA,sCAAA,CAAA,CAAA;AAEpB,IAAA,MAAM,GAAM,GAAAC,iBAAA,CAAO,KAAM,CAAA,WAAW,EAAE,MAAO,CAAA;AAAA,MAC3C,cAAA,EAAgB,QAAQ,IAAK,CAAA,cAAA;AAAA,KAC9B,CAAA,CAAA;AAED,IAAO,OAAA,MAAM,KAAK,QAAS,CAAA,KAAA,CAAM,GAAG,OAAO,CAAA,EAAG,GAAG,CAAI,CAAA,EAAA;AAAA,MACnD,OAAS,EAAA;AAAA,QACP,cAAgB,EAAA,kBAAA;AAAA,QAChB,GAAI,SAAS,KAAS,IAAA,EAAE,eAAe,CAAU,OAAA,EAAA,OAAA,EAAS,KAAK,CAAG,CAAA,EAAA;AAAA,OACpE;AAAA,MACA,MAAQ,EAAA,KAAA;AAAA,MACR,IAAM,EAAA,IAAA,CAAK,SAAU,CAAA,OAAA,CAAQ,IAAI,CAAA;AAAA,KAClC,CAAA,CAAA;AAAA,GACH;AACF;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pluginId.cjs.js","sources":["../../src/generated/pluginId.ts"],"sourcesContent":["/*\n * Copyright 2024 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\nexport const pluginId = 'events';\n"],"names":[],"mappings":";;AAgBO,MAAM,QAAW,GAAA;;;;"}
|
package/dist/index.cjs.js
CHANGED
|
@@ -1,143 +1,15 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var EventRouter = require('./api/EventRouter.cjs.js');
|
|
4
|
+
var DefaultEventsService = require('./api/DefaultEventsService.cjs.js');
|
|
5
|
+
var SubTopicEventRouter = require('./api/SubTopicEventRouter.cjs.js');
|
|
6
|
+
var service = require('./service.cjs.js');
|
|
4
7
|
|
|
5
|
-
class EventRouter {
|
|
6
|
-
events;
|
|
7
|
-
topics;
|
|
8
|
-
subscribed = false;
|
|
9
|
-
constructor(options) {
|
|
10
|
-
this.events = options.events;
|
|
11
|
-
this.topics = options.topics;
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
|
-
* Subscribes itself to the topic(s),
|
|
15
|
-
* after which events potentially can be received
|
|
16
|
-
* and processed by {@link EventRouter.onEvent}.
|
|
17
|
-
*/
|
|
18
|
-
async subscribe() {
|
|
19
|
-
if (this.subscribed) {
|
|
20
|
-
return;
|
|
21
|
-
}
|
|
22
|
-
this.subscribed = true;
|
|
23
|
-
await this.events.subscribe({
|
|
24
|
-
id: this.getSubscriberId(),
|
|
25
|
-
topics: this.topics,
|
|
26
|
-
onEvent: this.onEvent.bind(this)
|
|
27
|
-
});
|
|
28
|
-
}
|
|
29
|
-
async onEvent(params) {
|
|
30
|
-
const topic = this.determineDestinationTopic(params);
|
|
31
|
-
if (!topic) {
|
|
32
|
-
return;
|
|
33
|
-
}
|
|
34
|
-
await this.events.publish({
|
|
35
|
-
...params,
|
|
36
|
-
topic
|
|
37
|
-
});
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
8
|
|
|
41
|
-
class DefaultEventsService {
|
|
42
|
-
constructor(logger) {
|
|
43
|
-
this.logger = logger;
|
|
44
|
-
}
|
|
45
|
-
subscribers = /* @__PURE__ */ new Map();
|
|
46
|
-
static create(options) {
|
|
47
|
-
return new DefaultEventsService(options.logger);
|
|
48
|
-
}
|
|
49
|
-
/**
|
|
50
|
-
* Returns a plugin-scoped context of the `EventService`
|
|
51
|
-
* that ensures to prefix subscriber IDs with the plugin ID.
|
|
52
|
-
*
|
|
53
|
-
* @param pluginId - The plugin that the `EventService` should be created for.
|
|
54
|
-
*/
|
|
55
|
-
forPlugin(pluginId) {
|
|
56
|
-
return {
|
|
57
|
-
publish: (params) => {
|
|
58
|
-
return this.publish(params);
|
|
59
|
-
},
|
|
60
|
-
subscribe: (options) => {
|
|
61
|
-
return this.subscribe({
|
|
62
|
-
...options,
|
|
63
|
-
id: `${pluginId}.${options.id}`
|
|
64
|
-
});
|
|
65
|
-
}
|
|
66
|
-
};
|
|
67
|
-
}
|
|
68
|
-
async publish(params) {
|
|
69
|
-
this.logger.debug(
|
|
70
|
-
`Event received: topic=${params.topic}, metadata=${JSON.stringify(
|
|
71
|
-
params.metadata
|
|
72
|
-
)}, payload=${JSON.stringify(params.eventPayload)}`
|
|
73
|
-
);
|
|
74
|
-
if (!this.subscribers.has(params.topic)) {
|
|
75
|
-
return;
|
|
76
|
-
}
|
|
77
|
-
const onEventPromises = [];
|
|
78
|
-
this.subscribers.get(params.topic)?.forEach((subscription) => {
|
|
79
|
-
onEventPromises.push(
|
|
80
|
-
(async () => {
|
|
81
|
-
try {
|
|
82
|
-
await subscription.onEvent(params);
|
|
83
|
-
} catch (error) {
|
|
84
|
-
this.logger.warn(
|
|
85
|
-
`Subscriber "${subscription.id}" failed to process event for topic "${params.topic}"`,
|
|
86
|
-
error
|
|
87
|
-
);
|
|
88
|
-
}
|
|
89
|
-
})()
|
|
90
|
-
);
|
|
91
|
-
});
|
|
92
|
-
await Promise.all(onEventPromises);
|
|
93
|
-
}
|
|
94
|
-
async subscribe(options) {
|
|
95
|
-
options.topics.forEach((topic) => {
|
|
96
|
-
if (!this.subscribers.has(topic)) {
|
|
97
|
-
this.subscribers.set(topic, []);
|
|
98
|
-
}
|
|
99
|
-
this.subscribers.get(topic).push({
|
|
100
|
-
id: options.id,
|
|
101
|
-
onEvent: options.onEvent
|
|
102
|
-
});
|
|
103
|
-
});
|
|
104
|
-
}
|
|
105
|
-
}
|
|
106
9
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
});
|
|
113
|
-
}
|
|
114
|
-
determineDestinationTopic(params) {
|
|
115
|
-
const subTopic = this.determineSubTopic(params);
|
|
116
|
-
return subTopic ? `${params.topic}.${subTopic}` : void 0;
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
const eventsServiceRef = backendPluginApi.createServiceRef({
|
|
121
|
-
id: "events.service",
|
|
122
|
-
scope: "plugin"
|
|
123
|
-
});
|
|
124
|
-
const eventsServiceFactory = backendPluginApi.createServiceFactory({
|
|
125
|
-
service: eventsServiceRef,
|
|
126
|
-
deps: {
|
|
127
|
-
pluginMetadata: backendPluginApi.coreServices.pluginMetadata,
|
|
128
|
-
rootLogger: backendPluginApi.coreServices.rootLogger
|
|
129
|
-
},
|
|
130
|
-
async createRootContext({ rootLogger }) {
|
|
131
|
-
return DefaultEventsService.create({ logger: rootLogger });
|
|
132
|
-
},
|
|
133
|
-
async factory({ pluginMetadata }, eventsService) {
|
|
134
|
-
return eventsService.forPlugin(pluginMetadata.getId());
|
|
135
|
-
}
|
|
136
|
-
});
|
|
137
|
-
|
|
138
|
-
exports.DefaultEventsService = DefaultEventsService;
|
|
139
|
-
exports.EventRouter = EventRouter;
|
|
140
|
-
exports.SubTopicEventRouter = SubTopicEventRouter;
|
|
141
|
-
exports.eventsServiceFactory = eventsServiceFactory;
|
|
142
|
-
exports.eventsServiceRef = eventsServiceRef;
|
|
10
|
+
exports.EventRouter = EventRouter.EventRouter;
|
|
11
|
+
exports.DefaultEventsService = DefaultEventsService.DefaultEventsService;
|
|
12
|
+
exports.SubTopicEventRouter = SubTopicEventRouter.SubTopicEventRouter;
|
|
13
|
+
exports.eventsServiceFactory = service.eventsServiceFactory;
|
|
14
|
+
exports.eventsServiceRef = service.eventsServiceRef;
|
|
143
15
|
//# sourceMappingURL=index.cjs.js.map
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/api/EventRouter.ts","../src/api/DefaultEventsService.ts","../src/api/SubTopicEventRouter.ts","../src/service.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 { EventParams } from './EventParams';\nimport { EventsService } from './EventsService';\n\n/**\n * Subscribes to a topic and - depending on a set of conditions -\n * republishes the event to another topic.\n *\n * @see {@link https://www.enterpriseintegrationpatterns.com/MessageRouter.html | Message Router pattern}.\n * @public\n */\nexport abstract class EventRouter {\n private readonly events: EventsService;\n private readonly topics: string[];\n private subscribed: boolean = false;\n\n protected constructor(options: { events: EventsService; topics: string[] }) {\n this.events = options.events;\n this.topics = options.topics;\n }\n\n protected abstract getSubscriberId(): string;\n\n protected abstract determineDestinationTopic(\n params: EventParams,\n ): string | undefined;\n\n /**\n * Subscribes itself to the topic(s),\n * after which events potentially can be received\n * and processed by {@link EventRouter.onEvent}.\n */\n async subscribe(): Promise<void> {\n if (this.subscribed) {\n return;\n }\n\n this.subscribed = true;\n\n await this.events.subscribe({\n id: this.getSubscriberId(),\n topics: this.topics,\n onEvent: this.onEvent.bind(this),\n });\n }\n\n async onEvent(params: EventParams): Promise<void> {\n const topic = this.determineDestinationTopic(params);\n\n if (!topic) {\n return;\n }\n\n // republish to different topic\n await this.events.publish({\n ...params,\n topic,\n });\n }\n}\n","/*\n * Copyright 2024 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 { LoggerService } from '@backstage/backend-plugin-api';\nimport { EventParams } from './EventParams';\nimport { EventsService, EventsServiceSubscribeOptions } from './EventsService';\n\n/**\n * In-process 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 * Events will not be passed to subscribers at other instances of the same cluster.\n *\n * @public\n */\n// TODO(pjungermann): add opentelemetry? (see plugins/catalog-backend/src/util/opentelemetry.ts, etc.)\nexport class DefaultEventsService implements EventsService {\n private readonly subscribers = new Map<\n string,\n Omit<EventsServiceSubscribeOptions, 'topics'>[]\n >();\n\n private constructor(private readonly logger: LoggerService) {}\n\n static create(options: { logger: LoggerService }): DefaultEventsService {\n return new DefaultEventsService(options.logger);\n }\n\n /**\n * Returns a plugin-scoped context of the `EventService`\n * that ensures to prefix subscriber IDs with the plugin ID.\n *\n * @param pluginId - The plugin that the `EventService` should be created for.\n */\n forPlugin(pluginId: string): EventsService {\n return {\n publish: (params: EventParams): Promise<void> => {\n return this.publish(params);\n },\n subscribe: (options: EventsServiceSubscribeOptions): Promise<void> => {\n return this.subscribe({\n ...options,\n id: `${pluginId}.${options.id}`,\n });\n },\n };\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 if (!this.subscribers.has(params.topic)) {\n return;\n }\n\n const onEventPromises: Promise<void>[] = [];\n this.subscribers.get(params.topic)?.forEach(subscription => {\n onEventPromises.push(\n (async () => {\n try {\n await subscription.onEvent(params);\n } catch (error) {\n this.logger.warn(\n `Subscriber \"${subscription.id}\" failed to process event for topic \"${params.topic}\"`,\n error,\n );\n }\n })(),\n );\n });\n\n await Promise.all(onEventPromises);\n }\n\n async subscribe(options: EventsServiceSubscribeOptions): Promise<void> {\n options.topics.forEach(topic => {\n if (!this.subscribers.has(topic)) {\n this.subscribers.set(topic, []);\n }\n\n this.subscribers.get(topic)!.push({\n id: options.id,\n onEvent: options.onEvent,\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 { EventParams } from './EventParams';\nimport { EventRouter } from './EventRouter';\nimport { EventsService } from './EventsService';\n\n/**\n * Subscribes to the provided (generic) topic\n * and publishes the events under the more concrete sub-topic\n * depending on the implemented logic for determining it.\n * Implementing classes might use information from `metadata`\n * and/or properties within the payload.\n *\n * @public\n */\nexport abstract class SubTopicEventRouter extends EventRouter {\n protected constructor(options: { events: EventsService; topic: string }) {\n super({\n events: options.events,\n topics: [options.topic],\n });\n }\n\n protected abstract determineSubTopic(params: EventParams): string | undefined;\n\n protected determineDestinationTopic(params: EventParams): string | undefined {\n const subTopic = this.determineSubTopic(params);\n return subTopic ? `${params.topic}.${subTopic}` : undefined;\n }\n}\n","/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n coreServices,\n createServiceFactory,\n createServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { EventsService, DefaultEventsService } from './api';\n\n/**\n * The {@link EventsService} that allows to publish events, and subscribe to topics.\n * Uses the `root` scope so that events can be shared across all plugins, modules, and more.\n *\n * @public\n */\nexport const eventsServiceRef = createServiceRef<EventsService>({\n id: 'events.service',\n scope: 'plugin',\n});\n\n/** @public */\nexport const eventsServiceFactory = createServiceFactory({\n service: eventsServiceRef,\n deps: {\n pluginMetadata: coreServices.pluginMetadata,\n rootLogger: coreServices.rootLogger,\n },\n async createRootContext({ rootLogger }) {\n return DefaultEventsService.create({ logger: rootLogger });\n },\n async factory({ pluginMetadata }, eventsService) {\n return eventsService.forPlugin(pluginMetadata.getId());\n },\n});\n"],"names":["createServiceRef","createServiceFactory","coreServices"],"mappings":";;;;AA0BO,MAAe,WAAY,CAAA;AAAA,EACf,MAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACT,UAAsB,GAAA,KAAA,CAAA;AAAA,EAEpB,YAAY,OAAsD,EAAA;AAC1E,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,SAA2B,GAAA;AAC/B,IAAA,IAAI,KAAK,UAAY,EAAA;AACnB,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,IAAA,CAAK,UAAa,GAAA,IAAA,CAAA;AAElB,IAAM,MAAA,IAAA,CAAK,OAAO,SAAU,CAAA;AAAA,MAC1B,EAAA,EAAI,KAAK,eAAgB,EAAA;AAAA,MACzB,QAAQ,IAAK,CAAA,MAAA;AAAA,MACb,OAAS,EAAA,IAAA,CAAK,OAAQ,CAAA,IAAA,CAAK,IAAI,CAAA;AAAA,KAChC,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAM,MAAA,KAAA,GAAQ,IAAK,CAAA,yBAAA,CAA0B,MAAM,CAAA,CAAA;AAEnD,IAAA,IAAI,CAAC,KAAO,EAAA;AACV,MAAA,OAAA;AAAA,KACF;AAGA,IAAM,MAAA,IAAA,CAAK,OAAO,OAAQ,CAAA;AAAA,MACxB,GAAG,MAAA;AAAA,MACH,KAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF;;AC7CO,MAAM,oBAA8C,CAAA;AAAA,EAMjD,YAA6B,MAAuB,EAAA;AAAvB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAAA,GAAwB;AAAA,EAL5C,WAAA,uBAAkB,GAGjC,EAAA,CAAA;AAAA,EAIF,OAAO,OAAO,OAA0D,EAAA;AACtE,IAAO,OAAA,IAAI,oBAAqB,CAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AAAA,GAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,QAAiC,EAAA;AACzC,IAAO,OAAA;AAAA,MACL,OAAA,EAAS,CAAC,MAAuC,KAAA;AAC/C,QAAO,OAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,OAC5B;AAAA,MACA,SAAA,EAAW,CAAC,OAA0D,KAAA;AACpE,QAAA,OAAO,KAAK,SAAU,CAAA;AAAA,UACpB,GAAG,OAAA;AAAA,UACH,EAAI,EAAA,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,QAAQ,EAAE,CAAA,CAAA;AAAA,SAC9B,CAAA,CAAA;AAAA,OACH;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAyB,sBAAA,EAAA,MAAA,CAAO,KAAK,CAAA,WAAA,EAAc,IAAK,CAAA,SAAA;AAAA,QACtD,MAAO,CAAA,QAAA;AAAA,OACR,CAAa,UAAA,EAAA,IAAA,CAAK,SAAU,CAAA,MAAA,CAAO,YAAY,CAAC,CAAA,CAAA;AAAA,KACnD,CAAA;AAEA,IAAA,IAAI,CAAC,IAAK,CAAA,WAAA,CAAY,GAAI,CAAA,MAAA,CAAO,KAAK,CAAG,EAAA;AACvC,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,MAAM,kBAAmC,EAAC,CAAA;AAC1C,IAAA,IAAA,CAAK,YAAY,GAAI,CAAA,MAAA,CAAO,KAAK,CAAA,EAAG,QAAQ,CAAgB,YAAA,KAAA;AAC1D,MAAgB,eAAA,CAAA,IAAA;AAAA,QAAA,CACb,YAAY;AACX,UAAI,IAAA;AACF,YAAM,MAAA,YAAA,CAAa,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAC1B,KAAO,EAAA;AACd,YAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,cACV,CAAe,YAAA,EAAA,YAAA,CAAa,EAAE,CAAA,qCAAA,EAAwC,OAAO,KAAK,CAAA,CAAA,CAAA;AAAA,cAClF,KAAA;AAAA,aACF,CAAA;AAAA,WACF;AAAA,SACC,GAAA;AAAA,OACL,CAAA;AAAA,KACD,CAAA,CAAA;AAED,IAAM,MAAA,OAAA,CAAQ,IAAI,eAAe,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,MAAM,UAAU,OAAuD,EAAA;AACrE,IAAQ,OAAA,CAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAC9B,MAAA,IAAI,CAAC,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,KAAK,CAAG,EAAA;AAChC,QAAA,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,KAAO,EAAA,EAAE,CAAA,CAAA;AAAA,OAChC;AAEA,MAAA,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,KAAK,CAAA,CAAG,IAAK,CAAA;AAAA,QAChC,IAAI,OAAQ,CAAA,EAAA;AAAA,QACZ,SAAS,OAAQ,CAAA,OAAA;AAAA,OAClB,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;AC1EO,MAAe,4BAA4B,WAAY,CAAA;AAAA,EAClD,YAAY,OAAmD,EAAA;AACvE,IAAM,KAAA,CAAA;AAAA,MACJ,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,MAAA,EAAQ,CAAC,OAAA,CAAQ,KAAK,CAAA;AAAA,KACvB,CAAA,CAAA;AAAA,GACH;AAAA,EAIU,0BAA0B,MAAyC,EAAA;AAC3E,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA,CAAA;AAC9C,IAAA,OAAO,WAAW,CAAG,EAAA,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,QAAQ,CAAK,CAAA,GAAA,KAAA,CAAA,CAAA;AAAA,GACpD;AACF;;ACdO,MAAM,mBAAmBA,iCAAgC,CAAA;AAAA,EAC9D,EAAI,EAAA,gBAAA;AAAA,EACJ,KAAO,EAAA,QAAA;AACT,CAAC,EAAA;AAGM,MAAM,uBAAuBC,qCAAqB,CAAA;AAAA,EACvD,OAAS,EAAA,gBAAA;AAAA,EACT,IAAM,EAAA;AAAA,IACJ,gBAAgBC,6BAAa,CAAA,cAAA;AAAA,IAC7B,YAAYA,6BAAa,CAAA,UAAA;AAAA,GAC3B;AAAA,EACA,MAAM,iBAAA,CAAkB,EAAE,UAAA,EAAc,EAAA;AACtC,IAAA,OAAO,oBAAqB,CAAA,MAAA,CAAO,EAAE,MAAA,EAAQ,YAAY,CAAA,CAAA;AAAA,GAC3D;AAAA,EACA,MAAM,OAAA,CAAQ,EAAE,cAAA,IAAkB,aAAe,EAAA;AAC/C,IAAA,OAAO,aAAc,CAAA,SAAA,CAAU,cAAe,CAAA,KAAA,EAAO,CAAA,CAAA;AAAA,GACvD;AACF,CAAC;;;;;;;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
2
|
-
import { LoggerService } from '@backstage/backend-plugin-api';
|
|
2
|
+
import { LoggerService, DiscoveryService, AuthService, LifecycleService } from '@backstage/backend-plugin-api';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* @public
|
|
@@ -92,7 +92,7 @@ declare abstract class EventRouter {
|
|
|
92
92
|
*/
|
|
93
93
|
declare class DefaultEventsService implements EventsService {
|
|
94
94
|
private readonly logger;
|
|
95
|
-
private readonly
|
|
95
|
+
private readonly localBus;
|
|
96
96
|
private constructor();
|
|
97
97
|
static create(options: {
|
|
98
98
|
logger: LoggerService;
|
|
@@ -103,7 +103,12 @@ declare class DefaultEventsService implements EventsService {
|
|
|
103
103
|
*
|
|
104
104
|
* @param pluginId - The plugin that the `EventService` should be created for.
|
|
105
105
|
*/
|
|
106
|
-
forPlugin(pluginId: string
|
|
106
|
+
forPlugin(pluginId: string, options?: {
|
|
107
|
+
discovery: DiscoveryService;
|
|
108
|
+
logger: LoggerService;
|
|
109
|
+
auth: AuthService;
|
|
110
|
+
lifecycle: LifecycleService;
|
|
111
|
+
}): EventsService;
|
|
107
112
|
publish(params: EventParams): Promise<void>;
|
|
108
113
|
subscribe(options: EventsServiceSubscribeOptions): Promise<void>;
|
|
109
114
|
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
4
|
+
var DefaultEventsService = require('./api/DefaultEventsService.cjs.js');
|
|
5
|
+
|
|
6
|
+
const eventsServiceRef = backendPluginApi.createServiceRef({
|
|
7
|
+
id: "events.service",
|
|
8
|
+
scope: "plugin"
|
|
9
|
+
});
|
|
10
|
+
const eventsServiceFactory = backendPluginApi.createServiceFactory({
|
|
11
|
+
service: eventsServiceRef,
|
|
12
|
+
deps: {
|
|
13
|
+
pluginMetadata: backendPluginApi.coreServices.pluginMetadata,
|
|
14
|
+
rootLogger: backendPluginApi.coreServices.rootLogger,
|
|
15
|
+
discovery: backendPluginApi.coreServices.discovery,
|
|
16
|
+
logger: backendPluginApi.coreServices.logger,
|
|
17
|
+
lifecycle: backendPluginApi.coreServices.lifecycle,
|
|
18
|
+
auth: backendPluginApi.coreServices.auth
|
|
19
|
+
},
|
|
20
|
+
async createRootContext({ rootLogger }) {
|
|
21
|
+
return DefaultEventsService.DefaultEventsService.create({ logger: rootLogger });
|
|
22
|
+
},
|
|
23
|
+
async factory({ pluginMetadata, discovery, logger, lifecycle, auth }, eventsService) {
|
|
24
|
+
return eventsService.forPlugin(pluginMetadata.getId(), {
|
|
25
|
+
discovery,
|
|
26
|
+
logger,
|
|
27
|
+
lifecycle,
|
|
28
|
+
auth
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
exports.eventsServiceFactory = eventsServiceFactory;
|
|
34
|
+
exports.eventsServiceRef = eventsServiceRef;
|
|
35
|
+
//# sourceMappingURL=service.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"service.cjs.js","sources":["../src/service.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n coreServices,\n createServiceFactory,\n createServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { EventsService, DefaultEventsService } from './api';\n\n/**\n * The {@link EventsService} that allows to publish events, and subscribe to topics.\n * Uses the `root` scope so that events can be shared across all plugins, modules, and more.\n *\n * @public\n */\nexport const eventsServiceRef = createServiceRef<EventsService>({\n id: 'events.service',\n scope: 'plugin',\n});\n\n/** @public */\nexport const eventsServiceFactory = createServiceFactory({\n service: eventsServiceRef,\n deps: {\n pluginMetadata: coreServices.pluginMetadata,\n rootLogger: coreServices.rootLogger,\n discovery: coreServices.discovery,\n logger: coreServices.logger,\n lifecycle: coreServices.lifecycle,\n auth: coreServices.auth,\n },\n async createRootContext({ rootLogger }) {\n return DefaultEventsService.create({ logger: rootLogger });\n },\n async factory(\n { pluginMetadata, discovery, logger, lifecycle, auth },\n eventsService,\n ) {\n return eventsService.forPlugin(pluginMetadata.getId(), {\n discovery,\n logger,\n lifecycle,\n auth,\n });\n },\n});\n"],"names":["createServiceRef","createServiceFactory","coreServices","DefaultEventsService"],"mappings":";;;;;AA6BO,MAAM,mBAAmBA,iCAAgC,CAAA;AAAA,EAC9D,EAAI,EAAA,gBAAA;AAAA,EACJ,KAAO,EAAA,QAAA;AACT,CAAC,EAAA;AAGM,MAAM,uBAAuBC,qCAAqB,CAAA;AAAA,EACvD,OAAS,EAAA,gBAAA;AAAA,EACT,IAAM,EAAA;AAAA,IACJ,gBAAgBC,6BAAa,CAAA,cAAA;AAAA,IAC7B,YAAYA,6BAAa,CAAA,UAAA;AAAA,IACzB,WAAWA,6BAAa,CAAA,SAAA;AAAA,IACxB,QAAQA,6BAAa,CAAA,MAAA;AAAA,IACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,IACxB,MAAMA,6BAAa,CAAA,IAAA;AAAA,GACrB;AAAA,EACA,MAAM,iBAAA,CAAkB,EAAE,UAAA,EAAc,EAAA;AACtC,IAAA,OAAOC,yCAAqB,CAAA,MAAA,CAAO,EAAE,MAAA,EAAQ,YAAY,CAAA,CAAA;AAAA,GAC3D;AAAA,EACA,MAAM,QACJ,EAAE,cAAA,EAAgB,WAAW,MAAQ,EAAA,SAAA,EAAW,IAAK,EAAA,EACrD,aACA,EAAA;AACA,IAAA,OAAO,aAAc,CAAA,SAAA,CAAU,cAAe,CAAA,KAAA,EAAS,EAAA;AAAA,MACrD,SAAA;AAAA,MACA,MAAA;AAAA,MACA,SAAA;AAAA,MACA,IAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-events-node",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.1-next.1",
|
|
4
4
|
"description": "The plugin-events-node module for @backstage/plugin-events-backend",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "node-library",
|
|
@@ -50,11 +50,15 @@
|
|
|
50
50
|
"test": "backstage-cli package test"
|
|
51
51
|
},
|
|
52
52
|
"dependencies": {
|
|
53
|
-
"@backstage/backend-plugin-api": "
|
|
53
|
+
"@backstage/backend-plugin-api": "1.0.1-next.1",
|
|
54
|
+
"@backstage/errors": "1.2.4",
|
|
55
|
+
"@backstage/types": "1.1.1",
|
|
56
|
+
"cross-fetch": "^4.0.0",
|
|
57
|
+
"uri-template": "^2.0.0"
|
|
54
58
|
},
|
|
55
59
|
"devDependencies": {
|
|
56
60
|
"@backstage/backend-common": "^0.25.0",
|
|
57
|
-
"@backstage/backend-test-utils": "
|
|
58
|
-
"@backstage/cli": "
|
|
61
|
+
"@backstage/backend-test-utils": "1.0.1-next.2",
|
|
62
|
+
"@backstage/cli": "0.28.0-next.2"
|
|
59
63
|
}
|
|
60
64
|
}
|