Refactors several classes to use injected StorageKeyManager instances…

… instead of accessing the StorageMeyManager.GLOBAL_INSTANCE directly.

I've only updated some really simple usages to use the DI pattern. There shouldn't be any change in behaviour; everything still points to the global singleton instance for now.

PiperOrigin-RevId: 346223334

java/arcs/android/common/resurrection/DbHelper.kt

@@ -32,6 +32,7 @@ import arcs.core.storage.api.DriverAndKeyConfigurator
 @VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)
 class DbHelper(
   context: Context,
+  private val storageKeyManager: StorageKeyManager,
   dbName: String = RESURRECTION_DB_NAME
 ) : SQLiteOpenHelper(
   context,
@@ -157,7 +158,7 @@ class DbHelper(
         val notifiers =
           notifiersByComponentName[requestedNotifier]
             ?: mutableListOf()
-        notifiers.add(StorageKeyManager.GLOBAL_INSTANCE.parse(key))
+        notifiers.add(storageKeyManager.parse(key))
         notifiersByComponentName[requestedNotifier] = notifiers
       }
 

java/arcs/android/common/resurrection/ResurrectorService.kt

@@ -17,6 +17,7 @@ import android.os.Bundle
 import androidx.annotation.VisibleForTesting
 import arcs.android.common.resurrection.ResurrectionRequest.UnregisterRequest
 import arcs.core.storage.StorageKey
+import arcs.core.storage.StorageKeyManager
 import arcs.core.util.guardedBy
 import java.io.PrintWriter
 import kotlinx.coroutines.CoroutineName
@@ -42,13 +43,18 @@ abstract class ResurrectorService : Service() {
   protected open val job =
     Job() + Dispatchers.IO + CoroutineName("ResurrectorService")
 
-  private val dbHelper: DbHelper by lazy { DbHelper(this, resurrectionDatabaseName) }
+  // TODO(b/174432505): Don't use the GLOBAL_INSTANCE, accept as a constructor param instead.
+  protected val storageKeyManager = StorageKeyManager.GLOBAL_INSTANCE
+
+  private val dbHelper: DbHelper by lazy {
+    DbHelper(this, storageKeyManager, resurrectionDatabaseName)
+  }
 
   private val mutex = Mutex()
   private var registeredRequests: Set<ResurrectionRequest>
-    by guardedBy(mutex, setOf())
+  by guardedBy(mutex, setOf())
   private var registeredRequestsByNotifiers: Map<StorageKey?, Set<ResurrectionRequest>>
-    by guardedBy(mutex, mapOf())
+  by guardedBy(mutex, mapOf())
 
   @VisibleForTesting
   var loadJob: Job? = null
@@ -118,7 +124,7 @@ abstract class ResurrectorService : Service() {
       """
                 Resurrection Requests
                 ---------------------
-            """.trimIndent()
+      """.trimIndent()
     )
 
     val requests = StringBuilder().apply {

java/arcs/android/storage/database/AndroidSqliteDatabaseManager.kt

@@ -14,6 +14,7 @@ package arcs.android.storage.database
 import android.content.Context
 import androidx.lifecycle.LifecycleObserver
 import arcs.core.storage.StorageKey
+import arcs.core.storage.StorageKeyManager
 import arcs.core.storage.database.Database
 import arcs.core.storage.database.DatabaseIdentifier
 import arcs.core.storage.database.DatabaseManager
@@ -39,6 +40,9 @@ class AndroidSqliteDatabaseManager(
   private val dbCache by guardedBy(mutex, mutableMapOf<DatabaseIdentifier, DatabaseImpl>())
   override val registry = AndroidSqliteDatabaseRegistry(context)
 
+  // TODO(b/174432505): Don't use the GLOBAL_INSTANCE, accept as a constructor param instead.
+  private val storageKeyManager = StorageKeyManager.GLOBAL_INSTANCE
+
   suspend fun close() {
     mutex.withLock {
       dbCache.values.forEach { it.close() }
@@ -52,7 +56,7 @@ class AndroidSqliteDatabaseManager(
     val entry = registry.register(name, persistent)
     return mutex.withLock {
       dbCache[entry.name to entry.isPersistent]
-        ?: DatabaseImpl(context, name, persistent) {
+        ?: DatabaseImpl(context, storageKeyManager, name, persistent) {
           mutex.withLock {
             dbCache.remove(entry.name to entry.isPersistent)
           }

java/arcs/android/storage/database/DatabaseImpl.kt

@@ -108,6 +108,7 @@ typealias ReferenceId = Long
 // Our helper extension methods close Cursors correctly.
 class DatabaseImpl(
   context: Context,
+  private val storageKeyManager: StorageKeyManager,
   databaseName: String,
   persistent: Boolean = true,
   val onDatabaseClose: suspend () -> Unit = {}
@@ -435,7 +436,7 @@ class DatabaseImpl(
           } else {
             Reference(
               id = it.getString(6),
-              storageKey = StorageKeyManager.GLOBAL_INSTANCE.parse(it.getString(7)),
+              storageKey = storageKeyManager.parse(it.getString(7)),
               version = it.getVersionMap(8),
               _creationTimestamp = it.getLong(9),
               _expirationTimestamp = it.getLong(10),
@@ -1052,7 +1053,7 @@ class DatabaseImpl(
         arrayOf()
       ).forEach {
         val storageKeyId = it.getLong(0)
-        val storageKey = StorageKeyManager.GLOBAL_INSTANCE.parse(it.getString(1))
+        val storageKey = storageKeyManager.parse(it.getString(1))
         val orphan = it.getNullableBoolean(2) ?: false
         val noRef = it.getBoolean(3)
         if (orphan && noRef) {
@@ -1379,7 +1380,7 @@ class DatabaseImpl(
         )
 
         (storageKeys union updatedContainersStorageKeys).map { storageKey ->
-          notifyClients(StorageKeyManager.GLOBAL_INSTANCE.parse(storageKey)) {
+          notifyClients(storageKeyManager.parse(storageKey)) {
             it.onDatabaseDelete(null)
           }
         }
@@ -1720,7 +1721,7 @@ class DatabaseImpl(
     ReferenceWithVersion(
       Reference(
         id = it.getString(0),
-        storageKey = StorageKeyManager.GLOBAL_INSTANCE.parse(it.getString(3)),
+        storageKey = storageKeyManager.parse(it.getString(3)),
         version = it.getVersionMap(4),
         _creationTimestamp = it.getLong(1),
         _expirationTimestamp = it.getLong(2)

java/arcs/core/host/AbstractArcHost.kt

@@ -26,6 +26,7 @@ import arcs.core.host.api.HandleHolder
 import arcs.core.host.api.Particle
 import arcs.core.storage.StorageEndpointManager
 import arcs.core.storage.StorageKey
+import arcs.core.storage.StorageKeyManager
 import arcs.core.util.LruCacheMap
 import arcs.core.util.Scheduler
 import arcs.core.util.TaggedLog
@@ -87,6 +88,9 @@ abstract class AbstractArcHost(
   private val particleConstructors: MutableMap<ParticleIdentifier, ParticleConstructor> =
     mutableMapOf()
 
+  // TODO(b/174432505): Don't use the GLOBAL_INSTANCE, accept as a constructor param instead.
+  private val storageKeyManager = StorageKeyManager.GLOBAL_INSTANCE
+
   private val cacheMutex = Mutex()
 
   /** In memory cache of [ArcHostContext] state. */
@@ -353,7 +357,12 @@ abstract class AbstractArcHost(
   ): ArcHostContextParticle {
     val handleManager = entityHandleManager("$hostId-${arcHostContext.arcId}")
 
-    return ArcHostContextParticle(hostId, handleManager, this::instantiateParticle).apply {
+    return ArcHostContextParticle(
+      hostId,
+      handleManager,
+      storageKeyManager,
+      this::instantiateParticle
+    ).apply {
       val partition = createArcHostContextPersistencePlan(
         arcHostContextCapability,
         arcHostContext.arcId

java/arcs/core/host/ArcHostContextParticle.kt

@@ -47,6 +47,7 @@ typealias ArcHostContextParticle_PlanHandle = AbstractArcHostContextParticle.Pla
 class ArcHostContextParticle(
   private val hostId: String,
   private val handleManager: HandleManager,
+  private val storageKeyManager: StorageKeyManager,
   private val instantiateParticle: suspend (ParticleIdentifier, Plan.Particle?) -> Particle,
   private val instantiatedParticles: MutableMap<String, Particle> = mutableMapOf()
 ) : AbstractArcHostContextParticle() {
@@ -198,7 +199,7 @@ class ArcHostContextParticle(
     }
     handle.connectionName to Plan.HandleConnection(
       Plan.Handle(
-        StorageKeyManager.GLOBAL_INSTANCE.parse(planHandle.storageKey),
+        storageKeyManager.parse(planHandle.storageKey),
         // TODO(b/161818462): Properly serialize serialize Handle Type's schema.
         fromTag(arcId, particle, planHandle.type, handle.connectionName),
         emptyList()

java/arcs/sdk/android/labs/host/ArcHostHelper.kt

@@ -70,6 +70,7 @@ import kotlinx.coroutines.launch
  */
 class ArcHostHelper(
   private val service: Service,
+  private val storageKeyManager: StorageKeyManager,
   vararg arcHosts: ArcHost
 ) {
   private val job = SupervisorJob() + Dispatchers.Unconfined + CoroutineName("ArcHostHelper")
@@ -107,7 +108,7 @@ class ArcHostHelper(
 
     arcHost.onResurrected(
       targetId,
-      notifiers.map(StorageKeyManager.GLOBAL_INSTANCE::parse)
+      notifiers.map(storageKeyManager::parse)
     )
   }
 

java/arcs/sdk/android/labs/host/ArcHostService.kt

@@ -13,6 +13,7 @@ package arcs.sdk.android.labs.host
 import android.content.Intent
 import androidx.lifecycle.LifecycleService
 import arcs.core.host.ArcHost
+import arcs.core.storage.StorageKeyManager
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.MainScope
 import kotlinx.coroutines.cancel
@@ -23,6 +24,9 @@ import kotlinx.coroutines.cancel
 abstract class ArcHostService : LifecycleService() {
   protected val scope: CoroutineScope = MainScope()
 
+  // TODO(b/174432505): Don't use the GLOBAL_INSTANCE, accept as a constructor param instead.
+  private val storageKeyManager = StorageKeyManager.GLOBAL_INSTANCE
+
   // TODO: remove after G3 fixed
   abstract val arcHost: ArcHost
 
@@ -32,7 +36,7 @@ abstract class ArcHostService : LifecycleService() {
   open val arcHosts: List<ArcHost> by lazy { listOf(arcHost) }
 
   val arcHostHelper: ArcHostHelper by lazy {
-    ArcHostHelper(this, *arcHosts.toTypedArray())
+    ArcHostHelper(this, storageKeyManager, *arcHosts.toTypedArray())
   }
 
   override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {

javatests/arcs/android/common/resurrection/DbHelperTest.kt

@@ -15,6 +15,7 @@ import android.content.ComponentName
 import android.os.PersistableBundle
 import androidx.test.core.app.ApplicationProvider
 import androidx.test.ext.junit.runners.AndroidJUnit4
+import arcs.core.storage.StorageKeyManager
 import arcs.core.storage.keys.RamDiskStorageKey
 import com.google.common.truth.Truth.assertThat
 import org.junit.After
@@ -57,7 +58,10 @@ class DbHelperTest {
 
   @Before
   fun setUp() {
-    dbHelper = DbHelper(ApplicationProvider.getApplicationContext())
+    dbHelper = DbHelper(
+      ApplicationProvider.getApplicationContext(),
+      StorageKeyManager.GLOBAL_INSTANCE
+    )
   }
 
   @After

javatests/arcs/android/host/ArcHostHelperTest.kt

@@ -34,9 +34,9 @@ import arcs.core.host.ArcStateChangeCallback
 import arcs.core.host.ArcStateChangeRegistration
 import arcs.core.host.ParticleIdentifier
 import arcs.core.storage.StorageKey
-import arcs.core.storage.StorageKeyManager
 import arcs.core.storage.keys.VolatileStorageKey
 import arcs.core.storage.testutil.DummyStorageKey
+import arcs.core.storage.testutil.DummyStorageKeyManager
 import arcs.core.util.guardedBy
 import arcs.sdk.android.labs.host.ArcHostHelper
 import arcs.sdk.android.labs.host.ResurrectableHost
@@ -170,8 +170,7 @@ class ArcHostHelperTest {
     context = InstrumentationRegistry.getInstrumentation().targetContext
     service = Robolectric.setupService(TestAndroidArcHostService::class.java)
     arcHost = TestArcHost(context)
-    helper = ArcHostHelper(service, arcHost)
-    StorageKeyManager.GLOBAL_INSTANCE.addParser(DummyStorageKey)
+    helper = ArcHostHelper(service, DummyStorageKeyManager(), arcHost)
   }
 
   @Test

javatests/arcs/android/host/TestExternalArcHostService.kt

@@ -10,6 +10,7 @@ import arcs.core.host.ParticleRegistration
 import arcs.core.host.SchedulerProvider
 import arcs.core.host.SimpleSchedulerProvider
 import arcs.core.host.TestingHost
+import arcs.core.storage.StorageKeyManager
 import arcs.sdk.android.labs.host.ArcHostHelper
 import arcs.sdk.android.labs.host.ResurrectableHost
 import arcs.sdk.android.storage.AndroidStorageServiceEndpointManager
@@ -30,8 +31,11 @@ abstract class TestExternalArcHostService : Service() {
 
   val schedulerProvider = SimpleSchedulerProvider(Dispatchers.Default)
 
+  // TODO(b/174432505): Don't use the GLOBAL_INSTANCE, use a test-specific instance.
+  private val storageKeyManager = StorageKeyManager.GLOBAL_INSTANCE
+
   private val arcHostHelper: ArcHostHelper by lazy {
-    ArcHostHelper(this, arcHost)
+    ArcHostHelper(this, storageKeyManager, arcHost)
   }
 
   override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {

javatests/arcs/android/storage/database/DatabaseDowngradeTest.kt

@@ -18,6 +18,7 @@ import androidx.test.core.app.ApplicationProvider
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import arcs.android.common.map
 import arcs.android.common.transaction
+import arcs.core.storage.testutil.DummyStorageKeyManager
 import com.google.common.truth.Truth.assertThat
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -44,6 +45,7 @@ class DatabaseDowngradeTest {
 
     val databaseImpl = DatabaseImpl(
       ApplicationProvider.getApplicationContext(),
+      DummyStorageKeyManager(),
       "arcs",
       true
     )

javatests/arcs/android/storage/database/DatabaseImplTest.kt

@@ -37,6 +37,7 @@ import arcs.core.storage.database.DatabaseClient
 import arcs.core.storage.database.DatabaseData
 import arcs.core.storage.database.ReferenceWithVersion
 import arcs.core.storage.testutil.DummyStorageKey
+import arcs.core.storage.testutil.DummyStorageKeyManager
 import arcs.core.testutil.assertSuspendingThrows
 import arcs.core.util.ArcsDuration
 import arcs.core.util.ArcsInstant
@@ -64,7 +65,11 @@ class DatabaseImplTest {
 
   @Before
   fun setUp() {
-    database = DatabaseImpl(ApplicationProvider.getApplicationContext(), "test.sqlite3")
+    database = DatabaseImpl(
+      ApplicationProvider.getApplicationContext(),
+      DummyStorageKeyManager(),
+      "test.sqlite3"
+    )
     db = database.writableDatabase
     StorageKeyManager.GLOBAL_INSTANCE.addParser(DummyStorageKey)
   }
@@ -3784,6 +3789,7 @@ class DatabaseImplTest {
     // Makes sure in memory database can also return valid size.
     val inMemoryDatabase = DatabaseImpl(
       ApplicationProvider.getApplicationContext(),
+      DummyStorageKeyManager(),
       "test.sqlite3",
       persistent = false
     )