@backstage/plugin-events-backend-test-utils 0.0.0-nightly-20221115024001

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# @backstage/plugin-events-backend-test-utils
+
+## 0.0.0-nightly-20221115024001
+
+### Minor Changes
+
+- 7bbd2403a1: Adds a new backend plugin plugin-events-backend for managing events.
+
+  plugin-events-node exposes interfaces which can be used by modules.
+
+  plugin-events-backend-test-utils provides utilities which can be used while writing tests e.g. for modules.
+
+  Please find more information at
+  https://github.com/backstage/backstage/tree/master/plugins/events-backend/README.md.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-events-node@0.0.0-nightly-20221115024001

package/README.md

@@ -0,0 +1,4 @@
+# plugin-events-backend-test-utils
+
+Houses implementations of plugin-events-node interfaces
+which can be useful for test for events-backend and its modules.

package/dist/index.cjs.js

@@ -0,0 +1,69 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+class TestEventBroker {
+  constructor() {
+    this.published = [];
+    this.subscribed = [];
+  }
+  async publish(params) {
+    this.published.push(params);
+  }
+  subscribe(...subscribers) {
+    this.subscribed.push(...subscribers.flat());
+  }
+}
+
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateSet = (obj, member, value, setter) => {
+  __accessCheck(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+var _eventBroker;
+class TestEventPublisher {
+  constructor() {
+    __privateAdd(this, _eventBroker, void 0);
+  }
+  async setEventBroker(eventBroker) {
+    __privateSet(this, _eventBroker, eventBroker);
+  }
+  get eventBroker() {
+    return __privateGet(this, _eventBroker);
+  }
+}
+_eventBroker = new WeakMap();
+
+class TestEventSubscriber {
+  constructor(name, topics) {
+    this.receivedEvents = {};
+    this.name = name;
+    this.topics = topics;
+  }
+  supportsEventTopics() {
+    return this.topics;
+  }
+  async onEvent(params) {
+    var _a;
+    this.receivedEvents[params.topic] = (_a = this.receivedEvents[params.topic]) != null ? _a : [];
+    this.receivedEvents[params.topic].push(params);
+  }
+}
+
+exports.TestEventBroker = TestEventBroker;
+exports.TestEventPublisher = TestEventPublisher;
+exports.TestEventSubscriber = TestEventSubscriber;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/testUtils/TestEventBroker.ts","../src/testUtils/TestEventPublisher.ts","../src/testUtils/TestEventSubscriber.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  EventBroker,\n  EventParams,\n  EventSubscriber,\n} from '@backstage/plugin-events-node';\n\n/** @public */\nexport class TestEventBroker implements EventBroker {\n  readonly published: EventParams[] = [];\n  readonly subscribed: EventSubscriber[] = [];\n\n  async publish(params: EventParams): Promise<void> {\n    this.published.push(params);\n  }\n\n  subscribe(\n    ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n  ): void {\n    this.subscribed.push(...subscribers.flat());\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 { EventBroker, EventPublisher } from '@backstage/plugin-events-node';\n\n/** @public */\nexport class TestEventPublisher implements EventPublisher {\n  #eventBroker?: EventBroker;\n\n  async setEventBroker(eventBroker: EventBroker): Promise<void> {\n    this.#eventBroker = eventBroker;\n  }\n\n  get eventBroker() {\n    return this.#eventBroker;\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 { EventParams, EventSubscriber } from '@backstage/plugin-events-node';\n\n/** @public */\nexport class TestEventSubscriber implements EventSubscriber {\n  readonly name: string;\n  readonly topics: string[];\n\n  readonly receivedEvents: Record<string, EventParams[]> = {};\n\n  constructor(name: string, topics: string[]) {\n    this.name = name;\n    this.topics = topics;\n  }\n\n  supportsEventTopics(): string[] {\n    return this.topics;\n  }\n\n  async onEvent(params: EventParams): Promise<void> {\n    this.receivedEvents[params.topic] = this.receivedEvents[params.topic] ?? [];\n    this.receivedEvents[params.topic].push(params);\n  }\n}\n"],"names":[],"mappings":";;;;AAuBO,MAAM,eAAuC,CAAA;AAAA,EAA7C,WAAA,GAAA;AACL,IAAA,IAAA,CAAS,YAA2B,EAAC,CAAA;AACrC,IAAA,IAAA,CAAS,aAAgC,EAAC,CAAA;AAAA,GAAA;AAAA,EAE1C,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAK,IAAA,CAAA,SAAA,CAAU,KAAK,MAAM,CAAA,CAAA;AAAA,GAC5B;AAAA,EAEA,aACK,WACG,EAAA;AACN,IAAA,IAAA,CAAK,UAAW,CAAA,IAAA,CAAK,GAAG,WAAA,CAAY,MAAM,CAAA,CAAA;AAAA,GAC5C;AACF;;;;;;;;;;;;;;;;;;;;ACpCA,IAAA,YAAA,CAAA;AAmBO,MAAM,kBAA6C,CAAA;AAAA,EAAnD,WAAA,GAAA;AACL,IAAA,YAAA,CAAA,IAAA,EAAA,YAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAEA,MAAM,eAAe,WAAyC,EAAA;AAC5D,IAAA,YAAA,CAAA,IAAA,EAAK,YAAe,EAAA,WAAA,CAAA,CAAA;AAAA,GACtB;AAAA,EAEA,IAAI,WAAc,GAAA;AAChB,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AATE,YAAA,GAAA,IAAA,OAAA,EAAA;;ACDK,MAAM,mBAA+C,CAAA;AAAA,EAM1D,WAAA,CAAY,MAAc,MAAkB,EAAA;AAF5C,IAAA,IAAA,CAAS,iBAAgD,EAAC,CAAA;AAGxD,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AACZ,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AAAA,GAChB;AAAA,EAEA,mBAAgC,GAAA;AAC9B,IAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AAAA,GACd;AAAA,EAEA,MAAM,QAAQ,MAAoC,EAAA;AAlCpD,IAAA,IAAA,EAAA,CAAA;AAmCI,IAAK,IAAA,CAAA,cAAA,CAAe,OAAO,KAAS,CAAA,GAAA,CAAA,EAAA,GAAA,IAAA,CAAK,eAAe,MAAO,CAAA,KAAA,CAAA,KAA3B,YAAqC,EAAC,CAAA;AAC1E,IAAA,IAAA,CAAK,cAAe,CAAA,MAAA,CAAO,KAAO,CAAA,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAAA,GAC/C;AACF;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import { EventBroker, EventParams, EventSubscriber, EventPublisher } from '@backstage/plugin-events-node';
+
+/** @public */
+declare class TestEventBroker implements EventBroker {
+    readonly published: EventParams[];
+    readonly subscribed: EventSubscriber[];
+    publish(params: EventParams): Promise<void>;
+    subscribe(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): void;
+}
+
+/** @public */
+declare class TestEventPublisher implements EventPublisher {
+    #private;
+    setEventBroker(eventBroker: EventBroker): Promise<void>;
+    get eventBroker(): EventBroker | undefined;
+}
+
+/** @public */
+declare class TestEventSubscriber implements EventSubscriber {
+    readonly name: string;
+    readonly topics: string[];
+    readonly receivedEvents: Record<string, EventParams[]>;
+    constructor(name: string, topics: string[]);
+    supportsEventTopics(): string[];
+    onEvent(params: EventParams): Promise<void>;
+}
+
+export { TestEventBroker, TestEventPublisher, TestEventSubscriber };

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@backstage/plugin-events-backend-test-utils",
+  "description": "The plugin-events-backend-test-utils for @backstage/plugin-events-node",
+  "version": "0.0.0-nightly-20221115024001",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "node-library"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/plugin-events-node": "^0.0.0-nightly-20221115024001"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.0.0-nightly-20221115024001"
+  },
+  "files": [
+    "dist"
+  ]
+}