Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

fix(config): validate the chat-media, status and S3 timer knobs at boot

Yudhi Armyndharisb20e0c44faeb
diff --git a/src/config/env.validation.spec.ts b/src/config/env.validation.spec.ts
index 298fb5f5a..e2256faa0 100644
--- a/src/config/env.validation.spec.ts
+++ b/src/config/env.validation.spec.ts
@@ -499,4 +499,35 @@ describe('validateEnv', () => {
expect(() => validateEnv({ MEDIA_CONVERSION_TIMEOUT_MS: 'abc' })).toThrow(/positive integer/);
expect(() => validateEnv({ MEDIA_CONVERSION_MAX_OUTPUT_BYTES: '52428800' })).not.toThrow();
});
+
+ // Read with parseInt and a `> 0` guard, so `1h` became a 1 ms sweep interval rather than the default.
+ it.each([
+ 'CHAT_MEDIA_ARCHIVE_MAX_BYTES',
+ 'CHAT_MEDIA_ORPHAN_SWEEP_INTERVAL_MS',
+ 'CHAT_MEDIA_ORPHAN_GRACE_MS',
+ 'STATUS_MEDIA_MAX_BYTES',
+ 'STATUS_ORPHAN_SWEEP_INTERVAL_MS',
+ 'STATUS_ORPHAN_GRACE_MS',
+ 'S3_REPROBE_INTERVAL_MS',
+ ])('rejects a unit-suffixed or non-positive %s and accepts a plain count', key => {
+ expect(() => validateEnv({ [key]: '1h' })).toThrow(new RegExp(`${key} must be a positive integer`));
+ expect(() => validateEnv({ [key]: '0' })).toThrow(new RegExp(`${key} must be a positive integer`));
+ expect(() => validateEnv({ [key]: '3600000' })).not.toThrow();
+ });
+
+ it('rejects a unit-suffixed CHAT_MEDIA_ARCHIVE_TTL_DAYS but keeps 0 (keep forever)', () => {
+ expect(() => validateEnv({ CHAT_MEDIA_ARCHIVE_TTL_DAYS: '30d' })).toThrow(/CHAT_MEDIA_ARCHIVE_TTL_DAYS/);
+ expect(() => validateEnv({ CHAT_MEDIA_ARCHIVE_TTL_DAYS: '0' })).not.toThrow();
+ });
+
+ // Node fires a timer delay above 2^31-1 ms after 1 ms, so these would spin instead of waiting.
+ it.each([
+ 'MEDIA_CONVERSION_TIMEOUT_MS',
+ 'CHAT_MEDIA_ORPHAN_SWEEP_INTERVAL_MS',
+ 'STATUS_ORPHAN_SWEEP_INTERVAL_MS',
+ 'S3_REPROBE_INTERVAL_MS',
+ ])('rejects a %s above the Node timer ceiling', key => {
+ expect(() => validateEnv({ [key]: '2147483648' })).toThrow(new RegExp(`${key} must not exceed 2147483647 ms`));
+ expect(() => validateEnv({ [key]: '2147483647' })).not.toThrow();
+ });
});
diff --git a/src/config/env.validation.ts b/src/config/env.validation.ts
index 3c4758300..0993658a3 100644
--- a/src/config/env.validation.ts
+++ b/src/config/env.validation.ts
@@ -210,6 +210,7 @@ export function validateEnv(config: EnvConfig): EnvConfig {
'WEBHOOK_MEDIA_INLINE_MAX_BYTES', // 0 = never inline media
'EXPORT_INLINE_MEDIA_BUDGET_BYTES', // 0 = a data export carries no inline media at all
'MESSAGE_LIST_INLINE_MEDIA_BUDGET_BYTES', // 0 = a message list carries no inline media at all
+ 'CHAT_MEDIA_ARCHIVE_TTL_DAYS', // 0 = keep archived chat media forever
]) {
checkNonNegativeInt(key);
}
@@ -315,6 +316,14 @@ export function validateEnv(config: EnvConfig): EnvConfig {
'MEDIA_DOWNLOAD_TIMEOUT_MS',
'INBOUND_MEDIA_CONCURRENCY',
'CHAT_HISTORY_MEDIA_BUDGET_BYTES',
+ // Same parseInt read: `1h` became a 1 ms orphan sweep, re-walking all stored media every tick.
+ 'CHAT_MEDIA_ARCHIVE_MAX_BYTES',
+ 'CHAT_MEDIA_ORPHAN_SWEEP_INTERVAL_MS',
+ 'CHAT_MEDIA_ORPHAN_GRACE_MS',
+ 'STATUS_MEDIA_MAX_BYTES',
+ 'STATUS_ORPHAN_SWEEP_INTERVAL_MS',
+ 'STATUS_ORPHAN_GRACE_MS',
+ 'S3_REPROBE_INTERVAL_MS',
]) {
checkPositiveInt(key);
}
@@ -322,13 +331,20 @@ export function validateEnv(config: EnvConfig): EnvConfig {
// The ceiling matters for the same reason from the other side: the docs forbid 0, so an operator
// who wants an effectively unlimited budget reaches for a row of nines. Rejected at boot rather
// than clamped, so they learn the value they wrote is not the value they would have got.
- {
- const raw = str('PUPPETEER_PROTOCOL_TIMEOUT_MS');
+ // Every knob below becomes a timer delay, where Node's overflow turns a long wait into a 1 ms spin.
+ for (const [key, consequence] of [
+ ['PUPPETEER_PROTOCOL_TIMEOUT_MS', 'the browser never finishes launching'],
+ ['MEDIA_CONVERSION_TIMEOUT_MS', 'every conversion is killed as timed out'],
+ ['CHAT_MEDIA_ORPHAN_SWEEP_INTERVAL_MS', 'the orphan sweep reruns every millisecond'],
+ ['STATUS_ORPHAN_SWEEP_INTERVAL_MS', 'the orphan sweep reruns every millisecond'],
+ ['S3_REPROBE_INTERVAL_MS', 'S3 is re-probed every millisecond while it is down'],
+ ]) {
+ const raw = str(key);
const n = raw !== undefined && DECIMAL_INTEGER.test(raw) ? Number(raw) : NaN;
if (Number.isInteger(n) && n > MAX_TIMER_MS) {
errors.push(
- `PUPPETEER_PROTOCOL_TIMEOUT_MS must not exceed ${MAX_TIMER_MS} ms (got "${raw}"): Node's ` +
- `timers overflow above that and fire after 1 ms, so the browser never finishes launching`,
+ `${key} must not exceed ${MAX_TIMER_MS} ms (got "${raw}"): Node's ` +
+ `timers overflow above that and fire after 1 ms, so ${consequence}`,
);
}
}