servo 0.1.0

A component of the servo web-engine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255

/* 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/. */

//! [`UserContentManager`] API unit tests.
mod common;

use std::cell::RefCell;
use std::rc::Rc;

use net::test_util::{make_body, make_server};
use servo::user_contents::UserStyleSheet;
use servo::{
    CreateNewWebViewRequest, JSValue, LoadStatus, RenderingContext, Servo, UserContentManager,
    UserScript, WebView, WebViewBuilder, WebViewDelegate,
};
use url::Url;

use crate::common::{ServoTest, evaluate_javascript};

#[test]
fn test_user_content_manager_empty() {
    let servo_test = ServoTest::new();
    let user_content_manager = UserContentManager::new(servo_test.servo());
    let webview = WebViewBuilder::new(servo_test.servo(), servo_test.rendering_context.clone())
        .user_content_manager(Rc::new(user_content_manager))
        .url(Url::parse("data:text/html,Hello World").unwrap())
        .build();

    let result = evaluate_javascript(&servo_test, webview.clone(), "window.fromUserContentScript");
    assert_eq!(result, Ok(JSValue::Undefined));
}

#[test]
fn test_user_content_manager_user_script() {
    let servo_test = ServoTest::new();

    // Use a http server instead of a data url to allow the `webview.reload()` call below to reuse
    // the exisitng script thread. This is necessary to test that mutations on a `UserContentManager`
    // take effect on script threads created before the mutation.
    let (_, url) = make_server(move |_, response| {
        *response.body_mut() = make_body(b"<!DOCTYPE html>\nHello".to_vec());
    });

    let user_content_manager = Rc::new(UserContentManager::new(servo_test.servo()));
    user_content_manager.add_script(Rc::new("window.fromUserContentScript = 42;".into()));

    let webview = WebViewBuilder::new(servo_test.servo(), servo_test.rendering_context.clone())
        .user_content_manager(user_content_manager.clone())
        .url(url.into_url())
        .build();

    let result = evaluate_javascript(&servo_test, webview.clone(), "window.fromUserContentScript");
    assert_eq!(result, Ok(JSValue::Number(42.0)));

    // Add a second user script to the `UserContentManager`.
    let second_user_script = Rc::new(UserScript::from("window.fromSecondUserContentScript = 32;"));
    user_content_manager.add_script(second_user_script.clone());

    // The second user script must immediately take effect in any new WebViews.
    let new_webview = WebViewBuilder::new(servo_test.servo(), servo_test.rendering_context.clone())
        .user_content_manager(user_content_manager.clone())
        .url(Url::parse("data:text/html,<!DOCTYPE html>").unwrap())
        .build();

    let result = evaluate_javascript(
        &servo_test,
        new_webview,
        "window.fromSecondUserContentScript",
    );
    assert_eq!(result, Ok(JSValue::Number(32.0)));

    // The existing page in the first webview must not be affected since we haven't reloaded yet.
    let result = evaluate_javascript(
        &servo_test,
        webview.clone(),
        "window.fromSecondUserContentScript",
    );
    assert_eq!(result, Ok(JSValue::Undefined));

    // Now trigger a reload and ensure the second user script has effect on the page.
    webview.reload();

    let result = evaluate_javascript(
        &servo_test,
        webview.clone(),
        "window.fromSecondUserContentScript",
    );

    assert_eq!(result, Ok(JSValue::Number(32.0)));

    // Test that removing the user script works. Trigger a reload and ensure the second user script
    // no longer has effect on the page.
    user_content_manager.remove_script(second_user_script);
    webview.reload();

    let result = evaluate_javascript(&servo_test, webview, "window.fromSecondUserContentScript");

    assert_eq!(result, Ok(JSValue::Undefined));
}

#[test]
fn test_user_content_manager_for_auxiliary_webviews() {
    let servo_test = ServoTest::new();
    struct WebViewAuxiliaryTestDelegate {
        servo: Servo,
        rendering_context: Rc<dyn RenderingContext>,
        auxiliary_webview: RefCell<Option<WebView>>,
    }

    impl WebViewDelegate for WebViewAuxiliaryTestDelegate {
        fn request_create_new(&self, _parent_webview: WebView, request: CreateNewWebViewRequest) {
            let user_content_manager_for_auxiliary_webview = UserContentManager::new(&self.servo);
            // Add a different user script to the `UserContentManager` of auxiliary webview.
            user_content_manager_for_auxiliary_webview.add_script(Rc::new(
                "window.fromAuxiliaryUserContentScript = 32;".into(),
            ));
            let auxiliary_webview = request
                .builder(self.rendering_context.clone())
                .user_content_manager(Rc::new(user_content_manager_for_auxiliary_webview))
                .build();
            self.auxiliary_webview
                .borrow_mut()
                .replace(auxiliary_webview.clone());
        }
    }

    let delegate = Rc::new(WebViewAuxiliaryTestDelegate {
        servo: servo_test.servo.clone(),
        rendering_context: servo_test.rendering_context.clone(),
        auxiliary_webview: RefCell::new(None),
    });

    let user_content_manager = UserContentManager::new(servo_test.servo());
    user_content_manager.add_script(Rc::new("window.fromUserContentScript = 42;".into()));

    let webview = WebViewBuilder::new(servo_test.servo(), servo_test.rendering_context.clone())
        .delegate(delegate.clone())
        .user_content_manager(Rc::new(user_content_manager))
        .url(
            Url::parse(
                "data:text/html,<!DOCTYPE html>\
                <script>\
                    onload = () => window.open('data:text/html,<title>Auxiliary WebView</title>')\
                </script>",
            )
            .unwrap(),
        )
        .build();

    let load_webview = webview.clone();
    let delegate_clone = delegate.clone();
    let _ = servo_test.spin(move || {
        load_webview.load_status() != LoadStatus::Complete ||
            delegate_clone
                .auxiliary_webview
                .borrow()
                .as_ref()
                .is_none_or(|auxiliary_webview| {
                    auxiliary_webview.page_title() != Some("Auxiliary WebView".into())
                })
    });

    let result = evaluate_javascript(
        &servo_test,
        webview.clone(),
        "[ window.fromUserContentScript, window.fromAuxiliaryUserContentScript ]",
    );
    assert_eq!(
        result,
        Ok(JSValue::Array(vec![
            JSValue::Number(42.0),
            JSValue::Undefined
        ]))
    );

    let auxiliary_webview = delegate
        .auxiliary_webview
        .borrow_mut()
        .take()
        .expect("Gauranteed by spin");

    let result = evaluate_javascript(
        &servo_test,
        auxiliary_webview.clone(),
        "[ window.fromUserContentScript, window.fromAuxiliaryUserContentScript ]",
    );

    assert_eq!(
        result,
        Ok(JSValue::Array(vec![
            JSValue::Undefined,
            JSValue::Number(32.0),
        ]))
    );
}

#[test]
fn test_user_content_manager_for_user_stylesheets() {
    let servo_test = ServoTest::new();

    let user_content_manager = Rc::new(UserContentManager::new(servo_test.servo()));

    #[cfg(not(target_os = "windows"))]
    let url = Url::from_file_path("/test/test.css").unwrap();
    #[cfg(target_os = "windows")]
    let url = Url::from_file_path("C:\\test\\test.css").unwrap();

    let user_stylesheet = Rc::new(UserStyleSheet::new(
        "div { width: 100px; height: 50px }\
        p { width: 200px; height: 200px }"
            .into(),
        url,
    ));
    user_content_manager.add_stylesheet(user_stylesheet.clone());

    let webview = WebViewBuilder::new(servo_test.servo(), servo_test.rendering_context.clone())
        .user_content_manager(user_content_manager.clone())
        .url(
            Url::parse(
                "data:text/html,<!DOCTYPE html>\
                        <style>p { width: 300px; height: 300px }</style>\
                        <div id='div1'></div><p id='p1'>test paragraph</p>",
            )
            .unwrap(),
        )
        .build();

    let result = evaluate_javascript(
        &servo_test,
        webview.clone(),
        "[ div1.offsetWidth, div1.offsetHeight, p1.offsetWidth, p1.offsetHeight ]",
    );
    assert_eq!(
        result,
        Ok(JSValue::Array(vec![
            // `div` elements uses the rules from the user stylesheet since the author stylesheet doesn't
            // have any rules that match `div`s.
            JSValue::Number(100.0),
            JSValue::Number(50.0),
            // `p` element uses the rules from author stylesheet as they have precendece over user
            // rules from user stylesheets.
            JSValue::Number(300.0),
            JSValue::Number(300.0),
        ]))
    );

    // Test that removing the stylesheet works.
    user_content_manager.remove_stylesheet(user_stylesheet);
    webview.reload();

    let result = evaluate_javascript(&servo_test, webview.clone(), "div1.offsetHeight");

    assert_eq!(result, Ok(JSValue::Number(0.0)));
}