@backstage/plugin-events-backend 0.2.21 → 0.3.0-next.0

package/CHANGELOG.md

@@ -1,22 +1,82 @@
 # @backstage/plugin-events-backend
 
-## 0.2.21
+## 0.3.0-next.0
 
-### Patch Changes
+### Minor Changes
 
-- Updated dependencies
-  - @backstage/backend-common@0.21.2
-  - @backstage/backend-plugin-api@0.6.12
-  - @backstage/plugin-events-node@0.2.21
+- c4bd794: BREAKING CHANGE: Migrate `HttpPostIngressEventPublisher` and `eventsPlugin` to use `EventsService`.
 
-## 0.2.20
+  Uses the `EventsService` instead of `EventBroker` at `HttpPostIngressEventPublisher`,
+  dropping the use of `EventPublisher` including `setEventBroker(..)`.
+
+  Now, `HttpPostIngressEventPublisher.fromConfig` requires `events: EventsService` as option.
+
+  ```diff
+    const http = HttpPostIngressEventPublisher.fromConfig({
+      config: env.config,
+  +   events: env.events,
+      logger: env.logger,
+    });
+    http.bind(eventsRouter);
+
+    // e.g. at packages/backend/src/plugins/events.ts
+  - await new EventsBackend(env.logger)
+  -   .setEventBroker(env.eventBroker)
+  -   .addPublishers(http)
+  -   .start();
+
+    // or for other kinds of setups
+  - await Promise.all(http.map(publisher => publisher.setEventBroker(eventBroker)));
+  ```
+
+  `eventsPlugin` uses the `eventsServiceRef` as dependency.
+  Unsupported (and deprecated) extension point methods will throw an error to prevent unintended behavior.
+
+  ```ts
+  import { eventsServiceRef } from '@backstage/plugin-events-node';
+  ```
 
 ### Patch Changes
 
+- 56969b6: Add new `EventsService` as well as `eventsServiceRef` for the new backend system.
+
+  **Summary:**
+
+  - new:
+    `EventsService`, `eventsServiceRef`, `TestEventsService`
+  - deprecated:
+    `EventBroker`, `EventPublisher`, `EventSubscriber`, `DefaultEventBroker`, `EventsBackend`,
+    most parts of `EventsExtensionPoint` (alpha),
+    `TestEventBroker`, `TestEventPublisher`, `TestEventSubscriber`
+
+  Add the `eventsServiceRef` as dependency to your backend plugins
+  or backend plugin modules.
+
+  **Details:**
+
+  The previous implementation using the `EventsExtensionPoint` was added in the early stages
+  of the new backend system and does not respect the plugin isolation.
+  This made it not compatible anymore with the new backend system.
+
+  Additionally, the previous interfaces had some room for simplification,
+  supporting less exposure of internal concerns as well.
+
+  Hereby, this change adds a new `EventsService` interface as replacement for the now deprecated `EventBroker`.
+  The new interface does not require any `EventPublisher` or `EventSubscriber` interfaces anymore.
+  Instead, it is expected that the `EventsService` gets passed into publishers and subscribers,
+  and used internally. There is no need to expose anything of that at their own interfaces.
+
+  Most parts of `EventsExtensionPoint` (alpha) are deprecated as well and were not usable
+  (by other plugins or their modules) anyway.
+
+  The `DefaultEventBroker` implementation is deprecated and wraps the new `DefaultEventsService` implementation.
+  Optionally, an instance can be passed as argument to allow mixed setups to operate alongside.
+
 - Updated dependencies
-  - @backstage/backend-common@0.21.1
-  - @backstage/backend-plugin-api@0.6.11
-  - @backstage/plugin-events-node@0.2.20
+  - @backstage/plugin-events-node@0.3.0-next.0
+  - @backstage/backend-common@0.21.3-next.0
+  - @backstage/backend-plugin-api@0.6.13-next.0
+  - @backstage/config@1.1.2-next.0
 
 ## 0.2.19
 

package/README.md

@@ -1,137 +1,84 @@
-# events-backend
+# `@backstage/plugin-events-backend`
 
 Welcome to the events-backend backend plugin!
 
-This plugin provides the wiring of all extension points
-for managing events as defined by [plugin-events-node](../events-node)
-including backend plugin `EventsPlugin` and `EventsBackend`.
-
-Additionally, it uses a simple in-process implementation for
-the `EventBroker` by default which you can replace with a more sophisticated
-implementation of your choice as you need (e.g., via module).
-
-Some of these (non-exhaustive) may provide added persistence,
-or use external systems like AWS EventBridge, AWS SNS, Kafka, etc.
+This package is based on [events-node](../events-node) and its `eventsServiceRef`
+that is at the core of the event support.
+It provides an `eventsPlugin` (exported as `default`).
 
 By default, the plugin ships with support to receive events via HTTP endpoints
-`POST /api/events/http/{topic}` and will publish these
-to the used event broker.
+`POST /api/events/http/{topic}` and will publish these to the `EventsService`.
+
+HTTP ingresses can be enabled by config, or using the extension point
+of the `eventsPlugin`.
+Additionally, the latter allows to add a request validator
+(e.g., signature verification).
 
 ## Installation
 
 ```bash
 # From your Backstage root directory
-yarn --cwd packages/backend add @backstage/plugin-events-backend @backstage/plugin-events-node
+yarn --cwd packages/backend add @backstage/plugin-events-backend
 ```
 
-### Add to backend
-
-```ts title="packages/backend/src/index.ts"
-backend.add(import('@backstage/plugin-events-backend/alpha'));
-```
-
-### Add to backend (old)
-
-#### Event Broker
-
-First you will need to add and implementation of the `EventBroker` interface to the backend plugin environment.
-This will allow event broker instance any backend plugins to publish and subscribe to events in order to communicate
-between them.
-
-Add the following to `makeCreateEnv`
-
-```diff
+```ts
 // packages/backend/src/index.ts
-+   import { DefaultEventBroker } from '@backstage/plugin-events-backend';
-+   const eventBroker = new DefaultEventBroker(root.child({ type: 'plugin' }));
-```
-
-Then update plugin environment to include the event broker.
-
-```diff
-// packages/backend/src/types.ts
-+  import { EventBroker } from '@backstage/plugin-events-node';
-+  eventBroker: EventBroker;
+backend.add(import('@backstage/plugin-events-backend/alpha'));
 ```
 
-#### Publishing and Subscribing to events with the broker
+### Legacy Backend System
 
-Backend plugins are passed the event broker in the plugin environment at startup of the application. The plugin can
-make use of this to communicate between parts of the application.
-
-Here is an example of a plugin publishing a payload to a topic.
-
-```typescript jsx
-export default async function createPlugin(
-  env: PluginEnvironment,
-): Promise<Router> {
-  env.eventBroker.publish({
-    topic: 'publish.example',
-    eventPayload: { message: 'Hello, World!' },
-    metadata: {},
-  });
-}
-```
-
-Here is an example of a plugin subscribing to a topic.
+```ts
+// packages/backend/src/plugins/events.ts
+import { HttpPostIngressEventPublisher } from '@backstage/plugin-events-backend';
+import { Router } from 'express';
+import { PluginEnvironment } from '../types';
 
-```typescript jsx
 export default async function createPlugin(
   env: PluginEnvironment,
 ): Promise<Router> {
-  env.eventBroker.subscribe([
-    {
-      supportsEventTopics: ['publish.example'],
-      onEvent: async (params: EventParams) => {
-        env.logger.info(`receieved ${params.topic} event`);
-      },
-    },
-  ]);
-}
-```
-
-#### Implementing an `EventSubscriber` class
-
-More complex solutions might need the creation of a class that implements the `EventSubscriber` interface. e.g.
-
-```typescript jsx
-import { EventSubscriber } from './EventSubscriber';
+  const eventsRouter = Router();
 
-class ExampleSubscriber implements EventSubscriber {
-  // ...
-
-  supportsEventTopics() {
-    return ['publish.example'];
-  }
+  const http = HttpPostIngressEventPublisher.fromConfig({
+    config: env.config,
+    events: env.events,
+    logger: env.logger,
+  });
+  http.bind(eventsRouter);
 
-  async onEvent(params: EventParams) {
-    env.logger.info(`receieved ${params.topic} event`);
-  }
+  return eventsRouter;
 }
 ```
 
-#### Events Backend
-
-The events backend plugin provides a router to handler http events and publish the http requests onto the event
-broker.
+### Event-based Entity Providers
 
-To configure it add a file [`packages/backend/src/plugins/events.ts`](../../packages/backend/src/plugins/events.ts)
-to your Backstage project.
+You can implement the `EventSubscriber` interface on an `EntityProviders` to allow it to handle events from other plugins e.g. the event backend plugin
+mentioned above.
 
-Additionally, add the events plugin to your backend.
+Assuming you have configured the `eventBroker` into the `PluginEnvironment` you can pass the broker to the entity provider for it to subscribe.
 
 ```diff
-// packages/backend/src/index.ts
-// [...]
-+import events from './plugins/events';
-// [...]
-+  const eventsEnv = useHotMemoize(module, () => createEnv('events'));
-// [...]
-+  apiRouter.use('/events', await events(eventsEnv));
-// [...]
+// packages/backend/src/plugins/catalog.ts
+ import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
++import { DemoEventBasedEntityProvider } from './DemoEventBasedEntityProvider';
+ import { ScaffolderEntitiesProcessor } from '@backstage/plugin-scaffolder-backend';
+ import { Router } from 'express';
+ import { PluginEnvironment } from '../types';
+
+ export default async function createPlugin(
+   env: PluginEnvironment,
+ ): Promise<Router> {
+   const builder = await CatalogBuilder.create(env);
+   builder.addProcessor(new ScaffolderEntitiesProcessor());
++  const demoProvider = new DemoEventBasedEntityProvider({ logger: env.logger, topics: ['example'], eventBroker: env.eventBroker });
++  builder.addEntityProvider(demoProvider);
+   const { processingEngine, router } = await builder.build();
+   await processingEngine.start();
+   return router;
+ }
 ```
 
-#### Configuration
+## Configuration
 
 In order to create HTTP endpoints to receive events for a certain
 topic, you need to add them at your configuration:
@@ -161,57 +108,18 @@ in combination with suitable event subscribers.
 
 However, it is not limited to these use cases.
 
-### Event-based Entity Providers
-
-You can implement the `EventSubscriber` interface on an `EntityProviders` to allow it to handle events from other plugins e.g. the event backend plugin
-mentioned above.
-
-Assuming you have configured the `eventBroker` into the `PluginEnvironment` you can pass the broker to the entity provider for it to subscribe.
-
-```diff
-// packages/backend/src/plugins/catalog.ts
- import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
-+import { DemoEventBasedEntityProvider } from './DemoEventBasedEntityProvider';
- import { ScaffolderEntitiesProcessor } from '@backstage/plugin-scaffolder-backend';
- import { Router } from 'express';
- import { PluginEnvironment } from '../types';
-
- export default async function createPlugin(
-   env: PluginEnvironment,
- ): Promise<Router> {
-   const builder = await CatalogBuilder.create(env);
-   builder.addProcessor(new ScaffolderEntitiesProcessor());
-+  const demoProvider = new DemoEventBasedEntityProvider({ logger: env.logger, topics: ['example'], eventBroker: env.eventBroker });
-+  builder.addEntityProvider(demoProvider);
-   const { processingEngine, router } = await builder.build();
-   await processingEngine.start();
-   return router;
- }
-```
-
 ## Use Cases
 
-### Custom Event Broker
-
-Example using the `EventsBackend`:
-
-```ts
-new EventsBackend(env.logger)
-  .setEventBroker(yourEventBroker)
-  // [...]
-  .start();
-```
-
-Example using a module:
+### Request Validator
 
 ```ts
-import { eventsExtensionPoint } from '@backstage/plugin-events-node';
+import { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha';
 
 // [...]
 
-export const yourModuleEventsModule = createBackendModule({
+export const eventsModuleYourFeature = createBackendModule({
   pluginId: 'events',
-  moduleId: 'your-module',
+  moduleId: 'your-feature',
   register(env) {
     // [...]
     env.registerInit({
@@ -222,22 +130,22 @@ export const yourModuleEventsModule = createBackendModule({
       },
       async init({ /* ... */ events /*, ... */ }) {
         // [...]
-        const yourEventBroker = new YourEventBroker();
-        // [...]
-        events.setEventBroker(yourEventBroker);
+        events.addHttpPostIngress({
+          topic: 'your-topic',
+          validator: yourValidator,
+        });
       },
     });
   },
 });
 ```
 
-### Request Validator
-
-Example using the `EventsBackend`:
+#### Legacy Backend System
 
 ```ts
 const http = HttpPostIngressEventPublisher.fromConfig({
   config: env.config,
+  events: env.events,
   ingresses: {
     yourTopic: {
       validator: yourValidator,
@@ -246,39 +154,4 @@ const http = HttpPostIngressEventPublisher.fromConfig({
   logger: env.logger,
 });
 http.bind(router);
-
-await new EventsBackend(env.logger)
-  .addPublishers(http)
-  // [...]
-  .start();
-```
-
-Example using a module:
-
-```ts
-import { eventsExtensionPoint } from '@backstage/plugin-events-node';
-
-// [...]
-
-export const eventsModuleYourFeature = createBackendModule({
-  pluginId: 'events',
-  moduleId: 'your-feature',
-  register(env) {
-    // [...]
-    env.registerInit({
-      deps: {
-        // [...]
-        events: eventsExtensionPoint,
-        // [...]
-      },
-      async init({ /* ... */ events /*, ... */ }) {
-        // [...]
-        events.addHttpPostIngress({
-          topic: 'your-topic',
-          validator: yourValidator,
-        });
-      },
-    });
-  },
-});
 ```

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-events-backend",
-  "version": "0.2.21",
+  "version": "0.3.0-next.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -3,10 +3,11 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
-var backendCommon = require('@backstage/backend-common');
 var alpha = require('@backstage/plugin-events-node/alpha');
-var HttpPostIngressEventPublisher = require('./cjs/HttpPostIngressEventPublisher-6e928c08.cjs.js');
+var pluginEventsNode = require('@backstage/plugin-events-node');
 var Router = require('express-promise-router');
+var HttpPostIngressEventPublisher = require('./cjs/HttpPostIngressEventPublisher-a08684c9.cjs.js');
+require('@backstage/backend-common');
 require('express');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
@@ -26,48 +27,34 @@ var __privateAdd = (obj, member, value) => {
     throw TypeError("Cannot add the same private member more than once");
   member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 };
-var __privateSet = (obj, member, value, setter) => {
-  __accessCheck(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
-  return value;
-};
-var _eventBroker, _httpPostIngresses, _publishers, _subscribers;
+var _httpPostIngresses;
 class EventsExtensionPointImpl {
   constructor() {
-    __privateAdd(this, _eventBroker, void 0);
     __privateAdd(this, _httpPostIngresses, []);
-    __privateAdd(this, _publishers, []);
-    __privateAdd(this, _subscribers, []);
   }
-  setEventBroker(eventBroker) {
-    __privateSet(this, _eventBroker, eventBroker);
+  setEventBroker(_) {
+    throw new Error(
+      "setEventBroker is not supported anymore; use eventsServiceRef instead"
+    );
   }
-  addPublishers(...publishers) {
-    __privateGet(this, _publishers).push(...publishers.flat());
+  addPublishers(_) {
+    throw new Error(
+      "addPublishers is not supported anymore; use EventsService instead"
+    );
   }
-  addSubscribers(...subscribers) {
-    __privateGet(this, _subscribers).push(...subscribers.flat());
+  addSubscribers(_) {
+    throw new Error(
+      "addSubscribers is not supported anymore; use EventsService instead"
+    );
   }
   addHttpPostIngress(options) {
     __privateGet(this, _httpPostIngresses).push(options);
   }
-  get eventBroker() {
-    return __privateGet(this, _eventBroker);
-  }
-  get publishers() {
-    return __privateGet(this, _publishers);
-  }
-  get subscribers() {
-    return __privateGet(this, _subscribers);
-  }
   get httpPostIngresses() {
     return __privateGet(this, _httpPostIngresses);
   }
 }
-_eventBroker = new WeakMap();
 _httpPostIngresses = new WeakMap();
-_publishers = new WeakMap();
-_subscribers = new WeakMap();
 const eventsPlugin = backendPluginApi.createBackendPlugin({
   pluginId: "events",
   register(env) {
@@ -76,12 +63,11 @@ const eventsPlugin = backendPluginApi.createBackendPlugin({
     env.registerInit({
       deps: {
         config: backendPluginApi.coreServices.rootConfig,
+        events: pluginEventsNode.eventsServiceRef,
         logger: backendPluginApi.coreServices.logger,
         router: backendPluginApi.coreServices.httpRouter
       },
-      async init({ config, logger, router }) {
-        var _a;
-        const winstonLogger = backendCommon.loggerToWinstonLogger(logger);
+      async init({ config, events, logger, router }) {
         const ingresses = Object.fromEntries(
           extensionPoint.httpPostIngresses.map((ingress) => [
             ingress.topic,
@@ -90,15 +76,13 @@ const eventsPlugin = backendPluginApi.createBackendPlugin({
         );
         const http = HttpPostIngressEventPublisher.HttpPostIngressEventPublisher.fromConfig({
           config,
+          events,
           ingresses,
-          logger: winstonLogger
+          logger
         });
         const eventsRouter = Router__default["default"]();
         http.bind(eventsRouter);
         router.use(eventsRouter);
-        const eventBroker = (_a = extensionPoint.eventBroker) != null ? _a : new HttpPostIngressEventPublisher.DefaultEventBroker(winstonLogger);
-        eventBroker.subscribe(extensionPoint.subscribers);
-        [extensionPoint.publishers, http].flat().forEach((publisher) => publisher.setEventBroker(eventBroker));
       }
     });
   }

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.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 { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n  eventsExtensionPoint,\n  EventsExtensionPoint,\n} from '@backstage/plugin-events-node/alpha';\nimport {\n  EventBroker,\n  EventPublisher,\n  EventSubscriber,\n  HttpPostIngressOptions,\n} from '@backstage/plugin-events-node';\nimport { DefaultEventBroker } from './DefaultEventBroker';\nimport Router from 'express-promise-router';\nimport { HttpPostIngressEventPublisher } from './http';\n\nclass EventsExtensionPointImpl implements EventsExtensionPoint {\n  #eventBroker: EventBroker | undefined;\n  #httpPostIngresses: HttpPostIngressOptions[] = [];\n  #publishers: EventPublisher[] = [];\n  #subscribers: EventSubscriber[] = [];\n\n  setEventBroker(eventBroker: EventBroker): void {\n    this.#eventBroker = eventBroker;\n  }\n\n  addPublishers(\n    ...publishers: Array<EventPublisher | Array<EventPublisher>>\n  ): void {\n    this.#publishers.push(...publishers.flat());\n  }\n\n  addSubscribers(\n    ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n  ): void {\n    this.#subscribers.push(...subscribers.flat());\n  }\n\n  addHttpPostIngress(options: HttpPostIngressOptions) {\n    this.#httpPostIngresses.push(options);\n  }\n\n  get eventBroker() {\n    return this.#eventBroker;\n  }\n\n  get publishers() {\n    return this.#publishers;\n  }\n\n  get subscribers() {\n    return this.#subscribers;\n  }\n\n  get httpPostIngresses() {\n    return this.#httpPostIngresses;\n  }\n}\n\n/**\n * Events plugin\n *\n * @alpha\n */\nexport const eventsPlugin = createBackendPlugin({\n  pluginId: 'events',\n  register(env) {\n    const extensionPoint = new EventsExtensionPointImpl();\n    env.registerExtensionPoint(eventsExtensionPoint, extensionPoint);\n\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n        router: coreServices.httpRouter,\n      },\n      async init({ config, logger, router }) {\n        const winstonLogger = loggerToWinstonLogger(logger);\n\n        const ingresses = Object.fromEntries(\n          extensionPoint.httpPostIngresses.map(ingress => [\n            ingress.topic,\n            ingress as Omit<HttpPostIngressOptions, 'topic'>,\n          ]),\n        );\n\n        const http = HttpPostIngressEventPublisher.fromConfig({\n          config,\n          ingresses,\n          logger: winstonLogger,\n        });\n        const eventsRouter = Router();\n        http.bind(eventsRouter);\n        router.use(eventsRouter);\n\n        const eventBroker =\n          extensionPoint.eventBroker ?? new DefaultEventBroker(winstonLogger);\n\n        eventBroker.subscribe(extensionPoint.subscribers);\n        [extensionPoint.publishers, http]\n          .flat()\n          .forEach(publisher => publisher.setEventBroker(eventBroker));\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","eventsExtensionPoint","coreServices","loggerToWinstonLogger","HttpPostIngressEventPublisher","Router","DefaultEventBroker"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAA,YAAA,EAAA,kBAAA,EAAA,WAAA,EAAA,YAAA,CAAA;AAmCA,MAAM,wBAAyD,CAAA;AAAA,EAA/D,WAAA,GAAA;AACE,IAAA,YAAA,CAAA,IAAA,EAAA,YAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,kBAAA,EAA+C,EAAC,CAAA,CAAA;AAChD,IAAA,YAAA,CAAA,IAAA,EAAA,WAAA,EAAgC,EAAC,CAAA,CAAA;AACjC,IAAA,YAAA,CAAA,IAAA,EAAA,YAAA,EAAkC,EAAC,CAAA,CAAA;AAAA,GAAA;AAAA,EAEnC,eAAe,WAAgC,EAAA;AAC7C,IAAA,YAAA,CAAA,IAAA,EAAK,YAAe,EAAA,WAAA,CAAA,CAAA;AAAA,GACtB;AAAA,EAEA,iBACK,UACG,EAAA;AACN,IAAA,YAAA,CAAA,IAAA,EAAK,WAAY,CAAA,CAAA,IAAA,CAAK,GAAG,UAAA,CAAW,MAAM,CAAA,CAAA;AAAA,GAC5C;AAAA,EAEA,kBACK,WACG,EAAA;AACN,IAAA,YAAA,CAAA,IAAA,EAAK,YAAa,CAAA,CAAA,IAAA,CAAK,GAAG,WAAA,CAAY,MAAM,CAAA,CAAA;AAAA,GAC9C;AAAA,EAEA,mBAAmB,OAAiC,EAAA;AAClD,IAAK,YAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAmB,KAAK,OAAO,CAAA,CAAA;AAAA,GACtC;AAAA,EAEA,IAAI,WAAc,GAAA;AAChB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,UAAa,GAAA;AACf,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,WAAc,GAAA;AAChB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,iBAAoB,GAAA;AACtB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AAxCE,YAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,kBAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,WAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,YAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AA4CK,MAAM,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,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,MAAQ,EAAA,MAAA,EAAQ,QAAU,EAAA;AA/F7C,QAAA,IAAA,EAAA,CAAA;AAgGQ,QAAM,MAAA,aAAA,GAAgBC,oCAAsB,MAAM,CAAA,CAAA;AAElD,QAAA,MAAM,YAAY,MAAO,CAAA,WAAA;AAAA,UACvB,cAAA,CAAe,iBAAkB,CAAA,GAAA,CAAI,CAAW,OAAA,KAAA;AAAA,YAC9C,OAAQ,CAAA,KAAA;AAAA,YACR,OAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAEA,QAAM,MAAA,IAAA,GAAOC,4DAA8B,UAAW,CAAA;AAAA,UACpD,MAAA;AAAA,UACA,SAAA;AAAA,UACA,MAAQ,EAAA,aAAA;AAAA,SACT,CAAA,CAAA;AACD,QAAA,MAAM,eAAeC,0BAAO,EAAA,CAAA;AAC5B,QAAA,IAAA,CAAK,KAAK,YAAY,CAAA,CAAA;AACtB,QAAA,MAAA,CAAO,IAAI,YAAY,CAAA,CAAA;AAEvB,QAAA,MAAM,eACJ,EAAe,GAAA,cAAA,CAAA,WAAA,KAAf,IAA8B,GAAA,EAAA,GAAA,IAAIC,iDAAmB,aAAa,CAAA,CAAA;AAEpE,QAAY,WAAA,CAAA,SAAA,CAAU,eAAe,WAAW,CAAA,CAAA;AAChD,QAAC,CAAA,cAAA,CAAe,UAAY,EAAA,IAAI,CAC7B,CAAA,IAAA,EACA,CAAA,OAAA,CAAQ,CAAa,SAAA,KAAA,SAAA,CAAU,cAAe,CAAA,WAAW,CAAC,CAAA,CAAA;AAAA,OAC/D;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
+{"version":3,"file":"alpha.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';\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 * @alpha\n */\nexport const eventsPlugin = createBackendPlugin({\n  pluginId: 'events',\n  register(env) {\n    const extensionPoint = new EventsExtensionPointImpl();\n    env.registerExtensionPoint(eventsExtensionPoint, extensionPoint);\n\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        events: eventsServiceRef,\n        logger: coreServices.logger,\n        router: coreServices.httpRouter,\n      },\n      async init({ config, events, logger, router }) {\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        router.use(eventsRouter);\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","eventsExtensionPoint","coreServices","eventsServiceRef","HttpPostIngressEventPublisher","Router"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAA,kBAAA,CAAA;AA+BA,MAAM,wBAAyD,CAAA;AAAA,EAA/D,WAAA,GAAA;AACE,IAAA,YAAA,CAAA,IAAA,EAAA,kBAAA,EAA+C,EAAC,CAAA,CAAA;AAAA,GAAA;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,YAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAmB,KAAK,OAAO,CAAA,CAAA;AAAA,GACtC;AAAA,EAEA,IAAI,iBAAoB,GAAA;AACtB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AA3BE,kBAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AAkCK,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,QAAQD,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAQ,MAAQ,EAAA,MAAA,EAAQ,QAAU,EAAA;AAC7C,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,0BAAO,EAAA,CAAA;AAC5B,QAAA,IAAA,CAAK,KAAK,YAAY,CAAA,CAAA;AACtB,QAAA,MAAA,CAAO,IAAI,YAAY,CAAA,CAAA;AAAA,OACzB;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/cjs/{HttpPostIngressEventPublisher-6e928c08.cjs.js → HttpPostIngressEventPublisher-a08684c9.cjs.js}

@@ -9,49 +9,6 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
 var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
 
-var __defProp$1 = Object.defineProperty;
-var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$1 = (obj, key, value) => {
-  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-class DefaultEventBroker {
-  constructor(logger) {
-    this.logger = logger;
-    __publicField$1(this, "subscribers", {});
-  }
-  async publish(params) {
-    var _a;
-    this.logger.debug(
-      `Event received: topic=${params.topic}, metadata=${JSON.stringify(
-        params.metadata
-      )}, payload=${JSON.stringify(params.eventPayload)}`
-    );
-    const subscribed = (_a = this.subscribers[params.topic]) != null ? _a : [];
-    await Promise.all(
-      subscribed.map(async (subscriber) => {
-        try {
-          await subscriber.onEvent(params);
-        } catch (error) {
-          this.logger.error(
-            `Subscriber "${subscriber.constructor.name}" failed to process event`,
-            error
-          );
-        }
-      })
-    );
-  }
-  subscribe(...subscribers) {
-    subscribers.flat().forEach((subscriber) => {
-      subscriber.supportsEventTopics().forEach((topic) => {
-        var _a;
-        this.subscribers[topic] = (_a = this.subscribers[topic]) != null ? _a : [];
-        this.subscribers[topic].push(subscriber);
-      });
-    });
-  }
-}
-
 var __accessCheck = (obj, member, msg) => {
   if (!member.has(obj))
     throw TypeError("Cannot " + msg);
@@ -91,17 +48,11 @@ class RequestValidationContextImpl {
 }
 _rejectionDetails = new WeakMap();
 
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 class HttpPostIngressEventPublisher {
-  constructor(logger, ingresses) {
+  constructor(events, logger, ingresses) {
+    this.events = events;
     this.logger = logger;
     this.ingresses = ingresses;
-    __publicField(this, "eventBroker");
   }
   static fromConfig(env) {
     var _a, _b;
@@ -112,14 +63,11 @@ class HttpPostIngressEventPublisher {
         ingresses[topic] = {};
       }
     });
-    return new HttpPostIngressEventPublisher(env.logger, ingresses);
+    return new HttpPostIngressEventPublisher(env.events, env.logger, ingresses);
   }
   bind(router) {
     router.use("/http", this.createRouter(this.ingresses));
   }
-  async setEventBroker(eventBroker) {
-    this.eventBroker = eventBroker;
-  }
   createRouter(ingresses) {
     const router = Router__default["default"]();
     router.use(express__default["default"].json());
@@ -143,7 +91,7 @@ class HttpPostIngressEventPublisher {
         return;
       }
       const eventPayload = request.body;
-      await this.eventBroker.publish({
+      await this.events.publish({
         topic,
         eventPayload,
         metadata: request.headers
@@ -154,6 +102,5 @@ class HttpPostIngressEventPublisher {
   }
 }
 
-exports.DefaultEventBroker = DefaultEventBroker;
 exports.HttpPostIngressEventPublisher = HttpPostIngressEventPublisher;
-//# sourceMappingURL=HttpPostIngressEventPublisher-6e928c08.cjs.js.map
+//# sourceMappingURL=HttpPostIngressEventPublisher-a08684c9.cjs.js.map

package/dist/cjs/HttpPostIngressEventPublisher-a08684c9.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpPostIngressEventPublisher-a08684c9.cjs.js","sources":["../../src/service/http/validation/RequestValidationContextImpl.ts","../../src/service/http/HttpPostIngressEventPublisher.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  RequestRejectionDetails,\n  RequestValidationContext,\n} from '@backstage/plugin-events-node';\n\nexport class RequestValidationContextImpl implements RequestValidationContext {\n  #rejectionDetails: RequestRejectionDetails | undefined;\n\n  reject(details?: Partial<RequestRejectionDetails>): void {\n    this.#rejectionDetails = {\n      status: details?.status ?? 403,\n      payload: details?.payload ?? {},\n    };\n  }\n\n  wasRejected(): boolean {\n    return this.#rejectionDetails !== undefined;\n  }\n\n  get rejectionDetails() {\n    return this.#rejectionDetails;\n  }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { errorHandler } from '@backstage/backend-common';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport {\n  EventsService,\n  HttpPostIngressOptions,\n  RequestValidator,\n} from '@backstage/plugin-events-node';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { RequestValidationContextImpl } from './validation';\n\n/**\n * Publishes events received from their origin (e.g., webhook events from an SCM system)\n * via HTTP POST endpoint and passes the request body as event payload to the registered subscribers.\n *\n * @public\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class HttpPostIngressEventPublisher {\n  static fromConfig(env: {\n    config: Config;\n    events: EventsService;\n    ingresses?: { [topic: string]: Omit<HttpPostIngressOptions, 'topic'> };\n    logger: LoggerService;\n  }): HttpPostIngressEventPublisher {\n    const topics =\n      env.config.getOptionalStringArray('events.http.topics') ?? [];\n\n    const ingresses = env.ingresses ?? {};\n    topics.forEach(topic => {\n      // don't overwrite topic settings\n      // (e.g., added at the config as well as argument)\n      if (!ingresses[topic]) {\n        ingresses[topic] = {};\n      }\n    });\n\n    return new HttpPostIngressEventPublisher(env.events, env.logger, ingresses);\n  }\n\n  private constructor(\n    private readonly events: EventsService,\n    private readonly logger: LoggerService,\n    private readonly ingresses: {\n      [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n    },\n  ) {}\n\n  bind(router: express.Router): void {\n    router.use('/http', this.createRouter(this.ingresses));\n  }\n\n  private createRouter(ingresses: {\n    [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n  }): express.Router {\n    const router = Router();\n    router.use(express.json());\n\n    Object.keys(ingresses).forEach(topic =>\n      this.addRouteForTopic(router, topic, ingresses[topic].validator),\n    );\n\n    router.use(errorHandler());\n    return router;\n  }\n\n  private addRouteForTopic(\n    router: express.Router,\n    topic: string,\n    validator?: RequestValidator,\n  ): void {\n    const path = `/${topic}`;\n\n    router.post(path, async (request, response) => {\n      const requestDetails = {\n        body: request.body,\n        headers: request.headers,\n      };\n      const context = new RequestValidationContextImpl();\n      await validator?.(requestDetails, context);\n      if (context.wasRejected()) {\n        response\n          .status(context.rejectionDetails!.status)\n          .json(context.rejectionDetails!.payload);\n        return;\n      }\n\n      const eventPayload = request.body;\n      await this.events.publish({\n        topic,\n        eventPayload,\n        metadata: request.headers,\n      });\n\n      response.status(202).json({ status: 'accepted' });\n    });\n\n    // TODO(pjungermann): We don't really know the externally defined path prefix here,\n    //  however it is more useful for users to have it. Is there a better way?\n    this.logger.info(`Registered /api/events/http${path} to receive events`);\n  }\n}\n"],"names":["Router","express","errorHandler"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAA,iBAAA,CAAA;AAqBO,MAAM,4BAAiE,CAAA;AAAA,EAAvE,WAAA,GAAA;AACL,IAAA,YAAA,CAAA,IAAA,EAAA,iBAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAEA,OAAO,OAAkD,EAAA;AAxB3D,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAyBI,IAAA,YAAA,CAAA,IAAA,EAAK,iBAAoB,EAAA;AAAA,MACvB,MAAA,EAAA,CAAQ,EAAS,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAA,MAAA,KAAT,IAAmB,GAAA,EAAA,GAAA,GAAA;AAAA,MAC3B,OAAS,EAAA,CAAA,EAAA,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,OAAT,KAAA,IAAA,GAAA,EAAA,GAAoB,EAAC;AAAA,KAChC,CAAA,CAAA;AAAA,GACF;AAAA,EAEA,WAAuB,GAAA;AACrB,IAAA,OAAO,mBAAK,iBAAsB,CAAA,KAAA,KAAA,CAAA,CAAA;AAAA,GACpC;AAAA,EAEA,IAAI,gBAAmB,GAAA;AACrB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AAhBE,iBAAA,GAAA,IAAA,OAAA,EAAA;;ACaK,MAAM,6BAA8B,CAAA;AAAA,EAsBjC,WAAA,CACW,MACA,EAAA,MAAA,EACA,SAGjB,EAAA;AALiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AAAA,GAGhB;AAAA,EA3BH,OAAO,WAAW,GAKgB,EAAA;AAzCpC,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AA0CI,IAAA,MAAM,UACJ,EAAI,GAAA,GAAA,CAAA,MAAA,CAAO,uBAAuB,oBAAoB,CAAA,KAAtD,YAA2D,EAAC,CAAA;AAE9D,IAAA,MAAM,SAAY,GAAA,CAAA,EAAA,GAAA,GAAA,CAAI,SAAJ,KAAA,IAAA,GAAA,EAAA,GAAiB,EAAC,CAAA;AACpC,IAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAGtB,MAAI,IAAA,CAAC,SAAU,CAAA,KAAK,CAAG,EAAA;AACrB,QAAU,SAAA,CAAA,KAAK,IAAI,EAAC,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,OAAO,IAAI,6BAA8B,CAAA,GAAA,CAAI,MAAQ,EAAA,GAAA,CAAI,QAAQ,SAAS,CAAA,CAAA;AAAA,GAC5E;AAAA,EAUA,KAAK,MAA8B,EAAA;AACjC,IAAA,MAAA,CAAO,IAAI,OAAS,EAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,SAAS,CAAC,CAAA,CAAA;AAAA,GACvD;AAAA,EAEQ,aAAa,SAEF,EAAA;AACjB,IAAA,MAAM,SAASA,0BAAO,EAAA,CAAA;AACtB,IAAO,MAAA,CAAA,GAAA,CAAIC,2BAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,IAAO,MAAA,CAAA,IAAA,CAAK,SAAS,CAAE,CAAA,OAAA;AAAA,MAAQ,CAAA,KAAA,KAC7B,KAAK,gBAAiB,CAAA,MAAA,EAAQ,OAAO,SAAU,CAAA,KAAK,EAAE,SAAS,CAAA;AAAA,KACjE,CAAA;AAEA,IAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEQ,gBAAA,CACN,MACA,EAAA,KAAA,EACA,SACM,EAAA;AACN,IAAM,MAAA,IAAA,GAAO,IAAI,KAAK,CAAA,CAAA,CAAA;AAEtB,IAAA,MAAA,CAAO,IAAK,CAAA,IAAA,EAAM,OAAO,OAAA,EAAS,QAAa,KAAA;AAC7C,MAAA,MAAM,cAAiB,GAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,SAAS,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA;AACA,MAAM,MAAA,OAAA,GAAU,IAAI,4BAA6B,EAAA,CAAA;AACjD,MAAA,OAAM,uCAAY,cAAgB,EAAA,OAAA,CAAA,CAAA,CAAA;AAClC,MAAI,IAAA,OAAA,CAAQ,aAAe,EAAA;AACzB,QACG,QAAA,CAAA,MAAA,CAAO,QAAQ,gBAAkB,CAAA,MAAM,EACvC,IAAK,CAAA,OAAA,CAAQ,iBAAkB,OAAO,CAAA,CAAA;AACzC,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,MAAM,eAAe,OAAQ,CAAA,IAAA,CAAA;AAC7B,MAAM,MAAA,IAAA,CAAK,OAAO,OAAQ,CAAA;AAAA,QACxB,KAAA;AAAA,QACA,YAAA;AAAA,QACA,UAAU,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA,CAAA;AAED,MAAA,QAAA,CAAS,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,MAAA,EAAQ,YAAY,CAAA,CAAA;AAAA,KACjD,CAAA,CAAA;AAID,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAA8B,2BAAA,EAAA,IAAI,CAAoB,kBAAA,CAAA,CAAA,CAAA;AAAA,GACzE;AACF;;;;"}

package/dist/index.cjs.js

@@ -2,11 +2,44 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var HttpPostIngressEventPublisher = require('./cjs/HttpPostIngressEventPublisher-6e928c08.cjs.js');
+var pluginEventsNode = require('@backstage/plugin-events-node');
+var HttpPostIngressEventPublisher = require('./cjs/HttpPostIngressEventPublisher-a08684c9.cjs.js');
 require('@backstage/backend-common');
 require('express');
 require('express-promise-router');
 
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class DefaultEventBroker {
+  /**
+   *
+   * @param logger - logger
+   * @param events - replacement that gets wrapped to support not yet migrated implementations.
+   * An instance can be passed (required for a mixed mode), otherwise a new instance gets created internally.
+   * @deprecated use `DefaultEventsService` directly instead
+   */
+  constructor(logger, events) {
+    __publicField$1(this, "events");
+    this.events = events != null ? events : pluginEventsNode.DefaultEventsService.create({ logger });
+  }
+  async publish(params) {
+    return this.events.publish(params);
+  }
+  subscribe(...subscribers) {
+    subscribers.flat().forEach(async (subscriber) => {
+      await this.events.subscribe({
+        id: subscriber.constructor.name,
+        topics: subscriber.supportsEventTopics(),
+        onEvent: subscriber.onEvent.bind(subscriber)
+      });
+    });
+  }
+}
+
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => {
@@ -18,7 +51,7 @@ class EventsBackend {
     __publicField(this, "eventBroker");
     __publicField(this, "publishers", []);
     __publicField(this, "subscribers", []);
-    this.eventBroker = new HttpPostIngressEventPublisher.DefaultEventBroker(logger);
+    this.eventBroker = new DefaultEventBroker(logger);
   }
   setEventBroker(eventBroker) {
     this.eventBroker = eventBroker;
@@ -43,7 +76,7 @@ class EventsBackend {
   }
 }
 
-exports.DefaultEventBroker = HttpPostIngressEventPublisher.DefaultEventBroker;
 exports.HttpPostIngressEventPublisher = HttpPostIngressEventPublisher.HttpPostIngressEventPublisher;
+exports.DefaultEventBroker = DefaultEventBroker;
 exports.EventsBackend = EventsBackend;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/service/EventsBackend.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  EventBroker,\n  EventPublisher,\n  EventSubscriber,\n} from '@backstage/plugin-events-node';\nimport { Logger } from 'winston';\nimport { DefaultEventBroker } from './DefaultEventBroker';\n\n/**\n * A builder that helps wire up all component parts of the event management.\n *\n * @public\n */\nexport class EventsBackend {\n  private eventBroker: EventBroker;\n  private publishers: EventPublisher[] = [];\n  private subscribers: EventSubscriber[] = [];\n\n  constructor(logger: Logger) {\n    this.eventBroker = new DefaultEventBroker(logger);\n  }\n\n  setEventBroker(eventBroker: EventBroker): EventsBackend {\n    this.eventBroker = eventBroker;\n    return this;\n  }\n\n  addPublishers(\n    ...publishers: Array<EventPublisher | Array<EventPublisher>>\n  ): EventsBackend {\n    this.publishers.push(...publishers.flat());\n    return this;\n  }\n\n  addSubscribers(\n    ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n  ): EventsBackend {\n    this.subscribers.push(...subscribers.flat());\n    return this;\n  }\n\n  /**\n   * Wires up and returns all component parts of the event management.\n   */\n  async start(): Promise<void> {\n    this.eventBroker.subscribe(this.subscribers);\n    this.publishers.forEach(publisher =>\n      publisher.setEventBroker(this.eventBroker),\n    );\n  }\n}\n"],"names":["DefaultEventBroker"],"mappings":";;;;;;;;;;;;;;;AA6BO,MAAM,aAAc,CAAA;AAAA,EAKzB,YAAY,MAAgB,EAAA;AAJ5B,IAAQ,aAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA;AACR,IAAA,aAAA,CAAA,IAAA,EAAQ,cAA+B,EAAC,CAAA,CAAA;AACxC,IAAA,aAAA,CAAA,IAAA,EAAQ,eAAiC,EAAC,CAAA,CAAA;AAGxC,IAAK,IAAA,CAAA,WAAA,GAAc,IAAIA,gDAAA,CAAmB,MAAM,CAAA,CAAA;AAAA,GAClD;AAAA,EAEA,eAAe,WAAyC,EAAA;AACtD,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AACnB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,iBACK,UACY,EAAA;AACf,IAAA,IAAA,CAAK,UAAW,CAAA,IAAA,CAAK,GAAG,UAAA,CAAW,MAAM,CAAA,CAAA;AACzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,kBACK,WACY,EAAA;AACf,IAAA,IAAA,CAAK,WAAY,CAAA,IAAA,CAAK,GAAG,WAAA,CAAY,MAAM,CAAA,CAAA;AAC3C,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAuB,GAAA;AAC3B,IAAK,IAAA,CAAA,WAAA,CAAY,SAAU,CAAA,IAAA,CAAK,WAAW,CAAA,CAAA;AAC3C,IAAA,IAAA,CAAK,UAAW,CAAA,OAAA;AAAA,MAAQ,CACtB,SAAA,KAAA,SAAA,CAAU,cAAe,CAAA,IAAA,CAAK,WAAW,CAAA;AAAA,KAC3C,CAAA;AAAA,GACF;AACF;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/service/DefaultEventBroker.ts","../src/service/EventsBackend.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 { LoggerService } from '@backstage/backend-plugin-api';\nimport {\n  DefaultEventsService,\n  EventBroker,\n  EventParams,\n  EventsService,\n  EventSubscriber,\n} from '@backstage/plugin-events-node';\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 *\n * @public\n * @deprecated use `DefaultEventsService` from `@backstage/plugin-events-node` instead\n */\nexport class DefaultEventBroker implements EventBroker {\n  private readonly events: EventsService;\n\n  /**\n   *\n   * @param logger - logger\n   * @param events - replacement that gets wrapped to support not yet migrated implementations.\n   * An instance can be passed (required for a mixed mode), otherwise a new instance gets created internally.\n   * @deprecated use `DefaultEventsService` directly instead\n   */\n  constructor(logger: LoggerService, events?: EventsService) {\n    this.events = events ?? DefaultEventsService.create({ logger });\n  }\n\n  async publish(params: EventParams): Promise<void> {\n    return this.events.publish(params);\n  }\n\n  subscribe(\n    ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n  ): void {\n    subscribers.flat().forEach(async subscriber => {\n      await this.events.subscribe({\n        id: subscriber.constructor.name,\n        topics: subscriber.supportsEventTopics(),\n        onEvent: subscriber.onEvent.bind(subscriber),\n      });\n    });\n  }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  EventBroker,\n  EventPublisher,\n  EventSubscriber,\n} from '@backstage/plugin-events-node';\nimport { Logger } from 'winston';\nimport { DefaultEventBroker } from './DefaultEventBroker';\n\n/**\n * A builder that helps wire up all component parts of the event management.\n *\n * @public\n * @deprecated `EventBroker`, `EventPublisher`, and `EventSubscriber` got replaced by `EventsService` and its methods.\n */\nexport class EventsBackend {\n  private eventBroker: EventBroker;\n  private publishers: EventPublisher[] = [];\n  private subscribers: EventSubscriber[] = [];\n\n  constructor(logger: Logger) {\n    this.eventBroker = new DefaultEventBroker(logger);\n  }\n\n  setEventBroker(eventBroker: EventBroker): EventsBackend {\n    this.eventBroker = eventBroker;\n    return this;\n  }\n\n  addPublishers(\n    ...publishers: Array<EventPublisher | Array<EventPublisher>>\n  ): EventsBackend {\n    this.publishers.push(...publishers.flat());\n    return this;\n  }\n\n  addSubscribers(\n    ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n  ): EventsBackend {\n    this.subscribers.push(...subscribers.flat());\n    return this;\n  }\n\n  /**\n   * Wires up and returns all component parts of the event management.\n   */\n  async start(): Promise<void> {\n    this.eventBroker.subscribe(this.subscribers);\n    this.publishers.forEach(publisher =>\n      publisher.setEventBroker(this.eventBroker),\n    );\n  }\n}\n"],"names":["__publicField","DefaultEventsService"],"mappings":";;;;;;;;;;;;;;;;AAiCO,MAAM,kBAA0C,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUrD,WAAA,CAAY,QAAuB,MAAwB,EAAA;AAT3D,IAAiBA,eAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AAUf,IAAA,IAAA,CAAK,SAAS,MAAU,IAAA,IAAA,GAAA,MAAA,GAAAC,qCAAA,CAAqB,MAAO,CAAA,EAAE,QAAQ,CAAA,CAAA;AAAA,GAChE;AAAA,EAEA,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAO,OAAA,IAAA,CAAK,MAAO,CAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,aACK,WACG,EAAA;AACN,IAAA,WAAA,CAAY,IAAK,EAAA,CAAE,OAAQ,CAAA,OAAM,UAAc,KAAA;AAC7C,MAAM,MAAA,IAAA,CAAK,OAAO,SAAU,CAAA;AAAA,QAC1B,EAAA,EAAI,WAAW,WAAY,CAAA,IAAA;AAAA,QAC3B,MAAA,EAAQ,WAAW,mBAAoB,EAAA;AAAA,QACvC,OAAS,EAAA,UAAA,CAAW,OAAQ,CAAA,IAAA,CAAK,UAAU,CAAA;AAAA,OAC5C,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;;;;;;;AChCO,MAAM,aAAc,CAAA;AAAA,EAKzB,YAAY,MAAgB,EAAA;AAJ5B,IAAQ,aAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA;AACR,IAAA,aAAA,CAAA,IAAA,EAAQ,cAA+B,EAAC,CAAA,CAAA;AACxC,IAAA,aAAA,CAAA,IAAA,EAAQ,eAAiC,EAAC,CAAA,CAAA;AAGxC,IAAK,IAAA,CAAA,WAAA,GAAc,IAAI,kBAAA,CAAmB,MAAM,CAAA,CAAA;AAAA,GAClD;AAAA,EAEA,eAAe,WAAyC,EAAA;AACtD,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AACnB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,iBACK,UACY,EAAA;AACf,IAAA,IAAA,CAAK,UAAW,CAAA,IAAA,CAAK,GAAG,UAAA,CAAW,MAAM,CAAA,CAAA;AACzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,kBACK,WACY,EAAA;AACf,IAAA,IAAA,CAAK,WAAY,CAAA,IAAA,CAAK,GAAG,WAAA,CAAY,MAAM,CAAA,CAAA;AAC3C,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAuB,GAAA;AAC3B,IAAK,IAAA,CAAA,WAAA,CAAY,SAAU,CAAA,IAAA,CAAK,WAAW,CAAA,CAAA;AAC3C,IAAA,IAAA,CAAK,UAAW,CAAA,OAAA;AAAA,MAAQ,CACtB,SAAA,KAAA,SAAA,CAAU,cAAe,CAAA,IAAA,CAAK,WAAW,CAAA;AAAA,KAC3C,CAAA;AAAA,GACF;AACF;;;;;;"}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import { EventBroker, EventPublisher, EventSubscriber, HttpPostIngressOptions, EventParams } from '@backstage/plugin-events-node';
+import { EventBroker, EventPublisher, EventSubscriber, EventsService, EventParams, HttpPostIngressOptions } from '@backstage/plugin-events-node';
 import { Logger } from 'winston';
+import { LoggerService } from '@backstage/backend-plugin-api';
 import { Config } from '@backstage/config';
 import express from 'express';
 
@@ -7,6 +8,7 @@ import express from 'express';
  * A builder that helps wire up all component parts of the event management.
  *
  * @public
+ * @deprecated `EventBroker`, `EventPublisher`, and `EventSubscriber` got replaced by `EventsService` and its methods.
  */
 declare class EventsBackend {
     private eventBroker;
@@ -22,43 +24,50 @@ declare class EventsBackend {
     start(): Promise<void>;
 }
 
+/**
+ * In process event broker which will pass the event to all registered subscribers
+ * interested in it.
+ * Events will not be persisted in any form.
+ *
+ * @public
+ * @deprecated use `DefaultEventsService` from `@backstage/plugin-events-node` instead
+ */
+declare class DefaultEventBroker implements EventBroker {
+    private readonly events;
+    /**
+     *
+     * @param logger - logger
+     * @param events - replacement that gets wrapped to support not yet migrated implementations.
+     * An instance can be passed (required for a mixed mode), otherwise a new instance gets created internally.
+     * @deprecated use `DefaultEventsService` directly instead
+     */
+    constructor(logger: LoggerService, events?: EventsService);
+    publish(params: EventParams): Promise<void>;
+    subscribe(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): void;
+}
+
 /**
  * Publishes events received from their origin (e.g., webhook events from an SCM system)
  * via HTTP POST endpoint and passes the request body as event payload to the registered subscribers.
  *
  * @public
  */
-declare class HttpPostIngressEventPublisher implements EventPublisher {
+declare class HttpPostIngressEventPublisher {
+    private readonly events;
     private readonly logger;
     private readonly ingresses;
-    private eventBroker?;
     static fromConfig(env: {
         config: Config;
+        events: EventsService;
         ingresses?: {
             [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;
         };
-        logger: Logger;
+        logger: LoggerService;
     }): HttpPostIngressEventPublisher;
     private constructor();
     bind(router: express.Router): void;
-    setEventBroker(eventBroker: EventBroker): Promise<void>;
     private createRouter;
     private addRouteForTopic;
 }
 
-/**
- * In process event broker which will pass the event to all registered subscribers
- * interested in it.
- * Events will not be persisted in any form.
- *
- * @public
- */
-declare class DefaultEventBroker implements EventBroker {
-    private readonly logger;
-    constructor(logger: Logger);
-    private readonly subscribers;
-    publish(params: EventParams): Promise<void>;
-    subscribe(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): void;
-}
-
 export { DefaultEventBroker, EventsBackend, HttpPostIngressEventPublisher };

package/package.json

@@ -1,12 +1,19 @@
 {
   "name": "@backstage/plugin-events-backend",
-  "version": "0.2.21",
-  "main": "./dist/index.cjs.js",
-  "types": "./dist/index.d.ts",
-  "license": "Apache-2.0",
+  "version": "0.3.0-next.0",
+  "backstage": {
+    "role": "backend-plugin"
+  },
   "publishConfig": {
     "access": "public"
   },
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/events-backend"
+  },
+  "license": "Apache-2.0",
   "exports": {
     ".": {
       "require": "./dist/index.cjs.js",
@@ -20,45 +27,38 @@
     },
     "./package.json": "./package.json"
   },
-  "backstage": {
-    "role": "backend-plugin"
-  },
-  "homepage": "https://backstage.io",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/backstage/backstage",
-    "directory": "plugins/events-backend"
-  },
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "config.d.ts",
+    "dist",
+    "alpha"
+  ],
   "scripts": {
-    "start": "backstage-cli package start",
     "build": "backstage-cli package build",
-    "lint": "backstage-cli package lint",
-    "test": "backstage-cli package test",
     "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
     "prepack": "backstage-cli package prepack",
-    "postpack": "backstage-cli package postpack"
+    "postpack": "backstage-cli package postpack",
+    "start": "backstage-cli package start",
+    "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.21.2",
-    "@backstage/backend-plugin-api": "^0.6.12",
-    "@backstage/config": "^1.1.1",
-    "@backstage/plugin-events-node": "^0.2.21",
+    "@backstage/backend-common": "^0.21.3-next.0",
+    "@backstage/backend-plugin-api": "^0.6.13-next.0",
+    "@backstage/config": "^1.1.2-next.0",
+    "@backstage/plugin-events-node": "^0.3.0-next.0",
     "@types/express": "^4.17.6",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.21.2",
-    "@backstage/backend-test-utils": "^0.3.2",
-    "@backstage/cli": "^0.25.2",
-    "@backstage/plugin-events-backend-test-utils": "^0.1.22",
+    "@backstage/backend-common": "^0.21.3-next.0",
+    "@backstage/backend-test-utils": "^0.3.3-next.0",
+    "@backstage/cli": "^0.25.3-next.0",
+    "@backstage/plugin-events-backend-test-utils": "^0.1.23-next.0",
     "supertest": "^6.1.3"
   },
-  "files": [
-    "config.d.ts",
-    "dist",
-    "alpha"
-  ],
   "configSchema": "config.d.ts"
 }

package/dist/cjs/HttpPostIngressEventPublisher-6e928c08.cjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"HttpPostIngressEventPublisher-6e928c08.cjs.js","sources":["../../src/service/DefaultEventBroker.ts","../../src/service/http/validation/RequestValidationContextImpl.ts","../../src/service/http/HttpPostIngressEventPublisher.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  EventBroker,\n  EventParams,\n  EventSubscriber,\n} from '@backstage/plugin-events-node';\nimport { Logger } from 'winston';\n\n/**\n * In 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 *\n * @public\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class DefaultEventBroker implements EventBroker {\n  constructor(private readonly logger: Logger) {}\n\n  private readonly subscribers: {\n    [topic: string]: EventSubscriber[];\n  } = {};\n\n  async publish(params: EventParams): Promise<void> {\n    this.logger.debug(\n      `Event received: topic=${params.topic}, metadata=${JSON.stringify(\n        params.metadata,\n      )}, payload=${JSON.stringify(params.eventPayload)}`,\n    );\n\n    const subscribed = this.subscribers[params.topic] ?? [];\n    await Promise.all(\n      subscribed.map(async subscriber => {\n        try {\n          await subscriber.onEvent(params);\n        } catch (error) {\n          this.logger.error(\n            `Subscriber \"${subscriber.constructor.name}\" failed to process event`,\n            error,\n          );\n        }\n      }),\n    );\n  }\n\n  subscribe(\n    ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n  ): void {\n    subscribers.flat().forEach(subscriber => {\n      subscriber.supportsEventTopics().forEach(topic => {\n        this.subscribers[topic] = this.subscribers[topic] ?? [];\n        this.subscribers[topic].push(subscriber);\n      });\n    });\n  }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  RequestRejectionDetails,\n  RequestValidationContext,\n} from '@backstage/plugin-events-node';\n\nexport class RequestValidationContextImpl implements RequestValidationContext {\n  #rejectionDetails: RequestRejectionDetails | undefined;\n\n  reject(details?: Partial<RequestRejectionDetails>): void {\n    this.#rejectionDetails = {\n      status: details?.status ?? 403,\n      payload: details?.payload ?? {},\n    };\n  }\n\n  wasRejected(): boolean {\n    return this.#rejectionDetails !== undefined;\n  }\n\n  get rejectionDetails() {\n    return this.#rejectionDetails;\n  }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { errorHandler } from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport {\n  EventBroker,\n  EventPublisher,\n  HttpPostIngressOptions,\n  RequestValidator,\n} from '@backstage/plugin-events-node';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { Logger } from 'winston';\nimport { RequestValidationContextImpl } from './validation';\n\n/**\n * Publishes events received from their origin (e.g., webhook events from an SCM system)\n * via HTTP POST endpoint and passes the request body as event payload to the registered subscribers.\n *\n * @public\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class HttpPostIngressEventPublisher implements EventPublisher {\n  private eventBroker?: EventBroker;\n\n  static fromConfig(env: {\n    config: Config;\n    ingresses?: { [topic: string]: Omit<HttpPostIngressOptions, 'topic'> };\n    logger: Logger;\n  }): HttpPostIngressEventPublisher {\n    const topics =\n      env.config.getOptionalStringArray('events.http.topics') ?? [];\n\n    const ingresses = env.ingresses ?? {};\n    topics.forEach(topic => {\n      // don't overwrite topic settings\n      // (e.g., added at the config as well as argument)\n      if (!ingresses[topic]) {\n        ingresses[topic] = {};\n      }\n    });\n\n    return new HttpPostIngressEventPublisher(env.logger, ingresses);\n  }\n\n  private constructor(\n    private readonly logger: Logger,\n    private readonly ingresses: {\n      [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n    },\n  ) {}\n\n  bind(router: express.Router): void {\n    router.use('/http', this.createRouter(this.ingresses));\n  }\n\n  async setEventBroker(eventBroker: EventBroker): Promise<void> {\n    this.eventBroker = eventBroker;\n  }\n\n  private createRouter(ingresses: {\n    [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n  }): express.Router {\n    const router = Router();\n    router.use(express.json());\n\n    Object.keys(ingresses).forEach(topic =>\n      this.addRouteForTopic(router, topic, ingresses[topic].validator),\n    );\n\n    router.use(errorHandler());\n    return router;\n  }\n\n  private addRouteForTopic(\n    router: express.Router,\n    topic: string,\n    validator?: RequestValidator,\n  ): void {\n    const path = `/${topic}`;\n\n    router.post(path, async (request, response) => {\n      const requestDetails = {\n        body: request.body,\n        headers: request.headers,\n      };\n      const context = new RequestValidationContextImpl();\n      await validator?.(requestDetails, context);\n      if (context.wasRejected()) {\n        response\n          .status(context.rejectionDetails!.status)\n          .json(context.rejectionDetails!.payload);\n        return;\n      }\n\n      const eventPayload = request.body;\n      await this.eventBroker!.publish({\n        topic,\n        eventPayload,\n        metadata: request.headers,\n      });\n\n      response.status(202).json({ status: 'accepted' });\n    });\n\n    // TODO(pjungermann): We don't really know the externally defined path prefix here,\n    //  however it is more useful for users to have it. Is there a better way?\n    this.logger.info(`Registered /api/events/http${path} to receive events`);\n  }\n}\n"],"names":["__publicField","Router","express","errorHandler"],"mappings":";;;;;;;;;;;;;;;;;AA+BO,MAAM,kBAA0C,CAAA;AAAA,EACrD,YAA6B,MAAgB,EAAA;AAAhB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAE7B,IAAAA,eAAA,CAAA,IAAA,EAAiB,eAEb,EAAC,CAAA,CAAA;AAAA,GAJyC;AAAA,EAM9C,MAAM,QAAQ,MAAoC,EAAA;AAtCpD,IAAA,IAAA,EAAA,CAAA;AAuCI,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,MAAM,cAAa,EAAK,GAAA,IAAA,CAAA,WAAA,CAAY,OAAO,KAAK,CAAA,KAA7B,YAAkC,EAAC,CAAA;AACtD,IAAA,MAAM,OAAQ,CAAA,GAAA;AAAA,MACZ,UAAA,CAAW,GAAI,CAAA,OAAM,UAAc,KAAA;AACjC,QAAI,IAAA;AACF,UAAM,MAAA,UAAA,CAAW,QAAQ,MAAM,CAAA,CAAA;AAAA,iBACxB,KAAO,EAAA;AACd,UAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,YACV,CAAA,YAAA,EAAe,UAAW,CAAA,WAAA,CAAY,IAAI,CAAA,yBAAA,CAAA;AAAA,YAC1C,KAAA;AAAA,WACF,CAAA;AAAA,SACF;AAAA,OACD,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,aACK,WACG,EAAA;AACN,IAAY,WAAA,CAAA,IAAA,EAAO,CAAA,OAAA,CAAQ,CAAc,UAAA,KAAA;AACvC,MAAW,UAAA,CAAA,mBAAA,EAAsB,CAAA,OAAA,CAAQ,CAAS,KAAA,KAAA;AAhExD,QAAA,IAAA,EAAA,CAAA;AAiEQ,QAAK,IAAA,CAAA,WAAA,CAAY,KAAK,CAAI,GAAA,CAAA,EAAA,GAAA,IAAA,CAAK,YAAY,KAAK,CAAA,KAAtB,YAA2B,EAAC,CAAA;AACtD,QAAA,IAAA,CAAK,WAAY,CAAA,KAAK,CAAE,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AAAA,OACxC,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;;;;;;;;;;;;;;;;;;;ACtEA,IAAA,iBAAA,CAAA;AAqBO,MAAM,4BAAiE,CAAA;AAAA,EAAvE,WAAA,GAAA;AACL,IAAA,YAAA,CAAA,IAAA,EAAA,iBAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAEA,OAAO,OAAkD,EAAA;AAxB3D,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAyBI,IAAA,YAAA,CAAA,IAAA,EAAK,iBAAoB,EAAA;AAAA,MACvB,MAAA,EAAA,CAAQ,EAAS,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAA,MAAA,KAAT,IAAmB,GAAA,EAAA,GAAA,GAAA;AAAA,MAC3B,OAAS,EAAA,CAAA,EAAA,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,OAAT,KAAA,IAAA,GAAA,EAAA,GAAoB,EAAC;AAAA,KAChC,CAAA,CAAA;AAAA,GACF;AAAA,EAEA,WAAuB,GAAA;AACrB,IAAA,OAAO,mBAAK,iBAAsB,CAAA,KAAA,KAAA,CAAA,CAAA;AAAA,GACpC;AAAA,EAEA,IAAI,gBAAmB,GAAA;AACrB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AAhBE,iBAAA,GAAA,IAAA,OAAA,EAAA;;;;;;;;ACcK,MAAM,6BAAwD,CAAA;AAAA,EAuB3D,WAAA,CACW,QACA,SAGjB,EAAA;AAJiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AAxBnB,IAAQ,aAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA;AAAA,GA2BL;AAAA,EAzBH,OAAO,WAAW,GAIgB,EAAA;AA3CpC,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AA4CI,IAAA,MAAM,UACJ,EAAI,GAAA,GAAA,CAAA,MAAA,CAAO,uBAAuB,oBAAoB,CAAA,KAAtD,YAA2D,EAAC,CAAA;AAE9D,IAAA,MAAM,SAAY,GAAA,CAAA,EAAA,GAAA,GAAA,CAAI,SAAJ,KAAA,IAAA,GAAA,EAAA,GAAiB,EAAC,CAAA;AACpC,IAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAGtB,MAAI,IAAA,CAAC,SAAU,CAAA,KAAK,CAAG,EAAA;AACrB,QAAU,SAAA,CAAA,KAAK,IAAI,EAAC,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,OAAO,IAAI,6BAAA,CAA8B,GAAI,CAAA,MAAA,EAAQ,SAAS,CAAA,CAAA;AAAA,GAChE;AAAA,EASA,KAAK,MAA8B,EAAA;AACjC,IAAA,MAAA,CAAO,IAAI,OAAS,EAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,SAAS,CAAC,CAAA,CAAA;AAAA,GACvD;AAAA,EAEA,MAAM,eAAe,WAAyC,EAAA;AAC5D,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AAAA,GACrB;AAAA,EAEQ,aAAa,SAEF,EAAA;AACjB,IAAA,MAAM,SAASC,0BAAO,EAAA,CAAA;AACtB,IAAO,MAAA,CAAA,GAAA,CAAIC,2BAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,IAAO,MAAA,CAAA,IAAA,CAAK,SAAS,CAAE,CAAA,OAAA;AAAA,MAAQ,CAAA,KAAA,KAC7B,KAAK,gBAAiB,CAAA,MAAA,EAAQ,OAAO,SAAU,CAAA,KAAK,EAAE,SAAS,CAAA;AAAA,KACjE,CAAA;AAEA,IAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEQ,gBAAA,CACN,MACA,EAAA,KAAA,EACA,SACM,EAAA;AACN,IAAM,MAAA,IAAA,GAAO,IAAI,KAAK,CAAA,CAAA,CAAA;AAEtB,IAAA,MAAA,CAAO,IAAK,CAAA,IAAA,EAAM,OAAO,OAAA,EAAS,QAAa,KAAA;AAC7C,MAAA,MAAM,cAAiB,GAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,SAAS,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA;AACA,MAAM,MAAA,OAAA,GAAU,IAAI,4BAA6B,EAAA,CAAA;AACjD,MAAA,OAAM,uCAAY,cAAgB,EAAA,OAAA,CAAA,CAAA,CAAA;AAClC,MAAI,IAAA,OAAA,CAAQ,aAAe,EAAA;AACzB,QACG,QAAA,CAAA,MAAA,CAAO,QAAQ,gBAAkB,CAAA,MAAM,EACvC,IAAK,CAAA,OAAA,CAAQ,iBAAkB,OAAO,CAAA,CAAA;AACzC,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,MAAM,eAAe,OAAQ,CAAA,IAAA,CAAA;AAC7B,MAAM,MAAA,IAAA,CAAK,YAAa,OAAQ,CAAA;AAAA,QAC9B,KAAA;AAAA,QACA,YAAA;AAAA,QACA,UAAU,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA,CAAA;AAED,MAAA,QAAA,CAAS,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,MAAA,EAAQ,YAAY,CAAA,CAAA;AAAA,KACjD,CAAA,CAAA;AAID,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAA8B,2BAAA,EAAA,IAAI,CAAoB,kBAAA,CAAA,CAAA,CAAA;AAAA,GACzE;AACF;;;;;"}