E2-1983: Fixing local notifications not fired (#371)

* Fixing local notifications not fired

* Adding javadocs

Author: milos1290

AndroidSDKPush/src/main/AndroidManifest.xml

@@ -1,10 +1,15 @@
-<manifest package="com.leanplum.push"
-          xmlns:android="http://schemas.android.com/apk/res/android">
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.leanplum.push">
 
     <application>
+        <receiver android:name="com.leanplum.LeanplumJobStartReceiver" />
         <!-- Leanplum FCM Registration Service. -->
-        <service android:name="com.leanplum.LeanplumPushRegistrationService"/>
+        <service android:name="com.leanplum.LeanplumPushRegistrationService" />
         <!-- Leanplum Local Push Notification Service. -->
-        <service android:name="com.leanplum.LeanplumLocalPushListenerService"/>
+        <service
+            android:name="com.leanplum.LeanplumLocalPushListenerService"
+            android:permission="android.permission.BIND_JOB_SERVICE" />
     </application>
-</manifest>
+
+</manifest>

AndroidSDKPush/src/main/java/com/leanplum/LeanplumJobStartReceiver.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2019, Leanplum, Inc. All rights reserved.
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.leanplum;
+
+import android.content.BroadcastReceiver;
+import android.content.Context;
+import android.content.Intent;
+
+import androidx.core.app.JobIntentService;
+
+import com.leanplum.internal.Log;
+import com.leanplum.internal.Util;
+
+/**
+ * Broadcast receiver used for starting any JobIntentService.
+ * Received intent needs to have {@link LeanplumJobStartReceiver#LP_EXTRA_SERVICE_CLASS} and
+ * {@link LeanplumJobStartReceiver#LP_EXTRA_JOB_ID} populated to successfully enqueue work.
+ */
+public class LeanplumJobStartReceiver extends BroadcastReceiver {
+
+    public static final String LP_EXTRA_SERVICE_CLASS = "com.leanplum.service_class";
+    public static final String LP_EXTRA_JOB_ID = "com.leanplum.service_job_id";
+
+    @Override
+    public void onReceive(Context context, Intent intent) {
+        try {
+            if (intent.getExtras() == null) {
+                Log.w("Cannot enqueue work on JobIntentService, no extras in intent.");
+                return;
+            }
+
+            String serviceName = intent.getStringExtra(LP_EXTRA_SERVICE_CLASS);
+            int jobId = intent.getIntExtra(LP_EXTRA_JOB_ID, 0);
+
+            Class service = Class.forName(serviceName);
+            if (!JobIntentService.class.isAssignableFrom(service)) {
+                Log.w("The service provided is not a type of JobIntentService.");
+                return;
+            }
+
+            intent.setClass(context, service);
+
+            JobIntentService.enqueueWork(context, service, jobId, intent);
+        } catch (Exception e) {
+            Util.handleException(e);
+        }
+    }
+}

AndroidSDKPush/src/main/java/com/leanplum/LeanplumLocalPushListenerService.java

@@ -21,10 +21,13 @@
 
 package com.leanplum;
 
-import android.app.IntentService;
+import android.content.Context;
 import android.content.Intent;
 import android.os.Bundle;
 
+import androidx.annotation.NonNull;
+import androidx.core.app.JobIntentService;
+
 import com.leanplum.internal.Constants;
 import com.leanplum.internal.Log;
 import com.leanplum.internal.Util;
@@ -34,24 +37,37 @@
  *
  * @author Aleksandar Gyorev
  */
-public class LeanplumLocalPushListenerService extends IntentService {
-  public LeanplumLocalPushListenerService() {
-    super("LeanplumLocalPushListenerService");
-  }
-
-  @Override
-  protected void onHandleIntent(Intent intent) {
-    try {
-      if (intent == null) {
-        Log.e("The intent cannot be null");
-        return;
-      }
-      Bundle extras = intent.getExtras();
-      if (extras != null && extras.containsKey(Constants.Keys.PUSH_MESSAGE_TEXT)) {
-        LeanplumPushService.handleNotification(this, extras);
-      }
-    } catch (Throwable t) {
-      Util.handleException(t);
+public class LeanplumLocalPushListenerService extends JobIntentService {
+
+    private static final String LP_CLASS_NAME = LeanplumLocalPushListenerService.class.getName();
+    private static final int LP_JOB_ID = 1;
+
+    /**
+     * Convenience method that returns Intent which can be used to start the job.
+     * @param context Surrounding context.
+     * @return Intent with class name and job id.
+     */
+    public static Intent getIntent(Context context) {
+        Intent intent = new Intent();
+        intent.putExtra(LeanplumJobStartReceiver.LP_EXTRA_SERVICE_CLASS, LP_CLASS_NAME);
+        intent.putExtra(LeanplumJobStartReceiver.LP_EXTRA_JOB_ID, LP_JOB_ID);
+        intent.setClass(context, LeanplumJobStartReceiver.class);
+        return intent;
+    }
+
+    @Override
+    protected void onHandleWork(@NonNull Intent intent) {
+        try {
+            if (intent == null) {
+                Log.e("The intent cannot be null");
+                return;
+            }
+            Bundle extras = intent.getExtras();
+            if (extras != null && extras.containsKey(Constants.Keys.PUSH_MESSAGE_TEXT)) {
+                LeanplumPushService.handleNotification(this, extras);
+            }
+        } catch (Throwable t) {
+            Util.handleException(t);
+        }
     }
-  }
 }

AndroidSDKPush/src/main/java/com/leanplum/internal/LeanplumLocalPushHelper.java

@@ -54,7 +54,7 @@ class LeanplumLocalPushHelper {
   static boolean scheduleLocalPush(ActionContext actionContext, String messageId, long eta) {
     try {
       Context context = Leanplum.getContext();
-      Intent intentAlarm = new Intent(context, LeanplumLocalPushListenerService.class);
+      Intent intentAlarm = LeanplumLocalPushListenerService.getIntent(context);
       AlarmManager alarmManager = (AlarmManager) context.getSystemService(
           Context.ALARM_SERVICE);
 
@@ -68,7 +68,7 @@ static boolean scheduleLocalPush(ActionContext actionContext, String messageId,
         if (existingEta < eta) {
           return false;
         } else if (existingEta >= eta) {
-          PendingIntent existingIntent = PendingIntent.getService(
+          PendingIntent existingIntent = PendingIntent.getBroadcast(
               context, messageId.hashCode(), intentAlarm,
               PendingIntent.FLAG_UPDATE_CURRENT);
           alarmManager.cancel(existingIntent);
@@ -120,7 +120,7 @@ static boolean scheduleLocalPush(ActionContext actionContext, String messageId,
       }
 
       // Schedule notification.
-      PendingIntent operation = PendingIntent.getService(
+      PendingIntent operation = PendingIntent.getBroadcast(
           context, messageId.hashCode(), intentAlarm,
           PendingIntent.FLAG_UPDATE_CURRENT);
       alarmManager.set(AlarmManager.RTC_WAKEUP, eta, operation);