feat: add function to delete database (#187)

* feat: add function to delete database * write a test for it
xmtp · Feb 23, 2024 · 5da219a · 5da219a
1 parent 8cb7090
commit 5da219a
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 11 deletions.
diff --git a/library/src/androidTest/java/org/xmtp/android/library/ClientTest.kt b/library/src/androidTest/java/org/xmtp/android/library/ClientTest.kt
@@ -2,6 +2,7 @@ package org.xmtp.android.library
 
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.platform.app.InstrumentationRegistry
+import kotlinx.coroutines.runBlocking
 import org.junit.Assert.assertEquals
 import org.junit.Assert.fail
 import org.junit.Ignore
@@ -124,6 +125,49 @@ class ClientTest {
         assert(client.canMessageV3(listOf(client.address)))
     }
 
+    @Test
+    fun testCanDeleteDatabase() {
+        val context = InstrumentationRegistry.getInstrumentation().targetContext
+        val fakeWallet = PrivateKeyBuilder()
+        val fakeWallet2 = PrivateKeyBuilder()
+        var client =
+            Client().create(
+                account = fakeWallet,
+                options = ClientOptions(
+                    ClientOptions.Api(XMTPEnvironment.LOCAL, false),
+                    enableAlphaMls = true,
+                    appContext = context
+                )
+            )
+        val client2 =
+            Client().create(
+                account = fakeWallet2,
+                options = ClientOptions(
+                    ClientOptions.Api(XMTPEnvironment.LOCAL, false),
+                    enableAlphaMls = true,
+                    appContext = context
+                )
+            )
+        client.conversations.newGroup(listOf(client2.address,))
+        runBlocking { client.conversations.syncGroups() }
+        assertEquals(client.conversations.listGroups().size, 1)
+
+        client.deleteLocalDatabase()
+
+        client =
+            Client().create(
+                account = fakeWallet,
+                options = ClientOptions(
+                    ClientOptions.Api(XMTPEnvironment.LOCAL, false),
+                    enableAlphaMls = true,
+                    appContext = context
+                )
+            )
+
+        runBlocking { client.conversations.syncGroups() }
+        assertEquals(client.conversations.listGroups().size, 0)
+    }
+
     @Test
     fun testCreatesAV3DevClient() {
         val context = InstrumentationRegistry.getInstrumentation().targetContext

diff --git a/library/src/main/java/org/xmtp/android/library/Client.kt b/library/src/main/java/org/xmtp/android/library/Client.kt
@@ -85,6 +85,7 @@ class Client() {
     var logger: XMTPLogger = XMTPLogger()
     val libXMTPVersion: String = getVersionInfo()
     private var libXMTPClient: FfiXmtpClient? = null
+    private var dbPath: String = ""
 
     companion object {
         private const val TAG = "Client"
@@ -160,6 +161,7 @@ class Client() {
         privateKeyBundleV1: PrivateKeyBundleV1,
         apiClient: ApiClient,
         libXMTPClient: FfiXmtpClient? = null,
+        dbPath: String = "",
     ) : this() {
         this.address = address
         this.privateKeyBundleV1 = privateKeyBundleV1
@@ -168,6 +170,7 @@ class Client() {
         this.libXMTPClient = libXMTPClient
         this.conversations =
             Conversations(client = this, libXMTPConversations = libXMTPClient?.conversations())
+        this.dbPath = dbPath
     }
 
     fun buildFrom(
@@ -179,7 +182,7 @@ class Client() {
         val clientOptions = options ?: ClientOptions()
         val apiClient =
             GRPCApiClient(environment = clientOptions.api.env, secure = clientOptions.api.isSecure)
-        val v3Client: FfiXmtpClient? = if (isAlphaMlsEnabled(options)) {
+        val (v3Client, dbPath) = if (isAlphaMlsEnabled(options)) {
             runBlocking {
                 ffiXmtpClient(
                     options,
@@ -190,13 +193,14 @@ class Client() {
                     address
                 )
             }
-        } else null
+        } else Pair(null, " ")
 
         return Client(
             address = address,
             privateKeyBundleV1 = bundle,
             apiClient = apiClient,
-            libXMTPClient = v3Client
+            libXMTPClient = v3Client,
+            dbPath = dbPath
         )
     }
 
@@ -226,7 +230,7 @@ class Client() {
                     apiClient,
                     options
                 )
-                val libXMTPClient: FfiXmtpClient? =
+                val (libXMTPClient, dbPath) =
                     ffiXmtpClient(
                         options,
                         account,
@@ -236,7 +240,7 @@ class Client() {
                         account.address
                     )
                 val client =
-                    Client(account.address, privateKeyBundleV1, apiClient, libXMTPClient)
+                    Client(account.address, privateKeyBundleV1, apiClient, libXMTPClient, dbPath)
                 client.ensureUserContactPublished()
                 client
             } catch (e: java.lang.Exception) {
@@ -261,7 +265,7 @@ class Client() {
         val newOptions = options ?: ClientOptions()
         val apiClient =
             GRPCApiClient(environment = newOptions.api.env, secure = newOptions.api.isSecure)
-        val v3Client: FfiXmtpClient? = if (isAlphaMlsEnabled(options)) {
+        val (v3Client, dbPath) = if (isAlphaMlsEnabled(options)) {
             runBlocking {
                 ffiXmtpClient(
                     options,
@@ -272,13 +276,14 @@ class Client() {
                     address
                 )
             }
-        } else null
+        } else Pair(null, "")
 
         return Client(
             address = address,
             privateKeyBundleV1 = v1Bundle,
             apiClient = apiClient,
-            libXMTPClient = v3Client
+            libXMTPClient = v3Client,
+            dbPath = dbPath
         )
     }
 
@@ -293,12 +298,13 @@ class Client() {
         privateKeyBundleV1: PrivateKeyBundleV1,
         legacyIdentitySource: LegacyIdentitySource,
         accountAddress: String,
-    ): FfiXmtpClient? {
+    ): Pair<FfiXmtpClient?, String> {
+        var dbPath = ""
         val v3Client: FfiXmtpClient? =
             if (isAlphaMlsEnabled(options)) {
                 val alias = "xmtp-${options!!.api.env}-${accountAddress.lowercase()}"
 
-                val dbPath = if (options.dbPath == null) {
+                dbPath = if (options.dbPath == null) {
                     val dbDir = File(appContext?.filesDir?.absolutePath, "xmtp_db")
                     dbDir.mkdir()
                     dbDir.absolutePath + "/$alias.db3"
@@ -364,7 +370,7 @@ class Client() {
             }
         }
         Log.i(TAG, "LibXMTP $libXMTPVersion")
-        return v3Client
+        return Pair(v3Client, dbPath)
     }
 
     /**
@@ -586,6 +592,10 @@ class Client() {
         return !statuses.contains(false)
     }
 
+    fun deleteLocalDatabase() {
+        File(dbPath).delete()
+    }
+
     val privateKeyBundle: PrivateKeyBundle
         get() = PrivateKeyBundleBuilder.buildFromV1Key(privateKeyBundleV1)