@backstage/plugin-signals-backend 0.2.4 → 0.3.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @backstage/plugin-signals-backend
 
+## 0.3.0-next.1
+
+### Minor Changes
+
+- f59ea1d: Removed support for the old backend system. If you were using the old `createRouter` export, please migrate to [the new backend system](https://backstage.io/docs/backend-system/).
+
+## 0.2.5-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-auth-node@0.5.6-next.0
+  - @backstage/backend-plugin-api@1.1.1-next.0
+  - @backstage/config@1.3.1
+  - @backstage/types@1.2.0
+  - @backstage/plugin-events-node@0.4.7-next.0
+  - @backstage/plugin-signals-node@0.1.16-next.0
+
 ## 0.2.4
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -2,11 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var deprecated = require('./deprecated.cjs.js');
 var plugin = require('./plugin.cjs.js');
 
 
 
-exports.createRouter = deprecated.createRouter;
 exports.default = plugin.signalsPlugin;
 //# 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,29 +1,4 @@
-import express from 'express';
-import { Config } from '@backstage/config';
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { LoggerService, DiscoveryService, LifecycleService, AuthService, UserInfoService } from '@backstage/backend-plugin-api';
-import { IdentityApi } from '@backstage/plugin-auth-node';
-import { EventsService } from '@backstage/plugin-events-node';
-
-/**
- * @public
- * @deprecated Please migrate to the new backend system as this will be removed in the future.
- */
-interface RouterOptions {
-    logger: LoggerService;
-    events: EventsService;
-    identity?: IdentityApi;
-    discovery: DiscoveryService;
-    config: Config;
-    lifecycle?: LifecycleService;
-    auth?: AuthService;
-    userInfo?: UserInfoService;
-}
-/**
- * @public
- * @deprecated Please migrate to the new backend system as this will be removed in the future.
- */
-declare function createRouter(options: RouterOptions): Promise<express.Router>;
 
 /**
  * Signals backend plugin
@@ -32,4 +7,4 @@ declare function createRouter(options: RouterOptions): Promise<express.Router>;
  */
 declare const signalsPlugin: _backstage_backend_plugin_api.BackendFeature;
 
-export { type RouterOptions, createRouter, signalsPlugin as default };
+export { signalsPlugin as default };

package/dist/plugin.cjs.js

@@ -1,8 +1,8 @@
 'use strict';
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
-var deprecated = require('./deprecated.cjs.js');
 var pluginEventsNode = require('@backstage/plugin-events-node');
+var router = require('./service/router.cjs.js');
 
 const signalsPlugin = backendPluginApi.createBackendPlugin({
   pluginId: "signals",
@@ -29,7 +29,7 @@ const signalsPlugin = backendPluginApi.createBackendPlugin({
         events
       }) {
         httpRouter.use(
-          await deprecated.createRouter({
+          await router.createRouter({
             logger,
             config,
             lifecycle,

package/dist/plugin.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2023 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 */\nimport {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './deprecated';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\n\n/**\n * Signals backend plugin\n *\n * @public\n */\nexport const signalsPlugin = createBackendPlugin({\n  pluginId: 'signals',\n  register(env) {\n    env.registerInit({\n      deps: {\n        httpRouter: coreServices.httpRouter,\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n        lifecycle: coreServices.rootLifecycle,\n        discovery: coreServices.discovery,\n        userInfo: coreServices.userInfo,\n        auth: coreServices.auth,\n        events: eventsServiceRef,\n      },\n      async init({\n        httpRouter,\n        logger,\n        config,\n        lifecycle,\n        discovery,\n        userInfo,\n        auth,\n        events,\n      }) {\n        httpRouter.use(\n          await createRouter({\n            logger,\n            config,\n            lifecycle,\n            discovery,\n            userInfo,\n            auth,\n            events,\n          }),\n        );\n        httpRouter.addAuthPolicy({\n          path: '/',\n          allow: 'unauthenticated',\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","eventsServiceRef","createRouter"],"mappings":";;;;;;AA2BO,MAAM,gBAAgBA,oCAAoB,CAAA;AAAA,EAC/C,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,YAAYC,6BAAa,CAAA,UAAA;AAAA,QACzB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,aAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,MAAQ,EAAAC;AAAA,OACV;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,UAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA;AAAA,QACA;AAAA,OACC,EAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,uBAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,YACA,SAAA;AAAA,YACA,SAAA;AAAA,YACA,QAAA;AAAA,YACA,IAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AACA,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,IAAM,EAAA,GAAA;AAAA,UACN,KAAO,EAAA;AAAA,SACR,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}
+{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2023 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  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\nimport { createRouter } from './service/router';\n\n/**\n * Signals backend plugin\n *\n * @public\n */\nexport const signalsPlugin = createBackendPlugin({\n  pluginId: 'signals',\n  register(env) {\n    env.registerInit({\n      deps: {\n        httpRouter: coreServices.httpRouter,\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n        lifecycle: coreServices.rootLifecycle,\n        discovery: coreServices.discovery,\n        userInfo: coreServices.userInfo,\n        auth: coreServices.auth,\n        events: eventsServiceRef,\n      },\n      async init({\n        httpRouter,\n        logger,\n        config,\n        lifecycle,\n        discovery,\n        userInfo,\n        auth,\n        events,\n      }) {\n        httpRouter.use(\n          await createRouter({\n            logger,\n            config,\n            lifecycle,\n            discovery,\n            userInfo,\n            auth,\n            events,\n          }),\n        );\n        httpRouter.addAuthPolicy({\n          path: '/',\n          allow: 'unauthenticated',\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","eventsServiceRef","createRouter"],"mappings":";;;;;;AA4BO,MAAM,gBAAgBA,oCAAoB,CAAA;AAAA,EAC/C,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,YAAYC,6BAAa,CAAA,UAAA;AAAA,QACzB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,aAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,MAAQ,EAAAC;AAAA,OACV;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,UAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA;AAAA,QACA;AAAA,OACC,EAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,YACA,SAAA;AAAA,YACA,SAAA;AAAA,YACA,QAAA;AAAA,YACA,IAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AACA,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,IAAM,EAAA,GAAA;AAAA,UACN,KAAO,EAAA;AAAA,SACR,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}

package/dist/service/SignalManager.cjs.js

@@ -26,7 +26,7 @@ class SignalManager {
       topics: ["signals"],
       onEvent: (params) => this.onEventBrokerEvent(params.eventPayload)
     });
-    options.lifecycle?.addShutdownHook(() => this.onShutdown());
+    options.lifecycle.addShutdownHook(() => this.onShutdown());
   }
   ping() {
     this.connections.forEach((conn) => {

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

@@ -1 +1 @@
-{"version":3,"file":"SignalManager.cjs.js","sources":["../../src/service/SignalManager.ts"],"sourcesContent":["/*\n * Copyright 2023 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 */\nimport { EventParams, EventsService } from '@backstage/plugin-events-node';\nimport { SignalPayload } from '@backstage/plugin-signals-node';\nimport crypto from 'crypto';\nimport { RawData, WebSocket } from 'ws';\nimport { v4 as uuid } from 'uuid';\nimport { JsonObject } from '@backstage/types';\nimport {\n  BackstageUserInfo,\n  LifecycleService,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\n\n/**\n * @internal\n */\nexport type SignalConnection = {\n  id: string;\n  user: string;\n  ws: WebSocket;\n  ownershipEntityRefs: string[];\n  subscriptions: Set<string>;\n  isAlive: boolean;\n};\n\n/**\n * @internal\n */\nexport type SignalManagerOptions = {\n  events: EventsService;\n  config: Config;\n  logger: LoggerService;\n  lifecycle?: LifecycleService;\n};\n\n/** @internal */\nexport class SignalManager {\n  private connections: Map<string, SignalConnection> = new Map<\n    string,\n    SignalConnection\n  >();\n  private events: EventsService;\n  private logger: LoggerService;\n  private pingInterval: ReturnType<typeof setInterval> | undefined;\n\n  static create(options: SignalManagerOptions) {\n    return new SignalManager(options);\n  }\n\n  private constructor(options: SignalManagerOptions) {\n    this.events = options.events;\n\n    // Use a unique subscriber ID for each signals instance, in order to fan-out\n    // all events to each signals instance. This ensures that events always\n    // reach users in a scaled deployment.\n    const id = `signals-${crypto.randomBytes(8).toString('hex')}`;\n    this.logger = options.logger.child({ subscriberId: id });\n    this.logger.info(`Signals manager is subscribing to signals events`);\n\n    this.events.subscribe({\n      id,\n      topics: ['signals'],\n      onEvent: (params: EventParams) =>\n        this.onEventBrokerEvent(params.eventPayload as SignalPayload),\n    });\n\n    options.lifecycle?.addShutdownHook(() => this.onShutdown());\n  }\n\n  private ping() {\n    this.connections.forEach(conn => {\n      if (!conn.isAlive) {\n        this.logger.debug(`Connection ${conn.id} is not alive, terminating`);\n        conn.ws.terminate();\n        return;\n      }\n\n      conn.isAlive = false;\n      conn.ws.ping();\n    });\n  }\n\n  private onShutdown() {\n    if (this.pingInterval) {\n      clearInterval(this.pingInterval);\n    }\n\n    // TODO: Unsubscribe from events?\n\n    this.connections.forEach(conn => {\n      conn.ws.terminate();\n    });\n    this.connections.clear();\n  }\n\n  addConnection(ws: WebSocket, identity?: BackstageUserInfo) {\n    // Start pinging on first connection\n    if (!this.pingInterval) {\n      this.pingInterval = setInterval(() => this.ping(), 30000);\n    }\n\n    const id = uuid();\n    const conn = {\n      id,\n      user: identity?.userEntityRef ?? 'user:default/guest',\n      ws,\n      ownershipEntityRefs: identity?.ownershipEntityRefs ?? [\n        'user:default/guest',\n      ],\n      subscriptions: new Set<string>(),\n      isAlive: true,\n    };\n\n    this.connections.set(id, conn);\n\n    this.logger.debug(`Connection ${id} connected`);\n    ws.on('error', (err: Error) => {\n      this.logger.error(\n        `Error occurred with connection ${id}: ${err}, closing connection`,\n      );\n      ws.terminate();\n      this.connections.delete(id);\n    });\n\n    ws.on('close', (code: number, reason: Buffer) => {\n      this.logger.debug(\n        `Connection ${id} closed with code ${code}, reason: ${reason}`,\n      );\n      ws.terminate();\n      this.connections.delete(id);\n    });\n\n    ws.on('ping', () => {\n      conn.isAlive = true;\n      ws.pong();\n    });\n\n    ws.on('pong', () => {\n      conn.isAlive = true;\n    });\n\n    ws.on('message', (data: RawData, isBinary: boolean) => {\n      this.logger.debug(`Received message from connection ${id}: ${data}`);\n      if (isBinary) {\n        return;\n      }\n      try {\n        const json = JSON.parse(data.toString()) as JsonObject;\n        this.handleMessage(conn, json);\n      } catch (err: any) {\n        this.logger.error(\n          `Invalid message received from connection ${id}: ${err}`,\n        );\n      }\n    });\n  }\n\n  private handleMessage(connection: SignalConnection, message: JsonObject) {\n    if (message.action === 'subscribe' && message.channel) {\n      this.logger.debug(\n        `Connection ${connection.id} subscribed to ${message.channel}`,\n      );\n      connection.subscriptions.add(message.channel as string);\n    } else if (message.action === 'unsubscribe' && message.channel) {\n      this.logger.debug(\n        `Connection ${connection.id} unsubscribed from ${message.channel}`,\n      );\n      connection.subscriptions.delete(message.channel as string);\n    }\n  }\n\n  private async onEventBrokerEvent(eventPayload: SignalPayload): Promise<void> {\n    if (!eventPayload.channel || !eventPayload.message) {\n      return;\n    }\n\n    const { channel, recipients, message } = eventPayload;\n    const jsonMessage = JSON.stringify({ channel, message });\n    let users: string[] = [];\n    if (recipients.type === 'user') {\n      users = Array.isArray(recipients.entityRef)\n        ? recipients.entityRef\n        : [recipients.entityRef];\n    }\n\n    // Actual websocket message sending\n    this.connections.forEach(conn => {\n      if (!conn.subscriptions.has(channel)) {\n        return;\n      }\n\n      // Sending to all users can be done with broadcast\n      if (\n        recipients.type !== 'broadcast' &&\n        !conn.ownershipEntityRefs.some((ref: string) => users.includes(ref))\n      ) {\n        return;\n      }\n\n      if (conn.ws.readyState !== WebSocket.OPEN) {\n        return;\n      }\n\n      conn.ws.send(jsonMessage, err => {\n        if (err) {\n          this.logger.error(`Failed to send message to ${conn.id}: ${err}`);\n        }\n      });\n    });\n  }\n}\n"],"names":["crypto","uuid","WebSocket"],"mappings":";;;;;;;;;;AAmDO,MAAM,aAAc,CAAA;AAAA,EACjB,WAAA,uBAAiD,GAGvD,EAAA;AAAA,EACM,MAAA;AAAA,EACA,MAAA;AAAA,EACA,YAAA;AAAA,EAER,OAAO,OAAO,OAA+B,EAAA;AAC3C,IAAO,OAAA,IAAI,cAAc,OAAO,CAAA;AAAA;AAClC,EAEQ,YAAY,OAA+B,EAAA;AACjD,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AAKtB,IAAM,MAAA,EAAA,GAAK,WAAWA,uBAAO,CAAA,WAAA,CAAY,CAAC,CAAE,CAAA,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA;AAC3D,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAO,MAAM,EAAE,YAAA,EAAc,IAAI,CAAA;AACvD,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,CAAkD,gDAAA,CAAA,CAAA;AAEnE,IAAA,IAAA,CAAK,OAAO,SAAU,CAAA;AAAA,MACpB,EAAA;AAAA,MACA,MAAA,EAAQ,CAAC,SAAS,CAAA;AAAA,MAClB,SAAS,CAAC,MAAA,KACR,IAAK,CAAA,kBAAA,CAAmB,OAAO,YAA6B;AAAA,KAC/D,CAAA;AAED,IAAA,OAAA,CAAQ,SAAW,EAAA,eAAA,CAAgB,MAAM,IAAA,CAAK,YAAY,CAAA;AAAA;AAC5D,EAEQ,IAAO,GAAA;AACb,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAI,IAAA,CAAC,KAAK,OAAS,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAc,WAAA,EAAA,IAAA,CAAK,EAAE,CAA4B,0BAAA,CAAA,CAAA;AACnE,QAAA,IAAA,CAAK,GAAG,SAAU,EAAA;AAClB,QAAA;AAAA;AAGF,MAAA,IAAA,CAAK,OAAU,GAAA,KAAA;AACf,MAAA,IAAA,CAAK,GAAG,IAAK,EAAA;AAAA,KACd,CAAA;AAAA;AACH,EAEQ,UAAa,GAAA;AACnB,IAAA,IAAI,KAAK,YAAc,EAAA;AACrB,MAAA,aAAA,CAAc,KAAK,YAAY,CAAA;AAAA;AAKjC,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAA,IAAA,CAAK,GAAG,SAAU,EAAA;AAAA,KACnB,CAAA;AACD,IAAA,IAAA,CAAK,YAAY,KAAM,EAAA;AAAA;AACzB,EAEA,aAAA,CAAc,IAAe,QAA8B,EAAA;AAEzD,IAAI,IAAA,CAAC,KAAK,YAAc,EAAA;AACtB,MAAA,IAAA,CAAK,eAAe,WAAY,CAAA,MAAM,IAAK,CAAA,IAAA,IAAQ,GAAK,CAAA;AAAA;AAG1D,IAAA,MAAM,KAAKC,OAAK,EAAA;AAChB,IAAA,MAAM,IAAO,GAAA;AAAA,MACX,EAAA;AAAA,MACA,IAAA,EAAM,UAAU,aAAiB,IAAA,oBAAA;AAAA,MACjC,EAAA;AAAA,MACA,mBAAA,EAAqB,UAAU,mBAAuB,IAAA;AAAA,QACpD;AAAA,OACF;AAAA,MACA,aAAA,sBAAmB,GAAY,EAAA;AAAA,MAC/B,OAAS,EAAA;AAAA,KACX;AAEA,IAAK,IAAA,CAAA,WAAA,CAAY,GAAI,CAAA,EAAA,EAAI,IAAI,CAAA;AAE7B,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAc,WAAA,EAAA,EAAE,CAAY,UAAA,CAAA,CAAA;AAC9C,IAAG,EAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,GAAe,KAAA;AAC7B,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,+BAAA,EAAkC,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA,oBAAA;AAAA,OAC9C;AACA,MAAA,EAAA,CAAG,SAAU,EAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA;AAAA,KAC3B,CAAA;AAED,IAAA,EAAA,CAAG,EAAG,CAAA,OAAA,EAAS,CAAC,IAAA,EAAc,MAAmB,KAAA;AAC/C,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,EAAE,CAAqB,kBAAA,EAAA,IAAI,aAAa,MAAM,CAAA;AAAA,OAC9D;AACA,MAAA,EAAA,CAAG,SAAU,EAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA;AAAA,KAC3B,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA;AACf,MAAA,EAAA,CAAG,IAAK,EAAA;AAAA,KACT,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA;AAAA,KAChB,CAAA;AAED,IAAA,EAAA,CAAG,EAAG,CAAA,SAAA,EAAW,CAAC,IAAA,EAAe,QAAsB,KAAA;AACrD,MAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,iCAAA,EAAoC,EAAE,CAAA,EAAA,EAAK,IAAI,CAAE,CAAA,CAAA;AACnE,MAAA,IAAI,QAAU,EAAA;AACZ,QAAA;AAAA;AAEF,MAAI,IAAA;AACF,QAAA,MAAM,IAAO,GAAA,IAAA,CAAK,KAAM,CAAA,IAAA,CAAK,UAAU,CAAA;AACvC,QAAK,IAAA,CAAA,aAAA,CAAc,MAAM,IAAI,CAAA;AAAA,eACtB,GAAU,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,yCAAA,EAA4C,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA;AAAA,SACxD;AAAA;AACF,KACD,CAAA;AAAA;AACH,EAEQ,aAAA,CAAc,YAA8B,OAAqB,EAAA;AACvE,IAAA,IAAI,OAAQ,CAAA,MAAA,KAAW,WAAe,IAAA,OAAA,CAAQ,OAAS,EAAA;AACrD,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,UAAA,CAAW,EAAE,CAAA,eAAA,EAAkB,QAAQ,OAAO,CAAA;AAAA,OAC9D;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,GAAI,CAAA,OAAA,CAAQ,OAAiB,CAAA;AAAA,KAC7C,MAAA,IAAA,OAAA,CAAQ,MAAW,KAAA,aAAA,IAAiB,QAAQ,OAAS,EAAA;AAC9D,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,UAAA,CAAW,EAAE,CAAA,mBAAA,EAAsB,QAAQ,OAAO,CAAA;AAAA,OAClE;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,MAAO,CAAA,OAAA,CAAQ,OAAiB,CAAA;AAAA;AAC3D;AACF,EAEA,MAAc,mBAAmB,YAA4C,EAAA;AAC3E,IAAA,IAAI,CAAC,YAAA,CAAa,OAAW,IAAA,CAAC,aAAa,OAAS,EAAA;AAClD,MAAA;AAAA;AAGF,IAAA,MAAM,EAAE,OAAA,EAAS,UAAY,EAAA,OAAA,EAAY,GAAA,YAAA;AACzC,IAAA,MAAM,cAAc,IAAK,CAAA,SAAA,CAAU,EAAE,OAAA,EAAS,SAAS,CAAA;AACvD,IAAA,IAAI,QAAkB,EAAC;AACvB,IAAI,IAAA,UAAA,CAAW,SAAS,MAAQ,EAAA;AAC9B,MAAQ,KAAA,GAAA,KAAA,CAAM,QAAQ,UAAW,CAAA,SAAS,IACtC,UAAW,CAAA,SAAA,GACX,CAAC,UAAA,CAAW,SAAS,CAAA;AAAA;AAI3B,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAA,IAAI,CAAC,IAAA,CAAK,aAAc,CAAA,GAAA,CAAI,OAAO,CAAG,EAAA;AACpC,QAAA;AAAA;AAIF,MAAA,IACE,UAAW,CAAA,IAAA,KAAS,WACpB,IAAA,CAAC,IAAK,CAAA,mBAAA,CAAoB,IAAK,CAAA,CAAC,GAAgB,KAAA,KAAA,CAAM,QAAS,CAAA,GAAG,CAAC,CACnE,EAAA;AACA,QAAA;AAAA;AAGF,MAAA,IAAI,IAAK,CAAA,EAAA,CAAG,UAAe,KAAAC,YAAA,CAAU,IAAM,EAAA;AACzC,QAAA;AAAA;AAGF,MAAK,IAAA,CAAA,EAAA,CAAG,IAAK,CAAA,WAAA,EAAa,CAAO,GAAA,KAAA;AAC/B,QAAA,IAAI,GAAK,EAAA;AACP,UAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,0BAAA,EAA6B,KAAK,EAAE,CAAA,EAAA,EAAK,GAAG,CAAE,CAAA,CAAA;AAAA;AAClE,OACD,CAAA;AAAA,KACF,CAAA;AAAA;AAEL;;;;"}
+{"version":3,"file":"SignalManager.cjs.js","sources":["../../src/service/SignalManager.ts"],"sourcesContent":["/*\n * Copyright 2023 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, EventsService } from '@backstage/plugin-events-node';\nimport { SignalPayload } from '@backstage/plugin-signals-node';\nimport crypto from 'crypto';\nimport { RawData, WebSocket } from 'ws';\nimport { v4 as uuid } from 'uuid';\nimport { JsonObject } from '@backstage/types';\nimport {\n  BackstageUserInfo,\n  LifecycleService,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\n\n/**\n * @internal\n */\nexport type SignalConnection = {\n  id: string;\n  user: string;\n  ws: WebSocket;\n  ownershipEntityRefs: string[];\n  subscriptions: Set<string>;\n  isAlive: boolean;\n};\n\n/**\n * @internal\n */\nexport type SignalManagerOptions = {\n  events: EventsService;\n  config: Config;\n  logger: LoggerService;\n  lifecycle: LifecycleService;\n};\n\n/** @internal */\nexport class SignalManager {\n  private connections: Map<string, SignalConnection> = new Map<\n    string,\n    SignalConnection\n  >();\n  private events: EventsService;\n  private logger: LoggerService;\n  private pingInterval: ReturnType<typeof setInterval> | undefined;\n\n  static create(options: SignalManagerOptions) {\n    return new SignalManager(options);\n  }\n\n  private constructor(options: SignalManagerOptions) {\n    this.events = options.events;\n\n    // Use a unique subscriber ID for each signals instance, in order to fan-out\n    // all events to each signals instance. This ensures that events always\n    // reach users in a scaled deployment.\n    const id = `signals-${crypto.randomBytes(8).toString('hex')}`;\n    this.logger = options.logger.child({ subscriberId: id });\n    this.logger.info(`Signals manager is subscribing to signals events`);\n\n    this.events.subscribe({\n      id,\n      topics: ['signals'],\n      onEvent: (params: EventParams) =>\n        this.onEventBrokerEvent(params.eventPayload as SignalPayload),\n    });\n\n    options.lifecycle.addShutdownHook(() => this.onShutdown());\n  }\n\n  private ping() {\n    this.connections.forEach(conn => {\n      if (!conn.isAlive) {\n        this.logger.debug(`Connection ${conn.id} is not alive, terminating`);\n        conn.ws.terminate();\n        return;\n      }\n\n      conn.isAlive = false;\n      conn.ws.ping();\n    });\n  }\n\n  private onShutdown() {\n    if (this.pingInterval) {\n      clearInterval(this.pingInterval);\n    }\n\n    // TODO: Unsubscribe from events?\n\n    this.connections.forEach(conn => {\n      conn.ws.terminate();\n    });\n    this.connections.clear();\n  }\n\n  addConnection(ws: WebSocket, identity?: BackstageUserInfo) {\n    // Start pinging on first connection\n    if (!this.pingInterval) {\n      this.pingInterval = setInterval(() => this.ping(), 30000);\n    }\n\n    const id = uuid();\n    const conn = {\n      id,\n      user: identity?.userEntityRef ?? 'user:default/guest',\n      ws,\n      ownershipEntityRefs: identity?.ownershipEntityRefs ?? [\n        'user:default/guest',\n      ],\n      subscriptions: new Set<string>(),\n      isAlive: true,\n    };\n\n    this.connections.set(id, conn);\n\n    this.logger.debug(`Connection ${id} connected`);\n    ws.on('error', (err: Error) => {\n      this.logger.error(\n        `Error occurred with connection ${id}: ${err}, closing connection`,\n      );\n      ws.terminate();\n      this.connections.delete(id);\n    });\n\n    ws.on('close', (code: number, reason: Buffer) => {\n      this.logger.debug(\n        `Connection ${id} closed with code ${code}, reason: ${reason}`,\n      );\n      ws.terminate();\n      this.connections.delete(id);\n    });\n\n    ws.on('ping', () => {\n      conn.isAlive = true;\n      ws.pong();\n    });\n\n    ws.on('pong', () => {\n      conn.isAlive = true;\n    });\n\n    ws.on('message', (data: RawData, isBinary: boolean) => {\n      this.logger.debug(`Received message from connection ${id}: ${data}`);\n      if (isBinary) {\n        return;\n      }\n      try {\n        const json = JSON.parse(data.toString()) as JsonObject;\n        this.handleMessage(conn, json);\n      } catch (err: any) {\n        this.logger.error(\n          `Invalid message received from connection ${id}: ${err}`,\n        );\n      }\n    });\n  }\n\n  private handleMessage(connection: SignalConnection, message: JsonObject) {\n    if (message.action === 'subscribe' && message.channel) {\n      this.logger.debug(\n        `Connection ${connection.id} subscribed to ${message.channel}`,\n      );\n      connection.subscriptions.add(message.channel as string);\n    } else if (message.action === 'unsubscribe' && message.channel) {\n      this.logger.debug(\n        `Connection ${connection.id} unsubscribed from ${message.channel}`,\n      );\n      connection.subscriptions.delete(message.channel as string);\n    }\n  }\n\n  private async onEventBrokerEvent(eventPayload: SignalPayload): Promise<void> {\n    if (!eventPayload.channel || !eventPayload.message) {\n      return;\n    }\n\n    const { channel, recipients, message } = eventPayload;\n    const jsonMessage = JSON.stringify({ channel, message });\n    let users: string[] = [];\n    if (recipients.type === 'user') {\n      users = Array.isArray(recipients.entityRef)\n        ? recipients.entityRef\n        : [recipients.entityRef];\n    }\n\n    // Actual websocket message sending\n    this.connections.forEach(conn => {\n      if (!conn.subscriptions.has(channel)) {\n        return;\n      }\n\n      // Sending to all users can be done with broadcast\n      if (\n        recipients.type !== 'broadcast' &&\n        !conn.ownershipEntityRefs.some((ref: string) => users.includes(ref))\n      ) {\n        return;\n      }\n\n      if (conn.ws.readyState !== WebSocket.OPEN) {\n        return;\n      }\n\n      conn.ws.send(jsonMessage, err => {\n        if (err) {\n          this.logger.error(`Failed to send message to ${conn.id}: ${err}`);\n        }\n      });\n    });\n  }\n}\n"],"names":["crypto","uuid","WebSocket"],"mappings":";;;;;;;;;;AAoDO,MAAM,aAAc,CAAA;AAAA,EACjB,WAAA,uBAAiD,GAGvD,EAAA;AAAA,EACM,MAAA;AAAA,EACA,MAAA;AAAA,EACA,YAAA;AAAA,EAER,OAAO,OAAO,OAA+B,EAAA;AAC3C,IAAO,OAAA,IAAI,cAAc,OAAO,CAAA;AAAA;AAClC,EAEQ,YAAY,OAA+B,EAAA;AACjD,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AAKtB,IAAM,MAAA,EAAA,GAAK,WAAWA,uBAAO,CAAA,WAAA,CAAY,CAAC,CAAE,CAAA,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA;AAC3D,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAO,MAAM,EAAE,YAAA,EAAc,IAAI,CAAA;AACvD,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,CAAkD,gDAAA,CAAA,CAAA;AAEnE,IAAA,IAAA,CAAK,OAAO,SAAU,CAAA;AAAA,MACpB,EAAA;AAAA,MACA,MAAA,EAAQ,CAAC,SAAS,CAAA;AAAA,MAClB,SAAS,CAAC,MAAA,KACR,IAAK,CAAA,kBAAA,CAAmB,OAAO,YAA6B;AAAA,KAC/D,CAAA;AAED,IAAA,OAAA,CAAQ,SAAU,CAAA,eAAA,CAAgB,MAAM,IAAA,CAAK,YAAY,CAAA;AAAA;AAC3D,EAEQ,IAAO,GAAA;AACb,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAI,IAAA,CAAC,KAAK,OAAS,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAc,WAAA,EAAA,IAAA,CAAK,EAAE,CAA4B,0BAAA,CAAA,CAAA;AACnE,QAAA,IAAA,CAAK,GAAG,SAAU,EAAA;AAClB,QAAA;AAAA;AAGF,MAAA,IAAA,CAAK,OAAU,GAAA,KAAA;AACf,MAAA,IAAA,CAAK,GAAG,IAAK,EAAA;AAAA,KACd,CAAA;AAAA;AACH,EAEQ,UAAa,GAAA;AACnB,IAAA,IAAI,KAAK,YAAc,EAAA;AACrB,MAAA,aAAA,CAAc,KAAK,YAAY,CAAA;AAAA;AAKjC,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAA,IAAA,CAAK,GAAG,SAAU,EAAA;AAAA,KACnB,CAAA;AACD,IAAA,IAAA,CAAK,YAAY,KAAM,EAAA;AAAA;AACzB,EAEA,aAAA,CAAc,IAAe,QAA8B,EAAA;AAEzD,IAAI,IAAA,CAAC,KAAK,YAAc,EAAA;AACtB,MAAA,IAAA,CAAK,eAAe,WAAY,CAAA,MAAM,IAAK,CAAA,IAAA,IAAQ,GAAK,CAAA;AAAA;AAG1D,IAAA,MAAM,KAAKC,OAAK,EAAA;AAChB,IAAA,MAAM,IAAO,GAAA;AAAA,MACX,EAAA;AAAA,MACA,IAAA,EAAM,UAAU,aAAiB,IAAA,oBAAA;AAAA,MACjC,EAAA;AAAA,MACA,mBAAA,EAAqB,UAAU,mBAAuB,IAAA;AAAA,QACpD;AAAA,OACF;AAAA,MACA,aAAA,sBAAmB,GAAY,EAAA;AAAA,MAC/B,OAAS,EAAA;AAAA,KACX;AAEA,IAAK,IAAA,CAAA,WAAA,CAAY,GAAI,CAAA,EAAA,EAAI,IAAI,CAAA;AAE7B,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAc,WAAA,EAAA,EAAE,CAAY,UAAA,CAAA,CAAA;AAC9C,IAAG,EAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,GAAe,KAAA;AAC7B,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,+BAAA,EAAkC,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA,oBAAA;AAAA,OAC9C;AACA,MAAA,EAAA,CAAG,SAAU,EAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA;AAAA,KAC3B,CAAA;AAED,IAAA,EAAA,CAAG,EAAG,CAAA,OAAA,EAAS,CAAC,IAAA,EAAc,MAAmB,KAAA;AAC/C,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,EAAE,CAAqB,kBAAA,EAAA,IAAI,aAAa,MAAM,CAAA;AAAA,OAC9D;AACA,MAAA,EAAA,CAAG,SAAU,EAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA;AAAA,KAC3B,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA;AACf,MAAA,EAAA,CAAG,IAAK,EAAA;AAAA,KACT,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA;AAAA,KAChB,CAAA;AAED,IAAA,EAAA,CAAG,EAAG,CAAA,SAAA,EAAW,CAAC,IAAA,EAAe,QAAsB,KAAA;AACrD,MAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,iCAAA,EAAoC,EAAE,CAAA,EAAA,EAAK,IAAI,CAAE,CAAA,CAAA;AACnE,MAAA,IAAI,QAAU,EAAA;AACZ,QAAA;AAAA;AAEF,MAAI,IAAA;AACF,QAAA,MAAM,IAAO,GAAA,IAAA,CAAK,KAAM,CAAA,IAAA,CAAK,UAAU,CAAA;AACvC,QAAK,IAAA,CAAA,aAAA,CAAc,MAAM,IAAI,CAAA;AAAA,eACtB,GAAU,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,yCAAA,EAA4C,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA;AAAA,SACxD;AAAA;AACF,KACD,CAAA;AAAA;AACH,EAEQ,aAAA,CAAc,YAA8B,OAAqB,EAAA;AACvE,IAAA,IAAI,OAAQ,CAAA,MAAA,KAAW,WAAe,IAAA,OAAA,CAAQ,OAAS,EAAA;AACrD,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,UAAA,CAAW,EAAE,CAAA,eAAA,EAAkB,QAAQ,OAAO,CAAA;AAAA,OAC9D;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,GAAI,CAAA,OAAA,CAAQ,OAAiB,CAAA;AAAA,KAC7C,MAAA,IAAA,OAAA,CAAQ,MAAW,KAAA,aAAA,IAAiB,QAAQ,OAAS,EAAA;AAC9D,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,UAAA,CAAW,EAAE,CAAA,mBAAA,EAAsB,QAAQ,OAAO,CAAA;AAAA,OAClE;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,MAAO,CAAA,OAAA,CAAQ,OAAiB,CAAA;AAAA;AAC3D;AACF,EAEA,MAAc,mBAAmB,YAA4C,EAAA;AAC3E,IAAA,IAAI,CAAC,YAAA,CAAa,OAAW,IAAA,CAAC,aAAa,OAAS,EAAA;AAClD,MAAA;AAAA;AAGF,IAAA,MAAM,EAAE,OAAA,EAAS,UAAY,EAAA,OAAA,EAAY,GAAA,YAAA;AACzC,IAAA,MAAM,cAAc,IAAK,CAAA,SAAA,CAAU,EAAE,OAAA,EAAS,SAAS,CAAA;AACvD,IAAA,IAAI,QAAkB,EAAC;AACvB,IAAI,IAAA,UAAA,CAAW,SAAS,MAAQ,EAAA;AAC9B,MAAQ,KAAA,GAAA,KAAA,CAAM,QAAQ,UAAW,CAAA,SAAS,IACtC,UAAW,CAAA,SAAA,GACX,CAAC,UAAA,CAAW,SAAS,CAAA;AAAA;AAI3B,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAA,IAAI,CAAC,IAAA,CAAK,aAAc,CAAA,GAAA,CAAI,OAAO,CAAG,EAAA;AACpC,QAAA;AAAA;AAIF,MAAA,IACE,UAAW,CAAA,IAAA,KAAS,WACpB,IAAA,CAAC,IAAK,CAAA,mBAAA,CAAoB,IAAK,CAAA,CAAC,GAAgB,KAAA,KAAA,CAAM,QAAS,CAAA,GAAG,CAAC,CACnE,EAAA;AACA,QAAA;AAAA;AAGF,MAAA,IAAI,IAAK,CAAA,EAAA,CAAG,UAAe,KAAAC,YAAA,CAAU,IAAM,EAAA;AACzC,QAAA;AAAA;AAGF,MAAK,IAAA,CAAA,EAAA,CAAG,IAAK,CAAA,WAAA,EAAa,CAAO,GAAA,KAAA;AAC/B,QAAA,IAAI,GAAK,EAAA;AACP,UAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,0BAAA,EAA6B,KAAK,EAAE,CAAA,EAAA,EAAK,GAAG,CAAE,CAAA,CAAA;AAAA;AAClE,OACD,CAAA;AAAA,KACF,CAAA;AAAA;AAEL;;;;"}

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

@@ -1 +1 @@
-{"version":3,"file":"router.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["/*\n * Copyright 2023 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 */\nimport express, { NextFunction, Request, Response } from 'express';\nimport Router from 'express-promise-router';\nimport {\n  AuthService,\n  BackstageUserInfo,\n  DiscoveryService,\n  LifecycleService,\n  LoggerService,\n  UserInfoService,\n} from '@backstage/backend-plugin-api';\nimport * as https from 'https';\nimport http, { IncomingMessage } from 'http';\nimport { SignalManager } from './SignalManager';\nimport { EventsService } from '@backstage/plugin-events-node';\nimport { WebSocket, WebSocketServer } from 'ws';\nimport { Duplex } from 'stream';\nimport { Config } from '@backstage/config';\n\nexport interface RouterOptions {\n  logger: LoggerService;\n  events: EventsService;\n  discovery: DiscoveryService;\n  config: Config;\n  lifecycle?: LifecycleService;\n  userInfo: UserInfoService;\n  auth: AuthService;\n}\n\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const { logger, discovery, auth, userInfo } = options;\n\n  const manager = SignalManager.create(options);\n  let subscribedToUpgradeRequests = false;\n  let apiUrl: string | undefined = undefined;\n\n  const webSocketServer = new WebSocketServer({\n    noServer: true, // handle upgrade manually\n    clientTracking: false, // handle connections in SignalManager\n  });\n\n  webSocketServer.on('error', (error: Error) => {\n    logger.error(`WebSocket server error: ${error}`);\n  });\n\n  const handleUpgrade = async (\n    request: Request<any, any, any, any, any>,\n    socket: Duplex,\n    head: Buffer,\n  ) => {\n    if (!apiUrl) {\n      apiUrl = await discovery.getBaseUrl('signals');\n    }\n\n    if (!request.url || !apiUrl || !apiUrl.endsWith(request.url)) {\n      return;\n    }\n\n    let userIdentity: BackstageUserInfo | undefined = undefined;\n\n    // Authentication token is passed in Sec-WebSocket-Protocol header as there\n    // is no other way to pass the token with plain websockets\n    try {\n      const token = request.headers['sec-websocket-protocol'];\n      if (token) {\n        const credentials = await auth.authenticate(token);\n        if (auth.isPrincipal(credentials, 'user')) {\n          userIdentity = await userInfo.getUserInfo(credentials);\n        }\n      }\n    } catch (e) {\n      logger.error(`Failed to authenticate WebSocket connection: ${e}`);\n      socket.write(\n        'HTTP/1.1 401 Web Socket Protocol Handshake\\r\\n' +\n          'Upgrade: WebSocket\\r\\n' +\n          'Connection: Upgrade\\r\\n' +\n          '\\r\\n',\n      );\n      socket.destroy();\n      return;\n    }\n\n    try {\n      webSocketServer.handleUpgrade(\n        request,\n        socket,\n        head,\n        (ws: WebSocket, __: IncomingMessage) => {\n          manager.addConnection(ws, userIdentity);\n        },\n      );\n    } catch (e) {\n      logger.error(`Failed to handle WebSocket upgrade: ${e}`);\n      socket.write(\n        'HTTP/1.1 500 Web Socket Protocol Handshake\\r\\n' +\n          'Upgrade: WebSocket\\r\\n' +\n          'Connection: Upgrade\\r\\n' +\n          '\\r\\n',\n      );\n      socket.destroy();\n    }\n  };\n\n  const upgradeMiddleware = async (\n    req: Request,\n    _: Response,\n    next: NextFunction,\n  ) => {\n    const server: https.Server | http.Server = (req.socket as any)?.server;\n    if (\n      subscribedToUpgradeRequests ||\n      !server ||\n      !req.headers ||\n      req.headers.upgrade === undefined ||\n      req.headers.upgrade.toLowerCase() !== 'websocket'\n    ) {\n      next();\n      return;\n    }\n\n    subscribedToUpgradeRequests = true;\n    server.on('upgrade', handleUpgrade);\n  };\n\n  const router = Router();\n  router.use(express.json());\n  router.use(upgradeMiddleware);\n\n  router.get('/health', (_, response) => {\n    response.json({ status: 'ok' });\n  });\n\n  return router;\n}\n"],"names":["SignalManager","WebSocketServer","Router","express"],"mappings":";;;;;;;;;;;;AA2CA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,SAAW,EAAA,IAAA,EAAM,UAAa,GAAA,OAAA;AAE9C,EAAM,MAAA,OAAA,GAAUA,2BAAc,CAAA,MAAA,CAAO,OAAO,CAAA;AAC5C,EAAA,IAAI,2BAA8B,GAAA,KAAA;AAClC,EAAA,IAAI,MAA6B,GAAA,KAAA,CAAA;AAEjC,EAAM,MAAA,eAAA,GAAkB,IAAIC,kBAAgB,CAAA;AAAA,IAC1C,QAAU,EAAA,IAAA;AAAA;AAAA,IACV,cAAgB,EAAA;AAAA;AAAA,GACjB,CAAA;AAED,EAAgB,eAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,KAAiB,KAAA;AAC5C,IAAO,MAAA,CAAA,KAAA,CAAM,CAA2B,wBAAA,EAAA,KAAK,CAAE,CAAA,CAAA;AAAA,GAChD,CAAA;AAED,EAAA,MAAM,aAAgB,GAAA,OACpB,OACA,EAAA,MAAA,EACA,IACG,KAAA;AACH,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAS,MAAA,GAAA,MAAM,SAAU,CAAA,UAAA,CAAW,SAAS,CAAA;AAAA;AAG/C,IAAI,IAAA,CAAC,OAAQ,CAAA,GAAA,IAAO,CAAC,MAAA,IAAU,CAAC,MAAO,CAAA,QAAA,CAAS,OAAQ,CAAA,GAAG,CAAG,EAAA;AAC5D,MAAA;AAAA;AAGF,IAAA,IAAI,YAA8C,GAAA,KAAA,CAAA;AAIlD,IAAI,IAAA;AACF,MAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,OAAA,CAAQ,wBAAwB,CAAA;AACtD,MAAA,IAAI,KAAO,EAAA;AACT,QAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,KAAK,CAAA;AACjD,QAAA,IAAI,IAAK,CAAA,WAAA,CAAY,WAAa,EAAA,MAAM,CAAG,EAAA;AACzC,UAAe,YAAA,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,WAAW,CAAA;AAAA;AACvD;AACF,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAgD,6CAAA,EAAA,CAAC,CAAE,CAAA,CAAA;AAChE,MAAO,MAAA,CAAA,KAAA;AAAA,QACL;AAAA,OAIF;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA;AACf,MAAA;AAAA;AAGF,IAAI,IAAA;AACF,MAAgB,eAAA,CAAA,aAAA;AAAA,QACd,OAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,CAAC,IAAe,EAAwB,KAAA;AACtC,UAAQ,OAAA,CAAA,aAAA,CAAc,IAAI,YAAY,CAAA;AAAA;AACxC,OACF;AAAA,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAuC,oCAAA,EAAA,CAAC,CAAE,CAAA,CAAA;AACvD,MAAO,MAAA,CAAA,KAAA;AAAA,QACL;AAAA,OAIF;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA;AAAA;AACjB,GACF;AAEA,EAAA,MAAM,iBAAoB,GAAA,OACxB,GACA,EAAA,CAAA,EACA,IACG,KAAA;AACH,IAAM,MAAA,MAAA,GAAsC,IAAI,MAAgB,EAAA,MAAA;AAChE,IAAA,IACE,2BACA,IAAA,CAAC,MACD,IAAA,CAAC,IAAI,OACL,IAAA,GAAA,CAAI,OAAQ,CAAA,OAAA,KAAY,UACxB,GAAI,CAAA,OAAA,CAAQ,OAAQ,CAAA,WAAA,OAAkB,WACtC,EAAA;AACA,MAAK,IAAA,EAAA;AACL,MAAA;AAAA;AAGF,IAA8B,2BAAA,GAAA,IAAA;AAC9B,IAAO,MAAA,CAAA,EAAA,CAAG,WAAW,aAAa,CAAA;AAAA,GACpC;AAEA,EAAA,MAAM,SAASC,uBAAO,EAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,iBAAiB,CAAA;AAE5B,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,CAAA,EAAG,QAAa,KAAA;AACrC,IAAA,QAAA,CAAS,IAAK,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAM,CAAA;AAAA,GAC/B,CAAA;AAED,EAAO,OAAA,MAAA;AACT;;;;"}
+{"version":3,"file":"router.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["/*\n * Copyright 2023 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 express, { NextFunction, Request, Response } from 'express';\nimport Router from 'express-promise-router';\nimport {\n  AuthService,\n  BackstageUserInfo,\n  DiscoveryService,\n  LifecycleService,\n  LoggerService,\n  UserInfoService,\n} from '@backstage/backend-plugin-api';\nimport * as https from 'https';\nimport http, { IncomingMessage } from 'http';\nimport { SignalManager } from './SignalManager';\nimport { EventsService } from '@backstage/plugin-events-node';\nimport { WebSocket, WebSocketServer } from 'ws';\nimport { Duplex } from 'stream';\nimport { Config } from '@backstage/config';\n\nexport interface RouterOptions {\n  logger: LoggerService;\n  events: EventsService;\n  discovery: DiscoveryService;\n  config: Config;\n  lifecycle: LifecycleService;\n  userInfo: UserInfoService;\n  auth: AuthService;\n}\n\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const { logger, discovery, auth, userInfo } = options;\n\n  const manager = SignalManager.create(options);\n  let subscribedToUpgradeRequests = false;\n  let apiUrl: string | undefined = undefined;\n\n  const webSocketServer = new WebSocketServer({\n    noServer: true, // handle upgrade manually\n    clientTracking: false, // handle connections in SignalManager\n  });\n\n  webSocketServer.on('error', (error: Error) => {\n    logger.error(`WebSocket server error: ${error}`);\n  });\n\n  const handleUpgrade = async (\n    request: Request<any, any, any, any, any>,\n    socket: Duplex,\n    head: Buffer,\n  ) => {\n    if (!apiUrl) {\n      apiUrl = await discovery.getBaseUrl('signals');\n    }\n\n    if (!request.url || !apiUrl || !apiUrl.endsWith(request.url)) {\n      return;\n    }\n\n    let userIdentity: BackstageUserInfo | undefined = undefined;\n\n    // Authentication token is passed in Sec-WebSocket-Protocol header as there\n    // is no other way to pass the token with plain websockets\n    try {\n      const token = request.headers['sec-websocket-protocol'];\n      if (token) {\n        const credentials = await auth.authenticate(token);\n        if (auth.isPrincipal(credentials, 'user')) {\n          userIdentity = await userInfo.getUserInfo(credentials);\n        }\n      }\n    } catch (e) {\n      logger.error(`Failed to authenticate WebSocket connection: ${e}`);\n      socket.write(\n        'HTTP/1.1 401 Web Socket Protocol Handshake\\r\\n' +\n          'Upgrade: WebSocket\\r\\n' +\n          'Connection: Upgrade\\r\\n' +\n          '\\r\\n',\n      );\n      socket.destroy();\n      return;\n    }\n\n    try {\n      webSocketServer.handleUpgrade(\n        request,\n        socket,\n        head,\n        (ws: WebSocket, __: IncomingMessage) => {\n          manager.addConnection(ws, userIdentity);\n        },\n      );\n    } catch (e) {\n      logger.error(`Failed to handle WebSocket upgrade: ${e}`);\n      socket.write(\n        'HTTP/1.1 500 Web Socket Protocol Handshake\\r\\n' +\n          'Upgrade: WebSocket\\r\\n' +\n          'Connection: Upgrade\\r\\n' +\n          '\\r\\n',\n      );\n      socket.destroy();\n    }\n  };\n\n  const upgradeMiddleware = async (\n    req: Request,\n    _: Response,\n    next: NextFunction,\n  ) => {\n    const server: https.Server | http.Server = (req.socket as any)?.server;\n    if (\n      subscribedToUpgradeRequests ||\n      !server ||\n      !req.headers ||\n      req.headers.upgrade === undefined ||\n      req.headers.upgrade.toLowerCase() !== 'websocket'\n    ) {\n      next();\n      return;\n    }\n\n    subscribedToUpgradeRequests = true;\n    server.on('upgrade', handleUpgrade);\n  };\n\n  const router = Router();\n  router.use(express.json());\n  router.use(upgradeMiddleware);\n\n  router.get('/health', (_, response) => {\n    response.json({ status: 'ok' });\n  });\n\n  return router;\n}\n"],"names":["SignalManager","WebSocketServer","Router","express"],"mappings":";;;;;;;;;;;;AA4CA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,SAAW,EAAA,IAAA,EAAM,UAAa,GAAA,OAAA;AAE9C,EAAM,MAAA,OAAA,GAAUA,2BAAc,CAAA,MAAA,CAAO,OAAO,CAAA;AAC5C,EAAA,IAAI,2BAA8B,GAAA,KAAA;AAClC,EAAA,IAAI,MAA6B,GAAA,KAAA,CAAA;AAEjC,EAAM,MAAA,eAAA,GAAkB,IAAIC,kBAAgB,CAAA;AAAA,IAC1C,QAAU,EAAA,IAAA;AAAA;AAAA,IACV,cAAgB,EAAA;AAAA;AAAA,GACjB,CAAA;AAED,EAAgB,eAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,KAAiB,KAAA;AAC5C,IAAO,MAAA,CAAA,KAAA,CAAM,CAA2B,wBAAA,EAAA,KAAK,CAAE,CAAA,CAAA;AAAA,GAChD,CAAA;AAED,EAAA,MAAM,aAAgB,GAAA,OACpB,OACA,EAAA,MAAA,EACA,IACG,KAAA;AACH,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAS,MAAA,GAAA,MAAM,SAAU,CAAA,UAAA,CAAW,SAAS,CAAA;AAAA;AAG/C,IAAI,IAAA,CAAC,OAAQ,CAAA,GAAA,IAAO,CAAC,MAAA,IAAU,CAAC,MAAO,CAAA,QAAA,CAAS,OAAQ,CAAA,GAAG,CAAG,EAAA;AAC5D,MAAA;AAAA;AAGF,IAAA,IAAI,YAA8C,GAAA,KAAA,CAAA;AAIlD,IAAI,IAAA;AACF,MAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,OAAA,CAAQ,wBAAwB,CAAA;AACtD,MAAA,IAAI,KAAO,EAAA;AACT,QAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,KAAK,CAAA;AACjD,QAAA,IAAI,IAAK,CAAA,WAAA,CAAY,WAAa,EAAA,MAAM,CAAG,EAAA;AACzC,UAAe,YAAA,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,WAAW,CAAA;AAAA;AACvD;AACF,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAgD,6CAAA,EAAA,CAAC,CAAE,CAAA,CAAA;AAChE,MAAO,MAAA,CAAA,KAAA;AAAA,QACL;AAAA,OAIF;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA;AACf,MAAA;AAAA;AAGF,IAAI,IAAA;AACF,MAAgB,eAAA,CAAA,aAAA;AAAA,QACd,OAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,CAAC,IAAe,EAAwB,KAAA;AACtC,UAAQ,OAAA,CAAA,aAAA,CAAc,IAAI,YAAY,CAAA;AAAA;AACxC,OACF;AAAA,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAuC,oCAAA,EAAA,CAAC,CAAE,CAAA,CAAA;AACvD,MAAO,MAAA,CAAA,KAAA;AAAA,QACL;AAAA,OAIF;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA;AAAA;AACjB,GACF;AAEA,EAAA,MAAM,iBAAoB,GAAA,OACxB,GACA,EAAA,CAAA,EACA,IACG,KAAA;AACH,IAAM,MAAA,MAAA,GAAsC,IAAI,MAAgB,EAAA,MAAA;AAChE,IAAA,IACE,2BACA,IAAA,CAAC,MACD,IAAA,CAAC,IAAI,OACL,IAAA,GAAA,CAAI,OAAQ,CAAA,OAAA,KAAY,UACxB,GAAI,CAAA,OAAA,CAAQ,OAAQ,CAAA,WAAA,OAAkB,WACtC,EAAA;AACA,MAAK,IAAA,EAAA;AACL,MAAA;AAAA;AAGF,IAA8B,2BAAA,GAAA,IAAA;AAC9B,IAAO,MAAA,CAAA,EAAA,CAAG,WAAW,aAAa,CAAA;AAAA,GACpC;AAEA,EAAA,MAAM,SAASC,uBAAO,EAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,iBAAiB,CAAA;AAE5B,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,CAAA,EAAG,QAAa,KAAA;AACrC,IAAA,QAAA,CAAS,IAAK,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAM,CAAA;AAAA,GAC/B,CAAA;AAED,EAAO,OAAA,MAAA;AACT;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-signals-backend",
-  "version": "0.2.4",
+  "version": "0.3.0-next.1",
   "backstage": {
     "role": "backend-plugin",
     "pluginId": "signals",
@@ -37,14 +37,12 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-plugin-api": "^1.1.0",
-    "@backstage/config": "^1.3.1",
-    "@backstage/plugin-auth-node": "^0.5.5",
-    "@backstage/plugin-events-node": "^0.4.6",
-    "@backstage/plugin-signals-node": "^0.1.15",
-    "@backstage/types": "^1.2.0",
-    "@types/express": "^4.17.6",
+    "@backstage/backend-plugin-api": "1.1.1-next.0",
+    "@backstage/config": "1.3.1",
+    "@backstage/plugin-auth-node": "0.5.6-next.0",
+    "@backstage/plugin-events-node": "0.4.7-next.0",
+    "@backstage/plugin-signals-node": "0.1.16-next.0",
+    "@backstage/types": "1.2.0",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
     "http-proxy-middleware": "^2.0.0",
@@ -54,12 +52,13 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "^0.6.0",
-    "@backstage/backend-test-utils": "^1.2.0",
-    "@backstage/cli": "^0.29.4",
-    "@backstage/plugin-auth-backend": "^0.24.1",
-    "@backstage/plugin-auth-backend-module-guest-provider": "^0.2.3",
-    "@backstage/plugin-events-backend": "^0.4.0",
+    "@backstage/backend-defaults": "0.7.0-next.0",
+    "@backstage/backend-test-utils": "1.2.1-next.0",
+    "@backstage/cli": "0.29.5-next.0",
+    "@backstage/plugin-auth-backend": "0.24.2-next.0",
+    "@backstage/plugin-auth-backend-module-guest-provider": "0.2.4-next.0",
+    "@backstage/plugin-events-backend": "0.4.1-next.0",
+    "@types/express": "^4.17.6",
     "@types/supertest": "^2.0.8",
     "@types/ws": "^8.5.10",
     "msw": "^1.0.0",

package/dist/deprecated.cjs.js

@@ -1,14 +0,0 @@
-'use strict';
-
-var backendCommon = require('@backstage/backend-common');
-var router = require('./service/router.cjs.js');
-
-async function createRouter(options) {
-  return router.createRouter({
-    ...options,
-    ...backendCommon.createLegacyAuthAdapters(options)
-  });
-}
-
-exports.createRouter = createRouter;
-//# sourceMappingURL=deprecated.cjs.js.map

package/dist/deprecated.cjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"deprecated.cjs.js","sources":["../src/deprecated.ts"],"sourcesContent":["/*\n * Copyright 2024 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 express from 'express';\n\nimport { Config } from '@backstage/config';\nimport {\n  AuthService,\n  DiscoveryService,\n  LifecycleService,\n  LoggerService,\n  UserInfoService,\n} from '@backstage/backend-plugin-api';\nimport { createLegacyAuthAdapters } from '@backstage/backend-common';\n\nimport { IdentityApi } from '@backstage/plugin-auth-node';\nimport { EventsService } from '@backstage/plugin-events-node';\n\nimport { createRouter as _createRouter } from './service/router';\n\n/**\n * @public\n * @deprecated Please migrate to the new backend system as this will be removed in the future.\n */\nexport interface RouterOptions {\n  logger: LoggerService;\n  events: EventsService;\n  identity?: IdentityApi;\n  discovery: DiscoveryService;\n  config: Config;\n  lifecycle?: LifecycleService;\n  auth?: AuthService;\n  userInfo?: UserInfoService;\n}\n\n/**\n * @public\n * @deprecated Please migrate to the new backend system as this will be removed in the future.\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  return _createRouter({\n    ...options,\n    ...createLegacyAuthAdapters(options),\n  });\n}\n"],"names":["_createRouter","createLegacyAuthAdapters"],"mappings":";;;;;AAoDA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,OAAOA,mBAAc,CAAA;AAAA,IACnB,GAAG,OAAA;AAAA,IACH,GAAGC,uCAAyB,OAAO;AAAA,GACpC,CAAA;AACH;;;;"}