BREAKING: remove custom implementation of Deno.Buffer.toString() (den…

…oland#4992)

Keep in mind Buffer.toString() still exists, but returns [object Object]. 

Reason for removal of Buffer.toString() was that it implicitly used 
TextDecoder with fixed "utf-8" encoding and no way to customize 
the encoding.

cli/js/buffer.ts

@@ -6,7 +6,6 @@
 
 import { Reader, Writer, ReaderSync, WriterSync } from "./io.ts";
 import { assert } from "./util.ts";
-import { TextDecoder } from "./web/text_encoding.ts";
 
 // MIN_READ is the minimum ArrayBuffer size passed to a read call by
 // buffer.ReadFrom. As long as the Buffer has at least MIN_READ bytes beyond
@@ -44,11 +43,6 @@ export class Buffer implements Reader, ReaderSync, Writer, WriterSync {
     return this.#buf.subarray(this.#off);
   }
 
-  toString(): string {
-    const decoder = new TextDecoder();
-    return decoder.decode(this.#buf.subarray(this.#off));
-  }
-
   empty(): boolean {
     return this.#buf.byteLength <= this.#off;
   }

cli/js/lib.deno.ns.d.ts

@@ -847,12 +847,6 @@ declare namespace Deno {
      * least until the next buffer modification, so immediate changes to the
      * slice will affect the result of future reads. */
     bytes(): Uint8Array;
-    /** Returns the contents of the unread portion of the buffer as a `string`.
-     *
-     * **Warning**: if multibyte characters are present when data is flowing
-     * through the buffer, this method may result in incorrect strings due to a
-     * character being split. */
-    toString(): string;
     /** Returns whether the unread portion of the buffer is empty. */
     empty(): boolean;
     /** A read only number of bytes of the unread portion of the buffer. */
@@ -873,9 +867,15 @@ declare namespace Deno {
     readSync(p: Uint8Array): number | null;
     /** Reads the next `p.length` bytes from the buffer or until the buffer is
      * drained. Resolves to the number of bytes read. If the buffer has no
-     * data to return, resolves to EOF (`null`). */
+     * data to return, resolves to EOF (`null`).
+     *
+     * NOTE: This methods reads bytes sychronously; it's provided for
+     * compatibility with `Reader` interfaces.
+     */
     read(p: Uint8Array): Promise<number | null>;
     writeSync(p: Uint8Array): number;
+    /** NOTE: This methods writes bytes sychronously; it's provided for
+     * compatibility with `Writer` interface. */
     write(p: Uint8Array): Promise<number>;
     /** Grows the buffer's capacity, if necessary, to guarantee space for
      * another `n` bytes. After `.grow(n)`, at least `n` bytes can be written to

cli/js/tests/buffer_test.ts

@@ -35,7 +35,6 @@ function check(buf: Deno.Buffer, s: string): void {
   const decoder = new TextDecoder();
   const bytesStr = decoder.decode(bytes);
   assertEquals(bytesStr, s);
-  assertEquals(buf.length, buf.toString().length);
   assertEquals(buf.length, s.length);
 }
 

std/http/io_test.ts

@@ -51,7 +51,7 @@ test("chunkedBodyReader", async () => {
     await dest.write(buf.subarray(0, len));
   }
   const exp = "aaabbbbbcccccccccccdddddddddddddddddddddd";
-  assertEquals(dest.toString(), exp);
+  assertEquals(new TextDecoder().decode(dest.bytes()), exp);
 });
 
 test("chunkedBodyReader with trailers", async () => {
@@ -133,7 +133,10 @@ test("writeTrailer", async () => {
     new Headers({ "transfer-encoding": "chunked", trailer: "deno,node" }),
     new Headers({ deno: "land", node: "js" })
   );
-  assertEquals(w.toString(), "deno: land\r\nnode: js\r\n\r\n");
+  assertEquals(
+    new TextDecoder().decode(w.bytes()),
+    "deno: land\r\nnode: js\r\n\r\n"
+  );
 });
 
 test("writeTrailer should throw", async () => {
@@ -336,7 +339,7 @@ test("writeResponse with trailer", async () => {
     body,
     trailers: () => new Headers({ deno: "land", node: "js" }),
   });
-  const ret = w.toString();
+  const ret = new TextDecoder().decode(w.bytes());
   const exp = [
     "HTTP/1.1 200 OK",
     "transfer-encoding: chunked",

std/http/server_test.ts

@@ -63,7 +63,7 @@ test("responseWrite", async function (): Promise<void> {
     request.conn = mockConn();
 
     await request.respond(testCase.response);
-    assertEquals(buf.toString(), testCase.raw);
+    assertEquals(new TextDecoder().decode(buf.bytes()), testCase.raw);
     await request.done;
   }
 });

std/io/ioutil_test.ts

@@ -76,15 +76,15 @@ Deno.test("testCopyN1", async function (): Promise<void> {
   const r = stringsReader("abcdefghij");
   const n = await copyN(r, w, 3);
   assertEquals(n, 3);
-  assertEquals(w.toString(), "abc");
+  assertEquals(new TextDecoder().decode(w.bytes()), "abc");
 });
 
 Deno.test("testCopyN2", async function (): Promise<void> {
   const w = new Buffer();
   const r = stringsReader("abcdefghij");
   const n = await copyN(r, w, 11);
   assertEquals(n, 10);
-  assertEquals(w.toString(), "abcdefghij");
+  assertEquals(new TextDecoder().decode(w.bytes()), "abcdefghij");
 });
 
 Deno.test("copyNWriteAllData", async function (): Promise<void> {

std/mime/multipart.ts

@@ -302,7 +302,7 @@ export class MultipartReader {
         if (maxValueBytes < 0) {
           throw new RangeError("message too large");
         }
-        const value = buf.toString();
+        const value = new TextDecoder().decode(buf.bytes());
         valueMap.set(p.formName, value);
         continue;
       }

std/ws/test.ts

@@ -31,7 +31,8 @@ test("[ws] read unmasked text frame", async () => {
   const frame = await readFrame(buf);
   assertEquals(frame.opcode, OpCode.TextFrame);
   assertEquals(frame.mask, undefined);
-  assertEquals(new Buffer(frame.payload).toString(), "Hello");
+  const actual = new TextDecoder().decode(new Buffer(frame.payload).bytes());
+  assertEquals(actual, "Hello");
   assertEquals(frame.isLastFrame, true);
 });
 
@@ -57,7 +58,8 @@ test("[ws] read masked text frame", async () => {
   const frame = await readFrame(buf);
   assertEquals(frame.opcode, OpCode.TextFrame);
   unmask(frame.payload, frame.mask);
-  assertEquals(new Buffer(frame.payload).toString(), "Hello");
+  const actual = new TextDecoder().decode(new Buffer(frame.payload).bytes());
+  assertEquals(actual, "Hello");
   assertEquals(frame.isLastFrame, true);
 });
 
@@ -72,12 +74,14 @@ test("[ws] read unmasked split text frames", async () => {
   assertEquals(f1.isLastFrame, false);
   assertEquals(f1.mask, undefined);
   assertEquals(f1.opcode, OpCode.TextFrame);
-  assertEquals(new Buffer(f1.payload).toString(), "Hel");
+  const actual1 = new TextDecoder().decode(new Buffer(f1.payload).bytes());
+  assertEquals(actual1, "Hel");
 
   assertEquals(f2.isLastFrame, true);
   assertEquals(f2.mask, undefined);
   assertEquals(f2.opcode, OpCode.Continue);
-  assertEquals(new Buffer(f2.payload).toString(), "lo");
+  const actual2 = new TextDecoder().decode(new Buffer(f2.payload).bytes());
+  assertEquals(actual2, "lo");
 });
 
 test("[ws] read unmasked ping / pong frame", async () => {
@@ -87,15 +91,17 @@ test("[ws] read unmasked ping / pong frame", async () => {
   );
   const ping = await readFrame(buf);
   assertEquals(ping.opcode, OpCode.Ping);
-  assertEquals(new Buffer(ping.payload).toString(), "Hello");
+  const actual1 = new TextDecoder().decode(new Buffer(ping.payload).bytes());
+  assertEquals(actual1, "Hello");
   // prettier-ignore
   const pongFrame= [0x8a, 0x85, 0x37, 0xfa, 0x21, 0x3d, 0x7f, 0x9f, 0x4d, 0x51, 0x58]
   const buf2 = new BufReader(new Buffer(new Uint8Array(pongFrame)));
   const pong = await readFrame(buf2);
   assertEquals(pong.opcode, OpCode.Pong);
   assert(pong.mask !== undefined);
   unmask(pong.payload, pong.mask);
-  assertEquals(new Buffer(pong.payload).toString(), "Hello");
+  const actual2 = new TextDecoder().decode(new Buffer(pong.payload).bytes());
+  assertEquals(actual2, "Hello");
 });
 
 test("[ws] read unmasked big binary frame", async () => {