fix: allow batch_atomic to load in browsers

Author: kitsonk

batched_atomic.ts

@@ -29,8 +29,6 @@
  * @module
  */
 
-import { estimateSize } from "@deno/kv-utils/estimate-size";
-
 import { BLOB_KEY, BLOB_META_KEY, setBlob } from "./blob_util.ts";
 import { keys } from "./keys.ts";
 
@@ -58,6 +56,26 @@ const MAX_MUTATIONS = 999;
 const MAX_TOTAL_MUTATION_SIZE_BYTES = 750_000;
 const MAX_TOTAL_KEY_SIZE_BYTES = 75_000;
 
+/**
+ * Estimates the size of a value in bytes, which is used to determine the size of entries being stored in a Deno KV
+ * store.
+ *
+ * This is done this way to make this module loadable in environments where the V8 `serialize` function is not
+ * available, such as a web browser.
+ */
+const estimateSize = await ("Deno" in globalThis || "process" in globalThis
+  ? (async () => {
+    const { serialize } = await import("node:v8");
+    return (value: unknown) => {
+      const buffer = serialize(value);
+      return buffer.byteLength;
+    };
+  })()
+  : (async () => {
+    const { estimateSize } = await import("./estimate_size.ts");
+    return estimateSize;
+  })());
+
 /**
  * The class that encapsulates the batched atomic operations. Works around
  * limitations imposed by Deno KV related to individual atomic operations.

deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitsonk/kv-toolbox",
-  "version": "0.29.2",
+  "version": "0.29.3-beta.1",
   "exports": {
     ".": "./toolbox.ts",
     "./batched_atomic": "./batched_atomic.ts",

estimate_size.test.ts

@@ -0,0 +1,160 @@
+// Copyright 2024 the Deno authors. All rights reserved. MIT license.
+
+import { assertAlmostEquals, assertEquals } from "@std/assert";
+
+import { estimateSize } from "./estimate_size.ts";
+
+Deno.test({
+  name: "estimateSize - string",
+  fn() {
+    assertEquals(estimateSize("abcdefghijklmnopq"), 21);
+    assertEquals(estimateSize("🥟🥟"), 12);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - number",
+  fn() {
+    assertEquals(estimateSize(63), 4);
+    assertEquals(estimateSize(64), 5);
+    assertEquals(estimateSize(8_191), 5);
+    assertEquals(estimateSize(8_192), 6);
+    assertEquals(estimateSize(1_048_575), 6);
+    assertEquals(estimateSize(1_048_576), 7);
+    assertEquals(estimateSize(134_217_727), 7);
+    assertEquals(estimateSize(134_217_728), 8);
+    assertEquals(estimateSize(2_147_483_647), 8);
+    assertEquals(estimateSize(2_147_483_648), 11);
+    assertEquals(estimateSize(Number.MAX_SAFE_INTEGER), 11);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - boolean",
+  fn() {
+    assertEquals(estimateSize(true), 3);
+    assertEquals(estimateSize(false), 3);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - bigint",
+  fn() {
+    assertEquals(estimateSize(63n), 12);
+    assertEquals(estimateSize(BigInt(Number.MAX_SAFE_INTEGER + 1)), 12);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - undefined",
+  fn() {
+    assertEquals(estimateSize(undefined), 3);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - null",
+  fn() {
+    assertEquals(estimateSize(null), 3);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - Date",
+  fn() {
+    assertEquals(estimateSize(new Date()), 11);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - RegExp",
+  fn() {
+    assertEquals(estimateSize(/ab[cdefg]hijklmnopq/ig), 25);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - Error",
+  fn() {
+    assertAlmostEquals(
+      estimateSize(new URIError("boo hoo", { cause: new Error("boo") })),
+      496,
+      100,
+    );
+  },
+});
+
+Deno.test({
+  name: "estimateSize - Uint8Array",
+  fn() {
+    assertEquals(estimateSize(new Uint8Array([1, 2, 3])), 12);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - ArrayBuffer",
+  fn() {
+    assertEquals(estimateSize(new Uint8Array([1, 2, 3]).buffer), 12);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - Array",
+  fn() {
+    assertEquals(estimateSize([1, 2, 3, "boo", true, false, /abc/]), 27);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - Set",
+  fn() {
+    assertEquals(estimateSize(new Set([1, 2, 3, 4, "foo"])), 18);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - Map",
+  fn() {
+    assertEquals(
+      estimateSize(
+        new Map<string, string | number>([["a", 1], ["b", 2], ["c", "d"]]),
+      ),
+      21,
+    );
+  },
+});
+
+Deno.test({
+  name: "estimateSize - object",
+  fn() {
+    assertEquals(
+      estimateSize({ a: new Map([[{ a: 1 }, { b: /234/ }]]), b: false }),
+      36,
+    );
+  },
+});
+
+Deno.test({
+  name: "estimateSize - Deno.KvU64",
+  fn() {
+    assertEquals(estimateSize(new Deno.KvU64(100n)), 12);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - object with circular reference",
+  fn() {
+    // deno-lint-ignore no-explicit-any
+    const a = { b: 1 as any };
+    const b = { a };
+    a.b = b;
+    assertEquals(estimateSize(a), 11);
+  },
+});
+
+Deno.test({
+  name: "estimateSize - symbol",
+  fn() {
+    assertEquals(estimateSize(Symbol.for("@deno/kv-utils")), 0);
+  },
+});