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
|
/*
* 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.topics;
import static com.android.adservices.service.AdServicesConfig.TOPICS_EPOCH_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.FlagsFactory;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
/**
* Epoch computation job. This will be run approximately once per epoch to
* compute Topics.
*/
public final class EpochJobService extends JobService {
@Override
public boolean onStartJob(JobParameters params) {
LogUtil.d("EpochJobService.onStartJob");
if (FlagsFactory.getFlags().getTopicsKillSwitch()) {
LogUtil.e("Topics API is disabled, skipping and cancelling EpochJobService");
return skipAndCancelBackgroundJob(params);
}
// This service executes each incoming job on a Handler running on the application's
// main thread. This means that we must offload the execution logic to background executor.
// TODO(b/225382268): Handle cancellation.
ListenableFuture<Void> epochComputationFuture = Futures.submit(
() -> {
TopicsWorker.getInstance(this).computeEpoch();
},
AdServicesExecutors.getBackgroundExecutor());
Futures.addCallback(
epochComputationFuture,
new FutureCallback<Void>() {
@Override
public void onSuccess(Void result) {
LogUtil.d("Epoch Computation succeeded!");
// Tell the JobScheduler that the job has completed and does not need to be
// rescheduled.
jobFinished(params, /* wantsReschedule = */ false);
}
@Override
public void onFailure(Throwable t) {
LogUtil.e(t, "Failed to handle JobService: " + params.getJobId());
// When failure, also tell the JobScheduler that the job has completed and
// does not need to be rescheduled.
// TODO(b/225909845): Revisit this. We need a retry policy.
jobFinished(params, /* wantsReschedule = */ false);
}
},
directExecutor());
return true;
}
@Override
public boolean onStopJob(JobParameters params) {
LogUtil.d("EpochJobService.onStopJob");
return false;
}
@VisibleForTesting
static void schedule(
Context context,
@NonNull JobScheduler jobScheduler,
long epochJobPeriodMs,
long epochJobFlexMs) {
final JobInfo job =
new JobInfo.Builder(
TOPICS_EPOCH_JOB_ID,
new ComponentName(context, EpochJobService.class))
.setRequiresCharging(true)
.setPersisted(true)
.setPeriodic(epochJobPeriodMs, epochJobFlexMs)
.build();
jobScheduler.schedule(job);
LogUtil.d("Scheduling Epoch job ...");
}
/**
* Schedule Epoch 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()) {
LogUtil.e("Topics API is disabled, skip scheduling the EpochJobService");
return false;
}
final JobScheduler jobScheduler = context.getSystemService(JobScheduler.class);
if (jobScheduler == null) {
LogUtil.e("Cannot fetch Job Scheduler!");
return false;
}
long flagsEpochJobPeriodMs = FlagsFactory.getFlags().getTopicsEpochJobPeriodMs();
long flagsEpochJobFlexMs = FlagsFactory.getFlags().getTopicsEpochJobFlexMs();
JobInfo job = jobScheduler.getPendingJob(TOPICS_EPOCH_JOB_ID);
// Skip to reschedule the job if there is same scheduled job with same parameters.
if (job != null && !forceSchedule) {
long epochJobPeriodMs = job.getIntervalMillis();
long epochJobFlexMs = job.getFlexMillis();
if (flagsEpochJobPeriodMs == epochJobPeriodMs
&& flagsEpochJobFlexMs == epochJobFlexMs) {
LogUtil.i(
"Epoch Job Service has been scheduled with same parameters, skip"
+ " rescheduling!");
return false;
}
}
schedule(context, jobScheduler, flagsEpochJobPeriodMs, flagsEpochJobFlexMs);
return true;
}
private boolean skipAndCancelBackgroundJob(final JobParameters params) {
this.getSystemService(JobScheduler.class).cancel(TOPICS_EPOCH_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;
}
}
|
