Macos binary + retrieve binary from .pub-cache (#72)

Author: jeffmur

.github/workflows/publish.yml

@@ -20,11 +20,16 @@ jobs:
       - run: echo "PUB_VER=$(grep -oP 'version:\s\K[0-9]+\.[0-9]+\.[0-9]+' dart/pubspec.yaml)" >> $GITHUB_ENV
       # Compare the versions in env to github.ref_name
       - run: |
-          if [ "${{ env.CMAKE_VER }}" != "${{ env.PUB_VER }}" || "${{ env.CMAKE_VER }}" != "${{ github.ref_name }}" || "${{ github.ref_name }}" != "${{ env.PUB_VER }}" ]; then
-            echo "Version mismatch: CMakeLists.txt: ${{ env.CMAKE_VER }} != dart/pubspec.yaml: ${{ env.PUB_VER }} != github.ref_name: ${{ github.ref_name }}"
-            exit 1
+          if [[ "${{ env.CMAKE_VER }}" == "${{ env.PUB_VER }}" ]] && \
+             [[ "${{ env.CMAKE_VER }}" == "${{ github.ref_name }}" ]]; then
+            echo "All variables are equal."
+          else
+            echo "Variables differ:"
+            echo "CMAKE_VER: ${{ env.CMAKE_VER }}"
+            echo "PUB_VER: ${{ env.PUB_VER }}"
+            echo "GITHUB_REF_NAME: ${{ github.ref_name }}"
           fi
-  compile:
+  binary:
     name: Binary
     needs: version
     strategy:
@@ -42,6 +47,10 @@ jobs:
           - os: android
             arch: arm64-v8a
             runner: ubuntu-latest
+          - os: macos
+            arch: x64
+            runner: macos-latest
+
     runs-on: ${{ matrix.dist.runner }}
     container:
       image: ghcr.io/jeffmur/fhel:builder
@@ -68,7 +77,7 @@ jobs:
 
   publish:
     name: pub.dev
-    needs: version
+    needs: [version, binary]
     runs-on: ubuntu-latest
     container:
       image: ghcr.io/jeffmur/fhel:builder

Makefile

@@ -112,6 +112,6 @@ apk-ci: build-cmake
 
 # Publish dart package from github workflows
 .PHONY: publish-ci
-publish-ci: build-cmake
+publish-ci:
 	@git config --global --add safe.directory /tmp/flutter
 	@cd $(DART_SRC); $(MAKE) publish-force

dart/CHANGELOG.md

@@ -1,4 +1,12 @@
-## 0.0.4-linux
+## 0.0.6
+
+Added setup script to automate the process of setting up the library for the first time.
+
+```bash
+dart run fhel:setup <platform> --arch <architecture>
+```
+
+## 0.0.5
 
 Testing linux release
 

dart/README.md

@@ -32,6 +32,7 @@ dart run fhel:setup <platform> --arch <architecture>
 |----------|--------------|
 | Android  | `x86_64` `arm64-v8a` `armeabi-v7a` |
 | Linux    | `x64` |
+| MacOS    | `x64` |
 
 ```dart
 import 'package:fhel/seal.dart';

dart/bin/setup_commands.dart

@@ -9,6 +9,13 @@ import 'package:stack_trace/stack_trace.dart';
 
 const setupPkgName = "fhel";
 const baseUrl = "https://github.com/jeffmur/fhel/releases/download";
+const ARCH_OPT_MAP = {
+  "macos": ["arm64"],
+  "windows": ["x64"],
+  "linux": ["x64"],
+  "android": ["x86_64", "arm64-v8a", "armeabi-v7a"],
+  "ios": ["os64"],
+};
 
 abstract class BaseSetupCommand extends Command {
   @override
@@ -18,8 +25,18 @@ abstract class BaseSetupCommand extends Command {
   String get name => "base";
 
   String get arch {
-    final arch_ = argResults?["arch"] as String;
-    return ARCH_MAP[os]?[arch_] as String? ?? arch_;
+    return argResults?["arch"] as String;
+  }
+
+  BaseSetupCommand() {
+    argParser.addOption(
+      "arch",
+      abbr: "a",
+      allowed: ARCH_OPT_MAP[name],
+      defaultsTo: ARCH_OPT_MAP[name]!.first, // default to first arch
+      mandatory: false,
+    );
+    argParser.addFlag("force", abbr: "f", help: "Force download and extract");
   }
 
   String get pkgRoot => Frame.caller().uri.resolve("..").toFilePath();
@@ -59,8 +76,9 @@ abstract class BaseSetupCommand extends Command {
     final saveFile = File(cacheTarPath);
 
     if (force || !saveFile.existsSync()) {
-      if (!saveFile.parent.existsSync())
+      if (!saveFile.parent.existsSync()) {
         saveFile.parent.createSync(recursive: true);
+      }
 
       final String url = "$baseUrl/v$version/$libTarName";
       print(asInfo("Downloading $url"));
@@ -118,16 +136,6 @@ class MacOsSetupCommand extends BaseSetupCommand {
 
   @override
   String get name => "macos";
-
-  MacOsSetupCommand() {
-    argParser.addOption(
-      "arch",
-      abbr: "a",
-      allowed: ["x86_64", "x64", "arm64"],
-      mandatory: true,
-    );
-    argParser.addFlag("force", abbr: "f", help: "Force download and extract");
-  }
 }
 
 class WindowsSetupCommand extends BaseSetupCommand {
@@ -136,12 +144,6 @@ class WindowsSetupCommand extends BaseSetupCommand {
 
   @override
   String get name => "windows";
-
-  WindowsSetupCommand() {
-    argParser.addOption("arch",
-        abbr: "a", allowed: ["x86_64", "x64"], mandatory: true);
-    argParser.addFlag("force", abbr: "f", help: "Force download and extract");
-  }
 }
 
 class LinuxSetupCommand extends BaseSetupCommand {
@@ -150,12 +152,6 @@ class LinuxSetupCommand extends BaseSetupCommand {
 
   @override
   String get name => "linux";
-
-  LinuxSetupCommand() {
-    argParser.addOption("arch",
-        abbr: "a", allowed: ["x86_64", "x64"], mandatory: true);
-    argParser.addFlag("force", abbr: "f", help: "Force download and extract");
-  }
 }
 
 class AndroidSetupCommand extends BaseSetupCommand {
@@ -164,16 +160,6 @@ class AndroidSetupCommand extends BaseSetupCommand {
 
   @override
   String get name => "android";
-
-  AndroidSetupCommand() {
-    argParser.addOption(
-      "arch",
-      abbr: "a",
-      allowed: ["x86_64", "arm64-v8a", "armeabi-v7a"],
-      mandatory: true,
-    );
-    argParser.addFlag("force", abbr: "f", help: "Force download and extract");
-  }
 }
 
 class IosSetupCommand extends BaseSetupCommand {
@@ -182,35 +168,8 @@ class IosSetupCommand extends BaseSetupCommand {
 
   @override
   String get name => "ios";
-
-  IosSetupCommand() {
-    argParser.addOption(
-      "arch",
-      abbr: "a",
-      allowed: ["os64"],
-      mandatory: false,
-      defaultsTo: "os64",
-    );
-    argParser.addFlag("force", abbr: "f", help: "Force download and extract");
-  }
 }
 
-const ARCH_MAP = {
-  OS.windows: {
-    "x86_64": "x64",
-  },
-  OS.linux: {
-    "x86_64": "x64",
-  },
-  OS.macos: {
-    "x86_64": "x64",
-  },
-  OS.ios: {
-    "x86_64": "x64",
-  },
-  OS.android: {},
-};
-
 class OS {
   static const windows = "windows";
   static const linux = "linux";

dart/lib/afhe.dart

@@ -51,7 +51,7 @@ class Afhe {
   }
 
   /// Initializes the [Backend] without a [Scheme].
-  /// 
+  ///
   /// Typically used for loading parameters from a shared session.
   Afhe.noScheme(String backendName) {
     backend = Backend.set(backendName);
@@ -121,16 +121,17 @@ class Afhe {
   ///
   /// Used for generating a shared session.
   String genContextFromParameters(Map parameters) {
-    final ptr = _c_gen_context_from_str(library, parameters['header'], parameters['size']);
+    final ptr = _c_gen_context_from_str(
+        library, parameters['header'], parameters['size']);
     raiseForStatus();
     return ptr.toDartString();
   }
-  
+
   /// Returns the number of slots based on parameters.
   int get slotCount => _c_slot_count(library);
 
   /// Returns the string representation of FHE parameters.
-  /// 
+  ///
   /// Useful for saving to disk or sending over the network.
   /// The `header` is the string representation of the parameters.
   /// The `size` is the length of the string.
@@ -194,7 +195,7 @@ class Afhe {
   }
 
   /// Loads a [Ciphertext] from a non-human-readable format.
-  /// 
+  ///
   /// Useful for loading from disk or receiving over the network.
   /// The [size] is the length of the data.
   /// The [data] is a pointer to the memory address of the data.
@@ -206,7 +207,8 @@ class Afhe {
 
   /// Encodes a list of integers into a [Plaintext].
   Plaintext encodeVecInt(List<int> vec) {
-    Pointer ptr = _c_encode_vector_int(library, intListToUint64Array(vec), vec.length);
+    Pointer ptr =
+        _c_encode_vector_int(library, intListToUint64Array(vec), vec.length);
     raiseForStatus();
     return Plaintext.fromPointer(backend, ptr);
   }
@@ -228,7 +230,8 @@ class Afhe {
 
   /// Encodes a list of doubles into a [Plaintext].
   Plaintext encodeVecDouble(List<double> vec) {
-    Pointer ptr = _c_encode_vector_double(library, doubleListToArray(vec), vec.length);
+    Pointer ptr =
+        _c_encode_vector_double(library, doubleListToArray(vec), vec.length);
     raiseForStatus();
     // String cannot be extracted from C object for CKKS
     return Plaintext.fromPointer(backend, ptr, extractStr: false);
@@ -312,7 +315,7 @@ class Afhe {
   }
 
   /// Raises the [Ciphertext] to a [power].
-  /// 
+  ///
   /// Only supported for BFV/BGV [Scheme].
   /// The [power] must be a positive integer.
   /// Applies relinearization after each multiplication step.

dart/lib/ffi.dart

@@ -2,18 +2,71 @@ part of '../afhe.dart';
 
 const String _libraryName = 'fhel';
 
+// pub-cache directory
+String get desktopPubCachePath {
+  final homeDir =
+      Platform.environment['HOME'] ?? Platform.environment['USERPROFILE'];
+  final pubCachePath =
+      Platform.environment['PUB_CACHE'] ?? '$homeDir/.pub-cache';
+  final pubHostedUrl = Platform.environment['PUB_HOSTED_URL'] ?? 'pub.dev';
+  return "$pubCachePath/hosted/$pubHostedUrl";
+}
+
+// dynamic libfhel
+final libfhel = switch (Platform.operatingSystem) {
+  "windows" => "$_libraryName.dll",
+  "linux" || "android" => "lib$_libraryName.so",
+  "macos" => "lib$_libraryName.dylib",
+  _ => throw UnsupportedError(
+      "Platform ${Platform.operatingSystem} not supported",
+    )
+};
+
+// Latest .pub-cache version
+final version = () {
+  final pubCachePath = desktopPubCachePath;
+  final directory = Directory(pubCachePath);
+
+  // Filter for relevant directories and extract versions
+  final versions = directory
+      .listSync()
+      .whereType<Directory>() // Filter out non-directory entries
+      .map((directory) {
+        final name = path.basename(directory.path);
+        final match = RegExp('$_libraryName-(.*)').firstMatch(name);
+        return match != null
+            ? match.group(1)!
+            : '-1'; // Use null-aware operator and assert non-null group
+      })
+      .where((version) => version != '-1') // Filter out non-matching versions
+      .toList();
+
+  versions.sort(); // Sort versions in ascending order
+
+  return versions.isEmpty
+      ? throw StateError('Package $_libraryName not found in $pubCachePath. Have you run `dart pub install $_libraryName`?')
+      : versions.last; // Handle the case where no matching versions are found
+}();
+
 // load native library
 final DynamicLibrary dylib = () {
-  if (Platform.isIOS) return DynamicLibrary.process();
-  final defaultLibPath = switch (Platform.operatingSystem) {
-    "windows" => "$_libraryName.dll",
-    "linux" || "android" => "lib$_libraryName.so",
-    "macos" => "lib$_libraryName.dylib",
-    _ => throw UnsupportedError(
-        "Platform ${Platform.operatingSystem} not supported",
-      )
-  };
-  final libPath = path.absolute(
-      Platform.environment["FHEL_C_LIB_PREFIX"] ?? '', defaultLibPath);
-  return DynamicLibrary.open(libPath);
+  // Continuous integration
+  if (Platform.environment.containsKey('FHEL_C_LIB_PREFIX')) {
+    return DynamicLibrary.open("${Platform.environment['FHEL_C_LIB_PREFIX']}/$libfhel");
+  }
+  // Development environment
+  if (Platform.environment.containsKey('FHEL_C_LIB_PATH')) {
+    return DynamicLibrary.open(Platform.environment['FHEL_C_LIB_PATH']!);
+  }
+  // Android: packaged at runtime, see dart/android/build.gradle
+  if (Platform.isAndroid) {
+    return DynamicLibrary.open(libfhel);
+  }
+  // Production environment: .pub-cache
+  try {
+    return DynamicLibrary.open(
+        '$desktopPubCachePath/$_libraryName-$version/${Platform.operatingSystem}/$libfhel');
+  } catch (e) {
+    throw StateError('$e. Have you run `dart run fhel:setup --${Platform.operatingSystem}`?');
+  }
 }();