[BackgroundTaskScheduler] Check requirements before firing exact task.

Check that the requirements set for the BackgroundTask that is supposed
to fire at a fixed time are met before starting it.

Bug: 970160
Change-Id: I03edb499cd607c747b583b4eca2f500c1e105ff1
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1964613
Commit-Queue: Mugdha Lakhani <nator@chromium.org>
Reviewed-by: David Trainor <dtrainor@chromium.org>
Reviewed-by: Richard Knoll <knollr@chromium.org>
Cr-Commit-Position: refs/heads/master@{#728165}

components/background_task_scheduler/BUILD.gn

@@ -70,7 +70,6 @@ if (is_android) {
     testonly = true
 
     sources = [
-      "android/javatests/src/org/chromium/components/background_task_scheduler/BackgroundTaskBroadcastReceiverTest.java",
       "android/javatests/src/org/chromium/components/background_task_scheduler/BackgroundTaskSchedulerImplWithMockTest.java",
       "android/javatests/src/org/chromium/components/background_task_scheduler/BackgroundTaskSchedulerJobServiceTest.java",
       "android/javatests/src/org/chromium/components/background_task_scheduler/BundleToPersistableBundleConverterTest.java",
@@ -101,6 +100,7 @@ if (is_android) {
       "android/junit/src/org/chromium/components/background_task_scheduler/BackgroundTaskSchedulerImplTest.java",
       "android/junit/src/org/chromium/components/background_task_scheduler/BackgroundTaskSchedulerPrefsTest.java",
       "android/junit/src/org/chromium/components/background_task_scheduler/BackgroundTaskSchedulerUmaTest.java",
+      "android/junit/src/org/chromium/components/background_task_scheduler/BroadcastReceiverRobolectricTest.java",
       "android/junit/src/org/chromium/components/background_task_scheduler/ExtrasToProtoConverterTest.java",
       "android/junit/src/org/chromium/components/background_task_scheduler/ShadowGcmNetworkManager.java",
       "android/junit/src/org/chromium/components/background_task_scheduler/TaskInfoTest.java",

components/background_task_scheduler/android/java/src/org/chromium/components/background_task_scheduler/BackgroundTaskBroadcastReceiver.java

@@ -7,6 +7,12 @@ package org.chromium.components.background_task_scheduler;
 import android.content.BroadcastReceiver;
 import android.content.Context;
 import android.content.Intent;
+import android.content.IntentFilter;
+import android.net.ConnectivityManager;
+import android.net.Network;
+import android.net.NetworkInfo;
+import android.os.BatteryManager;
+import android.os.Build;
 import android.os.PowerManager;
 import android.text.format.DateUtils;
 
@@ -18,8 +24,6 @@ import org.chromium.content_public.browser.UiThreadTaskTraits;
 
 /**
  * Starts running the BackgroundTask at the specified triggering time.
- * TODO (crbug.com/970160): Check that the requirements set for the BackgroundTask are met before
- * starting it.
  *
  * Receives the information through a broadcast, which is synchronous in the Main thread. The
  * execution of the task will be detached to a best effort task.
@@ -96,8 +100,33 @@ public class BackgroundTaskBroadcastReceiver extends BroadcastReceiver {
             return;
         }
 
+        int taskId = taskParams.getTaskId();
+        ScheduledTaskProto.ScheduledTask scheduledTask =
+                BackgroundTaskSchedulerPrefs.getScheduledTask(taskId);
+        if (scheduledTask == null) {
+            Log.e(TAG, "Cannot get information about task with task ID " + taskId);
+            return;
+        }
+
+        // Only continue if network requirements match network status.
+        if (!networkRequirementsMet(context, taskId,
+                    convertToTaskInfoNetworkType(scheduledTask.getRequiredNetworkType()))) {
+            Log.w(TAG,
+                    "Failed to start task. Network requirements not satisfied for task with task ID"
+                            + taskId);
+            return;
+        }
+
+        // Check if battery requirements match.
+        if (!batteryRequirementsMet(context, taskId, scheduledTask.getRequiresCharging())) {
+            Log.w(TAG,
+                    "Failed to start task. Battery requirements not satisfied for task with task ID"
+                            + taskId);
+            return;
+        }
+
         final BackgroundTask backgroundTask =
-                BackgroundTaskSchedulerFactory.getBackgroundTaskFromTaskId(taskParams.getTaskId());
+                BackgroundTaskSchedulerFactory.getBackgroundTaskFromTaskId(taskId);
         if (backgroundTask == null) {
             Log.w(TAG, "Failed to start task. Could not instantiate BackgroundTask class.");
             // Cancel task if the BackgroundTask class is not found anymore. We assume this means
@@ -116,4 +145,52 @@ public class BackgroundTaskBroadcastReceiver extends BroadcastReceiver {
         TaskExecutor taskExecutor = new TaskExecutor(context, wakeLock, taskParams, backgroundTask);
         PostTask.postTask(UiThreadTaskTraits.BEST_EFFORT, taskExecutor::execute);
     }
+
+    private boolean networkRequirementsMet(Context context, int taskId, int requiredNetworkType) {
+        if (requiredNetworkType == TaskInfo.NetworkType.NONE) return true;
+
+        ConnectivityManager connectivityManager =
+                (ConnectivityManager) context.getApplicationContext().getSystemService(
+                        Context.CONNECTIVITY_SERVICE);
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+            Network network = connectivityManager.getActiveNetwork();
+            if (requiredNetworkType == TaskInfo.NetworkType.ANY) return (network != null);
+        } else {
+            NetworkInfo networkInfo = connectivityManager.getActiveNetworkInfo();
+            if (requiredNetworkType == TaskInfo.NetworkType.ANY) return (networkInfo != null);
+        }
+
+        return (!connectivityManager.isActiveNetworkMetered());
+    }
+
+    private boolean batteryRequirementsMet(Context context, int taskId, boolean requiresCharging) {
+        if (!requiresCharging) return true;
+        BatteryManager batteryManager =
+                (BatteryManager) context.getSystemService(Context.BATTERY_SERVICE);
+
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+            return batteryManager.isCharging();
+        }
+
+        IntentFilter intentFilter = new IntentFilter(Intent.ACTION_BATTERY_CHANGED);
+        Intent batteryStatus = context.registerReceiver(null, intentFilter);
+        int status = batteryStatus.getIntExtra(BatteryManager.EXTRA_STATUS, -1);
+        return status == BatteryManager.BATTERY_STATUS_CHARGING
+                || status == BatteryManager.BATTERY_STATUS_FULL;
+    }
+
+    private @TaskInfo.NetworkType int convertToTaskInfoNetworkType(
+            ScheduledTaskProto.ScheduledTask.RequiredNetworkType networkType) {
+        switch (networkType) {
+            case NONE:
+                return TaskInfo.NetworkType.NONE;
+            case ANY:
+                return TaskInfo.NetworkType.ANY;
+            case UNMETERED:
+                return TaskInfo.NetworkType.UNMETERED;
+            default:
+                assert false : "Incorrect value of RequiredNetworkType";
+                return -1;
+        }
+    }
 }

components/background_task_scheduler/android/java/src/org/chromium/components/background_task_scheduler/BackgroundTaskSchedulerAlarmManager.java

@@ -40,6 +40,7 @@ public class BackgroundTaskSchedulerAlarmManager implements BackgroundTaskSchedu
 
         ScheduledTaskProto.ScheduledTask scheduledTask =
                 BackgroundTaskSchedulerPrefs.getScheduledTask(taskId);
+
         if (scheduledTask == null) {
             Log.e(TAG, "Cannot get information about task with task ID " + taskId);
             return null;

components/background_task_scheduler/android/java/src/org/chromium/components/background_task_scheduler/BackgroundTaskSchedulerPrefs.java

@@ -109,7 +109,8 @@ public class BackgroundTaskSchedulerPrefs {
     public static void addScheduledTask(TaskInfo taskInfo) {
         try (TraceEvent te = TraceEvent.scoped("BackgroundTaskSchedulerPrefs.addScheduledTask",
                      Integer.toString(taskInfo.getTaskId()))) {
-            ScheduledTaskProtoVisitor visitor = new ScheduledTaskProtoVisitor(taskInfo.getExtras());
+            ScheduledTaskProtoVisitor visitor = new ScheduledTaskProtoVisitor(taskInfo.getExtras(),
+                    taskInfo.getRequiredNetworkType(), taskInfo.requiresCharging());
             taskInfo.getTimingInfo().accept(visitor);
 
             getSharedPreferences()
@@ -123,9 +124,15 @@ public class BackgroundTaskSchedulerPrefs {
     private static class ScheduledTaskProtoVisitor implements TaskInfo.TimingInfoVisitor {
         private String mSerializedScheduledTask;
         private final Bundle mExtras;
+        @TaskInfo.NetworkType
+        private final int mRequiredNetworkType;
+        private final boolean mRequiresCharging;
 
-        ScheduledTaskProtoVisitor(Bundle extras) {
+        ScheduledTaskProtoVisitor(Bundle extras, @TaskInfo.NetworkType int requiredNetworkType,
+                boolean requiresCharging) {
             mExtras = extras;
+            mRequiredNetworkType = requiredNetworkType;
+            mRequiresCharging = requiresCharging;
         }
 
         // Only valid after a TimingInfo object was visited.
@@ -159,6 +166,9 @@ public class BackgroundTaskSchedulerPrefs {
                     ScheduledTaskProto.ScheduledTask.newBuilder()
                             .setType(ScheduledTaskProto.ScheduledTask.Type.EXACT)
                             .setTriggerMs(exactInfo.getTriggerAtMs())
+                            .setRequiredNetworkType(
+                                    convertToRequiredNetworkType(mRequiredNetworkType))
+                            .setRequiresCharging(mRequiresCharging)
                             .addAllExtras(
                                     ExtrasToProtoConverter.convertExtrasToProtoExtras(mExtras))
                             .build();
@@ -283,4 +293,19 @@ public class BackgroundTaskSchedulerPrefs {
                     .apply();
         }
     }
+
+    private static ScheduledTaskProto.ScheduledTask.RequiredNetworkType
+    convertToRequiredNetworkType(@TaskInfo.NetworkType int networkType) {
+        switch (networkType) {
+            case TaskInfo.NetworkType.NONE:
+                return ScheduledTaskProto.ScheduledTask.RequiredNetworkType.NONE;
+            case TaskInfo.NetworkType.ANY:
+                return ScheduledTaskProto.ScheduledTask.RequiredNetworkType.ANY;
+            case TaskInfo.NetworkType.UNMETERED:
+                return ScheduledTaskProto.ScheduledTask.RequiredNetworkType.UNMETERED;
+            default:
+                assert false : "Incorrect value of TaskInfo.NetworkType";
+                return ScheduledTaskProto.ScheduledTask.RequiredNetworkType.NONE;
+        }
+    }
 }
\ No newline at end of file

components/background_task_scheduler/android/java/src/org/chromium/components/background_task_scheduler/scheduled_task.proto

@@ -18,6 +18,12 @@ message ScheduledTask {
     EXACT = 2;
   }
 
+  enum RequiredNetworkType {
+    NONE = 0;
+    ANY = 1;
+    UNMETERED = 2;
+  }
+
   // The type of the scheduled task.
   Type type = 1;
 
@@ -62,4 +68,14 @@ message ScheduledTask {
   // PeriodicTask objects store their extras through their scheduling backend
   // (JobScheduler and GcmNetworkManager).
   repeated ExtraItem extras = 3;
+
+  // Required network type, stored for an ExactTask. OneOffTask and PeriodicTask
+  // objects store their required network type through their scheduling backend
+  // (JobScheduler and GCMNetworkManager).
+  RequiredNetworkType required_network_type = 4;
+
+  // Bool representing whether the task requires charging. Stored for an
+  // ExactTask. OneOffTask and PeriodicTask objects store this info through
+  // their scheduling backend (JobScheduler and GCMNetworkManager).
+  bool requires_charging = 5;
 }
\ No newline at end of file

components/background_task_scheduler/android/javatests/src/org/chromium/components/background_task_scheduler/BackgroundTaskBroadcastReceiverTest.java

-// Copyright 2019 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-package org.chromium.components.background_task_scheduler;
-
-import static org.junit.Assert.assertEquals;
-
-import android.content.Context;
-import android.content.Intent;
-import android.support.test.filters.MediumTest;
-
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-
-import org.chromium.base.ContextUtils;
-import org.chromium.base.ThreadUtils;
-import org.chromium.base.test.BaseJUnit4ClassRunner;
-import org.chromium.content_public.browser.test.util.CriteriaHelper;
-
-import java.util.concurrent.Callable;
-import java.util.concurrent.TimeUnit;
-
-/** Tests for {@link BackgroundTaskBroadcastReceiver}. */
-@RunWith(BaseJUnit4ClassRunner.class)
-public class BackgroundTaskBroadcastReceiverTest {
-    class TestBackgroundTask implements BackgroundTask {
-        public TestBackgroundTask() {}
-
-        @Override
-        public boolean onStartTask(
-                Context context, TaskParameters taskParameters, TaskFinishedCallback callback) {
-            ThreadUtils.assertOnUiThread();
-            mScheduled++;
-            return false;
-        }
-
-        @Override
-        public boolean onStopTask(Context context, TaskParameters taskParameters) {
-            ThreadUtils.assertOnUiThread();
-            mStopped++;
-            return false;
-        }
-
-        @Override
-        public void reschedule(Context context) {
-            ThreadUtils.assertOnUiThread();
-            mRescheduled++;
-        }
-    }
-
-    class TestBackgroundTaskFactory implements BackgroundTaskFactory {
-        @Override
-        public BackgroundTask getBackgroundTaskFromTaskId(int taskId) {
-            if (taskId == TaskIds.TEST) {
-                return new TestBackgroundTask();
-            }
-            return null;
-        }
-    }
-
-    private int mScheduled;
-    private int mStopped;
-    private int mRescheduled;
-
-    @Before
-    public void setUp() {
-        mScheduled = 0;
-        mStopped = 0;
-        mRescheduled = 0;
-
-        BackgroundTaskSchedulerFactory.setBackgroundTaskFactory(new TestBackgroundTaskFactory());
-    }
-
-    @Test
-    @MediumTest
-    public void testStartExact() {
-        TaskInfo.TimingInfo exactInfo =
-                TaskInfo.ExactInfo.create().setTriggerAtMs(System.currentTimeMillis()).build();
-        TaskInfo exactTask = TaskInfo.createTask(TaskIds.TEST, exactInfo).build();
-        BackgroundTaskSchedulerPrefs.addScheduledTask(exactTask);
-
-        Intent intent = new Intent(
-                ContextUtils.getApplicationContext(), BackgroundTaskBroadcastReceiver.class)
-                                .putExtra(BackgroundTaskSchedulerDelegate.BACKGROUND_TASK_ID_KEY,
-                                        TaskIds.TEST);
-
-        BackgroundTaskBroadcastReceiver receiver = new BackgroundTaskBroadcastReceiver();
-        receiver.onReceive(ContextUtils.getApplicationContext(), intent);
-
-        Callable<Boolean> hasScheduled = () -> mScheduled == 1;
-        CriteriaHelper.pollUiThread(hasScheduled, "Failed to schedule task",
-                /*maxTimeoutMs=*/TimeUnit.MINUTES.toMillis(2), /*checkIntervalMs=*/50);
-
-        assertEquals(0, mStopped);
-        assertEquals(0, mRescheduled);
-    }
-}