File: keep_alive_request_tracker.cc

package info (click to toggle)
chromium 138.0.7204.157-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,864 kB
  • sloc: cpp: 34,936,859; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,967; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (198 lines) | stat: -rw-r--r-- 7,343 bytes parent folder | download | duplicates (3)
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
// 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.

#include "chrome/browser/loader/keep_alive_request_tracker.h"

#include <stdint.h>

#include <string>

#include "base/memory/ptr_util.h"
#include "base/no_destructor.h"
#include "base/notreached.h"
#include "base/time/time.h"
#include "components/page_load_metrics/browser/features.h"
#include "components/page_load_metrics/browser/page_load_metrics_util.h"
#include "net/http/http_response_headers.h"
#include "services/metrics/public/cpp/metrics_utils.h"
#include "services/metrics/public/cpp/ukm_builders.h"
#include "services/metrics/public/cpp/ukm_recorder.h"
#include "services/network/public/cpp/resource_request.h"
#include "services/network/public/mojom/attribution.mojom.h"
#include "services/network/public/mojom/url_response_head.mojom.h"

namespace {

// The maximum number of redirects to be recorded without bucketing.
// This is unlikely to reach as the maximum is 20 per spec
// https://fetch.spec.whatwg.org/#http-redirect-fetch
constexpr size_t kMaxNonBucketedNumRedirects = 20;

ChromeKeepAliveRequestTracker::RequestType ComputeRequestType(
    const network::ResourceRequest& request) {
  switch (request.attribution_reporting_eligibility) {
    case network::mojom::AttributionReportingEligibility::kUnset:
    case network::mojom::AttributionReportingEligibility::kEmpty:
      break;
    case network::mojom::AttributionReportingEligibility::kEventSource:
    case network::mojom::AttributionReportingEligibility::kNavigationSource:
    case network::mojom::AttributionReportingEligibility::kTrigger:
    case network::mojom::AttributionReportingEligibility::kEventSourceOrTrigger:
      return ChromeKeepAliveRequestTracker::RequestType::kAttribution;
  }

  if (request.is_fetch_later_api) {
    return ChromeKeepAliveRequestTracker::RequestType::kFetchLater;
  }

  return ChromeKeepAliveRequestTracker::RequestType::kFetch;
}

}  // namespace

// static
std::unique_ptr<ChromeKeepAliveRequestTracker>
ChromeKeepAliveRequestTracker::MaybeCreateKeepAliveRequestTracker(
    const network::ResourceRequest& request,
    std::optional<ukm::SourceId> ukm_source_id,
    IsContextDetachedCallback is_context_detached_callback) {
  if (!request.keepalive || !request.keepalive_token.has_value()) {
    return nullptr;
  }

  if (!ukm_source_id.has_value()) {
    return nullptr;
  }

  if (!base::FeatureList::IsEnabled(
          page_load_metrics::features::kBeaconLeakageLogging)) {
    return nullptr;
  }

  auto category_id = page_load_metrics::GetCategoryIdFromUrl(request.url);
  if (!category_id.has_value()) {
    return nullptr;
  }

  ChromeKeepAliveRequestTracker::RequestType request_type =
      ComputeRequestType(request);

  return base::WrapUnique(new ChromeKeepAliveRequestTracker(
      request_type, *category_id, *ukm_source_id,
      std::move(is_context_detached_callback), *request.keepalive_token));
}

ChromeKeepAliveRequestTracker::ChromeKeepAliveRequestTracker(
    RequestType request_type,
    uint32_t request_category,
    ukm::SourceId ukm_source_id,
    IsContextDetachedCallback is_context_detached_callback,
    base::UnguessableToken keepalive_token)
    : KeepAliveRequestTracker(request_type),
      created_time_(base::TimeTicks::Now()),
      ukm_builder_(ukm_source_id),
      is_context_detached_callback_(std::move(is_context_detached_callback)) {
  ukm_builder_.SetId_Low(keepalive_token.GetLowForSerialization());
  ukm_builder_.SetId_High(keepalive_token.GetHighForSerialization());
  ukm_builder_.SetRequestType(static_cast<int64_t>(request_type));
  ukm_builder_.SetCategory(request_category);
}

ChromeKeepAliveRequestTracker::~ChromeKeepAliveRequestTracker() {
  // TODO(crbug.com/382527001): Logging in dtor might not work on Android.
  LogUkmEvent();
}

void ChromeKeepAliveRequestTracker::AddStageMetrics(const RequestStage& stage) {
  base::TimeDelta relative_to_created_time =
      base::TimeTicks::Now() - created_time_;

  switch (stage.type) {
    case RequestStageType::kLoaderCreated:
      // kLoaderCreated is the initial stage set in ctor.
      NOTREACHED();

    case RequestStageType::kRequestStarted:
      ukm_builder_.SetTimeDelta_RequestStarted(
          relative_to_created_time.InMilliseconds());
      break;

    case RequestStageType::kFirstRedirectReceived:
      IncreaseNumRedirects();
      ukm_builder_.SetTimeDelta_FirstRedirectReceived(
          relative_to_created_time.InMilliseconds());
      break;

    case RequestStageType::kSecondRedirectReceived:
      IncreaseNumRedirects();
      ukm_builder_.SetTimeDelta_SecondRedirectReceived(
          relative_to_created_time.InMilliseconds());
      break;

    case RequestStageType::kThirdOrLaterRedirectReceived:
      IncreaseNumRedirects();
      ukm_builder_.SetTimeDelta_ThirdOrLaterRedirectReceived(
          relative_to_created_time.InMilliseconds());
      break;

    case RequestStageType::kResponseReceived:
      ukm_builder_.SetTimeDelta_ResponseReceived(
          relative_to_created_time.InMilliseconds());
      break;

    case RequestStageType::kRequestFailed:
      ukm_builder_.SetTimeDelta_RequestFailed(
          relative_to_created_time.InMilliseconds());
      ukm_builder_.SetRequestFailed_ErrorCode(stage.status->error_code);
      ukm_builder_.SetRequestFailed_ExtendedErrorCode(
          stage.status->extended_error_code);
      break;

    case RequestStageType::kLoaderDisconnectedFromRenderer:
      ukm_builder_.SetTimeDelta_LoaderDisconnectedFromRenderer(
          relative_to_created_time.InMilliseconds());
      break;

    case RequestStageType::kRequestCancelledByRenderer:
      ukm_builder_.SetTimeDelta_RequestCancelledByRenderer(
          relative_to_created_time.InMilliseconds());
      break;

    case RequestStageType::kRequestCancelledAfterTimeLimit:
      ukm_builder_.SetTimeDelta_RequestCancelledAfterTimeLimit(
          relative_to_created_time.InMilliseconds());
      break;

    case RequestStageType::kBrowserShutdown:
      ukm_builder_.SetTimeDelta_BrowserShutdown(
          relative_to_created_time.InMilliseconds());
      break;

    case RequestStageType::kLoaderCompleted:
      ukm_builder_.SetTimeDelta_LoaderCompleted(
          relative_to_created_time.InMilliseconds());
      ukm_builder_.SetLoaderCompleted_ErrorCode(stage.status->error_code);
      ukm_builder_.SetLoaderCompleted_ExtendedErrorCode(
          stage.status->extended_error_code);
      break;
  }
}

void ChromeKeepAliveRequestTracker::LogUkmEvent() {
  ukm_builder_.SetEndStage(static_cast<int64_t>(GetCurrentStage().type));
  if (auto previous_stage = GetPreviousStage(); previous_stage.has_value()) {
    ukm_builder_.SetPreviousStage(static_cast<int64_t>(previous_stage->type));
  }
  uint32_t num_redirects = GetNumRedirects();
  ukm_builder_.SetNumRedirects(
      num_redirects <= kMaxNonBucketedNumRedirects
          ? num_redirects
          : ukm::GetExponentialBucketMinForCounts1000(num_redirects));
  ukm_builder_.SetIsContextDetached(is_context_detached_callback_.Run());
  ukm_builder_.SetTimeDelta_EventLogged(
      (base::TimeTicks::Now() - created_time_).InMilliseconds());

  auto* ukm_recorder = ukm::UkmRecorder::Get();
  ukm_builder_.Record(ukm_recorder->Get());
}