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
|
/*
* 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;
import static com.android.adservices.service.AdServicesConfig.MAINTENANCE_JOB_ID;
import static com.google.common.util.concurrent.MoreExecutors.directExecutor;
import android.annotation.NonNull;
import android.app.job.JobInfo;
import android.app.job.JobParameters;
import android.app.job.JobScheduler;
import android.app.job.JobService;
import android.content.ComponentName;
import android.content.Context;
import com.android.adservices.LogUtil;
import com.android.adservices.concurrency.AdServicesExecutors;
import com.android.adservices.service.common.FledgeMaintenanceTasksWorker;
import com.android.adservices.service.topics.TopicsWorker;
import com.android.internal.annotations.VisibleForTesting;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import java.util.List;
import java.util.Objects;
/** Maintenance job to clean up. */
public final class MaintenanceJobService extends JobService {
private FledgeMaintenanceTasksWorker mFledgeMaintenanceTasksWorker;
/** Injects a {@link FledgeMaintenanceTasksWorker to be used during testing} */
@VisibleForTesting
public void injectFledgeMaintenanceTasksWorker(
@NonNull FledgeMaintenanceTasksWorker fledgeMaintenanceTasksWorker) {
mFledgeMaintenanceTasksWorker = fledgeMaintenanceTasksWorker;
}
@Override
public boolean onStartJob(JobParameters params) {
LogUtil.d("MaintenanceJobService.onStartJob");
if (FlagsFactory.getFlags().getTopicsKillSwitch()
&& FlagsFactory.getFlags().getFledgeSelectAdsKillSwitch()) {
LogUtil.e(
"Both Topics and Select Ads are disabled, skipping and cancelling"
+ " MaintenanceJobService");
return skipAndCancelBackgroundJob(params);
}
ListenableFuture<Void> appReconciliationFuture;
if (FlagsFactory.getFlags().getTopicsKillSwitch()) {
LogUtil.d("Topics API is disabled, skipping Topics Job");
appReconciliationFuture = Futures.immediateFuture(null);
} else {
appReconciliationFuture =
Futures.submit(
() -> TopicsWorker.getInstance(this).reconcileApplicationUpdate(this),
AdServicesExecutors.getBackgroundExecutor());
}
ListenableFuture<Void> fledgeMaintenanceTasksFuture;
if (FlagsFactory.getFlags().getFledgeSelectAdsKillSwitch()) {
LogUtil.d("SelectAds API is disabled, skipping SelectAds Job");
fledgeMaintenanceTasksFuture = Futures.immediateFuture(null);
} else {
fledgeMaintenanceTasksFuture =
Futures.submit(
this::doAdSelectionDataMaintenanceTasks,
AdServicesExecutors.getBackgroundExecutor());
}
ListenableFuture<List<Void>> futuresList =
Futures.allAsList(fledgeMaintenanceTasksFuture, appReconciliationFuture);
Futures.addCallback(
futuresList,
new FutureCallback<List<Void>>() {
@Override
public void onSuccess(List<Void> result) {
LogUtil.d("PP API jobs are done!");
jobFinished(params, /* wantsReschedule = */ false);
}
@Override
public void onFailure(Throwable t) {
LogUtil.e(
t, "Failed to handle MaintenanceJobService: " + params.getJobId());
jobFinished(params, /* wantsReschedule = */ false);
}
},
directExecutor());
return true;
}
@Override
public boolean onStopJob(JobParameters params) {
LogUtil.d("MaintenanceJobService.onStopJob");
return false;
}
@VisibleForTesting
static void schedule(
Context context,
@NonNull JobScheduler jobScheduler,
long maintenanceJobPeriodMs,
long maintenanceJobFlexMs) {
final JobInfo job =
new JobInfo.Builder(
MAINTENANCE_JOB_ID,
new ComponentName(context, MaintenanceJobService.class))
.setRequiresCharging(true)
.setPersisted(true)
.setPeriodic(maintenanceJobPeriodMs, maintenanceJobFlexMs)
.build();
jobScheduler.schedule(job);
LogUtil.d("Scheduling maintenance job ...");
}
/**
* Schedule Maintenance Job Service if needed: there is no scheduled job with same job
* parameters.
*
* @param context the context
* @param forceSchedule a flag to indicate whether to force rescheduling the job.
* @return a {@code boolean} to indicate if the service job is actually scheduled.
*/
public static boolean scheduleIfNeeded(Context context, boolean forceSchedule) {
if (FlagsFactory.getFlags().getTopicsKillSwitch()
&& FlagsFactory.getFlags().getFledgeSelectAdsKillSwitch()) {
LogUtil.e(
"Both Topics and Select Ads are disabled, skipping scheduling"
+ " MaintenanceJobService");
return false;
}
final JobScheduler jobScheduler = context.getSystemService(JobScheduler.class);
if (jobScheduler == null) {
LogUtil.e("Cannot fetch Job Scheduler!");
return false;
}
long flagsMaintenanceJobPeriodMs = FlagsFactory.getFlags().getMaintenanceJobPeriodMs();
long flagsMaintenanceJobFlexMs = FlagsFactory.getFlags().getMaintenanceJobFlexMs();
JobInfo job = jobScheduler.getPendingJob(MAINTENANCE_JOB_ID);
// Skip to reschedule the job if there is same scheduled job with same parameters.
if (job != null && !forceSchedule) {
long maintenanceJobPeriodMs = job.getIntervalMillis();
long maintenanceJobFlexMs = job.getFlexMillis();
if (flagsMaintenanceJobPeriodMs == maintenanceJobPeriodMs
&& flagsMaintenanceJobFlexMs == maintenanceJobFlexMs) {
LogUtil.i(
"Maintenance Job Service has been scheduled with same parameters, skip"
+ " rescheduling!");
return false;
}
}
schedule(context, jobScheduler, flagsMaintenanceJobPeriodMs, flagsMaintenanceJobFlexMs);
return true;
}
private boolean skipAndCancelBackgroundJob(final JobParameters params) {
this.getSystemService(JobScheduler.class).cancel(MAINTENANCE_JOB_ID);
// Tell the JobScheduler that the job has completed and does not need to be
// rescheduled.
jobFinished(params, false);
// Returning false means that this job has completed its work.
return false;
}
private FledgeMaintenanceTasksWorker getFledgeMaintenanceTasksWorker() {
if (!Objects.isNull(mFledgeMaintenanceTasksWorker)) {
return mFledgeMaintenanceTasksWorker;
}
mFledgeMaintenanceTasksWorker = FledgeMaintenanceTasksWorker.create(this);
return mFledgeMaintenanceTasksWorker;
}
private void doAdSelectionDataMaintenanceTasks() {
LogUtil.v("Performing Ad Selection maintenance tasks");
getFledgeMaintenanceTasksWorker().clearExpiredAdSelectionData();
}
}
|
