@forgeax/engine-runtime 0.1.23 → 0.1.25

package/src/__tests__/render-data.cases.unit.test.ts

@@ -0,0 +1,553 @@
+// @ts-nocheck — merged file: cross-source node:fs/node:path imports outside @types/node coverage in runtime tsconfig
+// Consolidated by feat-20260609-test-pool-startup-reduction-merge-tiny-test-files
+// biome-ignore-all lint/complexity/noUselessLoneBlockStatements: block-scope isolation between merged source files (consolidation paradigm)
+//
+// Source files (N=33):
+//   - packages/runtime/__tests__/create-renderer-fallback.test.ts
+//   - packages/runtime/src/__tests__/cluster-binner.test.ts
+//   - packages/runtime/src/__tests__/create-renderer-fallback-shader-manifest.test.ts
+//   - packages/runtime/src/__tests__/create-renderer-uniform-fallback.test.ts
+//   - packages/runtime/src/__tests__/createRenderer.test.ts
+//   - packages/runtime/src/__tests__/dispatch-sort.test.ts
+//   - packages/runtime/src/__tests__/engine-metrics.test.ts
+//   - packages/runtime/src/__tests__/device/gpu-residency-caps-guard.test.ts
+//   - packages/runtime/src/__tests__/pass-selector.test.ts
+//   - packages/runtime/src/__tests__/pipeline-builder.test.ts
+//   - packages/runtime/src/__tests__/pipeline-cache-key-topology.test.ts
+//   - packages/runtime/src/__tests__/pipeline-rename-grep-gate.test.ts
+//   - packages/runtime/src/__tests__/pipeline-vertex-stride-branch.test.ts
+//   - packages/runtime/src/__tests__/post-process-register.test.ts
+//   - packages/runtime/src/__tests__/record-all-topology.test.ts
+//   - packages/runtime/src/__tests__/record-draw-branch.test.ts
+//   - packages/runtime/src/__tests__/record-strip-index-format.test.ts
+//   - packages/runtime/src/__tests__/render-query-regression.test.ts
+//   - packages/runtime/src/__tests__/renderer-draw-world.test.ts
+//   - packages/runtime/src/__tests__/renderer-input-snapshot.test.ts
+//   - packages/runtime/src/__tests__/renderer-read-pixels.test.ts
+//   - packages/runtime/src/__tests__/renderer-ready.test.ts
+//   - packages/runtime/src/__tests__/renderstate-pipeline-cache.test.ts
+//   - packages/runtime/src/__tests__/storage-buffer-caps.test.ts
+//   - packages/runtime/src/__tests__/device/gpu-residency.test.ts
+//   - packages/runtime/src/__tests__/render-data.test.ts
+//   - packages/runtime/src/__tests__/hdrp-bgl-slots.test.ts
+//   - packages/runtime/src/__tests__/hdrp-caps-gate.test.ts
+//   - packages/runtime/src/__tests__/hdrp-grid-invalid.test.ts
+//   - packages/runtime/src/__tests__/hdrp-index-list-overflow-once.test.ts
+//   - packages/runtime/src/__tests__/hdrp-light-budget.test.ts
+//   - packages/runtime/src/__tests__/hdrp-pipeline-asset-config.test.ts
+//   - packages/runtime/src/__tests__/m7-hdrp-demo-shape.test.ts
+//
+// Paradigm: each block-scope wraps a source file. ancestorTitles[0] is the
+// source-preserved inner describe (NOT the source filename for these 3 files
+// — recovery path: vitest report ancestorTitles -> grep this file -> upstream
+// `// ─── from <name>.test.ts ───` block separator -> source filename).
+// Top-level imports merged + deduped.
+
+import { existsSync, readFileSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { HANDLE_CUBE, HANDLE_TRIANGLE, resolveAssetHandle } from '@forgeax/engine-assets-runtime';
+import type { World as WorldType } from '@forgeax/engine-ecs';
+import { defineComponent, World } from '@forgeax/engine-ecs';
+import {
+  buildMeshAttributeMapForUvSets,
+  createBoxGeometry,
+  createConeGeometry,
+  createCylinderGeometry,
+  createPlaneGeometry,
+  createSphereGeometry,
+  createTorusGeometry,
+  PROCEDURAL_FLOATS_PER_VERTEX,
+} from '@forgeax/engine-geometry';
+import { type Mat4, mat4, type Vec3, vec3 } from '@forgeax/engine-math';
+import type { Renderer as RendererType } from '@forgeax/engine-render';
+import { Camera, MeshFilter, MeshRenderer } from '@forgeax/engine-render';
+import {
+  err,
+  ok,
+  type PipelineLayout,
+  type RenderPipeline,
+  type Result,
+  type RhiCaps,
+  type RhiDevice,
+  RhiError,
+  ok as rhiOk,
+  type ShaderModule,
+} from '@forgeax/engine-rhi';
+import {
+  acquireCanvasContext as acquireNullCanvasContext,
+  createShaderModule as createNullShaderModule,
+  RhiNullAdapter,
+} from '@forgeax/engine-rhi-null';
+import { ChildOf, Transform } from '@forgeax/engine-scene';
+import {
+  findVariantByKey,
+  type MaterialShaderEntry,
+  type MaterialShaderManifestEntry,
+  type MaterialShaderManifestVariant,
+} from '@forgeax/engine-shader';
+import {
+  type AssetError,
+  type EquirectAsset,
+  type Handle,
+  type MaterialRenderState,
+  type MeshAsset,
+  type PassSelector,
+  type PrimitiveTopology,
+  type RenderPipelineAsset,
+  type TextureAsset,
+  toShared,
+} from '@forgeax/engine-types';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import {
+  bin,
+  type ClusterBinError,
+  calculateSphereClusterBounds,
+  clusterSpaceObjectAabb,
+  deriveCullingRadius,
+  ndcPositionToCluster,
+  viewZToZSlice,
+} from '../../../render/src/cluster-binner';
+import { GpuResidencyCache } from '../../../render/src/device/gpu-residency';
+import { createEngineMetrics } from '../../../render/src/engine-metrics';
+import { assertStorageBufferCap } from '../../../render/src/light-buffer-layout';
+import {
+  buildPbrPipelineLayouts,
+  buildPbrViewBglEntries,
+  type PbrCaps,
+} from '../../../render/src/pbr-pipeline';
+import {
+  HdrpInstallError,
+  validateClusterGrid,
+} from '../../../render/src/pipeline/standard-pipeline';
+import {
+  buildPipelineForMaterialShader,
+  type PipelineBuilderContext,
+  type PipelineBuilderShaderModuleFactory,
+} from '../../../render/src/pipeline-builder';
+import {
+  cacheKeyOf,
+  createHdrpBindGroupLayoutDescriptor,
+  type PipelineSpec,
+} from '../../../render/src/pipeline-spec';
+import {
+  deriveRenderDataCubemap,
+  deriveRenderDataMesh,
+  deriveRenderDataTexture,
+} from '../../../render/src/render-data';
+import { extractFrame, prepareExtractContext } from '../../../render/src/render-system-extract';
+import { matchPass } from '../../../render/src/systems/pass-selector';
+import { makeMockShaderRegistry } from './helpers/mock-shader-registry';
+import { standardMaterialShaderVariants } from './helpers/standard-material-manifest';
+
+function makeExplicitNullRhi(spies: {
+  setIndexBuffer: ReturnType<typeof vi.fn>;
+  setVertexBuffer: ReturnType<typeof vi.fn>;
+  draw: ReturnType<typeof vi.fn>;
+  drawIndexed: ReturnType<typeof vi.fn>;
+}): unknown {
+  const adapter = new RhiNullAdapter();
+  const requestDevice = adapter.requestDevice.bind(adapter);
+  adapter.requestDevice = async () => {
+    const result = await requestDevice();
+    if (result.ok) {
+      const device = result.value;
+      const createCommandEncoder = device.createCommandEncoder.bind(device);
+      device.createCommandEncoder = (desc) => {
+        const encoderResult = createCommandEncoder(desc);
+        if (!encoderResult.ok) return encoderResult;
+        const encoder = encoderResult.value;
+        const beginRenderPass = encoder.beginRenderPass.bind(encoder);
+        encoder.beginRenderPass = (passDesc) => {
+          const pass = beginRenderPass(passDesc);
+          const draw = pass.draw.bind(pass);
+          const drawIndexed = pass.drawIndexed.bind(pass);
+          const setIndexBuffer = pass.setIndexBuffer.bind(pass);
+          const setVertexBuffer = pass.setVertexBuffer.bind(pass);
+          pass.draw = (...args) => {
+            spies.draw(...args);
+            draw(...args);
+          };
+          pass.drawIndexed = (...args) => {
+            spies.drawIndexed(...args);
+            drawIndexed(...args);
+          };
+          pass.setIndexBuffer = (...args) => {
+            spies.setIndexBuffer(...args);
+            setIndexBuffer(...args);
+          };
+          pass.setVertexBuffer = (...args) => {
+            spies.setVertexBuffer(...args);
+            setVertexBuffer(...args);
+          };
+          return pass;
+        };
+        return { ok: true, value: encoder };
+      };
+    }
+    return result;
+  };
+  return {
+    requestAdapter: async () => ({ ok: true, value: adapter }),
+    acquireCanvasContext: acquireNullCanvasContext,
+    createShaderModule: (device: unknown, desc: { code: string; label?: string }) =>
+      createNullShaderModule(device as never, desc),
+  };
+}
+
+vi.mock('@forgeax/engine-rhi-wgpu', () => {
+  return {
+    rhi: {
+      requestAdapter: async () => ({
+        ok: false,
+        error: {
+          code: 'adapter-unavailable',
+          expected: 'adapter available',
+          hint: 'default mock fail',
+        },
+      }),
+      getPreferredCanvasFormat: () => 'bgra8unorm',
+      acquireCanvasContext: () => ({
+        ok: false,
+        error: {
+          code: 'webgpu-runtime-error',
+          expected: 'context available',
+          hint: 'default mock fail',
+        },
+      }),
+    },
+    ensureReady: async () => undefined,
+  };
+});
+
+void [
+  Camera,
+  ChildOf,
+  GpuResidencyCache,
+  HANDLE_CUBE,
+  HANDLE_TRIANGLE,
+  HdrpInstallError,
+  MeshFilter,
+  MeshRenderer,
+  PROCEDURAL_FLOATS_PER_VERTEX,
+  RhiError,
+  RhiNullAdapter,
+  Transform,
+  World,
+  acquireNullCanvasContext,
+  afterEach,
+  assertStorageBufferCap,
+  beforeEach,
+  bin,
+  buildMeshAttributeMapForUvSets,
+  buildPbrPipelineLayouts,
+  buildPbrViewBglEntries,
+  buildPipelineForMaterialShader,
+  cacheKeyOf,
+  calculateSphereClusterBounds,
+  clusterSpaceObjectAabb,
+  createBoxGeometry,
+  createConeGeometry,
+  createCylinderGeometry,
+  createEngineMetrics,
+  createHdrpBindGroupLayoutDescriptor,
+  createNullShaderModule,
+  createPlaneGeometry,
+  createSphereGeometry,
+  createTorusGeometry,
+  defineComponent,
+  deriveCullingRadius,
+  deriveRenderDataCubemap,
+  deriveRenderDataMesh,
+  deriveRenderDataTexture,
+  describe,
+  dirname,
+  err,
+  existsSync,
+  expect,
+  extractFrame,
+  fileURLToPath,
+  findVariantByKey,
+  it,
+  makeExplicitNullRhi,
+  makeMockShaderRegistry,
+  mat4,
+  matchPass,
+  ndcPositionToCluster,
+  ok,
+  prepareExtractContext,
+  readFileSync,
+  resolve,
+  resolveAssetHandle,
+  rhiOk,
+  standardMaterialShaderVariants,
+  toShared,
+  validateClusterGrid,
+  vec3,
+  vi,
+  viewZToZSlice,
+];
+type __MergedKeep =
+  | AssetError
+  | ClusterBinError
+  | EquirectAsset
+  | Handle
+  | Mat4
+  | MaterialRenderState
+  | MaterialShaderEntry
+  | MaterialShaderManifestEntry
+  | MaterialShaderManifestVariant
+  | MeshAsset
+  | PassSelector
+  | PbrCaps
+  | PipelineBuilderContext
+  | PipelineBuilderShaderModuleFactory
+  | PipelineLayout
+  | PipelineSpec
+  | PrimitiveTopology
+  | RenderPipeline
+  | RenderPipelineAsset
+  | RendererType
+  | Result
+  | RhiCaps
+  | RhiDevice
+  | ShaderModule
+  | TextureAsset
+  | Vec3
+  | WorldType;
+
+// Split source block: render data derivation contract.
+{
+  // --- from render-data.test.ts (__tests__/) ---
+  const GPU_BUFFER_USAGE_VERTEX = 0x20;
+  const GPU_BUFFER_USAGE_INDEX = 0x10;
+  const GPU_BUFFER_USAGE_COPY_DST = 0x08;
+  const TEXTURE_BINDING = 0x4;
+  const COPY_SRC = 0x1;
+  const COPY_DST = 0x2;
+  const RENDER_ATTACHMENT = 0x10;
+
+  function meshPod(overrides: Partial<MeshAsset> = {}): MeshAsset {
+    return {
+      kind: 'mesh',
+      vertices: new Float32Array(4 * 12),
+      indices: new Uint16Array([0, 1, 2, 0, 2, 3]),
+      attributes: buildMeshAttributeMapForUvSets(1),
+      aabb: new Float32Array(6),
+      ...overrides,
+      submeshes: [
+        {
+          indexOffset: 0,
+          indexCount: 6,
+          vertexCount: 0,
+          topology: 'triangle-list',
+        },
+      ],
+    };
+  }
+
+  function texturePod(
+    mipmap: boolean,
+    format: GPUTextureFormat = 'rgba8unorm-srgb',
+    width = 4,
+    height = 4,
+  ): TextureAsset {
+    return {
+      kind: 'texture',
+      shape: { viewDimension: '2d', extent: { width, height } },
+      format,
+      data: new Uint8Array(width * height * 4).fill(170),
+      colorSpace: format.endsWith('-srgb') ? 'srgb' : 'linear',
+      mips: mipmap ? { kind: 'generate' } : { kind: 'none' },
+    };
+  }
+
+  function equirectSource(
+    format: GPUTextureFormat,
+    colorSpace: 'srgb' | 'linear',
+    width = 8,
+    height = 4,
+  ): TextureAsset {
+    return {
+      kind: 'texture',
+      shape: { viewDimension: '2d', extent: { width, height } },
+      format,
+      data: new Uint8Array(width * height * 8),
+      colorSpace,
+      mips: { kind: 'none' },
+    };
+  }
+
+  describe('deriveRenderDataMesh', () => {
+    it('derives vertex / index buffer descriptors from a mesh POD', () => {
+      const res = deriveRenderDataMesh(meshPod());
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      const rd = res.value;
+      expect(rd.vertexByteLength).toBe(4 * 12 * 4); // 48 floats * 4 bytes
+      // 6 uint16 indices = 12 bytes, padded up to 4-byte multiple = 12
+      expect(rd.indexByteLength).toBe(12);
+      expect(rd.indexCount).toBe(6);
+      expect(rd.indexFormat).toBe('uint16');
+      expect(rd.layoutProjection.arrayStride).toBe(48);
+      expect(rd.layoutProjection.attributes.map((attribute) => attribute.key)).toEqual([
+        'position',
+        'normal',
+        'uv',
+        'tangent',
+      ]);
+      expect(rd.vertexUsage).toBe(GPU_BUFFER_USAGE_VERTEX | GPU_BUFFER_USAGE_COPY_DST);
+      expect(rd.indexUsage).toBe(GPU_BUFFER_USAGE_INDEX | GPU_BUFFER_USAGE_COPY_DST);
+    });
+
+    it('pads index byte length up to a 4-byte multiple and tags uint32', () => {
+      // 3 uint32 indices = 12 bytes (already aligned), format uint32
+      const res = deriveRenderDataMesh(meshPod({ indices: new Uint32Array([0, 1, 2]) }));
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      expect(res.value.indexFormat).toBe('uint32');
+      expect(res.value.indexCount).toBe(3);
+      expect(res.value.indexByteLength).toBe(12);
+    });
+
+    it('rounds an odd uint16 index count up to the next 4-byte multiple', () => {
+      // 5 uint16 = 10 bytes -> padded to 12
+      const res = deriveRenderDataMesh(meshPod({ indices: new Uint16Array([0, 1, 2, 3, 4]) }));
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      expect(res.value.indexByteLength).toBe(12);
+      expect(res.value.indexCount).toBe(5);
+    });
+  });
+
+  describe('deriveRenderDataTexture', () => {
+    it('derives a single-level descriptor when mipmap is false', () => {
+      const res = deriveRenderDataTexture(texturePod(false));
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      const rd = res.value;
+      expect(rd.width).toBe(4);
+      expect(rd.height).toBe(4);
+      expect(rd.format).toBe('rgba8unorm-srgb');
+      expect(rd.mipLevelCount).toBe(1);
+      expect(rd.usage).toBe(TEXTURE_BINDING | COPY_SRC | COPY_DST | RENDER_ATTACHMENT);
+      expect(rd.bytesPerRow).toBe(4 * 4);
+    });
+
+    it('computes mipLevelCount from dimensions when mipmap is true', () => {
+      // 8x8 -> log2(8)+1 = 4 levels
+      const res = deriveRenderDataTexture(texturePod(true, 'rgba8unorm-srgb', 8, 8));
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      expect(res.value.mipLevelCount).toBe(4);
+    });
+
+    it('asserts format <-> colorSpace consistency (srgb format requires srgb colorSpace)', () => {
+      const bad: TextureAsset = { ...texturePod(false, 'rgba8unorm-srgb'), colorSpace: 'linear' };
+      const res = deriveRenderDataTexture(bad);
+      expect(res.ok).toBe(false);
+      if (res.ok) return;
+      expect(res.error.code).toBe('invalid-source-format');
+    });
+
+    it('accepts a linear format with linear colorSpace', () => {
+      const res = deriveRenderDataTexture(texturePod(false, 'rgba8unorm'));
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      expect(res.value.format).toBe('rgba8unorm');
+    });
+
+    it('derives the row pitch from an rgba16float source payload', () => {
+      const source = texturePod(false, 'rgba16float');
+      const res = deriveRenderDataTexture({
+        ...source,
+        data: new Uint8Array(source.shape.extent.width * source.shape.extent.height * 8),
+      });
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      expect(res.value.bytesPerRow).toBe(source.shape.extent.width * 8);
+    });
+
+    it('derives row pitch from format when an rgba8 decoder retains trailing bytes', () => {
+      const source = texturePod(false, 'rgba8unorm');
+      const res = deriveRenderDataTexture({
+        ...source,
+        data: new Uint8Array(
+          source.shape.extent.width * source.shape.extent.height * 4 + source.shape.extent.width,
+        ),
+      });
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      expect(res.value.bytesPerRow).toBe(source.shape.extent.width * 4);
+    });
+
+    it('derives the row pitch from an rgba32float source payload', () => {
+      const source = texturePod(false, 'rgba32float');
+      const res = deriveRenderDataTexture({
+        ...source,
+        data: new Uint8Array(source.shape.extent.width * source.shape.extent.height * 16),
+      });
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      expect(res.value.bytesPerRow).toBe(source.shape.extent.width * 16);
+    });
+
+    it('rejects an uncompressed payload shorter than its base mip', () => {
+      const source = texturePod(false, 'rgba16float');
+      const res = deriveRenderDataTexture({ ...source, data: new Uint8Array(1) });
+      expect(res.ok).toBe(false);
+      if (res.ok) return;
+      expect(res.error.code).toBe('invalid-source-format');
+    });
+  });
+
+  describe('deriveRenderDataCubemap', () => {
+    it('derives cubeFaceSize + output format from a valid rgba16float equirect source', () => {
+      const res = deriveRenderDataCubemap(equirectSource('rgba16float', 'linear', 8, 4));
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      const rd = res.value;
+      expect(rd.cubeFaceSize).toBe(4); // == source height
+      expect(rd.outputFormat).toBe('rgba16float');
+      expect(rd.needsHalfConversion).toBe(false);
+      expect(rd.cubeUsage).toBe(TEXTURE_BINDING | COPY_DST | RENDER_ATTACHMENT | 0x1);
+    });
+
+    it('flags rgba32float -> rgba16float conversion and narrows the output format', () => {
+      const res = deriveRenderDataCubemap(equirectSource('rgba32float', 'linear', 8, 4));
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      expect(res.value.outputFormat).toBe('rgba16float');
+      expect(res.value.needsHalfConversion).toBe(true);
+    });
+
+    it('rejects a non-float / non-linear source with invalid-source-format', () => {
+      const res = deriveRenderDataCubemap(equirectSource('rgba8unorm', 'linear', 8, 4));
+      expect(res.ok).toBe(false);
+      if (res.ok) return;
+      expect(res.error.code).toBe('invalid-source-format');
+    });
+
+    it('rejects an rgba16float source whose colorSpace is not linear', () => {
+      const res = deriveRenderDataCubemap(equirectSource('rgba16float', 'srgb', 8, 4));
+      expect(res.ok).toBe(false);
+      if (res.ok) return;
+      expect(res.error.code).toBe('invalid-source-format');
+    });
+
+    it('the cube POD it implies is square (width === height === cubeFaceSize)', () => {
+      const res = deriveRenderDataCubemap(equirectSource('rgba16float', 'linear', 16, 8));
+      expect(res.ok).toBe(true);
+      if (!res.ok) return;
+      const cube: CubeTextureAsset = {
+        kind: 'cube-texture',
+        width: res.value.cubeFaceSize,
+        height: res.value.cubeFaceSize,
+        format: res.value.outputFormat,
+        faces: [],
+      };
+      expect(cube.width).toBe(cube.height);
+      expect(cube.width).toBe(8);
+    });
+  });
+}

package/src/__tests__/render-error-exhaustive.test-d.ts

@@ -195,6 +195,7 @@ function narrowRenderError(err: RenderError): void {
     case 'recovery-failed':
       void err.detail.operation;
       void err.detail.oldGeneration;
+      void err.detail.candidateGeneration;
       void err.detail.cause;
       break;
     case 'cleanup-failed':