Add exclusionFilters to USBDeviceRequestOptions #233

beaufortfrancois · 2023-06-16T12:20:41Z

The new "exclusionFilters" option in navigator.usb.requestDevice() allows web developers to exclude some devices from the browser picker. It can be used to exclude devices that match a broader filter but are unsupported, or are already connected for instance.

// Request access to a device from vendor ID 0xABCD. 
// The device with product ID 0x1234 has been reported as unsupported.
const device = await navigator.usb.requestDevice({
  filters: [{ vendorId: 0xABCD }],
  exclusionFilters: [{ vendorId: 0xABCD, productId: 0x1234 }],
});

Please have a look @reillyeon

FIX: #232

Preview | Diff

This CL adds a new "exclusionFilters" option in navigator.usb.requestDevice() options so that web developers can exclude from the browser picker some known devices that are known to not work as expected. Intent to Ship: TODO Spec: WICG/webusb#233 Demo: https://usb-exclusion-filters.glitch.me/ Bug: 1455392 Change-Id: I1b61d9daae3e14accedb24e493ae656316427893

yume-chan · 2023-06-16T13:08:11Z

Why do requestDevice and Peromission API treat the excludionFilters options differently? requestDevice doesn't allow it to be an empty array, and didn't check whether it was set in step 7. I think an empty array should behavior the same as not set.

reillyeon

LGTM with nits. I agree that we probably should unify the behavior between requestDevice() and the Permissions API integration. Of course the latter is a bit aspirational since it isn't implemented in any browser engine.

reillyeon · 2023-06-16T17:19:37Z

index.bs

     filter</a> in <code>|options|.{{USBPermissionDescriptor/filters}}</code>.
-  6. Display a prompt to the user requesting they select a device from
+  7. Remove devices from |enumerationResult| if they do <a>match a device filter</a>


Suggested change

7. Remove devices from |enumerationResult| if they do <a>match a device filter</a>

7. Remove devices from |enumerationResult| if they <a>match a device filter</a>

reillyeon · 2023-06-16T17:20:23Z

index.bs

@@ -2370,10 +2389,14 @@ defined as follows:
              and |device| does not <a>match a device filter</a> in
              <code>|desc|.{{USBPermissionDescriptor/filters}}</code>, continue
              to the next |device|.
-           2. Get the {{USBDevice}} representing |device| and add it to
+           2. If <code>|desc|.{{USBPermissionDescriptor/exclusionFilters}}</code>
+              is set and |device| does <a>match a device filter</a> in


Suggested change

is set and |device| does <a>match a device filter</a> in

is set and |device| <a>matches a device filter</a> in

You might need to add an attribute to the definition of "match a device filter" for it to understand this version is the same definition. I forget how smart it is about this.

This CL adds a new "exclusionFilters" option in navigator.usb.requestDevice() options so that web developers can exclude from the browser picker some devices that are known to not work as expected. Intent to Ship: TODO Spec: WICG/webusb#233 Demo: https://usb-exclusion-filters.glitch.me/ Bug: 1455392 Change-Id: I1b61d9daae3e14accedb24e493ae656316427893

beaufortfrancois · 2023-06-19T09:50:52Z

LGTM with nits. I agree that we probably should unify the behavior between requestDevice() and the Permissions API integration. Of course the latter is a bit aspirational since it isn't implemented in any browser engine.

Thank you! I've addressed your nits.

Would it be okay to land this as is and file a spec issue to unify the behaviour between requestDevice() and the Permissions API?

beaufortfrancois · 2023-06-19T09:52:11Z

FYI I've started implementing this change in Chromium at https://chromium-review.googlesource.com/c/chromium/src/+/4614682.

Once the spec is updated, I'll start an intent to ship if that looks good to you @reillyeon

reillyeon · 2023-06-20T16:28:10Z

Would it be okay to land this as is and file a spec issue to unify the behaviour between requestDevice() and the Permissions API?

Yes.

beaufortfrancois · 2023-06-20T19:52:40Z

@reillyeon Can you merge?

SHA: 1ebe98c Reason: push, by reillyeon Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

This CL adds a new "exclusionFilters" option in navigator.usb.requestDevice() options so that web developers can exclude from the browser picker some devices that are known to not work as expected. Intent to Ship: https://groups.google.com/a/chromium.org/g/blink-dev/c/e1mgO-m8zvQ Spec: WICG/webusb#233 Demo: https://usb-exclusion-filters.glitch.me/ Bug: 1455392 Change-Id: I1b61d9daae3e14accedb24e493ae656316427893

This CL adds a new "exclusionFilters" option in navigator.usb.requestDevice() options so that web developers can exclude from the browser picker some devices that are known to not work as expected. Intent to Ship: https://groups.google.com/a/chromium.org/g/blink-dev/c/e1mgO-m8zvQ Spec: - WICG/webusb#233 - WICG/webusb#235 Demo: https://usb-exclusion-filters.glitch.me/ Bug: 1455392 Change-Id: I1b61d9daae3e14accedb24e493ae656316427893

This CL adds a new "exclusionFilters" option in navigator.usb.requestDevice() options so that web developers can exclude from the browser picker some devices that are known to not work as expected. Intent to Ship: https://groups.google.com/a/chromium.org/g/blink-dev/c/e1mgO-m8zvQ Spec: - WICG/webusb#233 - WICG/webusb#235 Demo: https://usb-exclusion-filters.glitch.me/ Bug: 1455392 Change-Id: I1b61d9daae3e14accedb24e493ae656316427893 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4614682 Reviewed-by: Arthur Sonzogni <[email protected]> Reviewed-by: Reilly Grant <[email protected]> Commit-Queue: Fr <[email protected]> Cr-Commit-Position: refs/heads/main@{#1161953}

Upstream has done changes to the constructor of `UsbChooserController`. We happen to depend on this class for one of our tests, as way to insert a fake. This change makes the necessary adjustments to reflect the upstream change. Chromium change: https://chromium.googlesource.com/chromium/src/+/19b0f58776f13112c4490e912ff0850b52720a36 commit 19b0f58776f13112c4490e912ff0850b52720a36 Author: François Beaufort <[email protected]> Date: Fri Jun 23 21:18:39 2023 +0000 WebUSB: Add exclusionFilters to USBRequestDeviceOptions This CL adds a new "exclusionFilters" option in navigator.usb.requestDevice() options so that web developers can exclude from the browser picker some devices that are known to not work as expected. Intent to Ship: https://groups.google.com/a/chromium.org/g/blink-dev/c/e1mgO-m8zvQ Spec: - WICG/webusb#233 - WICG/webusb#235 Demo: https://usb-exclusion-filters.glitch.me/ Bug: 1455392

…stDeviceOptions, a=testonly Automatic update from web-platform-tests WebUSB: Add exclusionFilters to USBRequestDeviceOptions This CL adds a new "exclusionFilters" option in navigator.usb.requestDevice() options so that web developers can exclude from the browser picker some devices that are known to not work as expected. Intent to Ship: https://groups.google.com/a/chromium.org/g/blink-dev/c/e1mgO-m8zvQ Spec: - WICG/webusb#233 - WICG/webusb#235 Demo: https://usb-exclusion-filters.glitch.me/ Bug: 1455392 Change-Id: I1b61d9daae3e14accedb24e493ae656316427893 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4614682 Reviewed-by: Arthur Sonzogni <[email protected]> Reviewed-by: Reilly Grant <[email protected]> Commit-Queue: Fr <[email protected]> Cr-Commit-Position: refs/heads/main@{#1161953} -- wpt-commits: b7727490c96a87eb3f40fe43f266ad05368ab2b0 wpt-pr: 40582

Upstream has done changes to the constructor of `UsbChooserController`. We happen to depend on this class for one of our tests, as way to insert a fake. This change makes the necessary adjustments to reflect the upstream change. Chromium change: https://chromium.googlesource.com/chromium/src/+/19b0f58776f13112c4490e912ff0850b52720a36 commit 19b0f58776f13112c4490e912ff0850b52720a36 Author: François Beaufort <[email protected]> Date: Fri Jun 23 21:18:39 2023 +0000 WebUSB: Add exclusionFilters to USBRequestDeviceOptions This CL adds a new "exclusionFilters" option in navigator.usb.requestDevice() options so that web developers can exclude from the browser picker some devices that are known to not work as expected. Intent to Ship: https://groups.google.com/a/chromium.org/g/blink-dev/c/e1mgO-m8zvQ Spec: - WICG/webusb#233 - WICG/webusb#235 Demo: https://usb-exclusion-filters.glitch.me/ Bug: 1455392

Add exclusionFilters to USBDeviceRequestOptions

fd6ef2e

beaufortfrancois mentioned this pull request Jun 16, 2023

Exclusive filter in requestDevice #232

Closed

chromium-wpt-export-bot mentioned this pull request Jun 16, 2023

WebUSB: Add exclusionFilters to USBRequestDeviceOptions web-platform-tests/wpt#40582

Merged

reillyeon approved these changes Jun 16, 2023

View reviewed changes

Address nits

899dc84

reillyeon approved these changes Jun 20, 2023

View reviewed changes

reillyeon merged commit 1ebe98c into WICG:main Jun 20, 2023

github-actions bot added a commit that referenced this pull request Jun 20, 2023

Add exclusionFilters to USBDeviceRequestOptions (#233)

d327ef5

SHA: 1ebe98c Reason: push, by reillyeon Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

github-actions bot added a commit that referenced this pull request Jun 20, 2023

Add exclusionFilters to USBDeviceRequestOptions (#233)

9bed196

SHA: 1ebe98c Reason: push, by reillyeon Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

beaufortfrancois mentioned this pull request Jun 21, 2023

Unify the behaviour between requestDevice() and the Permissions API #234

Closed

This was referenced Jun 22, 2023

Add default value to exclusionFilters #235

Merged

WebUSB exclusionFilters option in requestDevice() w3ctag/design-reviews#865

Closed

yume-chan mentioned this pull request Sep 28, 2023

[w3c-web-usb] Add exclusionFilters option DefinitelyTyped/DefinitelyTyped#66864

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add exclusionFilters to USBDeviceRequestOptions #233

Add exclusionFilters to USBDeviceRequestOptions #233

beaufortfrancois commented Jun 16, 2023 •

edited by pr-preview bot

Loading

yume-chan commented Jun 16, 2023 •

edited

Loading

reillyeon left a comment

reillyeon Jun 16, 2023

reillyeon Jun 16, 2023

beaufortfrancois commented Jun 19, 2023

beaufortfrancois commented Jun 19, 2023

reillyeon commented Jun 20, 2023

beaufortfrancois commented Jun 20, 2023

	7. Remove devices from \|enumerationResult\| if they do <a>match a device filter</a>
	7. Remove devices from \|enumerationResult\| if they <a>match a device filter</a>

	is set and \|device\| does <a>match a device filter</a> in
	is set and \|device\| <a>matches a device filter</a> in

Add exclusionFilters to USBDeviceRequestOptions #233

Add exclusionFilters to USBDeviceRequestOptions #233

Conversation

beaufortfrancois commented Jun 16, 2023 • edited by pr-preview bot Loading

yume-chan commented Jun 16, 2023 • edited Loading

reillyeon left a comment

Choose a reason for hiding this comment

reillyeon Jun 16, 2023

Choose a reason for hiding this comment

reillyeon Jun 16, 2023

Choose a reason for hiding this comment

beaufortfrancois commented Jun 19, 2023

beaufortfrancois commented Jun 19, 2023

reillyeon commented Jun 20, 2023

beaufortfrancois commented Jun 20, 2023

beaufortfrancois commented Jun 16, 2023 •

edited by pr-preview bot

Loading

yume-chan commented Jun 16, 2023 •

edited

Loading