@backstage/plugin-events-backend-module-github 0.1.21 → 0.2.0-next.0

package/CHANGELOG.md

@@ -1,12 +1,83 @@
 # @backstage/plugin-events-backend-module-github
 
-## 0.1.21
+## 0.2.0-next.0
 
-### Patch Changes
+### Minor Changes
 
-- Updated dependencies
-  - @backstage/backend-plugin-api@0.6.11
-  - @backstage/plugin-events-node@0.2.20
+- eff3ca9: BREAKING CHANGE: Migrate `EventRouter` implementations from `EventBroker` to `EventsService`.
+
+  `EventRouter` uses the new `EventsService` instead of the `EventBroker` now,
+  causing a breaking change to its signature.
+
+  All of its extensions and implementations got adjusted accordingly.
+  (`SubTopicEventRouter`, `AzureDevOpsEventRouter`, `BitbucketCloudEventRouter`,
+  `GerritEventRouter`, `GithubEventRouter`, `GitlabEventRouter`)
+
+  Required adjustments were made to all backend modules for the new backend system,
+  now also making use of the `eventsServiceRef` instead of the `eventsExtensionPoint`.
+
+  **Migration:**
+
+  Example for implementations of `SubTopicEventRouter`:
+
+  ```diff
+    import {
+      EventParams,
+  +   EventsService,
+      SubTopicEventRouter,
+    } from '@backstage/plugin-events-node';
+
+    export class GithubEventRouter extends SubTopicEventRouter {
+  -   constructor() {
+  -     super('github');
+  +   constructor(options: { events: EventsService }) {
+  +     super({
+  +       events: options.events,
+  +       topic: 'github',
+  +     });
+      }
+
+  +   protected getSubscriberId(): string {
+  +     return 'GithubEventRouter';
+  +   }
+  +
+      // ...
+    }
+  ```
+
+  Example for a direct extension of `EventRouter`:
+
+  ```diff
+    class MyEventRouter extends EventRouter {
+  -   constructor(/* ... */) {
+  +   constructor(options: {
+  +     events: EventsService;
+  +     // ...
+  +   }) {
+  -     super();
+        // ...
+  +     super({
+  +       events: options.events,
+  +       topics: topics,
+  +     });
+      }
+  +
+  +   protected getSubscriberId(): string {
+  +     return 'MyEventRouter';
+  +   }
+  -
+  -   supportsEventTopics(): string[] {
+  -     return this.topics;
+  -   }
+    }
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-events-node@0.3.0-next.0
+  - @backstage/backend-plugin-api@0.6.13-next.0
+  - @backstage/config@1.1.2-next.0
 
 ## 0.1.20
 

package/README.md

@@ -1,9 +1,9 @@
 # events-backend-module-github
 
-Welcome to the `events-backend-module-github` backend plugin!
+Welcome to the `events-backend-module-github` backend module!
 
-This plugin is a module for the `events-backend` backend plugin
-and extends it with an `GithubEventRouter`.
+This package is a module for the `events-backend` backend plugin
+and extends the event system with an `GithubEventRouter`.
 
 The event router will subscribe to the topic `github`
 and route the events to more concrete topics based on the value
@@ -22,37 +22,49 @@ Please find all possible webhook event types at the
 
 ## Installation
 
-Install the [`events-backend` plugin](../events-backend/README.md).
-
-Install this module:
-
 ```bash
 # From your Backstage root directory
 yarn --cwd packages/backend add @backstage/plugin-events-backend-module-github
 ```
 
-Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`:
+### Event Router
 
-```diff
-+const githubEventRouter = new GithubEventRouter();
+```ts
+// packages/backend/src/index.ts
+import { eventsModuleGithubEventRouter } from '@backstage/plugin-events-backend-module-github/alpha';
+// ...
+backend.add(eventsModuleGithubEventRouter());
+```
 
-new EventsBackend(env.logger)
-+  .addPublishers(githubEventRouter)
-+  .addSubscribers(githubEventRouter);
-// [...]
+#### Legacy Backend System
+
+```ts
+// packages/backend/src/plugins/events.ts
+const eventRouter = new GithubEventRouter({ events: env.events });
+await eventRouter.subscribe();
 ```
 
 ### Signature Validator
 
+```ts
+// packages/backend/src/index.ts
+import { eventsModuleGithubWebhook } from '@backstage/plugin-events-backend-module-github/alpha';
+// ...
+backend.add(eventsModuleGithubWebhook());
+```
+
+#### Legacy Backend System
+
 Add the signature validator for the topic `github`:
 
 ```diff
-// at packages/backend/src/plugins/events.ts
+// packages/backend/src/plugins/events.ts
 + import { createGithubSignatureValidator } from '@backstage/plugin-events-backend-module-github';
-// [...]
-   const http = HttpPostIngressEventPublisher.fromConfig({
-     config: env.config,
-     ingresses: {
+  // [...]
+    const http = HttpPostIngressEventPublisher.fromConfig({
+      config: env.config,
+      events: env.events,
+      ingresses: {
 +       github: {
 +         validator: createGithubSignatureValidator(env.config),
 +       },
@@ -61,7 +73,7 @@ Add the signature validator for the topic `github`:
   });
 ```
 
-Additionally, you need to add the configuration:
+## Configuration
 
 ```yaml
 events:

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -3,10 +3,10 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
+var pluginEventsNode = require('@backstage/plugin-events-node');
+var GithubEventRouter = require('./cjs/GithubEventRouter-a54f8eae.cjs.js');
 var alpha = require('@backstage/plugin-events-node/alpha');
-var GithubEventRouter = require('./cjs/GithubEventRouter-21610cd1.cjs.js');
 require('@octokit/webhooks-methods');
-require('@backstage/plugin-events-node');
 
 const eventsModuleGithubEventRouter = backendPluginApi.createBackendModule({
   pluginId: "events",
@@ -14,12 +14,11 @@ const eventsModuleGithubEventRouter = backendPluginApi.createBackendModule({
   register(env) {
     env.registerInit({
       deps: {
-        events: alpha.eventsExtensionPoint
+        events: pluginEventsNode.eventsServiceRef
       },
       async init({ events }) {
-        const eventRouter = new GithubEventRouter.GithubEventRouter();
-        events.addPublishers(eventRouter);
-        events.addSubscribers(eventRouter);
+        const eventRouter = new GithubEventRouter.GithubEventRouter({ events });
+        await eventRouter.subscribe();
       }
     });
   }

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/service/eventsModuleGithubEventRouter.ts","../src/service/eventsModuleGithubWebhook.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 { createBackendModule } from '@backstage/backend-plugin-api';\nimport { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha';\nimport { GithubEventRouter } from '../router/GithubEventRouter';\n\n/**\n * Module for the events-backend plugin, adding an event router for GitHub.\n *\n * Registers the `GithubEventRouter`.\n *\n * @alpha\n */\nexport const eventsModuleGithubEventRouter = createBackendModule({\n  pluginId: 'events',\n  moduleId: 'github-event-router',\n  register(env) {\n    env.registerInit({\n      deps: {\n        events: eventsExtensionPoint,\n      },\n      async init({ events }) {\n        const eventRouter = new GithubEventRouter();\n\n        events.addPublishers(eventRouter);\n        events.addSubscribers(eventRouter);\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  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha';\nimport { createGithubSignatureValidator } from '../http/createGithubSignatureValidator';\n\n/**\n * Module for the events-backend plugin,\n * registering an HTTP POST ingress with request validator\n * which verifies the webhook signature based on a secret.\n *\n * @alpha\n */\nexport const eventsModuleGithubWebhook = createBackendModule({\n  pluginId: 'events',\n  moduleId: 'github-webhook',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        events: eventsExtensionPoint,\n      },\n      async init({ config, events }) {\n        events.addHttpPostIngress({\n          topic: 'github',\n          validator: createGithubSignatureValidator(config),\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","eventsExtensionPoint","GithubEventRouter","coreServices","createGithubSignatureValidator"],"mappings":";;;;;;;;;;AA2BO,MAAM,gCAAgCA,oCAAoB,CAAA;AAAA,EAC/D,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,qBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAQ,EAAAC,0BAAA;AAAA,OACV;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,MAAA,EAAU,EAAA;AACrB,QAAM,MAAA,WAAA,GAAc,IAAIC,mCAAkB,EAAA,CAAA;AAE1C,QAAA,MAAA,CAAO,cAAc,WAAW,CAAA,CAAA;AAChC,QAAA,MAAA,CAAO,eAAe,WAAW,CAAA,CAAA;AAAA,OACnC;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;ACbM,MAAM,4BAA4BF,oCAAoB,CAAA;AAAA,EAC3D,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,gBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQG,6BAAa,CAAA,UAAA;AAAA,QACrB,MAAQ,EAAAF,0BAAA;AAAA,OACV;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,MAAA,EAAQ,QAAU,EAAA;AAC7B,QAAA,MAAA,CAAO,kBAAmB,CAAA;AAAA,UACxB,KAAO,EAAA,QAAA;AAAA,UACP,SAAA,EAAWG,iDAA+B,MAAM,CAAA;AAAA,SACjD,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/service/eventsModuleGithubEventRouter.ts","../src/service/eventsModuleGithubWebhook.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 { createBackendModule } from '@backstage/backend-plugin-api';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\nimport { GithubEventRouter } from '../router/GithubEventRouter';\n\n/**\n * Module for the events-backend plugin, adding an event router for GitHub.\n *\n * Registers the `GithubEventRouter`.\n *\n * @alpha\n */\nexport const eventsModuleGithubEventRouter = createBackendModule({\n  pluginId: 'events',\n  moduleId: 'github-event-router',\n  register(env) {\n    env.registerInit({\n      deps: {\n        events: eventsServiceRef,\n      },\n      async init({ events }) {\n        const eventRouter = new GithubEventRouter({ events });\n        await eventRouter.subscribe();\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  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha';\nimport { createGithubSignatureValidator } from '../http/createGithubSignatureValidator';\n\n/**\n * Module for the events-backend plugin,\n * registering an HTTP POST ingress with request validator\n * which verifies the webhook signature based on a secret.\n *\n * @alpha\n */\nexport const eventsModuleGithubWebhook = createBackendModule({\n  pluginId: 'events',\n  moduleId: 'github-webhook',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        events: eventsExtensionPoint,\n      },\n      async init({ config, events }) {\n        events.addHttpPostIngress({\n          topic: 'github',\n          validator: createGithubSignatureValidator(config),\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","eventsServiceRef","GithubEventRouter","coreServices","eventsExtensionPoint","createGithubSignatureValidator"],"mappings":";;;;;;;;;;AA2BO,MAAM,gCAAgCA,oCAAoB,CAAA;AAAA,EAC/D,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,qBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAQ,EAAAC,iCAAA;AAAA,OACV;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,MAAA,EAAU,EAAA;AACrB,QAAA,MAAM,WAAc,GAAA,IAAIC,mCAAkB,CAAA,EAAE,QAAQ,CAAA,CAAA;AACpD,QAAA,MAAM,YAAY,SAAU,EAAA,CAAA;AAAA,OAC9B;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;ACXM,MAAM,4BAA4BF,oCAAoB,CAAA;AAAA,EAC3D,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,gBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQG,6BAAa,CAAA,UAAA;AAAA,QACrB,MAAQ,EAAAC,0BAAA;AAAA,OACV;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,MAAA,EAAQ,QAAU,EAAA;AAC7B,QAAA,MAAA,CAAO,kBAAmB,CAAA;AAAA,UACxB,KAAO,EAAA,QAAA;AAAA,UACP,SAAA,EAAWC,iDAA+B,MAAM,CAAA;AAAA,SACjD,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/cjs/{GithubEventRouter-21610cd1.cjs.js → GithubEventRouter-a54f8eae.cjs.js}

@@ -17,8 +17,14 @@ function createGithubSignatureValidator(config) {
 }
 
 class GithubEventRouter extends pluginEventsNode.SubTopicEventRouter {
-  constructor() {
-    super("github");
+  constructor(options) {
+    super({
+      events: options.events,
+      topic: "github"
+    });
+  }
+  getSubscriberId() {
+    return "GithubEventRouter";
   }
   determineSubTopic(params) {
     var _a;
@@ -28,4 +34,4 @@ class GithubEventRouter extends pluginEventsNode.SubTopicEventRouter {
 
 exports.GithubEventRouter = GithubEventRouter;
 exports.createGithubSignatureValidator = createGithubSignatureValidator;
-//# sourceMappingURL=GithubEventRouter-21610cd1.cjs.js.map
+//# sourceMappingURL=GithubEventRouter-a54f8eae.cjs.js.map

package/dist/cjs/{GithubEventRouter-21610cd1.cjs.js.map → GithubEventRouter-a54f8eae.cjs.js.map}

@@ -1 +1 @@
-{"version":3,"file":"GithubEventRouter-21610cd1.cjs.js","sources":["../../src/http/createGithubSignatureValidator.ts","../../src/router/GithubEventRouter.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 { Config } from '@backstage/config';\nimport {\n  RequestDetails,\n  RequestValidationContext,\n  RequestValidator,\n} from '@backstage/plugin-events-node';\nimport { verify } from '@octokit/webhooks-methods';\n\n/**\n * Validates that the request received is the expected GitHub request\n * using the signature received with the `x-hub-signature-256` header\n * which is based on a secret token configured at GitHub and here.\n *\n * See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks\n * for more details.\n *\n * @param config - root config\n * @public\n */\nexport function createGithubSignatureValidator(\n  config: Config,\n): RequestValidator {\n  const secret = config.getString('events.modules.github.webhookSecret');\n\n  return async (\n    request: RequestDetails,\n    context: RequestValidationContext,\n  ): Promise<void> => {\n    const signature = request.headers['x-hub-signature-256'] as\n      | string\n      | undefined;\n\n    if (\n      !signature ||\n      !(await verify(secret, JSON.stringify(request.body), signature))\n    ) {\n      context.reject({\n        status: 403,\n        payload: { message: 'invalid signature' },\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  EventParams,\n  SubTopicEventRouter,\n} from '@backstage/plugin-events-node';\n\n/**\n * Subscribes to the generic `github` topic\n * and publishes the events under the more concrete sub-topic\n * depending on the `x-github-event` provided.\n *\n * @public\n */\nexport class GithubEventRouter extends SubTopicEventRouter {\n  constructor() {\n    super('github');\n  }\n\n  protected determineSubTopic(params: EventParams): string | undefined {\n    return params.metadata?.['x-github-event'] as string | undefined;\n  }\n}\n"],"names":["verify","SubTopicEventRouter"],"mappings":";;;;;AAmCO,SAAS,+BACd,MACkB,EAAA;AAClB,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,SAAA,CAAU,qCAAqC,CAAA,CAAA;AAErE,EAAO,OAAA,OACL,SACA,OACkB,KAAA;AAClB,IAAM,MAAA,SAAA,GAAY,OAAQ,CAAA,OAAA,CAAQ,qBAAqB,CAAA,CAAA;AAIvD,IAAA,IACE,CAAC,SAAA,IACD,CAAE,MAAMA,sBAAO,CAAA,MAAA,EAAQ,IAAK,CAAA,SAAA,CAAU,OAAQ,CAAA,IAAI,CAAG,EAAA,SAAS,CAC9D,EAAA;AACA,MAAA,OAAA,CAAQ,MAAO,CAAA;AAAA,QACb,MAAQ,EAAA,GAAA;AAAA,QACR,OAAA,EAAS,EAAE,OAAA,EAAS,mBAAoB,EAAA;AAAA,OACzC,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;AC9BO,MAAM,0BAA0BC,oCAAoB,CAAA;AAAA,EACzD,WAAc,GAAA;AACZ,IAAA,KAAA,CAAM,QAAQ,CAAA,CAAA;AAAA,GAChB;AAAA,EAEU,kBAAkB,MAAyC,EAAA;AAjCvE,IAAA,IAAA,EAAA,CAAA;AAkCI,IAAO,OAAA,CAAA,EAAA,GAAA,MAAA,CAAO,aAAP,IAAkB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,gBAAA,CAAA,CAAA;AAAA,GAC3B;AACF;;;;;"}
+{"version":3,"file":"GithubEventRouter-a54f8eae.cjs.js","sources":["../../src/http/createGithubSignatureValidator.ts","../../src/router/GithubEventRouter.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 { Config } from '@backstage/config';\nimport {\n  RequestDetails,\n  RequestValidationContext,\n  RequestValidator,\n} from '@backstage/plugin-events-node';\nimport { verify } from '@octokit/webhooks-methods';\n\n/**\n * Validates that the request received is the expected GitHub request\n * using the signature received with the `x-hub-signature-256` header\n * which is based on a secret token configured at GitHub and here.\n *\n * See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks\n * for more details.\n *\n * @param config - root config\n * @public\n */\nexport function createGithubSignatureValidator(\n  config: Config,\n): RequestValidator {\n  const secret = config.getString('events.modules.github.webhookSecret');\n\n  return async (\n    request: RequestDetails,\n    context: RequestValidationContext,\n  ): Promise<void> => {\n    const signature = request.headers['x-hub-signature-256'] as\n      | string\n      | undefined;\n\n    if (\n      !signature ||\n      !(await verify(secret, JSON.stringify(request.body), signature))\n    ) {\n      context.reject({\n        status: 403,\n        payload: { message: 'invalid signature' },\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  EventParams,\n  EventsService,\n  SubTopicEventRouter,\n} from '@backstage/plugin-events-node';\n\n/**\n * Subscribes to the generic `github` topic\n * and publishes the events under the more concrete sub-topic\n * depending on the `x-github-event` provided.\n *\n * @public\n */\nexport class GithubEventRouter extends SubTopicEventRouter {\n  constructor(options: { events: EventsService }) {\n    super({\n      events: options.events,\n      topic: 'github',\n    });\n  }\n\n  protected getSubscriberId(): string {\n    return 'GithubEventRouter';\n  }\n\n  protected determineSubTopic(params: EventParams): string | undefined {\n    return params.metadata?.['x-github-event'] as string | undefined;\n  }\n}\n"],"names":["verify","SubTopicEventRouter"],"mappings":";;;;;AAmCO,SAAS,+BACd,MACkB,EAAA;AAClB,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,SAAA,CAAU,qCAAqC,CAAA,CAAA;AAErE,EAAO,OAAA,OACL,SACA,OACkB,KAAA;AAClB,IAAM,MAAA,SAAA,GAAY,OAAQ,CAAA,OAAA,CAAQ,qBAAqB,CAAA,CAAA;AAIvD,IAAA,IACE,CAAC,SAAA,IACD,CAAE,MAAMA,sBAAO,CAAA,MAAA,EAAQ,IAAK,CAAA,SAAA,CAAU,OAAQ,CAAA,IAAI,CAAG,EAAA,SAAS,CAC9D,EAAA;AACA,MAAA,OAAA,CAAQ,MAAO,CAAA;AAAA,QACb,MAAQ,EAAA,GAAA;AAAA,QACR,OAAA,EAAS,EAAE,OAAA,EAAS,mBAAoB,EAAA;AAAA,OACzC,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;AC7BO,MAAM,0BAA0BC,oCAAoB,CAAA;AAAA,EACzD,YAAY,OAAoC,EAAA;AAC9C,IAAM,KAAA,CAAA;AAAA,MACJ,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,KAAO,EAAA,QAAA;AAAA,KACR,CAAA,CAAA;AAAA,GACH;AAAA,EAEU,eAA0B,GAAA;AAClC,IAAO,OAAA,mBAAA,CAAA;AAAA,GACT;AAAA,EAEU,kBAAkB,MAAyC,EAAA;AAzCvE,IAAA,IAAA,EAAA,CAAA;AA0CI,IAAO,OAAA,CAAA,EAAA,GAAA,MAAA,CAAO,aAAP,IAAkB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,gBAAA,CAAA,CAAA;AAAA,GAC3B;AACF;;;;;"}

package/dist/index.cjs.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var GithubEventRouter = require('./cjs/GithubEventRouter-21610cd1.cjs.js');
+var GithubEventRouter = require('./cjs/GithubEventRouter-a54f8eae.cjs.js');
 require('@octokit/webhooks-methods');
 require('@backstage/plugin-events-node');
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Config } from '@backstage/config';
-import { RequestValidator, SubTopicEventRouter, EventParams } from '@backstage/plugin-events-node';
+import { RequestValidator, SubTopicEventRouter, EventsService, EventParams } from '@backstage/plugin-events-node';
 
 /**
  * Validates that the request received is the expected GitHub request
@@ -22,7 +22,10 @@ declare function createGithubSignatureValidator(config: Config): RequestValidato
  * @public
  */
 declare class GithubEventRouter extends SubTopicEventRouter {
-    constructor();
+    constructor(options: {
+        events: EventsService;
+    });
+    protected getSubscriberId(): string;
     protected determineSubTopic(params: EventParams): string | undefined;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-events-backend-module-github",
-  "version": "0.1.21",
+  "version": "0.2.0-next.0",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
@@ -39,16 +39,15 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^0.6.11",
-    "@backstage/config": "^1.1.1",
-    "@backstage/plugin-events-node": "^0.2.20",
-    "@octokit/webhooks-methods": "^3.0.0",
-    "winston": "^3.2.1"
+    "@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",
+    "@octokit/webhooks-methods": "^3.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.3.1",
-    "@backstage/cli": "^0.25.2",
-    "@backstage/plugin-events-backend-test-utils": "^0.1.21"
+    "@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"
   },
   "files": [
     "config.d.ts",