@backstage/plugin-signals-backend 0.0.4 → 0.1.0-next.2
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 +32 -18
- package/README.md +1 -1
- package/dist/index.cjs.js +71 -36
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +5 -3
- package/package.json +9 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,37 +1,51 @@
|
|
|
1
1
|
# @backstage/plugin-signals-backend
|
|
2
2
|
|
|
3
|
-
## 0.0.
|
|
3
|
+
## 0.1.0-next.2
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
|
+
- 6d84ee6: Changed to use the refactored signal service naming
|
|
7
8
|
- Updated dependencies
|
|
8
|
-
- @backstage/
|
|
9
|
-
- @backstage/
|
|
10
|
-
- @backstage/plugin-
|
|
11
|
-
- @backstage/backend-plugin-api@0.6.
|
|
12
|
-
- @backstage/
|
|
9
|
+
- @backstage/plugin-signals-node@0.1.0-next.2
|
|
10
|
+
- @backstage/backend-common@0.21.4-next.2
|
|
11
|
+
- @backstage/plugin-auth-node@0.4.9-next.2
|
|
12
|
+
- @backstage/backend-plugin-api@0.6.14-next.2
|
|
13
|
+
- @backstage/config@1.2.0-next.1
|
|
14
|
+
- @backstage/types@1.1.1
|
|
15
|
+
- @backstage/plugin-events-node@0.3.0-next.2
|
|
16
|
+
|
|
17
|
+
## 0.1.0-next.1
|
|
18
|
+
|
|
19
|
+
### Minor Changes
|
|
13
20
|
|
|
14
|
-
|
|
21
|
+
- daf85dc: BREAKING CHANGE: Migrates signals to use the `EventsService` and makes it mandatory
|
|
15
22
|
|
|
16
23
|
### Patch Changes
|
|
17
24
|
|
|
25
|
+
- df45710: Improved error logging and fixed authentication
|
|
18
26
|
- Updated dependencies
|
|
19
|
-
- @backstage/
|
|
20
|
-
- @backstage/plugin-
|
|
21
|
-
- @backstage/
|
|
22
|
-
- @backstage/backend-plugin-api@0.6.
|
|
23
|
-
- @backstage/plugin-
|
|
27
|
+
- @backstage/config@1.2.0-next.1
|
|
28
|
+
- @backstage/plugin-signals-node@0.1.0-next.1
|
|
29
|
+
- @backstage/backend-common@0.21.4-next.1
|
|
30
|
+
- @backstage/backend-plugin-api@0.6.14-next.1
|
|
31
|
+
- @backstage/plugin-auth-node@0.4.9-next.1
|
|
32
|
+
- @backstage/types@1.1.1
|
|
33
|
+
- @backstage/plugin-events-node@0.3.0-next.1
|
|
24
34
|
|
|
25
|
-
## 0.0.
|
|
35
|
+
## 0.0.4-next.0
|
|
26
36
|
|
|
27
37
|
### Patch Changes
|
|
28
38
|
|
|
39
|
+
- 0fb419b: Updated dependency `uuid` to `^9.0.0`.
|
|
40
|
+
Updated dependency `@types/uuid` to `^9.0.0`.
|
|
29
41
|
- Updated dependencies
|
|
30
|
-
- @backstage/
|
|
31
|
-
- @backstage/
|
|
32
|
-
- @backstage/plugin-
|
|
33
|
-
- @backstage/backend-plugin-api@0.6.
|
|
34
|
-
- @backstage/plugin-
|
|
42
|
+
- @backstage/plugin-events-node@0.3.0-next.0
|
|
43
|
+
- @backstage/backend-common@0.21.3-next.0
|
|
44
|
+
- @backstage/plugin-auth-node@0.4.8-next.0
|
|
45
|
+
- @backstage/backend-plugin-api@0.6.13-next.0
|
|
46
|
+
- @backstage/plugin-signals-node@0.0.4-next.0
|
|
47
|
+
- @backstage/config@1.1.2-next.0
|
|
48
|
+
- @backstage/types@1.1.1
|
|
35
49
|
|
|
36
50
|
## 0.0.1
|
|
37
51
|
|
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ Signals plugin allows backend plugins to publish messages to frontend plugins.
|
|
|
6
6
|
|
|
7
7
|
## Getting started
|
|
8
8
|
|
|
9
|
-
First install the `@backstage/plugin-signals-node` plugin to get the `
|
|
9
|
+
First install the `@backstage/plugin-signals-node` plugin to get the `SignalsService` set up.
|
|
10
10
|
|
|
11
11
|
Next, add Signals router to your backend in `packages/backend/src/plugins/signals.ts`:
|
|
12
12
|
|
package/dist/index.cjs.js
CHANGED
|
@@ -8,6 +8,7 @@ var Router = require('express-promise-router');
|
|
|
8
8
|
var ws = require('ws');
|
|
9
9
|
var uuid = require('uuid');
|
|
10
10
|
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
11
|
+
var pluginEventsNode = require('@backstage/plugin-events-node');
|
|
11
12
|
|
|
12
13
|
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
13
14
|
|
|
@@ -23,13 +24,13 @@ var __publicField = (obj, key, value) => {
|
|
|
23
24
|
class SignalManager {
|
|
24
25
|
constructor(options) {
|
|
25
26
|
__publicField(this, "connections", /* @__PURE__ */ new Map());
|
|
26
|
-
__publicField(this, "
|
|
27
|
+
__publicField(this, "events");
|
|
27
28
|
__publicField(this, "logger");
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
onEvent: (params) => this.onEventBrokerEvent(params)
|
|
29
|
+
({ events: this.events, logger: this.logger } = options);
|
|
30
|
+
this.events.subscribe({
|
|
31
|
+
id: "signals",
|
|
32
|
+
topics: ["signals"],
|
|
33
|
+
onEvent: (params) => this.onEventBrokerEvent(params.eventPayload)
|
|
33
34
|
});
|
|
34
35
|
}
|
|
35
36
|
static create(options) {
|
|
@@ -40,16 +41,16 @@ class SignalManager {
|
|
|
40
41
|
const id = uuid.v4();
|
|
41
42
|
const conn = {
|
|
42
43
|
id,
|
|
43
|
-
user: (_a = identity == null ? void 0 : identity.
|
|
44
|
+
user: (_a = identity == null ? void 0 : identity.userEntityRef) != null ? _a : "user:default/guest",
|
|
44
45
|
ws,
|
|
45
|
-
ownershipEntityRefs: (_b = identity == null ? void 0 : identity.
|
|
46
|
+
ownershipEntityRefs: (_b = identity == null ? void 0 : identity.ownershipEntityRefs) != null ? _b : [
|
|
46
47
|
"user:default/guest"
|
|
47
48
|
],
|
|
48
49
|
subscriptions: /* @__PURE__ */ new Set()
|
|
49
50
|
};
|
|
50
51
|
this.connections.set(id, conn);
|
|
51
52
|
ws.on("error", (err) => {
|
|
52
|
-
this.logger.
|
|
53
|
+
this.logger.error(
|
|
53
54
|
`Error occurred with connection ${id}: ${err}, closing connection`
|
|
54
55
|
);
|
|
55
56
|
ws.close();
|
|
@@ -89,8 +90,7 @@ class SignalManager {
|
|
|
89
90
|
connection.subscriptions.delete(message.channel);
|
|
90
91
|
}
|
|
91
92
|
}
|
|
92
|
-
async onEventBrokerEvent(
|
|
93
|
-
const { eventPayload } = params;
|
|
93
|
+
async onEventBrokerEvent(eventPayload) {
|
|
94
94
|
if (!eventPayload.channel || !eventPayload.message) {
|
|
95
95
|
return;
|
|
96
96
|
}
|
|
@@ -120,35 +120,46 @@ class SignalManager {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
async function createRouter(options) {
|
|
123
|
-
const { logger,
|
|
123
|
+
const { logger, discovery } = options;
|
|
124
|
+
const { auth, userInfo } = backendCommon.createLegacyAuthAdapters(options);
|
|
124
125
|
const manager = SignalManager.create(options);
|
|
125
126
|
let subscribedToUpgradeRequests = false;
|
|
127
|
+
let apiUrl = void 0;
|
|
126
128
|
const webSocketServer = new ws.WebSocketServer({
|
|
127
129
|
noServer: true,
|
|
128
130
|
clientTracking: false
|
|
129
131
|
});
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
132
|
+
webSocketServer.on("error", (error) => {
|
|
133
|
+
logger.error("WebSocket server error", error);
|
|
134
|
+
});
|
|
135
|
+
webSocketServer.on("close", () => {
|
|
136
|
+
logger.info("WebSocket server closed");
|
|
137
|
+
});
|
|
138
|
+
const handleUpgrade = async (request, socket, head) => {
|
|
139
|
+
if (!apiUrl) {
|
|
140
|
+
apiUrl = await discovery.getBaseUrl("signals");
|
|
141
|
+
}
|
|
142
|
+
if (!request.url || !apiUrl || !apiUrl.endsWith(request.url)) {
|
|
135
143
|
return;
|
|
136
144
|
}
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
if (!request.url || !apiUrl.endsWith(request.url)) {
|
|
141
|
-
return;
|
|
142
|
-
}
|
|
143
|
-
let userIdentity = void 0;
|
|
144
|
-
const token = req.headers["sec-websocket-protocol"];
|
|
145
|
+
let userIdentity = void 0;
|
|
146
|
+
try {
|
|
147
|
+
const token = request.headers["sec-websocket-protocol"];
|
|
145
148
|
if (token) {
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
});
|
|
149
|
+
const credentials = await auth.authenticate(token);
|
|
150
|
+
if (auth.isPrincipal(credentials, "user")) {
|
|
151
|
+
userIdentity = await userInfo.getUserInfo(credentials);
|
|
152
|
+
}
|
|
151
153
|
}
|
|
154
|
+
} catch (e) {
|
|
155
|
+
logger.error("Failed to authenticate WebSocket connection", e);
|
|
156
|
+
socket.write(
|
|
157
|
+
"HTTP/1.1 401 Web Socket Protocol Handshake\r\nUpgrade: WebSocket\r\nConnection: Upgrade\r\n\r\n"
|
|
158
|
+
);
|
|
159
|
+
socket.destroy();
|
|
160
|
+
return;
|
|
161
|
+
}
|
|
162
|
+
try {
|
|
152
163
|
webSocketServer.handleUpgrade(
|
|
153
164
|
request,
|
|
154
165
|
socket,
|
|
@@ -157,7 +168,19 @@ async function createRouter(options) {
|
|
|
157
168
|
manager.addConnection(ws, userIdentity);
|
|
158
169
|
}
|
|
159
170
|
);
|
|
160
|
-
})
|
|
171
|
+
} catch (e) {
|
|
172
|
+
logger.error("Failed to handle WebSocket upgrade", e);
|
|
173
|
+
}
|
|
174
|
+
};
|
|
175
|
+
const upgradeMiddleware = async (req, _, next) => {
|
|
176
|
+
var _a;
|
|
177
|
+
const server = (_a = req.socket) == null ? void 0 : _a.server;
|
|
178
|
+
if (subscribedToUpgradeRequests || !server || !req.headers || req.headers.upgrade === void 0 || req.headers.upgrade.toLowerCase() !== "websocket") {
|
|
179
|
+
next();
|
|
180
|
+
return;
|
|
181
|
+
}
|
|
182
|
+
subscribedToUpgradeRequests = true;
|
|
183
|
+
server.on("upgrade", handleUpgrade);
|
|
161
184
|
};
|
|
162
185
|
const router = Router__default["default"]();
|
|
163
186
|
router.use(express__default["default"].json());
|
|
@@ -178,16 +201,28 @@ const signalsPlugin = backendPluginApi.createBackendPlugin({
|
|
|
178
201
|
httpRouter: backendPluginApi.coreServices.httpRouter,
|
|
179
202
|
logger: backendPluginApi.coreServices.logger,
|
|
180
203
|
identity: backendPluginApi.coreServices.identity,
|
|
181
|
-
discovery: backendPluginApi.coreServices.discovery
|
|
182
|
-
|
|
183
|
-
|
|
204
|
+
discovery: backendPluginApi.coreServices.discovery,
|
|
205
|
+
userInfo: backendPluginApi.coreServices.userInfo,
|
|
206
|
+
auth: backendPluginApi.coreServices.auth,
|
|
207
|
+
events: pluginEventsNode.eventsServiceRef
|
|
184
208
|
},
|
|
185
|
-
async init({
|
|
209
|
+
async init({
|
|
210
|
+
httpRouter,
|
|
211
|
+
logger,
|
|
212
|
+
identity,
|
|
213
|
+
discovery,
|
|
214
|
+
userInfo,
|
|
215
|
+
auth,
|
|
216
|
+
events
|
|
217
|
+
}) {
|
|
186
218
|
httpRouter.use(
|
|
187
219
|
await createRouter({
|
|
188
220
|
logger,
|
|
189
221
|
identity,
|
|
190
|
-
discovery
|
|
222
|
+
discovery,
|
|
223
|
+
userInfo,
|
|
224
|
+
auth,
|
|
225
|
+
events
|
|
191
226
|
})
|
|
192
227
|
);
|
|
193
228
|
}
|
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 { EventBroker, EventParams } 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 { BackstageIdentityResponse } from '@backstage/plugin-auth-node';\nimport { LoggerService } 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 // TODO: Remove optional when events-backend can offer this service\n eventBroker?: EventBroker;\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 eventBroker?: EventBroker;\n private logger: LoggerService;\n\n static create(options: SignalManagerOptions) {\n return new SignalManager(options);\n }\n\n private constructor(options: SignalManagerOptions) {\n ({ eventBroker: this.eventBroker, logger: this.logger } = options);\n\n this.eventBroker?.subscribe({\n supportsEventTopics: () => ['signals'],\n onEvent: (params: EventParams<SignalPayload>) =>\n this.onEventBrokerEvent(params),\n });\n }\n\n addConnection(ws: WebSocket, identity?: BackstageIdentityResponse) {\n const id = uuid();\n\n const conn = {\n id,\n user: identity?.identity.userEntityRef ?? 'user:default/guest',\n ws,\n ownershipEntityRefs: identity?.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.info(\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(\n params: EventParams<SignalPayload>,\n ): Promise<void> {\n const { eventPayload } = params;\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 !== null) {\n users = Array.isArray(recipients) ? recipients : [recipients];\n }\n\n // Actual websocket message sending\n this.connections.forEach(conn => {\n if (!conn.subscriptions.has(channel)) {\n return;\n }\n // Sending to all users can be done with null\n if (\n recipients !== null &&\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 errorHandler,\n PluginEndpointDiscovery,\n} from '@backstage/backend-common';\nimport express, { NextFunction, Request, Response } from 'express';\nimport Router from 'express-promise-router';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport * as https from 'https';\nimport http, { IncomingMessage } from 'http';\nimport { SignalManager } from './SignalManager';\nimport {\n BackstageIdentityResponse,\n IdentityApi,\n IdentityApiGetIdentityRequest,\n} from '@backstage/plugin-auth-node';\nimport { EventBroker } from '@backstage/plugin-events-node';\nimport { WebSocket, WebSocketServer } from 'ws';\n\n/** @public */\nexport interface RouterOptions {\n logger: LoggerService;\n eventBroker?: EventBroker;\n identity: IdentityApi;\n discovery: PluginEndpointDiscovery;\n}\n\n/** @public */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { logger, identity, discovery } = options;\n const manager = SignalManager.create(options);\n let subscribedToUpgradeRequests = false;\n\n const webSocketServer = new WebSocketServer({\n noServer: true,\n clientTracking: false,\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 const apiUrl = await discovery.getBaseUrl('signals');\n server.on('upgrade', async (request, socket, head) => {\n if (!request.url || !apiUrl.endsWith(request.url)) {\n return;\n }\n\n let userIdentity: BackstageIdentityResponse | 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 const token = req.headers['sec-websocket-protocol'];\n if (token) {\n userIdentity = await identity.getIdentity({\n request: {\n headers: { authorization: token },\n },\n } as IdentityApiGetIdentityRequest);\n }\n\n webSocketServer.handleUpgrade(\n request,\n socket,\n head,\n (ws: WebSocket, __: IncomingMessage) => {\n manager.addConnection(ws, userIdentity);\n },\n );\n });\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';\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 // TODO: EventBroker. It is optional for now but it's actually required so waiting for the new backend system\n // for the events-backend for this to work.\n },\n async init({ httpRouter, logger, identity, discovery }) {\n httpRouter.use(\n await createRouter({\n logger,\n identity,\n discovery,\n }),\n );\n },\n });\n },\n});\n"],"names":["uuid","WebSocket","WebSocketServer","Router","express","errorHandler","createBackendPlugin","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AA4CO,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,aAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AAlDV,IAAA,IAAA,EAAA,CAAA;AAyDI,IAAA,CAAC,EAAE,WAAa,EAAA,IAAA,CAAK,aAAa,MAAQ,EAAA,IAAA,CAAK,QAAW,GAAA,OAAA,EAAA;AAE1D,IAAK,CAAA,EAAA,GAAA,IAAA,CAAA,WAAA,KAAL,mBAAkB,SAAU,CAAA;AAAA,MAC1B,mBAAA,EAAqB,MAAM,CAAC,SAAS,CAAA;AAAA,MACrC,OAAS,EAAA,CAAC,MACR,KAAA,IAAA,CAAK,mBAAmB,MAAM,CAAA;AAAA,KAClC,CAAA,CAAA;AAAA,GACF;AAAA,EAZA,OAAO,OAAO,OAA+B,EAAA;AAC3C,IAAO,OAAA,IAAI,cAAc,OAAO,CAAA,CAAA;AAAA,GAClC;AAAA,EAYA,aAAA,CAAc,IAAe,QAAsC,EAAA;AAlErE,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAmEI,IAAA,MAAM,KAAKA,OAAK,EAAA,CAAA;AAEhB,IAAA,MAAM,IAAO,GAAA;AAAA,MACX,EAAA;AAAA,MACA,IAAM,EAAA,CAAA,EAAA,GAAA,QAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,QAAA,CAAU,QAAS,CAAA,aAAA,KAAnB,IAAoC,GAAA,EAAA,GAAA,oBAAA;AAAA,MAC1C,EAAA;AAAA,MACA,mBAAqB,EAAA,CAAA,EAAA,GAAA,QAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,QAAA,CAAU,QAAS,CAAA,mBAAA,KAAnB,IAA0C,GAAA,EAAA,GAAA;AAAA,QAC7D,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,IAAA;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,mBACZ,MACe,EAAA;AACf,IAAM,MAAA,EAAE,cAAiB,GAAA,MAAA,CAAA;AACzB,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,IAAA,IAAI,eAAe,IAAM,EAAA;AACvB,MAAA,KAAA,GAAQ,MAAM,OAAQ,CAAA,UAAU,CAAI,GAAA,UAAA,GAAa,CAAC,UAAU,CAAA,CAAA;AAAA,KAC9D;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;AAEA,MAAA,IACE,UAAe,KAAA,IAAA,IACf,CAAC,IAAA,CAAK,mBAAoB,CAAA,IAAA,CAAK,CAAC,GAAA,KAAgB,KAAM,CAAA,QAAA,CAAS,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;;AC3HA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,QAAU,EAAA,SAAA,EAAc,GAAA,OAAA,CAAA;AACxC,EAAM,MAAA,OAAA,GAAU,aAAc,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAC5C,EAAA,IAAI,2BAA8B,GAAA,KAAA,CAAA;AAElC,EAAM,MAAA,eAAA,GAAkB,IAAIC,kBAAgB,CAAA;AAAA,IAC1C,QAAU,EAAA,IAAA;AAAA,IACV,cAAgB,EAAA,KAAA;AAAA,GACjB,CAAA,CAAA;AAED,EAAA,MAAM,iBAAoB,GAAA,OACxB,GACA,EAAA,CAAA,EACA,IACG,KAAA;AA1DP,IAAA,IAAA,EAAA,CAAA;AA2DI,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,IAAA,MAAM,MAAS,GAAA,MAAM,SAAU,CAAA,UAAA,CAAW,SAAS,CAAA,CAAA;AACnD,IAAA,MAAA,CAAO,EAAG,CAAA,SAAA,EAAW,OAAO,OAAA,EAAS,QAAQ,IAAS,KAAA;AACpD,MAAI,IAAA,CAAC,QAAQ,GAAO,IAAA,CAAC,OAAO,QAAS,CAAA,OAAA,CAAQ,GAAG,CAAG,EAAA;AACjD,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,IAAI,YAAsD,GAAA,KAAA,CAAA,CAAA;AAI1D,MAAM,MAAA,KAAA,GAAQ,GAAI,CAAA,OAAA,CAAQ,wBAAwB,CAAA,CAAA;AAClD,MAAA,IAAI,KAAO,EAAA;AACT,QAAe,YAAA,GAAA,MAAM,SAAS,WAAY,CAAA;AAAA,UACxC,OAAS,EAAA;AAAA,YACP,OAAA,EAAS,EAAE,aAAA,EAAe,KAAM,EAAA;AAAA,WAClC;AAAA,SACgC,CAAA,CAAA;AAAA,OACpC;AAEA,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,KACD,CAAA,CAAA;AAAA,GACH,CAAA;AAEA,EAAA,MAAM,SAASC,0BAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,2BAAQ,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;;ACvFO,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;AAAA;AAAA,OAG1B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,YAAY,MAAQ,EAAA,QAAA,EAAU,WAAa,EAAA;AACtD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,QAAA;AAAA,YACA,SAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;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 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 !== null) {\n users = Array.isArray(recipients) ? recipients : [recipients];\n }\n\n // Actual websocket message sending\n this.connections.forEach(conn => {\n if (!conn.subscriptions.has(channel)) {\n return;\n }\n // Sending to all users can be done with null\n if (\n recipients !== null &&\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 },\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,IAAA,IAAI,eAAe,IAAM,EAAA;AACvB,MAAA,KAAA,GAAQ,MAAM,OAAQ,CAAA,UAAU,CAAI,GAAA,UAAA,GAAa,CAAC,UAAU,CAAA,CAAA;AAAA,KAC9D;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;AAEA,MAAA,IACE,UAAe,KAAA,IAAA,IACf,CAAC,IAAA,CAAK,mBAAoB,CAAA,IAAA,CAAK,CAAC,GAAA,KAAgB,KAAM,CAAA,QAAA,CAAS,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;;ACrHA,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,0BAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,2BAAQ,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;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,16 +1,18 @@
|
|
|
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 } from '@backstage/backend-plugin-api';
|
|
4
|
+
import { LoggerService, AuthService, UserInfoService } from '@backstage/backend-plugin-api';
|
|
5
5
|
import { IdentityApi } from '@backstage/plugin-auth-node';
|
|
6
|
-
import {
|
|
6
|
+
import { EventsService } from '@backstage/plugin-events-node';
|
|
7
7
|
|
|
8
8
|
/** @public */
|
|
9
9
|
interface RouterOptions {
|
|
10
10
|
logger: LoggerService;
|
|
11
|
-
|
|
11
|
+
events: EventsService;
|
|
12
12
|
identity: IdentityApi;
|
|
13
13
|
discovery: PluginEndpointDiscovery;
|
|
14
|
+
auth?: AuthService;
|
|
15
|
+
userInfo?: UserInfoService;
|
|
14
16
|
}
|
|
15
17
|
/** @public */
|
|
16
18
|
declare function createRouter(options: RouterOptions): Promise<express.Router>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-signals-backend",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.1.0-next.2",
|
|
4
4
|
"main": "dist/index.cjs.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -27,25 +27,25 @@
|
|
|
27
27
|
"postpack": "backstage-cli package postpack"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@backstage/backend-common": "^0.21.
|
|
31
|
-
"@backstage/backend-plugin-api": "^0.6.
|
|
32
|
-
"@backstage/config": "^1.
|
|
33
|
-
"@backstage/plugin-auth-node": "^0.4.
|
|
34
|
-
"@backstage/plugin-events-node": "^0.2
|
|
35
|
-
"@backstage/plugin-signals-node": "^0.0.
|
|
30
|
+
"@backstage/backend-common": "^0.21.4-next.2",
|
|
31
|
+
"@backstage/backend-plugin-api": "^0.6.14-next.2",
|
|
32
|
+
"@backstage/config": "^1.2.0-next.1",
|
|
33
|
+
"@backstage/plugin-auth-node": "^0.4.9-next.2",
|
|
34
|
+
"@backstage/plugin-events-node": "^0.3.0-next.2",
|
|
35
|
+
"@backstage/plugin-signals-node": "^0.1.0-next.2",
|
|
36
36
|
"@backstage/types": "^1.1.1",
|
|
37
37
|
"@types/express": "*",
|
|
38
38
|
"express": "^4.17.1",
|
|
39
39
|
"express-promise-router": "^4.1.0",
|
|
40
40
|
"http-proxy-middleware": "^2.0.0",
|
|
41
41
|
"node-fetch": "^2.6.7",
|
|
42
|
-
"uuid": "^
|
|
42
|
+
"uuid": "^9.0.0",
|
|
43
43
|
"winston": "^3.2.1",
|
|
44
44
|
"ws": "^8.14.2",
|
|
45
45
|
"yn": "^4.0.0"
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
|
-
"@backstage/cli": "^0.25.2",
|
|
48
|
+
"@backstage/cli": "^0.25.3-next.2",
|
|
49
49
|
"@types/supertest": "^2.0.8",
|
|
50
50
|
"msw": "^1.0.0",
|
|
51
51
|
"supertest": "^6.2.4"
|