Use 'automatic' rather than 'auto' for 'encodeBody' (#358)

GregBrimble · web-flow · commit 4064fbf1b98e · 2022-09-07T17:59:39.000+01:00
diff --git a/packages/core/src/standards/http.ts b/packages/core/src/standards/http.ts
@@ -489,7 +489,7 @@ export function withImmutableHeaders<Body extends Request | Response>(
 }
 
 export interface ResponseInit extends BaseResponseInit {
-  readonly encodeBody?: "auto" | "manual";
+  readonly encodeBody?: "automatic" | "manual";
   readonly webSocket?: WebSocket;
 }
 
@@ -528,7 +528,7 @@ export class Response<
 
   // https://developers.cloudflare.com/workers/runtime-apis/response#properties
   // noinspection TypeScriptFieldCanBeMadeReadonly
-  #encodeBody: "auto" | "manual";
+  #encodeBody: "automatic" | "manual";
   // noinspection TypeScriptFieldCanBeMadeReadonly
   #status?: number;
   readonly #webSocket?: WebSocket;
@@ -584,8 +584,8 @@ export class Response<
       super(new BaseResponse(body, init));
     }
 
-    encodeBody ??= "auto";
-    if (encodeBody !== "auto" && encodeBody !== "manual") {
+    encodeBody ??= "automatic";
+    if (encodeBody !== "automatic" && encodeBody !== "manual") {
       throw new TypeError(`encodeBody: unexpected value: ${encodeBody}`);
     }
     this.#encodeBody = encodeBody;
@@ -625,7 +625,7 @@ export class Response<
     return clone;
   }
 
-  get encodeBody(): "auto" | "manual" {
+  get encodeBody(): "automatic" | "manual" {
     return this.#encodeBody;
   }
 
diff --git a/packages/core/test/standards/http.spec.ts b/packages/core/test/standards/http.spec.ts
@@ -695,7 +695,7 @@ test("Response: supports non-standard properties", (t) => {
 });
 test("Response: encodeBody defaults to auto", (t) => {
   const res = new Response(null);
-  t.is(res.encodeBody, "auto");
+  t.is(res.encodeBody, "automatic");
 });
 test("Response: requires status 101 for WebSocket response", (t) => {
   const pair = new WebSocketPair();
diff --git a/packages/http-server/src/index.ts b/packages/http-server/src/index.ts
@@ -176,7 +176,7 @@ async function writeResponse(
   // If a Content-Encoding is set, and the user hasn't encoded the body,
   // we're responsible for doing so.
   const encoders: Transform[] = [];
-  if (headers["content-encoding"] && response.encodeBody === "auto") {
+  if (headers["content-encoding"] && response.encodeBody === "automatic") {
     // Reverse of https://github.com/nodejs/undici/blob/48d9578f431cbbd6e74f77455ba92184f57096cf/lib/fetch/index.js#L1660
     const codings = headers["content-encoding"]
       .toString()
@@ -207,7 +207,7 @@ async function writeResponse(
   // response, and it's HTML
   const liveReloadEnabled =
     liveReload &&
-    response.encodeBody === "auto" &&
+    response.encodeBody === "automatic" &&
     response.headers.get("content-type")?.toLowerCase().includes("text/html");
 
   // If Content-Length is specified, and we're live-reloading, we'll

Original file line number	Diff line number	Diff line change
`@@ -489,7 +489,7 @@ export function withImmutableHeaders<Body extends Request \| Response>(`
`489`	`489`	`}`
`490`	`490`
`491`	`491`	`export interface ResponseInit extends BaseResponseInit {`
`492`		`- readonly encodeBody?: "auto" \| "manual";`
	`492`	`+ readonly encodeBody?: "automatic" \| "manual";`
`493`	`493`	`readonly webSocket?: WebSocket;`
`494`	`494`	`}`
`495`	`495`
`@@ -528,7 +528,7 @@ export class Response<`
`528`	`528`
`529`	`529`	`// https://developers.cloudflare.com/workers/runtime-apis/response#properties`
`530`	`530`	`// noinspection TypeScriptFieldCanBeMadeReadonly`
`531`		`- #encodeBody: "auto" \| "manual";`
	`531`	`+ #encodeBody: "automatic" \| "manual";`
`532`	`532`	`// noinspection TypeScriptFieldCanBeMadeReadonly`
`533`	`533`	`#status?: number;`
`534`	`534`	`readonly #webSocket?: WebSocket;`
`@@ -584,8 +584,8 @@ export class Response<`
`584`	`584`	`super(new BaseResponse(body, init));`
`585`	`585`	`}`
`586`	`586`
`587`		`- encodeBody ??= "auto";`
`588`		`- if (encodeBody !== "auto" && encodeBody !== "manual") {`
	`587`	`+ encodeBody ??= "automatic";`
	`588`	`+ if (encodeBody !== "automatic" && encodeBody !== "manual") {`
`589`	`589`	throw new TypeError(`encodeBody: unexpected value: ${encodeBody}`);
`590`	`590`	`}`
`591`	`591`	`this.#encodeBody = encodeBody;`
`@@ -625,7 +625,7 @@ export class Response<`
`625`	`625`	`return clone;`
`626`	`626`	`}`
`627`	`627`
`628`		`- get encodeBody(): "auto" \| "manual" {`
	`628`	`+ get encodeBody(): "automatic" \| "manual" {`
`629`	`629`	`return this.#encodeBody;`
`630`	`630`	`}`
`631`	`631`