File: contextual_content_suggestions_service.h

package info (click to toggle)
chromium-browser 70.0.3538.110-1~deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,619,476 kB
  • sloc: cpp: 13,024,755; ansic: 1,349,823; python: 916,672; xml: 314,489; java: 280,047; asm: 276,936; perl: 75,771; objc: 66,634; sh: 45,860; cs: 28,354; php: 11,064; makefile: 10,911; yacc: 9,109; tcl: 8,403; ruby: 4,065; lex: 1,779; pascal: 1,411; lisp: 1,055; awk: 41; jsp: 39; sed: 17; sql: 3
file content (109 lines) | stat: -rw-r--r-- 4,340 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_NTP_SNIPPETS_CONTEXTUAL_REPORTING_CONTEXTUAL_CONTENT_SUGGESTIONS_SERVICE_H_
#define COMPONENTS_NTP_SNIPPETS_CONTEXTUAL_REPORTING_CONTEXTUAL_CONTENT_SUGGESTIONS_SERVICE_H_

#include <map>
#include <memory>
#include <string>
#include <vector>

#include "base/callback.h"
#include "base/optional.h"
#include "components/image_fetcher/core/image_fetcher.h"
#include "components/keyed_service/core/keyed_service.h"
#include "components/ntp_snippets/callbacks.h"
#include "components/ntp_snippets/content_suggestion.h"
#include "components/ntp_snippets/contextual/contextual_suggestions_cache.h"
#include "components/ntp_snippets/contextual/contextual_suggestions_fetcher.h"
#include "components/ntp_snippets/contextual/reporting/contextual_suggestions_debugging_reporter.h"
#include "components/ntp_snippets/contextual/reporting/contextual_suggestions_reporter.h"
#include "services/metrics/public/cpp/ukm_source_id.h"

namespace ntp_snippets {
class CachedImageFetcher;
class RemoteSuggestionsDatabase;
}  // namespace ntp_snippets

namespace contextual_suggestions {

static constexpr int kFetchCacheCapacity = 10;

class ContextualContentSuggestionsServiceProxy;

// Retrieves contextual suggestions for a given URL and fetches images
// for contextual suggestion, using caching.
class ContextualContentSuggestionsService : public KeyedService {
 public:
  ContextualContentSuggestionsService(
      std::unique_ptr<ContextualSuggestionsFetcher>
          contextual_suggestions_fetcher,
      std::unique_ptr<ntp_snippets::CachedImageFetcher> image_fetcher,
      std::unique_ptr<ntp_snippets::RemoteSuggestionsDatabase>
          contextual_suggestions_database,
      std::unique_ptr<
          contextual_suggestions::ContextualSuggestionsReporterProvider>
          reporter_provider);
  ~ContextualContentSuggestionsService() override;

  // Asynchronously fetches contextual suggestions for the given URL.
  virtual void FetchContextualSuggestionClusters(
      const GURL& url,
      FetchClustersCallback callback,
      ReportFetchMetricsCallback metrics_callback);

  // Fetches an image pointed to by |url| and internally caches it using
  // |suggestion_id|. Asynchronous if cache or network is queried.
  virtual void FetchContextualSuggestionImage(
      const ntp_snippets::ContentSuggestion::ID& suggestion_id,
      const GURL& url,
      ntp_snippets::ImageFetchedCallback callback);

  void FetchDone(const GURL& url,
                 FetchClustersCallback callback,
                 ReportFetchMetricsCallback metrics_callback,
                 ContextualSuggestionsResult result);

  // Used to surface metrics events via chrome://eoc-internals.
  ContextualSuggestionsDebuggingReporter* GetDebuggingReporter();

  // Expose cached results for debugging.
  base::flat_map<GURL, ContextualSuggestionsResult>
  GetAllCachedResultsForDebugging();

  // Clear the cached results for debugging.
  void ClearCachedResultsForDebugging();

  std::unique_ptr<ContextualContentSuggestionsServiceProxy> CreateProxy();

 private:
  void BelowConfidenceThresholdFetchDone(
      FetchClustersCallback callback,
      ReportFetchMetricsCallback metrics_callback);
  // Cache for images of contextual suggestions, needed by CachedImageFetcher.
  std::unique_ptr<ntp_snippets::RemoteSuggestionsDatabase>
      contextual_suggestions_database_;

  // Cache of contextual suggestions fetch results, keyed by the context url.
  ContextualSuggestionsCache fetch_cache_;

  // Performs actual network request to fetch contextual suggestions.
  std::unique_ptr<ContextualSuggestionsFetcher> contextual_suggestions_fetcher_;

  std::unique_ptr<ntp_snippets::CachedImageFetcher> image_fetcher_;

  std::unique_ptr<contextual_suggestions::ContextualSuggestionsReporterProvider>
      reporter_provider_;

  // Look up by ContentSuggestion::ID::id_within_category() aka std::string to
  // get image URL.
  std::map<std::string, GURL> image_url_by_id_;

  DISALLOW_COPY_AND_ASSIGN(ContextualContentSuggestionsService);
};

}  // namespace contextual_suggestions

#endif  // COMPONENTS_NTP_SNIPPETS_CONTEXTUAL_REPORTING_CONTEXTUAL_CONTENT_SUGGESTIONS_SERVICE_H_