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
|
// Copyright 2025 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_WEB_APPLICATIONS_COMMANDS_MANIFEST_SILENT_UPDATE_COMMAND_H_
#define CHROME_BROWSER_WEB_APPLICATIONS_COMMANDS_MANIFEST_SILENT_UPDATE_COMMAND_H_
#include "base/functional/callback_forward.h"
#include "chrome/browser/web_applications/commands/web_app_command.h"
#include "chrome/browser/web_applications/locks/app_lock.h"
#include "chrome/browser/web_applications/locks/noop_lock.h"
#include "chrome/browser/web_applications/manifest_update_utils.h"
#include "chrome/browser/web_applications/web_contents/web_app_data_retriever.h"
class GURL;
namespace content {
class WebContents;
} // namespace content
namespace web_app {
// Not actually used in production logic. This is just for debugging output.
enum class ManifestSilentUpdateCommandStage {
kFetchingNewManifestData,
kLoadingExistingManifestData,
kAcquiringAppLock,
kComparingNonSecuritySensitiveManifestData,
kFinalizingSilentManifestChanges,
kCompleteCommand,
};
// This enum is recorded by UMA, the numeric values must not change.
enum class ManifestSilentUpdateCheckResult {
kAppNotInstalled = 0,
kAppUpdateFailedDuringInstall = 1,
kSystemShutdown = 2,
kAppSilentlyUpdated = 3,
kAppUpToDate = 4,
kIconReadFromDiskFailed = 5,
kWebContentsDestroyed = 6,
kMaxValue = kWebContentsDestroyed,
};
struct WebAppInstallInfo;
// Documentation: docs/webapps/manifest_update_process.md
//
// Checks whether the installed web app associated with a given WebContents has
// out of date manifest data and what to update it to.
//
// High level procedure for this command:
// - Download new manifest data from site.
// - Load existing manifest data from disk including external resources.
// - Diff the non-security sensitive manifest data. This includes all fields of
// the manifest excluding icons and app name.
// - Update non-security sensitive fields silently.
// - Choose two golden icons (one each from the new and existing manifest).
// - Compare their icon's URL which determines a silent update of the icon (<10%
// image diff) or store it as a PendingUpdateInfo (>10% image diff).
// - Finalize silent update of icon (if needed) and destroy command.
class ManifestSilentUpdateCommand
: public WebAppCommand<NoopLock, ManifestSilentUpdateCheckResult>,
public content::WebContentsObserver {
public:
using CompletedCallback =
base::OnceCallback<void(ManifestSilentUpdateCheckResult check_result)>;
ManifestSilentUpdateCommand(
const GURL& url,
base::WeakPtr<content::WebContents> web_contents,
CompletedCallback callback,
std::unique_ptr<WebAppDataRetriever> data_retriever,
std::unique_ptr<WebAppIconDownloader> icon_downloader);
~ManifestSilentUpdateCommand() override;
protected:
// WebAppCommand:
void StartWithLock(std::unique_ptr<NoopLock> lock) override;
private:
// Stage: Starting to fetch new manifest data
// (ManifestSilentUpdateCommandStage::kFetchingNewManifestData).
void StashNewManifestJson(blink::mojom::ManifestPtr opt_manifest,
bool valid_manifest_for_web_app,
webapps::InstallableStatusCode installable_status);
void ValidateNewScopeExtensions();
void StashValidatedScopeExtensions(
ScopeExtensions validated_scope_extensions);
// Stage: Loading existing manifest data from disk.
// (ManifestSilentUpdateCommandStage::kLoadingExistingManifestData)
void StashExistingAppIcons(IconBitmaps icon_bitmaps);
void StashExistingShortcutsMenuIconsFinalizeUpdateIfNeeded(
ShortcutsMenuIconBitmaps shortcuts_menu_icon_bitmaps);
// Stage: Compare the manifest data from the new and existing manifests.
// (ManifestSilentUpdateCommandStage::
// kComparingNonSecuritySensitiveManifestData)
void CompareManifestDataForSilentUpdate();
// Stage: Finalize silent changes to web app.
// (ManifestSilentUpdateCommandStage::kFinalizingSilentManifestChanges)
void NonSecuritySensitiveFieldsApplied(const webapps::AppId& app_id,
webapps::InstallResultCode code);
// Stage: Update check complete.
// (ManifestSilentUpdateCommandStage::kCompleteCommand)
void CompleteCommandAndSelfDestruct(
ManifestSilentUpdateCheckResult check_result);
bool IsWebContentsDestroyed();
// Updates NoopLock to an AppLock after retrieving the new manifest data.
void OnAppLockRetrieved();
base::WeakPtr<ManifestSilentUpdateCommand> GetWeakPtr() {
return weak_factory_.GetWeakPtr();
}
// Manifest update check request parameters.
const GURL url_;
webapps::AppId app_id_;
// Resources and helpers used to fetch manifest data.
std::unique_ptr<NoopLock> lock_;
std::unique_ptr<AppLock> app_lock_;
base::WeakPtr<content::WebContents> web_contents_;
std::unique_ptr<WebAppDataRetriever> data_retriever_;
std::unique_ptr<WebAppIconDownloader> icon_downloader_;
// Temporary variables stored here while the update check progresses
// asynchronously.
std::unique_ptr<WebAppInstallInfo> new_install_info_;
IconBitmaps existing_app_icon_bitmaps_;
ShortcutsMenuIconBitmaps existing_shortcuts_menu_icon_bitmaps_;
// Debug info.
ManifestSilentUpdateCommandStage stage_ =
ManifestSilentUpdateCommandStage::kFetchingNewManifestData;
base::WeakPtrFactory<ManifestSilentUpdateCommand> weak_factory_{this};
};
} // namespace web_app
#endif // CHROME_BROWSER_WEB_APPLICATIONS_COMMANDS_MANIFEST_SILENT_UPDATE_COMMAND_H_
|
