From 4d7c1020b06cea288cf91e47815b672620f892fa Mon Sep 17 00:00:00 2001 From: bbassie <17990055+bbassie@users.noreply.github.com> Date: Fri, 20 Nov 2026 10:18:37 +0000 Subject: [PATCH] Use fflate for zlib in the web interface ModPack and map exchange strings need synchronous inflate and deflate. In the browser these came from the browserify-zlib polyfill, which brings pako, assert and util along. The browser build now imports fflate through a #zlib_sync subpath import, Node.js keeps node:zlib. Co-Authored-By: Claude Opus 5.5 --- packages/lib/package.json | 8 +++++++ packages/lib/src/data/ModPack.ts | 4 ++-- packages/lib/src/factorio/exchange_string.ts | 2 +- packages/lib/src/zlib_sync.browser.ts | 15 ++++++++++++ packages/lib/src/zlib_sync.node.ts | 11 +++++++++ packages/lib/tsconfig.browser.json | 1 + pnpm-workspace.yaml | 1 + test/lib/zlib_sync.test.js | 25 ++++++++++++++++++++ 8 files changed, 64 insertions(+), 3 deletions(-) create mode 100644 packages/lib/src/zlib_sync.browser.ts create mode 100644 packages/lib/src/zlib_sync.node.ts create mode 100644 test/lib/zlib_sync.test.js diff --git a/packages/lib/package.json b/packages/lib/package.json index 53a1ba2b..41749d81 100644 --- a/packages/lib/package.json +++ b/packages/lib/package.json @@ -31,6 +31,13 @@ }, "import": "./src/link/WebSocket.browser.ts" }, + "#zlib_sync": { + "node": { + "types": "./src/zlib_sync.node.ts", + "default": "./dist/node/src/zlib_sync.node.js" + }, + "import": "./src/zlib_sync.browser.ts" + }, "#is_deep_strict_equal": { "node": { "types": "./src/is_deep_strict_equal.node.ts", @@ -56,6 +63,7 @@ "ajv": "^8.20.0", "chalk": "catalog:", "fast-deep-equal": "^3.1.3", + "fflate": "catalog:", "set-blocking": "catalog:", "triple-beam": "^1.4.1", "winston": "catalog:", diff --git a/packages/lib/src/data/ModPack.ts b/packages/lib/src/data/ModPack.ts index 29458422..8fb3d388 100644 --- a/packages/lib/src/data/ModPack.ts +++ b/packages/lib/src/data/ModPack.ts @@ -1,4 +1,4 @@ -import zlib from "zlib"; +import * as zlib from "#zlib_sync"; import { Type, Static } from "@sinclair/typebox"; import * as libSchema from "../schema.js"; @@ -306,7 +306,7 @@ export default class ModPack { // eslint-disable-next-line node/no-sync let buf = zlib.deflateSync(JSON.stringify(json)); - return buf.toString("base64"); + return Buffer.from(buf).toString("base64"); } static fromModPackString(modPackString: string) { diff --git a/packages/lib/src/factorio/exchange_string.ts b/packages/lib/src/factorio/exchange_string.ts index 38d2a36a..325502f4 100644 --- a/packages/lib/src/factorio/exchange_string.ts +++ b/packages/lib/src/factorio/exchange_string.ts @@ -1,4 +1,4 @@ -import zlib from "zlib"; +import * as zlib from "#zlib_sync"; class MapReaderState { pos = 0; diff --git a/packages/lib/src/zlib_sync.browser.ts b/packages/lib/src/zlib_sync.browser.ts new file mode 100644 index 00000000..67caa44f --- /dev/null +++ b/packages/lib/src/zlib_sync.browser.ts @@ -0,0 +1,15 @@ +/* eslint-disable node/no-sync */ +import { strToU8, unzlibSync, zlibSync } from "fflate"; + +export function inflateSync(data: Uint8Array): Uint8Array { + try { + return unzlibSync(data); + } catch (err: any) { + // Match the error code node:zlib gives for invalid data. + throw Object.assign(new Error(err.message), { code: "Z_DATA_ERROR" }); + } +} + +export function deflateSync(data: Uint8Array | string): Uint8Array { + return zlibSync(typeof data === "string" ? strToU8(data) : data); +} diff --git a/packages/lib/src/zlib_sync.node.ts b/packages/lib/src/zlib_sync.node.ts new file mode 100644 index 00000000..10ecf102 --- /dev/null +++ b/packages/lib/src/zlib_sync.node.ts @@ -0,0 +1,11 @@ +import zlib from "zlib"; + +export function inflateSync(data: Uint8Array): Uint8Array { + // eslint-disable-next-line node/no-sync + return zlib.inflateSync(data); +} + +export function deflateSync(data: Uint8Array | string): Uint8Array { + // eslint-disable-next-line node/no-sync + return zlib.deflateSync(data); +} diff --git a/packages/lib/tsconfig.browser.json b/packages/lib/tsconfig.browser.json index 07259d25..00cf87ad 100644 --- a/packages/lib/tsconfig.browser.json +++ b/packages/lib/tsconfig.browser.json @@ -19,6 +19,7 @@ "./src/hash.ts", "./src/ini.ts", "./src/is_deep_strict_equal.browser.ts", + "./src/zlib_sync.browser.ts", "./src/link/*.ts", "./src/lua_tools.ts", "./src/logging.ts", diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index ddd59f18..4636bd27 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -23,6 +23,7 @@ catalog: antd: ^5.29.3 chalk: ^6.0.1 express: ^5.3.0 + fflate: ^0.8.3 jsonwebtoken: ^9.0.3 react: ^18.3.1 react-dom: ^18.3.1 diff --git a/test/lib/zlib_sync.test.js b/test/lib/zlib_sync.test.js new file mode 100644 index 00000000..51a1abfb --- /dev/null +++ b/test/lib/zlib_sync.test.js @@ -0,0 +1,25 @@ +/* eslint-disable node/no-sync */ +import assert from "node:assert/strict"; +import zlib from "node:zlib"; + +import * as browserZlib from "../../packages/lib/src/zlib_sync.browser.ts"; + +describe("lib/zlib_sync.browser", function() { + const text = JSON.stringify({ name: "pack", mods: [{ name: "base", version: "2.0.0" }] }); + + it("should inflate data deflated by node:zlib", function() { + const inflated = browserZlib.inflateSync(zlib.deflateSync(text)); + assert.equal(Buffer.from(inflated).toString(), text); + }); + it("should deflate data node:zlib can inflate", function() { + assert.equal(zlib.inflateSync(browserZlib.deflateSync(text)).toString(), text); + const bytes = Buffer.from(text); + assert.equal(zlib.inflateSync(browserZlib.deflateSync(bytes)).toString(), text); + }); + it("should throw with a Z_ code on invalid data", function() { + assert.throws( + () => browserZlib.inflateSync(Buffer.from("not zlib data")), + err => err.code === "Z_DATA_ERROR" + ); + }); +});