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.

Sign up for GitHub

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

Jump to bottom

URLManifestItem.url shouldn't contain non-URL-unit characters #181

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

URLManifestItem.url shouldn't contain non-URL-unit characters #181

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d74b72a
Add RFC 181 - URLManifestItem.url shouldn't contain non-URL-unit char…
gsnedders Feb 16, 2024
447ff37
Update rfcs/valid-item-urls.md
gsnedders Feb 16, 2024
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
40 changes: 40 additions & 0 deletions rfcs/valid-item-urls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# RFC 181 - URLManifestItem.url shouldn't contain non-URL-unit characters

## Summary

Currently we end up storing URLs such as: `/xhr/xmlhttprequest-timeout-worker-aborted.html?aborted immediately after send()`. If you pass this to the [URL parser](https://url.spec.whatwg.org/#concept-url-parser) with a base URL of `http://web-platform.test`, this results in a number of [invalid-URL-unit](https://url.spec.whatwg.org/#invalid-url-unit) [validation errors](https://url.spec.whatwg.org/#validation-error).

We should instead store the output of [URL serialize](https://url.spec.whatwg.org/#concept-url-serializer) ∘ [URL parse](https://url.spec.whatwg.org/#concept-url-parser) of the URL.

## Details

There are various systems at various vendors which expect test identifiers to not contain spaces, and when in principle the test identifier is a URL one might expect it to not contain any spaces.

This is primarily a concern with variants, which vastly more often include spaces, such as the example above.

We do have a few files in WPT which contain spaces:

```
gsnedders@gsnedders-marsha web-platform-tests % find . -name '* *'
./tools/wave/test/WAVE Local.postman_environment.json
./tools/wave/test/WAVE Server REST API Tests.postman_collection.json
./tools/wave/tests/WAVE Local.postman_environment.json
./tools/wave/tests/WAVE Server REST API Tests.postman_collection.json
./css/CSS2/syntax/support/'green block.png
./html/semantics/document-metadata/the-meta-element/pragma-directives/attr-meta-http-equiv-refresh/support/url foo
./html/canvas/offscreen/path-objects/2d.path.roundrect.1.radius.dompoint.single argument.worker.js
./html/canvas/offscreen/path-objects/2d.path.roundrect.1.radius.dompoint.single argument.html
./html/canvas/element/path-objects/2d.path.roundrect.1.radius.dompoint.single argument.html
```

Only the last three of these are test files, which generate three test items.

One question here is whether we should disallow test file paths that allow spaces, or whether we should just escape these in the URL.
gsnedders marked this conversation as resolved.
Show resolved Hide resolved

## Risks

Any test system that keys off the test URLs will have to deal with URLs changing.

This includes the wptmanifest (i.e., wptrunner's expectation manifest), WebKit (and I believe Blink)'s TestExpectations files and results expectations files.

This may also affect items in wpt-metadata.