File: zero_suggest_cache_service.h

package info (click to toggle)
chromium 139.0.7258.138-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,120,676 kB
  • sloc: cpp: 35,100,869; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (68 lines) | stat: -rw-r--r-- 2,760 bytes parent folder | download | duplicates (6)
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
// 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.

#ifndef COMPONENTS_OMNIBOX_BROWSER_ZERO_SUGGEST_CACHE_SERVICE_H_
#define COMPONENTS_OMNIBOX_BROWSER_ZERO_SUGGEST_CACHE_SERVICE_H_

#include <memory>
#include <string>

#include "base/containers/lru_cache.h"
#include "base/observer_list.h"
#include "base/observer_list_types.h"
#include "build/build_config.h"
#include "components/keyed_service/core/keyed_service.h"
#include "components/omnibox/browser/search_suggestion_parser.h"
#include "components/omnibox/common/zero_suggest_cache_service_interface.h"
#include "components/prefs/pref_service.h"

class AutocompleteSchemeClassifier;

class ZeroSuggestCacheService : public ZeroSuggestCacheServiceInterface,
                                public KeyedService {
 public:
  ZeroSuggestCacheService(
      std::unique_ptr<AutocompleteSchemeClassifier> scheme_classifier,
      PrefService* prefs,
      size_t cache_size);

  ZeroSuggestCacheService(const ZeroSuggestCacheService&) = delete;
  ZeroSuggestCacheService& operator=(const ZeroSuggestCacheService&) = delete;

  ~ZeroSuggestCacheService() override;

  // Read/write zero suggest cache entries.
  CacheEntry ReadZeroSuggestResponse(const std::string& page_url) const;
  void StoreZeroSuggestResponse(const std::string& page_url,
                                const std::string& response_json);

  // Remove all zero suggest cache entries.
  void ClearCache();

  // Returns whether or not the in-memory zero suggest cache is empty.
  bool IsInMemoryCacheEmptyForTesting() const;

  // ZeroSuggestCacheServiceInterface:
  std::vector<ZeroSuggestCacheServiceInterface::CacheEntrySuggestResult>
  GetSuggestResults(const ZeroSuggestCacheServiceInterface::CacheEntry&
                        cache_entry) const override;
  void AddObserver(Observer* observer) override;
  void RemoveObserver(Observer* observer) override;

 private:
  std::unique_ptr<AutocompleteSchemeClassifier> scheme_classifier_;
  // Pref service used for in-memory cache data persistence. Not owned.
  const raw_ptr<PrefService> prefs_;
  // Cache mapping each page URL to the corresponding zero suggest response
  // (serialized JSON). |mutable| is used here because reading from the cache,
  // while logically const, will actually modify the internal recency list of
  // the HashingLRUCache object.
  mutable base::HashingLRUCache<std::string, CacheEntry> cache_;
  // Dedicated cache entry for "ZPS on NTP" data in order to minimize any
  // negative impact due to cache eviction policy.
  CacheEntry ntp_entry_;
  base::ObserverList<Observer> observers_;
};

#endif  // COMPONENTS_OMNIBOX_BROWSER_ZERO_SUGGEST_CACHE_SERVICE_H_