components/optimization_guide/content/browser/salient_image_retriever.cc

// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "components/optimization_guide/content/browser/salient_image_retriever.h"

#include <algorithm>
#include <map>
#include <set>
#include <vector>

#include "base/feature_list.h"
#include "base/functional/bind.h"
#include "base/memory/scoped_refptr.h"
#include "base/metrics/histogram_functions.h"
#include "components/optimization_guide/core/optimization_guide_logger.h"
#include "content/public/browser/render_frame_host.h"
#include "content/public/browser/web_contents.h"
#include "mojo/public/cpp/bindings/associated_remote.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 "services/metrics/public/cpp/ukm_source.h"
#include "services/service_manager/public/cpp/interface_provider.h"
#include "third_party/blink/public/common/associated_interfaces/associated_interface_provider.h"
#include "third_party/blink/public/mojom/opengraph/metadata.mojom.h"
#include "url/gurl.h"

namespace optimization_guide {

namespace {

// Keep in sync with OptimizationGuideSalientImageAvailability histogram enum.
enum class SalientImageAvailability {
  kUnknown = 0,
  kNotAvailable = 1,
  kAvailableButUnparsableFromOgImage = 2,
  kAvailableFromOgImage = 3,
  kMaxValue = kAvailableFromOgImage
};

void RecordMetrics(ukm::SourceId ukm_source_id,
                   SalientImageAvailability image_availability_result) {
  const char og_image_availability_histogram_name[] =
      "OptimizationGuide.PageContentAnnotations.SalientImageAvailability";

  ukm::builders::SalientImageAvailability(ukm_source_id)
      .SetImageAvailability(static_cast<int64_t>(image_availability_result))
      .Record(ukm::UkmRecorder::Get());

  base::UmaHistogramEnumeration(og_image_availability_histogram_name,
                                image_availability_result);
}

}  // namespace

SalientImageRetriever::SalientImageRetriever(
    OptimizationGuideLogger* optimization_guide_logger)
    : optimization_guide_logger_(optimization_guide_logger) {}
SalientImageRetriever::~SalientImageRetriever() = default;

void SalientImageRetriever::GetOgImage(content::WebContents* web_contents) {
  content::RenderFrameHost& main_frame =
      web_contents->GetPrimaryPage().GetMainDocument();

  main_frame.GetOpenGraphMetadata(base::BindOnce(
      &SalientImageRetriever::OnGetOpenGraphMetadata,
      weak_factory_.GetWeakPtr(), main_frame.GetLastCommittedURL(),
      web_contents->GetPrimaryMainFrame()->GetPageUkmSourceId()));
}

void SalientImageRetriever::OnGetOpenGraphMetadata(
    const GURL& page_url,
    ukm::SourceId ukm_source_id,
    blink::mojom::OpenGraphMetadataPtr metadata) {
  if (!metadata || !metadata->image) {
    RecordMetrics(ukm_source_id, SalientImageAvailability::kNotAvailable);
    return;
  }

  GURL url(metadata->image.value());
  if (url.is_empty() || !url.is_valid() || !url.SchemeIsHTTPOrHTTPS()) {
    RecordMetrics(ukm_source_id,
                  SalientImageAvailability::kAvailableButUnparsableFromOgImage);
    return;
  }

  RecordMetrics(ukm_source_id, SalientImageAvailability::kAvailableFromOgImage);

  OPTIMIZATION_GUIDE_LOGGER(
      optimization_guide_common::mojom::LogSource::PAGE_CONTENT_ANNOTATIONS,
      optimization_guide_logger_)
      << " page_url=" << page_url
      << " Salient Image URL: " << metadata->image.value();
}

}  // namespace optimization_guide