Rollout cache manager in SDK init (#718)

splitio · Dec 4, 2024 · 943229c · 943229c
1 parent 35ed81b
commit 943229c
Show file tree

Hide file tree

Showing 25 changed files with 316 additions and 147 deletions.
diff --git a/src/androidTest/java/fake/SynchronizerSpyImpl.java b/src/androidTest/java/fake/SynchronizerSpyImpl.java
@@ -3,6 +3,7 @@
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.atomic.AtomicInteger;
 
+import io.split.android.client.api.Key;
 import io.split.android.client.dtos.Event;
 import io.split.android.client.impressions.Impression;
 import io.split.android.client.service.synchronizer.Synchronizer;
@@ -122,12 +123,12 @@ public void unregisterAttributesSynchronizer(String userKey) {
     }
 
     @Override
-    public void registerMySegmentsSynchronizer(String userKey, MySegmentsSynchronizer mySegmentsSynchronizer) {
-        ((MySegmentsSynchronizerRegistry) mSynchronizer).registerMySegmentsSynchronizer(userKey, mySegmentsSynchronizer);
+    public void registerMySegmentsSynchronizer(Key key, MySegmentsSynchronizer mySegmentsSynchronizer) {
+        ((MySegmentsSynchronizerRegistry) mSynchronizer).registerMySegmentsSynchronizer(key, mySegmentsSynchronizer);
     }
 
     @Override
-    public void unregisterMySegmentsSynchronizer(String userKey) {
-        ((MySegmentsSynchronizerRegistry) mSynchronizer).unregisterMySegmentsSynchronizer(userKey);
+    public void unregisterMySegmentsSynchronizer(Key key) {
+        ((MySegmentsSynchronizerRegistry) mSynchronizer).unregisterMySegmentsSynchronizer(key);
     }
 }
diff --git a/src/androidTest/java/tests/database/DatabaseInitializationTest.java b/src/androidTest/java/tests/database/DatabaseInitializationTest.java
@@ -182,6 +182,11 @@ public void usingNullPrefixResultsInIgnoredPrefix() {
 
     private static String[] getDbList(Context context) {
         // remove -journal dbs since we're not interested in them
+        try {
+            Thread.sleep(500);
+        } catch (InterruptedException e) {
+            throw new RuntimeException(e);
+        }
         return Arrays.stream(context.databaseList()).filter(db -> !db.endsWith("-journal")).toArray(String[]::new);
     }
 }
diff --git a/src/androidTest/java/tests/integration/attributes/AttributesIntegrationTest.java b/src/androidTest/java/tests/integration/attributes/AttributesIntegrationTest.java
@@ -108,7 +108,7 @@ public void testPersistentAttributes2() throws InterruptedException {
         // 3. Perform clear and verify there are no attributes on DB
         client.clearAttributes();
 
-        countDownLatch.await(1, TimeUnit.SECONDS);
+        countDownLatch.await(7, TimeUnit.SECONDS);
 
         Assert.assertNull(mRoomDb.attributesDao().getByUserKey(userKey));
     }
@@ -153,7 +153,7 @@ public void testPersistentAttributesWithMultiClient2() throws InterruptedExcepti
 
         // 2. Clear second client's attributes and check DB entry has been cleared
         client2.clearAttributes();
-        countDownLatch.await(1, TimeUnit.SECONDS); // waiting since DB operations are async
+        countDownLatch.await(7, TimeUnit.SECONDS); // waiting since DB operations are async
         Assert.assertNull(mRoomDb.attributesDao().getByUserKey("new_key"));
 
         // 3. Verify evaluation with first client uses attribute
@@ -162,7 +162,7 @@ public void testPersistentAttributesWithMultiClient2() throws InterruptedExcepti
         // 4. Perform clear and verify there are no attributes on DB
         client.clearAttributes();
 
-        countDownLatch.await(1, TimeUnit.SECONDS);
+        countDownLatch.await(7, TimeUnit.SECONDS);
 
         Assert.assertNull(mRoomDb.attributesDao().getByUserKey(matchingKey));
     }

diff --git a/src/androidTest/java/tests/integration/encryption/EncryptionTest.java b/src/androidTest/java/tests/integration/encryption/EncryptionTest.java
@@ -127,7 +127,7 @@ public void onPostExecutionView(SplitClient client) {
             }
         });
 
-        assertTrue(latch.await(2, TimeUnit.SECONDS));
+        assertTrue(latch.await(5, TimeUnit.SECONDS));
         mLifecycleManager.simulateOnPause();
         Thread.sleep(200);
         mLifecycleManager.simulateOnResume();

diff --git a/src/androidTest/java/tests/integration/largesegments/LargeSegmentsStreamingTest.java b/src/androidTest/java/tests/integration/largesegments/LargeSegmentsStreamingTest.java
@@ -67,8 +67,8 @@ public void setUp() throws IOException, InterruptedException {
     public void unboundedLargeSegmentsUpdateTriggersSdkUpdate() throws IOException, InterruptedException {
         TestSetup testSetup = getTestSetup();
 
-        boolean mySegmentsAwait = mLatches.get(MY_SEGMENTS).await(10, TimeUnit.SECONDS);
-        boolean splitsAwait = mLatches.get(SPLIT_CHANGES).await(10, TimeUnit.SECONDS);
+        boolean mySegmentsAwait = mLatches.get(MY_SEGMENTS).await(15, TimeUnit.SECONDS);
+        boolean splitsAwait = mLatches.get(SPLIT_CHANGES).await(15, TimeUnit.SECONDS);
         String initialSegmentList = testSetup.database.myLargeSegmentDao().getByUserKey(IntegrationHelper.dummyUserKey().matchingKey()).getSegmentList();
         mRandomizeMyLargeSegments.set(true);
 

diff --git a/src/androidTest/java/tests/integration/shared/SharedClientsIntegrationTest.java b/src/androidTest/java/tests/integration/shared/SharedClientsIntegrationTest.java
@@ -159,8 +159,8 @@ public void onPostExecutionView(SplitClient client) {
             }
         });
         insertSplitsIntoDb();
-        readyLatch.await(10, TimeUnit.SECONDS);
-        readyLatch2.await(10, TimeUnit.SECONDS);
+        readyLatch.await(15, TimeUnit.SECONDS);
+        readyLatch2.await(15, TimeUnit.SECONDS);
 
         assertEquals(1, readyCount.get());
         assertEquals(1, readyCount2.get());

diff --git a/src/androidTest/java/tests/integration/telemetry/TelemetryOccupancyTest.java b/src/androidTest/java/tests/integration/telemetry/TelemetryOccupancyTest.java
@@ -6,16 +6,16 @@
 import org.junit.Test;
 
 import java.io.IOException;
+import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.CountDownLatch;
 
 import helper.TestableSplitConfigBuilder;
 import io.split.android.client.SplitClientConfig;
-import io.split.android.client.storage.db.StorageFactory;
 import io.split.android.client.telemetry.model.streaming.OccupancyPriStreamingEvent;
 import io.split.android.client.telemetry.model.streaming.OccupancySecStreamingEvent;
 import io.split.android.client.telemetry.model.streaming.StreamingEvent;
 import io.split.android.client.telemetry.model.streaming.TokenRefreshStreamingEvent;
-import io.split.android.client.telemetry.storage.TelemetryStorage;
 import tests.integration.streaming.OccupancyBaseTest;
 
 public class TelemetryOccupancyTest extends OccupancyBaseTest {
@@ -35,12 +35,19 @@ public class TelemetryOccupancyTest extends OccupancyBaseTest {
 
     @Test
     public void telemetryOccupancyPriStreamingEvent() throws InterruptedException, IOException {
+        new CountDownLatch(1);
         getSplitFactory(mTelemetryEnabledConfig);
 
         pushOccupancy(PRIMARY_CHANNEL, 1);
-        sleep(2000);
 
-        List<StreamingEvent> streamingEvents = mTelemetryStorage.popStreamingEvents();
+        long startTime = System.currentTimeMillis();
+        List<StreamingEvent> streamingEvents = new ArrayList<>();
+        streamingEvents = mTelemetryStorage.popStreamingEvents();
+        while (System.currentTimeMillis() - startTime < 5000 &&
+                !streamingEvents.stream().anyMatch(event -> event instanceof OccupancyPriStreamingEvent)) {
+            Thread.sleep(100);
+            streamingEvents = mTelemetryStorage.popStreamingEvents();
+        }
         assertTrue(streamingEvents.stream().anyMatch(event -> event instanceof OccupancyPriStreamingEvent));
     }
 
@@ -51,7 +58,14 @@ public void telemetryOccupancySecStreamingEvent() throws InterruptedException, I
         pushOccupancy(SECONDARY_CHANNEL, 1);
         sleep(2000);
 
-        List<StreamingEvent> streamingEvents = mTelemetryStorage.popStreamingEvents();
+        long startTime = System.currentTimeMillis();
+        List<StreamingEvent> streamingEvents = new ArrayList<>();
+        streamingEvents = mTelemetryStorage.popStreamingEvents();
+        while (System.currentTimeMillis() - startTime < 5000 &&
+                !streamingEvents.stream().anyMatch(event -> event instanceof OccupancySecStreamingEvent)) {
+            Thread.sleep(100);
+            streamingEvents = mTelemetryStorage.popStreamingEvents();
+        }
         assertTrue(streamingEvents.stream().anyMatch(event -> event instanceof OccupancySecStreamingEvent));
     }
 

diff --git a/src/main/java/io/split/android/client/SplitFactoryHelper.java b/src/main/java/io/split/android/client/SplitFactoryHelper.java
@@ -4,6 +4,7 @@
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.VisibleForTesting;
 import androidx.core.util.Pair;
 import androidx.work.WorkManager;
 
@@ -22,11 +23,15 @@
 
 import io.split.android.client.common.CompressionUtilProvider;
 import io.split.android.client.events.EventsManagerCoordinator;
+import io.split.android.client.events.SplitInternalEvent;
+import io.split.android.client.lifecycle.SplitLifecycleManager;
 import io.split.android.client.network.HttpClient;
 import io.split.android.client.network.SdkTargetPath;
 import io.split.android.client.network.SplitHttpHeadersBuilder;
 import io.split.android.client.service.ServiceFactory;
 import io.split.android.client.service.SplitApiFacade;
+import io.split.android.client.service.executor.SplitSingleThreadTaskExecutor;
+import io.split.android.client.service.executor.SplitTaskExecutionInfo;
 import io.split.android.client.service.executor.SplitTaskExecutionListener;
 import io.split.android.client.service.executor.SplitTaskExecutor;
 import io.split.android.client.service.executor.SplitTaskFactory;
@@ -56,6 +61,8 @@
 import io.split.android.client.service.sseclient.sseclient.SseHandler;
 import io.split.android.client.service.sseclient.sseclient.SseRefreshTokenTimer;
 import io.split.android.client.service.sseclient.sseclient.StreamingComponents;
+import io.split.android.client.service.synchronizer.RolloutCacheManager;
+import io.split.android.client.service.synchronizer.RolloutCacheManagerImpl;
 import io.split.android.client.service.synchronizer.SyncGuardian;
 import io.split.android.client.service.synchronizer.SyncGuardianImpl;
 import io.split.android.client.service.synchronizer.SyncManager;
@@ -70,7 +77,6 @@
 import io.split.android.client.shared.ClientComponentsRegisterImpl;
 import io.split.android.client.shared.UserConsent;
 import io.split.android.client.storage.attributes.PersistentAttributesStorage;
-import io.split.android.client.storage.cipher.EncryptionMigrationTask;
 import io.split.android.client.storage.cipher.SplitCipher;
 import io.split.android.client.storage.cipher.SplitCipherFactory;
 import io.split.android.client.storage.cipher.SplitEncryptionLevel;
@@ -86,6 +92,7 @@
 import io.split.android.client.telemetry.storage.TelemetryRuntimeProducer;
 import io.split.android.client.telemetry.storage.TelemetryStorage;
 import io.split.android.client.utils.Utils;
+import io.split.android.client.utils.logger.Logger;
 
 class SplitFactoryHelper {
     private static final int DB_MAGIC_CHARS_COUNT = 4;
@@ -399,21 +406,10 @@ public ProcessStrategy getImpressionStrategy(SplitTaskExecutor splitTaskExecutor
                 .getStrategy(config.impressionsMode());
     }
 
-    SplitCipher migrateEncryption(String apiKey,
-                                  SplitRoomDatabase splitDatabase,
-                                  SplitTaskExecutor splitTaskExecutor,
-                                  final boolean encryptionEnabled,
-                                  SplitTaskExecutionListener executionListener) {
-
-        SplitCipher toCipher = SplitCipherFactory.create(apiKey, encryptionEnabled ? SplitEncryptionLevel.AES_128_CBC :
+    @Nullable
+    SplitCipher getCipher(String apiKey, boolean encryptionEnabled) {
+        return SplitCipherFactory.create(apiKey, encryptionEnabled ? SplitEncryptionLevel.AES_128_CBC :
                 SplitEncryptionLevel.NONE);
-        splitTaskExecutor.submit(new EncryptionMigrationTask(apiKey,
-                        splitDatabase,
-                        encryptionEnabled,
-                        toCipher),
-                executionListener);
-
-        return toCipher;
     }
 
     @Nullable
@@ -486,4 +482,75 @@ public URI build(String matchingKey) throws URISyntaxException {
             return SdkTargetPath.mySegments(mEndpoint, matchingKey);
         }
     }
+
+    static class Initializer implements Runnable {
+
+        private final RolloutCacheManager mRolloutCacheManager;
+        private final SplitTaskExecutionListener mListener;
+
+        Initializer(
+                String apiToken,
+                SplitClientConfig config,
+                SplitTaskFactory splitTaskFactory,
+                SplitRoomDatabase splitDatabase,
+                SplitCipher splitCipher,
+                EventsManagerCoordinator eventsManagerCoordinator,
+                SplitTaskExecutor splitTaskExecutor,
+                SplitSingleThreadTaskExecutor splitSingleThreadTaskExecutor,
+                SplitStorageContainer storageContainer,
+                SyncManager syncManager,
+                SplitLifecycleManager lifecycleManager) {
+
+            this(new RolloutCacheManagerImpl(config,
+                            storageContainer,
+                            splitTaskFactory.createCleanUpDatabaseTask(System.currentTimeMillis() / 1000),
+                            splitTaskFactory.createEncryptionMigrationTask(apiToken, splitDatabase, config.encryptionEnabled(), splitCipher)),
+                    new Listener(eventsManagerCoordinator, splitTaskExecutor, splitSingleThreadTaskExecutor, syncManager, lifecycleManager));
+        }
+
+        @VisibleForTesting
+        Initializer(RolloutCacheManager rolloutCacheManager, SplitTaskExecutionListener listener) {
+            mRolloutCacheManager = rolloutCacheManager;
+            mListener = listener;
+        }
+
+        @Override
+        public void run() {
+            mRolloutCacheManager.validateCache(mListener);
+        }
+
+        static class Listener implements SplitTaskExecutionListener {
+
+            private final EventsManagerCoordinator mEventsManagerCoordinator;
+            private final SplitTaskExecutor mSplitTaskExecutor;
+            private final SplitSingleThreadTaskExecutor mSplitSingleThreadTaskExecutor;
+            private final SyncManager mSyncManager;
+            private final SplitLifecycleManager mLifecycleManager;
+
+            Listener(EventsManagerCoordinator eventsManagerCoordinator,
+                     SplitTaskExecutor splitTaskExecutor,
+                     SplitSingleThreadTaskExecutor splitSingleThreadTaskExecutor,
+                     SyncManager syncManager,
+                     SplitLifecycleManager lifecycleManager) {
+                mEventsManagerCoordinator = eventsManagerCoordinator;
+                mSplitTaskExecutor = splitTaskExecutor;
+                mSplitSingleThreadTaskExecutor = splitSingleThreadTaskExecutor;
+                mSyncManager = syncManager;
+                mLifecycleManager = lifecycleManager;
+            }
+
+            @Override
+            public void taskExecuted(@NonNull SplitTaskExecutionInfo taskInfo) {
+                mEventsManagerCoordinator.notifyInternalEvent(SplitInternalEvent.ENCRYPTION_MIGRATION_DONE);
+
+                mSplitTaskExecutor.resume();
+                mSplitSingleThreadTaskExecutor.resume();
+
+                mSyncManager.start();
+                mLifecycleManager.register(mSyncManager);
+
+                Logger.i("Android SDK initialized!");
+            }
+        }
+    }
 }