[Paint Preview] Add performance UKM

Adds UKM support for reporting the capture time of the main frame (in
ms) for a paint preview. Support for memory overhead and on-disk size
may be added to this dataset in future, but is out-of-scope for this CL
as getting reliable memory metrics is non-trivial and on-disk size is
handled on a per-implementation basis.

Bug: 1038390
Change-Id: Iaaf77b3722633773455babd3e7e51cd95f713577
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1988222
Commit-Queue: Calder Kitagawa <ckitagawa@chromium.org>
Reviewed-by: Michael Thiessen <mthiesse@chromium.org>
Reviewed-by: Ken Buchanan <kenrb@chromium.org>
Reviewed-by: Alexei Svitkine <asvitkine@chromium.org>
Cr-Commit-Position: refs/heads/master@{#738638}

chrome/browser/paint_preview/paint_preview_browsertest.cc

@@ -16,10 +16,12 @@
 #include "components/paint_preview/browser/paint_preview_client.h"
 #include "components/paint_preview/common/file_stream.h"
 #include "components/paint_preview/common/serial_utils.h"
+#include "components/ukm/test_ukm_recorder.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/common/content_switches.h"
 #include "net/dns/mock_host_resolver.h"
 #include "net/test/embedded_test_server/embedded_test_server.h"
+#include "services/metrics/public/cpp/ukm_builders.h"
 #include "third_party/skia/include/core/SkPicture.h"
 #include "url/gurl.h"
 
@@ -88,6 +90,7 @@ class PaintPreviewBrowserTest : public InProcessBrowserTest {
 
 IN_PROC_BROWSER_TEST_F(PaintPreviewBrowserTest, CaptureFrame) {
   LoadPage(http_server_.GetURL("a.com", "/cross_site_iframe_factory.html?a"));
+  ukm::TestAutoSetUkmRecorder ukm_recorder;
 
   base::UnguessableToken guid = base::UnguessableToken::Create();
   PaintPreviewClient::PaintPreviewParams params;
@@ -134,6 +137,10 @@ IN_PROC_BROWSER_TEST_F(PaintPreviewBrowserTest, CaptureFrame) {
           },
           loop.QuitClosure(), guid));
   loop.Run();
+
+  auto entries = ukm_recorder.GetEntriesByName(
+      ukm::builders::PaintPreviewCapture::kEntryName);
+  EXPECT_EQ(1u, entries.size());
 }
 
 IN_PROC_BROWSER_TEST_F(PaintPreviewBrowserTest, CaptureMainFrameWithSubframe) {

components/paint_preview/browser/BUILD.gn

@@ -31,9 +31,12 @@ source_set("browser") {
     "//components/discardable_memory/service",
     "//components/keyed_service/core",
     "//components/strings:components_strings_grit",
+    "//components/ukm/content",
     "//content/public/browser",
     "//mojo/public/cpp/base",
     "//mojo/public/cpp/bindings",
+    "//services/metrics/public/cpp:metrics_cpp",
+    "//services/metrics/public/cpp:ukm_builders",
     "//third_party/blink/public:blink_headers",
     "//third_party/blink/public/common",
     "//third_party/zlib/google:zip",

components/paint_preview/browser/DEPS

 include_rules = [
   "+cc/base",
   "+components/discardable_memory/service",
+  "+components/keyed_service/core",
   "+components/services/paint_preview_compositor/public/mojom",
   "+components/strings/grit/components_strings.h",
-  "+components/keyed_service/core",
+  "+components/ukm/content",
   "+content/public/browser",
   "+content/public/test",
+  "+services/metrics/public/cpp",
   "+third_party/blink/public/common",
   "+third_party/zlib/google",
 ]

components/paint_preview/browser/paint_preview_client.cc

@@ -11,10 +11,15 @@
 #include "base/strings/string_number_conversions.h"
 #include "base/task/post_task.h"
 #include "base/threading/scoped_blocking_call.h"
+#include "components/ukm/content/source_url_recorder.h"
 #include "content/public/browser/browser_task_traits.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/render_process_host.h"
+#include "content/public/browser/web_contents.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 "third_party/blink/public/common/associated_interfaces/associated_interface_provider.h"
 
 namespace paint_preview {
@@ -69,16 +74,32 @@ PaintPreviewCaptureResponseToPaintPreviewFrameProto(
   return frame_guids;
 }
 
+// Records UKM data for the capture.
+// TODO(crbug/1038390): Add more metrics;
+// - Peak memory during capture (bucketized).
+// - Compressed on disk size (bucketized).
+void RecordUkmCaptureData(ukm::SourceId source_id,
+                          base::TimeDelta blink_recording_time) {
+  if (source_id == ukm::kInvalidSourceId)
+    return;
+  ukm::builders::PaintPreviewCapture(source_id)
+      .SetBlinkCaptureTime(blink_recording_time.InMilliseconds())
+      .Record(ukm::UkmRecorder::Get());
+}
+
 }  // namespace
 
 PaintPreviewClient::PaintPreviewParams::PaintPreviewParams() = default;
+
 PaintPreviewClient::PaintPreviewParams::~PaintPreviewParams() = default;
 
 PaintPreviewClient::PaintPreviewData::PaintPreviewData() = default;
+
 PaintPreviewClient::PaintPreviewData::~PaintPreviewData() = default;
 
 PaintPreviewClient::PaintPreviewData& PaintPreviewClient::PaintPreviewData::
 operator=(PaintPreviewData&& rhs) noexcept = default;
+
 PaintPreviewClient::PaintPreviewData::PaintPreviewData(
     PaintPreviewData&& other) noexcept = default;
 
@@ -89,11 +110,13 @@ PaintPreviewClient::CreateResult::CreateResult(base::File file,
 PaintPreviewClient::CreateResult::~CreateResult() = default;
 
 PaintPreviewClient::CreateResult::CreateResult(CreateResult&& other) = default;
+
 PaintPreviewClient::CreateResult& PaintPreviewClient::CreateResult::operator=(
     CreateResult&& other) = default;
 
 PaintPreviewClient::PaintPreviewClient(content::WebContents* web_contents)
     : content::WebContentsObserver(web_contents) {}
+
 PaintPreviewClient::~PaintPreviewClient() = default;
 
 void PaintPreviewClient::CapturePaintPreview(
@@ -105,11 +128,13 @@ void PaintPreviewClient::CapturePaintPreview(
                             mojom::PaintPreviewStatus::kGuidCollision, nullptr);
     return;
   }
-  all_document_data_.insert({params.document_guid, PaintPreviewData()});
-  auto* document_data = &all_document_data_[params.document_guid];
-  document_data->root_dir = params.root_dir;
-  document_data->callback = std::move(callback);
-  document_data->root_url = render_frame_host->GetLastCommittedURL();
+  PaintPreviewData document_data;
+  document_data.root_dir = params.root_dir;
+  document_data.callback = std::move(callback);
+  document_data.root_url = render_frame_host->GetLastCommittedURL();
+  document_data.source_id =
+      ukm::GetSourceIdForWebContentsDocument(web_contents());
+  all_document_data_.insert({params.document_guid, std::move(document_data)});
   CapturePaintPreviewInternal(params, render_frame_host);
 }
 
@@ -309,16 +334,17 @@ mojom::PaintPreviewStatus PaintPreviewClient::RecordFrame(
     content::RenderFrameHost* render_frame_host,
     mojom::PaintPreviewCaptureResponsePtr response) {
   auto it = all_document_data_.find(guid);
+  DCHECK(it != all_document_data_.end());
   if (!it->second.proto) {
     it->second.proto = std::make_unique<PaintPreviewProto>();
-    it->second.proto->mutable_metadata()->set_url(
-        all_document_data_[guid].root_url.spec());
+    it->second.proto->mutable_metadata()->set_url(it->second.root_url.spec());
   }
 
   PaintPreviewProto* proto_ptr = it->second.proto.get();
 
   PaintPreviewFrameProto* frame_proto;
   if (is_main_frame) {
+    it->second.main_frame_blink_recording_time = response->blink_recording_time;
     frame_proto = proto_ptr->mutable_root_frame();
     frame_proto->set_is_main_frame(true);
     uint64_t old_style_id = MakeOldStyleId(render_frame_host);
@@ -353,6 +379,9 @@ void PaintPreviewClient::OnFinished(base::UnguessableToken guid,
         "Browser.PaintPreview.Capture.NumberOfFramesCaptured",
         document_data->finished_subframes.size());
 
+    RecordUkmCaptureData(document_data->source_id,
+                         document_data->main_frame_blink_recording_time);
+
     // At a minimum one frame was captured successfully, it is up to the
     // caller to decide if a partial success is acceptable based on what is
     // contained in the proto.

components/paint_preview/browser/paint_preview_client.h

@@ -96,6 +96,12 @@ class PaintPreviewClient
     // URL of the root frame.
     GURL root_url;
 
+    // UKM Source ID of the WebContent.
+    ukm::SourceId source_id;
+
+    // Main frame capture time.
+    base::TimeDelta main_frame_blink_recording_time;
+
     // Callback that is invoked on completion of data.
     PaintPreviewCallback callback;
 

components/paint_preview/common/mojom/paint_preview_recorder.mojom

@@ -5,6 +5,7 @@
 module paint_preview.mojom;
 
 import "mojo/public/mojom/base/file.mojom";
+import "mojo/public/mojom/base/time.mojom";
 import "mojo/public/mojom/base/unguessable_token.mojom";
 import "ui/gfx/geometry/mojom/geometry.mojom";
 import "url/mojom/url.mojom";
@@ -68,6 +69,9 @@ struct PaintPreviewCaptureResponse {
 
   // A list of links within the frame.
   array<LinkData> links;
+
+  // The time spent capturing in Blink.
+  mojo_base.mojom.TimeDelta blink_recording_time;
 };
 
 // Service for capturing a paint preview of a RenderFrame's contents. This

components/paint_preview/renderer/paint_preview_recorder_impl.cc

@@ -122,6 +122,7 @@ void PaintPreviewRecorderImpl::CapturePaintPreviewInternal(
   base::TimeTicks start_time = base::TimeTicks::Now();
   bool success = frame->CapturePaintPreview(bounds, canvas);
   base::TimeDelta capture_time = base::TimeTicks::Now() - start_time;
+  response->blink_recording_time = capture_time;
 
   if (is_main_frame_) {
     base::UmaHistogramBoolean("Renderer.PaintPreview.Capture.MainFrameSuccess",

tools/metrics/ukm/ukm.xml

@@ -7314,6 +7314,22 @@ be describing additional metrics about the same event.
   </metric>
 </event>
 
+<event name="PaintPreviewCapture">
+  <owner>ckitagawa@chromium.org</owner>
+  <owner>fredmello@chromium.org</owner>
+  <owner>mahmoudi@chromium.org</owner>
+  <owner>vollick@chromium.org</owner>
+  <summary>
+    Metrics related to the performance of capturing Paint Previews.
+  </summary>
+  <metric name="BlinkCaptureTime">
+    <summary>
+      The amount of time spent painting in Blink to record a Paint Preview of
+      the main frame.
+    </summary>
+  </metric>
+</event>
+
 <event name="PasswordForm">
   <owner>battre@chromium.org</owner>
   <summary>