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
|
/*
* Copyright (C) 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.adservices.service.customaudience;
import android.annotation.NonNull;
import android.content.Context;
import com.android.adservices.LogUtil;
import com.android.adservices.concurrency.AdServicesExecutors;
import com.android.adservices.data.customaudience.CustomAudienceDao;
import com.android.adservices.data.customaudience.CustomAudienceDatabase;
import com.android.adservices.data.customaudience.DBCustomAudienceBackgroundFetchData;
import com.android.adservices.service.Flags;
import com.android.adservices.service.FlagsFactory;
import com.android.internal.annotations.VisibleForTesting;
import com.google.common.collect.Lists;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import java.time.Clock;
import java.time.Instant;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
/** Worker instance for updating custom audiences in the background. */
public class BackgroundFetchWorker {
private static final Object SINGLETON_LOCK = new Object();
private static volatile BackgroundFetchWorker sBackgroundFetchWorker;
private final CustomAudienceDao mCustomAudienceDao;
private final Flags mFlags;
private final BackgroundFetchRunner mBackgroundFetchRunner;
private volatile boolean mWorkInProgress;
private volatile boolean mStopWorkRequested;
private CountDownLatch mStopWorkLatch;
@VisibleForTesting
protected BackgroundFetchWorker(
@NonNull CustomAudienceDao customAudienceDao,
@NonNull Flags flags,
@NonNull BackgroundFetchRunner backgroundFetchRunner) {
Objects.requireNonNull(customAudienceDao);
Objects.requireNonNull(flags);
Objects.requireNonNull(backgroundFetchRunner);
mCustomAudienceDao = customAudienceDao;
mFlags = flags;
mBackgroundFetchRunner = backgroundFetchRunner;
mWorkInProgress = false;
mStopWorkRequested = false;
mStopWorkLatch = new CountDownLatch(0);
}
/**
* Gets an instance of a {@link BackgroundFetchWorker}.
*
* <p>If an instance hasn't been initialized, a new singleton will be created and returned.
*/
@NonNull
public static BackgroundFetchWorker getInstance(@NonNull Context context) {
Objects.requireNonNull(context);
if (sBackgroundFetchWorker == null) {
synchronized (SINGLETON_LOCK) {
if (sBackgroundFetchWorker == null) {
CustomAudienceDao customAudienceDao =
CustomAudienceDatabase.getInstance(context).customAudienceDao();
Flags flags = FlagsFactory.getFlags();
sBackgroundFetchWorker =
new BackgroundFetchWorker(
customAudienceDao,
flags,
new BackgroundFetchRunner(customAudienceDao, flags));
}
}
}
return sBackgroundFetchWorker;
}
/**
* Runs the background fetch job for FLEDGE, including garbage collection and updating custom
* audiences.
*
* @param jobStartTime the {@link Instant} that the job was started, marking the beginning of
* the runtime timeout countdown
* @throws InterruptedException if the thread was interrupted while waiting for workers to
* complete their custom audience updates
* @throws ExecutionException if an internal exception was thrown while waiting for custom
* audience updates to complete
* @throws TimeoutException if the job exceeds the configured maximum runtime
*/
public void runBackgroundFetch(@NonNull Instant jobStartTime)
throws InterruptedException, ExecutionException, TimeoutException {
Objects.requireNonNull(jobStartTime);
LogUtil.d("Running FLEDGE background fetch with jobStartTime %s", jobStartTime.toString());
if (mWorkInProgress) {
LogUtil.w("Already running FLEDGE background fetch, skipping call");
return;
}
try {
mWorkInProgress = true;
mStopWorkRequested = false;
// Clean up expired custom audiences first so the actual fetch won't do unnecessary work
mBackgroundFetchRunner.deleteExpiredCustomAudiences(jobStartTime);
if (mStopWorkRequested) {
LogUtil.d("Stopping FLEDGE background fetch");
return;
}
long remainingJobTimeMs =
mFlags.getFledgeBackgroundFetchJobMaxRuntimeMs()
- (Clock.systemUTC().instant().toEpochMilli()
- jobStartTime.toEpochMilli());
if (remainingJobTimeMs <= 0) {
LogUtil.e("Timed out before updating FLEDGE custom audiences");
throw new TimeoutException();
}
// Fetch stale/eligible/delinquent custom audiences
final List<DBCustomAudienceBackgroundFetchData> fetchDataList =
mCustomAudienceDao.getActiveEligibleCustomAudienceBackgroundFetchData(
jobStartTime, mFlags.getFledgeBackgroundFetchMaxNumUpdated());
if (fetchDataList.isEmpty()) {
LogUtil.d("No custom audiences found to update");
return;
} else {
LogUtil.d("Updating %d custom audiences", fetchDataList.size());
}
// Divide the gathered CAs among worker threads
int numWorkers =
Math.min(
Math.max(1, Runtime.getRuntime().availableProcessors() - 2),
mFlags.getFledgeBackgroundFetchThreadPoolSize());
int numCustomAudiencesPerWorker =
(fetchDataList.size() / numWorkers)
+ (((fetchDataList.size() % numWorkers) == 0) ? 0 : 1);
List<ListenableFuture<Void>> subListFutureUpdates = new ArrayList<>();
for (final List<DBCustomAudienceBackgroundFetchData> fetchDataSubList :
Lists.partition(fetchDataList, numCustomAudiencesPerWorker)) {
subListFutureUpdates.add(
AdServicesExecutors.getBackgroundExecutor()
.submit(
() -> {
for (DBCustomAudienceBackgroundFetchData fetchData :
fetchDataSubList) {
if (mStopWorkRequested) {
return null;
}
mBackgroundFetchRunner.updateCustomAudience(
jobStartTime, fetchData);
}
return null;
}));
}
// Wait for all workers to complete within the allotted time
remainingJobTimeMs =
mFlags.getFledgeBackgroundFetchJobMaxRuntimeMs()
- (Clock.systemUTC().instant().toEpochMilli()
- jobStartTime.toEpochMilli());
Futures.allAsList(subListFutureUpdates).get(remainingJobTimeMs, TimeUnit.MILLISECONDS);
} finally {
mStopWorkLatch.countDown();
mWorkInProgress = false;
}
}
/** Requests that any ongoing work be stopped gracefully and waits for work to be stopped. */
public void stopWork() {
LogUtil.d("FLEDGE background fetch stop work requested");
if (!mWorkInProgress) {
LogUtil.d("FLEDGE background fetch not running");
return;
}
if (mStopWorkRequested && mStopWorkLatch.getCount() != 0) {
LogUtil.d("FLEDGE background fetch stop work already requested; waiting for stop");
} else {
mStopWorkLatch = new CountDownLatch(1);
}
mStopWorkRequested = true;
// Wait for work to be stopped so that we keep the wakelock while work is stopping
// Note that onStopJob() has its own timeout that is imposed while waiting for work to stop
try {
mStopWorkLatch.await();
} catch (InterruptedException exception) {
LogUtil.e(
exception, "Interrupt while waiting for FLEDGE background fetch to stop fully");
}
LogUtil.d("FLEDGE background fetch work stopped");
}
}
|
