Fix JNI exception class name casing, pin Rust toolchain, and remove deprecated surrealdb_unstable flag (#134)

Author: emmanuel-keller

.github/workflows/cross.yml

@@ -40,18 +40,20 @@ jobs:
       - name: Install dependencies
         run: sudo apt-get update -y
 
+      - name: Read Rust toolchain version
+        id: rust-version
+        run: echo "CHANNEL=$(grep 'channel' rust-toolchain.toml | sed 's/.*"\(.*\)"/\1/')" >> $GITHUB_OUTPUT
+
       - name: Set up Rust
         uses: dtolnay/rust-toolchain@631a55b12751854ce901bb631d5902ceb48146f7 # stable
         with:
-          toolchain: stable
+          toolchain: ${{ steps.rust-version.outputs.CHANNEL }}
           targets: ${{ matrix.target }}
 
       - name: Install cargo-ndk
         run: cargo install cargo-ndk
 
       - name: Build
-        env:
-          RUSTFLAGS: '--cfg surrealdb_unstable'
         run: cargo ndk -t ${{ matrix.ndk }} build --release
 
       - name: Upload so lib
@@ -91,15 +93,17 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y ${{ matrix.apt-get }}
 
+      - name: Read Rust toolchain version
+        id: rust-version
+        run: echo "CHANNEL=$(grep 'channel' rust-toolchain.toml | sed 's/.*"\(.*\)"/\1/')" >> $GITHUB_OUTPUT
+
       - name: Set up Rust
         uses: dtolnay/rust-toolchain@631a55b12751854ce901bb631d5902ceb48146f7 # stable
         with:
-          toolchain: stable
+          toolchain: ${{ steps.rust-version.outputs.CHANNEL }}
           targets: ${{ matrix.target }}
 
       - name: Build
-        env:
-          RUSTFLAGS: '--cfg surrealdb_unstable'
         run: |
           export ${{ matrix.linker }}
           cargo build --target ${{ matrix.target }} --release
@@ -122,15 +126,18 @@ jobs:
       - name: Cache Rust
         uses: Swatinem/rust-cache@42dc69e1aa15d09112580998cf2ef0119e2e91ae # v2
 
+      - name: Read Rust toolchain version
+        id: rust-version
+        shell: bash
+        run: echo "CHANNEL=$(grep 'channel' rust-toolchain.toml | sed 's/.*"\(.*\)"/\1/')" >> $GITHUB_OUTPUT
+
       - name: Set up Rust
         uses: dtolnay/rust-toolchain@631a55b12751854ce901bb631d5902ceb48146f7 # stable
         with:
-          toolchain: stable
-          target: ${{ matrix.arch }}-pc-windows-msvc
+          toolchain: ${{ steps.rust-version.outputs.CHANNEL }}
+          targets: ${{ matrix.arch }}-pc-windows-msvc
 
       - name: Build
-        env:
-          RUSTFLAGS: '--cfg surrealdb_unstable'
         run: cargo build --target ${{ matrix.arch }}-pc-windows-msvc --release
 
       - name: Upload artifact
@@ -155,14 +162,16 @@ jobs:
       - name: Cache Rust
         uses: Swatinem/rust-cache@42dc69e1aa15d09112580998cf2ef0119e2e91ae # v2
 
+      - name: Read Rust toolchain version
+        id: rust-version
+        run: echo "CHANNEL=$(grep 'channel' rust-toolchain.toml | sed 's/.*"\(.*\)"/\1/')" >> $GITHUB_OUTPUT
+
       - name: Set up Rust
         uses: dtolnay/rust-toolchain@631a55b12751854ce901bb631d5902ceb48146f7 # stable
         with:
-          toolchain: stable
+          toolchain: ${{ steps.rust-version.outputs.CHANNEL }}
 
       - name: Build
-        env:
-          RUSTFLAGS: '--cfg surrealdb_unstable'
         run: cargo build --target ${{ matrix.arch }}-apple-darwin --release
 
       - name: Upload artifact

.github/workflows/reports.yml

@@ -13,15 +13,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+
       - name: Install dependencies
         run: sudo apt-get update
 
       - name: Install Rust
         uses: dtolnay/rust-toolchain@631a55b12751854ce901bb631d5902ceb48146f7 # stable
-        with:
-          toolchain: stable
-
-      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
 
       - name: Cache Rust
         uses: Swatinem/rust-cache@42dc69e1aa15d09112580998cf2ef0119e2e91ae # v2
@@ -33,8 +31,6 @@ jobs:
           java-version: 25
 
       - name: Build native lib
-        env:
-          RUSTFLAGS: '--cfg surrealdb_unstable'
         run: cargo build
 
       - name: Setup Gradle

.github/workflows/test.yml

@@ -11,22 +11,17 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    env:
-      RUSTFLAGS: '--cfg surrealdb_unstable'
 
     strategy:
       fail-fast: false
       matrix:
         java: [ '8', '11', '17', '21', '25' ]
 
     steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+
       - name: Install Rust
         uses: dtolnay/rust-toolchain@631a55b12751854ce901bb631d5902ceb48146f7 # stable
-        with:
-          toolchain: stable
-          components: clippy,rustfmt
-
-      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
 
       - name: Cache Rust
         uses: Swatinem/rust-cache@42dc69e1aa15d09112580998cf2ef0119e2e91ae # v2

rust-toolchain.toml

@@ -0,0 +1,5 @@
+# This toolchain version should be aligned with the SurrealDB version
+# See: https://github.com/surrealdb/surrealdb/blob/v3.0.4/rust-toolchain.toml
+[toolchain]
+channel = "1.91"
+components = ["rustfmt", "clippy"]

src/main/rust/error.rs

@@ -13,7 +13,7 @@ pub(super) enum SurrealError {
     SurrealDBJni(String),
 }
 
-const EXCEPTION: &str = "java/lang/exception";
+const EXCEPTION: &str = "java/lang/Exception";
 const NULL_POINTER_EXCEPTION: &str = "java/lang/NullPointerException";
 const NO_SUCH_ELEMENT_EXCEPTION: &str = "java/util/NoSuchElementException";
 const SURREAL_EXCEPTION: &str = "com/surrealdb/SurrealException";
@@ -307,3 +307,45 @@ impl From<surrealdb::Error> for SurrealError {
         SurrealError::SurrealDB(e)
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    /// Validates that JNI class name constants use correct Java casing.
+    /// Java class names are case-sensitive in JNI; e.g. "java/lang/Exception"
+    /// is valid but "java/lang/exception" would fail at runtime.
+    #[test]
+    fn jni_class_names_are_correctly_cased() {
+        assert_eq!(EXCEPTION, "java/lang/Exception");
+        assert_eq!(NULL_POINTER_EXCEPTION, "java/lang/NullPointerException");
+        assert_eq!(
+            NO_SUCH_ELEMENT_EXCEPTION,
+            "java/util/NoSuchElementException"
+        );
+        assert_eq!(SURREAL_EXCEPTION, "com/surrealdb/SurrealException");
+        assert_eq!(SERVER_EXCEPTION, "com/surrealdb/ServerException");
+    }
+
+    /// Validates that each JNI class name segment that represents a class
+    /// (the last segment) starts with an uppercase letter, following Java conventions.
+    #[test]
+    fn jni_class_names_have_uppercase_class_segment() {
+        let constants = [
+            EXCEPTION,
+            NULL_POINTER_EXCEPTION,
+            NO_SUCH_ELEMENT_EXCEPTION,
+            SURREAL_EXCEPTION,
+            SERVER_EXCEPTION,
+        ];
+        for name in constants {
+            let class_segment = name.rsplit('/').next().unwrap();
+            assert!(
+                class_segment.starts_with(char::is_uppercase),
+                "JNI class name '{}' has a class segment '{}' that does not start with an uppercase letter",
+                name,
+                class_segment
+            );
+        }
+    }
+}