@backstage/plugin-events-backend 0.4.0 → 0.4.1-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# @backstage/plugin-events-backend
|
|
2
2
|
|
|
3
|
+
## 0.4.1-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- d9d62ef: Remove some internal usages of the backend-common package
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/backend-openapi-utils@0.4.1-next.0
|
|
10
|
+
- @backstage/backend-plugin-api@1.1.1-next.0
|
|
11
|
+
- @backstage/config@1.3.1
|
|
12
|
+
- @backstage/errors@1.2.6
|
|
13
|
+
- @backstage/types@1.2.0
|
|
14
|
+
- @backstage/plugin-events-node@0.4.7-next.0
|
|
15
|
+
|
|
3
16
|
## 0.4.0
|
|
4
17
|
|
|
5
18
|
### Minor Changes
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var backendCommon = require('@backstage/backend-common');
|
|
4
3
|
var errors = require('@backstage/errors');
|
|
5
4
|
var contentType = require('content-type');
|
|
6
5
|
var express = require('express');
|
|
@@ -52,7 +51,6 @@ class HttpPostIngressEventPublisher {
|
|
|
52
51
|
Object.keys(ingresses).forEach(
|
|
53
52
|
(topic) => this.addRouteForTopic(router, topic, ingresses[topic].validator)
|
|
54
53
|
);
|
|
55
|
-
router.use(backendCommon.errorHandler());
|
|
56
54
|
return router;
|
|
57
55
|
}
|
|
58
56
|
addRouteForTopic(router, topic, validator) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HttpPostIngressEventPublisher.cjs.js","sources":["../../../src/service/http/HttpPostIngressEventPublisher.ts"],"sourcesContent":["/*\n * Copyright 2022 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 {
|
|
1
|
+
{"version":3,"file":"HttpPostIngressEventPublisher.cjs.js","sources":["../../../src/service/http/HttpPostIngressEventPublisher.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { LoggerService } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { CustomErrorBase } from '@backstage/errors';\nimport {\n EventsService,\n HttpPostIngressOptions,\n RequestValidator,\n} from '@backstage/plugin-events-node';\nimport contentType from 'content-type';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { RequestValidationContextImpl } from './validation';\n\nclass UnsupportedCharsetError extends CustomErrorBase {\n name = 'UnsupportedCharsetError' as const;\n statusCode = 415 as const;\n\n constructor(charset: string) {\n super(`Unsupported charset: ${charset}`);\n }\n}\n\nclass UnsupportedMediaTypeError extends CustomErrorBase {\n name = 'UnsupportedMediaTypeError' as const;\n statusCode = 415 as const;\n\n constructor(mediaType?: string) {\n super(`Unsupported media type: ${mediaType ?? 'unknown'}`);\n }\n}\n\n/**\n * Publishes events received from their origin (e.g., webhook events from an SCM system)\n * via HTTP POST endpoint and passes the request body as event payload to the registered subscribers.\n *\n * @public\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class HttpPostIngressEventPublisher {\n static fromConfig(env: {\n config: Config;\n events: EventsService;\n ingresses?: { [topic: string]: Omit<HttpPostIngressOptions, 'topic'> };\n logger: LoggerService;\n }): HttpPostIngressEventPublisher {\n const topics =\n env.config.getOptionalStringArray('events.http.topics') ?? [];\n\n const ingresses = env.ingresses ?? {};\n topics.forEach(topic => {\n // don't overwrite topic settings\n // (e.g., added at the config as well as argument)\n if (!ingresses[topic]) {\n ingresses[topic] = {};\n }\n });\n\n return new HttpPostIngressEventPublisher(env.events, env.logger, ingresses);\n }\n\n private constructor(\n private readonly events: EventsService,\n private readonly logger: LoggerService,\n private readonly ingresses: {\n [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n },\n ) {}\n\n bind(router: express.Router): void {\n router.use('/http', this.createRouter(this.ingresses));\n }\n\n private createRouter(ingresses: {\n [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n }): express.Router {\n const router = Router();\n router.use(express.raw({ type: '*/*' }));\n\n Object.keys(ingresses).forEach(topic =>\n this.addRouteForTopic(router, topic, ingresses[topic].validator),\n );\n\n return router;\n }\n\n private addRouteForTopic(\n router: express.Router,\n topic: string,\n validator?: RequestValidator,\n ): void {\n const path = `/${topic}`;\n const logger = this.logger;\n\n router.post(path, async (request, response) => {\n const requestBody = request.body;\n if (!Buffer.isBuffer(requestBody)) {\n throw new Error(\n `Failed to retrieve raw body from incoming event for topic ${topic}; not a buffer: ${typeof requestBody}`,\n );\n }\n\n const bodyBuffer: Buffer = requestBody;\n const parsedContentType = contentType.parse(request);\n if (\n !parsedContentType.type ||\n parsedContentType.type !== 'application/json'\n ) {\n throw new UnsupportedMediaTypeError(parsedContentType.type);\n }\n\n const encoding = parsedContentType.parameters.charset ?? 'utf-8';\n if (!Buffer.isEncoding(encoding)) {\n throw new UnsupportedCharsetError(encoding);\n }\n\n const bodyString = bodyBuffer.toString(encoding);\n const bodyParsed =\n parsedContentType.type === 'application/json'\n ? JSON.parse(bodyString)\n : bodyString;\n\n if (validator) {\n const requestDetails = {\n body: bodyParsed,\n headers: request.headers,\n raw: {\n body: bodyBuffer,\n encoding: encoding as BufferEncoding,\n },\n };\n\n const context = new RequestValidationContextImpl();\n await validator(requestDetails, context);\n\n if (context.wasRejected()) {\n response\n .status(context.rejectionDetails!.status)\n .json(context.rejectionDetails!.payload);\n return;\n }\n }\n\n await this.events.publish({\n topic,\n eventPayload: bodyParsed,\n metadata: request.headers,\n });\n\n response.status(202).json({ status: 'accepted' });\n });\n\n // TODO(pjungermann): We don't really know the externally defined path prefix here,\n // however it is more useful for users to have it. Is there a better way?\n logger.info(`Registered /api/events/http${path} to receive events`);\n }\n}\n"],"names":["CustomErrorBase","Router","express","contentType","RequestValidationContextImpl"],"mappings":";;;;;;;;;;;;;;AA6BA,MAAM,gCAAgCA,sBAAgB,CAAA;AAAA,EACpD,IAAO,GAAA,yBAAA;AAAA,EACP,UAAa,GAAA,GAAA;AAAA,EAEb,YAAY,OAAiB,EAAA;AAC3B,IAAM,KAAA,CAAA,CAAA,qBAAA,EAAwB,OAAO,CAAE,CAAA,CAAA;AAAA;AAE3C;AAEA,MAAM,kCAAkCA,sBAAgB,CAAA;AAAA,EACtD,IAAO,GAAA,2BAAA;AAAA,EACP,UAAa,GAAA,GAAA;AAAA,EAEb,YAAY,SAAoB,EAAA;AAC9B,IAAM,KAAA,CAAA,CAAA,wBAAA,EAA2B,SAAa,IAAA,SAAS,CAAE,CAAA,CAAA;AAAA;AAE7D;AASO,MAAM,6BAA8B,CAAA;AAAA,EAsBjC,WAAA,CACW,MACA,EAAA,MAAA,EACA,SAGjB,EAAA;AALiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AAAA;AAGhB,EA3BH,OAAO,WAAW,GAKgB,EAAA;AAChC,IAAA,MAAM,SACJ,GAAI,CAAA,MAAA,CAAO,sBAAuB,CAAA,oBAAoB,KAAK,EAAC;AAE9D,IAAM,MAAA,SAAA,GAAY,GAAI,CAAA,SAAA,IAAa,EAAC;AACpC,IAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAGtB,MAAI,IAAA,CAAC,SAAU,CAAA,KAAK,CAAG,EAAA;AACrB,QAAU,SAAA,CAAA,KAAK,IAAI,EAAC;AAAA;AACtB,KACD,CAAA;AAED,IAAA,OAAO,IAAI,6BAA8B,CAAA,GAAA,CAAI,MAAQ,EAAA,GAAA,CAAI,QAAQ,SAAS,CAAA;AAAA;AAC5E,EAUA,KAAK,MAA8B,EAAA;AACjC,IAAA,MAAA,CAAO,IAAI,OAAS,EAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,SAAS,CAAC,CAAA;AAAA;AACvD,EAEQ,aAAa,SAEF,EAAA;AACjB,IAAA,MAAM,SAASC,uBAAO,EAAA;AACtB,IAAA,MAAA,CAAO,IAAIC,wBAAQ,CAAA,GAAA,CAAI,EAAE,IAAM,EAAA,KAAA,EAAO,CAAC,CAAA;AAEvC,IAAO,MAAA,CAAA,IAAA,CAAK,SAAS,CAAE,CAAA,OAAA;AAAA,MAAQ,CAAA,KAAA,KAC7B,KAAK,gBAAiB,CAAA,MAAA,EAAQ,OAAO,SAAU,CAAA,KAAK,EAAE,SAAS;AAAA,KACjE;AAEA,IAAO,OAAA,MAAA;AAAA;AACT,EAEQ,gBAAA,CACN,MACA,EAAA,KAAA,EACA,SACM,EAAA;AACN,IAAM,MAAA,IAAA,GAAO,IAAI,KAAK,CAAA,CAAA;AACtB,IAAA,MAAM,SAAS,IAAK,CAAA,MAAA;AAEpB,IAAA,MAAA,CAAO,IAAK,CAAA,IAAA,EAAM,OAAO,OAAA,EAAS,QAAa,KAAA;AAC7C,MAAA,MAAM,cAAc,OAAQ,CAAA,IAAA;AAC5B,MAAA,IAAI,CAAC,MAAA,CAAO,QAAS,CAAA,WAAW,CAAG,EAAA;AACjC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAA6D,0DAAA,EAAA,KAAK,CAAmB,gBAAA,EAAA,OAAO,WAAW,CAAA;AAAA,SACzG;AAAA;AAGF,MAAA,MAAM,UAAqB,GAAA,WAAA;AAC3B,MAAM,MAAA,iBAAA,GAAoBC,4BAAY,CAAA,KAAA,CAAM,OAAO,CAAA;AACnD,MAAA,IACE,CAAC,iBAAA,CAAkB,IACnB,IAAA,iBAAA,CAAkB,SAAS,kBAC3B,EAAA;AACA,QAAM,MAAA,IAAI,yBAA0B,CAAA,iBAAA,CAAkB,IAAI,CAAA;AAAA;AAG5D,MAAM,MAAA,QAAA,GAAW,iBAAkB,CAAA,UAAA,CAAW,OAAW,IAAA,OAAA;AACzD,MAAA,IAAI,CAAC,MAAA,CAAO,UAAW,CAAA,QAAQ,CAAG,EAAA;AAChC,QAAM,MAAA,IAAI,wBAAwB,QAAQ,CAAA;AAAA;AAG5C,MAAM,MAAA,UAAA,GAAa,UAAW,CAAA,QAAA,CAAS,QAAQ,CAAA;AAC/C,MAAA,MAAM,aACJ,iBAAkB,CAAA,IAAA,KAAS,qBACvB,IAAK,CAAA,KAAA,CAAM,UAAU,CACrB,GAAA,UAAA;AAEN,MAAA,IAAI,SAAW,EAAA;AACb,QAAA,MAAM,cAAiB,GAAA;AAAA,UACrB,IAAM,EAAA,UAAA;AAAA,UACN,SAAS,OAAQ,CAAA,OAAA;AAAA,UACjB,GAAK,EAAA;AAAA,YACH,IAAM,EAAA,UAAA;AAAA,YACN;AAAA;AACF,SACF;AAEA,QAAM,MAAA,OAAA,GAAU,IAAIC,yDAA6B,EAAA;AACjD,QAAM,MAAA,SAAA,CAAU,gBAAgB,OAAO,CAAA;AAEvC,QAAI,IAAA,OAAA,CAAQ,aAAe,EAAA;AACzB,UACG,QAAA,CAAA,MAAA,CAAO,QAAQ,gBAAkB,CAAA,MAAM,EACvC,IAAK,CAAA,OAAA,CAAQ,iBAAkB,OAAO,CAAA;AACzC,UAAA;AAAA;AACF;AAGF,MAAM,MAAA,IAAA,CAAK,OAAO,OAAQ,CAAA;AAAA,QACxB,KAAA;AAAA,QACA,YAAc,EAAA,UAAA;AAAA,QACd,UAAU,OAAQ,CAAA;AAAA,OACnB,CAAA;AAED,MAAA,QAAA,CAAS,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,MAAA,EAAQ,YAAY,CAAA;AAAA,KACjD,CAAA;AAID,IAAO,MAAA,CAAA,IAAA,CAAK,CAA8B,2BAAA,EAAA,IAAI,CAAoB,kBAAA,CAAA,CAAA;AAAA;AAEtE;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-events-backend",
|
|
3
|
-
"version": "0.4.0",
|
|
3
|
+
"version": "0.4.1-next.0",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "backend-plugin",
|
|
6
6
|
"pluginId": "events",
|
|
@@ -64,12 +64,12 @@
|
|
|
64
64
|
},
|
|
65
65
|
"dependencies": {
|
|
66
66
|
"@backstage/backend-common": "^0.25.0",
|
|
67
|
-
"@backstage/backend-openapi-utils": "
|
|
68
|
-
"@backstage/backend-plugin-api": "
|
|
69
|
-
"@backstage/config": "
|
|
70
|
-
"@backstage/errors": "
|
|
71
|
-
"@backstage/plugin-events-node": "
|
|
72
|
-
"@backstage/types": "
|
|
67
|
+
"@backstage/backend-openapi-utils": "0.4.1-next.0",
|
|
68
|
+
"@backstage/backend-plugin-api": "1.1.1-next.0",
|
|
69
|
+
"@backstage/config": "1.3.1",
|
|
70
|
+
"@backstage/errors": "1.2.6",
|
|
71
|
+
"@backstage/plugin-events-node": "0.4.7-next.0",
|
|
72
|
+
"@backstage/types": "1.2.0",
|
|
73
73
|
"@types/express": "^4.17.6",
|
|
74
74
|
"content-type": "^1.0.5",
|
|
75
75
|
"express": "^4.17.1",
|
|
@@ -78,12 +78,12 @@
|
|
|
78
78
|
"winston": "^3.2.1"
|
|
79
79
|
},
|
|
80
80
|
"devDependencies": {
|
|
81
|
-
"@backstage/backend-app-api": "
|
|
82
|
-
"@backstage/backend-defaults": "
|
|
83
|
-
"@backstage/backend-test-utils": "
|
|
84
|
-
"@backstage/cli": "
|
|
85
|
-
"@backstage/plugin-events-backend-test-utils": "
|
|
86
|
-
"@backstage/repo-tools": "
|
|
81
|
+
"@backstage/backend-app-api": "1.1.1-next.0",
|
|
82
|
+
"@backstage/backend-defaults": "0.7.0-next.0",
|
|
83
|
+
"@backstage/backend-test-utils": "1.2.1-next.0",
|
|
84
|
+
"@backstage/cli": "0.29.5-next.0",
|
|
85
|
+
"@backstage/plugin-events-backend-test-utils": "0.1.40-next.0",
|
|
86
|
+
"@backstage/repo-tools": "0.12.1-next.0",
|
|
87
87
|
"@types/content-type": "^1.1.8",
|
|
88
88
|
"supertest": "^7.0.0"
|
|
89
89
|
},
|