chore: TS noUncheckedIndexedAccess - partial fixes

Author: ibgreen

modules/core/src/adapter-utils/format-compiler-log.ts

@@ -3,6 +3,7 @@
 // Copyright (c) vis.gl contributors
 
 import type {CompilerMessage} from '../adapter/types/compiler-message';
+import {assertDefined} from '../utils/assert';
 
 /** @returns annotated errors or warnings */
 export function formatCompilerLog(
@@ -21,20 +22,22 @@ export function formatCompilerLog(
   switch (options?.showSourceCode || 'no') {
     case 'all':
       // Parse the error - note: browser and driver dependent
-      let currentMessage = 0;
+      let currentMessageIndex = 0;
       for (let lineNum = 1; lineNum <= lines.length; lineNum++) {
-        formattedLog += getNumberedLine(lines[lineNum - 1], lineNum, options);
-        while (log.length > currentMessage && log[currentMessage].lineNum === lineNum) {
-          const message = log[currentMessage++];
+        const line = assertDefined(lines[lineNum - 1]);
+        const currentMessage = assertDefined(log[currentMessageIndex]);
+        formattedLog += getNumberedLine(line, lineNum, options);
+        while (log.length > currentMessageIndex && currentMessage.lineNum === lineNum) {
+          const message = assertDefined(log[currentMessageIndex++]);
           formattedLog += formatCompilerMessage(message, lines, message.lineNum, {
             ...options,
             inlineSource: false
           });
         }
       }
       // Print any remaining messages
-      while (log.length > currentMessage) {
-        const message = log[currentMessage++];
+      while (log.length > currentMessageIndex) {
+        const message = assertDefined(log[currentMessageIndex++]);
         formattedLog += formatCompilerMessage(message, [], 0, {
           ...options,
           inlineSource: false

modules/core/src/adapter/canvas-context.ts

@@ -8,6 +8,7 @@ import type {Framebuffer} from './resources/framebuffer';
 import type {TextureFormatDepthStencil} from '../shadertypes/textures/texture-formats';
 import {uid} from '../utils/uid';
 import {withResolvers} from '../utils/promise-utils';
+import {assertDefined} from '../utils/assert';
 
 /** Properties for a CanvasContext */
 export type CanvasContextProps = {
@@ -346,27 +347,23 @@ export abstract class CanvasContext {
    */
   protected _handleResize(entries: ResizeObserverEntry[]) {
     const entry = entries.find(entry_ => entry_.target === this.canvas);
-    if (!entry) {
-      return;
-    }
-
+    const contentBoxSize = assertDefined(entry?.contentBoxSize?.[0]);
     // Update CSS size using content box size
-    this.cssWidth = entry.contentBoxSize[0].inlineSize;
-    this.cssHeight = entry.contentBoxSize[0].blockSize;
+    this.cssWidth = contentBoxSize.inlineSize;
+    this.cssHeight = contentBoxSize.blockSize;
 
     // Update our drawing buffer size variables, saving the old values for logging
     const oldPixelSize = this.getDevicePixelSize();
 
     // Use the most accurate drawing buffer size information the current browser can provide
     // Note: content box sizes are guaranteed to be integers
     // Note: Safari falls back to contentBoxSize
+    const devicePixelContentBoxSize = assertDefined(entry?.devicePixelContentBoxSize?.[0]);
     const devicePixelWidth =
-      entry.devicePixelContentBoxSize?.[0].inlineSize ||
-      entry.contentBoxSize[0].inlineSize * devicePixelRatio;
+      devicePixelContentBoxSize.inlineSize || contentBoxSize.inlineSize * devicePixelRatio;
 
     const devicePixelHeight =
-      entry.devicePixelContentBoxSize?.[0].blockSize ||
-      entry.contentBoxSize[0].blockSize * devicePixelRatio;
+      devicePixelContentBoxSize.blockSize || contentBoxSize.blockSize * devicePixelRatio;
 
     // Make sure we don't overflow the maximum supported texture size
     const [maxDevicePixelWidth, maxDevicePixelHeight] = this.getMaxDrawingBufferSize();

modules/core/src/adapter/resources/command-encoder.ts

@@ -27,11 +27,11 @@ export type CopyBufferToTextureOptions = {
   byteOffset?: number;
   destinationTexture: Texture;
   mipLevel?: number; //  = 0;
-  origin?: [number, number, number] | number[];
+  origin?: [number, number, number];
   aspect?: 'all' | 'stencil-only' | 'depth-only';
   bytesPerRow: number;
   rowsPerImage: number;
-  size: [number, number, number] | number[];
+  size: [number, number, number];
 };
 
 export type CopyTextureToBufferOptions = {
@@ -49,7 +49,7 @@ export type CopyTextureToBufferOptions = {
   width?: number;
   height?: number;
   depthOrArrayLayers?: number;
-  origin?: number[];
+  origin?: [number, number, number];
 
   /** Destination buffer */
   destinationBuffer: Buffer;
@@ -74,7 +74,7 @@ export type CopyTextureToTextureOptions = {
   /**  Mip-map level of the texture to copy to/from. (Default 0) */
   mipLevel?: number;
   /** Defines the origin of the copy - the minimum corner of the texture sub-region to copy from. */
-  origin?: number[];
+  origin?: [number, number, number];
   /** Defines which aspects of the {@link GPUImageCopyTexture#texture} to copy to/from. */
   aspect?: 'all' | 'stencil-only' | 'depth-only';
 
@@ -83,7 +83,7 @@ export type CopyTextureToTextureOptions = {
   /**  Mip-map level of the texture to copy to/from. (Default 0) */
   destinationMipLevel?: number;
   /** Defines the origin of the copy - the minimum corner of the texture sub-region to copy to. */
-  destinationOrigin?: number[];
+  destinationOrigin?: [number, number, number];
   /** Defines which aspects of the {@link GPUImageCopyTexture#texture} to copy to/from. */
   destinationAspect?: 'all' | 'stencil-only' | 'depth-only';
 

modules/core/src/adapter/resources/framebuffer.ts

@@ -146,17 +146,15 @@ export abstract class Framebuffer extends Resource<FramebufferProps> {
    * and destroys existing textures if owned
    */
   protected resizeAttachments(width: number, height: number): void {
-    for (let i = 0; i < this.colorAttachments.length; ++i) {
-      if (this.colorAttachments[i]) {
-        const resizedTexture = this.colorAttachments[i].texture.clone({
-          width,
-          height
-        });
-        this.destroyAttachedResource(this.colorAttachments[i]);
-        this.colorAttachments[i] = resizedTexture.view;
-        this.attachResource(resizedTexture.view);
-      }
-    }
+    this.colorAttachments.forEach((colorAttachment, i) => {
+      const resizedTexture = colorAttachment.texture.clone({
+        width,
+        height
+      });
+      this.destroyAttachedResource(colorAttachment);
+      this.colorAttachments[i] = resizedTexture.view;
+      this.attachResource(resizedTexture.view);
+    });
 
     if (this.depthStencilAttachment) {
       const resizedTexture = this.depthStencilAttachment.texture.clone({

modules/core/src/adapter/resources/shader.ts

@@ -162,5 +162,5 @@ function getShaderIdFromProps(props: ShaderProps): string {
 function getShaderName(shader: string, defaultName: string = 'unnamed'): string {
   const SHADER_NAME_REGEXP = /#define[\s*]SHADER_NAME[\s*]([A-Za-z0-9_-]+)[\s*]/;
   const match = SHADER_NAME_REGEXP.exec(shader);
-  return match ? match[1] : defaultName;
+  return match?.[1] ?? defaultName;
 }

modules/core/src/adapter/resources/texture.ts

@@ -92,14 +92,14 @@ export type TextureWriteOptions = {
   aspect?: 'all' | 'stencil-only' | 'depth-only';
 };
 
-const BASE_DIMENSIONS: Record<string, '1d' | '2d' | '3d'> = {
+const BASE_DIMENSIONS = {
   '1d': '1d',
   '2d': '2d',
   '2d-array': '2d',
   cube: '2d',
   'cube-array': '2d',
   '3d': '3d'
-};
+} as const satisfies Record<string, '1d' | '2d' | '3d'>;
 
 /** Texture properties */
 export type TextureProps = ResourceProps & {

modules/core/src/index.ts

@@ -216,6 +216,7 @@ export type {
 
 // INTERNAL UTILS - for use in other luma.gl modules only
 export {log} from './utils/log';
+export {assert, assertDefined} from './utils/assert';
 export {getScratchArray} from './utils/array-utils-flat';
 export type {AttributeInfo} from './adapter-utils/get-attribute-from-layouts';
 export {getAttributeInfosFromLayouts} from './adapter-utils/get-attribute-from-layouts';

modules/core/src/shadertypes/textures/pixel-utils.ts

@@ -77,7 +77,7 @@ export function readPixel(
 
   // Extract each of the four channels.
   for (let i = 0; i < 4; i++) {
-    const bits = bitsPerChannel[i];
+    const bits = bitsPerChannel[i] ?? 0;
     // If a channel's bit width is zero or negative, consider it not present.
     if (bits <= 0) {
       channels.push(0);
@@ -88,7 +88,7 @@ export function readPixel(
     }
   }
 
-  return [channels[0], channels[1], channels[2], channels[3]];
+  return [channels[0] ?? 0, channels[1] ?? 0, channels[2] ?? 0, channels[3] ?? 0];
 }
 
 /**
@@ -130,10 +130,10 @@ export function writePixel(
 ): void {
   let currentBitOffset = bitOffset;
   for (let channel = 0; channel < 4; channel++) {
-    const bits = bitsPerChannel[channel];
+    const bits = bitsPerChannel[channel] ?? 0;
     // Clamp the channel value to the maximum allowed by the bit width.
     const maxValue = (1 << bits) - 1;
-    const channelValue = pixel[channel] & maxValue;
+    const channelValue = (pixel[channel] ?? 0) & maxValue;
     writeBitsToDataView(dataView, currentBitOffset, bits, channelValue);
     currentBitOffset += bits;
   }

modules/core/src/shadertypes/textures/texture-format-decoder.ts

@@ -158,7 +158,7 @@ export function getTextureFormatInfo(format: TextureFormat): TextureFormatInfo {
     const dataType = `${type}${length}` as NormalizedDataType;
     const decodedType = getDataTypeInfo(dataType);
     const bits = decodedType.byteLength * 8;
-    const components = channels.length as 1 | 2 | 3 | 4;
+    const components = (channels?.length ?? 1) as 1 | 2 | 3 | 4;
     const bitsPerChannel: [number, number, number, number] = [
       bits,
       components >= 2 ? bits : 0,
@@ -176,7 +176,7 @@ export function getTextureFormatInfo(format: TextureFormat): TextureFormatInfo {
       signed: decodedType.signed,
       normalized: decodedType.normalized,
       bitsPerChannel,
-      bytesPerPixel: decodedType.byteLength * channels.length,
+      bytesPerPixel: decodedType.byteLength * components,
       packed: formatInfo.packed,
       srgb: formatInfo.srgb
     };

modules/core/src/utils/assert.ts

@@ -0,0 +1,16 @@
+// luma.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+/** Throws if condition is true and narrows type */
+export function assert(condition: unknown, message?: string): asserts condition {
+  if (!condition) {
+    throw new Error(message ?? 'luma.gl assertion failed.');
+  }
+}
+
+/** Throws if value is not defined, narrows type */
+export function assertDefined<T>(value: T | undefined, message?: string): T {
+  assert(value, message);
+  return value;
+}