Package the Rust mobile core and generated Kotlin API for Android (#92)

android/core/gradle.lockfile

@@ -2,6 +2,8 @@
 # Manual edits can break the build and are not advised.
 # This file is expected to be part of source control.
 # To regenerate this file, run: ./gradlew :core:dependencies --write-locks
+androidx.annotation:annotation-jvm:1.11.0=debugAndroidTestLintChecksClasspath,debugAndroidTestRuntimeClasspath,debugLintChecksClasspath,debugRuntimeClasspath,debugUnitTestLintChecksClasspath,debugUnitTestRuntimeClasspath,releaseLintChecksClasspath,releaseRuntimeClasspath
+androidx.annotation:annotation:1.11.0=debugAndroidTestLintChecksClasspath,debugAndroidTestRuntimeClasspath,debugLintChecksClasspath,debugRuntimeClasspath,debugUnitTestLintChecksClasspath,debugUnitTestRuntimeClasspath,releaseLintChecksClasspath,releaseRuntimeClasspath
 ch.qos.logback:logback-classic:1.3.15=ktlint
 ch.qos.logback:logback-core:1.3.15=ktlint
 com.android.tools.analytics-library:protos:32.4.1=androidLintTool
@@ -75,6 +77,7 @@ jakarta.xml.bind:jakarta.xml.bind-api:2.3.2=androidLintTool
 javax.inject:javax.inject:1=androidLintTool
 junit:junit:4.13.2=debugUnitTestCompileClasspath,debugUnitTestLintChecksClasspath,debugUnitTestRuntimeClasspath
 net.java.dev.jna:jna-platform:5.6.0=androidLintTool
+net.java.dev.jna:jna:5.19.1=debugAndroidTestLintChecksClasspath,debugAndroidTestRuntimeClasspath,debugLintChecksClasspath,debugRuntimeClasspath,debugUnitTestLintChecksClasspath,debugUnitTestRuntimeClasspath,releaseLintChecksClasspath,releaseRuntimeClasspath
 net.java.dev.jna:jna:5.6.0=androidLintTool
 net.sf.kxml:kxml2:2.3.0=androidLintTool
 org.apache.commons:commons-compress:1.27.1=androidLintTool
@@ -93,27 +96,27 @@ org.glassfish.jaxb:jaxb-runtime:2.3.2=androidLintTool
 org.glassfish.jaxb:txw2:2.3.2=androidLintTool
 org.hamcrest:hamcrest-core:1.3=debugUnitTestCompileClasspath,debugUnitTestLintChecksClasspath,debugUnitTestRuntimeClasspath
 org.jetbrains.kotlin:kotlin-build-tools-api:2.4.0=kotlinAbiValidationCompatClasspath
-org.jetbrains.kotlin:kotlin-build-tools-api:2.4.20=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
-org.jetbrains.kotlin:kotlin-build-tools-compat:2.4.20=kotlinAbiValidationCompatClasspath,kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
+org.jetbrains.kotlin:kotlin-build-tools-api:2.4.21=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
+org.jetbrains.kotlin:kotlin-build-tools-compat:2.4.21=kotlinAbiValidationCompatClasspath,kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
 org.jetbrains.kotlin:kotlin-build-tools-cri-impl:2.4.0=kotlinAbiValidationCompatClasspath
-org.jetbrains.kotlin:kotlin-build-tools-cri-impl:2.4.20=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
+org.jetbrains.kotlin:kotlin-build-tools-cri-impl:2.4.21=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
 org.jetbrains.kotlin:kotlin-build-tools-impl:2.4.0=kotlinAbiValidationCompatClasspath
-org.jetbrains.kotlin:kotlin-build-tools-impl:2.4.20=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
+org.jetbrains.kotlin:kotlin-build-tools-impl:2.4.21=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
 org.jetbrains.kotlin:kotlin-compiler-embeddable:2.2.0=ktlint,ktlintBaselineReporter,ktlintRuleset
 org.jetbrains.kotlin:kotlin-compiler-embeddable:2.4.0=kotlinAbiValidationCompatClasspath
-org.jetbrains.kotlin:kotlin-compiler-embeddable:2.4.20=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
+org.jetbrains.kotlin:kotlin-compiler-embeddable:2.4.21=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
 org.jetbrains.kotlin:kotlin-compiler-runner:2.4.0=kotlinAbiValidationCompatClasspath
-org.jetbrains.kotlin:kotlin-compiler-runner:2.4.20=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
+org.jetbrains.kotlin:kotlin-compiler-runner:2.4.21=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
 org.jetbrains.kotlin:kotlin-daemon-client:2.4.0=kotlinAbiValidationCompatClasspath
-org.jetbrains.kotlin:kotlin-daemon-client:2.4.20=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
+org.jetbrains.kotlin:kotlin-daemon-client:2.4.21=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
 org.jetbrains.kotlin:kotlin-daemon-embeddable:2.2.0=ktlint,ktlintBaselineReporter,ktlintRuleset
 org.jetbrains.kotlin:kotlin-daemon-embeddable:2.4.0=kotlinAbiValidationCompatClasspath
-org.jetbrains.kotlin:kotlin-daemon-embeddable:2.4.20=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
+org.jetbrains.kotlin:kotlin-daemon-embeddable:2.4.21=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
 org.jetbrains.kotlin:kotlin-reflect:1.6.10=kotlinAbiValidationCompatClasspath,kotlinBuildToolsApiClasspath,kotlinCompilerClasspath,ktlint,ktlintBaselineReporter,ktlintRuleset
 org.jetbrains.kotlin:kotlin-reflect:2.2.10=androidLintTool
 org.jetbrains.kotlin:kotlin-script-runtime:2.2.0=ktlint,ktlintBaselineReporter,ktlintRuleset
 org.jetbrains.kotlin:kotlin-script-runtime:2.4.0=kotlinAbiValidationCompatClasspath
-org.jetbrains.kotlin:kotlin-script-runtime:2.4.20=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
+org.jetbrains.kotlin:kotlin-script-runtime:2.4.21=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
 org.jetbrains.kotlin:kotlin-stdlib-common:2.2.0=ktlintReporter
 org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.8.0=ktlintReporter
 org.jetbrains.kotlin:kotlin-stdlib-jdk7:2.2.10=androidLintTool,unified-test-platform-gradle-work-action
@@ -122,8 +125,8 @@ org.jetbrains.kotlin:kotlin-stdlib-jdk8:2.2.10=androidLintTool,unified-test-plat
 org.jetbrains.kotlin:kotlin-stdlib:2.2.0=ktlint,ktlintBaselineReporter,ktlintReporter,ktlintRuleset
 org.jetbrains.kotlin:kotlin-stdlib:2.2.10=androidLintTool,unified-test-platform-gradle-work-action
 org.jetbrains.kotlin:kotlin-stdlib:2.4.0=kotlinAbiValidationCompatClasspath
-org.jetbrains.kotlin:kotlin-stdlib:2.4.20=debugAndroidTestCompileClasspath,debugAndroidTestLintChecksClasspath,debugAndroidTestRuntimeClasspath,debugCompileClasspath,debugLintChecksClasspath,debugRuntimeClasspath,debugUnitTestCompileClasspath,debugUnitTestLintChecksClasspath,debugUnitTestRuntimeClasspath,kotlinBuildToolsApiClasspath,kotlinCompilerClasspath,releaseCompileClasspath,releaseLintChecksClasspath,releaseRuntimeClasspath
-org.jetbrains.kotlin:kotlin-tooling-core:2.4.20=kotlinAbiValidationCompatClasspath,kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
+org.jetbrains.kotlin:kotlin-stdlib:2.4.21=debugAndroidTestCompileClasspath,debugAndroidTestLintChecksClasspath,debugAndroidTestRuntimeClasspath,debugCompileClasspath,debugLintChecksClasspath,debugRuntimeClasspath,debugUnitTestCompileClasspath,debugUnitTestLintChecksClasspath,debugUnitTestRuntimeClasspath,kotlinBuildToolsApiClasspath,kotlinCompilerClasspath,releaseCompileClasspath,releaseLintChecksClasspath,releaseRuntimeClasspath
+org.jetbrains.kotlin:kotlin-tooling-core:2.4.21=kotlinAbiValidationCompatClasspath,kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
 org.jetbrains.kotlinx:kotlinx-coroutines-android:1.11.0=debugAndroidTestCompileClasspath,debugAndroidTestLintChecksClasspath,debugAndroidTestRuntimeClasspath,debugCompileClasspath,debugLintChecksClasspath,debugRuntimeClasspath,debugUnitTestCompileClasspath,debugUnitTestLintChecksClasspath,debugUnitTestRuntimeClasspath,releaseCompileClasspath,releaseLintChecksClasspath,releaseRuntimeClasspath
 org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.11.0=debugAndroidTestCompileClasspath,debugAndroidTestLintChecksClasspath,debugAndroidTestRuntimeClasspath,debugCompileClasspath,debugLintChecksClasspath,debugRuntimeClasspath,debugUnitTestCompileClasspath,debugUnitTestLintChecksClasspath,debugUnitTestRuntimeClasspath,releaseCompileClasspath,releaseLintChecksClasspath,releaseRuntimeClasspath
 org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.9.0=androidLintTool,unified-test-platform-gradle-work-action

android/core/src/main/kotlin/de/rfc1437/ironstorage/core/NativeFixtureShellRepository.kt

@@ -0,0 +1,101 @@
+package de.rfc1437.ironstorage.core
+
+import android.content.Context
+import de.rfc1437.ironstorage.bridge.NativeBridgeException
+import de.rfc1437.ironstorage.bridge.NativeFailureKind
+import de.rfc1437.ironstorage.bridge.NativeRuntime
+import de.rfc1437.ironstorage.bridge.generated.MobileShellState
+import de.rfc1437.ironstorage.bridge.generated.MobileTab
+import java.util.concurrent.atomic.AtomicLong
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.flow.update
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
+
+/** #92's native fixture integration; repository initialization is owned by #90. */
+class NativeFixtureShellRepository internal constructor(
+    private val scope: CoroutineScope,
+    private val load: suspend (ShellState) -> ShellSnapshot
+) : ShellRepository {
+    constructor(context: Context, scope: CoroutineScope) : this(scope, nativeLoader(context))
+    private val mutableSnapshot = MutableStateFlow(ShellSnapshot(ShellState.Loading, emptyList()))
+    override val snapshot: StateFlow<ShellSnapshot> = mutableSnapshot
+    private val revision = AtomicLong()
+    private var job: Job? = null
+
+    init {
+        showFixture(ShellState.Empty)
+    }
+
+    override fun selectTab(tab: ShellTab) {
+        mutableSnapshot.update { it.copy(selectedTab = tab) }
+    }
+
+    fun showFixture(state: ShellState) {
+        val operation = revision.incrementAndGet()
+        job?.cancel()
+        job = scope.launch {
+            val result = try {
+                load(state)
+            } catch (error: NativeBridgeException) {
+                ShellSnapshot(ShellState.Error, emptyList(), nativeFailure = error.kind.toFacade())
+            }
+            if (revision.get() == operation) {
+                mutableSnapshot.update { result.copy(selectedTab = it.selectedTab) }
+            }
+        }
+    }
+}
+
+private fun nativeLoader(context: Context): suspend (ShellState) -> ShellSnapshot {
+    val runtime = NativeRuntime(context)
+    return { state ->
+        withContext(Dispatchers.IO) {
+            val shell = runtime.fixture(state.toNative())
+            val pages = shell.pages.map { page ->
+                ShellPage(page.tab.toFacade(), page.title, page.stateTitle, page.stateDetail)
+            }
+            val actual = shell.pages.firstOrNull()?.state
+                ?: throw NativeBridgeException(NativeFailureKind.RustFailure)
+            ShellSnapshot(actual.toFacade(), pages)
+        }
+    }
+}
+
+private fun MobileShellState.toFacade(): ShellState = when (this) {
+    MobileShellState.LOADING -> ShellState.Loading
+    MobileShellState.EMPTY -> ShellState.Empty
+    MobileShellState.READY -> ShellState.Ready
+    MobileShellState.LOCKED -> ShellState.Locked
+    MobileShellState.ERROR -> ShellState.Error
+}
+
+private fun ShellState.toNative(): MobileShellState = when (this) {
+    ShellState.Loading -> MobileShellState.LOADING
+    ShellState.Empty -> MobileShellState.EMPTY
+    ShellState.Ready -> MobileShellState.READY
+    ShellState.Locked -> MobileShellState.LOCKED
+    ShellState.Error -> MobileShellState.ERROR
+}
+
+private fun MobileTab.toFacade(): ShellTab = when (this) {
+    MobileTab.HOME -> ShellTab.Home
+    MobileTab.PASSWORDS -> ShellTab.Passwords
+    MobileTab.SEARCH -> ShellTab.Search
+    MobileTab.TOTP -> ShellTab.Totp
+    MobileTab.PREFERENCES -> ShellTab.Preferences
+}
+
+private fun NativeFailureKind.toFacade(): NativeFailure = when (this) {
+    NativeFailureKind.UnsupportedAbi -> NativeFailure.UnsupportedAbi
+    NativeFailureKind.MissingLibrary -> NativeFailure.MissingLibrary
+    NativeFailureKind.ContractMismatch -> NativeFailure.ContractMismatch
+    NativeFailureKind.ChecksumMismatch -> NativeFailure.ChecksumMismatch
+    NativeFailureKind.LoadFailure -> NativeFailure.LoadFailure
+    NativeFailureKind.RustFailure -> NativeFailure.RustFailure
+    NativeFailureKind.MainThreadCall -> NativeFailure.MainThreadCall
+}

android/core/src/main/kotlin/de/rfc1437/ironstorage/core/ShellRepository.kt

@@ -14,9 +14,20 @@ data class ShellPage(
 data class ShellSnapshot(
     val state: ShellState,
     val pages: List<ShellPage>,
-    val selectedTab: ShellTab = ShellTab.Home
+    val selectedTab: ShellTab = ShellTab.Home,
+    val nativeFailure: NativeFailure? = null
 )
 
+enum class NativeFailure {
+    UnsupportedAbi,
+    MissingLibrary,
+    ContractMismatch,
+    ChecksumMismatch,
+    LoadFailure,
+    RustFailure,
+    MainThreadCall
+}
+
 interface ShellRepository {
     val snapshot: StateFlow<ShellSnapshot>
     fun selectTab(tab: ShellTab)

android/core/src/test/kotlin/de/rfc1437/ironstorage/core/NativeFixtureShellRepositoryTest.kt

@@ -0,0 +1,31 @@
+package de.rfc1437.ironstorage.core
+
+import kotlinx.coroutines.CompletableDeferred
+import kotlinx.coroutines.NonCancellable
+import kotlinx.coroutines.test.runCurrent
+import kotlinx.coroutines.test.runTest
+import kotlinx.coroutines.withContext
+import org.junit.Assert.assertEquals
+import org.junit.Test
+
+@OptIn(kotlinx.coroutines.ExperimentalCoroutinesApi::class)
+class NativeFixtureShellRepositoryTest {
+    @Test
+    fun cancelledNativeCompletionCannotReplaceNewerStateOrTabSelection() = runTest {
+        val pending = CompletableDeferred<Unit>()
+        val repository = NativeFixtureShellRepository(backgroundScope) { state ->
+            if (state == ShellState.Ready) withContext(NonCancellable) { pending.await() }
+            ShellSnapshot(state, listOf(ShellPage(ShellTab.Home, "Home", state.name, "Fixture")))
+        }
+        runCurrent()
+        repository.showFixture(ShellState.Ready)
+        runCurrent()
+        repository.selectTab(ShellTab.Search)
+        repository.showFixture(ShellState.Locked)
+        runCurrent()
+        pending.complete(Unit)
+        runCurrent()
+        assertEquals(ShellState.Locked, repository.snapshot.value.state)
+        assertEquals(ShellTab.Search, repository.snapshot.value.selectedTab)
+    }
+}