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

content / browser / interest_group / storage_interest_group.h [blame]

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

#ifndef CONTENT_BROWSER_INTEREST_GROUP_STORAGE_INTEREST_GROUP_H_
#define CONTENT_BROWSER_INTEREST_GROUP_STORAGE_INTEREST_GROUP_H_

#include <optional>
#include <vector>

#include "base/time/time.h"
#include "content/common/content_export.h"
#include "content/services/auction_worklet/public/mojom/bidder_worklet.mojom.h"
#include "mojo/public/cpp/bindings/struct_ptr.h"
#include "third_party/blink/public/common/interest_group/interest_group.h"
#include "url/origin.h"

namespace content {

// StorageInterestGroup contains both the auction worklet's Bidding interest
// group as well as several fields that are used by the browser process during
// an auction but are not needed by or should not be sent to the worklet
// process.
struct CONTENT_EXPORT StorageInterestGroup {
  StorageInterestGroup();
  StorageInterestGroup(StorageInterestGroup&&);
  StorageInterestGroup& operator=(StorageInterestGroup&&) = default;
  ~StorageInterestGroup();

  blink::InterestGroup interest_group;
  blink::mojom::BiddingBrowserSignalsPtr bidding_browser_signals;

  // Hashed k-anonymous keys.
  base::flat_set<std::string> hashed_kanon_keys;

  // Top level page origin from when the interest group was joined.
  url::Origin joining_origin;
  // Most recent time the interest group was joined. Stored in database as
  // `exact_join_time`.
  base::Time join_time;
  // The last time this interest group was updated.
  base::Time last_updated;
  // The time when the browser will permit updating this interest group.
  base::Time next_update_after;
  // The last time the k-anon values were updated.
  base::Time last_k_anon_updated;
};

enum class DebugReportCooldownType {
  kShortCooldown = 0,
  kRestrictedCooldown = 1,

  kMaxValue = kRestrictedCooldown,
};

struct CONTENT_EXPORT DebugReportCooldown {
  base::Time starting_time;
  DebugReportCooldownType type;

  bool operator==(const DebugReportCooldown& other) const = default;
};

struct CONTENT_EXPORT DebugReportLockoutAndCooldowns {
  DebugReportLockoutAndCooldowns();
  DebugReportLockoutAndCooldowns(
      std::optional<base::Time> last_report_sent_time,
      std::map<url::Origin, DebugReportCooldown> debug_report_cooldown_map);
  DebugReportLockoutAndCooldowns(DebugReportLockoutAndCooldowns&);
  DebugReportLockoutAndCooldowns& operator=(DebugReportLockoutAndCooldowns&&) =
      default;
  DebugReportLockoutAndCooldowns(DebugReportLockoutAndCooldowns&&);
  ~DebugReportLockoutAndCooldowns();

  // The last time a forDebuggingOnly report was sent.
  std::optional<base::Time> last_report_sent_time;
  // The key is an ad tech origin, and value is its cooldown of sending
  // forDebuggingOnly reports.
  std::map<url::Origin, DebugReportCooldown> debug_report_cooldown_map = {};
};

// Converts forDebuggingOnly API's cooldown type to its actual cooldown
// duration.
CONTENT_EXPORT std::optional<base::TimeDelta>
ConvertDebugReportCooldownTypeToDuration(DebugReportCooldownType type);

}  // namespace content

#endif  // CONTENT_BROWSER_INTEREST_GROUP_STORAGE_INTEREST_GROUP_H_