@backstage/plugin-signals-backend 0.3.19-next.0 → 0.3.19
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 +19 -0
- package/dist/service/router.cjs.js +6 -6
- package/dist/service/router.cjs.js.map +1 -1
- package/package.json +12 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,24 @@
|
|
|
1
1
|
# @backstage/plugin-signals-backend
|
|
2
2
|
|
|
3
|
+
## 0.3.19
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 0ae9229: Fixed WebSocket upgrade error responses to prevent load balancers from returning 502 when authentication fails. Error responses now use valid HTTP headers, ensuring the actual error status (401 or 500) is delivered to the client instead of being masked.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/config@1.3.9
|
|
10
|
+
- @backstage/backend-plugin-api@1.10.1
|
|
11
|
+
- @backstage/plugin-events-node@0.4.26
|
|
12
|
+
- @backstage/plugin-signals-node@0.2.5
|
|
13
|
+
|
|
14
|
+
## 0.3.19-next.1
|
|
15
|
+
|
|
16
|
+
### Patch Changes
|
|
17
|
+
|
|
18
|
+
- Updated dependencies
|
|
19
|
+
- @backstage/config@1.3.9-next.0
|
|
20
|
+
- @backstage/backend-plugin-api@1.10.1-next.1
|
|
21
|
+
|
|
3
22
|
## 0.3.19-next.0
|
|
4
23
|
|
|
5
24
|
### Patch Changes
|
|
@@ -42,10 +42,10 @@ async function createRouter(options) {
|
|
|
42
42
|
}
|
|
43
43
|
} catch (e) {
|
|
44
44
|
logger.error(`Failed to authenticate WebSocket connection: ${e}`);
|
|
45
|
-
socket.
|
|
46
|
-
"HTTP/1.1 401
|
|
45
|
+
socket.end(
|
|
46
|
+
"HTTP/1.1 401 Unauthorized\r\nContent-Length: 0\r\nConnection: close\r\n\r\n",
|
|
47
|
+
() => socket.destroy()
|
|
47
48
|
);
|
|
48
|
-
socket.destroy();
|
|
49
49
|
return;
|
|
50
50
|
}
|
|
51
51
|
try {
|
|
@@ -59,10 +59,10 @@ async function createRouter(options) {
|
|
|
59
59
|
);
|
|
60
60
|
} catch (e) {
|
|
61
61
|
logger.error(`Failed to handle WebSocket upgrade: ${e}`);
|
|
62
|
-
socket.
|
|
63
|
-
"HTTP/1.1 500
|
|
62
|
+
socket.end(
|
|
63
|
+
"HTTP/1.1 500 Internal Server Error\r\nContent-Length: 0\r\nConnection: close\r\n\r\n",
|
|
64
|
+
() => socket.destroy()
|
|
64
65
|
);
|
|
65
|
-
socket.destroy();
|
|
66
66
|
}
|
|
67
67
|
};
|
|
68
68
|
const upgradeMiddleware = async (req, _, next) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"router.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\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 'node:https';\nimport http, { IncomingMessage } from 'node:http';\nimport { SignalManager } from './SignalManager';\nimport { EventsService } from '@backstage/plugin-events-node';\nimport { WebSocket, WebSocketServer } from 'ws';\nimport { Duplex } from 'node: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.
|
|
1
|
+
{"version":3,"file":"router.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\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 'node:https';\nimport http, { IncomingMessage } from 'node:http';\nimport { SignalManager } from './SignalManager';\nimport { EventsService } from '@backstage/plugin-events-node';\nimport { WebSocket, WebSocketServer } from 'ws';\nimport { Duplex } from 'node: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.end(\n 'HTTP/1.1 401 Unauthorized\\r\\n' +\n 'Content-Length: 0\\r\\n' +\n 'Connection: close\\r\\n' +\n '\\r\\n',\n () => socket.destroy(),\n );\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.end(\n 'HTTP/1.1 500 Internal Server Error\\r\\n' +\n 'Content-Length: 0\\r\\n' +\n 'Connection: close\\r\\n' +\n '\\r\\n',\n () => socket.destroy(),\n );\n }\n };\n\n const upgradeMiddleware = async (\n req: Request,\n _: Response,\n next: NextFunction,\n ) => {\n const server: https.Server | http.Server = (req.socket as any)?.server;\n if (\n subscribedToUpgradeRequests ||\n !server ||\n !req.headers ||\n req.headers.upgrade === undefined ||\n req.headers.upgrade.toLowerCase() !== 'websocket'\n ) {\n next();\n return;\n }\n\n subscribedToUpgradeRequests = true;\n server.on('upgrade', handleUpgrade);\n };\n\n const router = Router();\n router.use(express.json());\n router.use(upgradeMiddleware);\n\n router.get('/health', (_, response) => {\n response.json({ status: 'ok' });\n });\n\n return router;\n}\n"],"names":["SignalManager","WebSocketServer","Router","express"],"mappings":";;;;;;;;;;;;AA4CA,eAAsB,aACpB,OAAA,EACyB;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,SAAA,EAAW,IAAA,EAAM,UAAS,GAAI,OAAA;AAE9C,EAAA,MAAM,OAAA,GAAUA,2BAAA,CAAc,MAAA,CAAO,OAAO,CAAA;AAC5C,EAAA,IAAI,2BAAA,GAA8B,KAAA;AAClC,EAAA,IAAI,MAAA,GAA6B,MAAA;AAEjC,EAAA,MAAM,eAAA,GAAkB,IAAIC,kBAAA,CAAgB;AAAA,IAC1C,QAAA,EAAU,IAAA;AAAA;AAAA,IACV,cAAA,EAAgB;AAAA;AAAA,GACjB,CAAA;AAED,EAAA,eAAA,CAAgB,EAAA,CAAG,OAAA,EAAS,CAAC,KAAA,KAAiB;AAC5C,IAAA,MAAA,CAAO,KAAA,CAAM,CAAA,wBAAA,EAA2B,KAAK,CAAA,CAAE,CAAA;AAAA,EACjD,CAAC,CAAA;AAED,EAAA,MAAM,aAAA,GAAgB,OACpB,OAAA,EACA,MAAA,EACA,IAAA,KACG;AACH,IAAA,IAAI,CAAC,MAAA,EAAQ;AACX,MAAA,MAAA,GAAS,MAAM,SAAA,CAAU,UAAA,CAAW,SAAS,CAAA;AAAA,IAC/C;AAEA,IAAA,IAAI,CAAC,OAAA,CAAQ,GAAA,IAAO,CAAC,MAAA,IAAU,CAAC,MAAA,CAAO,QAAA,CAAS,OAAA,CAAQ,GAAG,CAAA,EAAG;AAC5D,MAAA;AAAA,IACF;AAEA,IAAA,IAAI,YAAA,GAA8C,MAAA;AAIlD,IAAA,IAAI;AACF,MAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,OAAA,CAAQ,wBAAwB,CAAA;AACtD,MAAA,IAAI,KAAA,EAAO;AACT,QAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,YAAA,CAAa,KAAK,CAAA;AACjD,QAAA,IAAI,IAAA,CAAK,WAAA,CAAY,WAAA,EAAa,MAAM,CAAA,EAAG;AACzC,UAAA,YAAA,GAAe,MAAM,QAAA,CAAS,WAAA,CAAY,WAAW,CAAA;AAAA,QACvD;AAAA,MACF;AAAA,IACF,SAAS,CAAA,EAAG;AACV,MAAA,MAAA,CAAO,KAAA,CAAM,CAAA,6CAAA,EAAgD,CAAC,CAAA,CAAE,CAAA;AAChE,MAAA,MAAA,CAAO,GAAA;AAAA,QACL,6EAAA;AAAA,QAIA,MAAM,OAAO,OAAA;AAAQ,OACvB;AACA,MAAA;AAAA,IACF;AAEA,IAAA,IAAI;AACF,MAAA,eAAA,CAAgB,aAAA;AAAA,QACd,OAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,CAAC,IAAe,EAAA,KAAwB;AACtC,UAAA,OAAA,CAAQ,aAAA,CAAc,IAAI,YAAY,CAAA;AAAA,QACxC;AAAA,OACF;AAAA,IACF,SAAS,CAAA,EAAG;AACV,MAAA,MAAA,CAAO,KAAA,CAAM,CAAA,oCAAA,EAAuC,CAAC,CAAA,CAAE,CAAA;AACvD,MAAA,MAAA,CAAO,GAAA;AAAA,QACL,sFAAA;AAAA,QAIA,MAAM,OAAO,OAAA;AAAQ,OACvB;AAAA,IACF;AAAA,EACF,CAAA;AAEA,EAAA,MAAM,iBAAA,GAAoB,OACxB,GAAA,EACA,CAAA,EACA,IAAA,KACG;AACH,IAAA,MAAM,MAAA,GAAsC,IAAI,MAAA,EAAgB,MAAA;AAChE,IAAA,IACE,2BAAA,IACA,CAAC,MAAA,IACD,CAAC,IAAI,OAAA,IACL,GAAA,CAAI,OAAA,CAAQ,OAAA,KAAY,UACxB,GAAA,CAAI,OAAA,CAAQ,OAAA,CAAQ,WAAA,OAAkB,WAAA,EACtC;AACA,MAAA,IAAA,EAAK;AACL,MAAA;AAAA,IACF;AAEA,IAAA,2BAAA,GAA8B,IAAA;AAC9B,IAAA,MAAA,CAAO,EAAA,CAAG,WAAW,aAAa,CAAA;AAAA,EACpC,CAAA;AAEA,EAAA,MAAM,SAASC,uBAAA,EAAO;AACtB,EAAA,MAAA,CAAO,GAAA,CAAIC,wBAAA,CAAQ,IAAA,EAAM,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,iBAAiB,CAAA;AAE5B,EAAA,MAAA,CAAO,GAAA,CAAI,SAAA,EAAW,CAAC,CAAA,EAAG,QAAA,KAAa;AACrC,IAAA,QAAA,CAAS,IAAA,CAAK,EAAE,MAAA,EAAQ,IAAA,EAAM,CAAA;AAAA,EAChC,CAAC,CAAA;AAED,EAAA,OAAO,MAAA;AACT;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-signals-backend",
|
|
3
|
-
"version": "0.3.19
|
|
3
|
+
"version": "0.3.19",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "backend-plugin",
|
|
6
6
|
"pluginId": "signals",
|
|
@@ -40,22 +40,22 @@
|
|
|
40
40
|
"test": "backstage-cli package test"
|
|
41
41
|
},
|
|
42
42
|
"dependencies": {
|
|
43
|
-
"@backstage/backend-plugin-api": "1.10.1
|
|
44
|
-
"@backstage/config": "1.3.
|
|
45
|
-
"@backstage/plugin-events-node": "0.4.26
|
|
46
|
-
"@backstage/plugin-signals-node": "0.2.5
|
|
47
|
-
"@backstage/types": "1.2.2",
|
|
43
|
+
"@backstage/backend-plugin-api": "^1.10.1",
|
|
44
|
+
"@backstage/config": "^1.3.9",
|
|
45
|
+
"@backstage/plugin-events-node": "^0.4.26",
|
|
46
|
+
"@backstage/plugin-signals-node": "^0.2.5",
|
|
47
|
+
"@backstage/types": "^1.2.2",
|
|
48
48
|
"express": "^4.22.0",
|
|
49
49
|
"express-promise-router": "^4.1.0",
|
|
50
50
|
"ws": "^8.20.1"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
|
-
"@backstage/backend-defaults": "0.
|
|
54
|
-
"@backstage/backend-test-utils": "1.11.7
|
|
55
|
-
"@backstage/cli": "0.36.6
|
|
56
|
-
"@backstage/plugin-auth-backend": "0.30.1
|
|
57
|
-
"@backstage/plugin-auth-backend-module-guest-provider": "0.2.23
|
|
58
|
-
"@backstage/plugin-events-backend": "0.6.6
|
|
53
|
+
"@backstage/backend-defaults": "^0.18.0",
|
|
54
|
+
"@backstage/backend-test-utils": "^1.11.7",
|
|
55
|
+
"@backstage/cli": "^0.36.6",
|
|
56
|
+
"@backstage/plugin-auth-backend": "^0.30.1",
|
|
57
|
+
"@backstage/plugin-auth-backend-module-guest-provider": "^0.2.23",
|
|
58
|
+
"@backstage/plugin-events-backend": "^0.6.6",
|
|
59
59
|
"@types/express": "^4.17.6",
|
|
60
60
|
"@types/supertest": "^2.0.8",
|
|
61
61
|
"@types/ws": "^8.5.10",
|