feat: Use strict names by default and fallback to item (#1916)

Author: aleksanderkatan

packages/typegpu/src/core/resolve/tgpuResolve.ts

@@ -191,7 +191,7 @@ function resolveFromTemplate(
     template,
     externals,
     shaderGenerator,
-    names = 'random',
+    names = 'strict',
     config,
     enableExtensions,
   } = options;
@@ -232,7 +232,7 @@ function resolveFromArray(
 ): ResolutionResult {
   const {
     shaderGenerator,
-    names = 'random',
+    names = 'strict',
     config,
     enableExtensions,
   } = options ?? {};

packages/typegpu/src/nameRegistry.ts

@@ -198,6 +198,16 @@ export interface NameRegistry {
   makeValid(primer: string): string;
 }
 
+function sanitizePrimer(primer: string | undefined) {
+  if (primer) {
+    // sanitizing
+    return primer
+      .replaceAll(/\s/g, '_') // whitespaces
+      .replaceAll(/[^\w\d]/g, ''); // removing illegal characters
+  }
+  return 'item';
+}
+
 /**
  * A function for checking whether an identifier needs renaming.
  * Throws if provided with an invalid identifier that cannot be easily renamed.
@@ -233,16 +243,9 @@ export class RandomNameRegistry extends NameRegistryImpl {
   private lastUniqueId = 0;
 
   makeUnique(primer?: string | undefined): string {
-    let label: string;
-    if (primer) {
-      // sanitizing
-      label = primer.replaceAll(/\s/g, '_'); // whitespace -> _
-      label = label.replaceAll(/[^\w\d]/g, ''); // removing illegal characters
-    } else {
-      label = 'item';
-    }
+    const sanitizedPrimer = sanitizePrimer(primer);
 
-    return `${label}_${this.lastUniqueId++}`;
+    return `${sanitizedPrimer}_${this.lastUniqueId++}`;
   }
 }
 
@@ -253,19 +256,18 @@ export class StrictNameRegistry extends NameRegistryImpl {
    */
   private readonly _usedNames = new Set<string>(bannedTokens);
 
+  // TODO: optimize this with a map
   makeUnique(primer?: string | undefined): string {
-    if (primer === undefined) {
-      throw new Error('Unnamed item found when using a strict name registry');
-    }
+    const sanitizedPrimer = sanitizePrimer(primer);
 
     let index = 0;
-    let unusedName = primer;
-    while (this._usedNames.has(unusedName)) {
+    let label = sanitizedPrimer;
+    while (this._usedNames.has(label)) {
       index++;
-      unusedName = `${primer}_${index}`;
+      label = `${sanitizedPrimer}_${index}`;
     }
 
-    this._usedNames.add(unusedName);
-    return unusedName;
+    this._usedNames.add(label);
+    return label;
   }
 }

packages/typegpu/tests/accessor.test.ts

@@ -2,7 +2,6 @@ import { describe, expect } from 'vitest';
 import * as d from '../src/data/index.ts';
 import tgpu from '../src/index.ts';
 import { it } from './utils/extendedIt.ts';
-import { asWgsl } from './utils/parseResolved.ts';
 
 const RED = d.vec3f(1, 0, 0);
 const RED_RESOLVED = 'vec3f(1, 0, 0)';
@@ -17,7 +16,7 @@ describe('tgpu.accessor', () => {
       .$uses({ colorAccess })
       .with(colorAccess, red);
 
-    expect(asWgsl(getColor)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([getColor])).toMatchInlineSnapshot(`
       "fn red() -> vec3f{ return vec3f(1, 0, 0); }
 
       fn getColor() -> vec3f{ return red(); }"
@@ -36,7 +35,7 @@ describe('tgpu.accessor', () => {
       .$uses({ colorAccess })
       .with(colorAccess, redUniform);
 
-    expect(asWgsl(getColor)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([getColor])).toMatchInlineSnapshot(`
       "@group(0) @binding(0) var<uniform> redUniform: vec3f;
 
       fn getColor() -> vec3f{ return redUniform; }"
@@ -55,7 +54,7 @@ describe('tgpu.accessor', () => {
       .with(colorAccess, RED)
       .with(multiplierAccess, 2);
 
-    expect(asWgsl(getColor)).toMatchInlineSnapshot(
+    expect(tgpu.resolve([getColor])).toMatchInlineSnapshot(
       `"fn getColor() -> vec3f{ return vec3f(1, 0, 0) * 2f; }"`,
     );
   });
@@ -66,7 +65,7 @@ describe('tgpu.accessor', () => {
     const getColor = tgpu.fn([], d.vec3f)`() { return colorAccess; }`
       .$uses({ colorAccess });
 
-    expect(asWgsl(getColor)).toMatchInlineSnapshot(
+    expect(tgpu.resolve([getColor])).toMatchInlineSnapshot(
       `"fn getColor() -> vec3f{ return vec3f(1, 0, 0); }"`,
     );
   });
@@ -83,7 +82,7 @@ describe('tgpu.accessor', () => {
     const main = tgpu.fn([])`() { return getColorWithGreen(); }`
       .$uses({ getColorWithGreen });
 
-    expect(asWgsl(main)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([main])).toMatchInlineSnapshot(`
       "fn getColor() -> vec3f{ return vec3f(0, 1, 0); }
 
       fn main() { return getColor(); }"
@@ -96,7 +95,7 @@ describe('tgpu.accessor', () => {
     const getColor = tgpu.fn([], d.vec3f)`() { return colorAccess; }`
       .$uses({ colorAccess });
 
-    expect(() => asWgsl(getColor))
+    expect(() => tgpu.resolve([getColor]))
       .toThrowErrorMatchingInlineSnapshot(`
         [Error: Resolution of the following tree failed:
         - <root>
@@ -127,7 +126,7 @@ describe('tgpu.accessor', () => {
       const color3X = colorAccessorFn.value.x;
     });
 
-    expect(asWgsl(main)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([main])).toMatchInlineSnapshot(`
       "@group(0) @binding(0) var<uniform> redUniform: vec3f;
 
       fn getColor() -> vec3f {
@@ -153,7 +152,7 @@ describe('tgpu.accessor', () => {
       const foo = fooAccess.$;
     });
 
-    expect(asWgsl(main)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([main])).toMatchInlineSnapshot(`
       "fn main() {
         const foo = 1f;
       }"

packages/typegpu/tests/align.test.ts

@@ -1,7 +1,7 @@
 import { describe, expect, expectTypeOf, it } from 'vitest';
 import { alignmentOf } from '../src/data/alignmentOf.ts';
 import * as d from '../src/data/index.ts';
-import { asWgsl } from './utils/parseResolved.ts';
+import tgpu from '../src/index.ts';
 
 describe('d.align', () => {
   it('adds @align attribute for custom aligned struct members', () => {
@@ -11,7 +11,7 @@ describe('d.align', () => {
       c: d.u32,
     });
 
-    expect(asWgsl(s1)).toContain(
+    expect(tgpu.resolve([s1])).toContain(
       '@align(16) b: u32,',
     );
   });

packages/typegpu/tests/array.test.ts

@@ -8,7 +8,6 @@ import { namespace } from '../src/core/resolve/namespace.ts';
 import { resolve } from '../src/resolutionCtx.ts';
 import type { Infer } from '../src/shared/repr.ts';
 import { arrayLength } from '../src/std/array.ts';
-import { asWgsl } from './utils/parseResolved.ts';
 
 describe('array', () => {
   it('produces a visually pleasant type', () => {
@@ -179,7 +178,7 @@ describe('array', () => {
       const defaultValue = Outer();
     });
 
-    expect(asWgsl(testFunction)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([testFunction])).toMatchInlineSnapshot(`
       "fn testFunction() {
         var defaultValue = array<array<f32, 1>, 2>();
       }"
@@ -195,7 +194,7 @@ describe('array', () => {
       return;
     });
 
-    expect(asWgsl(testFn)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([testFn])).toMatchInlineSnapshot(`
       "fn testFn() {
         var myArray = array<u32, 1>(10u);
         var myClone = myArray;
@@ -213,7 +212,7 @@ describe('array', () => {
       return;
     });
 
-    expect(asWgsl(testFn)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([testFn])).toMatchInlineSnapshot(`
       "fn testFn() {
         var myArrays = array<array<i32, 1>, 1>(array<i32, 1>(10i));
         var myClone = myArrays[0i];
@@ -227,7 +226,7 @@ describe('array', () => {
       const result = d.arrayOf(d.f32, 4)();
     });
 
-    expect(asWgsl(foo)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([foo])).toMatchInlineSnapshot(`
       "fn foo() {
         var result = array<f32, 4>();
       }"
@@ -239,7 +238,7 @@ describe('array', () => {
       const result = d.arrayOf(d.f32)(4)();
     });
 
-    expect(asWgsl(foo)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([foo])).toMatchInlineSnapshot(`
       "fn foo() {
         var result = array<f32, 4>();
       }"
@@ -251,7 +250,7 @@ describe('array', () => {
       const result = d.arrayOf(d.f32, count)();
     });
 
-    expect(() => asWgsl(foo)).toThrowErrorMatchingInlineSnapshot(`
+    expect(() => tgpu.resolve([foo])).toThrowErrorMatchingInlineSnapshot(`
       [Error: Resolution of the following tree failed:
       - <root>
       - fn:foo
@@ -265,7 +264,7 @@ describe('array', () => {
     });
 
     expect(
-      asWgsl(...Object.values(testLayout.bound)),
+      tgpu.resolve([...Object.values(testLayout.bound)]),
     ).toMatchInlineSnapshot(
       `"@group(0) @binding(0) var<storage, read> testArray: array<u32>;"`,
     );
@@ -276,7 +275,7 @@ describe('array', () => {
       const result = d.arrayOf(d.f32, 4)([1, 2, 3, 4]);
     });
 
-    expect(asWgsl(foo)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([foo])).toMatchInlineSnapshot(`
       "fn foo() {
         var result = array<f32, 4>(1f, 2f, 3f, 4f);
       }"
@@ -288,7 +287,7 @@ describe('array', () => {
       const result = d.arrayOf(d.f32)(4)([4, 3, 2, 1]);
     });
 
-    expect(asWgsl(foo)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([foo])).toMatchInlineSnapshot(`
       "fn foo() {
         var result = array<f32, 4>(4f, 3f, 2f, 1f);
       }"
@@ -302,7 +301,7 @@ describe('array', () => {
       const result = d.arrayOf(d.f32, arraySizeSlot.$)([4, 3, 2, 1]);
     });
 
-    expect(asWgsl(foo)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([foo])).toMatchInlineSnapshot(`
       "fn foo() {
         var result = array<f32, 4>(4f, 3f, 2f, 1f);
       }"
@@ -324,7 +323,7 @@ describe('array', () => {
       );
     });
 
-    expect(asWgsl(foo)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([foo])).toMatchInlineSnapshot(`
       "fn foo() {
         var result = array<f32, 8>(0f, 1f, 2f, 3f, 4f, 5f, 6f, 7f);
       }"
@@ -349,7 +348,7 @@ describe('array.length', () => {
       }
     });
 
-    expect(asWgsl(foo)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([foo])).toMatchInlineSnapshot(`
       "@group(0) @binding(0) var<storage, read_write> values: array<f32>;
 
       fn foo() {
@@ -378,7 +377,7 @@ describe('array.length', () => {
       }
     });
 
-    expect(asWgsl(foo)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([foo])).toMatchInlineSnapshot(`
       "@group(0) @binding(0) var<storage, read_write> values: array<f32, 128>;
 
       fn foo() {
@@ -405,7 +404,7 @@ describe('array.length', () => {
         return arrayLength(layout.$.values);
       });
 
-      expect(asWgsl(testFn)).toMatchInlineSnapshot(`
+      expect(tgpu.resolve([testFn])).toMatchInlineSnapshot(`
         "fn testFn() -> i32 {
           return 5;
         }"
@@ -425,7 +424,7 @@ describe('array.length', () => {
         return arrayLength(layout.bound.values.value);
       });
 
-      expect(asWgsl(testFn)).toMatchInlineSnapshot(`
+      expect(tgpu.resolve([testFn])).toMatchInlineSnapshot(`
         "@group(0) @binding(0) var<storage, read_write> values: array<f32>;
 
         fn testFn() -> u32 {

packages/typegpu/tests/attributes.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, expectTypeOf, it } from 'vitest';
 import * as d from '../src/data/index.ts';
-import { asWgsl } from './utils/parseResolved.ts';
+import tgpu from '../src/index.ts';
 
 describe('attributes', () => {
   it('adds attributes in the correct order', () => {
@@ -11,7 +11,7 @@ describe('attributes', () => {
         c: d.u32,
       });
 
-    expect(asWgsl(s1)).toContain('@size(8) @align(16) b: u32,');
+    expect(tgpu.resolve([s1])).toContain('@size(8) @align(16) b: u32,');
 
     expectTypeOf(s1).toEqualTypeOf<
       d.WgslStruct<{

packages/typegpu/tests/bindGroupLayout.test.ts

@@ -19,7 +19,6 @@ import {
   type UnwrapRuntimeConstructor,
 } from '../src/tgpuBindGroupLayout.ts';
 import { it } from './utils/extendedIt.ts';
-import { asWgsl } from './utils/parseResolved.ts';
 import './utils/webgpuGlobals.ts';
 
 const DEFAULT_READONLY_VISIBILITY_FLAGS = GPUShaderStage.COMPUTE |
@@ -223,7 +222,7 @@ describe('TgpuBindGroupLayout', () => {
     const main = tgpu.fn([])`() { textureLoad(fooTexture); }`
       .$uses({ fooTexture });
 
-    expect(asWgsl(main)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([main])).toMatchInlineSnapshot(`
       "@group(0) @binding(0) var fooTexture: texture_1d<f32>;
 
       fn main() { textureLoad(fooTexture); }"
@@ -247,7 +246,7 @@ describe('TgpuBindGroupLayout', () => {
       return Boid(boids[0]!);
     };
 
-    expect(asWgsl(getFirst)).toMatchInlineSnapshot(`
+    expect(tgpu.resolve([getFirst])).toMatchInlineSnapshot(`
       "struct Boid {
         pos: vec3f,
         vel: vec3f,