String Write Test

1import { describe, expect, it } from "vitest";
2import { query } from "./clickhouse.js";
3import { encode } from "./encode.js";
4import {
5  writeString,
6  writeStringBytes,
7  writeFixedString,
8  writeFixedStringBytes,
9} from "../src/writers/strings.js";
10
11describe("writeString", () => {
12  it("encodes the empty string", async () =>
13    expect(encode(writeString, "")).toEqual(
14      await query("SELECT '' FORMAT RowBinary"),
15    ));
16  it("encodes an ASCII string", async () =>
17    expect(encode(writeString, "hello")).toEqual(
18      await query("SELECT 'hello' FORMAT RowBinary"),
19    ));
20  it("encodes a multi-byte UTF-8 string", async () =>
21    expect(encode(writeString, "héllo · 日本")).toEqual(
22      await query("SELECT 'héllo · 日本' FORMAT RowBinary"),
23    ));
24  it("encodes a string longer than a 1-byte varint length", async () =>
25    expect(encode(writeString, "x".repeat(300))).toEqual(
26      await query("SELECT repeat('x', 300) FORMAT RowBinary"),
27    ));
28});
29
30describe("writeStringBytes", () => {
31  it("writes raw (non-UTF-8) bytes from a Uint8Array", () => {
32    // varint length 3, then the raw bytes verbatim.
33    expect([
34      ...encode(writeStringBytes, Buffer.from([0xff, 0x00, 0xfe])),
35    ]).toEqual([0x03, 0xff, 0x00, 0xfe]);
36  });
37});
38
39describe("writeFixedString", () => {
40  it("pads to the column width with trailing NULs", async () =>
41    expect(encode(writeFixedString(16), "abc")).toEqual(
42      await query("SELECT toFixedString('abc', 16) FORMAT RowBinary"),
43    ));
44
45  it("throws when the value exceeds the size", () =>
46    expect(() => encode(writeFixedString(2), "abc")).toThrow(RangeError));
47});
48
49describe("writeFixedStringBytes", () => {
50  it("pads raw bytes to the column width with trailing NULs", async () =>
51    expect(encode(writeFixedStringBytes(8), Buffer.from("abc"))).toEqual(
52      await query("SELECT toFixedString('abc', 8) FORMAT RowBinary"),
53    ));
54
55  it("zero-pads a short value", () =>
56    expect([...encode(writeFixedStringBytes(4), Buffer.from([1, 2]))]).toEqual([
57      1, 2, 0, 0,
58    ]));
59
60  it("throws when the value exceeds the size", () =>
61    expect(() =>
62      encode(writeFixedStringBytes(2), Buffer.from([1, 2, 3])),
63    ).toThrow(RangeError));
64});