Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

fix(storage): time out an S3 delete that never settles

Yudhi Armyndharis336c8c168e6c
diff --git a/src/common/storage/storage.service.s3-reprobe.spec.ts b/src/common/storage/storage.service.s3-reprobe.spec.ts
index 3050fb6fe..579e710a7 100644
--- a/src/common/storage/storage.service.s3-reprobe.spec.ts
+++ b/src/common/storage/storage.service.s3-reprobe.spec.ts
@@ -32,7 +32,7 @@ import {
HeadBucketCommand,
ListObjectsV2Command,
} from '@aws-sdk/client-s3';
-import { DEFAULT_S3_REPROBE_INTERVAL_MS, StorageService } from './storage.service';
+import { DEFAULT_S3_REPROBE_INTERVAL_MS, S3_DELETE_TIMEOUT_MS, StorageService } from './storage.service';
const ENV_KEYS = [
'S3_ENDPOINT',
@@ -360,6 +360,38 @@ describe('StorageService S3 re-probe and recovery', () => {
expect(deleteCalls.length).toBe(1);
});
+ it('deleteFile rejects once a DeleteObject that never settles hits its timeout', async () => {
+ // A hung delete used to await forever, holding the retention purges' single-flight guard so no
+ // purge ran again until a restart. The SDK's HTTP handler rejects when the abort signal fires.
+ mockSend.mockImplementation((cmd: unknown, options?: { abortSignal?: AbortSignal }) => {
+ if (!(cmd instanceof DeleteObjectCommand)) return Promise.resolve({});
+ return new Promise((_resolve, reject) => {
+ options?.abortSignal?.addEventListener('abort', () => reject(s3Error('AbortError')));
+ });
+ });
+ // AbortSignal.timeout runs on Node's internal timers, which fake timers do not reach.
+ const timeout = jest.spyOn(AbortSignal, 'timeout').mockImplementation((ms: number) => {
+ const controller = new AbortController();
+ setTimeout(() => controller.abort(), ms);
+ return controller.signal;
+ });
+ try {
+ const svc = new StorageService(makeConfig());
+ await flush();
+
+ const outcome = svc.deleteFile('hung.bin').then(
+ () => 'resolved',
+ (error: Error) => error.name,
+ );
+ await jest.advanceTimersByTimeAsync(S3_DELETE_TIMEOUT_MS - 1);
+ await expect(Promise.race([outcome, Promise.resolve('pending')])).resolves.toBe('pending');
+ await jest.advanceTimersByTimeAsync(1);
+ await expect(outcome).resolves.toBe('AbortError');
+ } finally {
+ timeout.mockRestore();
+ }
+ });
+
it('listFiles unions S3 objects with the local fallback dir (each key once)', async () => {
mockSend.mockImplementation((cmd: unknown) => {
if (cmd instanceof ListObjectsV2Command) {
diff --git a/src/common/storage/storage.service.ts b/src/common/storage/storage.service.ts
index 8b5be5f8d..059d6e868 100644
--- a/src/common/storage/storage.service.ts
+++ b/src/common/storage/storage.service.ts
@@ -40,6 +40,12 @@ interface S3Config {
/** How often an S3-configured service re-probes a bucket that was unreachable at boot. */
export const DEFAULT_S3_REPROBE_INTERVAL_MS = 60_000;
+/**
+ * Cap on one S3 DeleteObject. The retention purges delete row by row behind a single-flight guard,
+ * so a delete that never settles would hold that guard and stop every later purge until a restart.
+ */
+export const S3_DELETE_TIMEOUT_MS = 30_000;
+
function positiveIntFromEnv(name: string, fallback: number): number {
const parsed = Number.parseInt(process.env[name] ?? '', 10);
return Number.isInteger(parsed) && parsed > 0 ? parsed : fallback;
@@ -595,6 +601,7 @@ export class StorageService implements OnModuleDestroy {
Bucket: this.s3Bucket,
Key: `${this.s3KeyRoot}${filePath}`,
}),
+ { abortSignal: AbortSignal.timeout(S3_DELETE_TIMEOUT_MS) },
);
}
}