@backstage/plugin-events-backend 0.3.16-next.2 → 0.3.16

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @backstage/plugin-events-backend
 
+## 0.3.16
+
+### Patch Changes
+
+- e02a02b: Fix `events.useEventBus` by propagating config to `DefaultEventsService`
+- 9816f51: Add raw body information to `RequestDetails`
+  and use the raw body when validating incoming event requests.
+- b7d0334: Cleaning up event subscriptions after the max age window
+- Updated dependencies
+  - @backstage/config@1.3.0
+  - @backstage/plugin-events-node@0.4.5
+  - @backstage/types@1.2.0
+  - @backstage/backend-plugin-api@1.0.2
+  - @backstage/backend-openapi-utils@0.3.0
+  - @backstage/errors@1.2.5
+
+## 0.3.16-next.3
+
+### Patch Changes
+
+- 9816f51: Add raw body information to `RequestDetails`
+  and use the raw body when validating incoming event requests.
+- Updated dependencies
+  - @backstage/plugin-events-node@0.4.5-next.3
+  - @backstage/backend-openapi-utils@0.3.0-next.2
+  - @backstage/backend-plugin-api@1.0.2-next.2
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+
 ## 0.3.16-next.2
 
 ### Patch Changes

package/dist/service/EventsPlugin.cjs.js

@@ -45,21 +45,21 @@ const eventsPlugin = backendPluginApi.createBackendPlugin({
         config: backendPluginApi.coreServices.rootConfig,
         events: pluginEventsNode.eventsServiceRef,
         database: backendPluginApi.coreServices.database,
-        logger: backendPluginApi.coreServices.logger,
-        scheduler: backendPluginApi.coreServices.scheduler,
-        lifecycle: backendPluginApi.coreServices.lifecycle,
         httpAuth: backendPluginApi.coreServices.httpAuth,
-        router: backendPluginApi.coreServices.httpRouter
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        lifecycle: backendPluginApi.coreServices.lifecycle,
+        logger: backendPluginApi.coreServices.logger,
+        scheduler: backendPluginApi.coreServices.scheduler
       },
       async init({
         config,
         events,
         database,
-        logger,
-        scheduler,
-        lifecycle,
         httpAuth,
-        router
+        httpRouter,
+        lifecycle,
+        logger,
+        scheduler
       }) {
         const ingresses = Object.fromEntries(
           extensionPoint.httpPostIngresses.map((ingress) => [
@@ -75,17 +75,17 @@ const eventsPlugin = backendPluginApi.createBackendPlugin({
         });
         const eventsRouter = Router__default.default();
         http.bind(eventsRouter);
-        router.use(
+        httpRouter.use(eventsRouter);
+        httpRouter.use(
           await createEventBusRouter.createEventBusRouter({
             database,
+            lifecycle,
             logger,
             httpAuth,
-            scheduler,
-            lifecycle
+            scheduler
           })
         );
-        router.use(eventsRouter);
-        router.addAuthPolicy({
+        httpRouter.addAuthPolicy({
           allow: "unauthenticated",
           path: "/http"
         });

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

@@ -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 * @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;AAAA,EAEhD,eAAe,CAAc,EAAA;AAC3B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AACF,EAEA,cAAc,CAAc,EAAA;AAC1B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AACF,EAEA,eAAe,CAAc,EAAA;AAC3B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AACF,EAEA,mBAAmB,OAAiC,EAAA;AAClD,IAAK,IAAA,CAAA,kBAAA,CAAmB,KAAK,OAAO,CAAA;AAAA;AACtC,EAEA,IAAI,iBAAoB,GAAA;AACtB,IAAA,OAAO,IAAK,CAAA,kBAAA;AAAA;AAEhB;AAOO,MAAM,eAAeA,oCAAoB,CAAA;AAAA,EAC9C,QAAU,EAAA,QAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,cAAA,GAAiB,IAAI,wBAAyB,EAAA;AACpD,IAAI,GAAA,CAAA,sBAAA,CAAuBC,4BAAsB,cAAc,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;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;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;AAAA,WACD;AAAA,SACH;AAEA,QAAM,MAAA,IAAA,GAAOE,4DAA8B,UAAW,CAAA;AAAA,UACpD,MAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA;AAAA,SACD,CAAA;AACD,QAAA,MAAM,eAAeC,uBAAO,EAAA;AAC5B,QAAA,IAAA,CAAK,KAAK,YAAY,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;AAAA,WACD;AAAA,SACH;AAEA,QAAA,MAAA,CAAO,IAAI,YAAY,CAAA;AACvB,QAAA,MAAA,CAAO,aAAc,CAAA;AAAA,UACnB,KAAO,EAAA,iBAAA;AAAA,UACP,IAAM,EAAA;AAAA,SACP,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}
+{"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        httpAuth: coreServices.httpAuth,\n        httpRouter: coreServices.httpRouter,\n        lifecycle: coreServices.lifecycle,\n        logger: coreServices.logger,\n        scheduler: coreServices.scheduler,\n      },\n      async init({\n        config,\n        events,\n        database,\n        httpAuth,\n        httpRouter,\n        lifecycle,\n        logger,\n        scheduler,\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        // MUST be registered *before* the event bus router.\n        // Otherwise, it would already make use of `express.json()`\n        // that is used there as part of the middleware stack.\n        httpRouter.use(eventsRouter);\n\n        httpRouter.use(\n          await createEventBusRouter({\n            database,\n            lifecycle,\n            logger,\n            httpAuth,\n            scheduler,\n          }),\n        );\n\n        httpRouter.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;AAAA,EAEhD,eAAe,CAAc,EAAA;AAC3B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AACF,EAEA,cAAc,CAAc,EAAA;AAC1B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AACF,EAEA,eAAe,CAAc,EAAA;AAC3B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AACF,EAEA,mBAAmB,OAAiC,EAAA;AAClD,IAAK,IAAA,CAAA,kBAAA,CAAmB,KAAK,OAAO,CAAA;AAAA;AACtC,EAEA,IAAI,iBAAoB,GAAA;AACtB,IAAA,OAAO,IAAK,CAAA,kBAAA;AAAA;AAEhB;AAOO,MAAM,eAAeA,oCAAoB,CAAA;AAAA,EAC9C,QAAU,EAAA,QAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,cAAA,GAAiB,IAAI,wBAAyB,EAAA;AACpD,IAAI,GAAA,CAAA,sBAAA,CAAuBC,4BAAsB,cAAc,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,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,QAAA;AAAA,QACA,QAAA;AAAA,QACA,UAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAA;AAAA,QACA;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;AAAA,WACD;AAAA,SACH;AAEA,QAAM,MAAA,IAAA,GAAOE,4DAA8B,UAAW,CAAA;AAAA,UACpD,MAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA;AAAA,SACD,CAAA;AACD,QAAA,MAAM,eAAeC,uBAAO,EAAA;AAC5B,QAAA,IAAA,CAAK,KAAK,YAAY,CAAA;AAKtB,QAAA,UAAA,CAAW,IAAI,YAAY,CAAA;AAE3B,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,yCAAqB,CAAA;AAAA,YACzB,QAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA;AAAA,YACA,QAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAEA,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,KAAO,EAAA,iBAAA;AAAA,UACP,IAAM,EAAA;AAAA,SACP,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}

package/dist/service/http/HttpPostIngressEventPublisher.cjs.js

@@ -1,15 +1,32 @@
 'use strict';
 
 var backendCommon = require('@backstage/backend-common');
+var errors = require('@backstage/errors');
+var contentType = require('content-type');
 var express = require('express');
 var Router = require('express-promise-router');
 var RequestValidationContextImpl = require('./validation/RequestValidationContextImpl.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
+var contentType__default = /*#__PURE__*/_interopDefaultCompat(contentType);
 var express__default = /*#__PURE__*/_interopDefaultCompat(express);
 var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
 
+class UnsupportedCharsetError extends errors.CustomErrorBase {
+  name = "UnsupportedCharsetError";
+  statusCode = 415;
+  constructor(charset) {
+    super(`Unsupported charset: ${charset}`);
+  }
+}
+class UnsupportedMediaTypeError extends errors.CustomErrorBase {
+  name = "UnsupportedMediaTypeError";
+  statusCode = 415;
+  constructor(mediaType) {
+    super(`Unsupported media type: ${mediaType ?? "unknown"}`);
+  }
+}
 class HttpPostIngressEventPublisher {
   constructor(events, logger, ingresses) {
     this.events = events;
@@ -31,7 +48,7 @@ class HttpPostIngressEventPublisher {
   }
   createRouter(ingresses) {
     const router = Router__default.default();
-    router.use(express__default.default.json());
+    router.use(express__default.default.raw({ type: "*/*" }));
     Object.keys(ingresses).forEach(
       (topic) => this.addRouteForTopic(router, topic, ingresses[topic].validator)
     );
@@ -40,26 +57,49 @@ class HttpPostIngressEventPublisher {
   }
   addRouteForTopic(router, topic, validator) {
     const path = `/${topic}`;
+    const logger = this.logger;
     router.post(path, async (request, response) => {
-      const requestDetails = {
-        body: request.body,
-        headers: request.headers
-      };
-      const context = new RequestValidationContextImpl.RequestValidationContextImpl();
-      await validator?.(requestDetails, context);
-      if (context.wasRejected()) {
-        response.status(context.rejectionDetails.status).json(context.rejectionDetails.payload);
-        return;
+      const requestBody = request.body;
+      if (!Buffer.isBuffer(requestBody)) {
+        throw new Error(
+          `Failed to retrieve raw body from incoming event for topic ${topic}; not a buffer: ${typeof requestBody}`
+        );
+      }
+      const bodyBuffer = requestBody;
+      const parsedContentType = contentType__default.default.parse(request);
+      if (!parsedContentType.type || parsedContentType.type !== "application/json") {
+        throw new UnsupportedMediaTypeError(parsedContentType.type);
+      }
+      const encoding = parsedContentType.parameters.charset ?? "utf-8";
+      if (!Buffer.isEncoding(encoding)) {
+        throw new UnsupportedCharsetError(encoding);
+      }
+      const bodyString = bodyBuffer.toString(encoding);
+      const bodyParsed = parsedContentType.type === "application/json" ? JSON.parse(bodyString) : bodyString;
+      if (validator) {
+        const requestDetails = {
+          body: bodyParsed,
+          headers: request.headers,
+          raw: {
+            body: bodyBuffer,
+            encoding
+          }
+        };
+        const context = new RequestValidationContextImpl.RequestValidationContextImpl();
+        await validator(requestDetails, context);
+        if (context.wasRejected()) {
+          response.status(context.rejectionDetails.status).json(context.rejectionDetails.payload);
+          return;
+        }
       }
-      const eventPayload = request.body;
       await this.events.publish({
         topic,
-        eventPayload,
+        eventPayload: bodyParsed,
         metadata: request.headers
       });
       response.status(202).json({ status: "accepted" });
     });
-    this.logger.info(`Registered /api/events/http${path} to receive events`);
+    logger.info(`Registered /api/events/http${path} to receive events`);
   }
 }
 

package/dist/service/http/HttpPostIngressEventPublisher.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"HttpPostIngressEventPublisher.cjs.js","sources":["../../../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 { 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","RequestValidationContextImpl"],"mappings":";;;;;;;;;;;;AAmCO,MAAM,6BAA8B,CAAA;AAAA,EAsBjC,WAAA,CACW,MACA,EAAA,MAAA,EACA,SAGjB,EAAA;AALiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AAAA;AAGhB,EA3BH,OAAO,WAAW,GAKgB,EAAA;AAChC,IAAA,MAAM,SACJ,GAAI,CAAA,MAAA,CAAO,sBAAuB,CAAA,oBAAoB,KAAK,EAAC;AAE9D,IAAM,MAAA,SAAA,GAAY,GAAI,CAAA,SAAA,IAAa,EAAC;AACpC,IAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAGtB,MAAI,IAAA,CAAC,SAAU,CAAA,KAAK,CAAG,EAAA;AACrB,QAAU,SAAA,CAAA,KAAK,IAAI,EAAC;AAAA;AACtB,KACD,CAAA;AAED,IAAA,OAAO,IAAI,6BAA8B,CAAA,GAAA,CAAI,MAAQ,EAAA,GAAA,CAAI,QAAQ,SAAS,CAAA;AAAA;AAC5E,EAUA,KAAK,MAA8B,EAAA;AACjC,IAAA,MAAA,CAAO,IAAI,OAAS,EAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,SAAS,CAAC,CAAA;AAAA;AACvD,EAEQ,aAAa,SAEF,EAAA;AACjB,IAAA,MAAM,SAASA,uBAAO,EAAA;AACtB,IAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,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;AAAA,KACjE;AAEA,IAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA;AACzB,IAAO,OAAA,MAAA;AAAA;AACT,EAEQ,gBAAA,CACN,MACA,EAAA,KAAA,EACA,SACM,EAAA;AACN,IAAM,MAAA,IAAA,GAAO,IAAI,KAAK,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;AAAA,OACnB;AACA,MAAM,MAAA,OAAA,GAAU,IAAIC,yDAA6B,EAAA;AACjD,MAAM,MAAA,SAAA,GAAY,gBAAgB,OAAO,CAAA;AACzC,MAAI,IAAA,OAAA,CAAQ,aAAe,EAAA;AACzB,QACG,QAAA,CAAA,MAAA,CAAO,QAAQ,gBAAkB,CAAA,MAAM,EACvC,IAAK,CAAA,OAAA,CAAQ,iBAAkB,OAAO,CAAA;AACzC,QAAA;AAAA;AAGF,MAAA,MAAM,eAAe,OAAQ,CAAA,IAAA;AAC7B,MAAM,MAAA,IAAA,CAAK,OAAO,OAAQ,CAAA;AAAA,QACxB,KAAA;AAAA,QACA,YAAA;AAAA,QACA,UAAU,OAAQ,CAAA;AAAA,OACnB,CAAA;AAED,MAAA,QAAA,CAAS,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,MAAA,EAAQ,YAAY,CAAA;AAAA,KACjD,CAAA;AAID,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAA8B,2BAAA,EAAA,IAAI,CAAoB,kBAAA,CAAA,CAAA;AAAA;AAE3E;;;;"}
+{"version":3,"file":"HttpPostIngressEventPublisher.cjs.js","sources":["../../../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 { errorHandler } from '@backstage/backend-common';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { CustomErrorBase } from '@backstage/errors';\nimport {\n  EventsService,\n  HttpPostIngressOptions,\n  RequestValidator,\n} from '@backstage/plugin-events-node';\nimport contentType from 'content-type';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { RequestValidationContextImpl } from './validation';\n\nclass UnsupportedCharsetError extends CustomErrorBase {\n  name = 'UnsupportedCharsetError' as const;\n  statusCode = 415 as const;\n\n  constructor(charset: string) {\n    super(`Unsupported charset: ${charset}`);\n  }\n}\n\nclass UnsupportedMediaTypeError extends CustomErrorBase {\n  name = 'UnsupportedMediaTypeError' as const;\n  statusCode = 415 as const;\n\n  constructor(mediaType?: string) {\n    super(`Unsupported media type: ${mediaType ?? 'unknown'}`);\n  }\n}\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.raw({ type: '*/*' }));\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    const logger = this.logger;\n\n    router.post(path, async (request, response) => {\n      const requestBody = request.body;\n      if (!Buffer.isBuffer(requestBody)) {\n        throw new Error(\n          `Failed to retrieve raw body from incoming event for topic ${topic}; not a buffer: ${typeof requestBody}`,\n        );\n      }\n\n      const bodyBuffer: Buffer = requestBody;\n      const parsedContentType = contentType.parse(request);\n      if (\n        !parsedContentType.type ||\n        parsedContentType.type !== 'application/json'\n      ) {\n        throw new UnsupportedMediaTypeError(parsedContentType.type);\n      }\n\n      const encoding = parsedContentType.parameters.charset ?? 'utf-8';\n      if (!Buffer.isEncoding(encoding)) {\n        throw new UnsupportedCharsetError(encoding);\n      }\n\n      const bodyString = bodyBuffer.toString(encoding);\n      const bodyParsed =\n        parsedContentType.type === 'application/json'\n          ? JSON.parse(bodyString)\n          : bodyString;\n\n      if (validator) {\n        const requestDetails = {\n          body: bodyParsed,\n          headers: request.headers,\n          raw: {\n            body: bodyBuffer,\n            encoding: encoding as BufferEncoding,\n          },\n        };\n\n        const context = new RequestValidationContextImpl();\n        await validator(requestDetails, context);\n\n        if (context.wasRejected()) {\n          response\n            .status(context.rejectionDetails!.status)\n            .json(context.rejectionDetails!.payload);\n          return;\n        }\n      }\n\n      await this.events.publish({\n        topic,\n        eventPayload: bodyParsed,\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    logger.info(`Registered /api/events/http${path} to receive events`);\n  }\n}\n"],"names":["CustomErrorBase","Router","express","errorHandler","contentType","RequestValidationContextImpl"],"mappings":";;;;;;;;;;;;;;;AA8BA,MAAM,gCAAgCA,sBAAgB,CAAA;AAAA,EACpD,IAAO,GAAA,yBAAA;AAAA,EACP,UAAa,GAAA,GAAA;AAAA,EAEb,YAAY,OAAiB,EAAA;AAC3B,IAAM,KAAA,CAAA,CAAA,qBAAA,EAAwB,OAAO,CAAE,CAAA,CAAA;AAAA;AAE3C;AAEA,MAAM,kCAAkCA,sBAAgB,CAAA;AAAA,EACtD,IAAO,GAAA,2BAAA;AAAA,EACP,UAAa,GAAA,GAAA;AAAA,EAEb,YAAY,SAAoB,EAAA;AAC9B,IAAM,KAAA,CAAA,CAAA,wBAAA,EAA2B,SAAa,IAAA,SAAS,CAAE,CAAA,CAAA;AAAA;AAE7D;AASO,MAAM,6BAA8B,CAAA;AAAA,EAsBjC,WAAA,CACW,MACA,EAAA,MAAA,EACA,SAGjB,EAAA;AALiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AAAA;AAGhB,EA3BH,OAAO,WAAW,GAKgB,EAAA;AAChC,IAAA,MAAM,SACJ,GAAI,CAAA,MAAA,CAAO,sBAAuB,CAAA,oBAAoB,KAAK,EAAC;AAE9D,IAAM,MAAA,SAAA,GAAY,GAAI,CAAA,SAAA,IAAa,EAAC;AACpC,IAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAGtB,MAAI,IAAA,CAAC,SAAU,CAAA,KAAK,CAAG,EAAA;AACrB,QAAU,SAAA,CAAA,KAAK,IAAI,EAAC;AAAA;AACtB,KACD,CAAA;AAED,IAAA,OAAO,IAAI,6BAA8B,CAAA,GAAA,CAAI,MAAQ,EAAA,GAAA,CAAI,QAAQ,SAAS,CAAA;AAAA;AAC5E,EAUA,KAAK,MAA8B,EAAA;AACjC,IAAA,MAAA,CAAO,IAAI,OAAS,EAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,SAAS,CAAC,CAAA;AAAA;AACvD,EAEQ,aAAa,SAEF,EAAA;AACjB,IAAA,MAAM,SAASC,uBAAO,EAAA;AACtB,IAAA,MAAA,CAAO,IAAIC,wBAAQ,CAAA,GAAA,CAAI,EAAE,IAAM,EAAA,KAAA,EAAO,CAAC,CAAA;AAEvC,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;AAAA,KACjE;AAEA,IAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA;AACzB,IAAO,OAAA,MAAA;AAAA;AACT,EAEQ,gBAAA,CACN,MACA,EAAA,KAAA,EACA,SACM,EAAA;AACN,IAAM,MAAA,IAAA,GAAO,IAAI,KAAK,CAAA,CAAA;AACtB,IAAA,MAAM,SAAS,IAAK,CAAA,MAAA;AAEpB,IAAA,MAAA,CAAO,IAAK,CAAA,IAAA,EAAM,OAAO,OAAA,EAAS,QAAa,KAAA;AAC7C,MAAA,MAAM,cAAc,OAAQ,CAAA,IAAA;AAC5B,MAAA,IAAI,CAAC,MAAA,CAAO,QAAS,CAAA,WAAW,CAAG,EAAA;AACjC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAA6D,0DAAA,EAAA,KAAK,CAAmB,gBAAA,EAAA,OAAO,WAAW,CAAA;AAAA,SACzG;AAAA;AAGF,MAAA,MAAM,UAAqB,GAAA,WAAA;AAC3B,MAAM,MAAA,iBAAA,GAAoBC,4BAAY,CAAA,KAAA,CAAM,OAAO,CAAA;AACnD,MAAA,IACE,CAAC,iBAAA,CAAkB,IACnB,IAAA,iBAAA,CAAkB,SAAS,kBAC3B,EAAA;AACA,QAAM,MAAA,IAAI,yBAA0B,CAAA,iBAAA,CAAkB,IAAI,CAAA;AAAA;AAG5D,MAAM,MAAA,QAAA,GAAW,iBAAkB,CAAA,UAAA,CAAW,OAAW,IAAA,OAAA;AACzD,MAAA,IAAI,CAAC,MAAA,CAAO,UAAW,CAAA,QAAQ,CAAG,EAAA;AAChC,QAAM,MAAA,IAAI,wBAAwB,QAAQ,CAAA;AAAA;AAG5C,MAAM,MAAA,UAAA,GAAa,UAAW,CAAA,QAAA,CAAS,QAAQ,CAAA;AAC/C,MAAA,MAAM,aACJ,iBAAkB,CAAA,IAAA,KAAS,qBACvB,IAAK,CAAA,KAAA,CAAM,UAAU,CACrB,GAAA,UAAA;AAEN,MAAA,IAAI,SAAW,EAAA;AACb,QAAA,MAAM,cAAiB,GAAA;AAAA,UACrB,IAAM,EAAA,UAAA;AAAA,UACN,SAAS,OAAQ,CAAA,OAAA;AAAA,UACjB,GAAK,EAAA;AAAA,YACH,IAAM,EAAA,UAAA;AAAA,YACN;AAAA;AACF,SACF;AAEA,QAAM,MAAA,OAAA,GAAU,IAAIC,yDAA6B,EAAA;AACjD,QAAM,MAAA,SAAA,CAAU,gBAAgB,OAAO,CAAA;AAEvC,QAAI,IAAA,OAAA,CAAQ,aAAe,EAAA;AACzB,UACG,QAAA,CAAA,MAAA,CAAO,QAAQ,gBAAkB,CAAA,MAAM,EACvC,IAAK,CAAA,OAAA,CAAQ,iBAAkB,OAAO,CAAA;AACzC,UAAA;AAAA;AACF;AAGF,MAAM,MAAA,IAAA,CAAK,OAAO,OAAQ,CAAA;AAAA,QACxB,KAAA;AAAA,QACA,YAAc,EAAA,UAAA;AAAA,QACd,UAAU,OAAQ,CAAA;AAAA,OACnB,CAAA;AAED,MAAA,QAAA,CAAS,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,MAAA,EAAQ,YAAY,CAAA;AAAA,KACjD,CAAA;AAID,IAAO,MAAA,CAAA,IAAA,CAAK,CAA8B,2BAAA,EAAA,IAAI,CAAoB,kBAAA,CAAA,CAAA;AAAA;AAEtE;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-events-backend",
-  "version": "0.3.16-next.2",
+  "version": "0.3.16",
   "backstage": {
     "role": "backend-plugin",
     "pluginId": "events",
@@ -37,11 +37,20 @@
   },
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "index": [
+        "dist/index.d.ts"
+      ],
+      "alpha": [
+        "dist/alpha.d.ts"
+      ]
+    }
+  },
   "files": [
     "config.d.ts",
     "dist",
-    "migrations",
-    "alpha"
+    "migrations"
   ],
   "scripts": {
     "build": "backstage-cli package build",
@@ -55,25 +64,27 @@
   },
   "dependencies": {
     "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-openapi-utils": "0.3.0-next.2",
-    "@backstage/backend-plugin-api": "1.0.2-next.2",
-    "@backstage/config": "1.2.0",
-    "@backstage/errors": "1.2.4",
-    "@backstage/plugin-events-node": "0.4.5-next.2",
-    "@backstage/types": "1.1.1",
+    "@backstage/backend-openapi-utils": "^0.3.0",
+    "@backstage/backend-plugin-api": "^1.0.2",
+    "@backstage/config": "^1.3.0",
+    "@backstage/errors": "^1.2.5",
+    "@backstage/plugin-events-node": "^0.4.5",
+    "@backstage/types": "^1.2.0",
     "@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"
   },
   "devDependencies": {
-    "@backstage/backend-app-api": "1.0.2-next.2",
-    "@backstage/backend-defaults": "0.5.3-next.2",
-    "@backstage/backend-test-utils": "1.1.0-next.2",
-    "@backstage/cli": "0.29.0-next.2",
-    "@backstage/plugin-events-backend-test-utils": "0.1.38-next.2",
-    "@backstage/repo-tools": "0.11.0-next.2",
+    "@backstage/backend-app-api": "^1.0.2",
+    "@backstage/backend-defaults": "^0.5.3",
+    "@backstage/backend-test-utils": "^1.1.0",
+    "@backstage/cli": "^0.29.0",
+    "@backstage/plugin-events-backend-test-utils": "^0.1.38",
+    "@backstage/repo-tools": "^0.11.0",
+    "@types/content-type": "^1.1.8",
     "supertest": "^7.0.0"
   },
   "configSchema": "config.d.ts"

package/alpha/package.json

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