@backstage/plugin-signals-backend 0.1.9 → 0.2.0-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/dist/index.cjs.js +9 -7
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +13 -8
- package/package.json +12 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# @backstage/plugin-signals-backend
|
|
2
2
|
|
|
3
|
+
## 0.2.0-next.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- d425fc4: **BREAKING**: The return values from `createBackendPlugin`, `createBackendModule`, and `createServiceFactory` are now simply `BackendFeature` and `ServiceFactory`, instead of the previously deprecated form of a function that returns them. For this reason, `createServiceFactory` also no longer accepts the callback form where you provide direct options to the service. This also affects all `coreServices.*` service refs.
|
|
8
|
+
|
|
9
|
+
This may in particular affect tests; if you were effectively doing `createBackendModule({...})()` (note the parentheses), you can now remove those extra parentheses at the end. You may encounter cases of this in your `packages/backend/src/index.ts` too, where you add plugins, modules, and services. If you were using `createServiceFactory` with a function as its argument for the purpose of passing in options, this pattern has been deprecated for a while and is no longer supported. You may want to explore the new multiton patterns to achieve your goals, or moving settings to app-config.
|
|
10
|
+
|
|
11
|
+
As part of this change, the `IdentityFactoryOptions` type was removed, and can no longer be used to tweak that service. The identity service was also deprecated some time ago, and you will want to [migrate to the new auth system](https://backstage.io/docs/tutorials/auth-service-migration) if you still rely on it.
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- 3ec5ccb: The `createRouter` and its related types has been marked as deprecared. This backend should instead be initialized using the new backend system.
|
|
16
|
+
- 19ff127: Internal refactor to remove dependencies on the identity and token manager services, which have been removed. Public APIs no longer require the identity service or token manager to be provided.
|
|
17
|
+
- Updated dependencies
|
|
18
|
+
- @backstage/backend-plugin-api@0.9.0-next.0
|
|
19
|
+
- @backstage/backend-common@0.25.0-next.0
|
|
20
|
+
- @backstage/plugin-events-node@0.4.0-next.0
|
|
21
|
+
- @backstage/plugin-auth-node@0.5.2-next.0
|
|
22
|
+
- @backstage/plugin-signals-node@0.1.11-next.0
|
|
23
|
+
- @backstage/config@1.2.0
|
|
24
|
+
- @backstage/types@1.1.1
|
|
25
|
+
|
|
3
26
|
## 0.1.9
|
|
4
27
|
|
|
5
28
|
### Patch Changes
|
package/dist/index.cjs.js
CHANGED
|
@@ -147,9 +147,8 @@ class SignalManager {
|
|
|
147
147
|
}
|
|
148
148
|
}
|
|
149
149
|
|
|
150
|
-
async function createRouter(options) {
|
|
151
|
-
const { logger, discovery } = options;
|
|
152
|
-
const { auth, userInfo } = backendCommon.createLegacyAuthAdapters(options);
|
|
150
|
+
async function createRouter$1(options) {
|
|
151
|
+
const { logger, discovery, auth, userInfo } = options;
|
|
153
152
|
const manager = SignalManager.create(options);
|
|
154
153
|
let subscribedToUpgradeRequests = false;
|
|
155
154
|
let apiUrl = void 0;
|
|
@@ -218,10 +217,16 @@ async function createRouter(options) {
|
|
|
218
217
|
router.get("/health", (_, response) => {
|
|
219
218
|
response.json({ status: "ok" });
|
|
220
219
|
});
|
|
221
|
-
router.use(backendCommon.errorHandler());
|
|
222
220
|
return router;
|
|
223
221
|
}
|
|
224
222
|
|
|
223
|
+
async function createRouter(options) {
|
|
224
|
+
return createRouter$1({
|
|
225
|
+
...options,
|
|
226
|
+
...backendCommon.createLegacyAuthAdapters(options)
|
|
227
|
+
});
|
|
228
|
+
}
|
|
229
|
+
|
|
225
230
|
const signalsPlugin = backendPluginApi.createBackendPlugin({
|
|
226
231
|
pluginId: "signals",
|
|
227
232
|
register(env) {
|
|
@@ -231,7 +236,6 @@ const signalsPlugin = backendPluginApi.createBackendPlugin({
|
|
|
231
236
|
logger: backendPluginApi.coreServices.logger,
|
|
232
237
|
config: backendPluginApi.coreServices.rootConfig,
|
|
233
238
|
lifecycle: backendPluginApi.coreServices.rootLifecycle,
|
|
234
|
-
identity: backendPluginApi.coreServices.identity,
|
|
235
239
|
discovery: backendPluginApi.coreServices.discovery,
|
|
236
240
|
userInfo: backendPluginApi.coreServices.userInfo,
|
|
237
241
|
auth: backendPluginApi.coreServices.auth,
|
|
@@ -242,7 +246,6 @@ const signalsPlugin = backendPluginApi.createBackendPlugin({
|
|
|
242
246
|
logger,
|
|
243
247
|
config,
|
|
244
248
|
lifecycle,
|
|
245
|
-
identity,
|
|
246
249
|
discovery,
|
|
247
250
|
userInfo,
|
|
248
251
|
auth,
|
|
@@ -252,7 +255,6 @@ const signalsPlugin = backendPluginApi.createBackendPlugin({
|
|
|
252
255
|
await createRouter({
|
|
253
256
|
logger,
|
|
254
257
|
config,
|
|
255
|
-
identity,
|
|
256
258
|
lifecycle,
|
|
257
259
|
discovery,
|
|
258
260
|
userInfo,
|
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 LifecycleService,\n LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\n\n/**\n * @internal\n */\nexport type SignalConnection = {\n id: string;\n user: string;\n ws: WebSocket;\n ownershipEntityRefs: string[];\n subscriptions: Set<string>;\n isAlive: boolean;\n};\n\n/**\n * @internal\n */\nexport type SignalManagerOptions = {\n events: EventsService;\n config: Config;\n logger: LoggerService;\n lifecycle?: LifecycleService;\n};\n\n/** @internal */\nexport class SignalManager {\n private connections: Map<string, SignalConnection> = new Map<\n string,\n SignalConnection\n >();\n private events: EventsService;\n private logger: LoggerService;\n private pingInterval: ReturnType<typeof setInterval> | undefined;\n\n static create(options: SignalManagerOptions) {\n return new SignalManager(options);\n }\n\n private constructor(options: SignalManagerOptions) {\n ({ events: this.events, logger: this.logger } = options);\n\n this.events.subscribe({\n id: 'signals',\n topics: ['signals'],\n onEvent: (params: EventParams) =>\n this.onEventBrokerEvent(params.eventPayload as SignalPayload),\n });\n\n options.lifecycle?.addShutdownHook(() => this.onShutdown());\n }\n\n private ping() {\n this.connections.forEach(conn => {\n if (!conn.isAlive) {\n this.logger.debug(`Connection ${conn.id} is not alive, terminating`);\n conn.ws.terminate();\n return;\n }\n\n conn.isAlive = false;\n conn.ws.ping();\n });\n }\n\n private onShutdown() {\n if (this.pingInterval) {\n clearInterval(this.pingInterval);\n }\n\n // TODO: Unsubscribe from events?\n\n this.connections.forEach(conn => {\n conn.ws.terminate();\n });\n this.connections.clear();\n }\n\n addConnection(ws: WebSocket, identity?: BackstageUserInfo) {\n // Start pinging on first connection\n if (!this.pingInterval) {\n this.pingInterval = setInterval(() => this.ping(), 30000);\n }\n\n const id = uuid();\n const conn = {\n id,\n user: identity?.userEntityRef ?? 'user:default/guest',\n ws,\n ownershipEntityRefs: identity?.ownershipEntityRefs ?? [\n 'user:default/guest',\n ],\n subscriptions: new Set<string>(),\n isAlive: true,\n };\n\n this.connections.set(id, conn);\n\n this.logger.debug(`Connection ${id} connected`);\n ws.on('error', (err: Error) => {\n this.logger.error(\n `Error occurred with connection ${id}: ${err}, closing connection`,\n );\n ws.terminate();\n this.connections.delete(id);\n });\n\n ws.on('close', (code: number, reason: Buffer) => {\n this.logger.debug(\n `Connection ${id} closed with code ${code}, reason: ${reason}`,\n );\n ws.terminate();\n this.connections.delete(id);\n });\n\n ws.on('ping', () => {\n conn.isAlive = true;\n ws.pong();\n });\n\n ws.on('pong', () => {\n conn.isAlive = true;\n });\n\n ws.on('message', (data: RawData, isBinary: boolean) => {\n this.logger.debug(`Received message from connection ${id}: ${data}`);\n if (isBinary) {\n return;\n }\n try {\n const json = JSON.parse(data.toString()) as JsonObject;\n this.handleMessage(conn, json);\n } catch (err: any) {\n this.logger.error(\n `Invalid message received from connection ${id}: ${err}`,\n );\n }\n });\n }\n\n private handleMessage(connection: SignalConnection, message: JsonObject) {\n if (message.action === 'subscribe' && message.channel) {\n this.logger.debug(\n `Connection ${connection.id} subscribed to ${message.channel}`,\n );\n connection.subscriptions.add(message.channel as string);\n } else if (message.action === 'unsubscribe' && message.channel) {\n this.logger.debug(\n `Connection ${connection.id} unsubscribed from ${message.channel}`,\n );\n connection.subscriptions.delete(message.channel as string);\n }\n }\n\n private async onEventBrokerEvent(eventPayload: SignalPayload): Promise<void> {\n if (!eventPayload.channel || !eventPayload.message) {\n return;\n }\n\n const { channel, recipients, message } = eventPayload;\n const jsonMessage = JSON.stringify({ channel, message });\n let users: string[] = [];\n if (recipients.type === 'user') {\n users = Array.isArray(recipients.entityRef)\n ? recipients.entityRef\n : [recipients.entityRef];\n }\n\n // Actual websocket message sending\n this.connections.forEach(conn => {\n if (!conn.subscriptions.has(channel)) {\n return;\n }\n\n // Sending to all users can be done with broadcast\n if (\n recipients.type !== 'broadcast' &&\n !conn.ownershipEntityRefs.some((ref: string) => users.includes(ref))\n ) {\n return;\n }\n\n if (conn.ws.readyState !== WebSocket.OPEN) {\n return;\n }\n\n conn.ws.send(jsonMessage, err => {\n if (err) {\n this.logger.error(`Failed to send message to ${conn.id}: ${err}`);\n }\n });\n });\n }\n}\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n createLegacyAuthAdapters,\n errorHandler,\n PluginEndpointDiscovery,\n} from '@backstage/backend-common';\nimport express, { NextFunction, Request, Response } from 'express';\nimport Router from 'express-promise-router';\nimport {\n AuthService,\n BackstageUserInfo,\n LifecycleService,\n LoggerService,\n UserInfoService,\n} from '@backstage/backend-plugin-api';\nimport * as https from 'https';\nimport http, { IncomingMessage } from 'http';\nimport { SignalManager } from './SignalManager';\nimport { IdentityApi } from '@backstage/plugin-auth-node';\nimport { EventsService } from '@backstage/plugin-events-node';\nimport { WebSocket, WebSocketServer } from 'ws';\nimport { Duplex } from 'stream';\nimport { Config } from '@backstage/config';\n\n/** @public */\nexport interface RouterOptions {\n logger: LoggerService;\n events: EventsService;\n identity: IdentityApi;\n discovery: PluginEndpointDiscovery;\n config: Config;\n lifecycle?: LifecycleService;\n auth?: AuthService;\n userInfo?: UserInfoService;\n}\n\n/** @public */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { logger, discovery } = options;\n const { auth, userInfo } = createLegacyAuthAdapters(options);\n\n const manager = SignalManager.create(options);\n let subscribedToUpgradeRequests = false;\n let apiUrl: string | undefined = undefined;\n\n const webSocketServer = new WebSocketServer({\n noServer: true, // handle upgrade manually\n clientTracking: false, // handle connections in SignalManager\n });\n\n webSocketServer.on('error', (error: Error) => {\n logger.error(`WebSocket server error: ${error}`);\n });\n\n const handleUpgrade = async (\n request: Request<any, any, any, any, any>,\n socket: Duplex,\n head: Buffer,\n ) => {\n if (!apiUrl) {\n apiUrl = await discovery.getBaseUrl('signals');\n }\n\n if (!request.url || !apiUrl || !apiUrl.endsWith(request.url)) {\n return;\n }\n\n let userIdentity: BackstageUserInfo | undefined = undefined;\n\n // Authentication token is passed in Sec-WebSocket-Protocol header as there\n // is no other way to pass the token with plain websockets\n try {\n const token = request.headers['sec-websocket-protocol'];\n if (token) {\n const credentials = await auth.authenticate(token);\n if (auth.isPrincipal(credentials, 'user')) {\n userIdentity = await userInfo.getUserInfo(credentials);\n }\n }\n } catch (e) {\n logger.error(`Failed to authenticate WebSocket connection: ${e}`);\n socket.write(\n 'HTTP/1.1 401 Web Socket Protocol Handshake\\r\\n' +\n 'Upgrade: WebSocket\\r\\n' +\n 'Connection: Upgrade\\r\\n' +\n '\\r\\n',\n );\n socket.destroy();\n return;\n }\n\n try {\n webSocketServer.handleUpgrade(\n request,\n socket,\n head,\n (ws: WebSocket, __: IncomingMessage) => {\n manager.addConnection(ws, userIdentity);\n },\n );\n } catch (e) {\n logger.error(`Failed to handle WebSocket upgrade: ${e}`);\n socket.write(\n 'HTTP/1.1 500 Web Socket Protocol Handshake\\r\\n' +\n 'Upgrade: WebSocket\\r\\n' +\n 'Connection: Upgrade\\r\\n' +\n '\\r\\n',\n );\n socket.destroy();\n }\n };\n\n const upgradeMiddleware = async (\n req: Request,\n _: Response,\n next: NextFunction,\n ) => {\n const server: https.Server | http.Server = (req.socket as any)?.server;\n if (\n subscribedToUpgradeRequests ||\n !server ||\n !req.headers ||\n req.headers.upgrade === undefined ||\n req.headers.upgrade.toLowerCase() !== 'websocket'\n ) {\n next();\n return;\n }\n\n subscribedToUpgradeRequests = true;\n server.on('upgrade', handleUpgrade);\n };\n\n const router = Router();\n router.use(express.json());\n router.use(upgradeMiddleware);\n\n router.get('/health', (_, response) => {\n response.json({ status: 'ok' });\n });\n\n router.use(errorHandler());\n return router;\n}\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\n\n/**\n * Signals backend plugin\n *\n * @public\n */\nexport const signalsPlugin = createBackendPlugin({\n pluginId: 'signals',\n register(env) {\n env.registerInit({\n deps: {\n httpRouter: coreServices.httpRouter,\n logger: coreServices.logger,\n config: coreServices.rootConfig,\n lifecycle: coreServices.rootLifecycle,\n identity: coreServices.identity,\n discovery: coreServices.discovery,\n userInfo: coreServices.userInfo,\n auth: coreServices.auth,\n events: eventsServiceRef,\n },\n async init({\n httpRouter,\n logger,\n config,\n lifecycle,\n identity,\n discovery,\n userInfo,\n auth,\n events,\n }) {\n httpRouter.use(\n await createRouter({\n logger,\n config,\n identity,\n lifecycle,\n discovery,\n userInfo,\n auth,\n events,\n }),\n );\n httpRouter.addAuthPolicy({\n path: '/',\n allow: 'unauthenticated',\n });\n },\n });\n },\n});\n"],"names":["uuid","WebSocket","createLegacyAuthAdapters","WebSocketServer","Router","express","errorHandler","createBackendPlugin","coreServices","eventsServiceRef"],"mappings":";;;;;;;;;;;;;;;;;AAkDO,MAAM,aAAc,CAAA;AAAA,EACjB,WAAA,uBAAiD,GAGvD,EAAA,CAAA;AAAA,EACM,MAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EAER,OAAO,OAAO,OAA+B,EAAA;AAC3C,IAAO,OAAA,IAAI,cAAc,OAAO,CAAA,CAAA;AAAA,GAClC;AAAA,EAEQ,YAAY,OAA+B,EAAA;AACjD,IAAA,CAAC,EAAE,MAAQ,EAAA,IAAA,CAAK,QAAQ,MAAQ,EAAA,IAAA,CAAK,QAAW,GAAA,OAAA,EAAA;AAEhD,IAAA,IAAA,CAAK,OAAO,SAAU,CAAA;AAAA,MACpB,EAAI,EAAA,SAAA;AAAA,MACJ,MAAA,EAAQ,CAAC,SAAS,CAAA;AAAA,MAClB,SAAS,CAAC,MAAA,KACR,IAAK,CAAA,kBAAA,CAAmB,OAAO,YAA6B,CAAA;AAAA,KAC/D,CAAA,CAAA;AAED,IAAA,OAAA,CAAQ,SAAW,EAAA,eAAA,CAAgB,MAAM,IAAA,CAAK,YAAY,CAAA,CAAA;AAAA,GAC5D;AAAA,EAEQ,IAAO,GAAA;AACb,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAI,IAAA,CAAC,KAAK,OAAS,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAc,WAAA,EAAA,IAAA,CAAK,EAAE,CAA4B,0BAAA,CAAA,CAAA,CAAA;AACnE,QAAA,IAAA,CAAK,GAAG,SAAU,EAAA,CAAA;AAClB,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,IAAA,CAAK,OAAU,GAAA,KAAA,CAAA;AACf,MAAA,IAAA,CAAK,GAAG,IAAK,EAAA,CAAA;AAAA,KACd,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,UAAa,GAAA;AACnB,IAAA,IAAI,KAAK,YAAc,EAAA;AACrB,MAAA,aAAA,CAAc,KAAK,YAAY,CAAA,CAAA;AAAA,KACjC;AAIA,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAA,IAAA,CAAK,GAAG,SAAU,EAAA,CAAA;AAAA,KACnB,CAAA,CAAA;AACD,IAAA,IAAA,CAAK,YAAY,KAAM,EAAA,CAAA;AAAA,GACzB;AAAA,EAEA,aAAA,CAAc,IAAe,QAA8B,EAAA;AAEzD,IAAI,IAAA,CAAC,KAAK,YAAc,EAAA;AACtB,MAAA,IAAA,CAAK,eAAe,WAAY,CAAA,MAAM,IAAK,CAAA,IAAA,IAAQ,GAAK,CAAA,CAAA;AAAA,KAC1D;AAEA,IAAA,MAAM,KAAKA,OAAK,EAAA,CAAA;AAChB,IAAA,MAAM,IAAO,GAAA;AAAA,MACX,EAAA;AAAA,MACA,IAAA,EAAM,UAAU,aAAiB,IAAA,oBAAA;AAAA,MACjC,EAAA;AAAA,MACA,mBAAA,EAAqB,UAAU,mBAAuB,IAAA;AAAA,QACpD,oBAAA;AAAA,OACF;AAAA,MACA,aAAA,sBAAmB,GAAY,EAAA;AAAA,MAC/B,OAAS,EAAA,IAAA;AAAA,KACX,CAAA;AAEA,IAAK,IAAA,CAAA,WAAA,CAAY,GAAI,CAAA,EAAA,EAAI,IAAI,CAAA,CAAA;AAE7B,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAc,WAAA,EAAA,EAAE,CAAY,UAAA,CAAA,CAAA,CAAA;AAC9C,IAAG,EAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,GAAe,KAAA;AAC7B,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,+BAAA,EAAkC,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA,oBAAA,CAAA;AAAA,OAC9C,CAAA;AACA,MAAA,EAAA,CAAG,SAAU,EAAA,CAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAAA,KAC3B,CAAA,CAAA;AAED,IAAA,EAAA,CAAG,EAAG,CAAA,OAAA,EAAS,CAAC,IAAA,EAAc,MAAmB,KAAA;AAC/C,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,EAAE,CAAqB,kBAAA,EAAA,IAAI,aAAa,MAAM,CAAA,CAAA;AAAA,OAC9D,CAAA;AACA,MAAA,EAAA,CAAG,SAAU,EAAA,CAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAAA,KAC3B,CAAA,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA,CAAA;AACf,MAAA,EAAA,CAAG,IAAK,EAAA,CAAA;AAAA,KACT,CAAA,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA,CAAA;AAAA,KAChB,CAAA,CAAA;AAED,IAAA,EAAA,CAAG,EAAG,CAAA,SAAA,EAAW,CAAC,IAAA,EAAe,QAAsB,KAAA;AACrD,MAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,iCAAA,EAAoC,EAAE,CAAA,EAAA,EAAK,IAAI,CAAE,CAAA,CAAA,CAAA;AACnE,MAAA,IAAI,QAAU,EAAA;AACZ,QAAA,OAAA;AAAA,OACF;AACA,MAAI,IAAA;AACF,QAAA,MAAM,IAAO,GAAA,IAAA,CAAK,KAAM,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AACvC,QAAK,IAAA,CAAA,aAAA,CAAc,MAAM,IAAI,CAAA,CAAA;AAAA,eACtB,GAAU,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,yCAAA,EAA4C,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA,CAAA;AAAA,SACxD,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,aAAA,CAAc,YAA8B,OAAqB,EAAA;AACvE,IAAA,IAAI,OAAQ,CAAA,MAAA,KAAW,WAAe,IAAA,OAAA,CAAQ,OAAS,EAAA;AACrD,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,UAAA,CAAW,EAAE,CAAA,eAAA,EAAkB,QAAQ,OAAO,CAAA,CAAA;AAAA,OAC9D,CAAA;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,GAAI,CAAA,OAAA,CAAQ,OAAiB,CAAA,CAAA;AAAA,KAC7C,MAAA,IAAA,OAAA,CAAQ,MAAW,KAAA,aAAA,IAAiB,QAAQ,OAAS,EAAA;AAC9D,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,UAAA,CAAW,EAAE,CAAA,mBAAA,EAAsB,QAAQ,OAAO,CAAA,CAAA;AAAA,OAClE,CAAA;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,MAAO,CAAA,OAAA,CAAQ,OAAiB,CAAA,CAAA;AAAA,KAC3D;AAAA,GACF;AAAA,EAEA,MAAc,mBAAmB,YAA4C,EAAA;AAC3E,IAAA,IAAI,CAAC,YAAA,CAAa,OAAW,IAAA,CAAC,aAAa,OAAS,EAAA;AAClD,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,MAAM,EAAE,OAAA,EAAS,UAAY,EAAA,OAAA,EAAY,GAAA,YAAA,CAAA;AACzC,IAAA,MAAM,cAAc,IAAK,CAAA,SAAA,CAAU,EAAE,OAAA,EAAS,SAAS,CAAA,CAAA;AACvD,IAAA,IAAI,QAAkB,EAAC,CAAA;AACvB,IAAI,IAAA,UAAA,CAAW,SAAS,MAAQ,EAAA;AAC9B,MAAQ,KAAA,GAAA,KAAA,CAAM,QAAQ,UAAW,CAAA,SAAS,IACtC,UAAW,CAAA,SAAA,GACX,CAAC,UAAA,CAAW,SAAS,CAAA,CAAA;AAAA,KAC3B;AAGA,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAA,IAAI,CAAC,IAAA,CAAK,aAAc,CAAA,GAAA,CAAI,OAAO,CAAG,EAAA;AACpC,QAAA,OAAA;AAAA,OACF;AAGA,MAAA,IACE,UAAW,CAAA,IAAA,KAAS,WACpB,IAAA,CAAC,IAAK,CAAA,mBAAA,CAAoB,IAAK,CAAA,CAAC,GAAgB,KAAA,KAAA,CAAM,QAAS,CAAA,GAAG,CAAC,CACnE,EAAA;AACA,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,IAAI,IAAK,CAAA,EAAA,CAAG,UAAe,KAAAC,YAAA,CAAU,IAAM,EAAA;AACzC,QAAA,OAAA;AAAA,OACF;AAEA,MAAK,IAAA,CAAA,EAAA,CAAG,IAAK,CAAA,WAAA,EAAa,CAAO,GAAA,KAAA;AAC/B,QAAA,IAAI,GAAK,EAAA;AACP,UAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,0BAAA,EAA6B,KAAK,EAAE,CAAA,EAAA,EAAK,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,SAClE;AAAA,OACD,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;ACtKA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAM,MAAA,EAAE,MAAQ,EAAA,SAAA,EAAc,GAAA,OAAA,CAAA;AAC9B,EAAA,MAAM,EAAE,IAAA,EAAM,QAAS,EAAA,GAAIC,uCAAyB,OAAO,CAAA,CAAA;AAE3D,EAAM,MAAA,OAAA,GAAU,aAAc,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAC5C,EAAA,IAAI,2BAA8B,GAAA,KAAA,CAAA;AAClC,EAAA,IAAI,MAA6B,GAAA,KAAA,CAAA,CAAA;AAEjC,EAAM,MAAA,eAAA,GAAkB,IAAIC,kBAAgB,CAAA;AAAA,IAC1C,QAAU,EAAA,IAAA;AAAA;AAAA,IACV,cAAgB,EAAA,KAAA;AAAA;AAAA,GACjB,CAAA,CAAA;AAED,EAAgB,eAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,KAAiB,KAAA;AAC5C,IAAO,MAAA,CAAA,KAAA,CAAM,CAA2B,wBAAA,EAAA,KAAK,CAAE,CAAA,CAAA,CAAA;AAAA,GAChD,CAAA,CAAA;AAED,EAAA,MAAM,aAAgB,GAAA,OACpB,OACA,EAAA,MAAA,EACA,IACG,KAAA;AACH,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAS,MAAA,GAAA,MAAM,SAAU,CAAA,UAAA,CAAW,SAAS,CAAA,CAAA;AAAA,KAC/C;AAEA,IAAI,IAAA,CAAC,OAAQ,CAAA,GAAA,IAAO,CAAC,MAAA,IAAU,CAAC,MAAO,CAAA,QAAA,CAAS,OAAQ,CAAA,GAAG,CAAG,EAAA;AAC5D,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,IAAI,YAA8C,GAAA,KAAA,CAAA,CAAA;AAIlD,IAAI,IAAA;AACF,MAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,OAAA,CAAQ,wBAAwB,CAAA,CAAA;AACtD,MAAA,IAAI,KAAO,EAAA;AACT,QAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,KAAK,CAAA,CAAA;AACjD,QAAA,IAAI,IAAK,CAAA,WAAA,CAAY,WAAa,EAAA,MAAM,CAAG,EAAA;AACzC,UAAe,YAAA,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,WAAW,CAAA,CAAA;AAAA,SACvD;AAAA,OACF;AAAA,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAgD,6CAAA,EAAA,CAAC,CAAE,CAAA,CAAA,CAAA;AAChE,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,iGAAA;AAAA,OAIF,CAAA;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA,CAAA;AACf,MAAA,OAAA;AAAA,KACF;AAEA,IAAI,IAAA;AACF,MAAgB,eAAA,CAAA,aAAA;AAAA,QACd,OAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,CAAC,IAAe,EAAwB,KAAA;AACtC,UAAQ,OAAA,CAAA,aAAA,CAAc,IAAI,YAAY,CAAA,CAAA;AAAA,SACxC;AAAA,OACF,CAAA;AAAA,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAuC,oCAAA,EAAA,CAAC,CAAE,CAAA,CAAA,CAAA;AACvD,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,iGAAA;AAAA,OAIF,CAAA;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA,CAAA;AAAA,KACjB;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,iBAAoB,GAAA,OACxB,GACA,EAAA,CAAA,EACA,IACG,KAAA;AACH,IAAM,MAAA,MAAA,GAAsC,IAAI,MAAgB,EAAA,MAAA,CAAA;AAChE,IAAA,IACE,2BACA,IAAA,CAAC,MACD,IAAA,CAAC,IAAI,OACL,IAAA,GAAA,CAAI,OAAQ,CAAA,OAAA,KAAY,UACxB,GAAI,CAAA,OAAA,CAAQ,OAAQ,CAAA,WAAA,OAAkB,WACtC,EAAA;AACA,MAAK,IAAA,EAAA,CAAA;AACL,MAAA,OAAA;AAAA,KACF;AAEA,IAA8B,2BAAA,GAAA,IAAA,CAAA;AAC9B,IAAO,MAAA,CAAA,EAAA,CAAG,WAAW,aAAa,CAAA,CAAA;AAAA,GACpC,CAAA;AAEA,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,iBAAiB,CAAA,CAAA;AAE5B,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,CAAA,EAAG,QAAa,KAAA;AACrC,IAAA,QAAA,CAAS,IAAK,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAM,CAAA,CAAA;AAAA,GAC/B,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,EAAO,OAAA,MAAA,CAAA;AACT;;ACpIO,MAAM,gBAAgBC,oCAAoB,CAAA;AAAA,EAC/C,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,YAAYC,6BAAa,CAAA,UAAA;AAAA,QACzB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,aAAA;AAAA,QACxB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,MAAQ,EAAAC,iCAAA;AAAA,OACV;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,UAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA;AAAA,QACA,MAAA;AAAA,OACC,EAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,YACA,QAAA;AAAA,YACA,SAAA;AAAA,YACA,SAAA;AAAA,YACA,QAAA;AAAA,YACA,IAAA;AAAA,YACA,MAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AACA,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,IAAM,EAAA,GAAA;AAAA,UACN,KAAO,EAAA,iBAAA;AAAA,SACR,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/service/SignalManager.ts","../src/service/router.ts","../src/deprecated.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 express, { NextFunction, Request, Response } from 'express';\nimport Router from 'express-promise-router';\nimport {\n AuthService,\n BackstageUserInfo,\n DiscoveryService,\n LifecycleService,\n LoggerService,\n UserInfoService,\n} from '@backstage/backend-plugin-api';\nimport * as https from 'https';\nimport http, { IncomingMessage } from 'http';\nimport { SignalManager } from './SignalManager';\nimport { EventsService } from '@backstage/plugin-events-node';\nimport { WebSocket, WebSocketServer } from 'ws';\nimport { Duplex } from 'stream';\nimport { Config } from '@backstage/config';\n\nexport interface RouterOptions {\n logger: LoggerService;\n events: EventsService;\n discovery: DiscoveryService;\n config: Config;\n lifecycle?: LifecycleService;\n userInfo: UserInfoService;\n auth: AuthService;\n}\n\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { logger, discovery, auth, userInfo } = options;\n\n const manager = SignalManager.create(options);\n let subscribedToUpgradeRequests = false;\n let apiUrl: string | undefined = undefined;\n\n const webSocketServer = new WebSocketServer({\n noServer: true, // handle upgrade manually\n clientTracking: false, // handle connections in SignalManager\n });\n\n webSocketServer.on('error', (error: Error) => {\n logger.error(`WebSocket server error: ${error}`);\n });\n\n const handleUpgrade = async (\n request: Request<any, any, any, any, any>,\n socket: Duplex,\n head: Buffer,\n ) => {\n if (!apiUrl) {\n apiUrl = await discovery.getBaseUrl('signals');\n }\n\n if (!request.url || !apiUrl || !apiUrl.endsWith(request.url)) {\n return;\n }\n\n let userIdentity: BackstageUserInfo | undefined = undefined;\n\n // Authentication token is passed in Sec-WebSocket-Protocol header as there\n // is no other way to pass the token with plain websockets\n try {\n const token = request.headers['sec-websocket-protocol'];\n if (token) {\n const credentials = await auth.authenticate(token);\n if (auth.isPrincipal(credentials, 'user')) {\n userIdentity = await userInfo.getUserInfo(credentials);\n }\n }\n } catch (e) {\n logger.error(`Failed to authenticate WebSocket connection: ${e}`);\n socket.write(\n 'HTTP/1.1 401 Web Socket Protocol Handshake\\r\\n' +\n 'Upgrade: WebSocket\\r\\n' +\n 'Connection: Upgrade\\r\\n' +\n '\\r\\n',\n );\n socket.destroy();\n return;\n }\n\n try {\n webSocketServer.handleUpgrade(\n request,\n socket,\n head,\n (ws: WebSocket, __: IncomingMessage) => {\n manager.addConnection(ws, userIdentity);\n },\n );\n } catch (e) {\n logger.error(`Failed to handle WebSocket upgrade: ${e}`);\n socket.write(\n 'HTTP/1.1 500 Web Socket Protocol Handshake\\r\\n' +\n 'Upgrade: WebSocket\\r\\n' +\n 'Connection: Upgrade\\r\\n' +\n '\\r\\n',\n );\n socket.destroy();\n }\n };\n\n const upgradeMiddleware = async (\n req: Request,\n _: Response,\n next: NextFunction,\n ) => {\n const server: https.Server | http.Server = (req.socket as any)?.server;\n if (\n subscribedToUpgradeRequests ||\n !server ||\n !req.headers ||\n req.headers.upgrade === undefined ||\n req.headers.upgrade.toLowerCase() !== 'websocket'\n ) {\n next();\n return;\n }\n\n subscribedToUpgradeRequests = true;\n server.on('upgrade', handleUpgrade);\n };\n\n const router = Router();\n router.use(express.json());\n router.use(upgradeMiddleware);\n\n router.get('/health', (_, response) => {\n response.json({ status: 'ok' });\n });\n\n return router;\n}\n","/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport express from 'express';\n\nimport { Config } from '@backstage/config';\nimport {\n AuthService,\n DiscoveryService,\n LifecycleService,\n LoggerService,\n UserInfoService,\n} from '@backstage/backend-plugin-api';\nimport { createLegacyAuthAdapters } from '@backstage/backend-common';\n\nimport { IdentityApi } from '@backstage/plugin-auth-node';\nimport { EventsService } from '@backstage/plugin-events-node';\n\nimport { createRouter as _createRouter } from './service/router';\n\n/**\n * @public\n * @deprecated Please migrate to the new backend system as this will be removed in the future.\n */\nexport interface RouterOptions {\n logger: LoggerService;\n events: EventsService;\n identity?: IdentityApi;\n discovery: DiscoveryService;\n config: Config;\n lifecycle?: LifecycleService;\n auth?: AuthService;\n userInfo?: UserInfoService;\n}\n\n/**\n * @public\n * @deprecated Please migrate to the new backend system as this will be removed in the future.\n */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n return _createRouter({\n ...options,\n ...createLegacyAuthAdapters(options),\n });\n}\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './deprecated';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\n\n/**\n * Signals backend plugin\n *\n * @public\n */\nexport const signalsPlugin = createBackendPlugin({\n pluginId: 'signals',\n register(env) {\n env.registerInit({\n deps: {\n httpRouter: coreServices.httpRouter,\n logger: coreServices.logger,\n config: coreServices.rootConfig,\n lifecycle: coreServices.rootLifecycle,\n discovery: coreServices.discovery,\n userInfo: coreServices.userInfo,\n auth: coreServices.auth,\n events: eventsServiceRef,\n },\n async init({\n httpRouter,\n logger,\n config,\n lifecycle,\n discovery,\n userInfo,\n auth,\n events,\n }) {\n httpRouter.use(\n await createRouter({\n logger,\n config,\n lifecycle,\n discovery,\n userInfo,\n auth,\n events,\n }),\n );\n httpRouter.addAuthPolicy({\n path: '/',\n allow: 'unauthenticated',\n });\n },\n });\n },\n});\n"],"names":["uuid","WebSocket","createRouter","WebSocketServer","Router","express","_createRouter","createLegacyAuthAdapters","createBackendPlugin","coreServices","eventsServiceRef"],"mappings":";;;;;;;;;;;;;;;;;AAkDO,MAAM,aAAc,CAAA;AAAA,EACjB,WAAA,uBAAiD,GAGvD,EAAA,CAAA;AAAA,EACM,MAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EAER,OAAO,OAAO,OAA+B,EAAA;AAC3C,IAAO,OAAA,IAAI,cAAc,OAAO,CAAA,CAAA;AAAA,GAClC;AAAA,EAEQ,YAAY,OAA+B,EAAA;AACjD,IAAA,CAAC,EAAE,MAAQ,EAAA,IAAA,CAAK,QAAQ,MAAQ,EAAA,IAAA,CAAK,QAAW,GAAA,OAAA,EAAA;AAEhD,IAAA,IAAA,CAAK,OAAO,SAAU,CAAA;AAAA,MACpB,EAAI,EAAA,SAAA;AAAA,MACJ,MAAA,EAAQ,CAAC,SAAS,CAAA;AAAA,MAClB,SAAS,CAAC,MAAA,KACR,IAAK,CAAA,kBAAA,CAAmB,OAAO,YAA6B,CAAA;AAAA,KAC/D,CAAA,CAAA;AAED,IAAA,OAAA,CAAQ,SAAW,EAAA,eAAA,CAAgB,MAAM,IAAA,CAAK,YAAY,CAAA,CAAA;AAAA,GAC5D;AAAA,EAEQ,IAAO,GAAA;AACb,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAI,IAAA,CAAC,KAAK,OAAS,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAc,WAAA,EAAA,IAAA,CAAK,EAAE,CAA4B,0BAAA,CAAA,CAAA,CAAA;AACnE,QAAA,IAAA,CAAK,GAAG,SAAU,EAAA,CAAA;AAClB,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,IAAA,CAAK,OAAU,GAAA,KAAA,CAAA;AACf,MAAA,IAAA,CAAK,GAAG,IAAK,EAAA,CAAA;AAAA,KACd,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,UAAa,GAAA;AACnB,IAAA,IAAI,KAAK,YAAc,EAAA;AACrB,MAAA,aAAA,CAAc,KAAK,YAAY,CAAA,CAAA;AAAA,KACjC;AAIA,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAA,IAAA,CAAK,GAAG,SAAU,EAAA,CAAA;AAAA,KACnB,CAAA,CAAA;AACD,IAAA,IAAA,CAAK,YAAY,KAAM,EAAA,CAAA;AAAA,GACzB;AAAA,EAEA,aAAA,CAAc,IAAe,QAA8B,EAAA;AAEzD,IAAI,IAAA,CAAC,KAAK,YAAc,EAAA;AACtB,MAAA,IAAA,CAAK,eAAe,WAAY,CAAA,MAAM,IAAK,CAAA,IAAA,IAAQ,GAAK,CAAA,CAAA;AAAA,KAC1D;AAEA,IAAA,MAAM,KAAKA,OAAK,EAAA,CAAA;AAChB,IAAA,MAAM,IAAO,GAAA;AAAA,MACX,EAAA;AAAA,MACA,IAAA,EAAM,UAAU,aAAiB,IAAA,oBAAA;AAAA,MACjC,EAAA;AAAA,MACA,mBAAA,EAAqB,UAAU,mBAAuB,IAAA;AAAA,QACpD,oBAAA;AAAA,OACF;AAAA,MACA,aAAA,sBAAmB,GAAY,EAAA;AAAA,MAC/B,OAAS,EAAA,IAAA;AAAA,KACX,CAAA;AAEA,IAAK,IAAA,CAAA,WAAA,CAAY,GAAI,CAAA,EAAA,EAAI,IAAI,CAAA,CAAA;AAE7B,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAc,WAAA,EAAA,EAAE,CAAY,UAAA,CAAA,CAAA,CAAA;AAC9C,IAAG,EAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,GAAe,KAAA;AAC7B,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,+BAAA,EAAkC,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA,oBAAA,CAAA;AAAA,OAC9C,CAAA;AACA,MAAA,EAAA,CAAG,SAAU,EAAA,CAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAAA,KAC3B,CAAA,CAAA;AAED,IAAA,EAAA,CAAG,EAAG,CAAA,OAAA,EAAS,CAAC,IAAA,EAAc,MAAmB,KAAA;AAC/C,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,EAAE,CAAqB,kBAAA,EAAA,IAAI,aAAa,MAAM,CAAA,CAAA;AAAA,OAC9D,CAAA;AACA,MAAA,EAAA,CAAG,SAAU,EAAA,CAAA;AACb,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAAA,KAC3B,CAAA,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA,CAAA;AACf,MAAA,EAAA,CAAG,IAAK,EAAA,CAAA;AAAA,KACT,CAAA,CAAA;AAED,IAAG,EAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AAClB,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA,CAAA;AAAA,KAChB,CAAA,CAAA;AAED,IAAA,EAAA,CAAG,EAAG,CAAA,SAAA,EAAW,CAAC,IAAA,EAAe,QAAsB,KAAA;AACrD,MAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,iCAAA,EAAoC,EAAE,CAAA,EAAA,EAAK,IAAI,CAAE,CAAA,CAAA,CAAA;AACnE,MAAA,IAAI,QAAU,EAAA;AACZ,QAAA,OAAA;AAAA,OACF;AACA,MAAI,IAAA;AACF,QAAA,MAAM,IAAO,GAAA,IAAA,CAAK,KAAM,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AACvC,QAAK,IAAA,CAAA,aAAA,CAAc,MAAM,IAAI,CAAA,CAAA;AAAA,eACtB,GAAU,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,yCAAA,EAA4C,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA,CAAA;AAAA,SACxD,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,aAAA,CAAc,YAA8B,OAAqB,EAAA;AACvE,IAAA,IAAI,OAAQ,CAAA,MAAA,KAAW,WAAe,IAAA,OAAA,CAAQ,OAAS,EAAA;AACrD,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,UAAA,CAAW,EAAE,CAAA,eAAA,EAAkB,QAAQ,OAAO,CAAA,CAAA;AAAA,OAC9D,CAAA;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,GAAI,CAAA,OAAA,CAAQ,OAAiB,CAAA,CAAA;AAAA,KAC7C,MAAA,IAAA,OAAA,CAAQ,MAAW,KAAA,aAAA,IAAiB,QAAQ,OAAS,EAAA;AAC9D,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAc,WAAA,EAAA,UAAA,CAAW,EAAE,CAAA,mBAAA,EAAsB,QAAQ,OAAO,CAAA,CAAA;AAAA,OAClE,CAAA;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,MAAO,CAAA,OAAA,CAAQ,OAAiB,CAAA,CAAA;AAAA,KAC3D;AAAA,GACF;AAAA,EAEA,MAAc,mBAAmB,YAA4C,EAAA;AAC3E,IAAA,IAAI,CAAC,YAAA,CAAa,OAAW,IAAA,CAAC,aAAa,OAAS,EAAA;AAClD,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,MAAM,EAAE,OAAA,EAAS,UAAY,EAAA,OAAA,EAAY,GAAA,YAAA,CAAA;AACzC,IAAA,MAAM,cAAc,IAAK,CAAA,SAAA,CAAU,EAAE,OAAA,EAAS,SAAS,CAAA,CAAA;AACvD,IAAA,IAAI,QAAkB,EAAC,CAAA;AACvB,IAAI,IAAA,UAAA,CAAW,SAAS,MAAQ,EAAA;AAC9B,MAAQ,KAAA,GAAA,KAAA,CAAM,QAAQ,UAAW,CAAA,SAAS,IACtC,UAAW,CAAA,SAAA,GACX,CAAC,UAAA,CAAW,SAAS,CAAA,CAAA;AAAA,KAC3B;AAGA,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAA,IAAI,CAAC,IAAA,CAAK,aAAc,CAAA,GAAA,CAAI,OAAO,CAAG,EAAA;AACpC,QAAA,OAAA;AAAA,OACF;AAGA,MAAA,IACE,UAAW,CAAA,IAAA,KAAS,WACpB,IAAA,CAAC,IAAK,CAAA,mBAAA,CAAoB,IAAK,CAAA,CAAC,GAAgB,KAAA,KAAA,CAAM,QAAS,CAAA,GAAG,CAAC,CACnE,EAAA;AACA,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,IAAI,IAAK,CAAA,EAAA,CAAG,UAAe,KAAAC,YAAA,CAAU,IAAM,EAAA;AACzC,QAAA,OAAA;AAAA,OACF;AAEA,MAAK,IAAA,CAAA,EAAA,CAAG,IAAK,CAAA,WAAA,EAAa,CAAO,GAAA,KAAA;AAC/B,QAAA,IAAI,GAAK,EAAA;AACP,UAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,0BAAA,EAA6B,KAAK,EAAE,CAAA,EAAA,EAAK,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,SAClE;AAAA,OACD,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;AC9KA,eAAsBC,eACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,SAAW,EAAA,IAAA,EAAM,UAAa,GAAA,OAAA,CAAA;AAE9C,EAAM,MAAA,OAAA,GAAU,aAAc,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAC5C,EAAA,IAAI,2BAA8B,GAAA,KAAA,CAAA;AAClC,EAAA,IAAI,MAA6B,GAAA,KAAA,CAAA,CAAA;AAEjC,EAAM,MAAA,eAAA,GAAkB,IAAIC,kBAAgB,CAAA;AAAA,IAC1C,QAAU,EAAA,IAAA;AAAA;AAAA,IACV,cAAgB,EAAA,KAAA;AAAA;AAAA,GACjB,CAAA,CAAA;AAED,EAAgB,eAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,KAAiB,KAAA;AAC5C,IAAO,MAAA,CAAA,KAAA,CAAM,CAA2B,wBAAA,EAAA,KAAK,CAAE,CAAA,CAAA,CAAA;AAAA,GAChD,CAAA,CAAA;AAED,EAAA,MAAM,aAAgB,GAAA,OACpB,OACA,EAAA,MAAA,EACA,IACG,KAAA;AACH,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAS,MAAA,GAAA,MAAM,SAAU,CAAA,UAAA,CAAW,SAAS,CAAA,CAAA;AAAA,KAC/C;AAEA,IAAI,IAAA,CAAC,OAAQ,CAAA,GAAA,IAAO,CAAC,MAAA,IAAU,CAAC,MAAO,CAAA,QAAA,CAAS,OAAQ,CAAA,GAAG,CAAG,EAAA;AAC5D,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,IAAI,YAA8C,GAAA,KAAA,CAAA,CAAA;AAIlD,IAAI,IAAA;AACF,MAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,OAAA,CAAQ,wBAAwB,CAAA,CAAA;AACtD,MAAA,IAAI,KAAO,EAAA;AACT,QAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,KAAK,CAAA,CAAA;AACjD,QAAA,IAAI,IAAK,CAAA,WAAA,CAAY,WAAa,EAAA,MAAM,CAAG,EAAA;AACzC,UAAe,YAAA,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,WAAW,CAAA,CAAA;AAAA,SACvD;AAAA,OACF;AAAA,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAgD,6CAAA,EAAA,CAAC,CAAE,CAAA,CAAA,CAAA;AAChE,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,iGAAA;AAAA,OAIF,CAAA;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA,CAAA;AACf,MAAA,OAAA;AAAA,KACF;AAEA,IAAI,IAAA;AACF,MAAgB,eAAA,CAAA,aAAA;AAAA,QACd,OAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,CAAC,IAAe,EAAwB,KAAA;AACtC,UAAQ,OAAA,CAAA,aAAA,CAAc,IAAI,YAAY,CAAA,CAAA;AAAA,SACxC;AAAA,OACF,CAAA;AAAA,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA,CAAM,CAAuC,oCAAA,EAAA,CAAC,CAAE,CAAA,CAAA,CAAA;AACvD,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,iGAAA;AAAA,OAIF,CAAA;AACA,MAAA,MAAA,CAAO,OAAQ,EAAA,CAAA;AAAA,KACjB;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,iBAAoB,GAAA,OACxB,GACA,EAAA,CAAA,EACA,IACG,KAAA;AACH,IAAM,MAAA,MAAA,GAAsC,IAAI,MAAgB,EAAA,MAAA,CAAA;AAChE,IAAA,IACE,2BACA,IAAA,CAAC,MACD,IAAA,CAAC,IAAI,OACL,IAAA,GAAA,CAAI,OAAQ,CAAA,OAAA,KAAY,UACxB,GAAI,CAAA,OAAA,CAAQ,OAAQ,CAAA,WAAA,OAAkB,WACtC,EAAA;AACA,MAAK,IAAA,EAAA,CAAA;AACL,MAAA,OAAA;AAAA,KACF;AAEA,IAA8B,2BAAA,GAAA,IAAA,CAAA;AAC9B,IAAO,MAAA,CAAA,EAAA,CAAG,WAAW,aAAa,CAAA,CAAA;AAAA,GACpC,CAAA;AAEA,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,iBAAiB,CAAA,CAAA;AAE5B,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,CAAA,EAAG,QAAa,KAAA;AACrC,IAAA,QAAA,CAAS,IAAK,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAM,CAAA,CAAA;AAAA,GAC/B,CAAA,CAAA;AAED,EAAO,OAAA,MAAA,CAAA;AACT;;ACjGA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,OAAOC,cAAc,CAAA;AAAA,IACnB,GAAG,OAAA;AAAA,IACH,GAAGC,uCAAyB,OAAO,CAAA;AAAA,GACpC,CAAA,CAAA;AACH;;AChCO,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,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,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,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,23 +1,28 @@
|
|
|
1
|
-
import { PluginEndpointDiscovery } from '@backstage/backend-common';
|
|
2
1
|
import express from 'express';
|
|
2
|
+
import { Config } from '@backstage/config';
|
|
3
3
|
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
4
|
-
import { LoggerService, LifecycleService, AuthService, UserInfoService } from '@backstage/backend-plugin-api';
|
|
4
|
+
import { LoggerService, DiscoveryService, 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';
|
|
8
7
|
|
|
9
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* @public
|
|
10
|
+
* @deprecated Please migrate to the new backend system as this will be removed in the future.
|
|
11
|
+
*/
|
|
10
12
|
interface RouterOptions {
|
|
11
13
|
logger: LoggerService;
|
|
12
14
|
events: EventsService;
|
|
13
|
-
identity
|
|
14
|
-
discovery:
|
|
15
|
+
identity?: IdentityApi;
|
|
16
|
+
discovery: DiscoveryService;
|
|
15
17
|
config: Config;
|
|
16
18
|
lifecycle?: LifecycleService;
|
|
17
19
|
auth?: AuthService;
|
|
18
20
|
userInfo?: UserInfoService;
|
|
19
21
|
}
|
|
20
|
-
/**
|
|
22
|
+
/**
|
|
23
|
+
* @public
|
|
24
|
+
* @deprecated Please migrate to the new backend system as this will be removed in the future.
|
|
25
|
+
*/
|
|
21
26
|
declare function createRouter(options: RouterOptions): Promise<express.Router>;
|
|
22
27
|
|
|
23
28
|
/**
|
|
@@ -25,6 +30,6 @@ declare function createRouter(options: RouterOptions): Promise<express.Router>;
|
|
|
25
30
|
*
|
|
26
31
|
* @public
|
|
27
32
|
*/
|
|
28
|
-
declare const signalsPlugin: _backstage_backend_plugin_api.
|
|
33
|
+
declare const signalsPlugin: _backstage_backend_plugin_api.BackendFeature;
|
|
29
34
|
|
|
30
35
|
export { type RouterOptions, createRouter, signalsPlugin as default };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-signals-backend",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0-next.0",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "backend-plugin",
|
|
6
6
|
"pluginId": "signals",
|
|
@@ -37,12 +37,12 @@
|
|
|
37
37
|
"test": "backstage-cli package test"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@backstage/backend-common": "^0.
|
|
41
|
-
"@backstage/backend-plugin-api": "^0.
|
|
40
|
+
"@backstage/backend-common": "^0.25.0-next.0",
|
|
41
|
+
"@backstage/backend-plugin-api": "^0.9.0-next.0",
|
|
42
42
|
"@backstage/config": "^1.2.0",
|
|
43
|
-
"@backstage/plugin-auth-node": "^0.5.0",
|
|
44
|
-
"@backstage/plugin-events-node": "^0.
|
|
45
|
-
"@backstage/plugin-signals-node": "^0.1.
|
|
43
|
+
"@backstage/plugin-auth-node": "^0.5.2-next.0",
|
|
44
|
+
"@backstage/plugin-events-node": "^0.4.0-next.0",
|
|
45
|
+
"@backstage/plugin-signals-node": "^0.1.11-next.0",
|
|
46
46
|
"@backstage/types": "^1.1.1",
|
|
47
47
|
"@types/express": "*",
|
|
48
48
|
"express": "^4.17.1",
|
|
@@ -55,12 +55,12 @@
|
|
|
55
55
|
"yn": "^4.0.0"
|
|
56
56
|
},
|
|
57
57
|
"devDependencies": {
|
|
58
|
-
"@backstage/backend-defaults": "^0.
|
|
59
|
-
"@backstage/backend-test-utils": "^0.
|
|
60
|
-
"@backstage/cli": "^0.27.0",
|
|
61
|
-
"@backstage/plugin-auth-backend": "^0.
|
|
62
|
-
"@backstage/plugin-auth-backend-module-guest-provider": "^0.
|
|
63
|
-
"@backstage/plugin-events-backend": "^0.3.
|
|
58
|
+
"@backstage/backend-defaults": "^0.5.0-next.0",
|
|
59
|
+
"@backstage/backend-test-utils": "^0.6.0-next.0",
|
|
60
|
+
"@backstage/cli": "^0.27.1-next.0",
|
|
61
|
+
"@backstage/plugin-auth-backend": "^0.23.0-next.0",
|
|
62
|
+
"@backstage/plugin-auth-backend-module-guest-provider": "^0.2.0-next.0",
|
|
63
|
+
"@backstage/plugin-events-backend": "^0.3.12-next.0",
|
|
64
64
|
"@types/supertest": "^2.0.8",
|
|
65
65
|
"@types/ws": "^8.5.10",
|
|
66
66
|
"msw": "^1.0.0",
|