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 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
|
// Copyright 2017 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_UPDATE_CLIENT_COMPONENT_H_
#define COMPONENTS_UPDATE_CLIENT_COMPONENT_H_
#include <cstdint>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include <vector>
#include "base/files/file_path.h"
#include "base/functional/callback.h"
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ref.h"
#include "base/memory/ref_counted.h"
#include "base/sequence_checker.h"
#include "base/time/time.h"
#include "base/types/expected.h"
#include "base/values.h"
#include "base/version.h"
#include "components/update_client/crx_cache.h"
#include "components/update_client/crx_downloader.h"
#include "components/update_client/pipeline.h"
#include "components/update_client/protocol_parser.h"
#include "components/update_client/update_client.h"
namespace update_client {
class Configurator;
struct CrxUpdateItem;
struct UpdateContext;
// Describes a CRX component managed by the UpdateEngine. Each instance of
// this class is associated with one instance of UpdateContext.
//
// Through the course of the update flow, each Component's state_ will change:
//
// ╔══════════════╗ ┌──────┐
// ║ kUpdateError ║ ← │ kNew │
// ║ ║ └──────┘
// ║ ║ ↓
// ║ ║ ┌───────────┐ ╔═══════════╗
// ║ ║ ← │ kChecking │ → ║ kUpToDate ║
// ║ ║ └───────────┘ ╚═══════════╝
// ║ ║ ↓
// ║ ║ ┌────────────┐
// ║ ║ ← │ kCanUpdate │
// ║ ║ └────────────┘
// ║ ║ ↓
// ║ ║ ┌─────────────────────────────────┐ ╔══════════╗
// ║ ║ ← │ kDownloading ↔ kUpdating → kRun │ → ║ kUpdated ║
// ╚══════════════╝ └─────────────────────────────────┘ ╚══════════╝
//
// Each box in the above diagram corresponds to a specific Component::State.
// Component::State::Updating is responsible for running the kDownloading,
// kUpdating (installing), and kRun actions. The transitions between those
// three substates depends on the pipeline of operations provided by the update
// server and the details of what files are in cache. For example, if the
// installer is already cached, downloading will be skipped. As another example,
// if an installer fails, a fallback installer may be downloaded and run.
//
// When the service is checking for updates only (but not applying them),
// kCanUpdate will transition to kUpdateError.
class Component {
public:
using CallbackHandleComplete = base::OnceCallback<void()>;
Component(const UpdateContext& update_context, const std::string& id);
Component(const Component&) = delete;
Component& operator=(const Component&) = delete;
~Component();
// Handles the current state of the component and makes it transition
// to the next component state before |callback_handle_complete_| is invoked.
void Handle(CallbackHandleComplete callback_handle_complete);
CrxUpdateItem GetCrxUpdateItem() const;
// Called by the UpdateEngine when an update check for this component is done.
void SetUpdateCheckResult(std::optional<ProtocolParser::App> result,
ErrorCategory error_category,
int error,
base::OnceCallback<void(bool)> callback);
// Called by the UpdateEngine when a component enters a wait for throttling
// purposes.
void NotifyWait();
// Returns true if the component has reached a final state and no further
// handling and state transitions are possible.
bool IsHandled() const { return is_handled_; }
// Returns true if an update is available for this component, meaning that
// the update server has return a response containing an update.
bool IsUpdateAvailable() const { return is_update_available_; }
void Cancel() { state_->Cancel(); }
base::TimeDelta GetUpdateDuration() const;
ComponentState state() const { return state_->state(); }
std::string id() const { return id_; }
const std::optional<CrxComponent>& crx_component() const {
return crx_component_;
}
void set_crx_component(const CrxComponent& crx_component) {
crx_component_ = crx_component;
}
const base::Version& previous_version() const { return previous_version_; }
void set_previous_version(const base::Version& previous_version) {
previous_version_ = previous_version;
}
const base::Version& next_version() const { return next_version_; }
std::string previous_fp() const { return previous_fp_; }
void set_previous_fp(const std::string& previous_fp) {
previous_fp_ = previous_fp;
}
std::string next_fp() const { return next_fp_; }
void set_next_fp(const std::string& next_fp) { next_fp_ = next_fp; }
bool is_foreground() const;
ErrorCategory error_category() const { return error_category_; }
int error_code() const { return error_code_; }
int extra_code1() const { return extra_code1_; }
scoped_refptr<Configurator> config() const;
std::string session_id() const;
const std::vector<base::Value::Dict>& events() const { return events_; }
// Returns a clone of the component events.
std::vector<base::Value::Dict> GetEvents() const;
void AppendEvent(base::Value::Dict event);
private:
friend class MockPingManagerImpl;
friend class UpdateCheckerTest;
FRIEND_TEST_ALL_PREFIXES(PingManagerTest, SendPing);
FRIEND_TEST_ALL_PREFIXES(PingManagerTest, RequiresEncryption);
FRIEND_TEST_ALL_PREFIXES(UpdateCheckerTest, NoUpdateActionRun);
FRIEND_TEST_ALL_PREFIXES(UpdateCheckerTest, UpdateCheckCupError);
FRIEND_TEST_ALL_PREFIXES(UpdateCheckerTest, UpdateCheckError);
FRIEND_TEST_ALL_PREFIXES(UpdateCheckerTest, UpdateCheckInvalidAp);
FRIEND_TEST_ALL_PREFIXES(UpdateCheckerTest,
UpdateCheckRequiresEncryptionError);
FRIEND_TEST_ALL_PREFIXES(UpdateCheckerTest, UpdateCheckSuccess);
FRIEND_TEST_ALL_PREFIXES(UpdateCheckerTest, UpdateCheckUpdateDisabled);
// Describes an abstraction for implementing the behavior of a component and
// the transition from one state to another.
class State {
public:
using CallbackNextState =
base::OnceCallback<void(std::unique_ptr<State> next_state)>;
State(Component* component, ComponentState state);
virtual ~State();
// Handles the current state and initiates a transition to a new state.
// The transition to the new state is non-blocking and it is completed
// by the outer component, after the current state is fully handled.
void Handle(CallbackNextState callback);
ComponentState state() const { return state_; }
void Cancel() {
if (cancel_callback_) {
std::move(cancel_callback_).Run();
}
}
protected:
// Initiates the transition to the new state.
void TransitionState(std::unique_ptr<State> new_state);
// Makes the current state a final state where no other state transition
// can further occur.
void EndState();
Component& component() { return *component_; }
const Component& component() const { return *component_; }
SEQUENCE_CHECKER(sequence_checker_);
const ComponentState state_;
base::OnceClosure cancel_callback_;
private:
virtual void DoHandle() = 0;
const raw_ref<Component> component_;
CallbackNextState callback_next_state_;
};
class StateNew : public State {
public:
explicit StateNew(Component* component);
StateNew(const StateNew&) = delete;
StateNew& operator=(const StateNew&) = delete;
~StateNew() override;
private:
// State overrides.
void DoHandle() override;
};
class StateChecking : public State {
public:
explicit StateChecking(Component* component);
StateChecking(const StateChecking&) = delete;
StateChecking& operator=(const StateChecking&) = delete;
~StateChecking() override;
private:
// State overrides.
void DoHandle() override;
};
class StateUpdateError : public State {
public:
explicit StateUpdateError(Component* component);
StateUpdateError(const StateUpdateError&) = delete;
StateUpdateError& operator=(const StateUpdateError&) = delete;
~StateUpdateError() override;
private:
// State overrides.
void DoHandle() override;
};
class StateCanUpdate : public State {
public:
explicit StateCanUpdate(Component* component);
StateCanUpdate(const StateCanUpdate&) = delete;
StateCanUpdate& operator=(const StateCanUpdate&) = delete;
~StateCanUpdate() override;
private:
// State overrides.
void DoHandle() override;
bool CanTryDiffUpdate() const;
void GetNextCrxFromCacheComplete(
base::expected<base::FilePath, UnpackerError> result);
void CheckIfCacheContainsPreviousCrxComplete(
base::expected<base::FilePath, UnpackerError> result);
};
class StateUpToDate : public State {
public:
explicit StateUpToDate(Component* component);
StateUpToDate(const StateUpToDate&) = delete;
StateUpToDate& operator=(const StateUpToDate&) = delete;
~StateUpToDate() override;
private:
// State overrides.
void DoHandle() override;
};
class StateUpdating : public State {
public:
explicit StateUpdating(Component* component);
StateUpdating(const StateUpdating&) = delete;
StateUpdating& operator=(const StateUpdating&) = delete;
~StateUpdating() override;
private:
// State overrides.
void DoHandle() override;
void PipelineComplete(const CategorizedError& result);
};
class StateUpdated : public State {
public:
explicit StateUpdated(Component* component);
StateUpdated(const StateUpdated&) = delete;
StateUpdated& operator=(const StateUpdated&) = delete;
~StateUpdated() override;
private:
// State overrides.
void DoHandle() override;
};
// Returns true is the update payload for this component can be downloaded
// by a downloader which can do bandwidth throttling on the client side.
// The decision may be predicated on the expected size of the download.
bool CanDoBackgroundDownload(int64_t size) const;
// Changes the component state and notifies the caller of the |Handle|
// function that the handling of this component state is complete.
void ChangeState(std::unique_ptr<State> next_state);
// Notifies registered observers about changes in the state of the component.
// If an UpdateClient::CrxStateChangeCallback is provided as an argument to
// UpdateClient::Install or UpdateClient::Update function calls, then the
// callback is invoked as well.
void NotifyObservers() const;
// These functions return a specific event. Each data member of the event is
// represented as a key-value pair in a dictionary value.
base::Value::Dict MakeEventUpdateComplete() const;
base::Value::Dict MakeEventDownloadMetrics(
const CrxDownloader::DownloadMetrics& download_metrics) const;
base::Value::Dict MakeEventActionRun(bool succeeded,
int error_code,
int extra_code1) const;
std::unique_ptr<CrxInstaller::InstallParams> install_params() const;
SEQUENCE_CHECKER(sequence_checker_);
const std::string id_;
std::optional<CrxComponent> crx_component_;
// The update pipeline.
base::expected<PipelineStartCallback, CategorizedError> pipeline_;
// Time when an update check for this CRX has happened.
base::TimeTicks last_check_;
// Time when the update of this CRX has begun.
base::TimeTicks update_begin_;
// The from/to version and fingerprint values.
base::Version previous_version_;
base::Version next_version_;
std::string previous_fp_;
std::string next_fp_;
// True if the update check response for this component includes an update.
bool is_update_available_ = false;
// The error reported by the update checker.
int update_check_error_ = 0;
base::FilePath payload_path_;
// The byte counts below are valid for the current url being fetched.
// |total_bytes| is equal to the size of the CRX file and |downloaded_bytes|
// represents how much has been downloaded up to that point. A value of -1
// means that the byte count is unknown.
int64_t downloaded_bytes_ = -1;
int64_t total_bytes_ = -1;
// Install progress, in the range of [0, 100]. A value of -1 means that the
// progress is unknown.
int install_progress_ = -1;
// The error information for full and differential updates.
// The |error_category| contains a hint about which module in the component
// updater generated the error. The |error_code| constains the error and
// the |extra_code1| usually contains a system error, but it can contain
// any extended information that is relevant to either the category or the
// error itself.
// The `installer_result_` contains the value provided by the `CrxInstaller`
// instance when the install completes.
ErrorCategory error_category_ = ErrorCategory::kNone;
int error_code_ = 0;
int extra_code1_ = 0;
std::optional<CrxInstaller::Result> installer_result_;
// Contains app-specific custom response attributes from the server, sent in
// the last update check.
std::map<std::string, std::string> custom_attrs_;
// Contains the optional install parameters from the update response.
std::optional<CrxInstaller::InstallParams> install_params_;
// Contains the events which are therefore serialized in the requests.
std::vector<base::Value::Dict> events_;
CallbackHandleComplete callback_handle_complete_;
std::unique_ptr<State> state_;
const raw_ref<const UpdateContext> update_context_;
// Some `State` classes map to multiple `ComponentState` values - in those
// cases, state_hint_ indicates which ComponentState the State is currently
// processing.
ComponentState state_hint_ = ComponentState::kNew;
// True if this component has reached a final state because all its states
// have been handled.
bool is_handled_ = false;
};
using IdToComponentPtrMap = std::map<std::string, std::unique_ptr<Component>>;
} // namespace update_client
#endif // COMPONENTS_UPDATE_CLIENT_COMPONENT_H_
|