Skip to content

Commit

Permalink
test(streams): improve Buffer test (#5061)
Browse files Browse the repository at this point in the history
  • Loading branch information
kt3k committed Jun 17, 2024
1 parent 4837997 commit f92bfe9
Show file tree
Hide file tree
Showing 2 changed files with 98 additions and 7 deletions.
3 changes: 0 additions & 3 deletions streams/buffer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -375,9 +375,6 @@ export class Buffer {
}

#reslice(len: number) {
if (len > this.#buf.buffer.byteLength) {
throw new RangeError("Length is greater than buffer capacity");
}
this.#buf = new Uint8Array(this.#buf.buffer, 0, len);
}

Expand Down
102 changes: 98 additions & 4 deletions streams/buffer_test.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.

import { assert, assertEquals } from "@std/assert";
import { assert, assertEquals, assertThrows } from "@std/assert";
import { Buffer } from "./buffer.ts";

Deno.test("Buffer handles write and read", async function () {
Deno.test("Buffer handles write and read", async () => {
const buf = new Buffer();
const writer = buf.writable.getWriter();
const reader = buf.readable.getReader({ mode: "byob" });
Expand All @@ -13,6 +13,14 @@ Deno.test("Buffer handles write and read", async function () {
assertEquals(read.value, data);
});

Deno.test("Buffer can constrruct with initial data", async () => {
const data = new Uint8Array([4, 21, 45, 19]);
const buf = new Buffer(data);
const reader = buf.readable.getReader({ mode: "byob" });
const read = await reader.read(new Uint8Array(4));
assertEquals(read.value, data);
});

Deno.test("Buffer handles read empty", async function () {
const buf = new Buffer();
const reader = buf.readable.getReader({ mode: "byob" });
Expand All @@ -21,18 +29,104 @@ Deno.test("Buffer handles read empty", async function () {
assertEquals(read.value!.byteLength, 0);
});

Deno.test("Buffer handles write and get bytes", async function () {
Deno.test("Buffer handles write and get bytes", async () => {
const buf = new Buffer();
const writer = buf.writable.getWriter();
const data = new Uint8Array([4, 21, 45, 19]);
await writer.write(data);
assertEquals(buf.bytes(), data);
});

Deno.test("Buffer handles truncate", async function () {
Deno.test("Buffer.truncate(n) truncates the data except the first n bytes", async () => {
const buf = new Buffer();
const writer = buf.writable.getWriter();
await writer.write(new Uint8Array([4, 21, 45, 19]));
buf.truncate(3);
assertEquals(buf.bytes(), new Uint8Array([4, 21, 45]));
});

Deno.test("Buffer.truncate(0) truncates the entire buffer", async () => {
const data = new Uint8Array([4, 21, 45, 19]);
const buf = new Buffer(data.buffer);
buf.truncate(0);
assertEquals(await buf.bytes(), new Uint8Array(0));
});

Deno.test("Buffer.truncate(n) throws if n is negative", () => {
const buf = new Buffer();
assertThrows(
() => {
buf.truncate(-1);
},
Error,
"bytes.Buffer: truncation out of range",
);
});

Deno.test("Buffer.truncate(n) throws if n is greater than the length of the buffer", () => {
const buf = new Buffer();
assertThrows(
() => {
buf.truncate(1);
},
Error,
"bytes.Buffer: truncation out of range",
);
});

Deno.test("Buffer.bytes({ copy: false }) returns subarray, not an slice", () => {
const data = new Uint8Array([4, 21, 45, 19]);
const buf = new Buffer(data.buffer);
const subarray = buf.bytes({ copy: false });
subarray.set([0, 0], 0);
// The original array is affected
assertEquals(data, new Uint8Array([0, 0, 45, 19]));
});

Deno.test("Buffer.grow(n) allocates necessary array buffer (increases the capacity of the buffer) if necessary", () => {
const buf = new Buffer();
assertEquals(buf.capacity, 0);
buf.grow(10);
assertEquals(buf.capacity, 10);
});

Deno.test("Buffer.grow(n) doesn't allocate a new array buffer if it has enough capacity", async () => {
const buf = new Buffer(new Uint8Array(100).buffer);
buf.reset();
assertEquals(buf.capacity, 100);
await buf.writable.getWriter().write(new Uint8Array([4, 21, 45, 19]));
await buf.readable.getReader({ mode: "byob" }).read(new Uint8Array(4));
buf.grow(10);
assertEquals(buf.capacity, 100);
});

Deno.test("Buffer.grow(n) slides down the unread data if the required n + buf.length <= buf.capacity / 2", async () => {
const array = new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
const buf = new Buffer(array.buffer);
await buf.readable.getReader({ mode: "byob" }).read(new Uint8Array(8)); // read 8 bytes
buf.grow(2); // grow the buffer by 2 bytes
assertEquals(buf.bytes(), new Uint8Array([8, 9]));
assertEquals(array, new Uint8Array([8, 9, 2, 3, 4, 5, 6, 7, 8, 9]));
});

Deno.test("Buffer.grow(n) throws an error if n is a negative value", () => {
const buf = new Buffer();
assertThrows(
() => {
buf.grow(-1);
},
Error,
"Buffer.grow: negative count",
);
});

Deno.test("Buffer.grow(n) throws if the total of byte size exceeds 2 ** 32 - 2", () => {
const buf = new Buffer();
assertThrows(
() => {
buf.grow(2 ** 32);
},
Error,
"The buffer cannot be grown beyond the maximum size.",
);
});

0 comments on commit f92bfe9

Please sign in to comment.