private_metrics/private_metrics_reporting_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.

// ReportingService specialized to report private metrics.

#include "components/metrics/private_metrics/private_metrics_reporting_service.h"

#include <memory>
#include <string_view>

#include "base/metrics/histogram_functions.h"
#include "components/metrics/dwa/dwa_pref_names.h"
#include "components/metrics/dwa/dwa_recorder.h"
#include "components/metrics/metrics_service_client.h"
#include "components/metrics/private_metrics/private_metrics_features.h"
#include "components/metrics/private_metrics/private_metrics_pref_names.h"
#include "components/metrics/private_metrics/private_metrics_unsent_log_store_metrics.h"
#include "components/metrics/server_urls.h"
#include "components/metrics/unsent_log_store.h"
#include "components/metrics/unsent_log_store_metrics.h"
#include "components/prefs/pref_registry_simple.h"

namespace metrics::private_metrics {

namespace {

bool IsDwaCompatiblityEnabled(std::optional<bool> dwa_compatibility) {
  if (dwa_compatibility.has_value()) {
    return dwa_compatibility.value();
  }

  return !base::FeatureList::IsEnabled(kPrivateMetricsFeature);
}

const char* GetLogDataPrefName(bool dwa_compatibility) {
  if (dwa_compatibility) {
    return dwa::prefs::kUnsentLogStoreName;
  } else {
    return prefs::kUnsentLogStoreName;
  }
}

}  // namespace

PrivateMetricsReportingService::PrivateMetricsReportingService(
    metrics::MetricsServiceClient* client,
    PrefService* local_state,
    const UnsentLogStore::UnsentLogStoreLimits& storage_limits,
    std::optional<bool> dwa_compatibility)
    : ReportingService(client,
                       local_state,
                       storage_limits.max_log_size_bytes,
                       /*logs_event_manager=*/nullptr),
      dwa_compatibility_(IsDwaCompatiblityEnabled(dwa_compatibility)),
      unsent_log_store_(std::make_unique<PrivateMetricsUnsentLogStoreMetrics>(),
                        local_state,
                        GetLogDataPrefName(dwa_compatibility_),
                        /*metadata_pref_name=*/nullptr,
                        storage_limits,
                        client->GetUploadSigningKey(),
                        /*logs_event_manager=*/nullptr) {}

PrivateMetricsReportingService::~PrivateMetricsReportingService() = default;

metrics::UnsentLogStore* PrivateMetricsReportingService::unsent_log_store() {
  return &unsent_log_store_;
}

// static
void PrivateMetricsReportingService::RegisterPrefs(
    PrefRegistrySimple* registry) {
  registry->RegisterListPref(prefs::kUnsentLogStoreName);
  registry->RegisterListPref(dwa::prefs::kUnsentLogStoreName);
}

metrics::LogStore* PrivateMetricsReportingService::log_store() {
  return &unsent_log_store_;
}

GURL PrivateMetricsReportingService::GetUploadUrl() const {
  if (dwa_compatibility_) {
    return metrics::GetDwaServerUrl();
  } else {
    return metrics::GetPrivateMetricsServerUrl();
  }
}

GURL PrivateMetricsReportingService::GetInsecureUploadUrl() const {
  // Returns an empty string since retrying over HTTP is not enabled for Private
  // Metrics.
  return GURL();
}

std::string_view PrivateMetricsReportingService::upload_mime_type() const {
  return kMetricsMimeType;
}

metrics::MetricsLogUploader::MetricServiceType
PrivateMetricsReportingService::service_type() const {
  if (dwa_compatibility_) {
    return MetricsLogUploader::DWA;
  } else {
    return MetricsLogUploader::PRIVATE_METRICS;
  }
}

void PrivateMetricsReportingService::LogCellularConstraint(
    bool upload_canceled) {
  if (dwa_compatibility_) {
    base::UmaHistogramBoolean("DWA.LogUpload.Canceled.CellularConstraint",
                              upload_canceled);
  } else {
    base::UmaHistogramBoolean(
        "PrivateMetrics.LogUpload.Canceled.CellularConstraint",
        upload_canceled);
  }
}

void PrivateMetricsReportingService::LogResponseOrErrorCode(int response_code,
                                                            int error_code,
                                                            bool was_https) {
  // `was_https` is ignored since all Private Metrics logs are received over
  // HTTPS.
  if (dwa_compatibility_) {
    base::UmaHistogramSparse("DWA.LogUpload.ResponseOrErrorCode",
                             response_code >= 0 ? response_code : error_code);
  } else {
    base::UmaHistogramSparse("PrivateMetrics.LogUpload.ResponseOrErrorCode",
                             response_code >= 0 ? response_code : error_code);
  }
}

void PrivateMetricsReportingService::LogSuccessLogSize(size_t log_size) {
  if (dwa_compatibility_) {
    base::UmaHistogramCounts10000("DWA.LogSize.OnSuccess", log_size / 1024);
  } else {
    base::UmaHistogramCounts10000("PrivateMetrics.LogSize.OnSuccess",
                                  log_size / 1024);
  }
}

void PrivateMetricsReportingService::LogSuccessMetadata(
    const std::string& staged_log) {}

void PrivateMetricsReportingService::LogLargeRejection(size_t log_size) {}

}  // namespace metrics::private_metrics