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
|
// 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 CHROME_BROWSER_CHROMEOS_CROS_APPS_API_CROS_APPS_API_INFO_H_
#define CHROME_BROWSER_CHROMEOS_CROS_APPS_API_CROS_APPS_API_INFO_H_
#include <functional>
#include <initializer_list>
#include <string_view>
#include <vector>
#include "base/containers/flat_set.h"
#include "base/feature_list.h"
#include "third_party/blink/public/common/runtime_feature_state/runtime_feature_state_context.h"
#include "third_party/blink/public/mojom/runtime_feature_state//runtime_feature.mojom-forward.h"
#include "url/origin.h"
// Identifies ChromeOS Apps APIs. Use this to query systems like API access
// control.
using CrosAppsApiId = blink::mojom::RuntimeFeature;
// CrosAppsApiInfo carries information about a ChromeOS Apps API that's required
// for the rest of ChromeOS Apps system to function.
class CrosAppsApiInfo {
public:
using EnableBlinkRuntimeFeatureFunction =
void (blink::RuntimeFeatureStateContext::*)(bool);
CrosAppsApiInfo(CrosAppsApiId api_id,
EnableBlinkRuntimeFeatureFunction enable_fn);
CrosAppsApiInfo(const CrosAppsApiInfo&) = delete;
CrosAppsApiInfo& operator=(const CrosAppsApiInfo&) = delete;
CrosAppsApiInfo(CrosAppsApiInfo&&);
CrosAppsApiInfo& operator=(CrosAppsApiInfo&&);
~CrosAppsApiInfo();
// `AddAllowlistedOrigins` adds `origins` to the list of origins where the API
// will be enabled.
CrosAppsApiInfo& AddAllowlistedOrigins(
std::initializer_list<std::string_view> origins);
CrosAppsApiInfo& AddAllowlistedOrigins(
const std::vector<url::Origin>& origins);
// `SetRequiredFeatures` sets the list of `base::Feature`s that all need to be
// enabled for the API to be enabled.
//
// If `features` is an empty list (or this method isn't called), it means the
// API isn't gated behind any feature, and will be enabled if other conditions
// match (e.g. the origin is allowlisted).
CrosAppsApiInfo& SetRequiredFeatures(
std::initializer_list<std::reference_wrapper<const base::Feature>>
features);
// Returns the enum that represents this API.
CrosAppsApiId api_id() const { return api_id_; }
// Returns the function that should be called on RuntimeFeatureStateContext to
// enable the Blink runtime feature.
EnableBlinkRuntimeFeatureFunction enable_blink_runtime_feature_fn() const {
return enable_blink_runtime_feature_fn_;
}
// Returns the list of origins that could have access to the API.
const base::flat_set<url::Origin>& allowed_origins() const {
return allowed_origins_;
}
// Returns the list of `base::Feature`s that must all be enabled for the API
// to be enabled.
const std::vector<std::reference_wrapper<const base::Feature>>&
required_features() const {
return required_features_;
}
private:
CrosAppsApiId api_id_;
// TODO(b/309556977): Remove enablement function when Runtime Feature State
// supports a generic SetEnabled() method.
EnableBlinkRuntimeFeatureFunction enable_blink_runtime_feature_fn_;
base::flat_set<url::Origin> allowed_origins_;
std::vector<std::reference_wrapper<const base::Feature>> required_features_;
};
#endif // CHROME_BROWSER_CHROMEOS_CROS_APPS_API_CROS_APPS_API_INFO_H_
|
