Replace urlpattern implementation with rust-urlpattern crate (#36826)

This change implements the full URLPattern API using
https://github.com/denoland/rust-urlpattern, except the two most
important functions (`test` and `exec`). These two are blocked on
https://github.com/servo/servo/issues/28679 due to this union:
539ca27284/components/script_bindings/webidls/URLPattern.webidl (L61).

Testing: Covered by existing web platform tests
Makes https://github.com/servo/servo/pull/36421 obsolete

---------

Signed-off-by: Simon Wülker <simon.wuelker@arcor.de>
This commit is contained in:
Simon Wülker 2025-05-06 11:42:55 +02:00 committed by GitHub
parent 54c2818974
commit 03abec4148
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 292 additions and 2483 deletions

View file

@ -0,0 +1,204 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/. */
use dom_struct::dom_struct;
use js::rust::HandleObject;
use script_bindings::codegen::GenericUnionTypes::USVStringOrURLPatternInit;
use script_bindings::error::{Error, Fallible};
use script_bindings::reflector::Reflector;
use script_bindings::root::DomRoot;
use script_bindings::script_runtime::CanGc;
use script_bindings::str::USVString;
use crate::dom::bindings::codegen::Bindings::URLPatternBinding;
use crate::dom::bindings::codegen::Bindings::URLPatternBinding::URLPatternMethods;
use crate::dom::bindings::reflector::reflect_dom_object_with_proto;
use crate::dom::globalscope::GlobalScope;
/// <https://urlpattern.spec.whatwg.org/#urlpattern>
#[dom_struct]
pub(crate) struct URLPattern {
reflector: Reflector,
/// <https://urlpattern.spec.whatwg.org/#urlpattern-associated-url-pattern>
#[no_trace]
associated_url_pattern: urlpattern::UrlPattern,
}
impl URLPattern {
#[cfg_attr(crown, allow(crown::unrooted_must_root))]
fn new_inherited(associated_url_pattern: urlpattern::UrlPattern) -> URLPattern {
URLPattern {
reflector: Reflector::new(),
associated_url_pattern,
}
}
/// <https://urlpattern.spec.whatwg.org/#urlpattern-initialize>
pub(crate) fn initialize(
global: &GlobalScope,
proto: Option<HandleObject>,
input: USVStringOrURLPatternInit,
base_url: Option<USVString>,
options: &URLPatternBinding::URLPatternOptions,
can_gc: CanGc,
) -> Fallible<DomRoot<URLPattern>> {
// The section below converts from servos types to the types used in the urlpattern crate
let base_url = base_url.map(|usv_string| usv_string.0);
let input = bindings_to_third_party::map_urlpattern_input(input, base_url.clone());
let options = urlpattern::UrlPatternOptions {
ignore_case: options.ignoreCase,
};
// Parse and initialize the URL pattern.
let pattern_init =
urlpattern::quirks::process_construct_pattern_input(input, base_url.as_deref())
.map_err(|error| Error::Type(format!("{error}")))?;
let pattern = urlpattern::UrlPattern::parse(pattern_init, options)
.map_err(|error| Error::Type(format!("{error}")))?;
let url_pattern = reflect_dom_object_with_proto(
Box::new(URLPattern::new_inherited(pattern)),
global,
proto,
can_gc,
);
Ok(url_pattern)
}
}
impl URLPatternMethods<crate::DomTypeHolder> for URLPattern {
// <https://urlpattern.spec.whatwg.org/#dom-urlpattern-urlpattern>
fn Constructor(
global: &GlobalScope,
proto: Option<HandleObject>,
can_gc: CanGc,
input: USVStringOrURLPatternInit,
base_url: USVString,
options: &URLPatternBinding::URLPatternOptions,
) -> Fallible<DomRoot<URLPattern>> {
URLPattern::initialize(global, proto, input, Some(base_url), options, can_gc)
}
/// <https://urlpattern.spec.whatwg.org/#dom-urlpattern-urlpattern-input-options>
fn Constructor_(
global: &GlobalScope,
proto: Option<HandleObject>,
can_gc: CanGc,
input: USVStringOrURLPatternInit,
options: &URLPatternBinding::URLPatternOptions,
) -> Fallible<DomRoot<URLPattern>> {
// Step 1. Run initialize given this, input, null, and options.
URLPattern::initialize(global, proto, input, None, options, can_gc)
}
/// <https://urlpattern.spec.whatwg.org/#dom-urlpattern-protocol>
fn Protocol(&self) -> USVString {
// Step 1. Return thiss associated URL patterns protocol components pattern string.
USVString(self.associated_url_pattern.protocol().to_owned())
}
/// <https://urlpattern.spec.whatwg.org/#dom-urlpattern-username>
fn Username(&self) -> USVString {
// Step 1. Return thiss associated URL patterns username components pattern string.
USVString(self.associated_url_pattern.username().to_owned())
}
/// <https://urlpattern.spec.whatwg.org/#dom-urlpattern-password>
fn Password(&self) -> USVString {
// Step 1. Return thiss associated URL patterns password components pattern string.
USVString(self.associated_url_pattern.password().to_owned())
}
/// <https://urlpattern.spec.whatwg.org/#dom-urlpattern-hostname>
fn Hostname(&self) -> USVString {
// Step 1. Return thiss associated URL patterns hostname components pattern string.
USVString(self.associated_url_pattern.hostname().to_owned())
}
/// <https://urlpattern.spec.whatwg.org/#dom-urlpattern-port>
fn Port(&self) -> USVString {
// Step 1. Return thiss associated URL patterns port components pattern string.
USVString(self.associated_url_pattern.port().to_owned())
}
/// <https://urlpattern.spec.whatwg.org/#dom-urlpattern-pathname>
fn Pathname(&self) -> USVString {
// Step 1. Return thiss associated URL patterns pathname components pattern string.
USVString(self.associated_url_pattern.pathname().to_owned())
}
/// <https://urlpattern.spec.whatwg.org/#dom-urlpattern-search>
fn Search(&self) -> USVString {
// Step 1. Return thiss associated URL patterns search components pattern string.
USVString(self.associated_url_pattern.search().to_owned())
}
/// <https://urlpattern.spec.whatwg.org/#dom-urlpattern-hash>
fn Hash(&self) -> USVString {
// Step 1. Return thiss associated URL patterns hash components pattern string.
USVString(self.associated_url_pattern.hash().to_owned())
}
/// <https://urlpattern.spec.whatwg.org/#dom-urlpattern-hasregexpgroups>
fn HasRegExpGroups(&self) -> bool {
// Step 1. If thiss associated URL patterns has regexp groups, then return true.
// Step 2. Return false.
self.associated_url_pattern.has_regexp_groups()
}
}
mod bindings_to_third_party {
use crate::dom::urlpattern::USVStringOrURLPatternInit;
pub(super) fn map_urlpattern_input(
input: USVStringOrURLPatternInit,
base_url: Option<String>,
) -> urlpattern::quirks::StringOrInit {
match input {
USVStringOrURLPatternInit::USVString(usv_string) => {
urlpattern::quirks::StringOrInit::String(usv_string.0)
},
USVStringOrURLPatternInit::URLPatternInit(pattern_init) => {
let pattern_init = urlpattern::quirks::UrlPatternInit {
protocol: pattern_init
.protocol
.as_ref()
.map(|usv_string| usv_string.to_string()),
username: pattern_init
.username
.as_ref()
.map(|usv_string| usv_string.to_string()),
password: pattern_init
.password
.as_ref()
.map(|usv_string| usv_string.to_string()),
hostname: pattern_init
.hostname
.as_ref()
.map(|usv_string| usv_string.to_string()),
port: pattern_init
.port
.as_ref()
.map(|usv_string| usv_string.to_string()),
pathname: pattern_init
.pathname
.as_ref()
.map(|usv_string| usv_string.to_string()),
search: pattern_init
.search
.as_ref()
.map(|usv_string| usv_string.to_string()),
hash: pattern_init
.hash
.as_ref()
.map(|usv_string| usv_string.to_string()),
base_url,
};
urlpattern::quirks::StringOrInit::Init(pattern_init)
},
}
}
}