Merge pull request #595 from OneSignal/send_tags_handler

Nightsd01 · web-flow · commit 3d81d89157cd · 2018-07-24T18:23:50.000-07:00
Add Update Handler for Send/Delete Tags
diff --git a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignal.java b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignal.java
@@ -143,6 +143,24 @@ public interface GetTagsHandler {
       void tagsAvailable(JSONObject tags);
    }
 
+   public interface ChangeTagsUpdateHandler {
+      void onSuccess(JSONObject tags);
+      void onFailure(SendTagsError error);
+   }
+
+   public static class SendTagsError {
+      private String message;
+      private int code;
+
+      SendTagsError(int errorCode, String errorMessage) {
+         this.message = errorMessage;
+         this.code = errorCode;
+      }
+
+      public int getCode() { return code; }
+      public String getMessage() { return message; }
+   }
+
 
    public enum EmailErrorType {
       VALIDATION, REQUIRES_EMAIL_AUTH, INVALID_OPERATION, NETWORK
@@ -869,6 +887,13 @@ private static void fireCallbackForOpenedNotifications() {
 
       unprocessedOpenedNotifis.clear();
    }
+   /**
+    * Please do not use this method for logging, it is meant solely to be
+    * used by our wrapper SDK's.
+    */
+   public static void onesignalLog(LOG_LEVEL level, String message) {
+      OneSignal.Log(level, message);
+   }
 
    public static boolean userProvidedPrivacyConsent() {
       return getSavedUserConsentStatus();
@@ -1422,6 +1447,24 @@ public static void sendTags(String jsonString) {
     *
     */
    public static void sendTags(final JSONObject keyValues) {
+      sendTags(keyValues, null);
+   }
+
+   /**
+    * Tag a user based on an app event of your choosing so later you can create
+    * <a href="https://documentation.onesignal.com/docs/segmentation">OneSignal Segments</a>
+    *  to target these users.
+    *
+    *  NOTE: The ChangeTagsUpdateHandler will not be called under all circumstances. It can also take
+    *  more than 5 seconds in some cases to be called, so please do not block any user action
+    *  based on this callback.
+    * @param keyValues Key value pairs of your choosing to create or update. <b>Note:</b>
+    *                  Passing in a blank String as a value deletes a key.
+    *                  You can also call {@link #deleteTag(String)} or {@link #deleteTags(String)}.
+    *
+    */
+   public static void sendTags(final JSONObject keyValues, ChangeTagsUpdateHandler handler) {
+      final ChangeTagsUpdateHandler tagsHandler = handler;
 
       //if applicable, check if the user provided privacy consent
       if (shouldLogUserPrivacyConsentErrorMessageForMethodName("sendTags()"))
@@ -1430,10 +1473,13 @@ public static void sendTags(final JSONObject keyValues) {
       Runnable sendTagsRunnable = new Runnable() {
          @Override
          public void run() {
-            if (keyValues == null) return;
+            if (keyValues == null) {
+               if (tagsHandler != null)
+                  tagsHandler.onFailure(new SendTagsError(-1, "Attempted to send null tags"));
+               return;
+            }
 
             JSONObject existingKeys = OneSignalStateSynchronizer.getTags(false).result;
-
             JSONObject toSend = new JSONObject();
 
             Iterator<String> keys = keyValues.keys();
@@ -1456,15 +1502,21 @@ else if (keyValues.isNull(key) || "".equals(value)) {
                catch (Throwable t) {}
             }
 
-            if (!toSend.toString().equals("{}"))
-               OneSignalStateSynchronizer.sendTags(toSend);
+            if (!toSend.toString().equals("{}")) {
+               OneSignalStateSynchronizer.sendTags(toSend, tagsHandler);
+            } else {
+               tagsHandler.onSuccess(existingKeys);
+            }
          }
       };
 
 
       if (appContext == null || shouldRunTaskThroughQueue()) {
          Log(LOG_LEVEL.ERROR, "You must initialize OneSignal before modifying tags!" +
                  "Moving this operation to a pending task queue.");
+         if (tagsHandler != null)
+            tagsHandler.onFailure(new SendTagsError(-1, "You must initialize OneSignal before modifying tags!" +
+                    "Moving this operation to a pending task queue."));
          addTaskToQueue(new PendingTaskRunnable(sendTagsRunnable));
          return;
       }
@@ -1612,14 +1664,17 @@ public void run() {
     * @param key Key to remove.
     */
    public static void deleteTag(String key) {
+      deleteTag(key, null);
+   }
 
+   public static void deleteTag(String key, ChangeTagsUpdateHandler handler) {
       //if applicable, check if the user provided privacy consent
       if (shouldLogUserPrivacyConsentErrorMessageForMethodName("deleteTag()"))
          return;
 
       Collection<String> tempList = new ArrayList<>(1);
       tempList.add(key);
-      deleteTags(tempList);
+      deleteTags(tempList, handler);
    }
 
    /**
@@ -1628,7 +1683,10 @@ public static void deleteTag(String key) {
     * @param keys Keys to remove.
     */
    public static void deleteTags(Collection<String> keys) {
+      deleteTags(keys, null);
+   }
 
+   public static void deleteTags(Collection<String> keys, ChangeTagsUpdateHandler handler) {
       //if applicable, check if the user provided privacy consent
       if (shouldLogUserPrivacyConsentErrorMessageForMethodName("deleteTags()"))
          return;
@@ -1638,14 +1696,17 @@ public static void deleteTags(Collection<String> keys) {
          for (String key : keys)
             jsonTags.put(key, "");
 
-         sendTags(jsonTags);
+         sendTags(jsonTags, handler);
       } catch (Throwable t) {
          Log(LOG_LEVEL.ERROR, "Failed to generate JSON for deleteTags.", t);
       }
    }
 
    public static void deleteTags(String jsonArrayString) {
+      deleteTags(jsonArrayString, null);
+   }
 
+   public static void deleteTags(String jsonArrayString, ChangeTagsUpdateHandler handler) {
       //if applicable, check if the user provided privacy consent
       if (shouldLogUserPrivacyConsentErrorMessageForMethodName("deleteTags()"))
          return;
@@ -1657,7 +1718,7 @@ public static void deleteTags(String jsonArrayString) {
          for (int i = 0; i < jsonArray.length(); i++)
             jsonTags.put(jsonArray.getString(i), "");
 
-         sendTags(jsonTags);
+         sendTags(jsonTags, handler);
       } catch (Throwable t) {
          Log(LOG_LEVEL.ERROR, "Failed to generate JSON for deleteTags.", t);
       }
@@ -2138,6 +2199,10 @@ public static void setInFocusDisplaying(int displayOption) {
       setInFocusDisplaying(getInFocusDisplaying(displayOption));
    }
 
+   public static OSInFocusDisplayOption currentInFocusDisplayOption() {
+      return getCurrentOrNewInitBuilder().mDisplayOption;
+   }
+
    private static OSInFocusDisplayOption getInFocusDisplaying(int displayOption) {
       switch(displayOption) {
          case 0:
diff --git a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignalStateSynchronizer.java b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignalStateSynchronizer.java
@@ -29,6 +29,7 @@
 
 import org.json.JSONException;
 import org.json.JSONObject;
+import com.onesignal.OneSignal.ChangeTagsUpdateHandler;
 
 class OneSignalStateSynchronizer {
 
@@ -71,12 +72,13 @@ static void syncUserState(boolean fromSyncService) {
       getEmailStateSynchronizer().syncUserState(fromSyncService);
    }
 
-   static void sendTags(JSONObject newTags) {
+   static void sendTags(JSONObject newTags, ChangeTagsUpdateHandler handler) {
       try {
          JSONObject jsonField = new JSONObject().put("tags", newTags);
-         getPushStateSynchronizer().sendTags(jsonField);
-         getEmailStateSynchronizer().sendTags(jsonField);
+         getPushStateSynchronizer().sendTags(jsonField, handler);
+         getEmailStateSynchronizer().sendTags(jsonField, handler);
       } catch (JSONException e) {
+         handler.onFailure(new OneSignal.SendTagsError(-1, "Encountered an error attempting to serialize your tags into JSON: " + e.getMessage() + "\n" + e.getStackTrace()));
          e.printStackTrace();
       }
    }
diff --git a/OneSignalSDK/onesignal/src/main/java/com/onesignal/UserStateSynchronizer.java b/OneSignalSDK/onesignal/src/main/java/com/onesignal/UserStateSynchronizer.java
@@ -2,10 +2,13 @@
 
 import android.os.Handler;
 import android.os.HandlerThread;
+import com.onesignal.OneSignal.ChangeTagsUpdateHandler;
+import com.onesignal.OneSignal.SendTagsError;
 
 import org.json.JSONException;
 import org.json.JSONObject;
 
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicBoolean;
@@ -34,6 +37,11 @@ String getRegistrationId() {
     abstract GetTagsResult getTags(boolean fromServer);
 
     private AtomicBoolean runningSyncUserState = new AtomicBoolean();
+
+    // maintain an array of handlers so that if the user calls
+    // sendTags() multiple times, it will call each callback
+    private ArrayList<ChangeTagsUpdateHandler> sendTagsHandlers = new ArrayList<ChangeTagsUpdateHandler>();
+
     class NetworkHandlerThread extends HandlerThread {
         protected static final int NETWORK_HANDLER_USERSTATE = 0;
 
@@ -180,6 +188,15 @@ private void internalSyncUserState(boolean fromSyncService) {
 
             if (jsonBody == null) {
                 currentUserState.persistStateAfterSync(dependDiff, null);
+
+                for (ChangeTagsUpdateHandler handler : this.sendTagsHandlers) {
+                    if (handler != null) {
+                        handler.onSuccess(OneSignalStateSynchronizer.getTags(false).result);
+                    }
+                }
+
+                this.sendTagsHandlers.clear();
+                
                 return;
             }
             getToSyncUserState().persistState();
@@ -249,8 +266,21 @@ private void logoutEmailSyncSuccess() {
     }
 
     private void doPutSync(String userId, final JSONObject jsonBody, final JSONObject dependDiff) {
-        if (userId == null)
+        if (userId == null) {
+            for (ChangeTagsUpdateHandler handler : this.sendTagsHandlers) {
+                if (handler != null) {
+                    handler.onFailure(new SendTagsError(-1, "Unable to update tags: the current user is not registered with OneSignal"));
+                }
+            }
+
+            this.sendTagsHandlers.clear();
+
             return;
+        }
+        
+        final ArrayList<ChangeTagsUpdateHandler> tagsHandlers = (ArrayList<ChangeTagsUpdateHandler>) this.sendTagsHandlers.clone();
+
+        this.sendTagsHandlers.clear();
 
         OneSignalRestClient.putSync("players/" + userId, jsonBody, new OneSignalRestClient.ResponseHandler() {
             @Override
@@ -261,12 +291,29 @@ void onFailure(int statusCode, String response, Throwable throwable) {
                     handlePlayerDeletedFromServer();
                 else
                     handleNetworkFailure();
+
+                if (jsonBody.has("tags"))
+                    for (ChangeTagsUpdateHandler handler : tagsHandlers) {
+                        if (handler != null) {
+                            handler.onFailure(new SendTagsError(statusCode, response));
+                        }
+                    }
+
             }
 
             @Override
             void onSuccess(String response) {
                 currentUserState.persistStateAfterSync(dependDiff, jsonBody);
                 onSuccessfulSync(jsonBody);
+                JSONObject tags = OneSignalStateSynchronizer.getTags(false).result;
+
+                if (jsonBody.has("tags") && tags != null)
+                    for (ChangeTagsUpdateHandler handler : tagsHandlers) {
+                        if (handler != null) {
+                            handler.onSuccess(tags);
+                        }
+                    }
+
             }
         });
     }
@@ -385,7 +432,8 @@ void setSyncAsNewSession() {
     }
 
 
-    void sendTags(JSONObject tags) {
+    void sendTags(JSONObject tags, ChangeTagsUpdateHandler handler) {
+        this.sendTagsHandlers.add(handler);
         JSONObject userStateTags = getUserStateForModification().syncValues;
         generateJsonDiff(userStateTags, tags, userStateTags, null);
     }
diff --git a/OneSignalSDK/unittest/src/test/java/com/test/onesignal/MainOneSignalClassRunner.java b/OneSignalSDK/unittest/src/test/java/com/test/onesignal/MainOneSignalClassRunner.java
