@backstage/plugin-signals-backend 0.1.4-next.1 → 0.1.4
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 +21 -0
- package/dist/index.cjs.js +56 -12
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +4 -1
- package/package.json +13 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# @backstage/plugin-signals-backend
|
|
2
2
|
|
|
3
|
+
## 0.1.4
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 845d56a: Improved signal lifecycle management and added server side pinging of connections
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/backend-common@0.22.0
|
|
10
|
+
- @backstage/backend-plugin-api@0.6.18
|
|
11
|
+
- @backstage/plugin-events-node@0.3.4
|
|
12
|
+
- @backstage/plugin-auth-node@0.4.13
|
|
13
|
+
- @backstage/plugin-signals-node@0.1.4
|
|
14
|
+
|
|
15
|
+
## 0.1.4-next.2
|
|
16
|
+
|
|
17
|
+
### Patch Changes
|
|
18
|
+
|
|
19
|
+
- 845d56a: Improved signal lifecycle management and added server side pinging of connections
|
|
20
|
+
- Updated dependencies
|
|
21
|
+
- @backstage/backend-common@0.22.0-next.2
|
|
22
|
+
- @backstage/plugin-events-node@0.3.4-next.2
|
|
23
|
+
|
|
3
24
|
## 0.1.4-next.1
|
|
4
25
|
|
|
5
26
|
### Patch Changes
|
package/dist/index.cjs.js
CHANGED
|
@@ -26,18 +26,44 @@ class SignalManager {
|
|
|
26
26
|
__publicField(this, "connections", /* @__PURE__ */ new Map());
|
|
27
27
|
__publicField(this, "events");
|
|
28
28
|
__publicField(this, "logger");
|
|
29
|
+
__publicField(this, "pingInterval");
|
|
30
|
+
var _a;
|
|
29
31
|
({ events: this.events, logger: this.logger } = options);
|
|
30
32
|
this.events.subscribe({
|
|
31
33
|
id: "signals",
|
|
32
34
|
topics: ["signals"],
|
|
33
35
|
onEvent: (params) => this.onEventBrokerEvent(params.eventPayload)
|
|
34
36
|
});
|
|
37
|
+
(_a = options.lifecycle) == null ? void 0 : _a.addShutdownHook(() => this.onShutdown());
|
|
35
38
|
}
|
|
36
39
|
static create(options) {
|
|
37
40
|
return new SignalManager(options);
|
|
38
41
|
}
|
|
42
|
+
ping() {
|
|
43
|
+
this.connections.forEach((conn) => {
|
|
44
|
+
if (!conn.isAlive) {
|
|
45
|
+
this.logger.debug(`Connection ${conn.id} is not alive, terminating`);
|
|
46
|
+
conn.ws.terminate();
|
|
47
|
+
return;
|
|
48
|
+
}
|
|
49
|
+
conn.isAlive = false;
|
|
50
|
+
conn.ws.ping();
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
onShutdown() {
|
|
54
|
+
if (this.pingInterval) {
|
|
55
|
+
clearInterval(this.pingInterval);
|
|
56
|
+
}
|
|
57
|
+
this.connections.forEach((conn) => {
|
|
58
|
+
conn.ws.terminate();
|
|
59
|
+
});
|
|
60
|
+
this.connections.clear();
|
|
61
|
+
}
|
|
39
62
|
addConnection(ws, identity) {
|
|
40
63
|
var _a, _b;
|
|
64
|
+
if (!this.pingInterval) {
|
|
65
|
+
this.pingInterval = setInterval(() => this.ping(), 3e4);
|
|
66
|
+
}
|
|
41
67
|
const id = uuid.v4();
|
|
42
68
|
const conn = {
|
|
43
69
|
id,
|
|
@@ -46,22 +72,32 @@ class SignalManager {
|
|
|
46
72
|
ownershipEntityRefs: (_b = identity == null ? void 0 : identity.ownershipEntityRefs) != null ? _b : [
|
|
47
73
|
"user:default/guest"
|
|
48
74
|
],
|
|
49
|
-
subscriptions: /* @__PURE__ */ new Set()
|
|
75
|
+
subscriptions: /* @__PURE__ */ new Set(),
|
|
76
|
+
isAlive: true
|
|
50
77
|
};
|
|
51
78
|
this.connections.set(id, conn);
|
|
79
|
+
this.logger.debug(`Connection ${id} connected`);
|
|
52
80
|
ws.on("error", (err) => {
|
|
53
81
|
this.logger.error(
|
|
54
82
|
`Error occurred with connection ${id}: ${err}, closing connection`
|
|
55
83
|
);
|
|
56
|
-
ws.
|
|
84
|
+
ws.terminate();
|
|
57
85
|
this.connections.delete(id);
|
|
58
86
|
});
|
|
59
87
|
ws.on("close", (code, reason) => {
|
|
60
|
-
this.logger.
|
|
88
|
+
this.logger.debug(
|
|
61
89
|
`Connection ${id} closed with code ${code}, reason: ${reason}`
|
|
62
90
|
);
|
|
91
|
+
ws.terminate();
|
|
63
92
|
this.connections.delete(id);
|
|
64
93
|
});
|
|
94
|
+
ws.on("ping", () => {
|
|
95
|
+
conn.isAlive = true;
|
|
96
|
+
ws.pong();
|
|
97
|
+
});
|
|
98
|
+
ws.on("pong", () => {
|
|
99
|
+
conn.isAlive = true;
|
|
100
|
+
});
|
|
65
101
|
ws.on("message", (data, isBinary) => {
|
|
66
102
|
this.logger.debug(`Received message from connection ${id}: ${data}`);
|
|
67
103
|
if (isBinary) {
|
|
@@ -79,12 +115,12 @@ class SignalManager {
|
|
|
79
115
|
}
|
|
80
116
|
handleMessage(connection, message) {
|
|
81
117
|
if (message.action === "subscribe" && message.channel) {
|
|
82
|
-
this.logger.
|
|
118
|
+
this.logger.debug(
|
|
83
119
|
`Connection ${connection.id} subscribed to ${message.channel}`
|
|
84
120
|
);
|
|
85
121
|
connection.subscriptions.add(message.channel);
|
|
86
122
|
} else if (message.action === "unsubscribe" && message.channel) {
|
|
87
|
-
this.logger.
|
|
123
|
+
this.logger.debug(
|
|
88
124
|
`Connection ${connection.id} unsubscribed from ${message.channel}`
|
|
89
125
|
);
|
|
90
126
|
connection.subscriptions.delete(message.channel);
|
|
@@ -127,13 +163,12 @@ async function createRouter(options) {
|
|
|
127
163
|
let apiUrl = void 0;
|
|
128
164
|
const webSocketServer = new ws.WebSocketServer({
|
|
129
165
|
noServer: true,
|
|
166
|
+
// handle upgrade manually
|
|
130
167
|
clientTracking: false
|
|
168
|
+
// handle connections in SignalManager
|
|
131
169
|
});
|
|
132
170
|
webSocketServer.on("error", (error) => {
|
|
133
|
-
logger.error(
|
|
134
|
-
});
|
|
135
|
-
webSocketServer.on("close", () => {
|
|
136
|
-
logger.info("WebSocket server closed");
|
|
171
|
+
logger.error(`WebSocket server error: ${error}`);
|
|
137
172
|
});
|
|
138
173
|
const handleUpgrade = async (request, socket, head) => {
|
|
139
174
|
if (!apiUrl) {
|
|
@@ -152,7 +187,7 @@ async function createRouter(options) {
|
|
|
152
187
|
}
|
|
153
188
|
}
|
|
154
189
|
} catch (e) {
|
|
155
|
-
logger.error(
|
|
190
|
+
logger.error(`Failed to authenticate WebSocket connection: ${e}`);
|
|
156
191
|
socket.write(
|
|
157
192
|
"HTTP/1.1 401 Web Socket Protocol Handshake\r\nUpgrade: WebSocket\r\nConnection: Upgrade\r\n\r\n"
|
|
158
193
|
);
|
|
@@ -169,7 +204,11 @@ async function createRouter(options) {
|
|
|
169
204
|
}
|
|
170
205
|
);
|
|
171
206
|
} catch (e) {
|
|
172
|
-
logger.error(
|
|
207
|
+
logger.error(`Failed to handle WebSocket upgrade: ${e}`);
|
|
208
|
+
socket.write(
|
|
209
|
+
"HTTP/1.1 500 Web Socket Protocol Handshake\r\nUpgrade: WebSocket\r\nConnection: Upgrade\r\n\r\n"
|
|
210
|
+
);
|
|
211
|
+
socket.destroy();
|
|
173
212
|
}
|
|
174
213
|
};
|
|
175
214
|
const upgradeMiddleware = async (req, _, next) => {
|
|
@@ -186,7 +225,6 @@ async function createRouter(options) {
|
|
|
186
225
|
router.use(express__default.default.json());
|
|
187
226
|
router.use(upgradeMiddleware);
|
|
188
227
|
router.get("/health", (_, response) => {
|
|
189
|
-
logger.info("PONG!");
|
|
190
228
|
response.json({ status: "ok" });
|
|
191
229
|
});
|
|
192
230
|
router.use(backendCommon.errorHandler());
|
|
@@ -200,6 +238,8 @@ const signalsPlugin = backendPluginApi.createBackendPlugin({
|
|
|
200
238
|
deps: {
|
|
201
239
|
httpRouter: backendPluginApi.coreServices.httpRouter,
|
|
202
240
|
logger: backendPluginApi.coreServices.logger,
|
|
241
|
+
config: backendPluginApi.coreServices.rootConfig,
|
|
242
|
+
lifecycle: backendPluginApi.coreServices.rootLifecycle,
|
|
203
243
|
identity: backendPluginApi.coreServices.identity,
|
|
204
244
|
discovery: backendPluginApi.coreServices.discovery,
|
|
205
245
|
userInfo: backendPluginApi.coreServices.userInfo,
|
|
@@ -209,6 +249,8 @@ const signalsPlugin = backendPluginApi.createBackendPlugin({
|
|
|
209
249
|
async init({
|
|
210
250
|
httpRouter,
|
|
211
251
|
logger,
|
|
252
|
+
config,
|
|
253
|
+
lifecycle,
|
|
212
254
|
identity,
|
|
213
255
|
discovery,
|
|
214
256
|
userInfo,
|
|
@@ -218,7 +260,9 @@ const signalsPlugin = backendPluginApi.createBackendPlugin({
|
|
|
218
260
|
httpRouter.use(
|
|
219
261
|
await createRouter({
|
|
220
262
|
logger,
|
|
263
|
+
config,
|
|
221
264
|
identity,
|
|
265
|
+
lifecycle,
|
|
222
266
|
discovery,
|
|
223
267
|
userInfo,
|
|
224
268
|
auth,
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -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 LoggerService,\n} from '@backstage/backend-plugin-api';\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};\n\n/**\n * @internal\n */\nexport type SignalManagerOptions = {\n events: EventsService;\n logger: LoggerService;\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\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\n addConnection(ws: WebSocket, identity?: BackstageUserInfo) {\n const id = uuid();\n\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 };\n\n this.connections.set(id, conn);\n\n ws.on('error', (err: Error) => {\n this.logger.error(\n `Error occurred with connection ${id}: ${err}, closing connection`,\n );\n ws.close();\n this.connections.delete(id);\n });\n\n ws.on('close', (code: number, reason: Buffer) => {\n this.logger.info(\n `Connection ${id} closed with code ${code}, reason: ${reason}`,\n );\n this.connections.delete(id);\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.info(\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.info(\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 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';\n\n/** @public */\nexport interface RouterOptions {\n logger: LoggerService;\n events: EventsService;\n identity: IdentityApi;\n discovery: PluginEndpointDiscovery;\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,\n clientTracking: false,\n });\n\n webSocketServer.on('error', (error: Error) => {\n logger.error('WebSocket server error', error);\n });\n\n webSocketServer.on('close', () => {\n logger.info('WebSocket server closed');\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 }\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 logger.info('PONG!');\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 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 identity,\n discovery,\n userInfo,\n auth,\n events,\n }) {\n httpRouter.use(\n await createRouter({\n logger,\n identity,\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":";;;;;;;;;;;;;;;;;;;;;;;AA6CO,MAAM,aAAc,CAAA;AAAA,EAYjB,YAAY,OAA+B,EAAA;AAXnD,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;AAON,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;AAAA,GACH;AAAA,EAbA,OAAO,OAAO,OAA+B,EAAA;AAC3C,IAAO,OAAA,IAAI,cAAc,OAAO,CAAA,CAAA;AAAA,GAClC;AAAA,EAaA,aAAA,CAAc,IAAe,QAA8B,EAAA;AApE7D,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAqEI,IAAA,MAAM,KAAKA,OAAK,EAAA,CAAA;AAEhB,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,KACjC,CAAA;AAEA,IAAK,IAAA,CAAA,WAAA,CAAY,GAAI,CAAA,EAAA,EAAI,IAAI,CAAA,CAAA;AAE7B,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,KAAM,EAAA,CAAA;AACT,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,IAAA;AAAA,QACV,CAAc,WAAA,EAAA,EAAE,CAAqB,kBAAA,EAAA,IAAI,aAAa,MAAM,CAAA,CAAA;AAAA,OAC9D,CAAA;AACA,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAAA,KAC3B,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,IAAA;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,IAAA;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;;ACxHA,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,IACV,cAAgB,EAAA,KAAA;AAAA,GACjB,CAAA,CAAA;AAED,EAAgB,eAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,KAAiB,KAAA;AAC5C,IAAO,MAAA,CAAA,KAAA,CAAM,0BAA0B,KAAK,CAAA,CAAA;AAAA,GAC7C,CAAA,CAAA;AAED,EAAgB,eAAA,CAAA,EAAA,CAAG,SAAS,MAAM;AAChC,IAAA,MAAA,CAAO,KAAK,yBAAyB,CAAA,CAAA;AAAA,GACtC,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,+CAA+C,CAAC,CAAA,CAAA;AAC7D,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,sCAAsC,CAAC,CAAA,CAAA;AAAA,KACtD;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,iBAAoB,GAAA,OACxB,GACA,EAAA,CAAA,EACA,IACG,KAAA;AA7HP,IAAA,IAAA,EAAA,CAAA;AA8HI,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,MAAA,CAAO,KAAK,OAAO,CAAA,CAAA;AACnB,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;;AC9HO,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,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,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,QAAA;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,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;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import { PluginEndpointDiscovery } from '@backstage/backend-common';
|
|
2
2
|
import express from 'express';
|
|
3
3
|
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
4
|
-
import { LoggerService, AuthService, UserInfoService } from '@backstage/backend-plugin-api';
|
|
4
|
+
import { LoggerService, LifecycleService, AuthService, UserInfoService } from '@backstage/backend-plugin-api';
|
|
5
5
|
import { IdentityApi } from '@backstage/plugin-auth-node';
|
|
6
6
|
import { EventsService } from '@backstage/plugin-events-node';
|
|
7
|
+
import { Config } from '@backstage/config';
|
|
7
8
|
|
|
8
9
|
/** @public */
|
|
9
10
|
interface RouterOptions {
|
|
@@ -11,6 +12,8 @@ interface RouterOptions {
|
|
|
11
12
|
events: EventsService;
|
|
12
13
|
identity: IdentityApi;
|
|
13
14
|
discovery: PluginEndpointDiscovery;
|
|
15
|
+
config: Config;
|
|
16
|
+
lifecycle?: LifecycleService;
|
|
14
17
|
auth?: AuthService;
|
|
15
18
|
userInfo?: UserInfoService;
|
|
16
19
|
}
|
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.4",
|
|
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.0",
|
|
31
|
+
"@backstage/backend-plugin-api": "^0.6.18",
|
|
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.13",
|
|
34
|
+
"@backstage/plugin-events-node": "^0.3.4",
|
|
35
|
+
"@backstage/plugin-signals-node": "^0.1.4",
|
|
36
36
|
"@backstage/types": "^1.1.1",
|
|
37
37
|
"@types/express": "*",
|
|
38
38
|
"express": "^4.17.1",
|
|
@@ -41,16 +41,17 @@
|
|
|
41
41
|
"node-fetch": "^2.6.7",
|
|
42
42
|
"uuid": "^9.0.0",
|
|
43
43
|
"winston": "^3.2.1",
|
|
44
|
-
"ws": "^8.
|
|
44
|
+
"ws": "^8.17.0",
|
|
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.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",
|
|
53
53
|
"@types/supertest": "^2.0.8",
|
|
54
|
+
"@types/ws": "^8.5.10",
|
|
54
55
|
"msw": "^1.0.0",
|
|
55
56
|
"supertest": "^6.2.4"
|
|
56
57
|
},
|