| // Copyright 2012 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/renderer/loadtimes_extension_bindings.h" |
| |
| #include "base/time/time.h" |
| #include "extensions/renderer/v8_helpers.h" |
| #include "net/http/http_connection_info.h" |
| #include "third_party/blink/public/platform/web_url_response.h" |
| #include "third_party/blink/public/web/web_local_frame.h" |
| #include "third_party/blink/public/web/web_navigation_type.h" |
| #include "third_party/blink/public/web/web_performance_metrics_for_reporting.h" |
| #include "v8/include/v8-extension.h" |
| #include "v8/include/v8-isolate.h" |
| #include "v8/include/v8-object.h" |
| #include "v8/include/v8-primitive.h" |
| #include "v8/include/v8-template.h" |
| |
| using blink::WebDocumentLoader; |
| using blink::WebLocalFrame; |
| using blink::WebNavigationType; |
| |
| // Values for CSI "tran" property |
| const int kTransitionLink = 0; |
| const int kTransitionForwardBack = 6; |
| const int kTransitionOther = 15; |
| const int kTransitionReload = 16; |
| |
| namespace extensions_v8 { |
| |
| static const char* const kLoadTimesExtensionName = "v8/LoadTimes"; |
| |
| class LoadTimesExtensionWrapper : public v8::Extension { |
| public: |
| // Creates an extension which adds a new function, chrome.loadTimes() |
| // This function returns an object containing the following members: |
| // requestTime: The time the request to load the page was received |
| // loadTime: The time the renderer started the load process |
| // finishDocumentLoadTime: The time the document itself was loaded |
| // (this is before the onload() method is fired) |
| // finishLoadTime: The time all loading is done, after the onload() |
| // method and all resources |
| // navigationType: A string describing what user action initiated the load |
| // |
| // Note that chrome.loadTimes() is deprecated in favor of performance.timing. |
| // Many of the timings reported via chrome.loadTimes() match timings available |
| // in performance.timing. Timing data will be removed from chrome.loadTimes() |
| // in a future release. No new timings or other information should be exposed |
| // via these APIs. |
| LoadTimesExtensionWrapper() : |
| v8::Extension(kLoadTimesExtensionName, |
| "var chrome;" |
| "if (!chrome)" |
| " chrome = {};" |
| "chrome.loadTimes = function() {" |
| " native function GetLoadTimes();" |
| " return GetLoadTimes();" |
| "};" |
| "chrome.csi = function() {" |
| " native function GetCSI();" |
| " return GetCSI();" |
| "}") {} |
| |
| v8::Local<v8::FunctionTemplate> GetNativeFunctionTemplate( |
| v8::Isolate* isolate, |
| v8::Local<v8::String> name) override { |
| if (name->StringEquals( |
| v8::String::NewFromUtf8(isolate, "GetLoadTimes", |
| v8::NewStringType::kInternalized) |
| .ToLocalChecked())) { |
| return v8::FunctionTemplate::New(isolate, GetLoadTimes); |
| } else if (name->StringEquals( |
| v8::String::NewFromUtf8(isolate, "GetCSI", |
| v8::NewStringType::kInternalized) |
| .ToLocalChecked())) { |
| return v8::FunctionTemplate::New(isolate, GetCSI); |
| } |
| return v8::Local<v8::FunctionTemplate>(); |
| } |
| |
| static constexpr std::string_view GetNavigationType( |
| WebNavigationType nav_type) { |
| switch (nav_type) { |
| case blink::kWebNavigationTypeLinkClicked: |
| return "LinkClicked"; |
| case blink::kWebNavigationTypeFormSubmitted: |
| return "FormSubmitted"; |
| case blink::kWebNavigationTypeBackForward: |
| case blink::kWebNavigationTypeRestore: |
| return "BackForward"; |
| case blink::kWebNavigationTypeReload: |
| return "Reload"; |
| case blink::kWebNavigationTypeFormResubmittedBackForward: |
| case blink::kWebNavigationTypeFormResubmittedReload: |
| return "Resubmitted"; |
| case blink::kWebNavigationTypeOther: |
| return "Other"; |
| } |
| return ""; |
| } |
| |
| static int GetCSITransitionType(WebNavigationType nav_type) { |
| switch (nav_type) { |
| case blink::kWebNavigationTypeLinkClicked: |
| case blink::kWebNavigationTypeFormSubmitted: |
| case blink::kWebNavigationTypeFormResubmittedBackForward: |
| case blink::kWebNavigationTypeFormResubmittedReload: |
| return kTransitionLink; |
| case blink::kWebNavigationTypeBackForward: |
| case blink::kWebNavigationTypeRestore: |
| return kTransitionForwardBack; |
| case blink::kWebNavigationTypeReload: |
| return kTransitionReload; |
| case blink::kWebNavigationTypeOther: |
| return kTransitionOther; |
| } |
| return kTransitionOther; |
| } |
| |
| static void EmptySetter(v8::Local<v8::Name> name, |
| v8::Local<v8::Value> value, |
| const v8::PropertyCallbackInfo<void>& info) { |
| // Empty setter is required to keep the native data property in "accessor" |
| // state even in case the value is updated by user code. |
| } |
| |
| static void LoadtimesGetter( |
| v8::Local<v8::Name> name, |
| const v8::PropertyCallbackInfo<v8::Value>& info) { |
| if (WebLocalFrame* frame = WebLocalFrame::FrameForCurrentContext()) { |
| frame->UsageCountChromeLoadTimes(blink::WebString::FromUTF8( |
| *v8::String::Utf8Value(info.GetIsolate(), name))); |
| } |
| info.GetReturnValue().Set(info.Data()); |
| } |
| |
| static void GetLoadTimes(const v8::FunctionCallbackInfo<v8::Value>& args) { |
| args.GetReturnValue().SetNull(); |
| WebLocalFrame* frame = WebLocalFrame::FrameForCurrentContext(); |
| if (!frame) { |
| return; |
| } |
| WebDocumentLoader* document_loader = frame->GetDocumentLoader(); |
| if (!document_loader) { |
| return; |
| } |
| const blink::WebURLResponse& response = document_loader->GetWebResponse(); |
| blink::WebPerformanceMetricsForReporting web_performance = |
| frame->PerformanceMetricsForReporting(); |
| // Though request time now tends to be used to describe the time that the |
| // request for the main resource was issued, when chrome.loadTimes() was |
| // added, it was used to describe 'The time the request to load the page was |
| // received', which is the time now known as navigation start. For backward |
| // compatibility, we continue to provide request_time, setting its value to |
| // navigation start. |
| double request_time = web_performance.NavigationStart(); |
| // Developers often use start_load_time as the time the navigation was |
| // started, so we return navigationStart for this value as well. See |
| // https://gist.github.com/search?utf8=%E2%9C%93&q=startLoadTime. |
| // Note that, historically, start_load_time reported the time that a |
| // provisional load was first processed in the render process. For |
| // browser-initiated navigations, this is some time after navigation start, |
| // which means that developers who used this value as a way to track the |
| // start of a navigation were misusing this timestamp and getting the wrong |
| // value - they should be using navigationStart instead. Provisional loads |
| // will not be processed by the render process for browser-initiated |
| // navigations, so reporting the time a provisional load was processed in |
| // the render process will no longer make sense. Thus, we now report the |
| // time for navigationStart, which is a value more consistent with what |
| // developers currently use start_load_time for. |
| double start_load_time = web_performance.NavigationStart(); |
| // TODO(bmcquade): Remove this. 'commit' time is a concept internal to |
| // chrome that shouldn't be exposed to the web platform. |
| double commit_load_time = web_performance.ResponseStart(); |
| double finish_document_load_time = |
| web_performance.DomContentLoadedEventEnd(); |
| double finish_load_time = web_performance.LoadEventEnd(); |
| double first_paint_time = web_performance.FirstPaint(); |
| // TODO(bmcquade): remove this. It's misleading to track the first paint |
| // after the load event, since many pages perform their meaningful paints |
| // long before the load event fires. We report a time of zero for the |
| // time being. |
| double first_paint_after_load_time = 0.0; |
| std::string_view navigation_type = |
| GetNavigationType(document_loader->GetNavigationType()); |
| bool was_fetched_via_spdy = response.WasFetchedViaSPDY(); |
| bool was_alpn_negotiated = response.WasAlpnNegotiated(); |
| std::string alpn_negotiated_protocol = |
| response.AlpnNegotiatedProtocol().Utf8(); |
| bool was_alternate_protocol_available = |
| response.WasAlternateProtocolAvailable(); |
| std::string_view connection_info = |
| net::HttpConnectionInfoToString(response.ConnectionInfo()); |
| |
| // Important: |frame| and |document_loader| should not be |
| // referred to below this line, as JS setters below can invalidate these |
| // pointers. |
| v8::Isolate* isolate = args.GetIsolate(); |
| v8::Local<v8::Context> ctx = isolate->GetCurrentContext(); |
| v8::Local<v8::Object> load_times = v8::Object::New(isolate); |
| |
| // Helper lambdas for creating v8::Number, v8::Boolean and v8::String. |
| auto v8_num = [=](double value) { return v8::Number::New(isolate, value); }; |
| auto v8_bool = [=](bool value) { return v8::Boolean::New(isolate, value); }; |
| auto v8_str = [=](std::string_view str) { |
| return v8::String::NewFromUtf8(isolate, str.data(), |
| v8::NewStringType::kNormal, str.length()) |
| .ToLocalChecked(); |
| }; |
| |
| // Defines a property on |load_times| object with given name and value, |
| // returns true on success, false otherwise. |
| auto define_prop = [=](std::string_view name, v8::Local<v8::Value> value) { |
| v8::Local<v8::String> name_str = |
| v8::String::NewFromUtf8(isolate, name.data(), |
| v8::NewStringType::kInternalized, |
| name.length()) |
| .ToLocalChecked(); |
| |
| return load_times |
| ->SetNativeDataProperty(ctx, name_str, LoadtimesGetter, EmptySetter, |
| value) |
| .FromMaybe(false); |
| }; |
| |
| if (!define_prop("requestTime", v8_num(request_time))) { |
| return; |
| } |
| if (!define_prop("startLoadTime", v8_num(start_load_time))) { |
| return; |
| } |
| if (!define_prop("commitLoadTime", v8_num(commit_load_time))) { |
| return; |
| } |
| if (!define_prop("finishDocumentLoadTime", |
| v8_num(finish_document_load_time))) { |
| return; |
| } |
| if (!define_prop("finishLoadTime", v8_num(finish_load_time))) { |
| return; |
| } |
| if (!define_prop("firstPaintTime", v8_num(first_paint_time))) { |
| return; |
| } |
| if (!define_prop("firstPaintAfterLoadTime", |
| v8_num(first_paint_after_load_time))) { |
| return; |
| } |
| if (!define_prop("navigationType", v8_str(navigation_type))) { |
| return; |
| } |
| if (!define_prop("wasFetchedViaSpdy", v8_bool(was_fetched_via_spdy))) { |
| return; |
| } |
| if (!define_prop("wasNpnNegotiated", v8_bool(was_alpn_negotiated))) { |
| return; |
| } |
| if (!define_prop("npnNegotiatedProtocol", |
| v8_str(alpn_negotiated_protocol))) { |
| return; |
| } |
| if (!define_prop("wasAlternateProtocolAvailable", |
| v8_bool(was_alternate_protocol_available))) { |
| return; |
| } |
| if (!define_prop("connectionInfo", v8_str(connection_info))) { |
| return; |
| } |
| |
| args.GetReturnValue().Set(load_times); |
| } |
| |
| static void CSIGetter(v8::Local<v8::Name> name, |
| const v8::PropertyCallbackInfo<v8::Value>& info) { |
| if (WebLocalFrame* frame = WebLocalFrame::FrameForCurrentContext()) { |
| frame->UsageCountChromeCSI(blink::WebString::FromUTF8( |
| *v8::String::Utf8Value(info.GetIsolate(), name))); |
| } |
| info.GetReturnValue().Set(info.Data()); |
| } |
| |
| static void GetCSI(const v8::FunctionCallbackInfo<v8::Value>& args) { |
| args.GetReturnValue().SetNull(); |
| WebLocalFrame* frame = WebLocalFrame::FrameForCurrentContext(); |
| if (!frame) { |
| return; |
| } |
| WebDocumentLoader* document_loader = frame->GetDocumentLoader(); |
| if (!document_loader) { |
| return; |
| } |
| blink::WebPerformanceMetricsForReporting web_performance = |
| frame->PerformanceMetricsForReporting(); |
| base::Time now = base::Time::Now(); |
| base::Time start = base::Time::FromSecondsSinceUnixEpoch( |
| web_performance.NavigationStart()); |
| |
| base::Time dom_content_loaded_end = base::Time::FromSecondsSinceUnixEpoch( |
| web_performance.DomContentLoadedEventEnd()); |
| base::TimeDelta page = now - start; |
| int navigation_type = |
| GetCSITransitionType(document_loader->GetNavigationType()); |
| // Important: |frame| and |document_loader| should not be referred to below |
| // this line, as JS setters below can invalidate these pointers. |
| v8::Isolate* isolate = args.GetIsolate(); |
| v8::Local<v8::Context> ctx = isolate->GetCurrentContext(); |
| v8::Local<v8::Object> csi = v8::Object::New(isolate); |
| |
| // Helper lambda for creating v8::Number. |
| auto v8_num = [=](double value) { return v8::Number::New(isolate, value); }; |
| |
| // Defines a property on |csi| object with given name and value, |
| // returns true on success, false otherwise. |
| auto define_prop = [=](std::string_view name, v8::Local<v8::Value> value) { |
| v8::Local<v8::String> name_str = |
| v8::String::NewFromUtf8(isolate, name.data(), |
| v8::NewStringType::kInternalized, |
| name.length()) |
| .ToLocalChecked(); |
| |
| return csi |
| ->SetNativeDataProperty(ctx, name_str, CSIGetter, EmptySetter, value) |
| .FromMaybe(false); |
| }; |
| |
| if (!define_prop("startE", v8_num(start.InMillisecondsSinceUnixEpoch()))) { |
| return; |
| } |
| // NOTE: historically, the CSI onload field has reported the time the |
| // document finishes parsing, which is DOMContentLoaded. Thus, we continue |
| // to report that here, despite the fact that the field is named onloadT. |
| if (!define_prop( |
| "onloadT", |
| v8_num(dom_content_loaded_end.InMillisecondsSinceUnixEpoch()))) { |
| return; |
| } |
| if (!define_prop("pageT", v8_num(page.InMillisecondsF()))) { |
| return; |
| } |
| if (!define_prop("tran", v8_num(navigation_type))) { |
| return; |
| } |
| args.GetReturnValue().Set(csi); |
| } |
| }; |
| |
| std::unique_ptr<v8::Extension> LoadTimesExtension::Get() { |
| return std::make_unique<LoadTimesExtensionWrapper>(); |
| } |
| |
| } // namespace extensions_v8 |
