@lofcz/tikz 0.2.0 → 0.2.1

package/NOTICE.md

@@ -16,7 +16,8 @@ Only the ten upstream default bundles are shipped. Optional Classico (AFPL),
 Ghostscript, latex-doc, OpenType and otf-fonts bundles are excluded. No Ghostscript
 engine is included. Native binaries and macro contents are unchanged. Bundle payloads are Brotli-compressed
 without changing their contents. Our Node I/O decompresses them on demand and
-uses portable file URL handling. Browser I/O still uses uncompressed assets.
+uses portable file URL handling. Engine glue supports lazy optional module loading
+and TeX-only execution without initializing MetaPost. Browser I/O still uses uncompressed assets.
 
 Corresponding upstream source, patches and reproducible build instructions:
 https://github.com/jmckalex/mp-tikz-wasm/tree/d44aeeba98b0e60d13c35dfd080076e6b05c68b5

package/README.md

@@ -28,6 +28,12 @@ are accepted unchanged. Snippets receive a standalone wrapper and the standard
 calc, intersections, angles, quotes, arrows.meta and positioning libraries.
 pgfplots is available through `\usepackage{pgfplots}` in a complete document.
 
+Both entries enable the fork's lazy engine loading: TikZ skips MetaPost WASM,
+optional glue loads only when used, and graph-drawing documents automatically
+select LuaTeX. Each document still gets a fresh TeX/WASM execution state. These
+savings do not require cross-request caches, including on Vercel Fluid Node
+functions. The server entry keeps CPU-bound TeX outside the shared request loop.
+
 ## Limits and cancellation
 
 One page; 12,000 source characters; 30 seconds per execution and queue wait;
@@ -96,6 +102,8 @@ the full package including `runtime/`; copying only JavaScript is insufficient.
 ```sh
 npm ci
 npm run check
+npm run test:browser
+npm run bench:cold
 ```
 
 The engine source lives in `packages/engine`, imported from upstream v0.5.0 as a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lofcz/tikz",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Self-contained, process-isolated TikZ to SVG rendering powered by mp-tikz-wasm.",
   "type": "module",
   "license": "GPL-3.0-or-later",
@@ -47,7 +47,8 @@
     "check": "npm run build && npm test && npm run test:package",
     "prepack": "npm run build",
     "build:engine": "tsc -p packages/engine/tsconfig.build.json",
-    "test:browser": "node test/browser.mjs"
+    "test:browser": "node test/browser.mjs",
+    "bench:cold": "node test/bench-cold.mjs"
   },
   "devDependencies": {
     "@types/node": "^22.20.5",

package/runtime/dist/core.d.ts

@@ -45,6 +45,7 @@ export declare class MetaPostCore {
         build: string;
     };
     private userFiles;
+    private mplibReady?;
     /**
      * luaotfload's font cache (TEXMF_VAR), carried from one LuaTeX run to the
      * next. Parsing an OpenType face costs about a second, and every TeX run
@@ -53,7 +54,8 @@ export declare class MetaPostCore {
     private texmfVar;
     private get logger();
     constructor(env: CoreEnv);
-    init(): Promise<void>;
+    init(eager?: boolean): Promise<void>;
+    private initMetaPost;
     private progress;
     /** The errors and warnings of a finished run, one record each; a MetaPost help paragraph is indented under its error. */
     private report;

package/runtime/dist/core.js

@@ -69,7 +69,8 @@ export class MetaPostCore {
     cache = new MemorySnippetCache();
     bridge;
     version = { metapost: '', tex: 'pdfTeX 1.40.27 (DVI)', build: '' };
-    userFiles = new Set();
+    userFiles = new Map();
+    mplibReady;
     /**
      * luaotfload's font cache (TEXMF_VAR), carried from one LuaTeX run to the
      * next. Parsing an OpenType face costs about a second, and every TeX run
@@ -80,7 +81,13 @@ export class MetaPostCore {
     constructor(env) {
         this.env = env;
     }
-    async init() {
+    async init(eager = !this.env.options.lazy) {
+        if (!eager)
+            return;
+        this.mplibReady ??= this.initMetaPost();
+        await this.mplibReady;
+    }
+    async initMetaPost() {
         const o = this.env.options;
         this.progress({ phase: 'loading', detail: 'mplib.wasm' });
         // mplib's own stdout/stderr (dvitomp, the runtime) and, through the termLine hook, MetaPost's terminal
@@ -96,6 +103,8 @@ export class MetaPostCore {
         mkdirp(FS, '/work');
         this.installTexmf(FS, this.M.NODEFS);
         FS.chdir('/work');
+        for (const [path, bytes] of this.userFiles)
+            writeFileDeep(FS, path, bytes);
         mpxAddPath(this.M, `${TEXMF_ROOT}/fonts/tfm`);
         mpxAddPath(this.M, `${TEXMF_ROOT}/fonts/vf`);
         this.M.mpwasmHooks = {
@@ -193,9 +202,9 @@ export class MetaPostCore {
     }
     copyUserFiles(T) {
         // TeX may \input files the user supplied next to the job
-        for (const p of this.userFiles) {
+        for (const [p, bytes] of this.userFiles) {
             try {
-                writeFileDeep(T.FS, p, this.M.FS.readFile(p, { encoding: 'binary' }));
+                writeFileDeep(T.FS, p, this.M ? this.M.FS.readFile(p, { encoding: 'binary' }) : bytes);
             }
             catch { /* ignore */ }
         }
@@ -288,8 +297,9 @@ export class MetaPostCore {
     addFiles(files) {
         for (const [name, data] of Object.entries(files)) {
             const p = name.startsWith('/') ? name : `/work/${name}`;
-            writeFileDeep(this.M.FS, p, data);
-            this.userFiles.add(p);
+            if (this.M)
+                writeFileDeep(this.M.FS, p, data);
+            this.userFiles.set(p, typeof data === 'string' ? data : data.slice());
         }
     }
     /**
@@ -298,7 +308,7 @@ export class MetaPostCore {
      * typesetting one document after another would hand the first one's .aux to the next.
      */
     removeFiles(names) {
-        const paths = names ? names.map((n) => (n.startsWith('/') ? n : `/work/${n}`)) : [...this.userFiles];
+        const paths = names ? names.map((n) => (n.startsWith('/') ? n : `/work/${n}`)) : [...this.userFiles.keys()];
         for (const p of paths) {
             if (!this.userFiles.delete(p))
                 continue;
@@ -310,6 +320,7 @@ export class MetaPostCore {
     }
     clearCache() { this.cache.clear(); }
     async run(source, ro = {}) {
+        await this.init(true);
         const o = this.env.options;
         const t0 = now();
         this.stats = { totalMs: 0, metapostMs: 0, texMs: 0, texRuns: 0, metapostRuns: 0, snippetCacheHits: 0, snippetCacheMisses: 0 };

package/runtime/dist/index.js

@@ -34,16 +34,22 @@ class InProcessBackend {
             this.bundles.logger = this.logger;
             const base = o.bundleBaseUrl ?? new URL('./bundles/', here).href;
             await this.bundles.addAll(resolveBundleSpecs(o.bundles ?? DEFAULT_BUNDLES, base));
-            await this.bundles.prefetchEager();
-            await this.bundles.loadHot((base.endsWith('/') ? base : base + '/') + 'hot.json');
+            if (!o.lazy || !this.bundles.canFetchSync)
+                await this.bundles.prefetchEager();
+            if (!o.lazy)
+                await this.bundles.loadHot((base.endsWith('/') ? base : base + '/') + 'hot.json');
             if (!this.bundles.canFetchSync)
                 await this.bundles.prefetchAll();
         }
-        const mplibFactory = o.modules?.mplib ?? (await import(/* @vite-ignore */ new URL('./mplib.mjs', here).href)).default;
+        const lazyFactory = (name) => async (opts) => {
+            const module = await import(/* @vite-ignore */ new URL(`./${name}.mjs`, here).href);
+            return module.default(opts);
+        };
+        const mplibFactory = o.modules?.mplib ?? (o.lazy ? lazyFactory('mplib') : (await import(/* @vite-ignore */ new URL('./mplib.mjs', here).href)).default);
         let texFactory = o.modules?.tex;
         if (!texFactory && (o.tex ?? 'auto') !== 'none') {
             try {
-                texFactory = (await import(/* @vite-ignore */ new URL('./tex.mjs', here).href)).default;
+                texFactory = o.lazy ? lazyFactory('tex') : (await import(/* @vite-ignore */ new URL('./tex.mjs', here).href)).default;
             }
             catch {
                 texFactory = undefined;
@@ -52,7 +58,7 @@ class InProcessBackend {
         let dvisvgmFactory = o.modules?.dvisvgm;
         if (!dvisvgmFactory && texFactory) {
             try {
-                dvisvgmFactory = (await import(/* @vite-ignore */ new URL('./dvisvgm.mjs', here).href)).default;
+                dvisvgmFactory = o.lazy ? lazyFactory('dvisvgm') : (await import(/* @vite-ignore */ new URL('./dvisvgm.mjs', here).href)).default;
             }
             catch {
                 dvisvgmFactory = undefined;
@@ -62,7 +68,7 @@ class InProcessBackend {
         let luatexFactory = o.modules?.luatex;
         if (!luatexFactory && texFactory) {
             try {
-                luatexFactory = (await import(/* @vite-ignore */ new URL('./luatex.mjs', here).href)).default;
+                luatexFactory = o.lazy ? lazyFactory('luatex') : (await import(/* @vite-ignore */ new URL('./luatex.mjs', here).href)).default;
             }
             catch {
                 luatexFactory = undefined;
@@ -104,7 +110,15 @@ class InProcessBackend {
                 await this.bundles.add(spec);
         await this.bundles.prefetchAll((f) => bundles.includes(f.bundle));
     }
-    async prefetch(kinds) { return this.bundles ? this.bundles.prefetchHot(kinds) : 0; }
+    async prefetch(kinds) {
+        if (!this.bundles)
+            return 0;
+        if (!Object.keys(this.bundles.hot).length) {
+            const base = this.options.bundleBaseUrl ?? new URL('./bundles/', import.meta.url).href;
+            await this.bundles.loadHot((base.endsWith('/') ? base : base + '/') + 'hot.json');
+        }
+        return this.bundles.prefetchHot(kinds);
+    }
     setLogLevel(level) { this.logger.level = level; }
     dispose() { }
 }

package/runtime/dist/types.d.ts

@@ -98,6 +98,9 @@ export interface MetaPostOptions {
     };
     /** Run in-process instead of in a Web Worker (default: worker in browsers, in-process in Node). */
     worker?: boolean;
+    /** Defer engine glue and MetaPost WASM until used. MetaPost version fields in creation
+     * metadata remain empty in this mode. No cross-request cache is required. */
+    lazy?: boolean;
     /** Default for latex()'s snapshot option. Node: 'auto' (tikz.fmt from local files is free). Browser: 'none',
      *  because the 5.8 MB format does not compress and costs more to download than the files it replaces
      *  (2.5 MB gzipped); set 'auto' when many TikZ figures amortise it or the format is already cached. */

package/src/browser-worker.js

@@ -1,7 +1,7 @@
 import { MetaPost } from '../runtime/dist/index.js';
 
 try {
-  const engine = await MetaPost.create({ worker: false, logLevel: 'silent' });
+  const engine = await MetaPost.create({ worker: false, lazy: true, logLevel: 'silent' });
   self.onmessage = async ({ data: { source: code, maxOutputBytes } }) => {
     try {
       const source = /^\s*\\documentclass\b/m.test(code) ? code : String.raw`\documentclass[tikz,border=6pt]{standalone}
@@ -9,7 +9,7 @@ try {
 \begin{document}
 ${code}
 \end{document}`;
-      const result = await engine.latex(source, { fonts: 'paths' });
+      const result = await engine.latex(source, { engine: 'auto', fonts: 'paths' });
       if (result.status === 'error' || result.status === 'fatal' || result.pages?.length !== 1)
         throw new Error('TikZ requires one valid page. ' + JSON.stringify(result.diagnostics).slice(0, 2000));
       const svg = result.pages[0], bytes = new TextEncoder().encode(svg);

package/src/worker.js

@@ -3,9 +3,9 @@
 import { readFileSync } from 'node:fs';
 import { MetaPost } from '../runtime/dist/index.js';
 const { source } = JSON.parse(readFileSync(0, 'utf8'));
-const engine = await MetaPost.create({ worker: false, logLevel: 'silent' });
+const engine = await MetaPost.create({ worker: false, lazy: true, logLevel: 'silent' });
 try {
-  const result = await engine.latex(source, { fonts: 'paths' });
+  const result = await engine.latex(source, { engine: 'auto', fonts: 'paths' });
   if (result.status === 'error' || result.status === 'fatal' || result.pages?.length !== 1)
     throw new Error('TikZ requires one valid page. ' + JSON.stringify(result.diagnostics).slice(0, 2000));
   process.stdout.write(JSON.stringify({ svg: result.pages[0] }));