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
|
// Copyright 2023 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_OPTIMIZATION_GUIDE_CORE_HINTS_OPTIMIZATION_GUIDE_DECIDER_H_
#define COMPONENTS_OPTIMIZATION_GUIDE_CORE_HINTS_OPTIMIZATION_GUIDE_DECIDER_H_
#include <vector>
#include "base/containers/flat_set.h"
#include "base/functional/callback_forward.h"
#include "components/optimization_guide/core/hints/optimization_guide_decision.h"
#include "components/optimization_guide/proto/common_types.pb.h"
#include "components/optimization_guide/proto/hints.pb.h"
class GURL;
namespace commerce {
class ShoppingService;
} // namespace commerce
namespace page_image_service {
class ImageServiceImpl;
} // namespace page_image_service
namespace optimization_guide {
class OptimizationGuideDecider {
public:
// Registers the optimization types that intend to be queried during the
// session. It is expected for this to be called after the browser has been
// initialized.
//
// Registering an OptimizationType will cause data for the type to be fetched
// and cached on each page load.
virtual void RegisterOptimizationTypes(
const std::vector<proto::OptimizationType>& optimization_types) = 0;
// Invokes |callback| with the decision for the URL contained in |url| and
// |optimization_type|, when sufficient information has been collected to
// make the decision.
virtual void CanApplyOptimization(
const GURL& url,
proto::OptimizationType optimization_type,
OptimizationGuideDecisionCallback callback) = 0;
// Returns whether |optimization_type| can be applied for |url|. This should
// only be called for main frame navigations or future main frame navigations.
virtual OptimizationGuideDecision CanApplyOptimization(
const GURL& url,
proto::OptimizationType optimization_type,
OptimizationMetadata* optimization_metadata) = 0;
protected:
OptimizationGuideDecider() = default;
virtual ~OptimizationGuideDecider() = default;
private:
// These friend are consumers of the CanApplyOptimizationOnDemand API.
friend class commerce::ShoppingService;
friend class page_image_service::ImageServiceImpl;
// Invokes |callback| with the decision for all types contained in
// |optimization_types| for each URL contained in |urls|, when sufficient
// information has been collected to make decisions. |request_context| must be
// included to indicate when the request is being made to determine the
// appropriate permissions to make the request for accounting purposes.
// Consumers must call `RegisterOptimizationTypes` once during the session
// before calling this method.
//
// It is expected for consumers to consult with the Optimization Guide team
// before using this API. If approved, add your class as a friend class here.
virtual void CanApplyOptimizationOnDemand(
const std::vector<GURL>& urls,
const base::flat_set<proto::OptimizationType>& optimization_types,
proto::RequestContext request_context,
OnDemandOptimizationGuideDecisionRepeatingCallback callback,
std::optional<proto::RequestContextMetadata> request_context_metadata =
std::nullopt) = 0;
};
} // namespace optimization_guide
#endif // COMPONENTS_OPTIMIZATION_GUIDE_CORE_HINTS_OPTIMIZATION_GUIDE_DECIDER_H_
|
