File: LoadableSpeculationRules.cpp

package info (click to toggle)
webkit2gtk 2.51.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 455,340 kB
  • sloc: cpp: 3,865,253; javascript: 197,710; ansic: 165,177; python: 49,241; asm: 21,868; ruby: 18,095; perl: 16,926; xml: 4,623; sh: 2,409; yacc: 2,356; java: 2,019; lex: 1,330; pascal: 372; makefile: 210
file content (147 lines) | stat: -rw-r--r-- 6,129 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
/*
 * Copyright (C) 2025 Shopify 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. ``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
 * 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.
 */

#include "config.h"
#include "LoadableSpeculationRules.h"

#include "CachedResourceLoader.h"
#include "CachedResourceRequest.h"
#include "CachedScript.h"
#include "CrossOriginAccessControl.h"
#include "Document.h"
#include "DocumentInlines.h"
#include "DocumentResourceLoader.h"
#include "FrameDestructionObserverInlines.h"
#include "LocalFrame.h"
#include "ResourceRequest.h"
#include "ScriptController.h"
#include "ScriptSourceCode.h"

#include <wtf/text/MakeString.h>
#include <wtf/text/StringConcatenate.h>

namespace WebCore {

Ref<LoadableSpeculationRules> LoadableSpeculationRules::create(Document& document, const URL& url)
{
    return adoptRef(*new LoadableSpeculationRules(document, url));
}

LoadableSpeculationRules::LoadableSpeculationRules(Document& document, const URL& url)
    : m_document(document)
    , m_url(url)
{
}

LoadableSpeculationRules::~LoadableSpeculationRules()
{
    if (m_cachedScript)
        m_cachedScript->removeClient(*this);
}

CachedResourceHandle<CachedScript> LoadableSpeculationRules::requestSpeculationRules(Document& document, const URL& sourceURL)
{
    // https://html.spec.whatwg.org/C#the-speculation-rules-header
    // 3.4.2.2.1. Let request be a new request whose URL is url, destination is "speculationrules", and mode is "cors".
    if (!document.settings().isScriptEnabled())
        return nullptr;

    ResourceLoaderOptions options = CachedResourceLoader::defaultCachedResourceOptions();
    options.contentSecurityPolicyImposition = ContentSecurityPolicyImposition::DoPolicyCheck;
    options.sameOriginDataURLFlag = SameOriginDataURLFlag::Set;
    options.serviceWorkersMode = ServiceWorkersMode::All;
    options.integrity = ""_s;
    options.referrerPolicy = ReferrerPolicy::EmptyString;
    options.fetchPriority = RequestPriority::Auto;
    options.destination = FetchOptionsDestination::Speculationrules;

    auto request = createPotentialAccessControlRequest(URL { sourceURL }, WTFMove(options), document, ""_s);
    request.upgradeInsecureRequestIfNeeded(document);
    request.setPriority(ResourceLoadPriority::Low);

    return document.protectedCachedResourceLoader()->requestScript(WTFMove(request)).value_or(nullptr);
}

bool LoadableSpeculationRules::load(Document& document, const URL& url)
{
    ASSERT(!m_cachedScript);

    if (!url.isValid())
        return false;

    CachedResourceHandle cachedScript = requestSpeculationRules(document, m_url);
    m_cachedScript = cachedScript;
    if (!cachedScript)
        return false;
    cachedScript->addClient(*this);

    return true;
}

// https://html.spec.whatwg.org/C#the-speculation-rules-header
// 3.4.2.2. processResponseConsumeBody
void LoadableSpeculationRules::notifyFinished(CachedResource& resource, const NetworkLoadMetrics&, LoadWillContinueInAnotherProcess)
{
    ASSERT(&resource == m_cachedScript.get());

    RefPtr document = m_document.get();
    if (!document)
        return;

    // 1. If bodyBytes is null or failure, then abort these steps.
    // 2. If response's status is not an ok status, then abort these steps.
    if (m_cachedScript->errorOccurred()) {
        document->addConsoleMessage(MessageSource::Other, MessageLevel::Error, makeString("Failed to load speculation rules from "_s, m_url.string()));
        return;
    }

    // 3. If the result of extracting a MIME type from response's header list does not have an essence of "application/speculationrules+json", then abort these steps.
    if (resource.mimeType() != "application/speculationrules+json") {
        document->addConsoleMessage(MessageSource::Other, MessageLevel::Error, makeString("Invalid speculation rules MIME type "_s, m_url.string()));
        return;
    }

    // 4. Let bodyText be the result of UTF-8 decoding bodyBytes.
    if (resource.encoding() != "UTF-8"_s) {
        document->addConsoleMessage(MessageSource::Other, MessageLevel::Error, makeString("Invalid speculation rules encoding "_s, m_url.string()));
        return;
    }

    String speculationRulesText = m_cachedScript->script().toString();
    if (speculationRulesText.isEmpty())
        return;

    if (RefPtr frame = document->frame()) {
        ScriptSourceCode sourceCode(speculationRulesText, JSC::SourceTaintedOrigin::Untainted, URL(m_url), TextPosition(), JSC::SourceProviderSourceType::Program);
        // 5. Let ruleSet be the result of parsing a speculation rule set string given bodyText, document, and response's URL. If this throws an exception, then abort these steps.
        // 6. Append ruleSet to document's speculation rule sets.
        if (frame->checkedScript()->registerSpeculationRules(sourceCode, m_url)) {
            // 7. Consider speculative loads for document.
            document->considerSpeculationRules();
        }
    }
}

} // namespace WebCore