Go/Core Refactore: Move FFI to a dedicated folder to be reusable for other wrappers

Signed-off-by: barshaul <[email protected]>

Author: barshaul

.github/workflows/ffi.yml

@@ -0,0 +1,45 @@
+name: Glide FFI CI
+
+on:
+    push:
+        branches:
+            - main
+            - release-*
+            - v*
+        paths:
+            - glide-core/src/**
+            - glide-core/redis-rs/redis/src/**
+            - ffi/**
+    pull_request:
+        paths:
+            - glide-core/src/**
+            - glide-core/redis-rs/redis/src/**
+            - ffi/**
+    workflow_call:
+
+concurrency:
+    group: ffi-${{ github.head_ref || github.ref }}-${{ toJson(inputs) }}
+    cancel-in-progress: true
+
+env:
+    CARGO_TERM_COLOR: always
+
+jobs:
+    build-and-gen-c:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - name: Install Rust and protoc
+              uses: ./.github/workflows/install-rust-and-protoc
+              with:
+                  github-token: ${{ secrets.GITHUB_TOKEN }}
+
+            - name: Build the FFI library
+              working-directory: ffi
+              run: |
+                  cargo build --release
+            - name: Generate the C header file
+              working-directory: ffi
+              run: |
+                  cargo install cbindgen
+                  cbindgen --config cbindgen.toml --crate glide_ffi --output lib.h --lang c

.github/workflows/go-cd.yml

@@ -119,16 +119,14 @@ jobs:
               working-directory: go
               run: |
                   make install-build-tools
-                  make build-glide-client
-                  # TODO: move generation of protobuf and header file to a non-matrix step
-                  make generate-protobuf
+                  make build
             - name: Upload artifacts
               continue-on-error: true
               uses: actions/upload-artifact@v4
               with:
                   name: ${{ matrix.host.TARGET }}
                   path: |
-                      go/target/release/libglide_rs.a
+                      ffi/target/release/libglide_ffi.a
                       go/lib.h
                       go/protobuf/
 
@@ -149,7 +147,7 @@ jobs:
                   for dir in */; do
                     target_name=${dir%/}
                     mkdir -p $GITHUB_WORKSPACE/go/rustbin/${target_name}
-                    cp ${target_name}/target/release/libglide_rs.a $GITHUB_WORKSPACE/go/rustbin/${target_name}/
+                    cp ${target_name}/target/release/libglide_ffi.a $GITHUB_WORKSPACE/go/rustbin/${target_name}/
                   done
                   # TODO: move generation of protobuf and header file to a non-matrix step
                   cd x86_64-unknown-linux-gnu

.github/workflows/go.yml

@@ -9,6 +9,7 @@ on:
         paths:
             - glide-core/src/**
             - glide-core/redis-rs/redis/src/**
+            - ffi/src/**
             - utils/cluster_manager.py
             - go/**
             - .github/workflows/go.yml
@@ -22,6 +23,7 @@ on:
         paths:
             - glide-core/src/**
             - glide-core/redis-rs/redis/src/**
+            - ffi/src/**
             - utils/cluster_manager.py
             - go/**
             - .github/workflows/go.yml
@@ -133,11 +135,6 @@ jobs:
         steps:
             - uses: actions/checkout@v4
 
-            - uses: ./.github/workflows/lint-rust
-              with:
-                  cargo-toml-folder: go
-                  github-token: ${{ secrets.GITHUB_TOKEN }}
-
             - name: Set up Go ${{ matrix.go }}
               uses: actions/setup-go@v5
               with:

.github/workflows/rust.yml

@@ -10,6 +10,7 @@ on:
             - logger_core/**
             - glide-core/**
             - glide-core/redis-rs/redis/src/**
+            - ffi/**
             - utils/cluster_manager.py
             - .github/workflows/rust.yml
             - .github/workflows/install-shared-dependencies/action.yml
@@ -23,6 +24,7 @@ on:
             - logger_core/**
             - glide-core/**
             - glide-core/redis-rs/redis/src/**
+            - ffi/**
             - utils/cluster_manager.py
             - .github/workflows/rust.yml
             - .github/workflows/install-shared-dependencies/action.yml
@@ -127,6 +129,12 @@ jobs:
                   github-token: ${{ secrets.GITHUB_TOKEN }}
               name: lint glide-core
 
+            - uses: ./.github/workflows/lint-rust
+              with:
+                  cargo-toml-folder: ./ffi
+                  github-token: ${{ secrets.GITHUB_TOKEN }}
+              name: lint glide-ffi
+
             - uses: ./.github/workflows/lint-rust
               with:
                   cargo-toml-folder: ./logger_core

go/.cargo/config.toml ffi/.cargo/config.toml

@@ -1,5 +1,5 @@
 [env]
-GLIDE_NAME = { value = "GlideGo", force = true }
+GLIDE_NAME = { value = "GlideFFI", force = true }
 GLIDE_VERSION = "0.1.0"
 # Suppress error
 # > ... was built for newer 'macOS' version (14.5) than being linked (14.0)

ffi/.gitignore

@@ -0,0 +1,2 @@
+# cbindgen generated header file
+lib.h

go/Cargo.toml ffi/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "glide-rs"
+name = "glide-ffi"
 version = "0.1.0"
 edition = "2021"
 license = "Apache-2.0"
@@ -9,10 +9,10 @@ authors = ["Valkey GLIDE Maintainers"]
 crate-type = ["staticlib"]
 
 [dependencies]
-redis = { path = "../glide-core/redis-rs/redis", features = ["aio", "tokio-comp", "connection-manager", "tokio-rustls-comp"] }
+protobuf = { version = "3", features = [] }
+redis = { path = "../glide-core/redis-rs/redis", features = ["aio", "tokio-comp", "tokio-rustls-comp"] }
 glide-core = { path = "../glide-core", features = ["proto"] }
 tokio = { version = "^1", features = ["rt", "macros", "rt-multi-thread", "time"] }
-protobuf = { version = "3.3.0", features = [] }
 
 [profile.release]
 lto = true

ffi/README.md

@@ -0,0 +1,31 @@
+# glide_ffi
+
+## Overview
+
+The glide_ffi crate provides a C-compatible Foreign Function Interface (FFI) for interacting with `glide-core`. It serves as a bridge for internal wrappers written in other languages, such as Go, to integrate seamlessly with `glide-core`.
+
+## Structure
+	•	src/lib.rs: Defines the FFI interface.
+	•	cbindgen.toml: Configuration for generating the C header file (lib.h).
+	•	Cargo.toml: Manages dependencies, including glide-core.
+
+## Building the Library
+
+To build the FFI library:
+```
+cargo build --release
+```
+
+To generate the C header file:
+```
+cargo install cbindgen
+cbindgen --config cbindgen.toml --crate glide_ffi --output lib.h --lang c
+```
+
+## Running the linters
+
+```bash
+rustup component add clippy rustfmt
+cargo clippy --all-features --all-targets -- -D warnings
+cargo fmt --manifest-path ./Cargo.toml --all
+```