Add hourly period job to fetch battery usage data in Settings.

Bug: 253395332 Test: make RunSettingsRoboTests + manually Change-Id: I342066a30fed202e5013b8c2554f36d991975c3e
2022-10-20 11:48:48 +08:00
parent 9040efdccc
commit df05a1378b
11 changed files with 717 additions and 7 deletions
--- a/src/com/android/settings/fuelgauge/batteryusage/PeriodicJobManager.java
+++ b/src/com/android/settings/fuelgauge/batteryusage/PeriodicJobManager.java
@@ -0,0 +1,123 @@
+/*
+ * 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.settings.fuelgauge.batteryusage;
+
+import android.app.AlarmManager;
+import android.app.PendingIntent;
+import android.content.Context;
+import android.content.Intent;
+import android.util.Log;
+
+import androidx.annotation.VisibleForTesting;
+
+import java.text.SimpleDateFormat;
+import java.time.Clock;
+import java.time.Duration;
+import java.util.Date;
+import java.util.Locale;
+
+/** Manages the periodic job to schedule or cancel the next job. */
+public final class PeriodicJobManager {
+    private static final String TAG = "PeriodicJobManager";
+    private static final int ALARM_MANAGER_REQUEST_CODE = TAG.hashCode();
+
+    private static PeriodicJobManager sSingleton;
+
+    private final Context mContext;
+    private final AlarmManager mAlarmManager;
+    private final SimpleDateFormat mSimpleDateFormat =
+            new SimpleDateFormat("MMM dd,yyyy HH:mm:ss", Locale.ENGLISH);
+
+    @VisibleForTesting
+    static final int DATA_FETCH_INTERVAL_MINUTE = 60;
+
+    @VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
+    void reset() {
+        sSingleton = null; // for testing only
+    }
+
+    /** Gets or creates the new {@link PeriodicJobManager} instance. */
+    public static synchronized PeriodicJobManager getInstance(Context context) {
+        if (sSingleton == null || sSingleton.mAlarmManager == null) {
+            sSingleton = new PeriodicJobManager(context);
+        }
+        return sSingleton;
+    }
+
+    private PeriodicJobManager(Context context) {
+        this.mContext = context.getApplicationContext();
+        this.mAlarmManager = context.getSystemService(AlarmManager.class);
+    }
+
+    /** Schedules the next alarm job if it is available. */
+    @SuppressWarnings("JavaUtilDate")
+    public void refreshJob() {
+        if (mAlarmManager == null) {
+            Log.e(TAG, "cannot schedule next alarm job");
+            return;
+        }
+        // Cancels the previous alert job and schedules the next one.
+        final PendingIntent pendingIntent = getPendingIntent();
+        cancelJob(pendingIntent);
+        if (!canScheduleExactAlarms()) {
+            Log.w(TAG, "cannot schedule exact alarm job");
+            return;
+        }
+        // Uses UTC time to avoid scheduler is impacted by different timezone.
+        final long triggerAtMillis = getTriggerAtMillis(Clock.systemUTC());
+        mAlarmManager.setExactAndAllowWhileIdle(
+                AlarmManager.RTC_WAKEUP, triggerAtMillis, pendingIntent);
+        Log.d(TAG, "schedule next alarm job at "
+                + mSimpleDateFormat.format(new Date(triggerAtMillis)));
+    }
+
+    void cancelJob(PendingIntent pendingIntent) {
+        if (mAlarmManager != null) {
+            mAlarmManager.cancel(pendingIntent);
+        } else {
+            Log.e(TAG, "cannot cancel the alarm job");
+        }
+    }
+
+    /** Gets the next alarm trigger UTC time in milliseconds. */
+    static long getTriggerAtMillis(Clock clock) {
+        long currentTimeMillis = clock.millis();
+        // Rounds to the previous nearest time slot and shifts to the next one.
+        long timeSlotUnit = Duration.ofMinutes(DATA_FETCH_INTERVAL_MINUTE).toMillis();
+        return (currentTimeMillis / timeSlotUnit) * timeSlotUnit + timeSlotUnit;
+    }
+
+    private PendingIntent getPendingIntent() {
+        final Intent broadcastIntent =
+                new Intent(mContext, PeriodicJobReceiver.class)
+                        .setAction(PeriodicJobReceiver.ACTION_PERIODIC_JOB_UPDATE);
+        return PendingIntent.getBroadcast(
+                mContext.getApplicationContext(),
+                ALARM_MANAGER_REQUEST_CODE,
+                broadcastIntent,
+                PendingIntent.FLAG_CANCEL_CURRENT | PendingIntent.FLAG_IMMUTABLE);
+    }
+
+    private boolean canScheduleExactAlarms() {
+        return canScheduleExactAlarms(mAlarmManager);
+    }
+
+    /** Whether we can schedule exact alarm or not? */
+    public static boolean canScheduleExactAlarms(AlarmManager alarmManager) {
+        return alarmManager.canScheduleExactAlarms();
+    }
+}