feat: make experimental runtime the default, legacy opt-in via USE_RIVE_LEGACY

Author: mfazekas

.github/workflows/ci.yml

@@ -473,7 +473,7 @@ jobs:
           echo "=== Checking logcat for errors ==="
           adb logcat -d -s ReactNativeJS:* RiveExample:* RNRive:* | tail -200 || echo "No logs found"
 
-  test-harness-ios-experimental:
+  test-harness-ios-legacy:
     runs-on: macos-latest
     timeout-minutes: 90
     env:
@@ -496,16 +496,16 @@ jobs:
         with:
           path: |
             **/ios/Pods
-          key: ${{ runner.os }}-experimental-cocoapods-${{ hashFiles('example/ios/Podfile', '*.podspec') }}
+          key: ${{ runner.os }}-legacy-cocoapods-${{ hashFiles('example/ios/Podfile', '*.podspec') }}
           restore-keys: |
-            ${{ runner.os }}-experimental-cocoapods-
+            ${{ runner.os }}-legacy-cocoapods-
 
       - name: Install cocoapods
         if: steps.cocoapods-cache.outputs.cache-hit != 'true'
         run: |
           cd example
           bundle install
-          USE_RIVE_NEW_API=1 bundle exec pod install --project-directory=ios
+          USE_RIVE_LEGACY=1 bundle exec pod install --project-directory=ios
 
       - name: Save cocoapods cache
         if: steps.cocoapods-cache.outputs.cache-hit != 'true'
@@ -520,9 +520,9 @@ jobs:
         uses: actions/cache/restore@v4
         with:
           path: example/ios/build
-          key: ${{ runner.os }}-ios-experimental-build-${{ env.XCODE_VERSION }}-${{ hashFiles('yarn.lock', 'ios/**', 'nitrogen/generated/ios/**', '*.podspec', 'example/ios/Podfile', 'example/ios/RiveExample/**') }}
+          key: ${{ runner.os }}-ios-legacy-build-${{ env.XCODE_VERSION }}-${{ hashFiles('yarn.lock', 'ios/**', 'nitrogen/generated/ios/**', '*.podspec', 'example/ios/Podfile', 'example/ios/RiveExample/**') }}
           restore-keys: |
-            ${{ runner.os }}-ios-experimental-build-${{ env.XCODE_VERSION }}-
+            ${{ runner.os }}-ios-legacy-build-${{ env.XCODE_VERSION }}-
 
       - name: Build iOS app
         if: steps.ios-build-cache.outputs.cache-hit != 'true'
@@ -580,7 +580,7 @@ jobs:
           echo "=== Checking simulator logs for errors ==="
           xcrun simctl spawn booted log show --predicate 'processImagePath CONTAINS "RiveExample"' --last 5m --style compact 2>&1 | tail -200 || echo "No logs found"
 
-  test-harness-android-experimental:
+  test-harness-android-legacy:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     env:
@@ -602,19 +602,19 @@ jobs:
         run: |
           /bin/bash -c "yes | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --licenses > /dev/null"
 
-      - name: Enable experimental Rive API
+      - name: Enable legacy Rive backend
         run: |
-          sed -i 's/USE_RIVE_NEW_API=false/USE_RIVE_NEW_API=true/' example/android/gradle.properties
+          echo "USE_RIVE_LEGACY=true" >> example/android/gradle.properties
 
       - name: Cache Gradle
         uses: actions/cache@v4
         with:
           path: |
             ~/.gradle/wrapper
             ~/.gradle/caches
-          key: ${{ runner.os }}-gradle-harness-experimental-${{ hashFiles('example/android/gradle/wrapper/gradle-wrapper.properties') }}
+          key: ${{ runner.os }}-gradle-harness-legacy-${{ hashFiles('example/android/gradle/wrapper/gradle-wrapper.properties') }}
           restore-keys: |
-            ${{ runner.os }}-gradle-harness-experimental-
+            ${{ runner.os }}-gradle-harness-legacy-
             ${{ runner.os }}-gradle-harness-
             ${{ runner.os }}-gradle-
 
@@ -623,9 +623,9 @@ jobs:
         uses: actions/cache/restore@v4
         with:
           path: example/android/app/build
-          key: ${{ runner.os }}-android-experimental-build-${{ env.ANDROID_API_LEVEL }}-${{ hashFiles('yarn.lock', 'android/**', 'nitrogen/generated/android/**', 'example/android/app/build.gradle', 'example/android/gradle.properties') }}
+          key: ${{ runner.os }}-android-legacy-build-${{ env.ANDROID_API_LEVEL }}-${{ hashFiles('yarn.lock', 'android/**', 'nitrogen/generated/android/**', 'example/android/app/build.gradle', 'example/android/gradle.properties') }}
           restore-keys: |
-            ${{ runner.os }}-android-experimental-build-${{ env.ANDROID_API_LEVEL }}-
+            ${{ runner.os }}-android-legacy-build-${{ env.ANDROID_API_LEVEL }}-
 
       - name: Build Android app
         if: steps.android-build-cache.outputs.cache-hit != 'true'

RNRive.podspec

@@ -28,14 +28,14 @@ if !rive_ios_version
   raise "Internal Error: Failed to determine Rive iOS SDK version. Please ensure package.json contains 'runtimeVersions.ios'"
 end
 
-# Set to '1' (or set $UseRiveNewAPI = true in Podfile) to enable the
-# experimental Rive runtime backend. When disabled, the legacy backend is used.
-use_rive_new_api = ENV['USE_RIVE_NEW_API'] == '1' || (defined?($UseRiveNewAPI) && $UseRiveNewAPI)
+# The experimental runtime backend is used by default. Set USE_RIVE_LEGACY=1
+# (or $UseRiveLegacy = true in Podfile) to fall back to the legacy backend.
+use_legacy = ENV['USE_RIVE_LEGACY'] == '1' || (defined?($UseRiveLegacy) && $UseRiveLegacy)
 
-if use_rive_new_api
-  Pod::UI.puts "@rive-app/react-native: Using experimental Rive runtime backend"
-else
+if use_legacy
   Pod::UI.puts "@rive-app/react-native: Using legacy Rive runtime backend (iOS SDK #{rive_ios_version})"
+else
+  Pod::UI.puts "@rive-app/react-native: Using experimental Rive runtime backend"
 end
 
 Pod::Spec.new do |s|
@@ -51,10 +51,10 @@ Pod::Spec.new do |s|
 
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
-  if use_rive_new_api
-    s.exclude_files = ["ios/legacy/**"]
-  else
+  if use_legacy
     s.exclude_files = ["ios/new/**"]
+  else
+    s.exclude_files = ["ios/legacy/**"]
   end
 
   s.public_header_files = ['ios/RCTSwiftLog.h']
@@ -65,7 +65,7 @@ Pod::Spec.new do |s|
 
  install_modules_dependencies(s)
 
-  if use_rive_new_api
+  unless use_legacy
     s.xcconfig = { 'OTHER_SWIFT_FLAGS' => '$(inherited) -DRIVE_EXPERIMENTAL_API' }
   end
 end

android/build.gradle

@@ -111,16 +111,16 @@ android {
     targetCompatibility JavaVersion.VERSION_1_8
   }
 
-  def useNewRiveApi = rootProject.findProperty('USE_RIVE_NEW_API') == 'true'
+  def useLegacy = rootProject.findProperty('USE_RIVE_LEGACY') == 'true'
 
   sourceSets {
     main {
       java.srcDirs += ["generated/java",
                        "generated/jni"]
-      if (useNewRiveApi) {
-        java.srcDirs += ["src/experimental/java"]
-      } else {
+      if (useLegacy) {
         java.srcDirs += ["src/legacy/java"]
+      } else {
+        java.srcDirs += ["src/experimental/java"]
       }
     }
   }

example/android/gradle.properties

@@ -38,8 +38,6 @@ newArchEnabled=true
 # If set to false, you will be using JSC instead.
 hermesEnabled=true
 
-USE_RIVE_NEW_API=true
-
 # Rive: skip auto-init so RiveRuntime.initialize() must be called from JS.
 # Useful for testing init failure handling via the Runtime Init exerciser.
 # Rive_RiveRuntimeAndroidSkipSetup=true

example/ios/Podfile.lock

@@ -1754,7 +1754,7 @@ PODS:
     - React-logger (= 0.79.2)
     - React-perflogger (= 0.79.2)
     - React-utils (= 0.79.2)
-  - RiveRuntime (6.17.0)
+  - RiveRuntime (6.18.0)
   - RNCAsyncStorage (2.2.0):
     - DoubleConversion
     - glog
@@ -1904,7 +1904,7 @@ PODS:
     - ReactCommon/turbomodule/core
     - RNWorklets
     - Yoga
-  - RNRive (0.3.1):
+  - RNRive (0.4.0):
     - DoubleConversion
     - glog
     - hermes-engine
@@ -1928,7 +1928,7 @@ PODS:
     - ReactCodegen
     - ReactCommon/turbomodule/bridging
     - ReactCommon/turbomodule/core
-    - RiveRuntime (= 6.17.0)
+    - RiveRuntime (= 6.18.0)
     - Yoga
   - RNScreens (4.18.0):
     - DoubleConversion
@@ -2379,12 +2379,12 @@ SPEC CHECKSUMS:
   ReactAppDependencyProvider: 04d5eb15eb46be6720e17a4a7fa92940a776e584
   ReactCodegen: c63eda03ba1d94353fb97b031fc84f75a0d125ba
   ReactCommon: 76d2dc87136d0a667678668b86f0fca0c16fdeb0
-  RiveRuntime: 1c18823e5fd2b88f09666cf7c7ba14da7b8d52a4
+  RiveRuntime: 67df68cb59eeee7334a6c6656230393986858ac3
   RNCAsyncStorage: a1c8cc8a99c32de1244a9cf707bf9d83d0de0f71
   RNCPicker: 28c076ae12a1056269ec0305fe35fac3086c477d
   RNGestureHandler: 6b39f4e43e4b3a0fb86de9531d090ff205a011d5
   RNReanimated: 66b68ebe3baf7ec9e716bd059d700726f250d344
-  RNRive: 3909767b7ea667f114816356e508cc83954a4a30
+  RNRive: deeb388054707b87f7bbbe783f560b4fb656efab
   RNScreens: f38464ec1e83bda5820c3b05ccf4908e3841c5cc
   RNWorklets: b1faafefb82d9f29c4018404a0fb33974b494a7b
   SocketRocket: d4aabe649be1e368d1318fdf28a022d714d65748