@blamejs/core 0.7.18 → 0.7.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 +425 -423
- package/README.md +150 -150
- package/bin/blamejs.js +0 -0
- package/index.js +310 -308
- package/lib/api-key.js +660 -660
- package/lib/api-snapshot.js +338 -338
- package/lib/app-shutdown.js +385 -385
- package/lib/app.js +365 -365
- package/lib/archive.js +250 -250
- package/lib/atomic-file.js +544 -544
- package/lib/audit-chain.js +177 -177
- package/lib/audit-sign.js +344 -344
- package/lib/audit-tools.js +677 -677
- package/lib/audit.js +766 -766
- package/lib/auth/jwt-external.js +365 -0
- package/lib/auth/jwt.js +337 -311
- package/lib/auth/lockout.js +436 -436
- package/lib/auth/oauth.js +721 -721
- package/lib/auth/passkey.js +181 -181
- package/lib/auth/password.js +628 -594
- package/lib/backup/bundle.js +217 -217
- package/lib/backup/crypto.js +176 -176
- package/lib/backup/index.js +515 -515
- package/lib/backup/manifest.js +282 -282
- package/lib/break-glass.js +1338 -1338
- package/lib/bundler.js +441 -441
- package/lib/cache-redis.js +256 -256
- package/lib/cache.js +1206 -1206
- package/lib/canonical-json.js +115 -115
- package/lib/chain-writer.js +234 -234
- package/lib/cli-helpers.js +206 -206
- package/lib/cli.js +2334 -2334
- package/lib/cluster-provider-db.js +317 -317
- package/lib/cluster-storage.js +226 -226
- package/lib/cluster.js +703 -703
- package/lib/config-drift.js +301 -301
- package/lib/consent.js +222 -222
- package/lib/constants.js +191 -191
- package/lib/cookies.js +315 -315
- package/lib/credential-hash.js +322 -322
- package/lib/crypto.js +266 -266
- package/lib/csv.js +275 -275
- package/lib/db-declare-row-policy.js +267 -267
- package/lib/db-declare-view.js +420 -420
- package/lib/db-query.js +406 -406
- package/lib/db-schema.js +319 -319
- package/lib/db.js +1288 -1288
- package/lib/deprecate.js +222 -222
- package/lib/dev.js +335 -335
- package/lib/dual-control.js +473 -473
- package/lib/error-page.js +420 -420
- package/lib/external-db-migrate.js +441 -441
- package/lib/external-db.js +1061 -1061
- package/lib/file-type.js +273 -273
- package/lib/forms.js +422 -422
- package/lib/framework-error.js +293 -293
- package/lib/framework-schema.js +717 -717
- package/lib/handlers.js +350 -350
- package/lib/http-client-cookie-jar.js +508 -508
- package/lib/http-client.js +1195 -1195
- package/lib/i18n.js +878 -878
- package/lib/jobs.js +185 -185
- package/lib/log-stream-cloudwatch.js +369 -369
- package/lib/log-stream-local.js +146 -146
- package/lib/log-stream-otlp-grpc.js +410 -410
- package/lib/log-stream-otlp.js +286 -286
- package/lib/log-stream-syslog.js +302 -302
- package/lib/log-stream-webhook.js +199 -199
- package/lib/log-stream.js +330 -330
- package/lib/log.js +500 -500
- package/lib/mail-bounce.js +528 -528
- package/lib/mail-dkim.js +369 -369
- package/lib/mail.js +981 -981
- package/lib/metrics.js +683 -683
- package/lib/middleware/api-encrypt.js +936 -936
- package/lib/middleware/attach-user.js +157 -157
- package/lib/middleware/bearer-auth.js +152 -0
- package/lib/middleware/body-parser.js +1170 -1170
- package/lib/middleware/bot-guard.js +178 -178
- package/lib/middleware/compression.js +452 -452
- package/lib/middleware/cors.js +314 -314
- package/lib/middleware/csp-nonce.js +348 -348
- package/lib/middleware/csrf-protect.js +316 -316
- package/lib/middleware/db-role-for.js +264 -264
- package/lib/middleware/health.js +392 -392
- package/lib/middleware/index.js +82 -79
- package/lib/middleware/rate-limit.js +358 -358
- package/lib/middleware/request-id.js +61 -61
- package/lib/middleware/request-log.js +168 -168
- package/lib/middleware/require-auth.js +104 -104
- package/lib/middleware/security-headers.js +116 -116
- package/lib/middleware/sse.js +166 -166
- package/lib/migrations.js +383 -383
- package/lib/mtls-ca.js +518 -518
- package/lib/mtls-engine-default.js +481 -481
- package/lib/network-dns.js +632 -632
- package/lib/network-heartbeat.js +290 -290
- package/lib/network-nts.js +574 -574
- package/lib/network-proxy.js +265 -265
- package/lib/network-tls.js +328 -328
- package/lib/network.js +233 -233
- package/lib/notify.js +612 -612
- package/lib/ntp-check.js +229 -229
- package/lib/numeric-bounds.js +111 -111
- package/lib/object-store/azure-blob-bucket-ops.js +349 -349
- package/lib/object-store/azure-blob.js +488 -488
- package/lib/object-store/gcs-bucket-ops.js +351 -351
- package/lib/object-store/gcs.js +519 -519
- package/lib/object-store/http-put.js +153 -153
- package/lib/object-store/index.js +197 -197
- package/lib/object-store/sigv4-bucket-ops.js +1092 -1092
- package/lib/object-store/sigv4.js +903 -903
- package/lib/observability.js +151 -151
- package/lib/otel-export.js +269 -269
- package/lib/pagination.js +464 -464
- package/lib/parsers/index.js +80 -80
- package/lib/parsers/safe-env.js +642 -642
- package/lib/parsers/safe-ini.js +292 -292
- package/lib/parsers/safe-toml.js +784 -784
- package/lib/parsers/safe-xml.js +390 -390
- package/lib/parsers/safe-yaml.js +1015 -1015
- package/lib/permissions.js +708 -708
- package/lib/pqc-agent.js +87 -87
- package/lib/pqc-gate.js +279 -279
- package/lib/protobuf-encoder.js +190 -190
- package/lib/protocol-dispatcher.js +161 -161
- package/lib/pubsub-redis.js +167 -167
- package/lib/pubsub.js +429 -429
- package/lib/queue-local.js +476 -476
- package/lib/queue-redis.js +745 -745
- package/lib/queue-sqs.js +319 -319
- package/lib/queue.js +695 -695
- package/lib/redis-client.js +519 -519
- package/lib/request-helpers.js +340 -340
- package/lib/restore-bundle.js +237 -237
- package/lib/restore-rollback.js +259 -259
- package/lib/restore.js +409 -409
- package/lib/retry.js +376 -376
- package/lib/router.js +748 -748
- package/lib/safe-async.js +735 -735
- package/lib/safe-buffer.js +237 -237
- package/lib/safe-json.js +541 -541
- package/lib/safe-schema.js +1266 -1266
- package/lib/safe-url.js +159 -159
- package/lib/scheduler.js +706 -706
- package/lib/security-assert.js +373 -373
- package/lib/seeders.js +618 -618
- package/lib/session.js +535 -478
- package/lib/slug.js +269 -269
- package/lib/ssrf-guard.js +401 -401
- package/lib/storage.js +471 -471
- package/lib/subject.js +281 -281
- package/lib/template.js +791 -791
- package/lib/testing.js +798 -798
- package/lib/time.js +310 -310
- package/lib/totp.js +302 -302
- package/lib/tracing.js +494 -494
- package/lib/uuid.js +132 -132
- package/lib/validate-opts.js +340 -340
- package/lib/vault/index.js +308 -308
- package/lib/vault/rotate.js +784 -784
- package/lib/vault/wrap.js +296 -296
- package/lib/vendor/noble-ciphers.cjs +9 -9
- package/lib/webhook.js +595 -595
- package/lib/websocket.js +1048 -1048
- package/package.json +77 -77
- package/sbom.cyclonedx.json +7 -7
package/lib/queue-sqs.js
CHANGED
|
@@ -1,319 +1,319 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/**
|
|
3
|
-
* AWS SQS queue adapter — backs `b.queue` with Amazon SQS so multi-replica
|
|
4
|
-
* apps share a managed queue without each needing to be cluster leader.
|
|
5
|
-
*
|
|
6
|
-
* Wire protocol — AWSJsonProtocol_1.0 over HTTPS, SigV4-signed via
|
|
7
|
-
* `lib/object-store/sigv4.js`'s service-agnostic `signRequest` helper:
|
|
8
|
-
*
|
|
9
|
-
* POST https://sqs.{region}.amazonaws.com/
|
|
10
|
-
* Content-Type: application/x-amz-json-1.0
|
|
11
|
-
* X-Amz-Target: AmazonSQS.<Action>
|
|
12
|
-
* Authorization: AWS4-HMAC-SHA256 ...
|
|
13
|
-
*
|
|
14
|
-
* Action → SQS API
|
|
15
|
-
* enqueue → SendMessage
|
|
16
|
-
* lease → ReceiveMessage (long-poll up to WaitTimeSeconds)
|
|
17
|
-
* extendLease → ChangeMessageVisibility
|
|
18
|
-
* complete → DeleteMessage
|
|
19
|
-
* fail → ChangeMessageVisibility (VisibilityTimeout=0 → re-deliver
|
|
20
|
-
* immediately) — DLQ routing happens server-side via the
|
|
21
|
-
* queue's RedrivePolicy attribute, configured at queue
|
|
22
|
-
* creation time outside the framework
|
|
23
|
-
* size → GetQueueAttributes(ApproximateNumberOfMessages)
|
|
24
|
-
* purge → PurgeQueue
|
|
25
|
-
*
|
|
26
|
-
* Queue-name → URL: SQS queues live at
|
|
27
|
-
* https://sqs.{region}.amazonaws.com/{accountId}/{queueName}
|
|
28
|
-
* Operators pass `accountId` + `region` and the adapter constructs URLs
|
|
29
|
-
* from the framework's logical queue names. Operators with cross-account
|
|
30
|
-
* queues / FIFO queues / VPCE endpoints pass an explicit
|
|
31
|
-
* `queueUrlByName(name) → url` resolver instead.
|
|
32
|
-
*
|
|
33
|
-
* What this adapter does NOT support (operator wiring required):
|
|
34
|
-
*
|
|
35
|
-
* - DLQ inspection (dlqList / dlqRetry / dlqSize) — SQS DLQs are
|
|
36
|
-
* separate queues; operators using one wire it as a second framework
|
|
37
|
-
* backend and inspect via that backend's `lease()`.
|
|
38
|
-
* - Flow / cron / parent-child dependencies — SQS has no native flow
|
|
39
|
-
* primitives; those stay on queue-local or queue-redis.
|
|
40
|
-
* - sweepExpired — SQS handles visibility-timeout expiry server-side.
|
|
41
|
-
*
|
|
42
|
-
* Sealing: payloads pass through `cryptoField.sealRow("_blamejs_jobs",
|
|
43
|
-
* row)` before SendMessage so the SQS message body is a sealed envelope
|
|
44
|
-
* (operator's vault-key + framework crypto stack), same posture as the
|
|
45
|
-
* local + redis backends.
|
|
46
|
-
*/
|
|
47
|
-
var sigv4 = require("./object-store/sigv4");
|
|
48
|
-
var C = require("./constants");
|
|
49
|
-
var httpClient = require("./http-client");
|
|
50
|
-
var cryptoField = require("./crypto-field");
|
|
51
|
-
var safeJson = require("./safe-json");
|
|
52
|
-
var safeUrl = require("./safe-url");
|
|
53
|
-
var { generateToken } = require("./crypto");
|
|
54
|
-
var { QueueError } = require("./framework-error");
|
|
55
|
-
|
|
56
|
-
var _err = QueueError.factory;
|
|
57
|
-
|
|
58
|
-
var DEFAULT_VISIBILITY_TIMEOUT_SEC = 30;
|
|
59
|
-
var DEFAULT_WAIT_TIME_SEC = 0; // SQS supports up to 20s
|
|
60
|
-
var DEFAULT_MAX_MESSAGES_PER_LEASE = 10; // SQS hard cap
|
|
61
|
-
|
|
62
|
-
function _resolveEndpoint(opts) {
|
|
63
|
-
if (opts.endpoint) return opts.endpoint.replace(/\/+$/, "") + "/";
|
|
64
|
-
return "https://sqs." + opts.region + ".amazonaws.com/";
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
function _payloadHash(buf) {
|
|
68
|
-
// Empty body's payload hash is the SHA256 of the empty string —
|
|
69
|
-
// sigv4 requires the actual hash, not "UNSIGNED-PAYLOAD".
|
|
70
|
-
var nodeCrypto = require("node:crypto");
|
|
71
|
-
return nodeCrypto.createHash("sha256").update(buf || Buffer.alloc(0)).digest("hex");
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
function create(opts) {
|
|
75
|
-
opts = opts || {};
|
|
76
|
-
if (typeof opts.region !== "string" || opts.region.length === 0) {
|
|
77
|
-
throw _err("INVALID_CONFIG", "queue-sqs: opts.region is required", true);
|
|
78
|
-
}
|
|
79
|
-
if (typeof opts.accessKeyId !== "string" || opts.accessKeyId.length === 0) {
|
|
80
|
-
throw _err("INVALID_CONFIG", "queue-sqs: opts.accessKeyId is required", true);
|
|
81
|
-
}
|
|
82
|
-
if (typeof opts.secretAccessKey !== "string" || opts.secretAccessKey.length === 0) {
|
|
83
|
-
throw _err("INVALID_CONFIG", "queue-sqs: opts.secretAccessKey is required", true);
|
|
84
|
-
}
|
|
85
|
-
if (!opts.queueUrlByName && (!opts.accountId ||
|
|
86
|
-
(typeof opts.accountId !== "string" && typeof opts.accountId !== "number"))) {
|
|
87
|
-
throw _err("INVALID_CONFIG",
|
|
88
|
-
"queue-sqs: opts.accountId is required (12-digit AWS account ID) " +
|
|
89
|
-
"or pass opts.queueUrlByName(name) → url for cross-account / VPCE queues", true);
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
var region = opts.region;
|
|
93
|
-
var endpoint = _resolveEndpoint(opts);
|
|
94
|
-
var allowedProtocols = opts.allowedProtocols || safeUrl.ALLOW_HTTP_TLS;
|
|
95
|
-
var endpointUrl = safeUrl.parse(endpoint, {
|
|
96
|
-
errorClass: QueueError,
|
|
97
|
-
allowedProtocols: allowedProtocols,
|
|
98
|
-
});
|
|
99
|
-
var accessKeyId = opts.accessKeyId;
|
|
100
|
-
var secretAccessKey = opts.secretAccessKey;
|
|
101
|
-
var sessionToken = opts.sessionToken || null;
|
|
102
|
-
var accountId = opts.accountId ? String(opts.accountId) : null;
|
|
103
|
-
var timeoutMs = opts.timeoutMs;
|
|
104
|
-
var allowInternal = opts.allowInternal != null ? opts.allowInternal : null;
|
|
105
|
-
var visibilityTimeoutSec = Number(opts.visibilityTimeoutSec) || DEFAULT_VISIBILITY_TIMEOUT_SEC;
|
|
106
|
-
var waitTimeSec = Number(opts.waitTimeSec) || DEFAULT_WAIT_TIME_SEC;
|
|
107
|
-
|
|
108
|
-
var queueUrlResolver = typeof opts.queueUrlByName === "function"
|
|
109
|
-
? opts.queueUrlByName
|
|
110
|
-
: function (name) {
|
|
111
|
-
return endpoint + accountId + "/" + name;
|
|
112
|
-
};
|
|
113
|
-
|
|
114
|
-
function _post(action, body) {
|
|
115
|
-
var bodyBuf = Buffer.from(JSON.stringify(body || {}), "utf8");
|
|
116
|
-
var headers = {
|
|
117
|
-
"Content-Type": "application/x-amz-json-1.0",
|
|
118
|
-
"X-Amz-Target": "AmazonSQS." + action,
|
|
119
|
-
"Content-Length": String(bodyBuf.length),
|
|
120
|
-
};
|
|
121
|
-
var signed = sigv4.signRequest({
|
|
122
|
-
method: "POST",
|
|
123
|
-
url: endpointUrl,
|
|
124
|
-
headers: headers,
|
|
125
|
-
payloadHash: _payloadHash(bodyBuf),
|
|
126
|
-
region: region,
|
|
127
|
-
service: "sqs",
|
|
128
|
-
accessKeyId: accessKeyId,
|
|
129
|
-
secretAccessKey: secretAccessKey,
|
|
130
|
-
sessionToken: sessionToken,
|
|
131
|
-
allowedProtocols: allowedProtocols,
|
|
132
|
-
});
|
|
133
|
-
var reqOpts = {
|
|
134
|
-
method: "POST",
|
|
135
|
-
url: endpointUrl,
|
|
136
|
-
headers: signed.headers,
|
|
137
|
-
body: bodyBuf,
|
|
138
|
-
idleTimeoutMs: timeoutMs,
|
|
139
|
-
allowedProtocols: allowedProtocols,
|
|
140
|
-
errorClass: QueueError,
|
|
141
|
-
};
|
|
142
|
-
if (allowInternal !== null) reqOpts.allowInternal = allowInternal;
|
|
143
|
-
return httpClient.request(reqOpts).then(function (res) {
|
|
144
|
-
var text = Buffer.isBuffer(res.body) ? res.body.toString("utf8")
|
|
145
|
-
: (res.body || "").toString();
|
|
146
|
-
if (text.length === 0) return null;
|
|
147
|
-
try { return safeJson.parse(text); }
|
|
148
|
-
catch (_e) {
|
|
149
|
-
throw _err("BAD_RESPONSE", "queue-sqs: " + action +
|
|
150
|
-
" returned non-JSON body: " + text.slice(0, 500));
|
|
151
|
-
}
|
|
152
|
-
});
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
// ---- enqueue ----
|
|
156
|
-
async function enqueue(queueName, payload, enqueueOpts) {
|
|
157
|
-
enqueueOpts = enqueueOpts || {};
|
|
158
|
-
var queueUrl = queueUrlResolver(queueName);
|
|
159
|
-
var jobId = generateToken(C.BYTES.bytes(16));
|
|
160
|
-
var sealed = cryptoField.sealRow("_blamejs_jobs", {
|
|
161
|
-
_id: jobId,
|
|
162
|
-
queueName: queueName,
|
|
163
|
-
payload: JSON.stringify(payload == null ? null : payload),
|
|
164
|
-
enqueuedAt: Date.now(),
|
|
165
|
-
attempts: 0,
|
|
166
|
-
});
|
|
167
|
-
// SQS message body: serialize the sealed row as JSON. Receive
|
|
168
|
-
// replays the same shape — sealed.payload stays sealed in transit.
|
|
169
|
-
var bodyJson = JSON.stringify(sealed);
|
|
170
|
-
var sqsBody = {
|
|
171
|
-
QueueUrl: queueUrl,
|
|
172
|
-
MessageBody: bodyJson,
|
|
173
|
-
};
|
|
174
|
-
var delaySeconds = enqueueOpts.delaySeconds;
|
|
175
|
-
if (typeof delaySeconds === "number" && delaySeconds > 0) {
|
|
176
|
-
// SQS hard cap is 900s (15 min).
|
|
177
|
-
sqsBody.DelaySeconds = Math.min(C.TIME.minutes(15) / C.TIME.seconds(1), Math.floor(delaySeconds));
|
|
178
|
-
}
|
|
179
|
-
var rv = await _post("SendMessage", sqsBody);
|
|
180
|
-
return rv && (rv.MessageId || jobId);
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
// ---- lease ----
|
|
184
|
-
async function lease(queueName, leaseOpts) {
|
|
185
|
-
leaseOpts = leaseOpts || {};
|
|
186
|
-
var queueUrl = queueUrlResolver(queueName);
|
|
187
|
-
var maxMessages = Math.min(
|
|
188
|
-
DEFAULT_MAX_MESSAGES_PER_LEASE,
|
|
189
|
-
Math.max(1, Number(leaseOpts.maxRows) || 1)
|
|
190
|
-
);
|
|
191
|
-
var visTimeout = Number(leaseOpts.visibilityTimeoutSec) || visibilityTimeoutSec;
|
|
192
|
-
var waitSec = Number(leaseOpts.waitTimeSec) ||
|
|
193
|
-
(waitTimeSec > 0 ? waitTimeSec : DEFAULT_WAIT_TIME_SEC);
|
|
194
|
-
var rv = await _post("ReceiveMessage", {
|
|
195
|
-
QueueUrl: queueUrl,
|
|
196
|
-
MaxNumberOfMessages: maxMessages,
|
|
197
|
-
VisibilityTimeout: visTimeout,
|
|
198
|
-
WaitTimeSeconds: waitSec,
|
|
199
|
-
});
|
|
200
|
-
var messages = (rv && rv.Messages) || [];
|
|
201
|
-
var out = [];
|
|
202
|
-
for (var i = 0; i < messages.length; i++) {
|
|
203
|
-
var m = messages[i];
|
|
204
|
-
var sealed;
|
|
205
|
-
try { sealed = safeJson.parse(m.Body); }
|
|
206
|
-
catch (_e) { continue; }
|
|
207
|
-
var unsealed = cryptoField.unsealRow("_blamejs_jobs", sealed);
|
|
208
|
-
var payload;
|
|
209
|
-
try {
|
|
210
|
-
payload = unsealed.payload != null
|
|
211
|
-
? safeJson.parse(unsealed.payload, { maxBytes: C.BYTES.mib(64) }) : null;
|
|
212
|
-
} catch (_e) { payload = unsealed.payload; }
|
|
213
|
-
out.push({
|
|
214
|
-
jobId: unsealed._id,
|
|
215
|
-
queueName: unsealed.queueName || queueName,
|
|
216
|
-
payload: payload,
|
|
217
|
-
attempts: Number(unsealed.attempts) || 0,
|
|
218
|
-
enqueuedAt: Number(unsealed.enqueuedAt) || null,
|
|
219
|
-
leaseExpiresAt: Date.now() + C.TIME.seconds(visTimeout),
|
|
220
|
-
// SQS-specific: receipt handle is the only way to delete /
|
|
221
|
-
// change visibility / extend — surface it for the framework
|
|
222
|
-
// wrapper.
|
|
223
|
-
receiptHandle: m.ReceiptHandle,
|
|
224
|
-
sqsMessageId: m.MessageId,
|
|
225
|
-
});
|
|
226
|
-
}
|
|
227
|
-
return out;
|
|
228
|
-
}
|
|
229
|
-
|
|
230
|
-
// ---- extendLease ----
|
|
231
|
-
async function extendLease(queueName, jobId, extendOpts) {
|
|
232
|
-
extendOpts = extendOpts || {};
|
|
233
|
-
if (!extendOpts.receiptHandle) {
|
|
234
|
-
throw _err("MISSING_RECEIPT",
|
|
235
|
-
"queue-sqs: extendLease requires opts.receiptHandle (returned by lease())", true);
|
|
236
|
-
}
|
|
237
|
-
var queueUrl = queueUrlResolver(queueName);
|
|
238
|
-
var visTimeout = Number(extendOpts.visibilityTimeoutSec) || visibilityTimeoutSec;
|
|
239
|
-
await _post("ChangeMessageVisibility", {
|
|
240
|
-
QueueUrl: queueUrl,
|
|
241
|
-
ReceiptHandle: extendOpts.receiptHandle,
|
|
242
|
-
VisibilityTimeout: visTimeout,
|
|
243
|
-
});
|
|
244
|
-
return true;
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
// ---- complete ----
|
|
248
|
-
async function complete(queueName, jobId, completeOpts) {
|
|
249
|
-
completeOpts = completeOpts || {};
|
|
250
|
-
if (!completeOpts.receiptHandle) {
|
|
251
|
-
throw _err("MISSING_RECEIPT",
|
|
252
|
-
"queue-sqs: complete requires opts.receiptHandle", true);
|
|
253
|
-
}
|
|
254
|
-
var queueUrl = queueUrlResolver(queueName);
|
|
255
|
-
await _post("DeleteMessage", {
|
|
256
|
-
QueueUrl: queueUrl,
|
|
257
|
-
ReceiptHandle: completeOpts.receiptHandle,
|
|
258
|
-
});
|
|
259
|
-
return true;
|
|
260
|
-
}
|
|
261
|
-
|
|
262
|
-
// ---- fail (request re-delivery; SQS server-side DLQ routing decides
|
|
263
|
-
// if it goes back to the main queue or to the DLQ) ----
|
|
264
|
-
async function fail(queueName, jobId, failOpts) {
|
|
265
|
-
failOpts = failOpts || {};
|
|
266
|
-
if (!failOpts.receiptHandle) {
|
|
267
|
-
throw _err("MISSING_RECEIPT",
|
|
268
|
-
"queue-sqs: fail requires opts.receiptHandle", true);
|
|
269
|
-
}
|
|
270
|
-
var queueUrl = queueUrlResolver(queueName);
|
|
271
|
-
// VisibilityTimeout=0 → message becomes visible to other consumers
|
|
272
|
-
// immediately. SQS's RedrivePolicy on the queue (configured at
|
|
273
|
-
// queue creation) tracks ApproximateReceiveCount and routes to
|
|
274
|
-
// the DLQ once maxReceiveCount is exceeded.
|
|
275
|
-
await _post("ChangeMessageVisibility", {
|
|
276
|
-
QueueUrl: queueUrl,
|
|
277
|
-
ReceiptHandle: failOpts.receiptHandle,
|
|
278
|
-
VisibilityTimeout: 0,
|
|
279
|
-
});
|
|
280
|
-
return true;
|
|
281
|
-
}
|
|
282
|
-
|
|
283
|
-
// ---- size (visible messages only — in-flight and delayed are
|
|
284
|
-
// reported separately by GetQueueAttributes) ----
|
|
285
|
-
async function size(queueName) {
|
|
286
|
-
var queueUrl = queueUrlResolver(queueName);
|
|
287
|
-
var rv = await _post("GetQueueAttributes", {
|
|
288
|
-
QueueUrl: queueUrl,
|
|
289
|
-
AttributeNames: ["ApproximateNumberOfMessages"],
|
|
290
|
-
});
|
|
291
|
-
var attrs = (rv && rv.Attributes) || {};
|
|
292
|
-
return Number(attrs.ApproximateNumberOfMessages) || 0;
|
|
293
|
-
}
|
|
294
|
-
|
|
295
|
-
// ---- purge (60s server-side rate-limited; SQS rejects a second
|
|
296
|
-
// purge within the cooldown window) ----
|
|
297
|
-
async function purge(queueName) {
|
|
298
|
-
var queueUrl = queueUrlResolver(queueName);
|
|
299
|
-
await _post("PurgeQueue", { QueueUrl: queueUrl });
|
|
300
|
-
return 0; // SQS doesn't return a count
|
|
301
|
-
}
|
|
302
|
-
|
|
303
|
-
return {
|
|
304
|
-
enqueue: enqueue,
|
|
305
|
-
lease: lease,
|
|
306
|
-
extendLease: extendLease,
|
|
307
|
-
complete: complete,
|
|
308
|
-
fail: fail,
|
|
309
|
-
size: size,
|
|
310
|
-
purge: purge,
|
|
311
|
-
// Test hook — exposes the signed-request builder for assertion-
|
|
312
|
-
// only verification of wire shape without standing up a mock SQS
|
|
313
|
-
// server.
|
|
314
|
-
_post: _post,
|
|
315
|
-
_queueUrl: queueUrlResolver,
|
|
316
|
-
};
|
|
317
|
-
}
|
|
318
|
-
|
|
319
|
-
module.exports = { create: create };
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* AWS SQS queue adapter — backs `b.queue` with Amazon SQS so multi-replica
|
|
4
|
+
* apps share a managed queue without each needing to be cluster leader.
|
|
5
|
+
*
|
|
6
|
+
* Wire protocol — AWSJsonProtocol_1.0 over HTTPS, SigV4-signed via
|
|
7
|
+
* `lib/object-store/sigv4.js`'s service-agnostic `signRequest` helper:
|
|
8
|
+
*
|
|
9
|
+
* POST https://sqs.{region}.amazonaws.com/
|
|
10
|
+
* Content-Type: application/x-amz-json-1.0
|
|
11
|
+
* X-Amz-Target: AmazonSQS.<Action>
|
|
12
|
+
* Authorization: AWS4-HMAC-SHA256 ...
|
|
13
|
+
*
|
|
14
|
+
* Action → SQS API
|
|
15
|
+
* enqueue → SendMessage
|
|
16
|
+
* lease → ReceiveMessage (long-poll up to WaitTimeSeconds)
|
|
17
|
+
* extendLease → ChangeMessageVisibility
|
|
18
|
+
* complete → DeleteMessage
|
|
19
|
+
* fail → ChangeMessageVisibility (VisibilityTimeout=0 → re-deliver
|
|
20
|
+
* immediately) — DLQ routing happens server-side via the
|
|
21
|
+
* queue's RedrivePolicy attribute, configured at queue
|
|
22
|
+
* creation time outside the framework
|
|
23
|
+
* size → GetQueueAttributes(ApproximateNumberOfMessages)
|
|
24
|
+
* purge → PurgeQueue
|
|
25
|
+
*
|
|
26
|
+
* Queue-name → URL: SQS queues live at
|
|
27
|
+
* https://sqs.{region}.amazonaws.com/{accountId}/{queueName}
|
|
28
|
+
* Operators pass `accountId` + `region` and the adapter constructs URLs
|
|
29
|
+
* from the framework's logical queue names. Operators with cross-account
|
|
30
|
+
* queues / FIFO queues / VPCE endpoints pass an explicit
|
|
31
|
+
* `queueUrlByName(name) → url` resolver instead.
|
|
32
|
+
*
|
|
33
|
+
* What this adapter does NOT support (operator wiring required):
|
|
34
|
+
*
|
|
35
|
+
* - DLQ inspection (dlqList / dlqRetry / dlqSize) — SQS DLQs are
|
|
36
|
+
* separate queues; operators using one wire it as a second framework
|
|
37
|
+
* backend and inspect via that backend's `lease()`.
|
|
38
|
+
* - Flow / cron / parent-child dependencies — SQS has no native flow
|
|
39
|
+
* primitives; those stay on queue-local or queue-redis.
|
|
40
|
+
* - sweepExpired — SQS handles visibility-timeout expiry server-side.
|
|
41
|
+
*
|
|
42
|
+
* Sealing: payloads pass through `cryptoField.sealRow("_blamejs_jobs",
|
|
43
|
+
* row)` before SendMessage so the SQS message body is a sealed envelope
|
|
44
|
+
* (operator's vault-key + framework crypto stack), same posture as the
|
|
45
|
+
* local + redis backends.
|
|
46
|
+
*/
|
|
47
|
+
var sigv4 = require("./object-store/sigv4");
|
|
48
|
+
var C = require("./constants");
|
|
49
|
+
var httpClient = require("./http-client");
|
|
50
|
+
var cryptoField = require("./crypto-field");
|
|
51
|
+
var safeJson = require("./safe-json");
|
|
52
|
+
var safeUrl = require("./safe-url");
|
|
53
|
+
var { generateToken } = require("./crypto");
|
|
54
|
+
var { QueueError } = require("./framework-error");
|
|
55
|
+
|
|
56
|
+
var _err = QueueError.factory;
|
|
57
|
+
|
|
58
|
+
var DEFAULT_VISIBILITY_TIMEOUT_SEC = 30;
|
|
59
|
+
var DEFAULT_WAIT_TIME_SEC = 0; // SQS supports up to 20s
|
|
60
|
+
var DEFAULT_MAX_MESSAGES_PER_LEASE = 10; // SQS hard cap
|
|
61
|
+
|
|
62
|
+
function _resolveEndpoint(opts) {
|
|
63
|
+
if (opts.endpoint) return opts.endpoint.replace(/\/+$/, "") + "/";
|
|
64
|
+
return "https://sqs." + opts.region + ".amazonaws.com/";
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
function _payloadHash(buf) {
|
|
68
|
+
// Empty body's payload hash is the SHA256 of the empty string —
|
|
69
|
+
// sigv4 requires the actual hash, not "UNSIGNED-PAYLOAD".
|
|
70
|
+
var nodeCrypto = require("node:crypto");
|
|
71
|
+
return nodeCrypto.createHash("sha256").update(buf || Buffer.alloc(0)).digest("hex");
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
function create(opts) {
|
|
75
|
+
opts = opts || {};
|
|
76
|
+
if (typeof opts.region !== "string" || opts.region.length === 0) {
|
|
77
|
+
throw _err("INVALID_CONFIG", "queue-sqs: opts.region is required", true);
|
|
78
|
+
}
|
|
79
|
+
if (typeof opts.accessKeyId !== "string" || opts.accessKeyId.length === 0) {
|
|
80
|
+
throw _err("INVALID_CONFIG", "queue-sqs: opts.accessKeyId is required", true);
|
|
81
|
+
}
|
|
82
|
+
if (typeof opts.secretAccessKey !== "string" || opts.secretAccessKey.length === 0) {
|
|
83
|
+
throw _err("INVALID_CONFIG", "queue-sqs: opts.secretAccessKey is required", true);
|
|
84
|
+
}
|
|
85
|
+
if (!opts.queueUrlByName && (!opts.accountId ||
|
|
86
|
+
(typeof opts.accountId !== "string" && typeof opts.accountId !== "number"))) {
|
|
87
|
+
throw _err("INVALID_CONFIG",
|
|
88
|
+
"queue-sqs: opts.accountId is required (12-digit AWS account ID) " +
|
|
89
|
+
"or pass opts.queueUrlByName(name) → url for cross-account / VPCE queues", true);
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
var region = opts.region;
|
|
93
|
+
var endpoint = _resolveEndpoint(opts);
|
|
94
|
+
var allowedProtocols = opts.allowedProtocols || safeUrl.ALLOW_HTTP_TLS;
|
|
95
|
+
var endpointUrl = safeUrl.parse(endpoint, {
|
|
96
|
+
errorClass: QueueError,
|
|
97
|
+
allowedProtocols: allowedProtocols,
|
|
98
|
+
});
|
|
99
|
+
var accessKeyId = opts.accessKeyId;
|
|
100
|
+
var secretAccessKey = opts.secretAccessKey;
|
|
101
|
+
var sessionToken = opts.sessionToken || null;
|
|
102
|
+
var accountId = opts.accountId ? String(opts.accountId) : null;
|
|
103
|
+
var timeoutMs = opts.timeoutMs;
|
|
104
|
+
var allowInternal = opts.allowInternal != null ? opts.allowInternal : null;
|
|
105
|
+
var visibilityTimeoutSec = Number(opts.visibilityTimeoutSec) || DEFAULT_VISIBILITY_TIMEOUT_SEC;
|
|
106
|
+
var waitTimeSec = Number(opts.waitTimeSec) || DEFAULT_WAIT_TIME_SEC;
|
|
107
|
+
|
|
108
|
+
var queueUrlResolver = typeof opts.queueUrlByName === "function"
|
|
109
|
+
? opts.queueUrlByName
|
|
110
|
+
: function (name) {
|
|
111
|
+
return endpoint + accountId + "/" + name;
|
|
112
|
+
};
|
|
113
|
+
|
|
114
|
+
function _post(action, body) {
|
|
115
|
+
var bodyBuf = Buffer.from(JSON.stringify(body || {}), "utf8");
|
|
116
|
+
var headers = {
|
|
117
|
+
"Content-Type": "application/x-amz-json-1.0",
|
|
118
|
+
"X-Amz-Target": "AmazonSQS." + action,
|
|
119
|
+
"Content-Length": String(bodyBuf.length),
|
|
120
|
+
};
|
|
121
|
+
var signed = sigv4.signRequest({
|
|
122
|
+
method: "POST",
|
|
123
|
+
url: endpointUrl,
|
|
124
|
+
headers: headers,
|
|
125
|
+
payloadHash: _payloadHash(bodyBuf),
|
|
126
|
+
region: region,
|
|
127
|
+
service: "sqs",
|
|
128
|
+
accessKeyId: accessKeyId,
|
|
129
|
+
secretAccessKey: secretAccessKey,
|
|
130
|
+
sessionToken: sessionToken,
|
|
131
|
+
allowedProtocols: allowedProtocols,
|
|
132
|
+
});
|
|
133
|
+
var reqOpts = {
|
|
134
|
+
method: "POST",
|
|
135
|
+
url: endpointUrl,
|
|
136
|
+
headers: signed.headers,
|
|
137
|
+
body: bodyBuf,
|
|
138
|
+
idleTimeoutMs: timeoutMs,
|
|
139
|
+
allowedProtocols: allowedProtocols,
|
|
140
|
+
errorClass: QueueError,
|
|
141
|
+
};
|
|
142
|
+
if (allowInternal !== null) reqOpts.allowInternal = allowInternal;
|
|
143
|
+
return httpClient.request(reqOpts).then(function (res) {
|
|
144
|
+
var text = Buffer.isBuffer(res.body) ? res.body.toString("utf8")
|
|
145
|
+
: (res.body || "").toString();
|
|
146
|
+
if (text.length === 0) return null;
|
|
147
|
+
try { return safeJson.parse(text); }
|
|
148
|
+
catch (_e) {
|
|
149
|
+
throw _err("BAD_RESPONSE", "queue-sqs: " + action +
|
|
150
|
+
" returned non-JSON body: " + text.slice(0, 500));
|
|
151
|
+
}
|
|
152
|
+
});
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
// ---- enqueue ----
|
|
156
|
+
async function enqueue(queueName, payload, enqueueOpts) {
|
|
157
|
+
enqueueOpts = enqueueOpts || {};
|
|
158
|
+
var queueUrl = queueUrlResolver(queueName);
|
|
159
|
+
var jobId = generateToken(C.BYTES.bytes(16));
|
|
160
|
+
var sealed = cryptoField.sealRow("_blamejs_jobs", {
|
|
161
|
+
_id: jobId,
|
|
162
|
+
queueName: queueName,
|
|
163
|
+
payload: JSON.stringify(payload == null ? null : payload),
|
|
164
|
+
enqueuedAt: Date.now(),
|
|
165
|
+
attempts: 0,
|
|
166
|
+
});
|
|
167
|
+
// SQS message body: serialize the sealed row as JSON. Receive
|
|
168
|
+
// replays the same shape — sealed.payload stays sealed in transit.
|
|
169
|
+
var bodyJson = JSON.stringify(sealed);
|
|
170
|
+
var sqsBody = {
|
|
171
|
+
QueueUrl: queueUrl,
|
|
172
|
+
MessageBody: bodyJson,
|
|
173
|
+
};
|
|
174
|
+
var delaySeconds = enqueueOpts.delaySeconds;
|
|
175
|
+
if (typeof delaySeconds === "number" && delaySeconds > 0) {
|
|
176
|
+
// SQS hard cap is 900s (15 min).
|
|
177
|
+
sqsBody.DelaySeconds = Math.min(C.TIME.minutes(15) / C.TIME.seconds(1), Math.floor(delaySeconds));
|
|
178
|
+
}
|
|
179
|
+
var rv = await _post("SendMessage", sqsBody);
|
|
180
|
+
return rv && (rv.MessageId || jobId);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
// ---- lease ----
|
|
184
|
+
async function lease(queueName, leaseOpts) {
|
|
185
|
+
leaseOpts = leaseOpts || {};
|
|
186
|
+
var queueUrl = queueUrlResolver(queueName);
|
|
187
|
+
var maxMessages = Math.min(
|
|
188
|
+
DEFAULT_MAX_MESSAGES_PER_LEASE,
|
|
189
|
+
Math.max(1, Number(leaseOpts.maxRows) || 1)
|
|
190
|
+
);
|
|
191
|
+
var visTimeout = Number(leaseOpts.visibilityTimeoutSec) || visibilityTimeoutSec;
|
|
192
|
+
var waitSec = Number(leaseOpts.waitTimeSec) ||
|
|
193
|
+
(waitTimeSec > 0 ? waitTimeSec : DEFAULT_WAIT_TIME_SEC);
|
|
194
|
+
var rv = await _post("ReceiveMessage", {
|
|
195
|
+
QueueUrl: queueUrl,
|
|
196
|
+
MaxNumberOfMessages: maxMessages,
|
|
197
|
+
VisibilityTimeout: visTimeout,
|
|
198
|
+
WaitTimeSeconds: waitSec,
|
|
199
|
+
});
|
|
200
|
+
var messages = (rv && rv.Messages) || [];
|
|
201
|
+
var out = [];
|
|
202
|
+
for (var i = 0; i < messages.length; i++) {
|
|
203
|
+
var m = messages[i];
|
|
204
|
+
var sealed;
|
|
205
|
+
try { sealed = safeJson.parse(m.Body); }
|
|
206
|
+
catch (_e) { continue; }
|
|
207
|
+
var unsealed = cryptoField.unsealRow("_blamejs_jobs", sealed);
|
|
208
|
+
var payload;
|
|
209
|
+
try {
|
|
210
|
+
payload = unsealed.payload != null
|
|
211
|
+
? safeJson.parse(unsealed.payload, { maxBytes: C.BYTES.mib(64) }) : null;
|
|
212
|
+
} catch (_e) { payload = unsealed.payload; }
|
|
213
|
+
out.push({
|
|
214
|
+
jobId: unsealed._id,
|
|
215
|
+
queueName: unsealed.queueName || queueName,
|
|
216
|
+
payload: payload,
|
|
217
|
+
attempts: Number(unsealed.attempts) || 0,
|
|
218
|
+
enqueuedAt: Number(unsealed.enqueuedAt) || null,
|
|
219
|
+
leaseExpiresAt: Date.now() + C.TIME.seconds(visTimeout),
|
|
220
|
+
// SQS-specific: receipt handle is the only way to delete /
|
|
221
|
+
// change visibility / extend — surface it for the framework
|
|
222
|
+
// wrapper.
|
|
223
|
+
receiptHandle: m.ReceiptHandle,
|
|
224
|
+
sqsMessageId: m.MessageId,
|
|
225
|
+
});
|
|
226
|
+
}
|
|
227
|
+
return out;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
// ---- extendLease ----
|
|
231
|
+
async function extendLease(queueName, jobId, extendOpts) {
|
|
232
|
+
extendOpts = extendOpts || {};
|
|
233
|
+
if (!extendOpts.receiptHandle) {
|
|
234
|
+
throw _err("MISSING_RECEIPT",
|
|
235
|
+
"queue-sqs: extendLease requires opts.receiptHandle (returned by lease())", true);
|
|
236
|
+
}
|
|
237
|
+
var queueUrl = queueUrlResolver(queueName);
|
|
238
|
+
var visTimeout = Number(extendOpts.visibilityTimeoutSec) || visibilityTimeoutSec;
|
|
239
|
+
await _post("ChangeMessageVisibility", {
|
|
240
|
+
QueueUrl: queueUrl,
|
|
241
|
+
ReceiptHandle: extendOpts.receiptHandle,
|
|
242
|
+
VisibilityTimeout: visTimeout,
|
|
243
|
+
});
|
|
244
|
+
return true;
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
// ---- complete ----
|
|
248
|
+
async function complete(queueName, jobId, completeOpts) {
|
|
249
|
+
completeOpts = completeOpts || {};
|
|
250
|
+
if (!completeOpts.receiptHandle) {
|
|
251
|
+
throw _err("MISSING_RECEIPT",
|
|
252
|
+
"queue-sqs: complete requires opts.receiptHandle", true);
|
|
253
|
+
}
|
|
254
|
+
var queueUrl = queueUrlResolver(queueName);
|
|
255
|
+
await _post("DeleteMessage", {
|
|
256
|
+
QueueUrl: queueUrl,
|
|
257
|
+
ReceiptHandle: completeOpts.receiptHandle,
|
|
258
|
+
});
|
|
259
|
+
return true;
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
// ---- fail (request re-delivery; SQS server-side DLQ routing decides
|
|
263
|
+
// if it goes back to the main queue or to the DLQ) ----
|
|
264
|
+
async function fail(queueName, jobId, failOpts) {
|
|
265
|
+
failOpts = failOpts || {};
|
|
266
|
+
if (!failOpts.receiptHandle) {
|
|
267
|
+
throw _err("MISSING_RECEIPT",
|
|
268
|
+
"queue-sqs: fail requires opts.receiptHandle", true);
|
|
269
|
+
}
|
|
270
|
+
var queueUrl = queueUrlResolver(queueName);
|
|
271
|
+
// VisibilityTimeout=0 → message becomes visible to other consumers
|
|
272
|
+
// immediately. SQS's RedrivePolicy on the queue (configured at
|
|
273
|
+
// queue creation) tracks ApproximateReceiveCount and routes to
|
|
274
|
+
// the DLQ once maxReceiveCount is exceeded.
|
|
275
|
+
await _post("ChangeMessageVisibility", {
|
|
276
|
+
QueueUrl: queueUrl,
|
|
277
|
+
ReceiptHandle: failOpts.receiptHandle,
|
|
278
|
+
VisibilityTimeout: 0,
|
|
279
|
+
});
|
|
280
|
+
return true;
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
// ---- size (visible messages only — in-flight and delayed are
|
|
284
|
+
// reported separately by GetQueueAttributes) ----
|
|
285
|
+
async function size(queueName) {
|
|
286
|
+
var queueUrl = queueUrlResolver(queueName);
|
|
287
|
+
var rv = await _post("GetQueueAttributes", {
|
|
288
|
+
QueueUrl: queueUrl,
|
|
289
|
+
AttributeNames: ["ApproximateNumberOfMessages"],
|
|
290
|
+
});
|
|
291
|
+
var attrs = (rv && rv.Attributes) || {};
|
|
292
|
+
return Number(attrs.ApproximateNumberOfMessages) || 0;
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
// ---- purge (60s server-side rate-limited; SQS rejects a second
|
|
296
|
+
// purge within the cooldown window) ----
|
|
297
|
+
async function purge(queueName) {
|
|
298
|
+
var queueUrl = queueUrlResolver(queueName);
|
|
299
|
+
await _post("PurgeQueue", { QueueUrl: queueUrl });
|
|
300
|
+
return 0; // SQS doesn't return a count
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
return {
|
|
304
|
+
enqueue: enqueue,
|
|
305
|
+
lease: lease,
|
|
306
|
+
extendLease: extendLease,
|
|
307
|
+
complete: complete,
|
|
308
|
+
fail: fail,
|
|
309
|
+
size: size,
|
|
310
|
+
purge: purge,
|
|
311
|
+
// Test hook — exposes the signed-request builder for assertion-
|
|
312
|
+
// only verification of wire shape without standing up a mock SQS
|
|
313
|
+
// server.
|
|
314
|
+
_post: _post,
|
|
315
|
+
_queueUrl: queueUrlResolver,
|
|
316
|
+
};
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
module.exports = { create: create };
|