Move outcome table access to OSOutcomeEventsCache

* OneSignalCacheCleaner shouldn't have access to the outcome table when we have a class responsible for managing the outcome database table

Author: Jeasmine

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

@@ -1,6 +1,7 @@
 package com.onesignal;
 
 import android.os.Process;
+
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
@@ -21,6 +22,8 @@ class OSOutcomeEventsController {
     private static final String OS_SEND_SAVED_OUTCOMES = "OS_SEND_SAVED_OUTCOMES";
     private static final String OS_SAVE_UNIQUE_OUTCOME_NOTIFICATIONS = "OS_SAVE_UNIQUE_OUTCOME_NOTIFICATIONS";
 
+    private final static String OS_DELETE_CACHED_UNIQUE_OUTCOMES_NOTIFICATIONS_THREAD = "OS_DELETE_CACHED_UNIQUE_OUTCOMES_NOTIFICATIONS_THREAD";
+
     // Keeps track of unique outcome events sent for UNATTRIBUTED sessions on a per session level
     private Set<String> unattributedUniqueOutcomeEventsSentOnSession;
 
@@ -56,6 +59,21 @@ void cleanOutcomes() {
         saveUnattributedUniqueOutcomeEvents();
     }
 
+    /**
+     * Deletes cached unique outcome notifications whose ids do not exist inside of the NotificationTable.TABLE_NAME
+     */
+    void cleanCachedUniqueOutcomes() {
+        new Thread(new Runnable() {
+            @Override
+            public void run() {
+                Thread.currentThread().setPriority(Process.THREAD_PRIORITY_BACKGROUND);
+
+                outcomeEventsFactory.getRepository().cleanCachedUniqueOutcomeEventNotifications(
+                        OneSignalDbContract.NotificationTable.TABLE_NAME, OneSignalDbContract.NotificationTable.COLUMN_NAME_NOTIFICATION_ID);
+            }
+        }, OS_DELETE_CACHED_UNIQUE_OUTCOMES_NOTIFICATIONS_THREAD).start();
+    }
+
     /**
      * Any outcomes cached in local DB will be reattempted to be sent again
      * Cached outcomes come from the failure callback of the network request

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

@@ -840,6 +840,7 @@ private static void setupContextListeners(boolean wasAppContextNull) {
 
          sessionManager.initSessionFromCache();
          outcomeEventsController = new OSOutcomeEventsController(sessionManager, outcomeEventsFactory);
+         outcomeEventsController.cleanCachedUniqueOutcomes();
          // Prefs require a context to save
          // If the previous state of appContext was null, kick off write in-case it was waiting
          OneSignalPrefs.startDelayedWrite();

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

@@ -39,7 +39,6 @@ public void run() {
                 Thread.currentThread().setPriority(Process.THREAD_PRIORITY_BACKGROUND);
 
                 cleanCachedNotifications(writableDb);
-                cleanCachedUniqueOutcomeEventNotifications(writableDb);
             }
 
         }, OS_DELETE_CACHED_NOTIFICATIONS_THREAD).start();
@@ -86,25 +85,4 @@ private static void cleanCachedNotifications(OneSignalDbHelper writableDb) {
                 whereArgs);
     }
 
-    /**
-     * Deletes cached unique outcome notifications whose ids do not exist inside of the NotificationTable.TABLE_NAME
-     * <br/><br/>
-     * Note: This should only ever be called by {@link OneSignalCacheCleaner#cleanNotificationCache(OneSignalDbHelper)}
-     * <br/><br/>
-     *
-     * @see OneSignalCacheCleaner#cleanNotificationCache(OneSignalDbHelper)
-     */
-    private static void cleanCachedUniqueOutcomeEventNotifications(OneSignalDbHelper writableDb) {
-        String whereStr = "NOT EXISTS(" +
-                "SELECT NULL FROM " + NotificationTable.TABLE_NAME + " n " +
-                "WHERE" + " n." + NotificationTable.COLUMN_NAME_NOTIFICATION_ID + " = " + OutcomesDbContract.CACHE_UNIQUE_OUTCOME_COLUMN_CHANNEL_INFLUENCE_ID +
-                " AND " + OutcomesDbContract.CACHE_UNIQUE_OUTCOME_COLUMN_CHANNEL_TYPE + " = \"" + OSInfluenceChannel.NOTIFICATION.toString().toLowerCase() +
-                "\")";
-
-        writableDb.delete(
-                OutcomesDbContract.CACHE_UNIQUE_OUTCOME_TABLE,
-                whereStr,
-                null);
-    }
-
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/outcomes/data/OSOutcomeEventsCache.kt

@@ -2,6 +2,7 @@ package com.onesignal.outcomes.data
 
 import android.content.ContentValues
 import android.database.Cursor
+import android.database.sqlite.SQLiteDatabase
 import androidx.annotation.WorkerThread
 import com.onesignal.OSLogger
 import com.onesignal.OSSharedPreferences
@@ -311,4 +312,21 @@ internal class OSOutcomeEventsCache(private val logger: OSLogger,
         }
         return uniqueInfluences
     }
+
+    /**
+     * Deletes cached unique outcome notifications whose ids do not exist inside of the NotificationTable.TABLE_NAME
+     */
+    @WorkerThread
+    @Synchronized
+    fun cleanCachedUniqueOutcomeEventNotifications(notificationTableName: String, notificationIdColumnName: String) {
+        val whereStr = "NOT EXISTS(" +
+                "SELECT NULL FROM " + notificationTableName + " n " +
+                "WHERE" + " n." + notificationIdColumnName + " = " + OutcomesDbContract.CACHE_UNIQUE_OUTCOME_COLUMN_CHANNEL_INFLUENCE_ID +
+                " AND " + OutcomesDbContract.CACHE_UNIQUE_OUTCOME_COLUMN_CHANNEL_TYPE + " = \"" + OSInfluenceChannel.NOTIFICATION.toString().toLowerCase(Locale.ROOT) +
+                "\")"
+        dbHelper.delete(
+                OutcomesDbContract.CACHE_UNIQUE_OUTCOME_TABLE,
+                whereStr,
+                null)
+    }
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/outcomes/data/OSOutcomeEventsRepository.kt

@@ -41,4 +41,8 @@ internal abstract class OSOutcomeEventsRepository(protected val logger: OSLogger
         logger.debug("OneSignal save unattributedUniqueOutcomeEvents: $unattributedUniqueOutcomeEvents")
         outcomeEventsCache.saveUnattributedUniqueOutcomeEventsSentByChannel(unattributedUniqueOutcomeEvents)
     }
+
+    override fun cleanCachedUniqueOutcomeEventNotifications(notificationTableName: String, notificationIdColumnName: String) {
+        outcomeEventsCache.cleanCachedUniqueOutcomeEventNotifications(notificationTableName, notificationIdColumnName);
+    }
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/outcomes/domain/OSOutcomeEventsRepository.kt

@@ -12,4 +12,5 @@ interface OSOutcomeEventsRepository {
     fun getNotCachedUniqueOutcome(name: String, influences: List<OSInfluence>): List<OSInfluence>
     fun getUnattributedUniqueOutcomeEventsSent(): Set<String>?
     fun saveUnattributedUniqueOutcomeEventsSent(unattributedUniqueOutcomeEvents: Set<String>)
+    fun cleanCachedUniqueOutcomeEventNotifications(notificationTableName: String, notificationIdColumnName: String);
 }