Failed to load dynamic library

.github/workflows/build-native.yml

@@ -18,7 +18,7 @@ on:
 
 jobs:
   build-native:
-    runs-on: ${{ inputs.runner }}-latest
+    runs-on: ${{ inputs.runner }}
     name: Build native
     timeout-minutes: 60
     strategy:
@@ -37,7 +37,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ./binary/**
-          key: binaries-${{ matrix.build }}-${{hashFiles('./src/**')}}
+          key: binaries-${{ matrix.build }}-{{ inputs.runner }}-${{hashFiles('./src/**')}}
 
       - name: Setup Ninja
         if: contains(github.head_ref, 'release/') || steps.check-cache.outputs.cache-hit != 'true'

.github/workflows/ci.yml

@@ -129,39 +129,39 @@ jobs:
     name: Build Windows
     uses: ./.github/workflows/build-native.yml
     with:
-     runner: windows
+     runner: windows-2022
      binary: windows
      build: '["windows"]'
 
   build-macos:
     name: Build MacOS
     uses: ./.github/workflows/build-native.yml
     with:
-     runner: macos
+     runner: macos-11
      binary: macos
      build: '["macos"]'
 
   build-linux:
     name: Build Linux
     uses: ./.github/workflows/build-native.yml
     with:
-     runner: ubuntu
+     runner: ubuntu-20.04
      binary: linux
      build: '["linux"]'
 
   build-android:
     name: Build Android
     uses: ./.github/workflows/build-native.yml
     with:
-     runner: ubuntu
+     runner: ubuntu-20.04
      binary: android
      build: '["android-x86", "android-x86_64", "android-armeabi-v7a", "android-arm64-v8a"]'
 
   build-ios:
     name: Build IOS
     uses: ./.github/workflows/build-native.yml
     with:
-      runner: macos
+      runner: macos-11
       binary: ios
       build: '["ios-device", "ios-simulator", "ios-catalyst"]'
 

CHANGELOG.md

@@ -3,7 +3,7 @@
 **This project is in Release Candidate stage.**
 
 ### Enhancements
-* None
+* Improved error information returned when the `realm_dart` library failed to load. ([#1143](https://github.com/realm/realm-dart/pull/1143))
 
 ### Fixed
 * Improve performance of interprocess mutexes on iOS which don’t need to support reader-writer locking. The primary beneficiary of this is beginning and ending read transactions, which is now almost as fast as pre-v13.0.0 (Core upgrade).

lib/src/init.dart

@@ -65,7 +65,7 @@ DynamicLibrary _openRealmLib() {
   final root = _getNearestProjectRoot(Platform.script.path) ?? _getNearestProjectRoot(p.current);
 
   // Try to open lib from various candidate paths
-  Error? ex;
+  LoadRealmLibraryError? ex;
   for (final open in [
     () => _open(libName), // just ask OS..
     () => _open(p.join(_exeDirName, libName)), // try finding it next to the executable
@@ -75,7 +75,8 @@ DynamicLibrary _openRealmLib() {
     try {
       return open();
     } on Error catch (e) {
-      ex ??= e; // remember first exception, if everything fails
+      ex ??= LoadRealmLibraryError();
+      ex.add(e);
     }
   }
   throw ex!; // rethrow first
@@ -112,3 +113,20 @@ DynamicLibrary initRealm() {
 
   return _library = realmLibrary;
 }
+
+class LoadRealmLibraryError extends Error {
+  List<Error> loadingFromPathErrors = [];
+  void add(Error err) {
+    loadingFromPathErrors.add(err);
+  }
+
+  @override
+  @override
+  String toString() {
+    List<String> errMessages = [];
+    for (Error err in loadingFromPathErrors) {
+      errMessages.add(err.toString());
+    }
+    return errMessages.join('\n');
+  }
+}