chrome/browser/ui/waap/waap_ui_metrics_service.cc

// 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/ui/waap/waap_ui_metrics_service.h"

#include <string>
#include <string_view>

#include "base/logging.h"
#include "base/metrics/histogram_functions.h"
#include "base/strings/strcat.h"
#include "base/trace_event/trace_event.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/sessions/session_restore.h"
#include "chrome/browser/ui/waap/waap_ui_metrics_recorder.h"
#include "chrome/browser/ui/waap/waap_ui_metrics_service_factory.h"
#include "components/startup_metric_utils/browser/startup_metric_utils.h"
#include "components/startup_metric_utils/common/startup_metric_utils.h"

namespace {

std::string_view ReloadButtonModeToString(
    WaapUIMetricsRecorder::ReloadButtonMode mode) {
  switch (mode) {
    case WaapUIMetricsRecorder::ReloadButtonMode::kReload:
      return "Reload";
    case WaapUIMetricsRecorder::ReloadButtonMode::kStop:
      return "Stop";
  }
  NOTREACHED();
}

std::string_view ReloadButtonInputTypeToString(
    WaapUIMetricsRecorder::ReloadButtonInputType type) {
  switch (type) {
    case WaapUIMetricsRecorder::ReloadButtonInputType::kMouseRelease:
      return ".MouseRelease";
    case WaapUIMetricsRecorder::ReloadButtonInputType::kKeyPress:
      return ".KeyPress";
  }
  NOTREACHED();
}

// Helper to construct the full histogram name for ReloadButton metrics
std::string BuildReloadButtonHistogramName(std::string_view base,
                                           std::string_view slice = "") {
  return base::StrCat({"InitialWebUI.ReloadButton.", base, slice});
}

// Emits a WaaP trace event asynchronously onto a perfetto::Track and records a
// UMA histogram with the same event name.
void EmitHistogramWithTraceEvent(const char* event_name,
                                 base::TimeTicks start_ticks,
                                 base::TimeTicks end_ticks) {
  TRACE_EVENT_BEGIN("waap", perfetto::StaticString(event_name),
                    perfetto::Track(reinterpret_cast<uintptr_t>(event_name)),
                    start_ticks);
  TRACE_EVENT_END("waap",
                  perfetto::Track(reinterpret_cast<uintptr_t>(event_name)),
                  end_ticks);

  const base::TimeDelta delta = end_ticks - start_ticks;
  base::UmaHistogramLongTimes100(event_name, delta);
}

// Emits a WaaP trace event and records a UMA histogram with the given event
// name and duration.
void EmitReloadButtonHistogramWithTraceEvent(const char* event_name,
                                             base::TimeTicks start_ticks,
                                             base::TimeTicks end_ticks) {
  const base::TimeDelta duration = end_ticks - start_ticks;
  TRACE_EVENT_BEGIN("waap", perfetto::StaticString(event_name),
                    perfetto::Track(reinterpret_cast<uintptr_t>(event_name)),
                    start_ticks);
  TRACE_EVENT_END("waap",
                  perfetto::Track(reinterpret_cast<uintptr_t>(event_name)),
                  end_ticks);
  base::UmaHistogramCustomTimes(event_name, duration, base::Milliseconds(1),
                                base::Minutes(3), 100);
}

// Returns a suffix for the startup temperature of the browser.
const char* GetStartupTemperatureSuffix() {
  switch (startup_metric_utils::GetBrowser().GetStartupTemperature()) {
    case startup_metric_utils::COLD_STARTUP_TEMPERATURE:
      return ".ColdStartup";
    case startup_metric_utils::WARM_STARTUP_TEMPERATURE:
      return ".WarmStartup";
    case startup_metric_utils::LUKEWARM_STARTUP_TEMPERATURE:
      return "";
    case startup_metric_utils::UNDETERMINED_STARTUP_TEMPERATURE:
      return "";
    case startup_metric_utils::STARTUP_TEMPERATURE_COUNT:
      NOTREACHED();
  }
  return "";
}

// Records a startup paint metric for the given `paint_metric_base`.
void RecordStartupPaintMetric(std::string_view paint_metric_base,
                              bool is_session_restored,
                              base::TimeTicks paint_time) {
  if (!startup_metric_utils::GetBrowser().ShouldLogStartupHistogram()) {
    return;
  }

  base::TimeTicks time_origin =
      startup_metric_utils::GetBrowser().GetApplicationStartTicksForStartup();
  if (time_origin.is_null()) {
    return;
  }

  std::string histogram_name = base::StrCat(
      {"InitialWebUI.Startup", (is_session_restored ? ".SessionRestore" : ""),
       ".", paint_metric_base, GetStartupTemperatureSuffix()});

  EmitHistogramWithTraceEvent(histogram_name.c_str(), time_origin, paint_time);
}

}  // namespace

WaapUIMetricsService::WaapUIMetricsService(
    base::PassKey<WaapUIMetricsServiceFactory>,
    const Profile* profile)
    : is_session_restored_(SessionRestore::IsRestoring(profile)) {}

WaapUIMetricsService::~WaapUIMetricsService() = default;

// static
WaapUIMetricsService* WaapUIMetricsService::Get(Profile* profile) {
  return WaapUIMetricsServiceFactory::GetForProfile(profile);
}

void WaapUIMetricsService::OnBrowserWindowFirstPresentation(
    base::TimeTicks time) {
  static bool is_first_call = true;
  CHECK(!time.is_null());
  CHECK(is_first_call);
  is_first_call = false;

  RecordStartupPaintMetric("BrowserWindow.FirstPaint", is_session_restored_,
                           time);
}

void WaapUIMetricsService::OnFirstPaint(base::TimeTicks time) {
  static bool is_first_call = true;
  CHECK(!time.is_null());
  if (!is_first_call) {
    return;
  }
  is_first_call = false;

  // For early experiment, this is ReloadButton only.
  // TODO(crbug.com/448794588): Switch to general name after initial phase.
  RecordStartupPaintMetric("ReloadButton.FirstPaint", is_session_restored_,
                           time);
}

void WaapUIMetricsService::OnFirstContentfulPaint(base::TimeTicks time) {
  static bool is_first_call = true;
  CHECK(!time.is_null());
  if (!is_first_call) {
    return;
  }
  is_first_call = false;

  // For early experiment, this is ReloadButton only.
  // TODO(crbug.com/448794588): Switch to general name after initial phase.
  RecordStartupPaintMetric("ReloadButton.FirstContentfulPaint",
                           is_session_restored_, time);
}

void WaapUIMetricsService::OnReloadButtonMousePressToNextPaint(
    base::TimeTicks start_ticks,
    base::TimeTicks end_ticks) {
  auto name = BuildReloadButtonHistogramName("MousePressToNextPaint");
  EmitReloadButtonHistogramWithTraceEvent(name.c_str(), start_ticks, end_ticks);
}

void WaapUIMetricsService::OnReloadButtonMouseHoverToNextPaint(
    base::TimeTicks start_ticks,
    base::TimeTicks end_ticks) {
  auto name = BuildReloadButtonHistogramName("MouseHoverToNextPaint");
  EmitReloadButtonHistogramWithTraceEvent(name.c_str(), start_ticks, end_ticks);
}

void WaapUIMetricsService::OnReloadButtonInput(
    WaapUIMetricsRecorder::ReloadButtonInputType input_type) {
  auto name = BuildReloadButtonHistogramName("InputCount");
  base::UmaHistogramEnumeration(name, input_type);
}

void WaapUIMetricsService::OnReloadButtonInputToReload(
    base::TimeTicks start_ticks,
    base::TimeTicks end_ticks,
    WaapUIMetricsRecorder::ReloadButtonInputType input_type) {
  auto name = BuildReloadButtonHistogramName(
      "InputToReload", ReloadButtonInputTypeToString(input_type));
  EmitReloadButtonHistogramWithTraceEvent(name.c_str(), start_ticks, end_ticks);
}

void WaapUIMetricsService::OnReloadButtonInputToStop(
    base::TimeTicks start_ticks,
    base::TimeTicks end_ticks,
    WaapUIMetricsRecorder::ReloadButtonInputType input_type) {
  auto name = BuildReloadButtonHistogramName(
      "InputToStop", ReloadButtonInputTypeToString(input_type));
  EmitReloadButtonHistogramWithTraceEvent(name.c_str(), start_ticks, end_ticks);
}

void WaapUIMetricsService::OnReloadButtonInputToNextPaint(
    base::TimeTicks start_ticks,
    base::TimeTicks end_ticks,
    WaapUIMetricsRecorder::ReloadButtonInputType input_type) {
  auto name = BuildReloadButtonHistogramName(
      "InputToNextPaint", ReloadButtonInputTypeToString(input_type));
  EmitReloadButtonHistogramWithTraceEvent(name.c_str(), start_ticks, end_ticks);
}

void WaapUIMetricsService::OnReloadButtonChangeVisibleModeToNextPaint(
    base::TimeTicks start_ticks,
    base::TimeTicks end_ticks,
    WaapUIMetricsRecorder::ReloadButtonMode new_mode) {
  auto name = BuildReloadButtonHistogramName(
      "ChangeVisibleModeToNextPaintIn", ReloadButtonModeToString(new_mode));
  EmitReloadButtonHistogramWithTraceEvent(name.c_str(), start_ticks, end_ticks);
}