fix(s3): do not include body in GET or HEAD requests

Author: sam-goodwin

src/protocols/rest-xml.ts

@@ -1,12 +1,11 @@
-import * as FastCheck from "effect/FastCheck";
+import * as Stream from "effect/Stream";
+import { XMLBuilder, XMLParser } from "fast-xml-parser";
 import type { ServiceMetadata } from "../client.ts";
 import type {
   ParsedError,
   ProtocolHandler,
   ProtocolRequest,
 } from "./interface.ts";
-import { XMLBuilder, XMLParser } from "fast-xml-parser";
-import * as Stream from "effect/Stream";
 
 type Writeable<T> = { -readonly [P in keyof T]: T[P] };
 
@@ -31,18 +30,24 @@ export class RestXmlHandler implements ProtocolHandler {
       string,
     ];
 
+    const hasBody = method !== "GET" && method !== "HEAD";
+
     const request: Writeable<ProtocolRequest> = {
       path: urlTemplate,
       method,
       headers: {
-        "Content-Type":
-          operationMeta?.inputTraits?.Body === "httpStreaming"
-            ? "application/octet-stream"
-            : this.contentType,
         "User-Agent": "itty-aws",
       },
     };
 
+    // Only set Content-Type for methods that have a body
+    if (hasBody) {
+      request.headers["Content-Type"] =
+        operationMeta?.inputTraits?.Body === "httpStreaming"
+          ? "application/octet-stream"
+          : this.contentType;
+    }
+
     let body: Record<string, unknown> = {};
     let streamingBody = false;
 
@@ -63,7 +68,8 @@ export class RestXmlHandler implements ProtocolHandler {
       }
     }
 
-    if (!streamingBody) {
+    // Only set body for methods that support it
+    if (!streamingBody && hasBody) {
       request.body = builder.build(body);
     }
 

test/smoke/s3.test.ts

@@ -1,10 +1,10 @@
 import { fromNodeProviderChain } from "@aws-sdk/credential-providers";
-import { describe, expect, it } from "@effect/vitest";
-import { Console, Effect, Stream } from "effect";
-import { S3 } from "../../src/services/s3/index.ts";
 import { FileSystem } from "@effect/platform";
 import { NodeFileSystem } from "@effect/platform-node";
+import { describe, expect, it } from "@effect/vitest";
+import { Console, Effect, Stream } from "effect";
 import path from "pathe";
+import { S3 } from "../../src/services/s3/index.ts";
 
 const credentials = await fromNodeProviderChain()();
 
@@ -55,4 +55,42 @@ describe("S3 Smoke Tests", () => {
       yield* fs.remove(outputFilePath);
     }).pipe(Effect.provide(NodeFileSystem.layer)),
   );
+
+  it.live("headBucket and headObject", () =>
+    Effect.gen(function* () {
+      const fs = yield* FileSystem.FileSystem;
+
+      yield* Console.log("Step 1: Create bucket");
+      yield* client.createBucket({ Bucket: BUCKET_NAME });
+
+      yield* Console.log("Step 2: HeadBucket");
+      const bucketHead = yield* client.headBucket({ Bucket: BUCKET_NAME });
+      expect(bucketHead.BucketRegion).toBe("us-east-1");
+
+      yield* Console.log("Step 3: Upload a file");
+      const rawInput = yield* fs.readFile(inputFilePath);
+      yield* client.putObject({
+        Bucket: BUCKET_NAME,
+        Key: FILE_KEY,
+        Body: rawInput,
+        ContentType: "image/jpeg",
+      });
+
+      yield* Console.log("Step 4: HeadObject");
+      const objectHead = yield* client.headObject({
+        Bucket: BUCKET_NAME,
+        Key: FILE_KEY,
+      });
+      expect(objectHead.ContentType).toBe("image/jpeg");
+      expect(objectHead.ContentLength).toBe(String(rawInput.byteLength));
+
+      yield* Console.log("Step 5: clean up");
+      yield* client.deleteObject({
+        Bucket: BUCKET_NAME,
+        Key: FILE_KEY,
+      });
+      yield* client.deleteBucket({ Bucket: BUCKET_NAME });
+    }).pipe(Effect.provide(NodeFileSystem.layer)),
+    {timeout: 1000000}
+  );
 });