From 909f6ab08b40447d4140670fb3b849182e281917 Mon Sep 17 00:00:00 2001 From: bbassie <17990055+bbassie@users.noreply.github.com> Date: Fri, 20 Nov 2026 10:17:40 +0000 Subject: [PATCH 1/3] Move ModInfo.fromModFile to ModStore.readModInfo Reading a mod zip needs zip_ops, which pulled yauzl into the web interface bundle through the data classes. ModStore is node only, so the zip reading now lives there. Co-Authored-By: Claude Opus 5.5 --- packages/controller/src/routes.ts | 2 +- packages/lib/src/ModStore.ts | 40 ++++++++++++++++++++++++++++++- packages/lib/src/data/ModInfo.ts | 34 -------------------------- test/lib/ModStore.test.js | 35 ++++++++++++++++++++++++++- test/lib/data/ModInfo.js | 32 ------------------------- 5 files changed, 74 insertions(+), 69 deletions(-) diff --git a/packages/controller/src/routes.ts b/packages/controller/src/routes.ts index 9c5121d5..48348726 100644 --- a/packages/controller/src/routes.ts +++ b/packages/controller/src/routes.ts @@ -828,7 +828,7 @@ async function uploadMod(req: Request, res: Response) { // Pipe does not pass on an upload that was cut short. await Promise.all([finished(file.stream), finished(writeStream)]); - const modInfo = await lib.ModInfo.fromModFile(tempFilePath); + const modInfo = await lib.ModStore.readModInfo(tempFilePath); checkModName(modInfo.filename); await fs.rename(tempFilePath, path.join(modsDirectory, modInfo.filename)); req.app.locals.controller.modStore.addMod(modInfo); diff --git a/packages/lib/src/ModStore.ts b/packages/lib/src/ModStore.ts index 3efb7a5b..f9ba4c84 100644 --- a/packages/lib/src/ModStore.ts +++ b/packages/lib/src/ModStore.ts @@ -4,6 +4,8 @@ import events from "events"; import { Static } from "@sinclair/typebox"; import { logger } from "./logging.js"; import { downloadFile, atomicOverwriteFile } from "./file_ops.js"; +import { hashFile } from "./hash.js"; +import { ZipArchive, findRoot } from "./zip_ops.js"; import { ModPortalReleaseSchema, ModPortalDetailsSchema, ModNameVersionPair } from "./data/messages_mod.js"; import { ModInfo, ModPack, MajorMinorVersion, ModVersionEquality, SourceVersion } from "./data/index.js"; @@ -54,8 +56,44 @@ export default class ModStore extends events.EventEmitter { mods() { return this.files.values(); } + /** + * Read the info.json of a mod zip file along with its size, mtime and hash + * + * @param modPath - Path to the mod zip file. + * @returns Mod info for the file. + */ + static async readModInfo(modPath: string) { + let modInfo: Static; + let zip = await ZipArchive.fromFile(modPath); + try { + let content = await zip.readFile(path.posix.join(findRoot(zip), "info.json")); + if (content === null) { + throw new Error("Mod contains no info.json file"); + } + modInfo = JSON.parse(content.toString("utf8")); + } finally { + zip.close(); + } + + let valid = ModInfo.validateInfo(modInfo); + if (!valid) { + throw new Error("Mod's info.json is not valid"); + } + + const stat = await fs.stat(modPath); + return ModInfo.fromJSON({ + ...modInfo, + + size: stat.size, + sha1: await hashFile(modPath), + mtime_ms: stat.mtimeMs, + updated_at_ms: stat.mtimeMs, + is_deleted: false, + }); + } + static async loadFile(modsDirectory: string, file: string) { - let modInfo = await ModInfo.fromModFile(path.join(modsDirectory, file)); + let modInfo = await ModStore.readModInfo(path.join(modsDirectory, file)); if (modInfo.filename !== file) { throw new Error(`filename does not match the expected name ${modInfo.filename}.`); } diff --git a/packages/lib/src/data/ModInfo.ts b/packages/lib/src/data/ModInfo.ts index c44c8a6e..26420ba1 100644 --- a/packages/lib/src/data/ModInfo.ts +++ b/packages/lib/src/data/ModInfo.ts @@ -1,10 +1,6 @@ -import fs from "node:fs/promises"; -import path from "path"; import { Type, Static } from "@sinclair/typebox"; -import * as libHash from "../hash.js"; import * as libSchema from "../schema.js"; -import { ZipArchive, findRoot } from "../zip_ops.js"; import { ModRecord } from "./ModPack.js"; import { @@ -349,34 +345,4 @@ export default class ModInfo { if (this.isDeleted) { json.is_deleted = this.isDeleted; } return json; } - - static async fromModFile(modPath: string) { - let modInfo: Static; - let zip = await ZipArchive.fromFile(modPath); - try { - let content = await zip.readFile(path.posix.join(findRoot(zip), "info.json")); - if (content === null) { - throw new Error("Mod contains no info.json file"); - } - modInfo = JSON.parse(content.toString("utf8")); - } finally { - zip.close(); - } - - let valid = this.validateInfo(modInfo); - if (!valid) { - throw new Error("Mod's info.json is not valid"); - } - - const stat = await fs.stat(modPath); - return this.fromJSON({ - ...modInfo, - - size: stat.size, - sha1: await libHash.hashFile(modPath), - mtime_ms: stat.mtimeMs, - updated_at_ms: stat.mtimeMs, - is_deleted: false, - }); - } } diff --git a/test/lib/ModStore.test.js b/test/lib/ModStore.test.js index 309f3117..a2e02bfd 100644 --- a/test/lib/ModStore.test.js +++ b/test/lib/ModStore.test.js @@ -6,7 +6,8 @@ import stream from "node:stream"; // Capture native fetch before any potential mocks are applied const nativeFetch = global.fetch; -import { ModStore, ModInfo, ModVersionEquality, zipOutputStream } from "@clusterio/lib"; +import { ModStore, ModInfo, ModVersionEquality, zipOutputStream, hashFile } from "@clusterio/lib"; +import * as libBuildMod from "@clusterio/lib/build_mod.js"; import { externalTest, createZip, createZipBuffer } from "../common.js"; import "../setup_logging.js"; @@ -706,6 +707,38 @@ describe("lib/ModStore", function () { }); // === Instance Methods === + describe("readModInfo (static)", function () { + it("should load from a mod zip file", async function () { + await libBuildMod.build({ + build: true, + pack: true, + sourceDir: path.join("test", "file", "empty_mod"), + outputDir: path.join("temp", "test"), + }); + const filePath = path.join("temp", "test", "empty_mod_1.0.0.zip"); + const hash = await hashFile(filePath); + const stat = await fs.stat(filePath); + const mod = await ModStore.readModInfo(filePath); + assert.deepEqual( + mod, + ModInfo.fromJSON({ + name: "empty_mod", + version: "1.0.0", + title: "An Empty Mod", + author: "Me", + description: "An empty mod for testing", + factorio_version: "1.1", + dependencies: [], + filename: "empty_mod_1.0.0.zip", + size: stat.size, + mtime_ms: stat.mtimeMs, + updated_at_ms: stat.mtimeMs, + sha1: hash, + }) + ); + }); + }); + describe("Instance Methods", function () { let modStore; let testMod1Name = "test-mod-1"; diff --git a/test/lib/data/ModInfo.js b/test/lib/data/ModInfo.js index 68926e4a..190b5ac8 100644 --- a/test/lib/data/ModInfo.js +++ b/test/lib/data/ModInfo.js @@ -1,9 +1,6 @@ import assert from "node:assert/strict"; -import fs from "node:fs/promises"; -import path from "node:path"; import * as lib from "@clusterio/lib"; -import * as libBuildMod from "@clusterio/lib/build_mod.js"; import { ModInfo, ModDependency } from "@clusterio/lib"; import { testMatrix, testRoundTripJsonSerialisable } from "../../common.js"; @@ -413,35 +410,6 @@ describe("lib/data/ModInfo", function() { ["UltraMod", "SuperLib >= 1.00", "! bad-mod"].map(dep => new ModDependency(dep)) ); }); - it("should load from a mod zip file", async function() { - await libBuildMod.build({ - build: true, - pack: true, - sourceDir: path.join("test", "file", "empty_mod"), - outputDir: path.join("temp", "test"), - }); - const filePath = path.join("temp", "test", "empty_mod_1.0.0.zip"); - const hash = await lib.hashFile(filePath); - const stat = await fs.stat(filePath); - const mod = await ModInfo.fromModFile(filePath); - assert.deepEqual( - mod, - ModInfo.fromJSON({ - name: "empty_mod", - version: "1.0.0", - title: "An Empty Mod", - author: "Me", - description: "An empty mod for testing", - factorio_version: "1.1", - dependencies: [], - filename: "empty_mod_1.0.0.zip", - size: stat.size, - mtime_ms: stat.mtimeMs, - updated_at_ms: stat.mtimeMs, - sha1: hash, - }) - ); - }); describe("checkDependencySatisfaction()", function() { it("should return undefined when satisfied", function() { const mod = ModInfo.fromJSON({ dependencies: ["! a", "b = 1.0.0", "? c = 2.0.0"] }); 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 2/3] 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" + ); + }); +}); From 6dc48b6732424b1934cf1c7289001611898046d7 Mon Sep 17 00:00:00 2001 From: bbassie <17990055+bbassie@users.noreply.github.com> Date: Fri, 20 Nov 2026 10:19:04 +0000 Subject: [PATCH 3/3] Replace node:assert in link with a local assert The assert polyfill is 28 KB in the web interface bundle and link only uses it for plain truthiness checks. Co-Authored-By: Claude Opus 5.5 --- packages/lib/src/link/assert.ts | 6 ++++++ packages/lib/src/link/connectors.ts | 2 +- packages/lib/src/link/link.ts | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 packages/lib/src/link/assert.ts diff --git a/packages/lib/src/link/assert.ts b/packages/lib/src/link/assert.ts new file mode 100644 index 00000000..46881b11 --- /dev/null +++ b/packages/lib/src/link/assert.ts @@ -0,0 +1,6 @@ +/** Throws if condition is falsy, node:assert is not available in the browser. */ +export function assert(condition: unknown): asserts condition { + if (!condition) { + throw new Error("Assertion failed"); + } +} diff --git a/packages/lib/src/link/connectors.ts b/packages/lib/src/link/connectors.ts index c87b848a..f9769c83 100644 --- a/packages/lib/src/link/connectors.ts +++ b/packages/lib/src/link/connectors.ts @@ -1,5 +1,4 @@ // Connection adapters for Links -import { strict as assert } from "assert"; import events from "events"; import { WebSocket } from "#WebSocket"; @@ -7,6 +6,7 @@ import * as libData from "../data/index.js"; import * as libErrors from "../errors.js"; import { logger } from "../logging.js"; import ExponentialBackoff from "../ExponentialBackoff.js"; +import { assert } from "./assert.js"; import type { Request, Event } from "./link.js"; /** diff --git a/packages/lib/src/link/link.ts b/packages/lib/src/link/link.ts index 205ae9e6..c2db49aa 100644 --- a/packages/lib/src/link/link.ts +++ b/packages/lib/src/link/link.ts @@ -5,7 +5,7 @@ import { logger } from "../logging.js"; import * as libSchema from "../schema.js"; import { dataClasses, errorClasses } from "./messages.js"; import { BaseConnector, WebSocketBaseConnector } from "./connectors.js"; -import { strict as assert } from "assert"; +import { assert } from "./assert.js"; import type { PluginNodeEnvInfo, PluginWebEnvInfo } from "../plugin.js"; import type { AddressType, JSONDeserialisable, MessageRoutable, MessageRequest, MessageEvent, IUser,