@backstage/plugin-events-backend 0.4.4-next.2 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @backstage/plugin-events-backend
 
+## 0.5.0
+
+### Minor Changes
+
+- ee519c5: **BREAKING** Removed deprecated events related code
+- bda96a7: **BREAKING** Removed support for the legacy backend, please migrate to the new backend system. Also removed deprecated code.
+
+### Patch Changes
+
+- 2f4d3bc: Allow webhook content to be 5mb instead the default 100kb
+- b95aa77: add `addHttpPostBodyParser` to events extension to allow body parse customization. This feature will enhance flexibility in handling HTTP POST requests in event-related operations.
+- Updated dependencies
+  - @backstage/plugin-events-node@0.4.9
+  - @backstage/backend-openapi-utils@0.5.1
+  - @backstage/backend-plugin-api@1.2.1
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+
 ## 0.4.4-next.2
 
 ### Patch Changes

package/README.md

@@ -26,58 +26,6 @@ yarn --cwd packages/backend add @backstage/plugin-events-backend
 backend.add(import('@backstage/plugin-events-backend'));
 ```
 
-### Legacy Backend System
-
-```ts
-// packages/backend/src/plugins/events.ts
-import { HttpPostIngressEventPublisher } from '@backstage/plugin-events-backend';
-import { Router } from 'express';
-import { PluginEnvironment } from '../types';
-
-export default async function createPlugin(
-  env: PluginEnvironment,
-): Promise<Router> {
-  const eventsRouter = Router();
-
-  const http = HttpPostIngressEventPublisher.fromConfig({
-    config: env.config,
-    events: env.events,
-    logger: env.logger,
-  });
-  http.bind(eventsRouter);
-
-  return eventsRouter;
-}
-```
-
-### 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;
- }
-```
-
 ## Configuration
 
 In order to create HTTP endpoints to receive events for a certain
@@ -181,19 +129,3 @@ export const eventsModuleYourFeature = createBackendModule({
 We have the following default parsers:
 
 - `application/json`
-
-#### Legacy Backend System
-
-```ts
-const http = HttpPostIngressEventPublisher.fromConfig({
-  config: env.config,
-  events: env.events,
-  ingresses: {
-    yourTopic: {
-      validator: yourValidator,
-    },
-  },
-  logger: env.logger,
-});
-http.bind(router);
-```

package/dist/index.cjs.js

@@ -3,14 +3,10 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var EventsPlugin = require('./service/EventsPlugin.cjs.js');
-var EventsBackend = require('./service/EventsBackend.cjs.js');
-var DefaultEventBroker = require('./service/DefaultEventBroker.cjs.js');
 var HttpPostIngressEventPublisher = require('./service/http/HttpPostIngressEventPublisher.cjs.js');
 
 
 
 exports.default = EventsPlugin.eventsPlugin;
-exports.EventsBackend = EventsBackend.EventsBackend;
-exports.DefaultEventBroker = DefaultEventBroker.DefaultEventBroker;
 exports.HttpPostIngressEventPublisher = HttpPostIngressEventPublisher.HttpPostIngressEventPublisher;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,8 +1,7 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { LoggerService } from '@backstage/backend-plugin-api';
-import { EventBroker, EventPublisher, EventSubscriber, EventsService, EventParams, HttpPostIngressOptions, HttpBodyParser } from '@backstage/plugin-events-node';
-import { Logger } from 'winston';
 import { Config } from '@backstage/config';
+import { EventsService, HttpPostIngressOptions, HttpBodyParser } from '@backstage/plugin-events-node';
 import express from 'express';
 
 /**
@@ -12,48 +11,6 @@ import express from 'express';
  */
 declare const eventsPlugin: _backstage_backend_plugin_api.BackendFeature;
 
-/**
- * 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;
-    private publishers;
-    private subscribers;
-    constructor(logger: Logger);
-    setEventBroker(eventBroker: EventBroker): EventsBackend;
-    addPublishers(...publishers: Array<EventPublisher | Array<EventPublisher>>): EventsBackend;
-    addSubscribers(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): EventsBackend;
-    /**
-     * Wires up and returns all component parts of the event management.
-     */
-    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.
@@ -82,4 +39,4 @@ declare class HttpPostIngressEventPublisher {
     private addRouteForTopic;
 }
 
-export { DefaultEventBroker, EventsBackend, HttpPostIngressEventPublisher, eventsPlugin as default };
+export { HttpPostIngressEventPublisher, eventsPlugin as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-events-backend",
-  "version": "0.4.4-next.2",
+  "version": "0.5.0",
   "backstage": {
     "role": "backend-plugin",
     "pluginId": "events",
@@ -67,27 +67,25 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-openapi-utils": "0.5.1-next.1",
-    "@backstage/backend-plugin-api": "1.2.1-next.1",
-    "@backstage/config": "1.3.2",
-    "@backstage/errors": "1.2.7",
-    "@backstage/plugin-events-node": "0.4.9-next.2",
-    "@backstage/types": "1.2.1",
+    "@backstage/backend-openapi-utils": "^0.5.1",
+    "@backstage/backend-plugin-api": "^1.2.1",
+    "@backstage/config": "^1.3.2",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/plugin-events-node": "^0.4.9",
+    "@backstage/types": "^1.2.1",
     "@types/express": "^4.17.6",
     "content-type": "^1.0.5",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
-    "knex": "^3.0.0",
-    "winston": "^3.2.1"
+    "knex": "^3.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-app-api": "1.2.1-next.2",
-    "@backstage/backend-defaults": "0.8.2-next.2",
-    "@backstage/backend-test-utils": "1.3.1-next.2",
-    "@backstage/cli": "0.31.0-next.1",
-    "@backstage/plugin-events-backend-test-utils": "0.1.42-next.2",
-    "@backstage/repo-tools": "0.13.1-next.2",
+    "@backstage/backend-app-api": "^1.2.1",
+    "@backstage/backend-defaults": "^0.8.2",
+    "@backstage/backend-test-utils": "^1.3.1",
+    "@backstage/cli": "^0.31.0",
+    "@backstage/plugin-events-backend-test-utils": "^0.1.42",
+    "@backstage/repo-tools": "^0.13.1",
     "@types/content-type": "^1.1.8",
     "supertest": "^7.0.0"
   },

package/dist/service/DefaultEventBroker.cjs.js

@@ -1,32 +0,0 @@
-'use strict';
-
-var pluginEventsNode = require('@backstage/plugin-events-node');
-
-class DefaultEventBroker {
-  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, events) {
-    this.events = events ?? pluginEventsNode.DefaultEventsService.create({ logger, useEventBus: "never" });
-  }
-  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)
-      });
-    });
-  }
-}
-
-exports.DefaultEventBroker = DefaultEventBroker;
-//# sourceMappingURL=DefaultEventBroker.cjs.js.map

package/dist/service/DefaultEventBroker.cjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"DefaultEventBroker.cjs.js","sources":["../../src/service/DefaultEventBroker.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 =\n      events ?? DefaultEventsService.create({ logger, useEventBus: 'never' });\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"],"names":["DefaultEventsService"],"mappings":";;;;AAiCO,MAAM,kBAA0C,CAAA;AAAA,EACpC,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASjB,WAAA,CAAY,QAAuB,MAAwB,EAAA;AACzD,IAAK,IAAA,CAAA,MAAA,GACH,UAAUA,qCAAqB,CAAA,MAAA,CAAO,EAAE,MAAQ,EAAA,WAAA,EAAa,SAAS,CAAA;AAAA;AAC1E,EAEA,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAO,OAAA,IAAA,CAAK,MAAO,CAAA,OAAA,CAAQ,MAAM,CAAA;AAAA;AACnC,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;AAAA,OAC5C,CAAA;AAAA,KACF,CAAA;AAAA;AAEL;;;;"}

package/dist/service/EventsBackend.cjs.js

@@ -1,36 +0,0 @@
-'use strict';
-
-var DefaultEventBroker = require('./DefaultEventBroker.cjs.js');
-
-class EventsBackend {
-  eventBroker;
-  publishers = [];
-  subscribers = [];
-  constructor(logger) {
-    this.eventBroker = new DefaultEventBroker.DefaultEventBroker(logger);
-  }
-  setEventBroker(eventBroker) {
-    this.eventBroker = eventBroker;
-    return this;
-  }
-  addPublishers(...publishers) {
-    this.publishers.push(...publishers.flat());
-    return this;
-  }
-  addSubscribers(...subscribers) {
-    this.subscribers.push(...subscribers.flat());
-    return this;
-  }
-  /**
-   * Wires up and returns all component parts of the event management.
-   */
-  async start() {
-    this.eventBroker.subscribe(this.subscribers);
-    this.publishers.forEach(
-      (publisher) => publisher.setEventBroker(this.eventBroker)
-    );
-  }
-}
-
-exports.EventsBackend = EventsBackend;
-//# sourceMappingURL=EventsBackend.cjs.js.map

package/dist/service/EventsBackend.cjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"EventsBackend.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 * @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":["DefaultEventBroker"],"mappings":";;;;AA8BO,MAAM,aAAc,CAAA;AAAA,EACjB,WAAA;AAAA,EACA,aAA+B,EAAC;AAAA,EAChC,cAAiC,EAAC;AAAA,EAE1C,YAAY,MAAgB,EAAA;AAC1B,IAAK,IAAA,CAAA,WAAA,GAAc,IAAIA,qCAAA,CAAmB,MAAM,CAAA;AAAA;AAClD,EAEA,eAAe,WAAyC,EAAA;AACtD,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA;AACnB,IAAO,OAAA,IAAA;AAAA;AACT,EAEA,iBACK,UACY,EAAA;AACf,IAAA,IAAA,CAAK,UAAW,CAAA,IAAA,CAAK,GAAG,UAAA,CAAW,MAAM,CAAA;AACzC,IAAO,OAAA,IAAA;AAAA;AACT,EAEA,kBACK,WACY,EAAA;AACf,IAAA,IAAA,CAAK,WAAY,CAAA,IAAA,CAAK,GAAG,WAAA,CAAY,MAAM,CAAA;AAC3C,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,MAAM,KAAuB,GAAA;AAC3B,IAAK,IAAA,CAAA,WAAA,CAAY,SAAU,CAAA,IAAA,CAAK,WAAW,CAAA;AAC3C,IAAA,IAAA,CAAK,UAAW,CAAA,OAAA;AAAA,MAAQ,CACtB,SAAA,KAAA,SAAA,CAAU,cAAe,CAAA,IAAA,CAAK,WAAW;AAAA,KAC3C;AAAA;AAEJ;;;;"}