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 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
|
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/services/app_service/public/cpp/app_registry_cache.h"
#include <optional>
#include <string_view>
#include <utility>
#include "base/containers/contains.h"
#include "base/observer_list.h"
#include "base/sequence_checker.h"
#include "components/services/app_service/public/cpp/app.h"
#include "components/services/app_service/public/cpp/app_registry_cache_wrapper.h"
#include "components/services/app_service/public/cpp/app_update.h"
#include "components/services/app_service/public/cpp/types_util.h"
namespace apps {
AppRegistryCache::Observer::Observer() = default;
AppRegistryCache::Observer::~Observer() {
CHECK(!IsInObserverList());
}
AppRegistryCache::AppRegistryCache() : account_id_(EmptyAccountId()) {}
AppRegistryCache::~AppRegistryCache() {
for (auto& obs : observers_) {
obs.OnAppRegistryCacheWillBeDestroyed(this);
}
DCHECK(observers_.empty());
AppRegistryCacheWrapper::Get().RemoveAppRegistryCache(this);
}
void AppRegistryCache::AddObserver(Observer* observer) {
DCHECK(observer);
observers_.AddObserver(observer);
}
void AppRegistryCache::RemoveObserver(Observer* observer) {
observers_.RemoveObserver(observer);
}
AppType AppRegistryCache::GetAppType(const std::string& app_id) {
DCHECK_CALLED_ON_VALID_SEQUENCE(my_sequence_checker_);
auto d_iter = deltas_in_progress_.find(app_id);
if (d_iter != deltas_in_progress_.end()) {
return d_iter->second->app_type;
}
auto s_iter = states_.find(app_id);
return (s_iter != states_.end()) ? s_iter->second->app_type
: AppType::kUnknown;
}
std::vector<AppPtr> AppRegistryCache::GetAllApps() {
DCHECK_CALLED_ON_VALID_SEQUENCE(my_sequence_checker_);
std::vector<AppPtr> apps;
for (const auto& s_iter : states_) {
const App* state = s_iter.second.get();
apps.push_back(state->Clone());
auto d_iter = deltas_in_progress_.find(s_iter.first);
const App* delta =
(d_iter != deltas_in_progress_.end()) ? d_iter->second : nullptr;
AppUpdate::Merge(apps[apps.size() - 1].get(), delta);
}
for (const auto& d_iter : deltas_in_progress_) {
if (!base::Contains(states_, d_iter.first)) {
// Call AppUpdate::Merge to set the init value for the icon key's
// `update_version` to keep the consistency as AppRegistryCache's
// `states_`.
auto app =
std::make_unique<App>(d_iter.second->app_type, d_iter.second->app_id);
AppUpdate::Merge(app.get(), d_iter.second);
apps.push_back(std::move(app));
}
}
return apps;
}
void AppRegistryCache::SetAccountId(const AccountId& account_id) {
account_id_ = account_id;
}
const std::set<AppType>& AppRegistryCache::InitializedAppTypes() const {
return initialized_app_types_;
}
bool AppRegistryCache::IsAppTypeInitialized(apps::AppType app_type) const {
return base::Contains(initialized_app_types_, app_type);
}
bool AppRegistryCache::IsAppTypePublished(apps::AppType app_type) const {
return base::Contains(published_app_types_, app_type);
}
bool AppRegistryCache::IsAppInstalled(const std::string& app_id) const {
bool installed = false;
ForOneApp(app_id, [&installed](const AppUpdate& update) {
installed = apps_util::IsInstalled(update.Readiness());
});
return installed;
}
void AppRegistryCache::ReinitializeForTesting() {
states_.clear();
deltas_in_progress_.clear();
deltas_pending_.clear();
in_progress_initialized_app_types_.clear();
published_app_types_.clear();
// We can't clear initialized_app_types_ here as observers
// expect each type to be initialized only once.
}
void AppRegistryCache::OnAppsForTesting(std::vector<AppPtr> deltas,
apps::AppType app_type,
bool should_notify_initialized) {
OnApps(std::move(deltas), app_type, should_notify_initialized);
}
void AppRegistryCache::OnApps(std::vector<AppPtr> deltas,
apps::AppType app_type,
bool should_notify_initialized) {
DCHECK_CALLED_ON_VALID_SEQUENCE(my_sequence_checker_);
if (should_notify_initialized) {
DCHECK_NE(apps::AppType::kUnknown, app_type);
if (!IsAppTypePublished(app_type)) {
published_app_types_.insert(app_type);
for (auto& obs : observers_) {
obs.OnAppTypePublishing(deltas, app_type);
}
}
if (!IsAppTypeInitialized(app_type)) {
in_progress_initialized_app_types_.insert(app_type);
}
}
OnApps(std::move(deltas));
}
void AppRegistryCache::OnApps(std::vector<AppPtr> deltas) {
if (!deltas_in_progress_.empty()) {
std::move(deltas.begin(), deltas.end(),
std::back_inserter(deltas_pending_));
return;
}
DoOnApps(std::move(deltas));
while (!deltas_pending_.empty()) {
std::vector<AppPtr> pending;
pending.swap(deltas_pending_);
DoOnApps(std::move(pending));
}
OnAppTypeInitialized();
}
void AppRegistryCache::DoOnApps(std::vector<AppPtr> deltas) {
// Merge any deltas elements that have the same app_id. If an observer's
// OnAppUpdate calls back into this AppRegistryCache then we can therefore
// present a single delta for any given app_id.
bool is_pending = false;
for (auto& delta : deltas) {
if (is_pending) {
deltas_pending_.push_back(std::move(delta));
continue;
}
if (delta->readiness == Readiness::kRemoved) {
// As soon as we see a removed update, we need to defer future merges to
// avoid cases where a removed update is merged with a future non-removed
// update.
//
// For example, for below apps deltas:
// 1. {App1: ready}
// 2. {App1: uninstalled, App1: removed}
// 3. {App1: disabled by policy, App2: ready}
//
// The expected result for OnAppUpdate is:
// {App1: ready}
// {App1: uninstalled}
// Then App1 is removed in AppRegistry, GetAppType returns kUnknown.
// {App1: is added as disabled by policy}
// {App2: ready}
is_pending = true;
}
auto d_iter = deltas_in_progress_.find(delta->app_id);
if (d_iter != deltas_in_progress_.end()) {
if (delta->readiness == Readiness::kRemoved) {
// Ensure that removed deltas are *not* merged, so that the last update
// before the merge is sent separately.
deltas_pending_.push_back(std::move(delta));
} else {
// Call AppUpdate::MergeDelta to merge the icon key's `update_version`.
AppUpdate::MergeDelta(d_iter->second, delta.get());
}
} else {
deltas_in_progress_[delta->app_id] = delta.get();
}
}
// The remaining for loops range over the deltas_in_progress_ map, not
// the deltas vector, so that OnAppUpdate is called only once per unique
// app_id.
// Notify the observers for every de-duplicated delta.
for (const auto& d_iter : deltas_in_progress_) {
// Do not update subscribers for removed apps.
if (d_iter.second->readiness == Readiness::kRemoved) {
continue;
}
auto s_iter = states_.find(d_iter.first);
App* state = (s_iter != states_.end()) ? s_iter->second.get() : nullptr;
App* delta = d_iter.second;
// Skip OnAppUpdate if there is no change.
if (!AppUpdate::IsChanged(state, delta)) {
continue;
}
for (auto& obs : observers_) {
obs.OnAppUpdate(AppUpdate(state, delta, account_id_));
}
}
// Update the states for every de-duplicated delta.
for (const auto& d_iter : deltas_in_progress_) {
auto s_iter = states_.find(d_iter.first);
apps::App* state =
(s_iter != states_.end()) ? s_iter->second.get() : nullptr;
apps::App* delta = d_iter.second;
if (delta->readiness != Readiness::kRemoved) {
if (state) {
AppUpdate::Merge(state, delta);
} else {
// Call AppUpdate::Merge to set the init value for the icon key's
// `update_version`.
auto app = std::make_unique<App>(delta->app_type, delta->app_id);
AppUpdate::Merge(app.get(), delta);
states_.insert(std::make_pair(delta->app_id, std::move(app)));
}
} else {
DCHECK(!state || state->readiness != Readiness::kReady);
states_.erase(d_iter.first);
}
}
deltas_in_progress_.clear();
}
void AppRegistryCache::InitApps(apps::AppType app_type) {
DCHECK_CALLED_ON_VALID_SEQUENCE(my_sequence_checker_);
CHECK_NE(apps::AppType::kUnknown, app_type);
if (!IsAppTypeInitialized(app_type)) {
in_progress_initialized_app_types_.insert(app_type);
}
OnAppTypeInitialized();
}
void AppRegistryCache::OnAppTypeInitialized() {
if (in_progress_initialized_app_types_.empty()) {
return;
}
// In observer's OnAppTypeInitialized callback, `OnApp` might be called to
// update the app, then this OnAppTypeInitialized might be called again. So we
// need to check the initialized `app_type` first, and remove it from
// `in_progress_initialized_app_types_` to prevent the dead loop.
std::set<AppType> in_progress_initialized_app_types;
for (auto app_type : in_progress_initialized_app_types_) {
in_progress_initialized_app_types.insert(app_type);
}
for (auto app_type : in_progress_initialized_app_types) {
in_progress_initialized_app_types_.erase(app_type);
initialized_app_types_.insert(app_type);
for (auto& obs : observers_) {
obs.OnAppTypeInitialized(app_type);
}
}
}
std::optional<AppUpdate> AppRegistryCache::GetAppUpdate(
std::string_view app_id) const {
DCHECK_CALLED_ON_VALID_SEQUENCE(my_sequence_checker_);
auto s_iter = states_.find(app_id);
const App* state = (s_iter != states_.end()) ? s_iter->second.get() : nullptr;
auto d_iter = deltas_in_progress_.find(app_id);
const App* delta =
(d_iter != deltas_in_progress_.end()) ? d_iter->second : nullptr;
if (state || delta) {
return AppUpdate(state, delta, account_id_);
}
return std::nullopt;
}
} // namespace apps
|