@backstage/plugin-events-backend-module-aws-sqs 0.4.5-next.2 → 0.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -0
- package/config.d.ts +4 -4
- package/dist/publisher/config.cjs.js +3 -2
- package/dist/publisher/config.cjs.js.map +1 -1
- package/package.json +19 -10
- package/alpha/package.json +0 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# @backstage/plugin-events-backend-module-aws-sqs
|
|
2
2
|
|
|
3
|
+
## 0.4.5
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- d52d7f9: Support ISO and ms string forms of durations in config too
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/config@1.3.0
|
|
10
|
+
- @backstage/plugin-events-node@0.4.5
|
|
11
|
+
- @backstage/types@1.2.0
|
|
12
|
+
- @backstage/backend-plugin-api@1.0.2
|
|
13
|
+
|
|
14
|
+
## 0.4.5-next.3
|
|
15
|
+
|
|
16
|
+
### Patch Changes
|
|
17
|
+
|
|
18
|
+
- Updated dependencies
|
|
19
|
+
- @backstage/plugin-events-node@0.4.5-next.3
|
|
20
|
+
- @backstage/backend-plugin-api@1.0.2-next.2
|
|
21
|
+
- @backstage/config@1.2.0
|
|
22
|
+
- @backstage/types@1.1.1
|
|
23
|
+
|
|
3
24
|
## 0.4.5-next.2
|
|
4
25
|
|
|
5
26
|
### Patch Changes
|
package/config.d.ts
CHANGED
|
@@ -48,12 +48,12 @@ export interface Config {
|
|
|
48
48
|
/**
|
|
49
49
|
* (Optional) Visibility timeout for messages in flight.
|
|
50
50
|
*/
|
|
51
|
-
visibilityTimeout: HumanDuration;
|
|
51
|
+
visibilityTimeout: HumanDuration | string;
|
|
52
52
|
/**
|
|
53
53
|
* (Optional) Wait time when polling for available messages.
|
|
54
54
|
* Default: 20 seconds.
|
|
55
55
|
*/
|
|
56
|
-
waitTime: HumanDuration;
|
|
56
|
+
waitTime: HumanDuration | string;
|
|
57
57
|
};
|
|
58
58
|
/**
|
|
59
59
|
* (Optional) Timeout for the task execution which includes polling for messages
|
|
@@ -62,12 +62,12 @@ export interface Config {
|
|
|
62
62
|
*
|
|
63
63
|
* Must be greater than `queue.waitTime` + `waitTimeAfterEmptyReceive`.
|
|
64
64
|
*/
|
|
65
|
-
timeout: HumanDuration;
|
|
65
|
+
timeout: HumanDuration | string;
|
|
66
66
|
/**
|
|
67
67
|
* (Optional) Wait time before polling again if no message was received.
|
|
68
68
|
* Default: 1 minute.
|
|
69
69
|
*/
|
|
70
|
-
waitTimeAfterEmptyReceive: HumanDuration;
|
|
70
|
+
waitTimeAfterEmptyReceive: HumanDuration | string;
|
|
71
71
|
};
|
|
72
72
|
};
|
|
73
73
|
};
|
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
+
var config = require('@backstage/config');
|
|
3
4
|
var luxon = require('luxon');
|
|
4
5
|
|
|
5
6
|
const CONFIG_PREFIX_MODULE = "events.modules.awsSqs.";
|
|
6
7
|
const CONFIG_PREFIX_PUBLISHER = `${CONFIG_PREFIX_MODULE}awsSqsConsumingEventPublisher.`;
|
|
7
8
|
const DEFAULT_WAIT_TIME_AFTER_EMPTY_RECEIVE = { minutes: 1 };
|
|
8
9
|
const MAX_WAIT_SECONDS = 20;
|
|
9
|
-
function readOptionalHumanDuration(config, key) {
|
|
10
|
-
return config.
|
|
10
|
+
function readOptionalHumanDuration(config$1, key) {
|
|
11
|
+
return config$1.has(key) ? config.readDurationFromConfig(config$1, { key }) : void 0;
|
|
11
12
|
}
|
|
12
13
|
function readOptionalDuration(config, key) {
|
|
13
14
|
const duration = readOptionalHumanDuration(config, key);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.cjs.js","sources":["../../src/publisher/config.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 { Config } from '@backstage/config';\nimport { HumanDuration
|
|
1
|
+
{"version":3,"file":"config.cjs.js","sources":["../../src/publisher/config.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 { Config, readDurationFromConfig } from '@backstage/config';\nimport { HumanDuration } from '@backstage/types';\nimport { Duration } from 'luxon';\n\nconst CONFIG_PREFIX_MODULE = 'events.modules.awsSqs.';\nconst CONFIG_PREFIX_PUBLISHER = `${CONFIG_PREFIX_MODULE}awsSqsConsumingEventPublisher.`;\nconst DEFAULT_WAIT_TIME_AFTER_EMPTY_RECEIVE = { minutes: 1 };\nconst MAX_WAIT_SECONDS = 20;\n\nexport interface AwsSqsEventSourceConfig {\n pollingWaitTime: Duration;\n queueUrl: string;\n region: string;\n timeout: Duration;\n topic: string;\n visibilityTimeout?: Duration;\n waitTimeAfterEmptyReceive: Duration;\n endpoint?: string;\n}\n\n// TODO(pjungermann): validation could be improved similar to `convertToHumanDuration` at @backstage/backend-plugin-api\nfunction readOptionalHumanDuration(\n config: Config,\n key: string,\n): HumanDuration | undefined {\n return config.has(key) ? readDurationFromConfig(config, { key }) : undefined;\n}\n\nfunction readOptionalDuration(\n config: Config,\n key: string,\n): Duration | undefined {\n const duration = readOptionalHumanDuration(config, key);\n return duration ? Duration.fromObject(duration) : undefined;\n}\n\nexport function readConfig(config: Config): AwsSqsEventSourceConfig[] {\n const key = `${CONFIG_PREFIX_PUBLISHER}topics`;\n const topics = config.getOptionalConfig(key);\n\n return (\n topics?.keys()?.map(topic => {\n const topicConfig = topics.getConfig(topic);\n const keyPrefix = `${key}.${topic}.`;\n\n // queue config:\n const pollingWaitTime = Duration.fromObject(\n readOptionalHumanDuration(topicConfig, 'queue.waitTime') ?? {\n seconds: MAX_WAIT_SECONDS,\n },\n );\n if (\n pollingWaitTime.valueOf() < 0 ||\n pollingWaitTime.as('seconds') > MAX_WAIT_SECONDS\n ) {\n throw new Error(\n `${keyPrefix}queue.waitTime must be within 0..${MAX_WAIT_SECONDS} seconds.`,\n );\n }\n const queueUrl = topicConfig.getString('queue.url');\n const region = topicConfig.getString('queue.region');\n const endpoint = topicConfig.getOptionalString('queue.endpoint');\n const visibilityTimeout = readOptionalDuration(\n topicConfig,\n 'queue.visibilityTimeout',\n );\n\n // task:\n const waitTimeAfterEmptyReceive = Duration.fromObject(\n readOptionalHumanDuration(topicConfig, 'waitTimeAfterEmptyReceive') ??\n DEFAULT_WAIT_TIME_AFTER_EMPTY_RECEIVE,\n );\n if (waitTimeAfterEmptyReceive.valueOf() < 0) {\n throw new Error(\n `The ${keyPrefix}waitTimeAfterEmptyReceive must not be negative.`,\n );\n }\n const timeout =\n readOptionalDuration(topicConfig, 'timeout') ??\n pollingWaitTime\n .plus(waitTimeAfterEmptyReceive)\n .plus(Duration.fromObject({ seconds: 180 }));\n if (\n timeout.valueOf() <=\n pollingWaitTime.valueOf() + waitTimeAfterEmptyReceive.valueOf()\n ) {\n throw new Error(\n `The ${keyPrefix}timeout must be greater than ${keyPrefix}queue.waitTime + ${keyPrefix}waitTimeAfterEmptyReceive.`,\n );\n }\n\n return {\n pollingWaitTime,\n queueUrl,\n endpoint,\n region,\n timeout,\n topic,\n visibilityTimeout,\n waitTimeAfterEmptyReceive,\n };\n }) ?? []\n );\n}\n"],"names":["config","readDurationFromConfig","Duration"],"mappings":";;;;;AAoBA,MAAM,oBAAuB,GAAA,wBAAA;AAC7B,MAAM,uBAAA,GAA0B,GAAG,oBAAoB,CAAA,8BAAA,CAAA;AACvD,MAAM,qCAAA,GAAwC,EAAE,OAAA,EAAS,CAAE,EAAA;AAC3D,MAAM,gBAAmB,GAAA,EAAA;AAczB,SAAS,yBAAA,CACPA,UACA,GAC2B,EAAA;AAC3B,EAAO,OAAAA,QAAA,CAAO,IAAI,GAAG,CAAA,GAAIC,8BAAuBD,QAAQ,EAAA,EAAE,GAAI,EAAC,CAAI,GAAA,KAAA,CAAA;AACrE;AAEA,SAAS,oBAAA,CACP,QACA,GACsB,EAAA;AACtB,EAAM,MAAA,QAAA,GAAW,yBAA0B,CAAA,MAAA,EAAQ,GAAG,CAAA;AACtD,EAAA,OAAO,QAAW,GAAAE,cAAA,CAAS,UAAW,CAAA,QAAQ,CAAI,GAAA,KAAA,CAAA;AACpD;AAEO,SAAS,WAAW,MAA2C,EAAA;AACpE,EAAM,MAAA,GAAA,GAAM,GAAG,uBAAuB,CAAA,MAAA,CAAA;AACtC,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,iBAAA,CAAkB,GAAG,CAAA;AAE3C,EAAA,OACE,MAAQ,EAAA,IAAA,EAAQ,EAAA,GAAA,CAAI,CAAS,KAAA,KAAA;AAC3B,IAAM,MAAA,WAAA,GAAc,MAAO,CAAA,SAAA,CAAU,KAAK,CAAA;AAC1C,IAAA,MAAM,SAAY,GAAA,CAAA,EAAG,GAAG,CAAA,CAAA,EAAI,KAAK,CAAA,CAAA,CAAA;AAGjC,IAAA,MAAM,kBAAkBA,cAAS,CAAA,UAAA;AAAA,MAC/B,yBAAA,CAA0B,WAAa,EAAA,gBAAgB,CAAK,IAAA;AAAA,QAC1D,OAAS,EAAA;AAAA;AACX,KACF;AACA,IACE,IAAA,eAAA,CAAgB,SAAY,GAAA,CAAA,IAC5B,gBAAgB,EAAG,CAAA,SAAS,IAAI,gBAChC,EAAA;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,EAAG,SAAS,CAAA,iCAAA,EAAoC,gBAAgB,CAAA,SAAA;AAAA,OAClE;AAAA;AAEF,IAAM,MAAA,QAAA,GAAW,WAAY,CAAA,SAAA,CAAU,WAAW,CAAA;AAClD,IAAM,MAAA,MAAA,GAAS,WAAY,CAAA,SAAA,CAAU,cAAc,CAAA;AACnD,IAAM,MAAA,QAAA,GAAW,WAAY,CAAA,iBAAA,CAAkB,gBAAgB,CAAA;AAC/D,IAAA,MAAM,iBAAoB,GAAA,oBAAA;AAAA,MACxB,WAAA;AAAA,MACA;AAAA,KACF;AAGA,IAAA,MAAM,4BAA4BA,cAAS,CAAA,UAAA;AAAA,MACzC,yBAAA,CAA0B,WAAa,EAAA,2BAA2B,CAChE,IAAA;AAAA,KACJ;AACA,IAAI,IAAA,yBAAA,CAA0B,OAAQ,EAAA,GAAI,CAAG,EAAA;AAC3C,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,OAAO,SAAS,CAAA,+CAAA;AAAA,OAClB;AAAA;AAEF,IAAA,MAAM,UACJ,oBAAqB,CAAA,WAAA,EAAa,SAAS,CAAA,IAC3C,gBACG,IAAK,CAAA,yBAAyB,CAC9B,CAAA,IAAA,CAAKA,eAAS,UAAW,CAAA,EAAE,OAAS,EAAA,GAAA,EAAK,CAAC,CAAA;AAC/C,IACE,IAAA,OAAA,CAAQ,SACR,IAAA,eAAA,CAAgB,SAAY,GAAA,yBAAA,CAA0B,SACtD,EAAA;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAO,IAAA,EAAA,SAAS,CAAgC,6BAAA,EAAA,SAAS,oBAAoB,SAAS,CAAA,0BAAA;AAAA,OACxF;AAAA;AAGF,IAAO,OAAA;AAAA,MACL,eAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA,MAAA;AAAA,MACA,OAAA;AAAA,MACA,KAAA;AAAA,MACA,iBAAA;AAAA,MACA;AAAA,KACF;AAAA,GACD,KAAK,EAAC;AAEX;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-events-backend-module-aws-sqs",
|
|
3
|
-
"version": "0.4.5
|
|
3
|
+
"version": "0.4.5",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "backend-plugin-module",
|
|
6
6
|
"pluginId": "events",
|
|
@@ -33,10 +33,19 @@
|
|
|
33
33
|
},
|
|
34
34
|
"main": "./dist/index.cjs.js",
|
|
35
35
|
"types": "./dist/index.d.ts",
|
|
36
|
+
"typesVersions": {
|
|
37
|
+
"*": {
|
|
38
|
+
"index": [
|
|
39
|
+
"dist/index.d.ts"
|
|
40
|
+
],
|
|
41
|
+
"alpha": [
|
|
42
|
+
"dist/alpha.d.ts"
|
|
43
|
+
]
|
|
44
|
+
}
|
|
45
|
+
},
|
|
36
46
|
"files": [
|
|
37
47
|
"config.d.ts",
|
|
38
|
-
"dist"
|
|
39
|
-
"alpha"
|
|
48
|
+
"dist"
|
|
40
49
|
],
|
|
41
50
|
"scripts": {
|
|
42
51
|
"build": "backstage-cli package build",
|
|
@@ -49,17 +58,17 @@
|
|
|
49
58
|
},
|
|
50
59
|
"dependencies": {
|
|
51
60
|
"@aws-sdk/client-sqs": "^3.350.0",
|
|
52
|
-
"@backstage/backend-plugin-api": "1.0.2
|
|
53
|
-
"@backstage/config": "1.
|
|
54
|
-
"@backstage/plugin-events-node": "0.4.5
|
|
55
|
-
"@backstage/types": "1.
|
|
61
|
+
"@backstage/backend-plugin-api": "^1.0.2",
|
|
62
|
+
"@backstage/config": "^1.3.0",
|
|
63
|
+
"@backstage/plugin-events-node": "^0.4.5",
|
|
64
|
+
"@backstage/types": "^1.2.0",
|
|
56
65
|
"luxon": "^3.0.0"
|
|
57
66
|
},
|
|
58
67
|
"devDependencies": {
|
|
59
68
|
"@aws-sdk/types": "^3.347.0",
|
|
60
|
-
"@backstage/backend-test-utils": "1.1.0
|
|
61
|
-
"@backstage/cli": "0.29.0
|
|
62
|
-
"@backstage/plugin-events-backend-test-utils": "0.1.38
|
|
69
|
+
"@backstage/backend-test-utils": "^1.1.0",
|
|
70
|
+
"@backstage/cli": "^0.29.0",
|
|
71
|
+
"@backstage/plugin-events-backend-test-utils": "^0.1.38",
|
|
63
72
|
"aws-sdk-client-mock": "^4.0.0"
|
|
64
73
|
},
|
|
65
74
|
"configSchema": "config.d.ts"
|