File: WebPageNavigationTests.swift

package info (click to toggle)
wpewebkit 2.50.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 438,176 kB
  • sloc: cpp: 3,776,128; javascript: 197,881; ansic: 156,930; python: 49,118; asm: 21,987; ruby: 18,540; perl: 16,723; xml: 4,623; yacc: 2,360; sh: 2,096; java: 2,019; lex: 1,327; pascal: 366; makefile: 90
file content (166 lines) | stat: -rw-r--r-- 6,522 bytes parent folder | download | duplicates (2)
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
// Copyright (C) 2025 Apple Inc. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
// BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.

#if ENABLE_SWIFTUI && canImport(Testing) && compiler(>=6.0)

import Testing
@_spi(Testing) import WebKit

private struct NeverLoadingSchemeHandler: URLSchemeHandler {
    // This force unwrap is safe because the scheme is a static String.
    // swift-format-ignore: NeverForceUnwrap
    @MainActor
    static let scheme = URLScheme("never-loading")!

    nonisolated func reply(for request: URLRequest) -> some AsyncSequence<URLSchemeTaskResult, any Error> {
        AsyncThrowingStream { _ in }
    }
}

@MainActor
struct WebPageNavigationTests {
    @Test
    func basicNavigationProducesExpectedNavigationEvents() async throws {
        let page = WebPage()

        let html = "<html><div>Hello</div></html>"
        let sequence = page.load(html: html)

        let expected: [WebPage.NavigationEvent] = [.startedProvisionalNavigation, .committed, .finished]
        let actual = try await Array(sequence)

        #expect(actual == expected)
    }

    @Test
    func failedNavigationProducesExpectedNavigationError() async throws {
        let page = WebPage()

        let sequence = page.load(URL(string: "about:foo"))

        var actual: [WebPage.NavigationEvent] = []
        let expected: [WebPage.NavigationEvent] = [.startedProvisionalNavigation]

        await #expect(throws: (any Error).self) {
            for try await event in sequence {
                actual.append(event)
            }
        }

        #expect(actual == expected)
    }

    @Test
    func explicitlyStopLoadingProgrammaticNavigation() async throws {
        var configuration = WebPage.Configuration()
        configuration.urlSchemeHandlers[NeverLoadingSchemeHandler.scheme] = NeverLoadingSchemeHandler()

        let page = WebPage(configuration: configuration)
        let sequence = page.load(URL(string: "never-loading:///index.html"))

        // FIXME: `#expect` should work here, but due to a Swift Testing issue causes the test to hang.
        do {
            for try await event in sequence where event == .startedProvisionalNavigation {
                page.stopLoading()
            }
            Issue.record("Stopping page load should trigger an error and therefore the loop should never finish.")
        } catch {
            #expect(error is WebPage.NavigationError)
        }
    }

    @Test
    func stopLoadingProgrammaticNavigationViaTaskCancellation() async throws {
        var configuration = WebPage.Configuration()
        configuration.urlSchemeHandlers[NeverLoadingSchemeHandler.scheme] = NeverLoadingSchemeHandler()
        let page = WebPage(configuration: configuration)

        let allNavigations = page.navigations
        let sequence = page.load(URL(string: "never-loading:///index.html"))

        var task: Task<Void, any Error>? = nil

        await withCheckedContinuation { continuation in
            task = Task {
                for try await event in sequence {
                    if event == .startedProvisionalNavigation {
                        continuation.resume()
                    } else {
                        Issue.record("No other event should occur since the load is indefinite.")
                    }
                }
            }
        }

        try #require(task).cancel()

        let expectedEvents: [WebPage.NavigationEvent] = [.startedProvisionalNavigation]
        var actualEvents: [WebPage.NavigationEvent] = []

        // FIXME: `#expect` should work here, but due to a Swift Testing issue causes the test to hang.
        do {
            for try await event in allNavigations {
                actualEvents.append(event)
            }
            Issue.record("The stream is indefinite and therefore should never reach here.")
        } catch {
            #expect(error is WebPage.NavigationError)
        }

        #expect(actualEvents == expectedEvents)
    }

    @Test
    func failedNavigationWithWebContentProcessTerminated() async throws {
        var configuration = WebPage.Configuration()
        configuration.urlSchemeHandlers[NeverLoadingSchemeHandler.scheme] = NeverLoadingSchemeHandler()

        let page = WebPage(configuration: configuration)
        let sequence = page.load(URL(string: "never-loading:///index.html"))

        // FIXME: `#expect` should work here, but a Swift Testing issue causes the test to hang.
        do {
            for try await event in sequence where event == .startedProvisionalNavigation {
                page.terminateWebContentProcess()
            }
            Issue.record("Terminating the web content process should trigger an error and therefore the loop should never finish.")
        } catch {
            #expect(error is WebPage.NavigationError)
        }
    }

    @Test
    func navigationProceedsAfterDiscardingNavigationStream() async throws {
        let page = WebPage()

        let html = "<title>A title</title>"
        page.load(html: html)

        // A timeout is used since observing the navigation sequence itself alters the outcome of this test.
        try await Task.sleep(for: .seconds(10))

        #expect(page.title == "A title")
    }
}

#endif // ENABLE_SWIFTUI && canImport(Testing) && compiler(>=6.0)