File: javascript_frameworks_ukm_observer.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (170 lines) | stat: -rw-r--r-- 6,924 bytes parent folder | download | duplicates (7)
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
// Copyright 2020 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/page_load_metrics/observers/javascript_frameworks_ukm_observer.h"

#include "base/feature_list.h"
#include "services/metrics/public/cpp/ukm_builders.h"
#include "services/metrics/public/cpp/ukm_recorder.h"
#include "third_party/blink/public/common/features.h"
#include "third_party/blink/public/common/loader/loading_behavior_flag.h"
#include "third_party/blink/public/mojom/loader/javascript_framework_detection.mojom-forward.h"

JavascriptFrameworksUkmObserver::JavascriptFrameworksUkmObserver() = default;

JavascriptFrameworksUkmObserver::~JavascriptFrameworksUkmObserver() = default;

page_load_metrics::PageLoadMetricsObserver::ObservePolicy
JavascriptFrameworksUkmObserver::OnFencedFramesStart(
    content::NavigationHandle* navigation_handle,
    const GURL& currently_committed_url) {
  // OnLoadingBehaviorObserved events for detecting JavaScript frameworks are
  // only kicked for outermost frames. See DetectJavascriptFrameworksOnLoad in
  // third_party/blink/renderer/core/script/detect_javascript_frameworks.cc
  return STOP_OBSERVING;
}

page_load_metrics::PageLoadMetricsObserver::ObservePolicy
JavascriptFrameworksUkmObserver::OnPrerenderStart(
    content::NavigationHandle* navigation_handle,
    const GURL& currently_committed_url) {
  // Metrics should be collected for Prerendered frames but only recorded after
  // the page has been displayed.
  is_in_prerendered_page_ = true;
  return CONTINUE_OBSERVING;
}

void JavascriptFrameworksUkmObserver::OnJavaScriptFrameworksObserved(
    content::RenderFrameHost* rfh,
    const blink::JavaScriptFrameworkDetectionResult& result) {
  framework_detection_result_ = result;
}

void JavascriptFrameworksUkmObserver::OnComplete(
    const page_load_metrics::mojom::PageLoadTiming&) {
  if (is_in_prerendered_page_)
    return;

  RecordJavascriptFrameworkPageLoad();
}

JavascriptFrameworksUkmObserver::ObservePolicy
JavascriptFrameworksUkmObserver::FlushMetricsOnAppEnterBackground(
    const page_load_metrics::mojom::PageLoadTiming&) {
  if (is_in_prerendered_page_)
    return CONTINUE_OBSERVING;

  RecordJavascriptFrameworkPageLoad();
  return STOP_OBSERVING;
}

void JavascriptFrameworksUkmObserver::RecordJavascriptFrameworkPageLoad() {
  ukm::builders::JavascriptFrameworkPageLoad detect_framework_builder(
      GetDelegate().GetPageUkmSourceId());

  ukm::builders::ContentManagementSystemPageLoad detect_cms_builder(
      GetDelegate().GetPageUkmSourceId());

  using blink::mojom::JavaScriptFramework;

  auto is_detected = [&](JavaScriptFramework framework) -> bool {
    return framework_detection_result_.detected_versions.contains(framework);
  };

  detect_framework_builder
      .SetAngularPageLoad(is_detected(JavaScriptFramework::kAngular))
      .SetGatsbyPageLoad(is_detected(JavaScriptFramework::kGatsby))
      .SetNextJSPageLoad(is_detected(JavaScriptFramework::kNext))
      .SetNuxtJSPageLoad(is_detected(JavaScriptFramework::kNuxt))
      .SetPreactPageLoad(is_detected(JavaScriptFramework::kPreact))
      .SetReactPageLoad(is_detected(JavaScriptFramework::kReact))
      .SetSapperPageLoad(is_detected(JavaScriptFramework::kSapper))
      .SetSveltePageLoad(is_detected(JavaScriptFramework::kSvelte))
      .SetVuePageLoad(is_detected(JavaScriptFramework::kVue))
      .SetVuePressPageLoad(is_detected(JavaScriptFramework::kVuePress));

  detect_framework_builder.Record(ukm::UkmRecorder::Get());

  detect_cms_builder
      .SetDrupalPageLoad(is_detected(JavaScriptFramework::kDrupal))
      .SetJoomlaPageLoad(is_detected(JavaScriptFramework::kJoomla))
      .SetShopifyPageLoad(is_detected(JavaScriptFramework::kShopify))
      .SetSquarespacePageLoad(is_detected(JavaScriptFramework::kSquarespace))
      .SetWixPageLoad(is_detected(JavaScriptFramework::kWix))
      .SetWordPressPageLoad(is_detected(JavaScriptFramework::kWordPress));

  detect_cms_builder.Record(ukm::UkmRecorder::Get());

  ukm::builders::Blink_JavaScriptFramework_Versions versions_builder_jsf(
      GetDelegate().GetPageUkmSourceId());

  typedef ukm::builders::Blink_JavaScriptFramework_Versions& (
      ukm::builders::Blink_JavaScriptFramework_Versions::*
          JavaScriptFrameworkValueSetter)(int64_t);

  ukm::builders::Blink_ContentManagementSystem_Versions versions_builder_cms(
      GetDelegate().GetPageUkmSourceId());

  typedef ukm::builders::Blink_ContentManagementSystem_Versions& (
      ukm::builders::Blink_ContentManagementSystem_Versions::*
          ContentManagementSystemValueSetter)(int64_t);

  auto detect_jsf_version = [&](JavaScriptFramework framework,
                                JavaScriptFrameworkValueSetter setter) {
    auto version =
        framework_detection_result_.detected_versions.find(framework);
    if (version == framework_detection_result_.detected_versions.end() ||
        version->second == blink::kNoFrameworkVersionDetected) {
      return false;
    }

    (versions_builder_jsf.*setter)(version->second);
    return true;
  };

  auto detect_cms_version = [&](JavaScriptFramework framework,
                                ContentManagementSystemValueSetter setter) {
    auto version =
        framework_detection_result_.detected_versions.find(framework);
    if (version == framework_detection_result_.detected_versions.end() ||
        version->second == blink::kNoFrameworkVersionDetected) {
      return false;
    }

    (versions_builder_cms.*setter)(version->second);
    return true;
  };

  if (detect_jsf_version(JavaScriptFramework::kAngular,
                         &ukm::builders::Blink_JavaScriptFramework_Versions::
                             SetAngularVersion) ||
      detect_jsf_version(JavaScriptFramework::kNext,
                         &ukm::builders::Blink_JavaScriptFramework_Versions::
                             SetNextJSVersion) ||
      detect_jsf_version(
          JavaScriptFramework::kNuxt,
          &ukm::builders::Blink_JavaScriptFramework_Versions::SetNuxtVersion) ||
      detect_jsf_version(
          JavaScriptFramework::kVue,
          &ukm::builders::Blink_JavaScriptFramework_Versions::SetVueVersion)) {
    versions_builder_jsf.Record(ukm::UkmRecorder::Get());
  }

  if (detect_cms_version(
          JavaScriptFramework::kDrupal,
          &ukm::builders::Blink_ContentManagementSystem_Versions::
              SetDrupalVersion) ||
      detect_cms_version(
          JavaScriptFramework::kWordPress,
          &ukm::builders::Blink_ContentManagementSystem_Versions::
              SetWordPressVersion)) {
    versions_builder_cms.Record(ukm::UkmRecorder::Get());
  }
}

void JavascriptFrameworksUkmObserver::DidActivatePrerenderedPage(
    content::NavigationHandle* navigation_handle) {
  DCHECK(is_in_prerendered_page_);
  is_in_prerendered_page_ = false;
}