Validate setImmediates API in different encoder types #4515

shaoboyan091 · 2025-12-03T06:50:29Z

This PR adding validation tests to cover setImmediates API in different encoder types (compute pass, render pass, render bundle) by covering:

Interpretation:
- Passing a TypedArray, the data offset and size are given in elements (not bytes).
Alignment:
- rangeOffset is not a multiple of 4 bytes.
- content size, converted to bytes, is not a multiple of 4 bytes.
Arithmetic overflow
- rangeOffset + contentSize is overflow
Bounds:
- dataOffset + contentSize (in bytes) exceeds the content data size.
- rangeOffset + contentSize (in bytes) exceeds the maxImmediateSize.

Issue: #

Requirements for PR author:

All missing test coverage is tracked with "TODO" or .unimplemented().
New helpers are /** documented */ and new helper files are found in helper_index.txt.
Test behaves as expected in a WebGPU implementation. (If not passing, explain above.)
Test have be tested with compatibility mode validation enabled and behave as expected. (If not passing, explain above.)

Requirements for reviewer sign-off:

Tests are properly located in the test tree.
Test descriptions allow a reader to "read only the test plans and evaluate coverage completeness", and accurately reflect the test code.
Tests provide complete coverage (including validation control cases). Missing coverage MUST be covered by TODOs.
Helpers and types promote readability and maintainability.

When landing this PR, be sure to make any necessary issue status updates.

Copilot

Pull request overview

This PR adds comprehensive validation tests for the setImmediates API across different encoder types (compute pass, render pass, render bundle). The tests validate interpretation of TypedArray data offsets/sizes, alignment requirements, arithmetic overflow handling, and bounds checking.

Adds validation tests for setImmediates API covering interpretation, alignment, overflow, and bounds scenarios
Tests validate that data offset and size are interpreted as bytes (not elements) for TypedArrays
Updates @webgpu/types package from version 0.1.66 to 0.1.67 to support the new API

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 5 comments.

File	Description
src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts	New test file implementing comprehensive validation tests for the setImmediates API across different encoder types
package.json	Updates @webgpu/types dependency to version 0.1.67
package-lock.json	Updates package lock file to reflect new @webgpu/types version with corresponding integrity hashes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts

Copilot

Pull request overview

Copilot reviewed 2 out of 3 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts

Copilot

Pull request overview

Copilot reviewed 2 out of 3 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts

This PR adding validation tests to cover setImmediates API in different encoder types (compute pass, render pass, render bundle) by covering: * Interpretation: - Passing a TypedArray the data offset and size is not given in elements. * Alignment: - rangeOffset is not a multiple of 4 bytes. - content size, converted to bytes, is not a multiple of 4 bytes. * Arithmetic overflow - rangeOffset + contentSize is overflow * Bounds: - dataOffset + size (in bytes) exceeds the content data size. - rangeOffset + size (in bytes) exceeds the maxImmdiateSize.

Co-authored-by: Copilot <[email protected]>

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts

Co-authored-by: Copilot <[email protected]>

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-08T03:16:43Z

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts

+  });
+
+g.test('overflow')
+  .desc('Tests that rangeOffset + contentSize exceeds Number.MAX_SAFE_INTEGER.')


In the description, there's a grammatical issue. The description should read "Tests that rangeOffset + contentSize do not exceed Number.MAX_SAFE_INTEGER" or "Tests the case when rangeOffset + contentSize exceeds Number.MAX_SAFE_INTEGER" to be clearer about what is being validated. Currently "exceeds" suggests the test is checking that overflow occurs, but based on the test logic, it should be preventing overflow.

Suggested change

.desc('Tests that rangeOffset + contentSize exceeds Number.MAX_SAFE_INTEGER.')

.desc('Tests that rangeOffset + contentSize do not exceed Number.MAX_SAFE_INTEGER.')

Copilot · 2025-12-08T03:16:43Z

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts

+  - rangeOffset is not a multiple of 4 bytes.
+  - content size, converted to bytes, is not a multiple of 4 bytes.
+* Arithmetic overflow
+  - rangeOffset + contentSize is overflow


Grammar issue: "is overflow" is incorrect. Should be "overflows" or "causes overflow".

Suggested change

- rangeOffset + contentSize is overflow

- rangeOffset + contentSize overflows

Copilot · 2025-12-08T03:16:44Z

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts

+  .desc(
+    'Tests that rangeOffset + contentSize is greater than maxImmediateSize and contentSize is larger than data size.'


Grammar issue: "contentSize" is singular, so it should be "is larger" not "are larger".

Copilot · 2025-12-08T03:16:44Z

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts

+        {
+          offset: 8,
+          contentByteSize: kMaxSafeMultipleOf8,
+          _rangeValid: true,
+          _contentValid: false,
+        },
+      ] as const)
+  )
+  .fn(t => {
+    const { encoderType, offset, contentByteSize, _rangeValid, _contentValid } = t.params;
+    const data = new Uint8Array(t.device.limits.maxImmediateSize);
+
+    const { encoder, validateFinish } = t.createEncoder(encoderType);
+
+    const doSetImmediates = () => {
+      encoder.setImmediates(offset, data, 0, contentByteSize);


The overflow test creates a Uint8Array with size maxImmediateSize, but the overflow test case attempts to use contentByteSize: kMaxSafeMultipleOf8 (approximately 9e15). This will throw a RangeError due to accessing data beyond the array bounds (lines 163-170 in the out_of_bounds test also validate this scenario), not due to arithmetic overflow of rangeOffset + contentSize.

The test expects a RangeError (due to _contentValid: false), but this conflates two different validation errors: data bounds checking vs arithmetic overflow checking. The _rangeValid: true parameter suggests the range validation should pass, but since a RangeError is thrown earlier for bounds checking, the validateFinish(_rangeValid) call never actually validates the overflow behavior.

Consider separating these concerns: use a sufficiently large data array for the overflow test, or adjust the test to properly distinguish between bounds errors and overflow errors.

shaoboyan091 requested a review from Copilot December 3, 2025 06:50

Copilot started reviewing on behalf of shaoboyan091 December 3, 2025 06:51 View session

Copilot finished reviewing on behalf of shaoboyan091 December 3, 2025 06:52

Copilot AI reviewed Dec 3, 2025

View reviewed changes

shaoboyan091 force-pushed the immediate-validation branch from 6f03310 to 44d19ed Compare December 3, 2025 08:46

shaoboyan091 requested a review from Copilot December 3, 2025 08:47

Copilot started reviewing on behalf of shaoboyan091 December 3, 2025 08:47 View session

Copilot finished reviewing on behalf of shaoboyan091 December 3, 2025 08:49

Copilot AI reviewed Dec 3, 2025

View reviewed changes

shaoboyan091 requested a review from Copilot December 4, 2025 01:30

Copilot started reviewing on behalf of shaoboyan091 December 4, 2025 01:31 View session

Copilot finished reviewing on behalf of shaoboyan091 December 4, 2025 01:33

Copilot AI reviewed Dec 4, 2025

View reviewed changes

shaoboyan091 force-pushed the immediate-validation branch from 18d7d95 to 8afc31a Compare December 5, 2025 02:53

shaoboyan091 force-pushed the immediate-validation branch from 8afc31a to d20b18f Compare December 5, 2025 06:23

Apply suggestions from code review

c2d4647

Co-authored-by: Copilot <[email protected]>

shaoboyan091 requested a review from Copilot December 5, 2025 08:21

Copilot started reviewing on behalf of shaoboyan091 December 5, 2025 08:22 View session

Copilot finished reviewing on behalf of shaoboyan091 December 5, 2025 08:24

Copilot AI reviewed Dec 5, 2025

View reviewed changes

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts Outdated Show resolved Hide resolved

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts Outdated Show resolved Hide resolved

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts Outdated Show resolved Hide resolved

shaoboyan091 and others added 2 commits December 5, 2025 16:51

Apply suggestions from code review

76323b7

Co-authored-by: Copilot <[email protected]>

Avoid allocation issue

ea4de3e

shaoboyan091 requested review from Kangz, Copilot and kainino0x December 5, 2025 09:04

Copilot started reviewing on behalf of shaoboyan091 December 5, 2025 09:04 View session

Copilot finished reviewing on behalf of shaoboyan091 December 5, 2025 09:07

Copilot AI reviewed Dec 5, 2025

View reviewed changes

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts Show resolved Hide resolved

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts Show resolved Hide resolved

Enhance oob cases

3632ea1

shaoboyan091 requested a review from Copilot December 8, 2025 03:03

Copilot started reviewing on behalf of shaoboyan091 December 8, 2025 03:04 View session

Copilot AI reviewed Dec 8, 2025

View reviewed changes

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts Show resolved Hide resolved

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts Outdated Show resolved Hide resolved

src/webgpu/api/validation/encoding/cmds/setImmediates.spec.ts Outdated Show resolved Hide resolved

Address comments

2b0f03b

shaoboyan091 requested a review from Copilot December 8, 2025 03:12

Copilot started reviewing on behalf of shaoboyan091 December 8, 2025 03:13 View session

Copilot AI reviewed Dec 8, 2025

View reviewed changes

	.desc('Tests that rangeOffset + contentSize exceeds Number.MAX_SAFE_INTEGER.')
	.desc('Tests that rangeOffset + contentSize do not exceed Number.MAX_SAFE_INTEGER.')

	- rangeOffset + contentSize is overflow
	- rangeOffset + contentSize overflows

		.desc(
		'Tests that rangeOffset + contentSize is greater than maxImmediateSize and contentSize is larger than data size.'

Validate setImmediates API in different encoder types #4515

Are you sure you want to change the base?

Validate setImmediates API in different encoder types #4515

Conversation

shaoboyan091 commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

shaoboyan091 commented Dec 3, 2025 •

edited

Loading