Android 12 trampoline restrictions (#470)

* Bypass LeanplumPushReceiver for API 31

* Add log for 'Too many requests' error in dev mode

* Bump compile sdk to 31. Fix tests to runs with Java 11.

* Set travis java to 11

* Comment Bouncy Castle library

* Fix build

Author: hborisoff

.travis.yml

@@ -4,13 +4,14 @@ language: android
 
 env:
   global:
-    - BUILD_API=30
-    - BUILD_TOOLS=30.0.3
+    - JAVA_TOOL_OPTIONS=-Dhttps.protocols=TLSv1.2
+    - BUILD_API=31
+    - BUILD_TOOLS=31.0.0
     - ABI=x86
     - EMU_API=22
     - EMU_FLAVOR=default
     - ANDROID_HOME=/usr/local/android-sdk
-    - TOOLS=${ANDROID_HOME}/tools
+    - TOOLS=${ANDROID_HOME}/cmdline-tools/latest
     # PATH order is important, the 'emulator' script exists in more than one place
     - PATH=${ANDROID_HOME}:${ANDROID_HOME}/emulator:${TOOLS}:${TOOLS}/bin:${ANDROID_HOME}/platform-tools:${PATH}
     # If you want to run snapshot tests change value to 'true'. Build time will be increased by 6 minutes.
@@ -20,26 +21,33 @@ android:
   components:
     - tools
 
+jdk:
+  - oraclejdk11
+
 licenses:
   - 'android-sdk-preview-license-.+'
   - 'android-sdk-license-.+'
   - 'google-gdk-license-.+'
 
 before_install:
-  - sudo wget "https://bouncycastle.org/download/bcprov-ext-jdk15on-165.jar" -O "${JAVA_HOME}/jre/lib/ext/bcprov-ext-jdk15on-165.jar"
-  - sudo echo "security.provider.11=org.bouncycastle.jce.provider.BouncyCastleProvider" | sudo tee -a ${JAVA_HOME}/jre/lib/security/java.security
-  - if [[ $RUN_SNAPSHOT_TESTS == true ]]; then python -m pip install Tools/Pillow-6.2.2-cp27-cp27mu-manylinux1_x86_64.whl --user; fi; # library for image manipulation in snapshot tests
+  # Install cmdline-tools (older tools doesn't support Java 11)
+  - wget -q "https://dl.google.com/android/repository/commandlinetools-linux-7583922_latest.zip" -O android-commandline-tools-linux.zip
+  - mkdir -p ${ANDROID_HOME}/cmdline-tools
+  - unzip -q android-commandline-tools-linux.zip -d ${ANDROID_HOME}/cmdline-tools
+  - mv ${ANDROID_HOME}/cmdline-tools/cmdline-tools ${ANDROID_HOME}/cmdline-tools/latest
+  # Library for image manipulation in snapshot tests
+  - if [[ $RUN_SNAPSHOT_TESTS == true ]]; then python -m pip install Tools/Pillow-6.2.2-cp27-cp27mu-manylinux1_x86_64.whl --user; fi;
 
 before_script:
   # Install Android SDK and run emulator
   - echo 'count=0' > /home/travis/.android/repositories.cfg # avoid harmless sdkmanager warning
-  - echo y | sdkmanager "platform-tools" >/dev/null
-  - echo y | sdkmanager "tools" >/dev/null
-  - echo y | sdkmanager "build-tools;$BUILD_TOOLS" >/dev/null
-  - echo y | sdkmanager "platforms;android-$EMU_API" >/dev/null
-  - echo y | sdkmanager "platforms;android-$BUILD_API" >/dev/null
-  - echo y | sdkmanager "extras;android;m2repository" >/dev/null
-  - if [[ $RUN_SNAPSHOT_TESTS == true ]]; then echo y | sdkmanager "system-images;android-$EMU_API;$EMU_FLAVOR;$ABI"; fi;
+  - echo y | ${TOOLS}/bin/sdkmanager "platform-tools" >/dev/null
+  - echo y | ${TOOLS}/bin/sdkmanager "tools" >/dev/null
+  - echo y | ${TOOLS}/bin/sdkmanager "build-tools;$BUILD_TOOLS" >/dev/null
+  - echo y | ${TOOLS}/bin/sdkmanager "platforms;android-$EMU_API" >/dev/null
+  - echo y | ${TOOLS}/bin/sdkmanager "platforms;android-$BUILD_API" >/dev/null
+  - echo y | ${TOOLS}/bin/sdkmanager "extras;android;m2repository" >/dev/null
+  - if [[ $RUN_SNAPSHOT_TESTS == true ]]; then echo y | ${TOOLS}/bin/sdkmanager "system-images;android-$EMU_API;$EMU_FLAVOR;$ABI"; fi;
   - if [[ $RUN_SNAPSHOT_TESTS == true ]]; then echo no | avdmanager create avd --force -n test -k "system-images;android-$EMU_API;$EMU_FLAVOR;$ABI" -c 100M; fi;
   - if [[ $RUN_SNAPSHOT_TESTS == true ]]; then emulator -verbose -avd test -no-accel -no-snapshot -no-window -no-audio -camera-back none -camera-front none -selinux permissive -qemu -m 2048 & fi;
 

AndroidSDKCore/src/main/java/com/leanplum/LeanplumActivityHelper.java

@@ -21,20 +21,24 @@
 
 package com.leanplum;
 
+import android.annotation.TargetApi;
 import android.app.Activity;
 import android.app.Application;
 import android.app.Application.ActivityLifecycleCallbacks;
 import android.content.Context;
+import android.content.Intent;
 import android.content.res.Resources;
 import android.os.Bundle;
 
 import com.leanplum.annotations.Parser;
 import com.leanplum.callbacks.PostponableAction;
 import com.leanplum.internal.ActionManager;
+import com.leanplum.internal.Constants;
 import com.leanplum.internal.LeanplumInternal;
 import com.leanplum.internal.Log;
-import com.leanplum.internal.Util;
 
+import com.leanplum.internal.OperationQueue;
+import com.leanplum.utils.BuildUtil;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.LinkedList;
@@ -106,58 +110,98 @@ public static boolean isActivityPaused() {
   }
 
   /**
-   * Enables lifecycle callbacks for Android devices with Android OS >= 4.0
+   * Class provides additional functionality to handle payloads of push notifications built to
+   * comply with new Android 12 restrictions on using notification trampolines.
+   * The intent contains the message bundle which is used to run the open action and to track
+   * 'Push Opened' and 'Open' events.
    */
-  public static void enableLifecycleCallbacks(final Application app) {
-    Leanplum.setApplicationContext(app.getApplicationContext());
-    app.registerActivityLifecycleCallbacks(new ActivityLifecycleCallbacks() {
-      @Override
-      public void onActivityStopped(Activity activity) {
-        try {
-          onStop(activity);
-        } catch (Throwable t) {
-          Log.exception(t);
-        }
-      }
+  @TargetApi(31)
+  static class NoTrampolinesLifecycleCallbacks extends LeanplumLifecycleCallbacks {
 
-      @Override
-      public void onActivityResumed(final Activity activity) {
-        try {
-          onResume(activity);
-          if (Leanplum.isScreenTrackingEnabled()) {
-            Leanplum.advanceTo(activity.getLocalClassName());
-          }
-        } catch (Throwable t) {
-          Log.exception(t);
+    @Override
+    public void onActivityResumed(Activity activity) {
+      super.onActivityResumed(activity);
+
+      if (activity.getIntent() != null) {
+        Bundle extras = activity.getIntent().getExtras();
+        if (extras != null && extras.containsKey(Constants.Keys.PUSH_MESSAGE_TEXT)) {
+          OperationQueue.sharedInstance().addParallelOperation(
+              () -> handleNotificationPayload(extras));
         }
       }
+    }
 
-      @Override
-      public void onActivityPaused(Activity activity) {
-        try {
-          onPause(activity);
-        } catch (Throwable t) {
-          Log.exception(t);
-        }
+    private void handleNotificationPayload(Bundle message) {
+      try {
+        Class.forName("com.leanplum.LeanplumPushService")
+            .getDeclaredMethod("onActivityNotificationClick", Bundle.class)
+            .invoke(null, message);
+      } catch (Throwable t) {
+        Log.e("Push Notification action not run. Did you forget leanplum-push module?", t);
       }
+    }
+  }
 
-      @Override
-      public void onActivityStarted(Activity activity) {
+  static class LeanplumLifecycleCallbacks implements ActivityLifecycleCallbacks {
+    @Override
+    public void onActivityStopped(Activity activity) {
+      try {
+        onStop(activity);
+      } catch (Throwable t) {
+        Log.exception(t);
       }
+    }
 
-      @Override
-      public void onActivitySaveInstanceState(Activity activity, Bundle outState) {
+    @Override
+    public void onActivityResumed(final Activity activity) {
+      try {
+        onResume(activity);
+        if (Leanplum.isScreenTrackingEnabled()) {
+          Leanplum.advanceTo(activity.getLocalClassName());
+        }
+      } catch (Throwable t) {
+        Log.exception(t);
       }
+    }
 
-      @Override
-      public void onActivityDestroyed(Activity activity) {
+    @Override
+    public void onActivityPaused(Activity activity) {
+      try {
+        onPause(activity);
+      } catch (Throwable t) {
+        Log.exception(t);
       }
+    }
 
-      @Override
-      public void onActivityCreated(Activity activity, Bundle savedInstanceState) {
-      }
+    @Override
+    public void onActivityStarted(Activity activity) {
+    }
+
+    @Override
+    public void onActivitySaveInstanceState(Activity activity, Bundle outState) {
+    }
+
+    @Override
+    public void onActivityDestroyed(Activity activity) {
+    }
+
+    @Override
+    public void onActivityCreated(Activity activity, Bundle savedInstanceState) {
+    }
+  }
+
+  /**
+   * Enables lifecycle callbacks for Android devices with Android OS >= 4.0
+   */
+  public static void enableLifecycleCallbacks(final Application app) {
+    Leanplum.setApplicationContext(app.getApplicationContext());
+
+    if (BuildUtil.shouldDisableTrampolines(app)) {
+      app.registerActivityLifecycleCallbacks(new NoTrampolinesLifecycleCallbacks());
+    } else {
+      app.registerActivityLifecycleCallbacks(new LeanplumLifecycleCallbacks());
+    }
 
-    });
     registeredCallbacks = true;
     // run pending actions if any upon start
     LeanplumInternal.addStartIssuedHandler(runPendingActionsRunnable);

AndroidSDKCore/src/main/java/com/leanplum/internal/ActionManager.java

@@ -31,6 +31,7 @@
 import com.leanplum.Leanplum;
 import com.leanplum.LocationManager;
 import com.leanplum.callbacks.ActionCallback;
+import com.leanplum.internal.Constants.Defaults;
 import com.leanplum.utils.SharedPreferencesUtil;
 
 import java.util.HashMap;
@@ -58,7 +59,6 @@ public class ActionManager {
   public static final String HELD_BACK_ACTION_NAME = "__held_back";
   private static final String LEANPLUM_LOCAL_PUSH_HELPER =
       "com.leanplum.internal.LeanplumLocalPushHelper";
-  private static final String PREFERENCES_NAME = "__leanplum_messaging__";
   private static LocationManager locationManager;
   private static boolean loggedLocationManagerFailure = false;
 
@@ -157,7 +157,7 @@ public boolean onResponse(ActionContext actionContext) {
           // Get existing eta and clear notification from preferences.
           Context context = Leanplum.getContext();
           SharedPreferences preferences = context.getSharedPreferences(
-              PREFERENCES_NAME, Context.MODE_PRIVATE);
+              Defaults.MESSAGING_PREF_NAME, Context.MODE_PRIVATE);
           String preferencesKey = String.format(Constants.Defaults.LOCAL_NOTIFICATION_KEY,
               messageId);
           long existingEta = preferences.getLong(preferencesKey, 0L);
@@ -193,7 +193,7 @@ public Map<String, Number> getMessageImpressionOccurrences(String messageId) {
     }
     Context context = Leanplum.getContext();
     SharedPreferences preferences = context.getSharedPreferences(
-        PREFERENCES_NAME, Context.MODE_PRIVATE);
+        Defaults.MESSAGING_PREF_NAME, Context.MODE_PRIVATE);
     String savedValue = preferences.getString(
         String.format(Constants.Defaults.MESSAGE_IMPRESSION_OCCURRENCES_KEY, messageId),
         "{}");
@@ -205,7 +205,7 @@ public Map<String, Number> getMessageImpressionOccurrences(String messageId) {
   public void saveMessageImpressionOccurrences(Map<String, Number> occurrences, String messageId) {
     Context context = Leanplum.getContext();
     SharedPreferences preferences = context.getSharedPreferences(
-        PREFERENCES_NAME, Context.MODE_PRIVATE);
+        Defaults.MESSAGING_PREF_NAME, Context.MODE_PRIVATE);
     SharedPreferences.Editor editor = preferences.edit();
     editor.putString(
         String.format(Constants.Defaults.MESSAGE_IMPRESSION_OCCURRENCES_KEY, messageId),
@@ -221,7 +221,7 @@ public int getMessageTriggerOccurrences(String messageId) {
     }
     Context context = Leanplum.getContext();
     SharedPreferences preferences = context.getSharedPreferences(
-        PREFERENCES_NAME, Context.MODE_PRIVATE);
+        Defaults.MESSAGING_PREF_NAME, Context.MODE_PRIVATE);
     int savedValue = preferences.getInt(
         String.format(Constants.Defaults.MESSAGE_TRIGGER_OCCURRENCES_KEY, messageId), 0);
     messageTriggerOccurrences.put(messageId, savedValue);
@@ -231,7 +231,7 @@ public int getMessageTriggerOccurrences(String messageId) {
   public void saveMessageTriggerOccurrences(int occurrences, String messageId) {
     Context context = Leanplum.getContext();
     SharedPreferences preferences = context.getSharedPreferences(
-        PREFERENCES_NAME, Context.MODE_PRIVATE);
+        Defaults.MESSAGING_PREF_NAME, Context.MODE_PRIVATE);
     SharedPreferences.Editor editor = preferences.edit();
     editor.putInt(
         String.format(Constants.Defaults.MESSAGE_TRIGGER_OCCURRENCES_KEY, messageId), occurrences);
@@ -246,7 +246,7 @@ public MessageMatchResult shouldShowMessage(String messageId, Map<String, Object
     // 1. Must not be muted.
     Context context = Leanplum.getContext();
     SharedPreferences preferences = context.getSharedPreferences(
-        PREFERENCES_NAME, Context.MODE_PRIVATE);
+        Defaults.MESSAGING_PREF_NAME, Context.MODE_PRIVATE);
     if (preferences.getBoolean(
         String.format(Constants.Defaults.MESSAGE_MUTED_KEY, messageId), false)) {
       return result;
@@ -558,7 +558,7 @@ public void muteFutureMessagesOfKind(String messageId) {
     if (messageId != null) {
       Context context = Leanplum.getContext();
       SharedPreferences preferences = context.getSharedPreferences(
-          PREFERENCES_NAME, Context.MODE_PRIVATE);
+          Defaults.MESSAGING_PREF_NAME, Context.MODE_PRIVATE);
       SharedPreferences.Editor editor = preferences.edit();
       editor.putBoolean(
           String.format(Constants.Defaults.MESSAGE_MUTED_KEY, messageId),
@@ -661,7 +661,7 @@ private int countOccurrences(long startTime, long endTime) {
 
     Context context = Leanplum.getContext();
     SharedPreferences prefs =
-        context.getSharedPreferences(PREFERENCES_NAME, Context.MODE_PRIVATE);
+        context.getSharedPreferences(Defaults.MESSAGING_PREF_NAME, Context.MODE_PRIVATE);
     Map<String, ?> all = prefs.getAll();
 
     int occurrenceCount = 0;

AndroidSDKCore/src/main/java/com/leanplum/internal/Clock.java

@@ -29,6 +29,8 @@
  * mock in unit tests.
  */
 public abstract class Clock {
+  public static final long DAY_MILLIS = 24 * 60 * 60 * 1000;
+  public static final long MONTH_MILLIS = 30 * DAY_MILLIS;
 
   public static final Clock SYSTEM = new Clock() {
     @Override
@@ -68,4 +70,13 @@ static void setInstance(Clock clock) {
    */
   @NonNull
   abstract Date newDate();
+
+  /**
+   * Checks if time is not from more than 30 days ago.
+   *
+   * @return True if elapsed time is less than a month.
+   */
+  public boolean lessThanMonthAgo(long timeInMillis) {
+    return currentTimeMillis() - timeInMillis < MONTH_MILLIS;
+  }
 }

AndroidSDKCore/src/main/java/com/leanplum/internal/Constants.java

@@ -77,6 +77,7 @@ public static class Defaults {
     public static final String TOKEN_KEY = "__leanplum_token";
     public static final String MESSAGES_KEY = "__leanplum_messages";
     public static final String REGIONS_KEY = "regions";
+    public static final String MESSAGING_PREF_NAME = "__leanplum_messaging__";
     public static final String MESSAGE_TRIGGER_OCCURRENCES_KEY =
         "__leanplum_message_trigger_occurrences_%s";
     public static final String MESSAGE_IMPRESSION_OCCURRENCES_KEY =
@@ -191,6 +192,7 @@ public static class Keys {
     public static final String PUSH_MESSAGE_SILENT_TRACK = "lp_silent_track";
     public static final String PUSH_SENT_TIME = "lp_sent_time";
     public static final String PUSH_OCCURRENCE_ID = "lp_occurrence_id";
+    public static final String LOCAL_PUSH_OCCURRENCE_ID = "internal_occurrence_id";
     public static final String REGION = "region";
     public static final String REGION_STATE = "regionState";
     public static final String REGIONS = "regions";

AndroidSDKCore/src/main/java/com/leanplum/internal/RequestSender.java

@@ -154,6 +154,12 @@ public void sendRequests() {
           }
         } else {
           Exception errorException = new Exception("HTTP error " + statusCode);
+          String errorMessage = errorException.getMessage();
+          if (responseBody != null) {
+            errorMessage += " " + responseBody.toString();
+          }
+          Log.i(errorMessage);
+
           if (statusCode != -1
               && statusCode != 408
               && statusCode != 429

AndroidSDKCore/src/main/java/com/leanplum/utils/BuildUtil.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017, Leanplum, Inc. All rights reserved.
+ * Copyright 2021, Leanplum, Inc. All rights reserved.
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -42,6 +42,18 @@ public static boolean isNotificationChannelSupported(Context context) {
     return Build.VERSION.SDK_INT >= 26 && getTargetSdkVersion(context) >= 26;
   }
 
+  /**
+   * Checks whether notification trampolines are not supported.
+   * Targeting Android 12 means you cannot use a service or broadcast receiver as a trampoline to
+   * start an activity. The activity must be started immediately when notification is clicked.
+   *
+   * @param context The application context.
+   * @return True if notification trampolines are not supported.
+   */
+  public static boolean shouldDisableTrampolines(Context context) {
+    return Build.VERSION.SDK_INT >= 31 && getTargetSdkVersion(context) >= 31;
+  }
+
   /**
    * Returns target SDK version parsed from manifest.
    *