Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC 128: Consume User Activation #128

Merged
merged 4 commits into from
Apr 4, 2023
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions rfcs/consume_user_activation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# RFC 128: Consume user activation

Editor: Marcos Caceres, Apple Inc.

## Summary

Tests in WPT are currently relying on various indirect means to "[consume user activation](https://html.spec.whatwg.org/#consume-user-activation)" [HTML].
Some of these means are non-standard in as far as they are not specified to consume user activation, meaning that the tests are inshrining non-standard behavior for conformance purposes.

The workarounds being used are as follows, with several drawbacks:

* Using Fullscreen API: non-standard, takes significant time to put an element into fullscreen.
foolip marked this conversation as resolved.
Show resolved Hide resolved
marcoscaceres marked this conversation as resolved.
Show resolved Hide resolved
* Using window.open() and window.close() - non-standard, not mobile friendly.
* Using Payment Request API - not widely implemented (e.g., not exposed in Gecko).

We also looked at a range of other possible APIs that consume user activation, and found [none to be suitable](https://github.com/web-platform-tests/wpt/issues/36727#issuecomment-1296349964).

## Details

We would like to propose the addition of an async function `test_driver.consume_user_activation()` method that returns a `Promse<boolean>` (representing if the activation was consumed or not). For example:

```
const consume = await test_driver.consume_user_activation();
```

The `consume_user_activation()` method can take a `Window` <var>context</var> (which defaults to the current Window object). Allowing consumption to happen at a particular window, if required.

The `consume_user_activation()` method would be implemented via the proposed addition of “[Consume user activation of Window](https://github.com/w3c/webdriver/pull/1695)” to the Web Driver specification.

This prposal has several advantages:
* it's fast - no opening windows or waiting for fullscreen to enter/exit.
* it's lightweight - it doesn't create new browsing contexts.
* it's mobile friendly - as above.
* it's build for purpose - no more using other APIs to indirectly achieve the desired outcome.
* It's really simple - it complements `.bless()` and other user activation functionality already available.

[An implementation](https://github.com/WebKit/WebKit/pull/6539) is available in WebKit.

## Risks

None known.