@lightningjs/renderer 3.0.0-beta9 → 3.0.1

package/src/core/renderers/webgl/WebGlCtxRenderTexture.ts

@@ -1,86 +1,89 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2024 Comcast Cable Communications Management, LLC.
- *
- * Licensed under the Apache License, Version 2.0 (the License);
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import type { Dimensions } from '../../../common/CommonTypes.js';
-import { assertTruthy } from '../../../utils.js';
-import type { TextureMemoryManager } from '../../TextureMemoryManager.js';
-import type { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
-import type { RenderTexture } from '../../textures/RenderTexture.js';
-import { WebGlCtxTexture } from './WebGlCtxTexture.js';
-
-export class WebGlCtxRenderTexture extends WebGlCtxTexture {
-  declare textureSource: RenderTexture;
-
-  public framebuffer: WebGLFramebuffer | null = null;
-
-  constructor(
-    glw: WebGlContextWrapper,
-    memManager: TextureMemoryManager,
-    textureSource: RenderTexture,
-  ) {
-    super(glw, memManager, textureSource);
-  }
-
-  override async onLoadRequest(): Promise<Dimensions> {
-    const { glw } = this;
-    const nativeTexture = (this._nativeCtxTexture =
-      this.createNativeCtxTexture());
-    const { width, height } = this.textureSource;
-
-    // Create Framebuffer object
-    this.framebuffer = glw.createFramebuffer();
-
-    // Set the dimensions of the render texture
-    glw.texImage2D(
-      0,
-      glw.RGBA,
-      width,
-      height,
-      0,
-      glw.RGBA,
-      glw.UNSIGNED_BYTE,
-      null,
-    );
-
-    // Update the texture memory manager
-    this.setTextureMemUse(width * height * 4);
-
-    // Bind the framebuffer
-    glw.bindFramebuffer(this.framebuffer);
-
-    // Attach the texture to the framebuffer
-    glw.framebufferTexture2D(glw.COLOR_ATTACHMENT0, nativeTexture, 0);
-
-    // Unbind the framebuffer
-    glw.bindFramebuffer(null);
-
-    return {
-      width,
-      height,
-    };
-  }
-
-  override free(): void {
-    super.free();
-
-    // Delete the framebuffer
-    this.glw.deleteFramebuffer(this.framebuffer);
-    this.framebuffer = null;
-  }
-}
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2024 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Dimensions } from '../../../common/CommonTypes.js';
+import type { TextureMemoryManager } from '../../TextureMemoryManager.js';
+import type { GlContextWrapper } from '../../platforms/GlContextWrapper.js';
+import type { Bound } from '../../lib/utils.js';
+import type { RenderTexture } from '../../textures/RenderTexture.js';
+import { WebGlCtxTexture } from './WebGlCtxTexture.js';
+
+export class WebGlCtxRenderTexture extends WebGlCtxTexture {
+  declare textureSource: RenderTexture;
+
+  public framebuffer: WebGLFramebuffer | null = null;
+
+  override txCoords: Bound = {
+    x1: 0,
+    y1: 1,
+    x2: 1,
+    y2: 0,
+  };
+
+  constructor(
+    glw: GlContextWrapper,
+    memManager: TextureMemoryManager,
+    textureSource: RenderTexture,
+  ) {
+    super(glw, memManager, textureSource);
+  }
+
+  override async onLoadRequest(): Promise<Dimensions> {
+    const { glw } = this;
+    const nativeTexture = (this._nativeCtxTexture =
+      this.createNativeCtxTexture());
+
+    if (!nativeTexture) {
+      throw new Error('Failed to create native texture for RenderTexture');
+    }
+
+    const { w, h } = this.textureSource;
+
+    // Create Framebuffer object
+    this.framebuffer = glw.createFramebuffer();
+
+    // Set the dimensions of the render texture
+    glw.texImage2D(0, glw.RGBA, w, h, 0, glw.RGBA, glw.UNSIGNED_BYTE, null);
+
+    // Update the texture memory manager
+    this.setTextureMemUse(w * h * 4);
+
+    // Bind the framebuffer
+    glw.bindFramebuffer(this.framebuffer);
+
+    // Attach the texture to the framebuffer
+    glw.framebufferTexture2D(glw.COLOR_ATTACHMENT0, nativeTexture, 0);
+
+    // Unbind the framebuffer
+    glw.bindFramebuffer(null);
+
+    return {
+      w,
+      h,
+    };
+  }
+
+  override free(): void {
+    super.free();
+
+    // Delete the framebuffer
+    this.glw.deleteFramebuffer(this.framebuffer);
+    this.framebuffer = null;
+  }
+}

package/src/core/renderers/webgl/WebGlCtxSubTexture.ts

@@ -1,50 +1,95 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2023 Comcast Cable Communications Management, LLC.
- *
- * Licensed under the Apache License, Version 2.0 (the License);
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import type { Dimensions } from '../../../common/CommonTypes.js';
-import { assertTruthy } from '../../../utils.js';
-import type { TextureMemoryManager } from '../../TextureMemoryManager.js';
-import type { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
-import type { SubTexture } from '../../textures/SubTexture.js';
-import { WebGlCtxTexture } from './WebGlCtxTexture.js';
-
-export class WebGlCtxSubTexture extends WebGlCtxTexture {
-  constructor(
-    glw: WebGlContextWrapper,
-    memManager: TextureMemoryManager,
-    textureSource: SubTexture,
-  ) {
-    super(glw, memManager, textureSource);
-  }
-
-  override async onLoadRequest(): Promise<Dimensions> {
-    const props = (this.textureSource as SubTexture).textureData;
-    assertTruthy(props, 'SubTexture must have texture data');
-
-    if (props.data instanceof Uint8Array) {
-      // its a 1x1 Color Texture
-      return { width: 1, height: 1 };
-    }
-
-    return {
-      width: props.data?.width || 0,
-      height: props.data?.height || 0,
-    };
-  }
-}
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Dimensions } from '../../../common/CommonTypes.js';
+import { assertTruthy } from '../../../utils.js';
+import type { TextureMemoryManager } from '../../TextureMemoryManager.js';
+import type { GlContextWrapper } from '../../platforms/GlContextWrapper.js';
+import type { SubTexture } from '../../textures/SubTexture.js';
+import type { SubTextureProps } from '../../textures/SubTexture.js';
+import type { CompressedData } from '../../textures/Texture.js';
+import { WebGlCtxTexture } from './WebGlCtxTexture.js';
+
+export class WebGlCtxSubTexture extends WebGlCtxTexture {
+  constructor(
+    glw: GlContextWrapper,
+    memManager: TextureMemoryManager,
+    textureSource: SubTexture,
+  ) {
+    super(glw, memManager, textureSource);
+  }
+
+  override async onLoadRequest(): Promise<Dimensions> {
+    const props = (this.textureSource as SubTexture).textureData;
+    assertTruthy(props, 'SubTexture must have texture data');
+
+    if (props.data instanceof Uint8Array) {
+      // its a 1x1 Color Texture
+      return { w: 1, h: 1 };
+    }
+
+    return this.extractDimensions(props.data);
+  }
+
+  /**
+   * Efficiently extracts width/height from polymorphic texture data
+   * Optimized for performance by using type guards and avoiding unnecessary property access
+   */
+  private extractDimensions(
+    data:
+      | ImageBitmap
+      | ImageData
+      | SubTextureProps
+      | CompressedData
+      | HTMLImageElement
+      | null,
+  ): Dimensions {
+    if (data === null) {
+      return { w: 0, h: 0 };
+    }
+
+    // Check for standard web API objects first (most common case)
+    // These use width/height properties: ImageBitmap, ImageData, HTMLImageElement
+    if (this.hasWidthHeight(data) === true) {
+      return { w: data.width, h: data.height };
+    }
+
+    // Check for internal objects that use w/h properties: SubTextureProps, CompressedData
+    if (this.hasWH(data) === true) {
+      return { w: data.w, h: data.h };
+    }
+
+    // Fallback
+    return { w: 0, h: 0 };
+  }
+
+  /**
+   * Type guard for objects with width/height properties
+   */
+  private hasWidthHeight(data: any): data is { width: number; height: number } {
+    return typeof data.width === 'number' && typeof data.height === 'number';
+  }
+
+  /**
+   * Type guard for objects with w/h properties
+   */
+  private hasWH(data: any): data is { w: number; h: number } {
+    return typeof data.w === 'number' && typeof data.h === 'number';
+  }
+}

package/src/core/renderers/webgl/WebGlCtxTexture.test.ts

@@ -0,0 +1,113 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2026 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Tests proving the WebGL OOM / ctxTexture undefined crash scenario.
+ *
+ * Crash chain being simulated:
+ *   GL_OUT_OF_MEMORY from texImage2D
+ *   → Texture.release() sets ctxTexture = undefined (via microtask)
+ *   → WebGlRenderer.addQuad() reads tx.ctxTexture as WebGlCtxTexture (undefined)
+ *   → CoreNode.addTexture(undefined) pushes undefined into renderOpTextures
+ *   → WebGlShaderProgram.bindTextures() reads textures[0]!.ctxTexture
+ *   → TypeError: Cannot read property 'ctxTexture' of undefined  ← CRASH
+ *
+ * All tests here are RED before the fix and GREEN after.
+ */
+
+import { describe, expect, it, vi } from 'vitest';
+import { WebGlShaderProgram } from './WebGlShaderProgram.js';
+import { CoreNode } from '../../CoreNode.js';
+import type { WebGlCtxTexture } from './WebGlCtxTexture.js';
+
+// ---------------------------------------------------------------------------
+// Test 1 — bindTextures crashes when textures[0] is undefined
+//
+// Directly mirrors the crash from the production stack trace:
+//   fb.bindTextures → textures[0]!.ctxTexture
+//   → TypeError: Cannot read property 'ctxTexture' of undefined
+// ---------------------------------------------------------------------------
+describe('WebGlShaderProgram.bindTextures', () => {
+  it('does not throw when textures[0] is undefined', () => {
+    // Create a minimal instance that bypasses the GL-context-requiring constructor
+    const instance = Object.create(
+      WebGlShaderProgram.prototype,
+    ) as WebGlShaderProgram;
+    (instance as any).glw = { activeTexture: vi.fn(), bindTexture: vi.fn() };
+
+    // After Fix B: bindTextures returns early instead of crashing
+    expect(() =>
+      instance.bindTextures([undefined as unknown as WebGlCtxTexture]),
+    ).not.toThrow();
+  });
+});
+
+// ---------------------------------------------------------------------------
+// Test 2 — addTexture silently accepts undefined and stores it
+//
+// The crash is silent at this layer: passing an undefined ctxTexture to
+// CoreNode.addTexture does NOT throw — it quietly pushes undefined into
+// renderOpTextures, poisoning the array for bindTextures later.
+// ---------------------------------------------------------------------------
+describe('CoreNode.addTexture with undefined ctxTexture', () => {
+  it('accepts undefined without throwing and stores it in renderOpTextures', () => {
+    // Call via prototype to avoid the complex CoreNode constructor
+    const fakeCtx = { renderOpTextures: [] as WebGlCtxTexture[] };
+    const idx = CoreNode.prototype.addTexture.call(
+      fakeCtx,
+      undefined as unknown as WebGlCtxTexture,
+    );
+
+    // No error raised here — that is the problem
+    expect(idx).toBe(0);
+    // undefined is now stored; any subsequent bindTextures call will crash
+    expect(fakeCtx.renderOpTextures[0]).toBeUndefined();
+  });
+});
+
+// ---------------------------------------------------------------------------
+// Test 3 — full crash chain: undefined ctxTexture → addTexture → bindTextures
+//
+// End-to-end proof that the chain fails before any fix is applied.
+// ---------------------------------------------------------------------------
+describe('full OOM crash chain: undefined ctxTexture → bindTextures crash', () => {
+  it('does not crash when undefined ctxTexture propagates to bindTextures', () => {
+    // Simulate: GPU OOM causes Texture.release() → ctxTexture = undefined
+    const undefinedCtxTexture = undefined as unknown as WebGlCtxTexture;
+
+    // Simulate: WebGlRenderer.addQuad reads tx.ctxTexture (undefined) and
+    // passes it to curRenderOp.addTexture — no error thrown here
+    const fakeRenderOp = { renderOpTextures: [] as WebGlCtxTexture[] };
+    CoreNode.prototype.addTexture.call(fakeRenderOp, undefinedCtxTexture);
+
+    // Confirm undefined is still sitting in renderOpTextures (addTexture is unchanged)
+    expect(fakeRenderOp.renderOpTextures[0]).toBeUndefined();
+
+    // Simulate: bindRenderOp calls bindTextures with the poisoned array
+    const program = Object.create(
+      WebGlShaderProgram.prototype,
+    ) as WebGlShaderProgram;
+    (program as any).glw = { activeTexture: vi.fn(), bindTexture: vi.fn() };
+
+    // After Fix B: bindTextures returns early — the draw loop is protected
+    expect(() =>
+      program.bindTextures(fakeRenderOp.renderOpTextures),
+    ).not.toThrow();
+  });
+});