Completely remove global static deviceType int (#994)

* Completely remove global static deviceType int
* Better to use the OSUtils getDeviceType method since we wont know what part fo the SDK init we are in
* The chance of a 0 deviceType is a race condition we do not want to fight with

* Remove space from param key name "device_type"

* Unit tests created for testing Android and Amazon device types
* Make sure that the correct device_type appears in the player create network requests
* Using ShadowOSUtils getDeviceType now relies on a availableClasses HashSet
  * Created a method called mockAmazonDevice that will add the ADM class string and when this exists we can pretend this device is a Amazon FireOS device
* Added a few new asserts to check against device type in player create payloads and generic on session requests

* Cleaned up device type unit tests
* Checking against the deviceType in the player create right after OneSignal init

* Added resetStatics to ADM shadow in unit tests
* Without resetting the statics for ADM the on_session will not be called, need to find
WIP need to fix the current test related to making sure previous usage deviceType fails and new usage passes

* Finished unit test related to device type on Android and Amazon
* Remove package private helper for setAppContext
* Removed all refs to appId and now we try to use a cached appId in the network requests
* Testing deviceType to reproduce the 0 deviceType and this is through two new tests, one for Android and one for Amazon

Author: mikechoch

OneSignalSDK/onesignal/src/main/java/com/onesignal/FocusTimeController.java

@@ -12,15 +12,12 @@
 import java.util.List;
 import java.util.concurrent.atomic.AtomicBoolean;
 
-
 /**
  * Entry points that could cause on_focus to fire:
  * 1. OSSessionManager.session changed (onSessionEnded) - Send any attributed session time
  * 2. App is foregrounded (appForegrounded) - Set start focused time
  * 3. App is backgrounded (appBackgrounded) - Kick off job to sync when session ends
  */
-
-
 class FocusTimeController {
    // Only present if app is currently in focus.
    @Nullable private Long timeFocusedAtMs;
@@ -239,7 +236,7 @@ protected void additionalFieldsToAddToOnFocusPayload(@NonNull JSONObject jsonBod
 
       private @NonNull JSONObject generateOnFocusPayload(long totalTimeActive) throws JSONException {
          JSONObject jsonBody = new JSONObject()
-            .put("app_id", OneSignal.appId)
+            .put("app_id", OneSignal.getSavedAppId())
             .put("type", 1) // Always 1, where this type means do NOT increase session_count
             .put("state", "ping") // Always ping, other types are not used
             .put("active_time", totalTimeActive)

OneSignalSDK/onesignal/src/main/java/com/onesignal/GenerateNotification.java

@@ -297,7 +297,7 @@ private static void setAlertnessOptions(JSONObject gcmBundle, NotificationCompat
       else
          notificationDefaults |= Notification.DEFAULT_LIGHTS;
 
-      if (OneSignal.getVibrate(currentContext) && gcmBundle.optInt("vib", 1) == 1) {
+      if (OneSignal.getVibrate() && gcmBundle.optInt("vib", 1) == 1) {
          if (gcmBundle.has("vib_pt")) {
             long[] vibrationPattern = OSUtils.parseVibrationPattern(gcmBundle);
             if (vibrationPattern != null)
@@ -1007,7 +1007,7 @@ private static boolean isSoundEnabled(JSONObject gcmBundle) {
       String sound = gcmBundle.optString("sound", null);
       if ("null".equals(sound) || "nil".equals(sound))
          return false;
-      return OneSignal.getSoundEnabled(currentContext);
+      return OneSignal.getSoundEnabled();
    }
 
    // Android 5.0 accent color to use, only works when AndroidManifest.xml is targetSdkVersion >= 21

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessageController.java

@@ -20,6 +20,8 @@
 import java.util.Map;
 import java.util.Set;
 
+import static com.onesignal.OneSignal.getSavedAppId;
+
 class OSInAppMessageController implements OSDynamicTriggerControllerObserver, OSSystemConditionController.OSSystemConditionObserver {
 
     private static ArrayList<String> PREFERRED_VARIANT_ORDER = new ArrayList<String>() {{
@@ -400,7 +402,7 @@ private void fireRESTCallForClick(@NonNull final OSInAppMessage message, @NonNul
 
         try {
             JSONObject json = new JSONObject() {{
-                put("app_id", OneSignal.appId);
+                put("app_id", OneSignal.getSavedAppId());
                 put("device_type", new OSUtils().getDeviceType());
                 put("player_id", OneSignal.getUserId());
                 put("click_id", clickId);

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSUtils.java

@@ -31,7 +31,6 @@
 import android.content.ContentResolver;
 import android.content.Context;
 import android.content.Intent;
-import android.content.pm.ActivityInfo;
 import android.content.pm.ApplicationInfo;
 import android.content.pm.PackageManager;
 import android.content.res.Resources;
@@ -100,8 +99,9 @@ public static boolean shouldRetryNetworkRequest(int statusCode) {
       return true;
    }
 
-   int initializationChecker(Context context, int deviceType, String oneSignalAppId) {
+   int initializationChecker(Context context, String oneSignalAppId) {
       int subscribableStatus = 1;
+      int deviceType = getDeviceType();
 
       try {
          //noinspection ResultOfMethodCallIgnored

OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignal.java

@@ -440,7 +440,6 @@ public void onSessionEnding(@NonNull OSSessionManager.SessionResult lastSessionR
 
    private static AdvertisingIdentifierProvider mainAdIdProvider = new AdvertisingIdProviderGPS();
 
-   private static int deviceType;
    @SuppressWarnings("WeakerAccess")
    public static String sdkType = "native";
 
@@ -600,7 +599,6 @@ public static void setAppContext(@NonNull Context context) {
       // Register the lifecycle listener of the app for state changes in activities with proper context
       ActivityLifecycleListener.registerActivityLifecycleCallbacks((Application)appContext);
 
-
       if (wasAppContextNull) {
          sessionManager = new OSSessionManager(getNewSessionListener());
          outcomeEventsController = new OutcomeEventsController(sessionManager, getDBHelperInstance());
@@ -684,8 +682,7 @@ public static void init(Context context, String googleProjectNumber, String oneS
       if (!isGoogleProjectNumberRemote())
          mGoogleProjectNumber = googleProjectNumber;
 
-      deviceType = osUtils.getDeviceType();
-      subscribableStatus = osUtils.initializationChecker(context, deviceType, oneSignalAppId);
+      subscribableStatus = osUtils.initializationChecker(context, oneSignalAppId);
       if (isSubscriptionStatusUninitializable())
          return;
 
@@ -766,14 +763,14 @@ private static void handleAppIdChange() {
       if (oldAppId != null) {
          if (!oldAppId.equals(appId)) {
             Log(LOG_LEVEL.DEBUG, "APP ID changed, clearing user id as it is no longer valid.");
-            SaveAppId(appId);
+            saveAppId(appId);
             OneSignalStateSynchronizer.resetCurrentState();
             remoteParams = null;
          }
       }
       else {
          BadgeCountUpdater.updateCount(0, appContext);
-         SaveAppId(appId);
+         saveAppId(appId);
       }
    }
 
@@ -955,6 +952,7 @@ private static PushRegistrator getPushRegistrator() {
       if (mPushRegistrator != null)
          return mPushRegistrator;
 
+      int deviceType = osUtils.getDeviceType();
       if (deviceType == UserState.DEVICE_TYPE_FIREOS)
          mPushRegistrator = new PushRegistratorADM();
       else if (OSUtils.hasFCMLibrary())
@@ -1317,7 +1315,7 @@ private static void registerUserTask() throws JSONException {
 
       JSONObject deviceInfo = new JSONObject();
 
-      deviceInfo.put("app_id", appId);
+      deviceInfo.put("app_id", getSavedAppId());
 
       String adId = mainAdIdProvider.getIdentifier(appContext);
       if (adId != null)
@@ -1344,7 +1342,7 @@ private static void registerUserTask() throws JSONException {
       pushState.put("identifier", lastRegistrationId);
       pushState.put("subscribableStatus", subscribableStatus);
       pushState.put("androidPermission", areNotificationsEnabledForSubscribedState());
-      pushState.put("device_type", deviceType);
+      pushState.put("device_type", osUtils.getDeviceType());
       OneSignalStateSynchronizer.updatePushState(pushState);
 
       if (shareLocation && lastLocationPoint != null)
@@ -1981,7 +1979,7 @@ static void sendPurchases(JSONArray purchases, boolean newAsExisting, OneSignalR
 
       try {
          JSONObject jsonBody = new JSONObject();
-         jsonBody.put("app_id", appId);
+         jsonBody.put("app_id", getSavedAppId());
          if (newAsExisting)
             jsonBody.put("existing", true);
          jsonBody.put("purchases", purchases);
@@ -2177,7 +2175,7 @@ private static void notificationOpenedRESTCall(Context inContext, JSONArray data
             jsonBody.put("app_id", getSavedAppId(inContext));
             jsonBody.put("player_id", getSavedUserId(inContext));
             jsonBody.put("opened", true);
-            jsonBody.put("device_type", deviceType);
+            jsonBody.put("device_type", osUtils.getDeviceType());
 
             OneSignalRestClient.put("notifications/" + notificationId, jsonBody, new OneSignalRestClient.ResponseHandler() {
                @Override
@@ -2192,11 +2190,14 @@ void  onFailure(int statusCode, String response, Throwable throwable) {
       }
    }
 
-   private static void SaveAppId(String appId) {
+   private static void saveAppId(String appId) {
       if (appContext == null)
          return;
-      OneSignalPrefs.saveString(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_GT_APP_ID, appId);
+
+      OneSignalPrefs.saveString(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_GT_APP_ID,
+              appId);
    }
 
    static String getSavedAppId() {
@@ -2207,35 +2208,44 @@ private static String getSavedAppId(Context inContext) {
       if (inContext == null)
          return null;
 
-      return OneSignalPrefs.getString(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_GT_APP_ID,null);
+      return OneSignalPrefs.getString(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_GT_APP_ID,
+              null);
    }
 
    static boolean getSavedUserConsentStatus() {
-      return OneSignalPrefs.getBool(OneSignalPrefs.PREFS_ONESIGNAL, OneSignalPrefs.PREFS_ONESIGNAL_USER_PROVIDED_CONSENT, false);
+      return OneSignalPrefs.getBool(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_ONESIGNAL_USER_PROVIDED_CONSENT,
+              false);
    }
 
    static void saveUserConsentStatus(boolean consent) {
-      OneSignalPrefs.saveBool(OneSignalPrefs.PREFS_ONESIGNAL, OneSignalPrefs.PREFS_ONESIGNAL_USER_PROVIDED_CONSENT, consent);
+      OneSignalPrefs.saveBool(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_ONESIGNAL_USER_PROVIDED_CONSENT,
+              consent);
    }
 
    private static String getSavedUserId(Context inContext) {
       if (inContext == null)
-         return "";
+         return null;
 
-      return OneSignalPrefs.getString(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_GT_PLAYER_ID,null);
+      return OneSignalPrefs.getString(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_GT_PLAYER_ID,
+              null);
    }
 
    static boolean hasUserId() {
       return getUserId() != null;
    }
 
    static String getUserId() {
-      if (userId == null && appContext != null) {
-         userId = OneSignalPrefs.getString(OneSignalPrefs.PREFS_ONESIGNAL,
-                 OneSignalPrefs.PREFS_GT_PLAYER_ID,null);
-      }
+      if (userId == null && appContext != null)
+         userId = getSavedUserId(appContext);
+
       return userId;
    }
 
@@ -2244,8 +2254,10 @@ static void saveUserId(String id) {
       if (appContext == null)
          return;
 
-      OneSignalPrefs.saveString(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_GT_PLAYER_ID, userId);
+      OneSignalPrefs.saveString(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_GT_PLAYER_ID,
+              userId);
    }
 
    static boolean hasEmailId() {
@@ -2254,8 +2266,10 @@ static boolean hasEmailId() {
 
    static String getEmailId() {
       if (TextUtils.isEmpty(emailId) && appContext != null) {
-         emailId = OneSignalPrefs.getString(OneSignalPrefs.PREFS_ONESIGNAL,
-                 OneSignalPrefs.PREFS_OS_EMAIL_ID,null);
+         emailId = OneSignalPrefs.getString(
+                 OneSignalPrefs.PREFS_ONESIGNAL,
+                 OneSignalPrefs.PREFS_OS_EMAIL_ID,
+                 null);
       }
       return emailId;
    }
@@ -2265,20 +2279,27 @@ static void saveEmailId(String id) {
       if (appContext == null)
          return;
 
-      OneSignalPrefs.saveString(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_OS_EMAIL_ID, "".equals(emailId) ? null : emailId);
+      OneSignalPrefs.saveString(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_OS_EMAIL_ID,
+              "".equals(emailId) ? null : emailId);
    }
 
    static boolean getFilterOtherGCMReceivers(Context context) {
-      return OneSignalPrefs.getBool(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_OS_FILTER_OTHER_GCM_RECEIVERS,false);
+      return OneSignalPrefs.getBool(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_OS_FILTER_OTHER_GCM_RECEIVERS,
+              false);
    }
 
    static void saveFilterOtherGCMReceivers(boolean set) {
       if (appContext == null)
          return;
 
-      OneSignalPrefs.saveBool(OneSignalPrefs.PREFS_ONESIGNAL,"OS_FILTER_OTHER_GCM_RECEIVERS",set);
+      OneSignalPrefs.saveBool(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              "OS_FILTER_OTHER_GCM_RECEIVERS",
+              set);
    }
 
    // Called when a player id is returned from OneSignal
@@ -2312,13 +2333,17 @@ static void updateEmailIdDependents(String emailId) {
    }
 
    static boolean getFirebaseAnalyticsEnabled() {
-      return OneSignalPrefs.getBool(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_GT_FIREBASE_TRACKING_ENABLED,false);
+      return OneSignalPrefs.getBool(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_GT_FIREBASE_TRACKING_ENABLED,
+              false);
    }
 
    static boolean getClearGroupSummaryClick() {
-      return OneSignalPrefs.getBool(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_OS_CLEAR_GROUP_SUMMARY_CLICK,true);
+      return OneSignalPrefs.getBool(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_OS_CLEAR_GROUP_SUMMARY_CLICK,
+              true);
    }
 
 
@@ -2335,13 +2360,17 @@ public static void enableVibrate(boolean enable) {
       if (appContext == null)
          return;
 
-      OneSignalPrefs.saveBool(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_GT_VIBRATE_ENABLED,enable);
+      OneSignalPrefs.saveBool(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_GT_VIBRATE_ENABLED,
+              enable);
    }
 
-   static boolean getVibrate(Context context) {
-      return OneSignalPrefs.getBool(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_GT_VIBRATE_ENABLED,true);
+   static boolean getVibrate() {
+      return OneSignalPrefs.getBool(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_GT_VIBRATE_ENABLED,
+              true);
    }
 
    // If true(default) - Sound plays when receiving notification. Vibrates when device is on vibrate only mode.
@@ -2361,19 +2390,25 @@ public static void enableSound(boolean enable) {
               OneSignalPrefs.PREFS_GT_SOUND_ENABLED,enable);
    }
 
-   static boolean getSoundEnabled(Context context) {
-      return OneSignalPrefs.getBool(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_GT_SOUND_ENABLED,true);
+   static boolean getSoundEnabled() {
+      return OneSignalPrefs.getBool(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_GT_SOUND_ENABLED,
+              true);
    }
 
    static void setLastSessionTime(long time) {
-      OneSignalPrefs.saveLong(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_OS_LAST_SESSION_TIME,time);
+      OneSignalPrefs.saveLong(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_OS_LAST_SESSION_TIME,
+              time);
    }
 
-   private static long getLastSessionTime(Context context) {
-      return OneSignalPrefs.getLong(OneSignalPrefs.PREFS_ONESIGNAL,
-              OneSignalPrefs.PREFS_OS_LAST_SESSION_TIME,-31*1000);
+   private static long getLastSessionTime() {
+      return OneSignalPrefs.getLong(
+              OneSignalPrefs.PREFS_ONESIGNAL,
+              OneSignalPrefs.PREFS_OS_LAST_SESSION_TIME,
+              -31 * 1000L);
    }
 
    /**
@@ -3090,7 +3125,7 @@ static boolean isAppActive() {
    }
 
    private static boolean isPastOnSessionTime() {
-      return (System.currentTimeMillis() - getLastSessionTime(appContext)) >= MIN_ON_SESSION_TIME_MILLIS;
+      return (System.currentTimeMillis() - getLastSessionTime()) >= MIN_ON_SESSION_TIME_MILLIS;
    }
 
    // Extra check to make sure we don't unsubscribe devices that rely on silent background notifications.

OneSignalSDK/unittest/src/main/AndroidManifest.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-          package="com.onesignal.example">
+    package="com.onesignal.example">
 
     <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
     <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>