@lightningjs/renderer 3.0.0-beta9 → 3.0.0

package/src/core/CoreShaderManager.ts

@@ -1,188 +1,188 @@
-/*
- * 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 { deepClone } from '../utils.js';
-import {
-  CoreShaderNode,
-  resolveShaderProps,
-  type CoreShaderType,
-} from './renderers/CoreShaderNode.js';
-import type { CoreShaderProgram } from './renderers/CoreShaderProgram.js';
-import type { Stage } from './Stage.js';
-
-export type ShaderMap = Record<string, CoreShaderType>;
-
-export type ExtractProps<Props> = {
-  [K in keyof Props]: Props[K] extends { default: infer D } ? D : Props[K];
-};
-
-export type PartialShaderProps<Props> = Partial<ExtractProps<Props>>;
-export type ExtractShaderProps<T extends keyof ShaderMap> = ExtractProps<
-  ShaderMap[T]['props']
->;
-export type OptionalShaderProps<T extends keyof ShaderMap> = PartialShaderProps<
-  ShaderMap[T]['props']
->;
-
-export class CoreShaderManager {
-  protected shTypes: ShaderMap = {};
-  protected shCache: Map<string, CoreShaderProgram> = new Map();
-
-  /**
-   * valuesCache is used to store calculations that can be shared between shader nodes.
-   */
-  protected valuesCache: Map<string, Record<string, unknown>> = new Map();
-  protected valuesCacheUsage: Map<string, number> = new Map();
-
-  protected attachedShader: CoreShaderProgram | null = null;
-
-  constructor(readonly stage: Stage) {}
-
-  registerShaderType(name: string, shType: CoreShaderType): void {
-    /**
-     * block name duplicates
-     */
-    if (this.shTypes[name] !== undefined) {
-      console.warn(
-        `ShaderType already exists with the name: ${name}. Breaking off registration.`,
-      );
-      return;
-    }
-    /**
-     * Check renderer if shader type is supported.
-     */
-    if (this.stage.renderer.supportsShaderType(shType) === false) {
-      console.warn(
-        `The renderer being used does not support this shader type. Breaking off registration.`,
-      );
-      return;
-    }
-    this.shTypes[name] = deepClone(shType);
-  }
-
-  /**
-   * Loads a shader (if not already loaded) and returns a controller for it.
-   *
-   * @param shType
-   * @param props
-   * @returns
-   */
-  createShader<Name extends keyof ShaderMap>(
-    name: Name,
-    props?: Record<string, unknown>,
-  ): CoreShaderNode | null {
-    const shType = this.shTypes[name as string] as ShaderMap[Name];
-    if (shType === undefined) {
-      console.warn(
-        `ShaderType not found falling back on renderer default shader`,
-      );
-      return this.stage.defShaderNode;
-    }
-    let shaderKey = name as string;
-    if (shType.props !== undefined) {
-      /**
-       * if props is undefined create empty obj to fill
-       */
-      props = props || {};
-      /**
-       * resolve shader values
-       */
-      resolveShaderProps(props, shType.props);
-      if (shType.getCacheMarkers !== undefined) {
-        shaderKey += `-${shType.getCacheMarkers(props)}`;
-      }
-    }
-
-    if (this.stage.renderer.mode === 'canvas') {
-      return this.stage.renderer.createShaderNode(shaderKey, shType, props);
-    }
-
-    /**
-     * get shaderProgram by cacheKey
-     */
-    let shProgram = this.shCache.get(shaderKey);
-
-    /**
-     * if shaderProgram was not found create a new one
-     */
-    if (shProgram === undefined) {
-      shProgram = this.stage.renderer.createShaderProgram(shType, props)!;
-      this.shCache.set(shaderKey, shProgram);
-    }
-
-    return this.stage.renderer.createShaderNode(
-      shaderKey,
-      shType,
-      props,
-      shProgram,
-    );
-  }
-
-  mutateShaderValueUsage(key: string, mutation: number) {
-    let usage = this.valuesCacheUsage.get(key) || 0;
-    this.valuesCacheUsage.set(key, usage + mutation);
-  }
-
-  getShaderValues(key: string) {
-    const values = this.valuesCache.get(key);
-    if (values === undefined) {
-      return undefined;
-    }
-    this.mutateShaderValueUsage(key, 1);
-    return values;
-  }
-
-  setShaderValues(key: string, values: Record<string, unknown>) {
-    this.valuesCache.set(key, values);
-    this.mutateShaderValueUsage(key, 1);
-  }
-
-  cleanup() {
-    const values = [...this.valuesCacheUsage.entries()].sort(
-      (entryA, entryB) => {
-        if (entryA[1] < entryB[1]) {
-          return -1;
-        } else if (entryA[1] > entryB[1]) {
-          return 1;
-        }
-        return 0;
-      },
-    );
-
-    for (let i = 0; i < values.length; i++) {
-      if (values[i]![1] > 0) {
-        break;
-      }
-      this.valuesCacheUsage.delete(values[i]![0]);
-      this.valuesCache.delete(values[i]![0]);
-    }
-  }
-
-  useShader(shader: CoreShaderProgram): void {
-    if (this.attachedShader === shader) {
-      return;
-    }
-    if (this.attachedShader && this.attachedShader.detach) {
-      this.attachedShader.detach();
-    }
-    if (shader.attach) {
-      shader.attach();
-    }
-    this.attachedShader = shader;
-  }
-}
+/*
+ * 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 { deepClone } from '../utils.js';
+import {
+  CoreShaderNode,
+  resolveShaderProps,
+  type CoreShaderType,
+} from './renderers/CoreShaderNode.js';
+import type { CoreShaderProgram } from './renderers/CoreShaderProgram.js';
+import type { Stage } from './Stage.js';
+
+export type ShaderMap = Record<string, CoreShaderType>;
+
+export type ExtractProps<Props> = {
+  [K in keyof Props]: Props[K] extends { default: infer D } ? D : Props[K];
+};
+
+export type PartialShaderProps<Props> = Partial<ExtractProps<Props>>;
+export type ExtractShaderProps<T extends keyof ShaderMap> = ExtractProps<
+  ShaderMap[T]['props']
+>;
+export type OptionalShaderProps<T extends keyof ShaderMap> = PartialShaderProps<
+  ShaderMap[T]['props']
+>;
+
+export class CoreShaderManager {
+  protected shTypes: ShaderMap = {};
+  protected shCache: Map<string, CoreShaderProgram> = new Map();
+
+  /**
+   * valuesCache is used to store calculations that can be shared between shader nodes.
+   */
+  protected valuesCache: Map<string, Record<string, unknown>> = new Map();
+  protected valuesCacheUsage: Map<string, number> = new Map();
+
+  protected attachedShader: CoreShaderProgram | null = null;
+
+  constructor(readonly stage: Stage) {}
+
+  registerShaderType(name: string, shType: CoreShaderType): void {
+    /**
+     * block name duplicates
+     */
+    if (this.shTypes[name] !== undefined) {
+      console.warn(
+        `ShaderType already exists with the name: ${name}. Breaking off registration.`,
+      );
+      return;
+    }
+    /**
+     * Check renderer if shader type is supported.
+     */
+    if (this.stage.renderer.supportsShaderType(shType) === false) {
+      console.warn(
+        `The renderer being used does not support this shader type. Breaking off registration.`,
+      );
+      return;
+    }
+    this.shTypes[name] = deepClone(shType);
+  }
+
+  /**
+   * Loads a shader (if not already loaded) and returns a controller for it.
+   *
+   * @param shType
+   * @param props
+   * @returns
+   */
+  createShader<Name extends keyof ShaderMap>(
+    name: Name,
+    props?: Record<string, unknown>,
+  ): CoreShaderNode | null {
+    const shType = this.shTypes[name as string] as ShaderMap[Name];
+    if (shType === undefined) {
+      console.warn(
+        `ShaderType not found falling back on renderer default shader`,
+      );
+      return this.stage.defShaderNode;
+    }
+    let shaderKey = name as string;
+    if (shType.props !== undefined) {
+      /**
+       * if props is undefined create empty obj to fill
+       */
+      props = props || {};
+      /**
+       * resolve shader values
+       */
+      resolveShaderProps(props, shType.props);
+      if (shType.getCacheMarkers !== undefined) {
+        shaderKey += `-${shType.getCacheMarkers(props)}`;
+      }
+    }
+
+    if (this.stage.renderer.mode === 'canvas') {
+      return this.stage.renderer.createShaderNode(shaderKey, shType, props);
+    }
+
+    /**
+     * get shaderProgram by cacheKey
+     */
+    let shProgram = this.shCache.get(shaderKey);
+
+    /**
+     * if shaderProgram was not found create a new one
+     */
+    if (shProgram === undefined) {
+      shProgram = this.stage.renderer.createShaderProgram(shType, props)!;
+      this.shCache.set(shaderKey, shProgram);
+    }
+
+    return this.stage.renderer.createShaderNode(
+      shaderKey,
+      shType,
+      props,
+      shProgram,
+    );
+  }
+
+  mutateShaderValueUsage(key: string, mutation: number) {
+    let usage = this.valuesCacheUsage.get(key) || 0;
+    this.valuesCacheUsage.set(key, usage + mutation);
+  }
+
+  getShaderValues(key: string) {
+    const values = this.valuesCache.get(key);
+    if (values === undefined) {
+      return undefined;
+    }
+    this.mutateShaderValueUsage(key, 1);
+    return values;
+  }
+
+  setShaderValues(key: string, values: Record<string, unknown>) {
+    this.valuesCache.set(key, values);
+    this.mutateShaderValueUsage(key, 1);
+  }
+
+  cleanup() {
+    const values = [...this.valuesCacheUsage.entries()].sort(
+      (entryA, entryB) => {
+        if (entryA[1] < entryB[1]) {
+          return -1;
+        } else if (entryA[1] > entryB[1]) {
+          return 1;
+        }
+        return 0;
+      },
+    );
+
+    for (let i = 0; i < values.length; i++) {
+      if (values[i]![1] > 0) {
+        break;
+      }
+      this.valuesCacheUsage.delete(values[i]![0]);
+      this.valuesCache.delete(values[i]![0]);
+    }
+  }
+
+  useShader(shader: CoreShaderProgram): void {
+    if (this.attachedShader === shader) {
+      return;
+    }
+    if (this.attachedShader && this.attachedShader.detach) {
+      this.attachedShader.detach();
+    }
+    if (shader.attach) {
+      shader.attach();
+    }
+    this.attachedShader = shader;
+  }
+}

package/src/core/CoreTextNode.test.ts

@@ -0,0 +1,311 @@
+/*
+ * 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 { describe, expect, it, vi, beforeEach } from 'vitest';
+import { CoreTextNode, type CoreTextNodeProps } from './CoreTextNode.js';
+import { Stage } from './Stage.js';
+import { CoreRenderer } from './renderers/CoreRenderer.js';
+import { mock } from 'vitest-mock-extended';
+import type { TextRenderer } from './text-rendering/TextRenderer.js';
+import { createBound } from './lib/utils.js';
+
+describe('CoreTextNode', () => {
+  let stage: Stage;
+  let mockTextRenderer: TextRenderer;
+
+  const defaultTextProps: CoreTextNodeProps = {
+    // CoreNodeProps
+    alpha: 1,
+    autosize: false,
+    boundsMargin: null,
+    clipping: false,
+    color: 0xffffffff,
+    colorBl: 0xffffffff,
+    colorBottom: 0xffffffff,
+    colorBr: 0xffffffff,
+    colorLeft: 0xffffffff,
+    colorRight: 0xffffffff,
+    colorTl: 0xffffffff,
+    colorTop: 0xffffffff,
+    colorTr: 0xffffffff,
+    h: 0,
+    mount: 0,
+    mountX: 0,
+    mountY: 0,
+    parent: null,
+    pivot: 0,
+    pivotX: 0,
+    pivotY: 0,
+    rotation: 0,
+    rtt: false,
+    scale: 1,
+    scaleX: 1,
+    scaleY: 1,
+    shader: null,
+    src: '',
+    texture: null,
+    textureOptions: {},
+    w: 0,
+    x: 0,
+    y: 0,
+    zIndex: 0,
+    // TrProps
+    text: 'Test',
+    textAlign: 'left',
+    contain: 'none',
+    fontFamily: 'Arial',
+    fontStyle: 'normal',
+    fontSize: 16,
+    letterSpacing: 0,
+    lineHeight: 1,
+    maxHeight: 0,
+    maxLines: 0,
+    maxWidth: 0,
+    offsetY: 0,
+    overflowSuffix: '...',
+    verticalAlign: 'top',
+    wordBreak: 'break-word',
+    // CoreTextNodeProps specific
+    textRendererOverride: null,
+    forceLoad: false,
+  };
+
+  const clippingRect = {
+    x: 0,
+    y: 0,
+    w: 200,
+    h: 200,
+    valid: true,
+  };
+
+  beforeEach(() => {
+    stage = mock<Stage>({
+      strictBound: createBound(0, 0, 1920, 1080),
+      preloadBound: createBound(0, 0, 1920, 1080),
+      defaultTexture: {
+        state: 'loaded',
+      },
+      renderer: mock<CoreRenderer>() as CoreRenderer,
+    });
+
+    // Mock text renderer with basic functionality
+    mockTextRenderer = {
+      type: 'sdf',
+      font: {
+        isFontLoaded: vi.fn().mockReturnValue(true),
+        waitingForFont: vi.fn(),
+        stopWaitingForFont: vi.fn(),
+      },
+      renderText: vi.fn().mockReturnValue({
+        width: 100,
+        height: 20,
+        layout: { glyphs: [], width: 100, height: 20 },
+      }),
+      addQuads: vi.fn().mockReturnValue(new Float32Array(0)),
+      renderQuads: vi.fn(),
+    } as any;
+  });
+
+  describe('text property handling', () => {
+    it('should normalize empty string and set node as non-renderable', () => {
+      const node = new CoreTextNode(stage, defaultTextProps, mockTextRenderer);
+
+      node.text = '';
+
+      expect(node.text).toBe('');
+      expect(node.isRenderable).toBe(false);
+    });
+
+    it('should normalize null to empty string and set node as non-renderable', () => {
+      const node = new CoreTextNode(stage, defaultTextProps, mockTextRenderer);
+
+      node.text = null as any;
+
+      expect(node.text).toBe('');
+      expect(node.isRenderable).toBe(false);
+    });
+
+    it('should normalize undefined to empty string and set node as non-renderable', () => {
+      const node = new CoreTextNode(stage, defaultTextProps, mockTextRenderer);
+
+      node.text = undefined as any;
+
+      expect(node.text).toBe('');
+      expect(node.isRenderable).toBe(false);
+    });
+
+    it('should convert non-string values to strings', () => {
+      const node = new CoreTextNode(stage, defaultTextProps, mockTextRenderer);
+
+      node.text = 123 as any;
+
+      expect(node.text).toBe('123');
+    });
+
+    it('should handle valid text and allow node to be renderable', () => {
+      const node = new CoreTextNode(stage, defaultTextProps, mockTextRenderer);
+
+      node.text = 'Valid text content';
+
+      expect(node.text).toBe('Valid text content');
+      // Note: renderable state is determined during update cycle
+    });
+
+    it('should clear cached layout data when text is set to empty', () => {
+      const props = { ...defaultTextProps, text: 'Initial text' };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      // Simulate some cached state
+      node.text = '';
+
+      expect(node.text).toBe('');
+      expect(node.isRenderable).toBe(false);
+    });
+
+    it('should clear cached layout data when text is set to null', () => {
+      const props = { ...defaultTextProps, text: 'Initial text' };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      node.text = null as any;
+
+      expect(node.text).toBe('');
+      expect(node.isRenderable).toBe(false);
+    });
+
+    it('should clear cached layout data when text is set to undefined', () => {
+      const props = { ...defaultTextProps, text: 'Initial text' };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      node.text = undefined as any;
+
+      expect(node.text).toBe('');
+      expect(node.isRenderable).toBe(false);
+    });
+
+    it('should not call renderText during update when text is empty', () => {
+      const props = { ...defaultTextProps, text: '', forceLoad: true };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      node.update(16, clippingRect);
+
+      expect(mockTextRenderer.renderText).not.toHaveBeenCalled();
+    });
+
+    it('should not call renderText during update when text is null', () => {
+      const props = { ...defaultTextProps, text: null as any, forceLoad: true };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      node.update(16, clippingRect);
+
+      expect(mockTextRenderer.renderText).not.toHaveBeenCalled();
+    });
+
+    it('should transition from valid text to empty text correctly', () => {
+      const props = { ...defaultTextProps, text: 'Valid text' };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      // Set to valid text first
+      node.text = 'Some content';
+      expect(node.text).toBe('Some content');
+
+      // Then set to empty
+      node.text = '';
+      expect(node.text).toBe('');
+      expect(node.isRenderable).toBe(false);
+    });
+
+    it('should transition from empty text to valid text correctly', () => {
+      const props = { ...defaultTextProps, text: '' };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      expect(node.text).toBe('');
+      expect(node.isRenderable).toBe(false);
+
+      // Set to valid text
+      node.text = 'New content';
+      expect(node.text).toBe('New content');
+    });
+
+    it('should handle rapid text changes including null/undefined', () => {
+      const props = { ...defaultTextProps, text: 'Initial' };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      node.text = 'First';
+      expect(node.text).toBe('First');
+
+      node.text = null as any;
+      expect(node.text).toBe('');
+      expect(node.isRenderable).toBe(false);
+
+      node.text = 'Second';
+      expect(node.text).toBe('Second');
+
+      node.text = undefined as any;
+      expect(node.text).toBe('');
+      expect(node.isRenderable).toBe(false);
+
+      node.text = 'Third';
+      expect(node.text).toBe('Third');
+    });
+  });
+
+  describe('updateIsRenderable with invalid text', () => {
+    it('should mark node as non-renderable when text is empty', () => {
+      const props = { ...defaultTextProps, text: '' };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      node.updateIsRenderable();
+
+      expect(node.isRenderable).toBe(false);
+    });
+
+    it('should mark node as non-renderable even if layout exists when text is empty', () => {
+      const props = { ...defaultTextProps, text: 'Valid' };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      // Change text to empty after potential layout generation
+      node.text = '';
+      node.updateIsRenderable();
+
+      expect(node.isRenderable).toBe(false);
+    });
+  });
+
+  describe('update cycle with invalid text', () => {
+    it('should skip layout generation when text is empty', () => {
+      const props = { ...defaultTextProps, text: '', forceLoad: true };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      node.update(16, clippingRect);
+
+      expect(mockTextRenderer.renderText).not.toHaveBeenCalled();
+      expect(node.isRenderable).toBe(false);
+    });
+
+    it('should skip layout generation when text becomes empty during update', () => {
+      const props = { ...defaultTextProps, text: 'Valid', forceLoad: true };
+      const node = new CoreTextNode(stage, props, mockTextRenderer);
+
+      node.text = '';
+      node.update(16, clippingRect);
+
+      expect(node.isRenderable).toBe(false);
+    });
+  });
+});