feat: migrate viewModelByIndex, createInstanceByIndex, viewModel to async

Author: mfazekas

android/src/experimental/java/com/margelo/nitro/rive/HybridRiveFile.kt

@@ -37,19 +37,28 @@ class HybridRiveFile(
       }
     }
 
-  override fun viewModelByIndex(index: Double): HybridViewModelSpec? {
+  private suspend fun viewModelByIndexImpl(index: Double): HybridViewModelSpec? {
     val file = riveFile ?: return null
+    val names = file.getViewModelNames()
+    val idx = index.toInt()
+    if (idx < 0 || idx >= names.size) return null
+    return HybridViewModel(file, riveWorker, names[idx], this)
+  }
+
+  // Deprecated: Use viewModelByIndexAsync instead
+  override fun viewModelByIndex(index: Double): HybridViewModelSpec? {
     return try {
-      val names = runBlocking { file.getViewModelNames() }
-      val idx = index.toInt()
-      if (idx < 0 || idx >= names.size) return null
-      HybridViewModel(file, riveWorker, names[idx], this)
+      runBlocking { viewModelByIndexImpl(index) }
     } catch (e: Exception) {
       Log.e(TAG, "viewModelByIndex($index) failed", e)
       null
     }
   }
 
+  override fun viewModelByIndexAsync(index: Double): Promise<HybridViewModelSpec?> {
+    return Promise.async { viewModelByIndexImpl(index) }
+  }
+
   override fun viewModelByName(name: String): HybridViewModelSpec? {
     val file = riveFile ?: return null
     return try {

android/src/experimental/java/com/margelo/nitro/rive/HybridViewModel.kt

@@ -8,6 +8,7 @@ import app.rive.ViewModelInstanceSource
 import app.rive.ViewModelSource
 import app.rive.core.CommandQueue
 import com.facebook.proguard.annotations.DoNotStrip
+import com.margelo.nitro.core.Promise
 import kotlinx.coroutines.runBlocking
 
 @Keep
@@ -42,10 +43,19 @@ class HybridViewModel(
   override val modelName: String
     get() = viewModelName
 
+  // Deprecated: Use createInstanceByIndexAsync instead
   override fun createInstanceByIndex(index: Double): HybridViewModelInstanceSpec? {
     return createDefaultInstance()
   }
 
+  override fun createInstanceByIndexAsync(index: Double): Promise<HybridViewModelInstanceSpec?> {
+    return Promise.async {
+      val source = vmSource.defaultInstance()
+      val vmi = ViewModelInstance.fromFile(riveFile, source)
+      HybridViewModelInstance(vmi, riveWorker, parentFile, viewModelName)
+    }
+  }
+
   override fun createInstanceByName(name: String): HybridViewModelInstanceSpec? {
     return try {
       val instanceNames = runBlocking { riveFile.getViewModelInstanceNames(viewModelName) }

android/src/experimental/java/com/margelo/nitro/rive/HybridViewModelInstance.kt

@@ -6,6 +6,7 @@ import app.rive.ViewModelInstance
 import app.rive.ViewModelInstanceSource
 import app.rive.core.CommandQueue
 import com.facebook.proguard.annotations.DoNotStrip
+import com.margelo.nitro.core.Promise
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.runBlocking
 
@@ -128,19 +129,28 @@ class HybridViewModelInstance(
     }
   }
 
-  override fun viewModel(path: String): HybridViewModelInstanceSpec? {
+  private fun viewModelImpl(path: String): HybridViewModelInstanceSpec? {
     if (!hasProperty(path)) return null
+    val file = parentFile.riveFile ?: return null
+    val source = ViewModelInstanceSource.Reference(viewModelInstance, path)
+    val childVmi = ViewModelInstance.fromFile(file, source)
+    return HybridViewModelInstance(childVmi, riveWorker, parentFile)
+  }
+
+  // Deprecated: Use viewModelAsync instead
+  override fun viewModel(path: String): HybridViewModelInstanceSpec? {
     return try {
-      val file = parentFile.riveFile ?: return null
-      val source = ViewModelInstanceSource.Reference(viewModelInstance, path)
-      val childVmi = ViewModelInstance.fromFile(file, source)
-      HybridViewModelInstance(childVmi, riveWorker, parentFile)
+      viewModelImpl(path)
     } catch (e: Exception) {
       Log.e(TAG, "viewModel failed for path '$path'", e)
       null
     }
   }
 
+  override fun viewModelAsync(path: String): Promise<HybridViewModelInstanceSpec?> {
+    return Promise.async { viewModelImpl(path) }
+  }
+
   override fun replaceViewModel(path: String, instance: HybridViewModelInstanceSpec) {
     Log.w(TAG, "replaceViewModel not yet supported in experimental API")
   }

android/src/legacy/java/com/margelo/nitro/rive/HybridRiveFile.kt

@@ -24,6 +24,7 @@ class HybridRiveFile : HybridRiveFileSpec() {
   override val viewModelCount: Double?
     get() = riveFile?.viewModelCount?.toDouble()
 
+  // Deprecated: Use viewModelByIndexAsync instead
   override fun viewModelByIndex(index: Double): HybridViewModelSpec? {
     if (index < 0) return null
     return try {
@@ -34,6 +35,17 @@ class HybridRiveFile : HybridRiveFileSpec() {
     }
   }
 
+  override fun viewModelByIndexAsync(index: Double): Promise<HybridViewModelSpec?> {
+    return Promise.async {
+      try {
+        val vm = riveFile?.getViewModelByIndex(index.toInt()) ?: return@async null
+        HybridViewModel(vm)
+      } catch (e: Exception) {
+        null
+      }
+    }
+  }
+
   override fun viewModelByName(name: String): HybridViewModelSpec? {
     return try {
       val vm = riveFile?.getViewModelByName(name) ?: return null

android/src/legacy/java/com/margelo/nitro/rive/HybridViewModel.kt

@@ -4,6 +4,7 @@ import androidx.annotation.Keep
 import app.rive.runtime.kotlin.core.ViewModel
 import app.rive.runtime.kotlin.core.errors.ViewModelException
 import com.facebook.proguard.annotations.DoNotStrip
+import com.margelo.nitro.core.Promise
 
 @Keep
 @DoNotStrip
@@ -15,6 +16,7 @@ class HybridViewModel(private val viewModel: ViewModel) : HybridViewModelSpec()
   override val modelName: String
     get() = viewModel.name
 
+  // Deprecated: Use createInstanceByIndexAsync instead
   override fun createInstanceByIndex(index: Double): HybridViewModelInstanceSpec? {
     if (index < 0) return null
     try {
@@ -25,6 +27,17 @@ class HybridViewModel(private val viewModel: ViewModel) : HybridViewModelSpec()
     }
   }
 
+  override fun createInstanceByIndexAsync(index: Double): Promise<HybridViewModelInstanceSpec?> {
+    return Promise.async {
+      try {
+        val vmi = viewModel.createInstanceFromIndex(index.toInt())
+        HybridViewModelInstance(vmi)
+      } catch (e: ViewModelException) {
+        null
+      }
+    }
+  }
+
   override fun createInstanceByName(name: String): HybridViewModelInstanceSpec? {
     try {
       val vmi = viewModel.createInstanceFromName(name)

android/src/legacy/java/com/margelo/nitro/rive/HybridViewModelInstance.kt

@@ -5,6 +5,7 @@ import androidx.annotation.Keep
 import app.rive.runtime.kotlin.core.ViewModelInstance
 import app.rive.runtime.kotlin.core.errors.ViewModelException
 import com.facebook.proguard.annotations.DoNotStrip
+import com.margelo.nitro.core.Promise
 
 @Keep
 @DoNotStrip
@@ -60,10 +61,19 @@ class HybridViewModelInstance(val viewModelInstance: ViewModelInstance) : Hybrid
     HybridViewModelArtboardProperty(viewModelInstance.getArtboardProperty(path))
   }
 
+  // Deprecated: Use viewModelAsync instead
   override fun viewModel(path: String) = getPropertyOrNull {
     HybridViewModelInstance(viewModelInstance.getInstanceProperty(path))
   }
 
+  override fun viewModelAsync(path: String): Promise<HybridViewModelInstanceSpec?> {
+    return Promise.async {
+      getPropertyOrNull {
+        HybridViewModelInstance(viewModelInstance.getInstanceProperty(path))
+      }
+    }
+  }
+
   override fun replaceViewModel(path: String, instance: HybridViewModelInstanceSpec) {
     val nativeInstance = (instance as HybridViewModelInstance).viewModelInstance
     viewModelInstance.setInstanceProperty(path, nativeInstance)

example/__tests__/databinding-advanced.harness.ts

@@ -26,14 +26,14 @@ describe('RiveFile ViewModel Access', () => {
 
   it('viewModelByIndex(0) returns a ViewModel', async () => {
     const file = await loadFile(DATABINDING);
-    const vm = file.viewModelByIndex(0);
+    const vm = await file.viewModelByIndexAsync(0);
     expect(vm).toBeDefined();
   });
 
   it('viewModelByIndex(-1) returns undefined or throws', async () => {
     const file = await loadFile(DATABINDING);
     try {
-      const vm = file.viewModelByIndex(-1);
+      const vm = await file.viewModelByIndexAsync(-1);
       expect(vm).toBeUndefined();
     } catch {
       // Android Rive SDK throws a JNI exception for invalid indices
@@ -43,7 +43,7 @@ describe('RiveFile ViewModel Access', () => {
   it('viewModelByIndex(100) returns undefined or throws', async () => {
     const file = await loadFile(DATABINDING);
     try {
-      const vm = file.viewModelByIndex(100);
+      const vm = await file.viewModelByIndexAsync(100);
       expect(vm).toBeUndefined();
     } catch {
       // Android Rive SDK throws a JNI exception for out-of-range indices
@@ -129,10 +129,10 @@ describe('ViewModel Creation Variants', () => {
 
   it('createInstanceByIndex(0) works', async () => {
     const file = await loadFile(DATABINDING);
-    const vm = file.viewModelByIndex(0);
+    const vm = await file.viewModelByIndexAsync(0);
     expectDefined(vm);
 
-    const instance = vm.createInstanceByIndex(0);
+    const instance = await vm.createInstanceByIndexAsync(0);
     expectDefined(instance);
   });
 
@@ -142,7 +142,7 @@ describe('ViewModel Creation Variants', () => {
     expectDefined(vm);
 
     // Legacy returns undefined, experimental returns an empty instance
-    vm.createInstanceByIndex(100);
+    await vm.createInstanceByIndexAsync(100);
     expect(true).toBe(true);
   });
 
@@ -355,7 +355,7 @@ describe.skip('Image Properties', () => {
     const file = await loadFile(DATABINDING_IMAGES);
     const vm = file.viewModelByName('MyViewModel');
     expectDefined(vm);
-    const instance = vm.createInstanceByIndex(0);
+    const instance = await vm.createInstanceByIndexAsync(0);
     expectDefined(instance);
 
     const imageProp = instance.imageProperty('bound_image');

example/__tests__/rive.harness.ts

@@ -30,12 +30,12 @@ describe('ViewModel', () => {
     const instance = vm?.createDefaultInstance();
     expect(instance).toBeDefined();
 
-    const vm1 = instance?.viewModel('vm1');
-    const vm2 = instance?.viewModel('vm2');
+    const vm1 = await instance?.viewModelAsync('vm1');
+    const vm2 = await instance?.viewModelAsync('vm2');
     expect(vm1).toBeDefined();
     expect(vm2).toBeDefined();
 
-    expect(instance?.viewModel('nonexistent')).toBeUndefined();
+    expect(await instance?.viewModelAsync('nonexistent')).toBeUndefined();
 
     expect(vm1?.instanceName).toBeDefined();
     expect(typeof vm1?.instanceName).toBe('string');
@@ -48,7 +48,7 @@ describe('ViewModel', () => {
     const instance = vm?.createDefaultInstance();
     expect(instance).toBeDefined();
 
-    const vm2Instance = instance?.viewModel('vm2');
+    const vm2Instance = await instance?.viewModelAsync('vm2');
     expect(vm2Instance).toBeDefined();
 
     const vm2NameProp = vm2Instance?.stringProperty('name');
@@ -58,7 +58,7 @@ describe('ViewModel', () => {
 
     instance?.replaceViewModel('vm1', vm2Instance!);
 
-    const vm1AfterReplace = instance?.viewModel('vm1');
+    const vm1AfterReplace = await instance?.viewModelAsync('vm1');
     const vm1NameProp = vm1AfterReplace?.stringProperty('name');
     // Android experimental backend doesn't support replaceViewModel yet (no-op)
     const val = vm1NameProp?.value;

example/__tests__/viewmodel-properties.harness.ts

@@ -104,7 +104,7 @@ describe('ViewModel Properties', () => {
 
   it('nested viewModel property access works', async () => {
     const instance = await createGordonInstance();
-    const petViewModel = instance.viewModel('pet');
+    const petViewModel = await instance.viewModelAsync('pet');
     expectDefined(petViewModel);
 
     const petName = petViewModel.stringProperty('name');
@@ -146,7 +146,7 @@ describe('ViewModel Properties', () => {
     expect(instance.colorProperty('nonexistent')).toBeUndefined();
     expect(instance.enumProperty('nonexistent')).toBeUndefined();
     expect(instance.triggerProperty('nonexistent')).toBeUndefined();
-    expect(instance.viewModel('nonexistent')).toBeUndefined();
+    expect(await instance.viewModelAsync('nonexistent')).toBeUndefined();
   });
 });
 

example/android/gradle.properties

@@ -38,4 +38,4 @@ newArchEnabled=true
 # If set to false, you will be using JSC instead.
 hermesEnabled=true
 
-USE_RIVE_NEW_API=true
+USE_RIVE_NEW_API=false