@backstage/plugin-events-backend 0.3.13-next.1 → 0.3.14
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 +28 -0
- package/README.md +1 -1
- package/alpha/package.json +1 -1
- package/dist/alpha.cjs.js +2 -2
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/alpha.d.ts +3 -7
- package/dist/index.cjs.js +4 -0
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +10 -2
- package/dist/service/EventsPlugin.cjs.js.map +1 -1
- package/package.json +14 -13
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,33 @@
|
|
|
1
1
|
# @backstage/plugin-events-backend
|
|
2
2
|
|
|
3
|
+
## 0.3.14
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/plugin-events-node@0.4.2
|
|
9
|
+
- @backstage/backend-plugin-api@1.0.1
|
|
10
|
+
|
|
11
|
+
## 0.3.13
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- 094eaa3: Remove references to in-repo backend-common
|
|
16
|
+
- 3109c24: The export for the new backend system at the `/alpha` export is now also available via the main entry point, which means that you can remove the `/alpha` suffix from the import.
|
|
17
|
+
- 5c728ee: The events backend now has its own built-in event bus for distributing events across multiple backend instances. It exposes a new HTTP API under `/bus/v1/` for publishing and reading events from the bus, as well as its own storage and notification mechanism for events.
|
|
18
|
+
|
|
19
|
+
The backing event store for the bus only supports scaled deployment if PostgreSQL is used as the DBMS. If SQLite or MySQL is used, the event bus will fall back to an in-memory store that does not support multiple backend instances.
|
|
20
|
+
|
|
21
|
+
The default `EventsService` implementation from `@backstage/plugin-events-node` has also been updated to use the new events bus.
|
|
22
|
+
|
|
23
|
+
- Updated dependencies
|
|
24
|
+
- @backstage/plugin-events-node@0.4.1
|
|
25
|
+
- @backstage/backend-openapi-utils@0.2.0
|
|
26
|
+
- @backstage/backend-plugin-api@1.0.1
|
|
27
|
+
- @backstage/config@1.2.0
|
|
28
|
+
- @backstage/errors@1.2.4
|
|
29
|
+
- @backstage/types@1.1.1
|
|
30
|
+
|
|
3
31
|
## 0.3.13-next.1
|
|
4
32
|
|
|
5
33
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -23,7 +23,7 @@ yarn --cwd packages/backend add @backstage/plugin-events-backend
|
|
|
23
23
|
|
|
24
24
|
```ts
|
|
25
25
|
// packages/backend/src/index.ts
|
|
26
|
-
backend.add(import('@backstage/plugin-events-backend
|
|
26
|
+
backend.add(import('@backstage/plugin-events-backend'));
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
### Legacy Backend System
|
package/alpha/package.json
CHANGED
package/dist/alpha.cjs.js
CHANGED
|
@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
|
|
|
4
4
|
|
|
5
5
|
var EventsPlugin = require('./service/EventsPlugin.cjs.js');
|
|
6
6
|
|
|
7
|
+
const _feature = EventsPlugin.eventsPlugin;
|
|
7
8
|
|
|
8
|
-
|
|
9
|
-
exports.default = EventsPlugin.eventsPlugin;
|
|
9
|
+
exports.default = _feature;
|
|
10
10
|
//# sourceMappingURL=alpha.cjs.js.map
|
package/dist/alpha.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alpha.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 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 { eventsPlugin } from './service/EventsPlugin';\n\n/** @alpha */\nconst _feature = eventsPlugin;\nexport default _feature;\n"],"names":["eventsPlugin"],"mappings":";;;;;;AAmBA,MAAM,QAAW,GAAAA;;;;"}
|
package/dist/alpha.d.ts
CHANGED
|
@@ -1,10 +1,6 @@
|
|
|
1
1
|
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
2
2
|
|
|
3
|
-
/**
|
|
4
|
-
|
|
5
|
-
*
|
|
6
|
-
* @alpha
|
|
7
|
-
*/
|
|
8
|
-
declare const eventsPlugin: _backstage_backend_plugin_api.BackendFeature;
|
|
3
|
+
/** @alpha */
|
|
4
|
+
declare const _feature: _backstage_backend_plugin_api.BackendFeature;
|
|
9
5
|
|
|
10
|
-
export {
|
|
6
|
+
export { _feature as default };
|
package/dist/index.cjs.js
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var EventsPlugin = require('./service/EventsPlugin.cjs.js');
|
|
3
6
|
var EventsBackend = require('./service/EventsBackend.cjs.js');
|
|
4
7
|
var DefaultEventBroker = require('./service/DefaultEventBroker.cjs.js');
|
|
5
8
|
var HttpPostIngressEventPublisher = require('./service/http/HttpPostIngressEventPublisher.cjs.js');
|
|
6
9
|
|
|
7
10
|
|
|
8
11
|
|
|
12
|
+
exports.default = EventsPlugin.eventsPlugin;
|
|
9
13
|
exports.EventsBackend = EventsBackend.EventsBackend;
|
|
10
14
|
exports.DefaultEventBroker = DefaultEventBroker.DefaultEventBroker;
|
|
11
15
|
exports.HttpPostIngressEventPublisher = HttpPostIngressEventPublisher.HttpPostIngressEventPublisher;
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,17 @@
|
|
|
1
|
+
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
2
|
+
import { LoggerService } from '@backstage/backend-plugin-api';
|
|
1
3
|
import { EventBroker, EventPublisher, EventSubscriber, EventsService, EventParams, HttpPostIngressOptions } from '@backstage/plugin-events-node';
|
|
2
4
|
import { Logger } from 'winston';
|
|
3
|
-
import { LoggerService } from '@backstage/backend-plugin-api';
|
|
4
5
|
import { Config } from '@backstage/config';
|
|
5
6
|
import express from 'express';
|
|
6
7
|
|
|
8
|
+
/**
|
|
9
|
+
* Events plugin
|
|
10
|
+
*
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
declare const eventsPlugin: _backstage_backend_plugin_api.BackendFeature;
|
|
14
|
+
|
|
7
15
|
/**
|
|
8
16
|
* A builder that helps wire up all component parts of the event management.
|
|
9
17
|
*
|
|
@@ -70,4 +78,4 @@ declare class HttpPostIngressEventPublisher {
|
|
|
70
78
|
private addRouteForTopic;
|
|
71
79
|
}
|
|
72
80
|
|
|
73
|
-
export { DefaultEventBroker, EventsBackend, HttpPostIngressEventPublisher };
|
|
81
|
+
export { DefaultEventBroker, EventsBackend, HttpPostIngressEventPublisher, eventsPlugin as default };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EventsPlugin.cjs.js","sources":["../../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 createBackendPlugin,\n coreServices,\n} from '@backstage/backend-plugin-api';\nimport {\n eventsExtensionPoint,\n EventsExtensionPoint,\n} from '@backstage/plugin-events-node/alpha';\nimport {\n eventsServiceRef,\n HttpPostIngressOptions,\n} from '@backstage/plugin-events-node';\nimport Router from 'express-promise-router';\nimport { HttpPostIngressEventPublisher } from './http';\nimport { createEventBusRouter } from './hub';\n\nclass EventsExtensionPointImpl implements EventsExtensionPoint {\n #httpPostIngresses: HttpPostIngressOptions[] = [];\n\n setEventBroker(_: any): void {\n throw new Error(\n 'setEventBroker is not supported anymore; use eventsServiceRef instead',\n );\n }\n\n addPublishers(_: any): void {\n throw new Error(\n 'addPublishers is not supported anymore; use EventsService instead',\n );\n }\n\n addSubscribers(_: any): void {\n throw new Error(\n 'addSubscribers is not supported anymore; use EventsService instead',\n );\n }\n\n addHttpPostIngress(options: HttpPostIngressOptions) {\n this.#httpPostIngresses.push(options);\n }\n\n get httpPostIngresses() {\n return this.#httpPostIngresses;\n }\n}\n\n/**\n * Events plugin\n *\n * @
|
|
1
|
+
{"version":3,"file":"EventsPlugin.cjs.js","sources":["../../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 createBackendPlugin,\n coreServices,\n} from '@backstage/backend-plugin-api';\nimport {\n eventsExtensionPoint,\n EventsExtensionPoint,\n} from '@backstage/plugin-events-node/alpha';\nimport {\n eventsServiceRef,\n HttpPostIngressOptions,\n} from '@backstage/plugin-events-node';\nimport Router from 'express-promise-router';\nimport { HttpPostIngressEventPublisher } from './http';\nimport { createEventBusRouter } from './hub';\n\nclass EventsExtensionPointImpl implements EventsExtensionPoint {\n #httpPostIngresses: HttpPostIngressOptions[] = [];\n\n setEventBroker(_: any): void {\n throw new Error(\n 'setEventBroker is not supported anymore; use eventsServiceRef instead',\n );\n }\n\n addPublishers(_: any): void {\n throw new Error(\n 'addPublishers is not supported anymore; use EventsService instead',\n );\n }\n\n addSubscribers(_: any): void {\n throw new Error(\n 'addSubscribers is not supported anymore; use EventsService instead',\n );\n }\n\n addHttpPostIngress(options: HttpPostIngressOptions) {\n this.#httpPostIngresses.push(options);\n }\n\n get httpPostIngresses() {\n return this.#httpPostIngresses;\n }\n}\n\n/**\n * Events plugin\n *\n * @public\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.rootConfig,\n events: eventsServiceRef,\n database: coreServices.database,\n logger: coreServices.logger,\n scheduler: coreServices.scheduler,\n lifecycle: coreServices.lifecycle,\n httpAuth: coreServices.httpAuth,\n router: coreServices.httpRouter,\n },\n async init({\n config,\n events,\n database,\n logger,\n scheduler,\n lifecycle,\n httpAuth,\n router,\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 events,\n ingresses,\n logger,\n });\n const eventsRouter = Router();\n http.bind(eventsRouter);\n\n router.use(\n await createEventBusRouter({\n database,\n logger,\n httpAuth,\n scheduler,\n lifecycle,\n }),\n );\n\n router.use(eventsRouter);\n router.addAuthPolicy({\n allow: 'unauthenticated',\n path: '/http',\n });\n },\n });\n },\n});\n"],"names":["createBackendPlugin","eventsExtensionPoint","coreServices","eventsServiceRef","HttpPostIngressEventPublisher","Router","createEventBusRouter"],"mappings":";;;;;;;;;;;;;AAgCA,MAAM,wBAAyD,CAAA;AAAA,EAC7D,qBAA+C,EAAC,CAAA;AAAA,EAEhD,eAAe,CAAc,EAAA;AAC3B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uEAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEA,cAAc,CAAc,EAAA;AAC1B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,mEAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEA,eAAe,CAAc,EAAA;AAC3B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,oEAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEA,mBAAmB,OAAiC,EAAA;AAClD,IAAK,IAAA,CAAA,kBAAA,CAAmB,KAAK,OAAO,CAAA,CAAA;AAAA,GACtC;AAAA,EAEA,IAAI,iBAAoB,GAAA;AACtB,IAAA,OAAO,IAAK,CAAA,kBAAA,CAAA;AAAA,GACd;AACF,CAAA;AAOO,MAAM,eAAeA,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,UAAA;AAAA,QACrB,MAAQ,EAAAC,iCAAA;AAAA,QACR,UAAUD,6BAAa,CAAA,QAAA;AAAA,QACvB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,QAAQA,6BAAa,CAAA,UAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,QAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA;AAAA,QACA,MAAA;AAAA,OACC,EAAA;AACD,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,GAAOE,4DAA8B,UAAW,CAAA;AAAA,UACpD,MAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA,MAAA;AAAA,SACD,CAAA,CAAA;AACD,QAAA,MAAM,eAAeC,uBAAO,EAAA,CAAA;AAC5B,QAAA,IAAA,CAAK,KAAK,YAAY,CAAA,CAAA;AAEtB,QAAO,MAAA,CAAA,GAAA;AAAA,UACL,MAAMC,yCAAqB,CAAA;AAAA,YACzB,QAAA;AAAA,YACA,MAAA;AAAA,YACA,QAAA;AAAA,YACA,SAAA;AAAA,YACA,SAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAEA,QAAA,MAAA,CAAO,IAAI,YAAY,CAAA,CAAA;AACvB,QAAA,MAAA,CAAO,aAAc,CAAA;AAAA,UACnB,KAAO,EAAA,iBAAA;AAAA,UACP,IAAM,EAAA,OAAA;AAAA,SACP,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-events-backend",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.14",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "backend-plugin",
|
|
6
6
|
"pluginId": "events",
|
|
@@ -22,6 +22,7 @@
|
|
|
22
22
|
"license": "Apache-2.0",
|
|
23
23
|
"exports": {
|
|
24
24
|
".": {
|
|
25
|
+
"backstage": "@backstage/BackendFeature",
|
|
25
26
|
"require": "./dist/index.cjs.js",
|
|
26
27
|
"types": "./dist/index.d.ts",
|
|
27
28
|
"default": "./dist/index.cjs.js"
|
|
@@ -54,12 +55,12 @@
|
|
|
54
55
|
},
|
|
55
56
|
"dependencies": {
|
|
56
57
|
"@backstage/backend-common": "^0.25.0",
|
|
57
|
-
"@backstage/backend-openapi-utils": "0.2.0
|
|
58
|
-
"@backstage/backend-plugin-api": "1.0.1
|
|
59
|
-
"@backstage/config": "1.2.0",
|
|
60
|
-
"@backstage/errors": "1.2.4",
|
|
61
|
-
"@backstage/plugin-events-node": "0.4.
|
|
62
|
-
"@backstage/types": "1.1.1",
|
|
58
|
+
"@backstage/backend-openapi-utils": "^0.2.0",
|
|
59
|
+
"@backstage/backend-plugin-api": "^1.0.1",
|
|
60
|
+
"@backstage/config": "^1.2.0",
|
|
61
|
+
"@backstage/errors": "^1.2.4",
|
|
62
|
+
"@backstage/plugin-events-node": "^0.4.2",
|
|
63
|
+
"@backstage/types": "^1.1.1",
|
|
63
64
|
"@types/express": "^4.17.6",
|
|
64
65
|
"express": "^4.17.1",
|
|
65
66
|
"express-promise-router": "^4.1.0",
|
|
@@ -67,12 +68,12 @@
|
|
|
67
68
|
"winston": "^3.2.1"
|
|
68
69
|
},
|
|
69
70
|
"devDependencies": {
|
|
70
|
-
"@backstage/backend-app-api": "1.0.1
|
|
71
|
-
"@backstage/backend-defaults": "0.5.
|
|
72
|
-
"@backstage/backend-test-utils": "1.0.
|
|
73
|
-
"@backstage/cli": "0.28.0
|
|
74
|
-
"@backstage/plugin-events-backend-test-utils": "0.1.
|
|
75
|
-
"@backstage/repo-tools": "0.10.0
|
|
71
|
+
"@backstage/backend-app-api": "^1.0.1",
|
|
72
|
+
"@backstage/backend-defaults": "^0.5.2",
|
|
73
|
+
"@backstage/backend-test-utils": "^1.0.2",
|
|
74
|
+
"@backstage/cli": "^0.28.0",
|
|
75
|
+
"@backstage/plugin-events-backend-test-utils": "^0.1.37",
|
|
76
|
+
"@backstage/repo-tools": "^0.10.0",
|
|
76
77
|
"supertest": "^7.0.0"
|
|
77
78
|
},
|
|
78
79
|
"configSchema": "config.d.ts"
|