Add exclusionFilters option in requestDevice() #93

beaufortfrancois · 2022-02-21T12:35:26Z

This PR is about a new "exclusionFilters" option in navigator.hid.requestDevice() so that developers can exclude from the browser picker some known devices that are known to not work as expected.

Currently, developers let users pick a device, then check against a custom helper function (like deviceIsBlocklisted()) if device is known to be malfunctioning.

// Request access to a device with vendor ID 0xABCD. The device must also have a
// collection with usage page Consumer (0x000C) and usage ID Consumer Control
// (0x0001). The device with product ID 0x1234 has been reported as malfunctioning.
const devices = await navigator.hid.requestDevice({
  filters: [{ vendorId: 0xabcd, usagePage: 0x000c, usage: 0x0001 }],
  exclusionFilters: [{ vendorId: 0xabcd, productId: 0x1234 }],
});

Please have a look @nondebug

index.html

nondebug · 2022-02-28T19:21:06Z

index.html

@@ -1263,6 +1273,61 @@ <h4>
            </li>
          </ol>
        </section>
+        <section data-dfn-for="HIDDeviceExclude">
+          <h4>
+            <dfn>HIDDeviceExclude</dfn> dictionary


I think there's not much value in defining a new dictionary type for exclusion filters. Let's reuse HIDDeviceFilter for the exclusion filters and specify that usagePage and usage must not be defined when a HIDDeviceFilter is used for exclusion.

Actually, I think it makes more sense to treat exclusion filters exactly the same as normal (inclusion?) filters other than whether they include or exclude. If the filters look the same they should behave the same. Let's allow filtering by usagePage and usage (even though I can't think of a good reason to do that). In the future I think we may add filter parameters for connection type (usb, bluetooth, etc) and it would be nice to not need duplicate language in the spec for inclusion vs exclusion.

I've updated spec PR based on your feedback. Please have another look.

index.html

beaufortfrancois · 2022-03-01T11:03:12Z

@nondebug I've updated the PR based on your feedback. Please have another look.

This CL adds a exclusionFilters option in navigator.usb.requestDevice() so that developers can exclude from the browser picker some devices that are known to not work as expected. This feature is available behind the WebHIDExclusionFiltersOption blink runtime feature. Intent to prototype: TODO Spec: WICG/webhid#93 Demo: https://hid-exclusion-filters.glitch.me/ Change-Id: If16eb4c788de2acd2454009449699cbbcd6039b8 Bug: 1301934

nondebug

Apologies for the delay, these changes LGTM

beaufortfrancois · 2022-03-22T07:26:23Z

@nondebug Thank you. I can't merge this PR, please do.

This CL adds a exclusionFilters option in navigator.usb.requestDevice() so that developers can exclude from the browser picker some devices that are known to not work as expected. This feature is available behind the WebHIDExclusionFiltersOption blink runtime feature. Intent to prototype: TODO Spec: WICG/webhid#93 Demo: https://hid-exclusion-filters.glitch.me/ Change-Id: If16eb4c788de2acd2454009449699cbbcd6039b8 Bug: 1301934

This CL adds a exclusionFilters option in navigator.usb.requestDevice() so that developers can exclude from the browser picker some devices that are known to not work as expected. This feature is available behind the WebHIDExclusionFiltersOption blink runtime feature. Intent to ship: TODO Spec: WICG/webhid#93 Demo: https://hid-exclusion-filters.glitch.me/ Change-Id: If16eb4c788de2acd2454009449699cbbcd6039b8 Bug: 1301934

@nondebug

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

This CL adds a exclusionFilters option in navigator.usb.requestDevice() so that developers can exclude from the browser picker some devices that are known to not work as expected. This feature is available behind the WebHIDExclusionFiltersOption blink runtime feature. Intent to ship: https://groups.google.com/a/chromium.org/g/blink-dev/c/DPAaLnuaOH4 Spec: WICG/webhid#93 Demo: https://hid-exclusion-filters.glitch.me/ Change-Id: If16eb4c788de2acd2454009449699cbbcd6039b8 Bug: 1301934

This CL adds a exclusionFilters option in navigator.usb.requestDevice() so that developers can exclude from the browser picker some devices that are known to not work as expected. This feature is available behind the WebHIDExclusionFiltersOption blink runtime feature. Intent to ship: https://groups.google.com/a/chromium.org/g/blink-dev/c/DPAaLnuaOH4 Spec: WICG/webhid#93 Demo: https://hid-exclusion-filters.glitch.me/ Change-Id: If16eb4c788de2acd2454009449699cbbcd6039b8 Bug: 1301934 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3478175 Reviewed-by: Matt Reynolds <mattreynolds@chromium.org> Reviewed-by: Daniel Cheng <dcheng@chromium.org> Auto-Submit: Fr <beaufort.francois@gmail.com> Reviewed-by: Avi Drissman <avi@chromium.org> Commit-Queue: Avi Drissman <avi@chromium.org> Cr-Commit-Position: refs/heads/main@{#986496}

Chromium change: https://chromium.googlesource.com/chromium/src/+/c655f4ee8c6a16058886450db522ceb00d285e6a commit c655f4ee8c6a16058886450db522ceb00d285e6a Author: François Beaufort <beaufort.francois@gmail.com> Date: Tue Mar 29 15:06:28 2022 +0000 hid: Add exclusionFilters option to requestDevice This CL adds a exclusionFilters option in navigator.usb.requestDevice() so that developers can exclude from the browser picker some devices that are known to not work as expected. This feature is available behind the WebHIDExclusionFiltersOption blink runtime feature. Intent to ship: https://groups.google.com/a/chromium.org/g/blink-dev/c/DPAaLnuaOH4 Spec: WICG/webhid#93 Demo: https://hid-exclusion-filters.glitch.me/ Bug: 1301934

This CL adds a exclusionFilters option in navigator.usb.requestDevice() so that developers can exclude from the browser picker some devices that are known to not work as expected. This feature is available behind the WebHIDExclusionFiltersOption blink runtime feature. Intent to ship: https://groups.google.com/a/chromium.org/g/blink-dev/c/DPAaLnuaOH4 Spec: WICG/webhid#93 Demo: https://hid-exclusion-filters.glitch.me/ Change-Id: If16eb4c788de2acd2454009449699cbbcd6039b8 Bug: 1301934 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3478175 Reviewed-by: Matt Reynolds <mattreynolds@chromium.org> Reviewed-by: Daniel Cheng <dcheng@chromium.org> Auto-Submit: Fr <beaufort.francois@gmail.com> Reviewed-by: Avi Drissman <avi@chromium.org> Commit-Queue: Avi Drissman <avi@chromium.org> Cr-Commit-Position: refs/heads/main@{#986496} NOKEYCHECK=True GitOrigin-RevId: c655f4ee8c6a16058886450db522ceb00d285e6a

Add excludes option to requestDevice()

bc8667f

beaufortfrancois mentioned this pull request Feb 21, 2022

Exclude some devices from picker #92

Closed

nondebug reviewed Feb 28, 2022

View reviewed changes

Address feedback

91e82fb

beaufortfrancois changed the title ~~Add excludes option in requestDevice()~~ Add exclusionFilters option in requestDevice() Mar 1, 2022

chromium-wpt-export-bot mentioned this pull request Mar 1, 2022

hid: Add exclusionFilters option to requestDevice web-platform-tests/wpt#33014

Merged

beaufortfrancois force-pushed the exclude branch 3 times, most recently from d7adce7 to 30b4fda Compare March 4, 2022 08:44

Treat exclusion filters same as filters

46c3fe7

beaufortfrancois force-pushed the exclude branch from 30b4fda to 46c3fe7 Compare March 4, 2022 11:13

beaufortfrancois mentioned this pull request Mar 14, 2022

A new filter option to exclude already-authorized devices #49

Open

nondebug approved these changes Mar 22, 2022

View reviewed changes

nondebug merged commit fcff4a1 into WICG:main Mar 24, 2022

github-actions bot added a commit that referenced this pull request Mar 24, 2022

Merge pull request #93 from beaufortfrancois/exclude

efe1b60

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

beaufortfrancois mentioned this pull request Mar 24, 2023

Add exclusionFilters to RequestDeviceOptions WebBluetoothCG/web-bluetooth#600

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add exclusionFilters option in requestDevice() #93

Add exclusionFilters option in requestDevice() #93

beaufortfrancois commented Feb 21, 2022 •

edited

Loading

nondebug Feb 28, 2022

beaufortfrancois Mar 1, 2022

nondebug Mar 3, 2022

beaufortfrancois Mar 4, 2022

beaufortfrancois commented Mar 1, 2022

nondebug left a comment

beaufortfrancois commented Mar 22, 2022

Add exclusionFilters option in requestDevice() #93

Add exclusionFilters option in requestDevice() #93

Conversation

beaufortfrancois commented Feb 21, 2022 • edited Loading

nondebug Feb 28, 2022

Choose a reason for hiding this comment

beaufortfrancois Mar 1, 2022

Choose a reason for hiding this comment

nondebug Mar 3, 2022

Choose a reason for hiding this comment

beaufortfrancois Mar 4, 2022

Choose a reason for hiding this comment

beaufortfrancois commented Mar 1, 2022

nondebug left a comment

Choose a reason for hiding this comment

beaufortfrancois commented Mar 22, 2022

beaufortfrancois commented Feb 21, 2022 •

edited

Loading