Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions utils/s3/__tests__/s3.service.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,40 @@ describe("S3Service", () => {
});
});

describe("missing keys", () => {
const missing = () => Object.assign(new Error("Key not found"), { name: "NoSuchKey" });

it("still throws the wrapped error but logs a warning, not an error", async () => {
mockS3Client.send.mockRejectedValue(missing());
const errorLog = jest.spyOn((service as any).logger, "error").mockImplementation();
const warnLog = jest.spyOn((service as any).logger, "warn").mockImplementation();

await expect(service.getFileBuffer("my-bucket", "a/voice.json")).rejects.toThrow(
"S3 error: Key not found"
);
expect(errorLog).not.toHaveBeenCalled();
expect(warnLog).toHaveBeenCalledWith("File not found my-bucket/a/voice.json");
});

it("treats a 404 response the same way for streams", async () => {
mockS3Client.send.mockRejectedValue(
Object.assign(new Error("boom"), { $metadata: { httpStatusCode: 404 } })
);
const errorLog = jest.spyOn((service as any).logger, "error").mockImplementation();

await expect(service.getFileStream("my-bucket", "x")).rejects.toThrow("S3 error: boom");
expect(errorLog).not.toHaveBeenCalled();
});

it("keeps logging real failures as errors", async () => {
mockS3Client.send.mockRejectedValue(new Error("Timeout"));
const errorLog = jest.spyOn((service as any).logger, "error").mockImplementation();

await expect(service.getFileBuffer("my-bucket", "x")).rejects.toThrow("S3 error: Timeout");
expect(errorLog).toHaveBeenCalledTimes(1);
});
});

describe("listFiles", () => {
it("should send a ListObjectsV2Command with bucket and prefix", async () => {
mockS3Client.send.mockResolvedValue({ Contents: [] });
Expand Down
25 changes: 23 additions & 2 deletions utils/s3/s3.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@ import { Readable } from "stream";

export const S3_CLIENT = Symbol("S3_CLIENT");

/**
* A missing object is an expected outcome for callers that probe for optional files
* (e.g. "is there a stored take yet?"), not a server failure.
*/
function isMissingKey(error: any): boolean {
return (
error?.name === "NoSuchKey" ||
error?.name === "NotFound" ||
error?.$metadata?.httpStatusCode === 404 ||
/key not found|does not exist/i.test(error?.message ?? "")
);
}

export interface S3ObjectSummary {
key: string;
size?: number;
Expand Down Expand Up @@ -41,7 +54,7 @@ export class S3Service {
try {
return await this.getObjectStream(bucket, key);
} catch (error) {
this.logger.error(`Failed to get file stream ${bucket}/${key}: ${error.message}`, error.stack);
this.logFetchFailure("file stream", bucket, key, error);
throw new Error(`S3 error: ${error.message}`);
}
}
Expand All @@ -54,7 +67,7 @@ export class S3Service {
const stream = await this.getObjectStream(bucket, key);
return await streamToBuffer(stream);
} catch (error) {
this.logger.error(`Failed to get file buffer ${bucket}/${key}: ${error.message}`, error.stack);
this.logFetchFailure("file buffer", bucket, key, error);
throw new Error(`S3 error: ${error.message}`);
}
}
Expand Down Expand Up @@ -95,6 +108,14 @@ export class S3Service {
}
}

private logFetchFailure(what: string, bucket: string, key: string, error: any): void {
if (isMissingKey(error)) {
this.logger.warn(`File not found ${bucket}/${key}`);
return;
}
this.logger.error(`Failed to get ${what} ${bucket}/${key}: ${error.message}`, error.stack);
}

private async getObjectStream(bucket: string, key: string): Promise<Readable> {
const response = await this.s3Client.send(new GetObjectCommand({ Bucket: bucket, Key: key }));
return response.Body as Readable;
Expand Down
Loading