@backstage/plugin-signals-backend 0.1.4 → 0.1.5-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @backstage/plugin-signals-backend
2
2
 
3
+ ## 0.1.5-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - 6a576dc: Replace the usage of `getVoidLogger` with `mockServices.logger.mock` in order to remove the dependency with the soon-to-be-deprecated `backend-common` package.
8
+ - Updated dependencies
9
+ - @backstage/backend-common@0.22.1-next.0
10
+ - @backstage/plugin-events-node@0.3.5-next.0
11
+ - @backstage/backend-plugin-api@0.6.19-next.0
12
+ - @backstage/plugin-auth-node@0.4.14-next.0
13
+ - @backstage/plugin-signals-node@0.1.5-next.0
14
+ - @backstage/config@1.2.0
15
+ - @backstage/types@1.1.1
16
+
3
17
  ## 0.1.4
4
18
 
5
19
  ### Patch Changes
package/dist/index.cjs.js CHANGED
@@ -15,29 +15,22 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
15
15
  var express__default = /*#__PURE__*/_interopDefaultCompat(express);
16
16
  var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
17
17
 
18
- var __defProp = Object.defineProperty;
19
- var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
20
- var __publicField = (obj, key, value) => {
21
- __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
22
- return value;
23
- };
24
18
  class SignalManager {
19
+ connections = /* @__PURE__ */ new Map();
20
+ events;
21
+ logger;
22
+ pingInterval;
23
+ static create(options) {
24
+ return new SignalManager(options);
25
+ }
25
26
  constructor(options) {
26
- __publicField(this, "connections", /* @__PURE__ */ new Map());
27
- __publicField(this, "events");
28
- __publicField(this, "logger");
29
- __publicField(this, "pingInterval");
30
- var _a;
31
27
  ({ events: this.events, logger: this.logger } = options);
32
28
  this.events.subscribe({
33
29
  id: "signals",
34
30
  topics: ["signals"],
35
31
  onEvent: (params) => this.onEventBrokerEvent(params.eventPayload)
36
32
  });
37
- (_a = options.lifecycle) == null ? void 0 : _a.addShutdownHook(() => this.onShutdown());
38
- }
39
- static create(options) {
40
- return new SignalManager(options);
33
+ options.lifecycle?.addShutdownHook(() => this.onShutdown());
41
34
  }
42
35
  ping() {
43
36
  this.connections.forEach((conn) => {
@@ -60,16 +53,15 @@ class SignalManager {
60
53
  this.connections.clear();
61
54
  }
62
55
  addConnection(ws, identity) {
63
- var _a, _b;
64
56
  if (!this.pingInterval) {
65
57
  this.pingInterval = setInterval(() => this.ping(), 3e4);
66
58
  }
67
59
  const id = uuid.v4();
68
60
  const conn = {
69
61
  id,
70
- user: (_a = identity == null ? void 0 : identity.userEntityRef) != null ? _a : "user:default/guest",
62
+ user: identity?.userEntityRef ?? "user:default/guest",
71
63
  ws,
72
- ownershipEntityRefs: (_b = identity == null ? void 0 : identity.ownershipEntityRefs) != null ? _b : [
64
+ ownershipEntityRefs: identity?.ownershipEntityRefs ?? [
73
65
  "user:default/guest"
74
66
  ],
75
67
  subscriptions: /* @__PURE__ */ new Set(),
@@ -212,8 +204,7 @@ async function createRouter(options) {
212
204
  }
213
205
  };
214
206
  const upgradeMiddleware = async (req, _, next) => {
215
- var _a;
216
- const server = (_a = req.socket) == null ? void 0 : _a.server;
207
+ const server = req.socket?.server;
217
208
  if (subscribedToUpgradeRequests || !server || !req.headers || req.headers.upgrade === void 0 || req.headers.upgrade.toLowerCase() !== "websocket") {
218
209
  next();
219
210
  return;
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs.js","sources":["../src/service/SignalManager.ts","../src/service/router.ts","../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 { EventParams, EventsService } from '@backstage/plugin-events-node';\nimport { SignalPayload } from '@backstage/plugin-signals-node';\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 ({ events: this.events, logger: this.logger } = options);\n\n this.events.subscribe({\n id: 'signals',\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","/*\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 createLegacyAuthAdapters,\n errorHandler,\n PluginEndpointDiscovery,\n} from '@backstage/backend-common';\nimport express, { NextFunction, Request, Response } from 'express';\nimport Router from 'express-promise-router';\nimport {\n AuthService,\n BackstageUserInfo,\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 { IdentityApi } from '@backstage/plugin-auth-node';\nimport { EventsService } from '@backstage/plugin-events-node';\nimport { WebSocket, WebSocketServer } from 'ws';\nimport { Duplex } from 'stream';\nimport { Config } from '@backstage/config';\n\n/** @public */\nexport interface RouterOptions {\n logger: LoggerService;\n events: EventsService;\n identity: IdentityApi;\n discovery: PluginEndpointDiscovery;\n config: Config;\n lifecycle?: LifecycleService;\n auth?: AuthService;\n userInfo?: UserInfoService;\n}\n\n/** @public */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { logger, discovery } = options;\n const { auth, userInfo } = createLegacyAuthAdapters(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 router.use(errorHandler());\n return router;\n}\n","/*\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 './service/router';\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 identity: coreServices.identity,\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 identity,\n discovery,\n userInfo,\n auth,\n events,\n }) {\n httpRouter.use(\n await createRouter({\n logger,\n config,\n identity,\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":["uuid","WebSocket","createLegacyAuthAdapters","WebSocketServer","Router","express","errorHandler","createBackendPlugin","coreServices","eventsServiceRef"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAkDO,MAAM,aAAc,CAAA;AAAA,EAajB,YAAY,OAA+B,EAAA;AAZnD,IAAQ,aAAA,CAAA,IAAA,EAAA,aAAA,sBAAiD,GAGvD,EAAA,CAAA,CAAA;AACF,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA,CAAA;AAzDV,IAAA,IAAA,EAAA,CAAA;AAgEI,IAAA,CAAC,EAAE,MAAQ,EAAA,IAAA,CAAK,QAAQ,MAAQ,EAAA,IAAA,CAAK,QAAW,GAAA,OAAA,EAAA;AAEhD,IAAA,IAAA,CAAK,OAAO,SAAU,CAAA;AAAA,MACpB,EAAI,EAAA,SAAA;AAAA,MACJ,MAAA,EAAQ,CAAC,SAAS,CAAA;AAAA,MAClB,SAAS,CAAC,MAAA,KACR,IAAK,CAAA,kBAAA,CAAmB,OAAO,YAA6B,CAAA;AAAA,KAC/D,CAAA,CAAA;AAED,IAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,SAAR,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAmB,eAAgB,CAAA,MAAM,KAAK,UAAW,EAAA,CAAA,CAAA;AAAA,GAC3D;AAAA,EAfA,OAAO,OAAO,OAA+B,EAAA;AAC3C,IAAO,OAAA,IAAI,cAAc,OAAO,CAAA,CAAA;AAAA,GAClC;AAAA,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,CAAA;AACnE,QAAA,IAAA,CAAK,GAAG,SAAU,EAAA,CAAA;AAClB,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,IAAA,CAAK,OAAU,GAAA,KAAA,CAAA;AACf,MAAA,IAAA,CAAK,GAAG,IAAK,EAAA,CAAA;AAAA,KACd,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,UAAa,GAAA;AACnB,IAAA,IAAI,KAAK,YAAc,EAAA;AACrB,MAAA,aAAA,CAAc,KAAK,YAAY,CAAA,CAAA;AAAA,KACjC;AAIA,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAA,IAAA,CAAK,GAAG,SAAU,EAAA,CAAA;AAAA,KACnB,CAAA,CAAA;AACD,IAAA,IAAA,CAAK,YAAY,KAAM,EAAA,CAAA;AAAA,GACzB;AAAA,EAEA,aAAA,CAAc,IAAe,QAA8B,EAAA;AAtG7D,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAwGI,IAAI,IAAA,CAAC,KAAK,YAAc,EAAA;AACtB,MAAA,IAAA,CAAK,eAAe,WAAY,CAAA,MAAM,IAAK,CAAA,IAAA,IAAQ,GAAK,CAAA,CAAA;AAAA,KAC1D;AAEA,IAAA,MAAM,KAAKA,OAAK,EAAA,CAAA;AAChB,IAAA,MAAM,IAAO,GAAA;AAAA,MACX,EAAA;AAAA,MACA,IAAA,EAAA,CAAM,EAAU,GAAA,QAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,QAAA,CAAA,aAAA,KAAV,IAA2B,GAAA,EAAA,GAAA,oBAAA;AAAA,MACjC,EAAA;AAAA,MACA,mBAAA,EAAA,CAAqB,EAAU,GAAA,QAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,QAAA,CAAA,mBAAA,KAAV,IAAiC,GAAA,EAAA,GAAA;AAAA,QACpD,oBAAA;AAAA,OACF;AAAA,MACA,aAAA,sBAAmB,GAAY,EAAA;AAAA,MAC/B,OAAS,EAAA,IAAA;AAAA,KACX,CAAA;AAEA,IAAK,IAAA,CAAA,WAAA,CAAY,GAAI,CAAA,EAAA,EAAI,IAAI,CAAA,CAAA;AAE7B,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAc,WAAA,EAAA,EAAE,CAAY,UAAA,CAAA,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,CAAA;AAAA,OAC9C,CAAA;AACA,MAAA,EAAA,CAAG,SAAU,EAAA,CAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAAA,KAC3B,CAAA,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,CAAA;AAAA,OAC9D,CAAA;AACA,MAAA,EAAA,CAAG,SAAU,EAAA,CAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAAA,KAC3B,CAAA,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA,CAAA;AACf,MAAA,EAAA,CAAG,IAAK,EAAA,CAAA;AAAA,KACT,CAAA,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA,CAAA;AAAA,KAChB,CAAA,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,CAAA;AACnE,MAAA,IAAI,QAAU,EAAA;AACZ,QAAA,OAAA;AAAA,OACF;AACA,MAAI,IAAA;AACF,QAAA,MAAM,IAAO,GAAA,IAAA,CAAK,KAAM,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AACvC,QAAK,IAAA,CAAA,aAAA,CAAc,MAAM,IAAI,CAAA,CAAA;AAAA,eACtB,GAAU,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,yCAAA,EAA4C,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA,CAAA;AAAA,SACxD,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,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,CAAA;AAAA,OAC9D,CAAA;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,GAAI,CAAA,OAAA,CAAQ,OAAiB,CAAA,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,CAAA;AAAA,OAClE,CAAA;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,MAAO,CAAA,OAAA,CAAQ,OAAiB,CAAA,CAAA;AAAA,KAC3D;AAAA,GACF;AAAA,EAEA,MAAc,mBAAmB,YAA4C,EAAA;AAC3E,IAAA,IAAI,CAAC,YAAA,CAAa,OAAW,IAAA,CAAC,aAAa,OAAS,EAAA;AAClD,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,MAAM,EAAE,OAAA,EAAS,UAAY,EAAA,OAAA,EAAY,GAAA,YAAA,CAAA;AACzC,IAAA,MAAM,cAAc,IAAK,CAAA,SAAA,CAAU,EAAE,OAAA,EAAS,SAAS,CAAA,CAAA;AACvD,IAAA,IAAI,QAAkB,EAAC,CAAA;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,CAAA;AAAA,KAC3B;AAGA,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,OAAA;AAAA,OACF;AAGA,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,OAAA;AAAA,OACF;AAEA,MAAA,IAAI,IAAK,CAAA,EAAA,CAAG,UAAe,KAAAC,YAAA,CAAU,IAAM,EAAA;AACzC,QAAA,OAAA;AAAA,OACF;AAEA,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,CAAA;AAAA,SAClE;AAAA,OACD,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;ACtKA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAM,MAAA,EAAE,MAAQ,EAAA,SAAA,EAAc,GAAA,OAAA,CAAA;AAC9B,EAAA,MAAM,EAAE,IAAA,EAAM,QAAS,EAAA,GAAIC,uCAAyB,OAAO,CAAA,CAAA;AAE3D,EAAM,MAAA,OAAA,GAAU,aAAc,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAC5C,EAAA,IAAI,2BAA8B,GAAA,KAAA,CAAA;AAClC,EAAA,IAAI,MAA6B,GAAA,KAAA,CAAA,CAAA;AAEjC,EAAM,MAAA,eAAA,GAAkB,IAAIC,kBAAgB,CAAA;AAAA,IAC1C,QAAU,EAAA,IAAA;AAAA;AAAA,IACV,cAAgB,EAAA,KAAA;AAAA;AAAA,GACjB,CAAA,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,CAAA;AAAA,GAChD,CAAA,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,CAAA;AAAA,KAC/C;AAEA,IAAI,IAAA,CAAC,OAAQ,CAAA,GAAA,IAAO,CAAC,MAAA,IAAU,CAAC,MAAO,CAAA,QAAA,CAAS,OAAQ,CAAA,GAAG,CAAG,EAAA;AAC5D,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,IAAI,YAA8C,GAAA,KAAA,CAAA,CAAA;AAIlD,IAAI,IAAA;AACF,MAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,OAAA,CAAQ,wBAAwB,CAAA,CAAA;AACtD,MAAA,IAAI,KAAO,EAAA;AACT,QAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,KAAK,CAAA,CAAA;AACjD,QAAA,IAAI,IAAK,CAAA,WAAA,CAAY,WAAa,EAAA,MAAM,CAAG,EAAA;AACzC,UAAe,YAAA,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,WAAW,CAAA,CAAA;AAAA,SACvD;AAAA,OACF;AAAA,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAgD,6CAAA,EAAA,CAAC,CAAE,CAAA,CAAA,CAAA;AAChE,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,iGAAA;AAAA,OAIF,CAAA;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA,CAAA;AACf,MAAA,OAAA;AAAA,KACF;AAEA,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,CAAA;AAAA,SACxC;AAAA,OACF,CAAA;AAAA,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAuC,oCAAA,EAAA,CAAC,CAAE,CAAA,CAAA,CAAA;AACvD,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,iGAAA;AAAA,OAIF,CAAA;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA,CAAA;AAAA,KACjB;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,iBAAoB,GAAA,OACxB,GACA,EAAA,CAAA,EACA,IACG,KAAA;AApIP,IAAA,IAAA,EAAA,CAAA;AAqII,IAAM,MAAA,MAAA,GAAA,CAAsC,EAAI,GAAA,GAAA,CAAA,MAAA,KAAJ,IAAoB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,MAAA,CAAA;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,CAAA;AACL,MAAA,OAAA;AAAA,KACF;AAEA,IAA8B,2BAAA,GAAA,IAAA,CAAA;AAC9B,IAAO,MAAA,CAAA,EAAA,CAAG,WAAW,aAAa,CAAA,CAAA;AAAA,GACpC,CAAA;AAEA,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,iBAAiB,CAAA,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,CAAA;AAAA,GAC/B,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,EAAO,OAAA,MAAA,CAAA;AACT;;ACpIO,MAAM,gBAAgBC,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,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,MAAQ,EAAAC,iCAAA;AAAA,OACV;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,UAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA;AAAA,QACA,MAAA;AAAA,OACC,EAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,YACA,QAAA;AAAA,YACA,SAAA;AAAA,YACA,SAAA;AAAA,YACA,QAAA;AAAA,YACA,IAAA;AAAA,YACA,MAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AACA,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,IAAM,EAAA,GAAA;AAAA,UACN,KAAO,EAAA,iBAAA;AAAA,SACR,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
1
+ {"version":3,"file":"index.cjs.js","sources":["../src/service/SignalManager.ts","../src/service/router.ts","../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 { EventParams, EventsService } from '@backstage/plugin-events-node';\nimport { SignalPayload } from '@backstage/plugin-signals-node';\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 ({ events: this.events, logger: this.logger } = options);\n\n this.events.subscribe({\n id: 'signals',\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","/*\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 createLegacyAuthAdapters,\n errorHandler,\n PluginEndpointDiscovery,\n} from '@backstage/backend-common';\nimport express, { NextFunction, Request, Response } from 'express';\nimport Router from 'express-promise-router';\nimport {\n AuthService,\n BackstageUserInfo,\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 { IdentityApi } from '@backstage/plugin-auth-node';\nimport { EventsService } from '@backstage/plugin-events-node';\nimport { WebSocket, WebSocketServer } from 'ws';\nimport { Duplex } from 'stream';\nimport { Config } from '@backstage/config';\n\n/** @public */\nexport interface RouterOptions {\n logger: LoggerService;\n events: EventsService;\n identity: IdentityApi;\n discovery: PluginEndpointDiscovery;\n config: Config;\n lifecycle?: LifecycleService;\n auth?: AuthService;\n userInfo?: UserInfoService;\n}\n\n/** @public */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { logger, discovery } = options;\n const { auth, userInfo } = createLegacyAuthAdapters(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 router.use(errorHandler());\n return router;\n}\n","/*\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 './service/router';\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 identity: coreServices.identity,\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 identity,\n discovery,\n userInfo,\n auth,\n events,\n }) {\n httpRouter.use(\n await createRouter({\n logger,\n config,\n identity,\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":["uuid","WebSocket","createLegacyAuthAdapters","WebSocketServer","Router","express","errorHandler","createBackendPlugin","coreServices","eventsServiceRef"],"mappings":";;;;;;;;;;;;;;;;;AAkDO,MAAM,aAAc,CAAA;AAAA,EACjB,WAAA,uBAAiD,GAGvD,EAAA,CAAA;AAAA,EACM,MAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EAER,OAAO,OAAO,OAA+B,EAAA;AAC3C,IAAO,OAAA,IAAI,cAAc,OAAO,CAAA,CAAA;AAAA,GAClC;AAAA,EAEQ,YAAY,OAA+B,EAAA;AACjD,IAAA,CAAC,EAAE,MAAQ,EAAA,IAAA,CAAK,QAAQ,MAAQ,EAAA,IAAA,CAAK,QAAW,GAAA,OAAA,EAAA;AAEhD,IAAA,IAAA,CAAK,OAAO,SAAU,CAAA;AAAA,MACpB,EAAI,EAAA,SAAA;AAAA,MACJ,MAAA,EAAQ,CAAC,SAAS,CAAA;AAAA,MAClB,SAAS,CAAC,MAAA,KACR,IAAK,CAAA,kBAAA,CAAmB,OAAO,YAA6B,CAAA;AAAA,KAC/D,CAAA,CAAA;AAED,IAAA,OAAA,CAAQ,SAAW,EAAA,eAAA,CAAgB,MAAM,IAAA,CAAK,YAAY,CAAA,CAAA;AAAA,GAC5D;AAAA,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,CAAA;AACnE,QAAA,IAAA,CAAK,GAAG,SAAU,EAAA,CAAA;AAClB,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,IAAA,CAAK,OAAU,GAAA,KAAA,CAAA;AACf,MAAA,IAAA,CAAK,GAAG,IAAK,EAAA,CAAA;AAAA,KACd,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,UAAa,GAAA;AACnB,IAAA,IAAI,KAAK,YAAc,EAAA;AACrB,MAAA,aAAA,CAAc,KAAK,YAAY,CAAA,CAAA;AAAA,KACjC;AAIA,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAA,IAAA,CAAK,GAAG,SAAU,EAAA,CAAA;AAAA,KACnB,CAAA,CAAA;AACD,IAAA,IAAA,CAAK,YAAY,KAAM,EAAA,CAAA;AAAA,GACzB;AAAA,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,CAAA;AAAA,KAC1D;AAEA,IAAA,MAAM,KAAKA,OAAK,EAAA,CAAA;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,oBAAA;AAAA,OACF;AAAA,MACA,aAAA,sBAAmB,GAAY,EAAA;AAAA,MAC/B,OAAS,EAAA,IAAA;AAAA,KACX,CAAA;AAEA,IAAK,IAAA,CAAA,WAAA,CAAY,GAAI,CAAA,EAAA,EAAI,IAAI,CAAA,CAAA;AAE7B,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAc,WAAA,EAAA,EAAE,CAAY,UAAA,CAAA,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,CAAA;AAAA,OAC9C,CAAA;AACA,MAAA,EAAA,CAAG,SAAU,EAAA,CAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAAA,KAC3B,CAAA,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,CAAA;AAAA,OAC9D,CAAA;AACA,MAAA,EAAA,CAAG,SAAU,EAAA,CAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAAA,KAC3B,CAAA,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA,CAAA;AACf,MAAA,EAAA,CAAG,IAAK,EAAA,CAAA;AAAA,KACT,CAAA,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA,CAAA;AAAA,KAChB,CAAA,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,CAAA;AACnE,MAAA,IAAI,QAAU,EAAA;AACZ,QAAA,OAAA;AAAA,OACF;AACA,MAAI,IAAA;AACF,QAAA,MAAM,IAAO,GAAA,IAAA,CAAK,KAAM,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AACvC,QAAK,IAAA,CAAA,aAAA,CAAc,MAAM,IAAI,CAAA,CAAA;AAAA,eACtB,GAAU,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,yCAAA,EAA4C,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA,CAAA;AAAA,SACxD,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,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,CAAA;AAAA,OAC9D,CAAA;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,GAAI,CAAA,OAAA,CAAQ,OAAiB,CAAA,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,CAAA;AAAA,OAClE,CAAA;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,MAAO,CAAA,OAAA,CAAQ,OAAiB,CAAA,CAAA;AAAA,KAC3D;AAAA,GACF;AAAA,EAEA,MAAc,mBAAmB,YAA4C,EAAA;AAC3E,IAAA,IAAI,CAAC,YAAA,CAAa,OAAW,IAAA,CAAC,aAAa,OAAS,EAAA;AAClD,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,MAAM,EAAE,OAAA,EAAS,UAAY,EAAA,OAAA,EAAY,GAAA,YAAA,CAAA;AACzC,IAAA,MAAM,cAAc,IAAK,CAAA,SAAA,CAAU,EAAE,OAAA,EAAS,SAAS,CAAA,CAAA;AACvD,IAAA,IAAI,QAAkB,EAAC,CAAA;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,CAAA;AAAA,KAC3B;AAGA,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,OAAA;AAAA,OACF;AAGA,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,OAAA;AAAA,OACF;AAEA,MAAA,IAAI,IAAK,CAAA,EAAA,CAAG,UAAe,KAAAC,YAAA,CAAU,IAAM,EAAA;AACzC,QAAA,OAAA;AAAA,OACF;AAEA,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,CAAA;AAAA,SAClE;AAAA,OACD,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;ACtKA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAM,MAAA,EAAE,MAAQ,EAAA,SAAA,EAAc,GAAA,OAAA,CAAA;AAC9B,EAAA,MAAM,EAAE,IAAA,EAAM,QAAS,EAAA,GAAIC,uCAAyB,OAAO,CAAA,CAAA;AAE3D,EAAM,MAAA,OAAA,GAAU,aAAc,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAC5C,EAAA,IAAI,2BAA8B,GAAA,KAAA,CAAA;AAClC,EAAA,IAAI,MAA6B,GAAA,KAAA,CAAA,CAAA;AAEjC,EAAM,MAAA,eAAA,GAAkB,IAAIC,kBAAgB,CAAA;AAAA,IAC1C,QAAU,EAAA,IAAA;AAAA;AAAA,IACV,cAAgB,EAAA,KAAA;AAAA;AAAA,GACjB,CAAA,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,CAAA;AAAA,GAChD,CAAA,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,CAAA;AAAA,KAC/C;AAEA,IAAI,IAAA,CAAC,OAAQ,CAAA,GAAA,IAAO,CAAC,MAAA,IAAU,CAAC,MAAO,CAAA,QAAA,CAAS,OAAQ,CAAA,GAAG,CAAG,EAAA;AAC5D,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,IAAI,YAA8C,GAAA,KAAA,CAAA,CAAA;AAIlD,IAAI,IAAA;AACF,MAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,OAAA,CAAQ,wBAAwB,CAAA,CAAA;AACtD,MAAA,IAAI,KAAO,EAAA;AACT,QAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,KAAK,CAAA,CAAA;AACjD,QAAA,IAAI,IAAK,CAAA,WAAA,CAAY,WAAa,EAAA,MAAM,CAAG,EAAA;AACzC,UAAe,YAAA,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,WAAW,CAAA,CAAA;AAAA,SACvD;AAAA,OACF;AAAA,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAgD,6CAAA,EAAA,CAAC,CAAE,CAAA,CAAA,CAAA;AAChE,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,iGAAA;AAAA,OAIF,CAAA;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA,CAAA;AACf,MAAA,OAAA;AAAA,KACF;AAEA,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,CAAA;AAAA,SACxC;AAAA,OACF,CAAA;AAAA,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAuC,oCAAA,EAAA,CAAC,CAAE,CAAA,CAAA,CAAA;AACvD,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,iGAAA;AAAA,OAIF,CAAA;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA,CAAA;AAAA,KACjB;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,iBAAoB,GAAA,OACxB,GACA,EAAA,CAAA,EACA,IACG,KAAA;AACH,IAAM,MAAA,MAAA,GAAsC,IAAI,MAAgB,EAAA,MAAA,CAAA;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,CAAA;AACL,MAAA,OAAA;AAAA,KACF;AAEA,IAA8B,2BAAA,GAAA,IAAA,CAAA;AAC9B,IAAO,MAAA,CAAA,EAAA,CAAG,WAAW,aAAa,CAAA,CAAA;AAAA,GACpC,CAAA;AAEA,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,iBAAiB,CAAA,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,CAAA;AAAA,GAC/B,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,EAAO,OAAA,MAAA,CAAA;AACT;;ACpIO,MAAM,gBAAgBC,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,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,MAAQ,EAAAC,iCAAA;AAAA,OACV;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,UAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA;AAAA,QACA,MAAA;AAAA,OACC,EAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,YACA,QAAA;AAAA,YACA,SAAA;AAAA,YACA,SAAA;AAAA,YACA,QAAA;AAAA,YACA,IAAA;AAAA,YACA,MAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AACA,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,IAAM,EAAA,GAAA;AAAA,UACN,KAAO,EAAA,iBAAA;AAAA,SACR,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-signals-backend",
3
- "version": "0.1.4",
3
+ "version": "0.1.5-next.0",
4
4
  "main": "dist/index.cjs.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "license": "Apache-2.0",
@@ -27,12 +27,12 @@
27
27
  "postpack": "backstage-cli package postpack"
28
28
  },
29
29
  "dependencies": {
30
- "@backstage/backend-common": "^0.22.0",
31
- "@backstage/backend-plugin-api": "^0.6.18",
30
+ "@backstage/backend-common": "^0.22.1-next.0",
31
+ "@backstage/backend-plugin-api": "^0.6.19-next.0",
32
32
  "@backstage/config": "^1.2.0",
33
- "@backstage/plugin-auth-node": "^0.4.13",
34
- "@backstage/plugin-events-node": "^0.3.4",
35
- "@backstage/plugin-signals-node": "^0.1.4",
33
+ "@backstage/plugin-auth-node": "^0.4.14-next.0",
34
+ "@backstage/plugin-events-node": "^0.3.5-next.0",
35
+ "@backstage/plugin-signals-node": "^0.1.5-next.0",
36
36
  "@backstage/types": "^1.1.1",
37
37
  "@types/express": "*",
38
38
  "express": "^4.17.1",
@@ -45,11 +45,12 @@
45
45
  "yn": "^4.0.0"
46
46
  },
47
47
  "devDependencies": {
48
- "@backstage/backend-defaults": "^0.2.18",
49
- "@backstage/cli": "^0.26.5",
50
- "@backstage/plugin-auth-backend": "^0.22.5",
51
- "@backstage/plugin-auth-backend-module-guest-provider": "^0.1.4",
52
- "@backstage/plugin-events-backend": "^0.3.5",
48
+ "@backstage/backend-defaults": "^0.2.19-next.0",
49
+ "@backstage/backend-test-utils": "^0.3.9-next.0",
50
+ "@backstage/cli": "^0.26.6-next.0",
51
+ "@backstage/plugin-auth-backend": "^0.22.6-next.0",
52
+ "@backstage/plugin-auth-backend-module-guest-provider": "^0.1.5-next.0",
53
+ "@backstage/plugin-events-backend": "^0.3.6-next.0",
53
54
  "@types/supertest": "^2.0.8",
54
55
  "@types/ws": "^8.5.10",
55
56
  "msw": "^1.0.0",