@backstage/plugin-events-backend-module-gerrit 0.1.22 → 0.2.0-next.0

package/CHANGELOG.md

@@ -1,20 +1,82 @@
 # @backstage/plugin-events-backend-module-gerrit
 
-## 0.1.22
+## 0.2.0-next.0
 
-### Patch Changes
-
-- Updated dependencies
-  - @backstage/backend-plugin-api@0.6.12
-  - @backstage/plugin-events-node@0.2.21
-
-## 0.1.21
-
-### 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
 
 ## 0.1.20
 

package/README.md

@@ -1,8 +1,8 @@
 # events-backend-module-gerrit
 
-Welcome to the `events-backend-module-gerrit` backend plugin!
+Welcome to the `events-backend-module-gerrit` backend module!
 
-This plugin is a module for the `events-backend` backend plugin
+This package is a module for the `events-backend` backend plugin
 and extends it with an `GerritEventRouter`.
 
 The event router will subscribe to the topic `gerrit`
@@ -21,30 +21,20 @@ 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-gerrit
 ```
 
-### Add to backend
-
-```ts title="packages/backend/src/index.ts"
+```ts
+// packages/backend/src/index.ts
 backend.add(import('@backstage/plugin-events-backend-module-gerrit/alpha'));
 ```
 
-### Add to backend (old)
-
-Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`:
-
-```diff
-+const gerritEventRouter = new GerritEventRouter();
+### Legacy Backend System
 
-new EventsBackend(env.logger)
-+  .addPublishers(gerritEventRouter)
-+  .addSubscribers(gerritEventRouter);
-// [...]
+```ts
+// packages/backend/src/plugins/events.ts
+const eventRouter = new GerritEventRouter({ events: env.events });
+await eventRouter.subscribe();
 ```

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -3,9 +3,8 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
-var alpha = require('@backstage/plugin-events-node/alpha');
-var GerritEventRouter = require('./cjs/GerritEventRouter-21791cb7.cjs.js');
-require('@backstage/plugin-events-node');
+var pluginEventsNode = require('@backstage/plugin-events-node');
+var GerritEventRouter = require('./cjs/GerritEventRouter-076aa57d.cjs.js');
 
 const eventsModuleGerritEventRouter = backendPluginApi.createBackendModule({
   pluginId: "events",
@@ -13,12 +12,11 @@ const eventsModuleGerritEventRouter = backendPluginApi.createBackendModule({
   register(env) {
     env.registerInit({
       deps: {
-        events: alpha.eventsExtensionPoint
+        events: pluginEventsNode.eventsServiceRef
       },
       async init({ events }) {
-        const eventRouter = new GerritEventRouter.GerritEventRouter();
-        events.addPublishers(eventRouter);
-        events.addSubscribers(eventRouter);
+        const eventRouter = new GerritEventRouter.GerritEventRouter({ events });
+        await eventRouter.subscribe();
       }
     });
   }

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/service/eventsModuleGerritEventRouter.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 { GerritEventRouter } from '../router/GerritEventRouter';\n\n/**\n * Module for the events-backend plugin, adding an event router for Gerrit.\n *\n * Registers the `GerritEventRouter`.\n *\n * @alpha\n */\nexport const eventsModuleGerritEventRouter = createBackendModule({\n  pluginId: 'events',\n  moduleId: 'gerrit-event-router',\n  register(env) {\n    env.registerInit({\n      deps: {\n        events: eventsExtensionPoint,\n      },\n      async init({ events }) {\n        const eventRouter = new GerritEventRouter();\n\n        events.addPublishers(eventRouter);\n        events.addSubscribers(eventRouter);\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","eventsExtensionPoint","GerritEventRouter"],"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;;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/service/eventsModuleGerritEventRouter.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 { GerritEventRouter } from '../router/GerritEventRouter';\n\n/**\n * Module for the events-backend plugin, adding an event router for Gerrit.\n *\n * Registers the `GerritEventRouter`.\n *\n * @alpha\n */\nexport const eventsModuleGerritEventRouter = createBackendModule({\n  pluginId: 'events',\n  moduleId: 'gerrit-event-router',\n  register(env) {\n    env.registerInit({\n      deps: {\n        events: eventsServiceRef,\n      },\n      async init({ events }) {\n        const eventRouter = new GerritEventRouter({ events });\n        await eventRouter.subscribe();\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","eventsServiceRef","GerritEventRouter"],"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;;;;;"}

package/dist/cjs/{GerritEventRouter-21791cb7.cjs.js → GerritEventRouter-076aa57d.cjs.js}

@@ -3,8 +3,14 @@
 var pluginEventsNode = require('@backstage/plugin-events-node');
 
 class GerritEventRouter extends pluginEventsNode.SubTopicEventRouter {
-  constructor() {
-    super("gerrit");
+  constructor(options) {
+    super({
+      events: options.events,
+      topic: "gerrit"
+    });
+  }
+  getSubscriberId() {
+    return "GerritEventRouter";
   }
   determineSubTopic(params) {
     if ("type" in params.eventPayload) {
@@ -16,4 +22,4 @@ class GerritEventRouter extends pluginEventsNode.SubTopicEventRouter {
 }
 
 exports.GerritEventRouter = GerritEventRouter;
-//# sourceMappingURL=GerritEventRouter-21791cb7.cjs.js.map
+//# sourceMappingURL=GerritEventRouter-076aa57d.cjs.js.map

package/dist/cjs/GerritEventRouter-076aa57d.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GerritEventRouter-076aa57d.cjs.js","sources":["../../src/router/GerritEventRouter.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  EventParams,\n  EventsService,\n  SubTopicEventRouter,\n} from '@backstage/plugin-events-node';\n\n/**\n * Subscribes to the generic `gerrit` topic\n * and publishes the events under the more concrete sub-topic\n * depending on the `$.type` field provided.\n *\n * @public\n */\nexport class GerritEventRouter extends SubTopicEventRouter {\n  constructor(options: { events: EventsService }) {\n    super({\n      events: options.events,\n      topic: 'gerrit',\n    });\n  }\n\n  protected getSubscriberId(): string {\n    return 'GerritEventRouter';\n  }\n\n  protected determineSubTopic(params: EventParams): string | undefined {\n    if ('type' in (params.eventPayload as object)) {\n      const payload = params.eventPayload as { type: string };\n      return payload.type;\n    }\n\n    return undefined;\n  }\n}\n"],"names":["SubTopicEventRouter"],"mappings":";;;;AA6BO,MAAM,0BAA0BA,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;AACnE,IAAI,IAAA,MAAA,IAAW,OAAO,YAAyB,EAAA;AAC7C,MAAA,MAAM,UAAU,MAAO,CAAA,YAAA,CAAA;AACvB,MAAA,OAAO,OAAQ,CAAA,IAAA,CAAA;AAAA,KACjB;AAEA,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACT;AACF;;;;"}

package/dist/index.cjs.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var GerritEventRouter = require('./cjs/GerritEventRouter-21791cb7.cjs.js');
+var GerritEventRouter = require('./cjs/GerritEventRouter-076aa57d.cjs.js');
 require('@backstage/plugin-events-node');
 
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { SubTopicEventRouter, EventParams } from '@backstage/plugin-events-node';
+import { SubTopicEventRouter, EventsService, EventParams } from '@backstage/plugin-events-node';
 
 /**
  * Subscribes to the generic `gerrit` topic
@@ -8,7 +8,10 @@ import { SubTopicEventRouter, EventParams } from '@backstage/plugin-events-node'
  * @public
  */
 declare class GerritEventRouter 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-gerrit",
-  "version": "0.1.22",
+  "version": "0.2.0-next.0",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
@@ -39,14 +39,13 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^0.6.12",
-    "@backstage/plugin-events-node": "^0.2.21",
-    "winston": "^3.2.1"
+    "@backstage/backend-plugin-api": "^0.6.13-next.0",
+    "@backstage/plugin-events-node": "^0.3.0-next.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.3.2",
-    "@backstage/cli": "^0.25.2",
-    "@backstage/plugin-events-backend-test-utils": "^0.1.22"
+    "@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": [
     "dist",

package/dist/cjs/GerritEventRouter-21791cb7.cjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"GerritEventRouter-21791cb7.cjs.js","sources":["../../src/router/GerritEventRouter.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  EventParams,\n  SubTopicEventRouter,\n} from '@backstage/plugin-events-node';\n\n/**\n * Subscribes to the generic `gerrit` topic\n * and publishes the events under the more concrete sub-topic\n * depending on the `$.type` field provided.\n *\n * @public\n */\nexport class GerritEventRouter extends SubTopicEventRouter {\n  constructor() {\n    super('gerrit');\n  }\n\n  protected determineSubTopic(params: EventParams): string | undefined {\n    if ('type' in (params.eventPayload as object)) {\n      const payload = params.eventPayload as { type: string };\n      return payload.type;\n    }\n\n    return undefined;\n  }\n}\n"],"names":["SubTopicEventRouter"],"mappings":";;;;AA4BO,MAAM,0BAA0BA,oCAAoB,CAAA;AAAA,EACzD,WAAc,GAAA;AACZ,IAAA,KAAA,CAAM,QAAQ,CAAA,CAAA;AAAA,GAChB;AAAA,EAEU,kBAAkB,MAAyC,EAAA;AACnE,IAAI,IAAA,MAAA,IAAW,OAAO,YAAyB,EAAA;AAC7C,MAAA,MAAM,UAAU,MAAO,CAAA,YAAA,CAAA;AACvB,MAAA,OAAO,OAAQ,CAAA,IAAA,CAAA;AAAA,KACjB;AAEA,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACT;AACF;;;;"}