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
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_LOADER_KEEP_ALIVE_REQUEST_BROWSERTEST_UTIL_H_
#define CONTENT_BROWSER_LOADER_KEEP_ALIVE_REQUEST_BROWSERTEST_UTIL_H_
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "content/browser/loader/keep_alive_url_loader.h"
#include "content/public/test/content_browser_test.h"
#include "content/public/test/keep_alive_url_loader_utils.h"
#include "net/test/embedded_test_server/embedded_test_server.h"
#include "url/gurl.h"
namespace net::test_server {
class ControllableHttpResponse;
} // namespace net::test_server
namespace content {
class WebContentsImpl;
class RenderFrameHostImpl;
// `KeepAliveRequestBrowserTestBase` is a base class for performing fetch
// keep-alive request content browser tests.
class KeepAliveRequestBrowserTestBase : public ContentBrowserTest {
protected:
using FeaturesType = std::vector<base::test::FeatureRefAndParams>;
using DisabledFeaturesType = std::vector<base::test::FeatureRef>;
static constexpr char kPrimaryHost[] = "a.test";
static constexpr char kSecondaryHost[] = "b.test";
static constexpr char kAllowedCspHost[] = "csp.test";
static constexpr char kKeepAliveEndpoint[] = "/beacon";
static constexpr char kBeaconId[] = "beacon01";
static constexpr char k200TextResponse[] =
"HTTP/1.1 200 OK\r\n"
"Content-Type: text/html; charset=utf-8\r\n"
"\r\n"
"Acked!";
static constexpr char k301Response[] =
"HTTP/1.1 301 Moved Permanently\r\n"
"Location: %s\r\n"
"\r\n";
KeepAliveRequestBrowserTestBase();
~KeepAliveRequestBrowserTestBase() override;
// Not Copyable.
KeepAliveRequestBrowserTestBase(const KeepAliveRequestBrowserTestBase&) =
delete;
KeepAliveRequestBrowserTestBase& operator=(
const KeepAliveRequestBrowserTestBase&) = delete;
void SetUp() override;
virtual const FeaturesType& GetEnabledFeatures() = 0;
virtual const DisabledFeaturesType& GetDisabledFeatures();
void SetUpOnMainThread() override;
void TearDownOnMainThread() override;
// Returns a keepalive endpoint with the given `id`.
static std::string GetKeepAliveEndpoint(
std::optional<std::string> id = std::nullopt);
// Encodes the given `url` using the JS method encodeURIComponent.
static std::string EncodeURL(const GURL& url);
protected:
[[nodiscard]] std::vector<
std::unique_ptr<net::test_server::ControllableHttpResponse>>
RegisterRequestHandlers(const std::vector<std::string>& relative_urls);
// Returns a cross-origin (kSecondaryHost) URL that causes the following
// redirect chain:
// http(s)://b.test:<port>/no-cors-server-redirect-307?...
// --> http(s)://b.test:<port>/server-redirect-307?...
// --> http(s)://b.test:<port>/no-cors-server-redirect-307?...
// --> `target_url
GURL GetCrossOriginMultipleRedirectsURL(const GURL& target_url) const;
// Returns a same-origin (kPrimaryHost) URL that causes the following
// redirect chain:
// http(s)://a.test:<port>/server-redirect-307?...
// --> http(s)://a.test:<port>/no-cors-server-redirect-307?...
// --> `target_url`
GURL GetSameOriginMultipleRedirectsURL(const GURL& target_url) const;
// Returns a same-origin (kPrimaryHost) URL that leads to cross-origin
// redirect chain:
// http(s)://a.test:<port>/server-redirect-307?...
// --> http(s)://b.test:<port>/no-cors-server-redirect-307?...
// --> `target_url`
GURL GetSameAndCrossOriginRedirectsURL(const GURL& target_url) const;
// Returns a same-origin (kPrimaryHost) URL that redirects to `target_url`:
// http(s)://a.test:<port>/server-redirect-307?...
// --> `target_url`
GURL GetSameOriginRedirectURL(const GURL& target_url) const;
using FetchKeepAliveRequestMetricType =
KeepAliveURLLoader::FetchKeepAliveRequestMetricType;
// Note: `renderer` is made optional to support the use cases where its
// loggings happen after unloading a renderer, as the browser process might
// not be able to fetch UMA logged by renderer in time before the latter is
// shutting down, as described in https://crbug.com/40109064.
// It should be made required once the bug is resolved.
struct ExpectedRequestHistogram {
int browser = 0;
std::optional<int> renderer = std::nullopt;
};
using ExpectedTotalRequests = ExpectedRequestHistogram;
using ExpectedStartedRequests = ExpectedRequestHistogram;
using ExpectedSucceededRequests = ExpectedRequestHistogram;
using ExpectedFailedRequests = ExpectedRequestHistogram;
// A helper to assert on the number of UMA logged from both browser and
// renderer processes.
void ExpectFetchKeepAliveHistogram(
const FetchKeepAliveRequestMetricType& expected_sample,
const ExpectedTotalRequests& total,
const ExpectedStartedRequests& started_count,
const ExpectedSucceededRequests& succeeded_count,
const ExpectedFailedRequests& failed_count,
size_t retried_count = 0);
void DisableBackForwardCache(WebContents* web_contents);
void SetUseHttps();
WebContentsImpl* web_contents() const;
RenderFrameHostImpl* current_frame_host();
KeepAliveURLLoaderService* loader_service();
KeepAliveURLLoadersTestObserver& loaders_observer();
net::EmbeddedTestServer* server();
const net::EmbeddedTestServer* server() const;
const base::HistogramTester& histogram_tester();
private:
base::test::ScopedFeatureList feature_list_;
std::unique_ptr<KeepAliveURLLoadersTestObserver> loaders_observer_;
bool use_https_ = false;
const std::unique_ptr<net::EmbeddedTestServer> https_test_server_;
std::unique_ptr<base::HistogramTester> histogram_tester_;
};
} // namespace content
#endif // CONTENT_BROWSER_LOADER_KEEP_ALIVE_REQUEST_BROWSERTEST_UTIL_H_
|
