@bitmagic/world-forger 0.1.3 → 0.1.5

package/dist/pipeline/voxelize-level.js

@@ -1,6 +1,7 @@
 import { requireArtifact } from './artifact-store.js';
 import { ForgeStepError } from './errors.js';
 import { forgeRequestId } from './request-id.js';
+import { emitForgeProgress } from './progress-types.js';
 /**
  * Idle timeout for the level bake: it runs chunk-by-chunk in the browser and
  * emits VOXELIZE_GLB_AS_LEVEL_PROGRESS per chunk, each of which re-arms this
@@ -11,6 +12,63 @@ import { forgeRequestId } from './request-id.js';
 export const VOXELIZE_TIMEOUT_MS = 20 * 60 * 1000;
 /** Progress message the bake emits per chunk; resets the idle timeout above. */
 const VOXELIZE_PROGRESS_TYPE = 'VOXELIZE_GLB_AS_LEVEL_PROGRESS';
+/**
+ * Minimum gap between bake progress events reaching the host.
+ *
+ * The engine emits one message per chunk and a large level has thousands. Every host on the
+ * receiving end does something with a cost — a temp-file-and-rename job record write, an SSE frame,
+ * a node in a log tree — so the throttle belongs HERE, at the one place both lanes pass through,
+ * rather than being reinvented (and forgotten) per host.
+ */
+export const BAKE_PROGRESS_MIN_INTERVAL_MS = 3000;
+function asBakeProgress(message) {
+    const { chunkIndex, totalChunks } = message;
+    if (typeof chunkIndex !== 'number' || typeof totalChunks !== 'number')
+        return null;
+    return {
+        chunkIndex,
+        totalChunks,
+        ...(typeof message.nonEmptyChunks === 'number' ? { nonEmptyChunks: message.nonEmptyChunks } : {}),
+        ...(typeof message.label === 'string' ? { label: message.label } : {}),
+    };
+}
+/**
+ * Turn one bake payload into a progress event, or null when it should be dropped by the throttle.
+ *
+ * The final chunk and the label-only phases ALWAYS pass: the last chunk is what tells a watcher the
+ * loop finished rather than stalled, and the phase labels are the only thing said during the upload
+ * that follows it. Exported for unit testing — this is the whole of the bake's progress logic, and
+ * it is worth being able to exercise it without a browser.
+ */
+export function bakeProgressEvent(message, state, at) {
+    const progress = asBakeProgress(message);
+    if (progress === null)
+        return null;
+    const isPhaseLabel = progress.totalChunks <= 0;
+    const isFinalChunk = !isPhaseLabel && progress.chunkIndex + 1 >= progress.totalChunks;
+    if (!isFinalChunk && !isPhaseLabel && at - state.lastAt < BAKE_PROGRESS_MIN_INTERVAL_MS)
+        return null;
+    state.lastAt = at;
+    if (isPhaseLabel) {
+        return {
+            step: 'voxelize',
+            phase: 'update',
+            message: `Baking the level — ${progress.label ?? 'working'}`,
+            ...(progress.label ? { detail: progress.label } : {}),
+        };
+    }
+    const done = progress.chunkIndex + 1;
+    const percent = Math.floor((done / progress.totalChunks) * 100);
+    const filled = progress.nonEmptyChunks === undefined ? '' : `, ${progress.nonEmptyChunks} non-empty`;
+    return {
+        step: 'voxelize',
+        phase: 'update',
+        message: `Baking the level — chunk ${done}/${progress.totalChunks} (${percent}%${filled})`,
+        completed: done,
+        total: progress.totalChunks,
+        ...(progress.label ? { detail: progress.label } : {}),
+    };
+}
 /**
  * Bake the level. Tagged instance groups are skipped (objectAssetInstances).
  * Single attempt: a timed-out bake must not be silently re-run.
@@ -19,6 +77,14 @@ export async function voxelizeLevel(store, deps) {
     const input = await requireArtifact(store, 'input');
     const forge = await requireArtifact(store, 'forge');
     const requestId = forgeRequestId();
+    emitForgeProgress(deps, {
+        step: 'voxelize',
+        phase: 'start',
+        message: 'Baking the level (the long step — chunk progress follows)',
+    });
+    // -Infinity, not 0: the FIRST message must always pass. A zero start throttles it whenever the
+    // clock begins near zero, which is exactly the moment a watcher most needs to see the bake begin.
+    const throttle = { lastAt: -Infinity };
     const result = await deps.transport.sendAndWait({
         type: 'VOXELIZE_GLB_AS_LEVEL',
         requestId,
@@ -30,8 +96,17 @@ export async function voxelizeLevel(store, deps) {
         options: forge.voxelizeOptions,
     }, 'VOXELIZE_GLB_AS_LEVEL_RESULT', VOXELIZE_TIMEOUT_MS, 
     // Single attempt (a timed-out bake must not be silently re-fired), but the
-    // timeout is now idle-based: per-chunk progress re-arms it.
-    { maxRetries: 1, progressType: VOXELIZE_PROGRESS_TYPE });
+    // timeout is now idle-based: per-chunk progress re-arms it — and the same
+    // messages are now also reported on, rather than only counted.
+    {
+        maxRetries: 1,
+        progressType: VOXELIZE_PROGRESS_TYPE,
+        onProgress: (message) => {
+            const event = bakeProgressEvent(message, throttle, Date.now());
+            if (event)
+                emitForgeProgress(deps, event);
+        },
+    });
     if (!result) {
         throw new ForgeStepError('Level voxelization timed out. The editor (browser) must be open for baking. The designed GLB was uploaded and can be voxelized manually from the Assets tab.', forge.glbUrl);
     }
@@ -58,6 +133,13 @@ export async function voxelizeLevel(store, deps) {
         ...(notes.length > 0 ? { notes } : {}),
     };
     await store.put('level-bake', bake);
+    emitForgeProgress(deps, {
+        step: 'voxelize',
+        phase: 'done',
+        message: bake.nonEmptyChunkCount === undefined
+            ? 'Level baked'
+            : `Level baked (${bake.nonEmptyChunkCount} non-empty chunks)`,
+    });
     deps.logger.info({ jobId: store.jobId, vwldUrl: bake.vwldUrl, chunks: bake.nonEmptyChunkCount, navUrl: forge.navUrl, unmatched }, 'Level baked');
 }
 //# sourceMappingURL=voxelize-level.js.map

package/dist/pipeline/voxelize-level.js.map

@@ -1 +1 @@
-{"version":3,"file":"voxelize-level.js","sourceRoot":"","sources":["../../src/pipeline/voxelize-level.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAClD,gFAAgF;AAChF,MAAM,sBAAsB,GAAG,gCAAgC,CAAC;AAEhE;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,KAAsB,EAAE,IAAe;IACzE,MAAM,KAAK,GAAG,MAAM,eAAe,CAAgB,KAAK,EAAE,OAAO,CAAC,CAAC;IACnE,MAAM,KAAK,GAAG,MAAM,eAAe,CAAgB,KAAK,EAAE,OAAO,CAAC,CAAC;IACnE,MAAM,SAAS,GAAG,cAAc,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAC7C;QACE,IAAI,EAAE,uBAAuB;QAC7B,SAAS;QACT,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,SAAS,EAAE,KAAK,CAAC,IAAI;QACrB,yEAAyE;QACzE,wEAAwE;QACxE,8DAA8D;QAC9D,OAAO,EAAE,KAAK,CAAC,eAAe;KAC/B,EACD,8BAA8B,EAC9B,mBAAmB;IACnB,2EAA2E;IAC3E,4DAA4D;IAC5D,EAAE,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE,sBAAsB,EAAE,CACxD,CAAC;IAEF,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,cAAc,CACtB,8JAA8J,EAC9J,KAAK,CAAC,MAAM,CACb,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,cAAc,CACtB,8BAA+B,MAAM,CAAC,KAAgB,IAAK,MAAM,CAAC,OAAkB,IAAI,eAAe,EAAE,EACzG,KAAK,CAAC,MAAM,CACb,CAAC;IACJ,CAAC;IAED,0EAA0E;IAC1E,qDAAqD;IACrD,MAAM,SAAS,GAAI,MAAM,CAAC,iBAA0C,IAAI,EAAE,CAAC;IAC3E,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC;QAChC,CAAC,CAAC,CAAC,gDAAgD,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,+BAA+B,CAAC;QACvG,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,IAAI,GAAsB;QAC9B,OAAO,EAAE,MAAM,CAAC,OAAiB;QACjC,WAAW,EAAE;YACX,GAAI,MAAM,CAAC,WAAuC;YAClD,wEAAwE;YACxE,oEAAoE;YACpE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClD;QACD,kBAAkB,EAAE,MAAM,CAAC,kBAAwC;QACnE,eAAe,EAAE,MAAM,CAAC,eAAqC;QAC7D,qBAAqB,EAAE,MAAM,CAAC,qBAA2C;QACzE,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvC,CAAC;IACF,MAAM,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,kBAAkB,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,aAAa,CAAC,CAAC;AACnJ,CAAC"}
+{"version":3,"file":"voxelize-level.js","sourceRoot":"","sources":["../../src/pipeline/voxelize-level.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAA2B,MAAM,qBAAqB,CAAC;AAEjF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAClD,gFAAgF;AAChF,MAAM,sBAAsB,GAAG,gCAAgC,CAAC;AAEhE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,IAAI,CAAC;AAWlD,SAAS,cAAc,CAAC,OAAgC;IACtD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAC5C,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,OAAO,WAAW,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACnF,OAAO;QACL,UAAU;QACV,WAAW;QACX,GAAG,CAAC,OAAO,OAAO,CAAC,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjG,GAAG,CAAC,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvE,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAgC,EAChC,KAAyB,EACzB,EAAU;IAEV,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IACzC,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACnC,MAAM,YAAY,GAAG,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC;IAC/C,MAAM,YAAY,GAAG,CAAC,YAAY,IAAI,QAAQ,CAAC,UAAU,GAAG,CAAC,IAAI,QAAQ,CAAC,WAAW,CAAC;IACtF,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,IAAI,EAAE,GAAG,KAAK,CAAC,MAAM,GAAG,6BAA6B;QAAE,OAAO,IAAI,CAAC;IACrG,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;IAElB,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO;YACL,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,sBAAsB,QAAQ,CAAC,KAAK,IAAI,SAAS,EAAE;YAC5D,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACtD,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,GAAG,CAAC,CAAC;IACrC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,GAAG,GAAG,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,QAAQ,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,cAAc,YAAY,CAAC;IACrG,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,QAAQ;QACf,OAAO,EAAE,4BAA4B,IAAI,IAAI,QAAQ,CAAC,WAAW,KAAK,OAAO,IAAI,MAAM,GAAG;QAC1F,SAAS,EAAE,IAAI;QACf,KAAK,EAAE,QAAQ,CAAC,WAAW;QAC3B,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtD,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,KAAsB,EAAE,IAAe;IACzE,MAAM,KAAK,GAAG,MAAM,eAAe,CAAgB,KAAK,EAAE,OAAO,CAAC,CAAC;IACnE,MAAM,KAAK,GAAG,MAAM,eAAe,CAAgB,KAAK,EAAE,OAAO,CAAC,CAAC;IACnE,MAAM,SAAS,GAAG,cAAc,EAAE,CAAC;IACnC,iBAAiB,CAAC,IAAI,EAAE;QACtB,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,OAAO;QACd,OAAO,EAAE,2DAA2D;KACrE,CAAC,CAAC;IACH,+FAA+F;IAC/F,kGAAkG;IAClG,MAAM,QAAQ,GAAG,EAAE,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC;IACvC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAC7C;QACE,IAAI,EAAE,uBAAuB;QAC7B,SAAS;QACT,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,SAAS,EAAE,KAAK,CAAC,IAAI;QACrB,yEAAyE;QACzE,wEAAwE;QACxE,8DAA8D;QAC9D,OAAO,EAAE,KAAK,CAAC,eAAe;KAC/B,EACD,8BAA8B,EAC9B,mBAAmB;IACnB,2EAA2E;IAC3E,0EAA0E;IAC1E,+DAA+D;IAC/D;QACE,UAAU,EAAE,CAAC;QACb,YAAY,EAAE,sBAAsB;QACpC,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE;YACtB,MAAM,KAAK,GAAG,iBAAiB,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YAC/D,IAAI,KAAK;gBAAE,iBAAiB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC;KACF,CACF,CAAC;IAEF,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,cAAc,CACtB,8JAA8J,EAC9J,KAAK,CAAC,MAAM,CACb,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,cAAc,CACtB,8BAA+B,MAAM,CAAC,KAAgB,IAAK,MAAM,CAAC,OAAkB,IAAI,eAAe,EAAE,EACzG,KAAK,CAAC,MAAM,CACb,CAAC;IACJ,CAAC;IAED,0EAA0E;IAC1E,qDAAqD;IACrD,MAAM,SAAS,GAAI,MAAM,CAAC,iBAA0C,IAAI,EAAE,CAAC;IAC3E,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC;QAChC,CAAC,CAAC,CAAC,gDAAgD,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,+BAA+B,CAAC;QACvG,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,IAAI,GAAsB;QAC9B,OAAO,EAAE,MAAM,CAAC,OAAiB;QACjC,WAAW,EAAE;YACX,GAAI,MAAM,CAAC,WAAuC;YAClD,wEAAwE;YACxE,oEAAoE;YACpE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClD;QACD,kBAAkB,EAAE,MAAM,CAAC,kBAAwC;QACnE,eAAe,EAAE,MAAM,CAAC,eAAqC;QAC7D,qBAAqB,EAAE,MAAM,CAAC,qBAA2C;QACzE,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvC,CAAC;IACF,MAAM,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IACpC,iBAAiB,CAAC,IAAI,EAAE;QACtB,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,IAAI,CAAC,kBAAkB,KAAK,SAAS;YAC5C,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,gBAAgB,IAAI,CAAC,kBAAkB,oBAAoB;KAChE,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,kBAAkB,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,aAAa,CAAC,CAAC;AACnJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitmagic/world-forger",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Client half of the Bitmagic world forger: the forged-level artifact schema, the host seams, and the browser pipeline steps that bake archetypes, bake a level and place its instances.",
   "license": "MIT",
   "type": "module",