script/dom/servoparser/
prefetch.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::cell::{Cell, RefCell};
6use std::ops::Deref;
7
8use base::generic_channel::GenericSend;
9use base::id::{PipelineId, WebViewId};
10use html5ever::buffer_queue::BufferQueue;
11use html5ever::tokenizer::states::RawKind;
12use html5ever::tokenizer::{
13    Tag, TagKind, Token, TokenSink, TokenSinkResult, Tokenizer as HtmlTokenizer,
14};
15use html5ever::{Attribute, LocalName, local_name};
16use js::jsapi::JSTracer;
17use markup5ever::TokenizerResult;
18use net_traits::policy_container::PolicyContainer;
19use net_traits::request::{
20    CorsSettings, CredentialsMode, Destination, InsecureRequestsPolicy, ParserMetadata, Referrer,
21    RequestClient,
22};
23use net_traits::{CoreResourceMsg, FetchChannels, ReferrerPolicy, ResourceThreads};
24use servo_url::{ImmutableOrigin, ServoUrl};
25
26use crate::dom::bindings::reflector::DomGlobal;
27use crate::dom::bindings::trace::{CustomTraceable, JSTraceable};
28use crate::dom::document::Document;
29use crate::dom::html::htmlscriptelement::script_fetch_request;
30use crate::dom::processingoptions::determine_cors_settings_for_token;
31use crate::fetch::create_a_potential_cors_request;
32use crate::script_module::ScriptFetchOptions;
33
34#[derive(JSTraceable, MallocSizeOf)]
35#[cfg_attr(crown, crown::unrooted_must_root_lint::must_root)]
36pub(crate) struct Tokenizer {
37    #[ignore_malloc_size_of = "Defined in html5ever"]
38    inner: TraceableTokenizer,
39}
40
41struct TraceableTokenizer(HtmlTokenizer<PrefetchSink>);
42
43impl Deref for TraceableTokenizer {
44    type Target = HtmlTokenizer<PrefetchSink>;
45    fn deref(&self) -> &Self::Target {
46        &self.0
47    }
48}
49
50#[expect(unsafe_code)]
51unsafe impl JSTraceable for TraceableTokenizer {
52    unsafe fn trace(&self, trc: *mut JSTracer) {
53        unsafe { CustomTraceable::trace(&self.0, trc) }
54    }
55}
56
57#[expect(unsafe_code)]
58unsafe impl CustomTraceable for PrefetchSink {
59    unsafe fn trace(&self, trc: *mut JSTracer) {
60        unsafe { <Self as JSTraceable>::trace(self, trc) }
61    }
62}
63
64impl Tokenizer {
65    pub(crate) fn new(document: &Document) -> Self {
66        let global = document.global();
67        let sink = PrefetchSink {
68            origin: document.origin().immutable().clone(),
69            pipeline_id: global.pipeline_id(),
70            webview_id: document.webview_id(),
71            base_url: RefCell::new(None),
72            document_url: document.url(),
73            referrer: global.get_referrer(),
74            referrer_policy: document.get_referrer_policy(),
75            resource_threads: document.loader().resource_threads().clone(),
76            // Initially we set prefetching to false, and only set it
77            // true after the first script tag, since that is what will
78            // block the main parser.
79            prefetching: Cell::new(false),
80            insecure_requests_policy: document.insecure_requests_policy(),
81            has_trustworthy_ancestor_origin: document.has_trustworthy_ancestor_or_current_origin(),
82            policy_container: global.policy_container(),
83            request_client: global.request_client(),
84        };
85        let options = Default::default();
86        let inner = TraceableTokenizer(HtmlTokenizer::new(sink, options));
87        Tokenizer { inner }
88    }
89
90    pub(crate) fn feed(&self, input: &BufferQueue) {
91        while let TokenizerResult::Script(PrefetchHandle) = self.inner.feed(input) {}
92    }
93}
94
95#[derive(JSTraceable)]
96struct PrefetchSink {
97    #[no_trace]
98    origin: ImmutableOrigin,
99    #[no_trace]
100    pipeline_id: PipelineId,
101    #[no_trace]
102    webview_id: WebViewId,
103    #[no_trace]
104    document_url: ServoUrl,
105    #[no_trace]
106    base_url: RefCell<Option<ServoUrl>>,
107    #[no_trace]
108    referrer: Referrer,
109    #[no_trace]
110    referrer_policy: ReferrerPolicy,
111    #[no_trace]
112    resource_threads: ResourceThreads,
113    prefetching: Cell<bool>,
114    #[no_trace]
115    insecure_requests_policy: InsecureRequestsPolicy,
116    has_trustworthy_ancestor_origin: bool,
117    #[no_trace]
118    policy_container: PolicyContainer,
119    #[no_trace]
120    request_client: RequestClient,
121}
122
123/// The prefetch tokenizer produces trivial results
124#[derive(Clone, Copy, JSTraceable)]
125struct PrefetchHandle;
126
127impl TokenSink for PrefetchSink {
128    type Handle = PrefetchHandle;
129    fn process_token(&self, token: Token, _line_number: u64) -> TokenSinkResult<PrefetchHandle> {
130        let tag = match token {
131            Token::TagToken(ref tag) => tag,
132            _ => return TokenSinkResult::Continue,
133        };
134        match (tag.kind, &tag.name) {
135            (TagKind::StartTag, &local_name!("script")) if self.prefetching.get() => {
136                if let Some(url) = self.get_url(tag, local_name!("src")) {
137                    debug!("Prefetch script {}", url);
138                    let cors_setting = self.get_cors_settings(tag, local_name!("crossorigin"));
139                    let integrity_metadata = self
140                        .get_attr(tag, local_name!("integrity"))
141                        .map(|attr| String::from(&attr.value))
142                        .unwrap_or_default();
143                    let cryptographic_nonce = self
144                        .get_attr(tag, local_name!("nonce"))
145                        .map(|attr| String::from(&attr.value))
146                        .unwrap_or_default();
147                    let request = script_fetch_request(
148                        self.webview_id,
149                        url,
150                        cors_setting,
151                        ScriptFetchOptions {
152                            referrer: self.referrer.clone(),
153                            referrer_policy: self.referrer_policy,
154                            integrity_metadata,
155                            cryptographic_nonce,
156                            credentials_mode: CredentialsMode::CredentialsSameOrigin,
157                            parser_metadata: ParserMetadata::ParserInserted,
158                        },
159                    )
160                    .insecure_requests_policy(self.insecure_requests_policy)
161                    .has_trustworthy_ancestor_origin(self.has_trustworthy_ancestor_origin)
162                    .policy_container(self.policy_container.clone())
163                    .client(self.request_client.clone())
164                    .origin(self.origin.clone())
165                    .pipeline_id(Some(self.pipeline_id));
166                    let _ = self
167                        .resource_threads
168                        .send(CoreResourceMsg::Fetch(request, FetchChannels::Prefetch));
169                }
170                TokenSinkResult::RawData(RawKind::ScriptData)
171            },
172            (TagKind::StartTag, &local_name!("img")) if self.prefetching.get() => {
173                if let Some(url) = self.get_url(tag, local_name!("src")) {
174                    debug!("Prefetch {} {}", tag.name, url);
175                    let request = create_a_potential_cors_request(
176                        Some(self.webview_id),
177                        url,
178                        Destination::Image,
179                        self.get_cors_settings(tag, local_name!("crossorigin")),
180                        None,
181                        self.referrer.clone(),
182                    )
183                    .insecure_requests_policy(self.insecure_requests_policy)
184                    .has_trustworthy_ancestor_origin(self.has_trustworthy_ancestor_origin)
185                    .policy_container(self.policy_container.clone())
186                    .client(self.request_client.clone())
187                    .origin(self.origin.clone())
188                    .pipeline_id(Some(self.pipeline_id))
189                    .referrer_policy(self.get_referrer_policy(tag, local_name!("referrerpolicy")));
190
191                    let _ = self
192                        .resource_threads
193                        .send(CoreResourceMsg::Fetch(request, FetchChannels::Prefetch));
194                }
195                TokenSinkResult::Continue
196            },
197            (TagKind::StartTag, &local_name!("link")) if self.prefetching.get() => {
198                if let Some(rel) = self.get_attr(tag, local_name!("rel")) {
199                    if rel.value.eq_ignore_ascii_case("stylesheet") {
200                        if let Some(url) = self.get_url(tag, local_name!("href")) {
201                            debug!("Prefetch {} {}", tag.name, url);
202                            let cors_setting =
203                                self.get_cors_settings(tag, local_name!("crossorigin"));
204                            let referrer_policy =
205                                self.get_referrer_policy(tag, local_name!("referrerpolicy"));
206                            let integrity_metadata = self
207                                .get_attr(tag, local_name!("integrity"))
208                                .map(|attr| String::from(&attr.value))
209                                .unwrap_or_default();
210
211                            // https://html.spec.whatwg.org/multipage/#default-fetch-and-process-the-linked-resource
212                            let request = create_a_potential_cors_request(
213                                Some(self.webview_id),
214                                url,
215                                Destination::Style,
216                                cors_setting,
217                                None,
218                                self.referrer.clone(),
219                            )
220                            .insecure_requests_policy(self.insecure_requests_policy)
221                            .has_trustworthy_ancestor_origin(self.has_trustworthy_ancestor_origin)
222                            .policy_container(self.policy_container.clone())
223                            .client(self.request_client.clone())
224                            .origin(self.origin.clone())
225                            .pipeline_id(Some(self.pipeline_id))
226                            .referrer_policy(referrer_policy)
227                            .integrity_metadata(integrity_metadata);
228
229                            let _ = self
230                                .resource_threads
231                                .send(CoreResourceMsg::Fetch(request, FetchChannels::Prefetch));
232                        }
233                    }
234                }
235                TokenSinkResult::Continue
236            },
237            (TagKind::StartTag, &local_name!("script")) => {
238                TokenSinkResult::RawData(RawKind::ScriptData)
239            },
240            (TagKind::EndTag, &local_name!("script")) => {
241                // After the first script tag, the main parser is blocked, so it's worth prefetching.
242                self.prefetching.set(true);
243                TokenSinkResult::Script(PrefetchHandle)
244            },
245            (TagKind::StartTag, &local_name!("base")) => {
246                if let Some(url) = self.get_url(tag, local_name!("href")) {
247                    if self.base_url.borrow().is_none() {
248                        debug!("Setting base {}", url);
249                        *self.base_url.borrow_mut() = Some(url);
250                    }
251                }
252                TokenSinkResult::Continue
253            },
254            _ => TokenSinkResult::Continue,
255        }
256    }
257}
258
259impl PrefetchSink {
260    fn get_attr<'a>(&'a self, tag: &'a Tag, name: LocalName) -> Option<&'a Attribute> {
261        tag.attrs.iter().find(|attr| attr.name.local == name)
262    }
263
264    fn get_url(&self, tag: &Tag, name: LocalName) -> Option<ServoUrl> {
265        let attr = self.get_attr(tag, name)?;
266        let base_url = self.base_url.borrow();
267        let base = base_url.as_ref().unwrap_or(&self.document_url);
268        ServoUrl::parse_with_base(Some(base), &attr.value).ok()
269    }
270
271    fn get_referrer_policy(&self, tag: &Tag, name: LocalName) -> ReferrerPolicy {
272        self.get_attr(tag, name)
273            .map(|attr| ReferrerPolicy::from(&*attr.value))
274            .unwrap_or(self.referrer_policy)
275    }
276
277    fn get_cors_settings(&self, tag: &Tag, name: LocalName) -> Option<CorsSettings> {
278        let attr = self.get_attr(tag, name)?;
279        determine_cors_settings_for_token(&attr.value)
280    }
281}
script/dom/servoparser/prefetch.rs

script/dom/servoparser/
prefetch.rs
