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
|
// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_TEST_TEST_BACKGROUND_SYNC_MANAGER_H_
#define CONTENT_TEST_TEST_BACKGROUND_SYNC_MANAGER_H_
#include <stdint.h>
#include <memory>
#include <string>
#include "base/functional/callback_forward.h"
#include "base/memory/ref_counted.h"
#include "base/time/time.h"
#include "content/browser/background_sync/background_sync_manager.h"
#include "content/browser/service_worker/service_worker_registry.h"
namespace url {
class Origin;
} // namespace url
namespace content {
struct BackgroundSyncParameters;
class DevToolsBackgroundServicesContextImpl;
class ServiceWorkerContextWrapper;
class ServiceWorkerVersion;
// A BackgroundSyncManager for use in unit tests. This class provides control
// over internal behavior and state, to allow tests to simulate various
// scenarios. Examples include (but are not limited to):
// - Delaying and corrupting the backend storage.
// - Controlling the firing of service worker onsync events.
// - Setting the network state
class TestBackgroundSyncManager : public BackgroundSyncManager {
public:
using DispatchSyncCallback =
base::RepeatingCallback<void(scoped_refptr<ServiceWorkerVersion>,
ServiceWorkerVersion::StatusCallback)>;
TestBackgroundSyncManager(
scoped_refptr<ServiceWorkerContextWrapper> service_worker_context,
DevToolsBackgroundServicesContextImpl& devtools_context);
TestBackgroundSyncManager(const TestBackgroundSyncManager&) = delete;
TestBackgroundSyncManager& operator=(const TestBackgroundSyncManager&) =
delete;
~TestBackgroundSyncManager() override;
// Force a call to the internal Init() method.
void DoInit();
// Resume any delayed backend operation.
void ResumeBackendOperation();
// Clear the delayed task if it exists. Delayed tasks are tasks posted with a
// delay to trigger the BackgroundSyncManager to try firing its sync events
// again.
void ClearDelayedTask();
// Determine whether backend operations succeed or fail due to
// corruption.
void set_corrupt_backend(bool corrupt_backend) {
corrupt_backend_ = corrupt_backend;
}
// Delay backend operations until explicitly resumed by calling
// ResumeBackendOperation().
void set_delay_backend(bool delay_backend) { delay_backend_ = delay_backend; }
// Set a callback for when the sync event is dispatched, so tests can observe
// when the event happens.
void set_dispatch_sync_callback(const DispatchSyncCallback& callback) {
dispatch_sync_callback_ = callback;
}
// Set a callback for when the periodicSync event is dispatched, so tests can
// observe it.
void set_dispatch_periodic_sync_callback(
const DispatchSyncCallback& callback) {
dispatch_periodic_sync_callback_ = callback;
}
// Sets the response to checks for a main frame for register attempts.
void set_has_main_frame_window_client(bool value) {
has_main_frame_window_client_ = value;
}
// Accessors to internal state
bool last_chance() const { return last_chance_; }
const BackgroundSyncParameters* background_sync_parameters() const {
return parameters_.get();
}
void DispatchPeriodicSyncEvent(
const std::string& tag,
scoped_refptr<ServiceWorkerVersion> active_version,
ServiceWorkerVersion::StatusCallback callback) override;
// Override to allow the test to cache the result.
base::TimeDelta GetSoonestWakeupDelta(
blink::mojom::BackgroundSyncType sync_type,
base::Time last_browser_wakeup_for_periodic_sync) override;
// Override to do not fire any sync events when firing is disabled.
void FireReadyEvents(blink::mojom::BackgroundSyncType sync_type,
bool reschedule,
base::OnceClosure callback,
std::unique_ptr<BackgroundSyncEventKeepAlive> keepalive =
nullptr) override;
void SuspendFiringEvents() { dont_fire_sync_events_ = true; }
void ResumeFiringEvents() { dont_fire_sync_events_ = false; }
protected:
// Override to allow delays to be injected by tests.
void StoreDataInBackend(
int64_t sw_registration_id,
const url::Origin& origin,
const std::string& key,
const std::string& data,
ServiceWorkerRegistry::StatusCallback callback) override;
// Override to allow delays to be injected by tests.
void GetDataFromBackend(
const std::string& key,
ServiceWorkerRegistry::GetUserDataForAllRegistrationsCallback callback)
override;
// Override to avoid actual dispatching of the event, just call the provided
// callback instead.
void DispatchSyncEvent(
const std::string& tag,
scoped_refptr<ServiceWorkerVersion> active_version,
bool last_chance,
ServiceWorkerVersion::StatusCallback callback) override;
// Override to avoid actual check for main frame, instead return the value set
// by tests.
void HasMainFrameWindowClient(const blink::StorageKey& key,
BoolCallback callback) override;
private:
// Callback to resume the StoreDataInBackend operation, after explicit
// delays injected by tests.
void StoreDataInBackendContinue(
int64_t sw_registration_id,
const url::Origin& origin,
const std::string& key,
const std::string& data,
ServiceWorkerRegistry::StatusCallback callback);
// Callback to resume the GetDataFromBackend operation, after explicit delays
// injected by tests.
void GetDataFromBackendContinue(
const std::string& key,
ServiceWorkerRegistry::GetUserDataForAllRegistrationsCallback callback);
bool corrupt_backend_ = false;
bool delay_backend_ = false;
bool has_main_frame_window_client_ = true;
bool last_chance_ = false;
bool dont_fire_sync_events_ = false;
base::OnceClosure continuation_;
DispatchSyncCallback dispatch_sync_callback_;
DispatchSyncCallback dispatch_periodic_sync_callback_;
base::TimeDelta soonest_one_shot_sync_wakeup_delta_;
base::TimeDelta soonest_periodic_sync_wakeup_delta_;
};
} // namespace content
#endif // CONTENT_TEST_TEST_BACKGROUND_SYNC_MANAGER_H_
|
