fix(ruby): Enable ruby-sdk to be cross compiled ahead of time (#42)

* fix(ruby): Enable rust-sdk to be cross compiled ahead of time

* add github action to cross compile gems

* remove comment

* fix indentation

* change working directory for ruby

* fix cross-gem agai

* yet another fix

* another try

* yep

* manually run cross compile

* fix indentation

* more fixes

* skip tags

* adapt build from https://github.com/BoundaryML/baml/blob/canary/.github/workflows/build-ruby-release.reusable.yaml

* fix path

* Fix https://github.com/openssl/openssl/pull/25367\#issuecomment-2338141250

* chore: add "vendored" feature flag to eppo_core

* chore(ruby): build gem for 3.0 version

* code review comments

* add fake publish step for testing

* comment out needs

* update cargo lockfile

* fix file path

* fix version

* another try

* another try

* 20th time is the charm

* fix paths

* add ls for debugging

* final try

* move cross_gems and publish to publish.yml

---------

Co-authored-by: Oleksii Shmalko <[email protected]>

.github/workflows/ci.yml

@@ -26,44 +26,3 @@ jobs:
       - run: cargo build --verbose --all-targets
       - run: cargo test --verbose
       - run: cargo doc --verbose
-
-
-  ruby_test:
-    runs-on: ${{ matrix.os }}-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu, macos]
-        ruby: [3.0, 3.1, 3.2]
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          submodules: true
-
-      - name: Set up Ruby & Rust
-        uses: oxidize-rb/actions/setup-ruby-and-rust@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-          cargo-cache: true
-          rubygems: '3.5.11'
-
-      - run: npm ci
-
-      - name: Override eppo_core for testing
-        run: |
-          mkdir -p ~/.cargo/
-          echo "[patch.crates-io.eppo_core]" >> "${CARGO_HOME:-$HOME/.cargo}/config.toml"
-          echo "path = '$PWD/eppo_core'" >> "${CARGO_HOME:-$HOME/.cargo}/config.toml"
-
-      - name: Install dependencies
-        run: bundle install
-        working-directory: ruby-sdk
-
-      - name: Build
-        run: bundle exec rake build
-        working-directory: ruby-sdk
-
-      - name: Run tests
-        run: npm run with-server test:ruby

.github/workflows/publish.yml

@@ -55,38 +55,196 @@ jobs:
         env:
           CARGO_REGISTRY_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
 
+  cross_gems:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ruby-sdk
+    strategy:
+      fail-fast: false
+      matrix:
+        _:
+          - platform: x86_64-linux
+            # This is necessary because rb-sys-dock depends on manylinux2014,
+            # which is based on CentOS 7 which is EOL as of July 2024 Once
+            # rake-compiler-dock switches to manylinux_2_28 and rb-sys-dock
+            # picks that up, we can pick their updates up and then drop this.
+            # See https://github.com/oxidize-rb/rb-sys/issues/402 and
+            # https://github.com/rake-compiler/rake-compiler-dock/issues/122
+            # for more details.
+            rb-sys-dock-setup: ./build/x86-64_linux-setup.sh
+          - platform: x86_64-linux-musl
+          - platform: aarch64-linux
+          - platform: aarch64-linux-musl
+          - platform: arm-linux
+          - platform: arm64-darwin
+          # - platform: x64-mingw32
+          # - platform: x86-mingw-ucrt
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: oxidize-rb/actions/setup-ruby-and-rust@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+          cargo-cache: true
+          cargo-vendor: true
+          cache-version: v2-${{ matrix._.platform }}
+
+      - name: Set vars
+        id: vars
+        run: |
+          echo "rb-sys-version=$(bundle exec ruby -rrb_sys -e 'puts RbSys::VERSION')" >> $GITHUB_OUTPUT
+
+      - uses: "ruby/setup-ruby@v1"
+        with:
+          ruby-version: "3.2"
+          bundler-cache: true
+
+      - name: Configure environment
+        shell: bash
+        id: configure
+        run: |
+          : Configure environment
+          echo "RB_SYS_DOCK_UID=$(id -u)" >> $GITHUB_ENV
+          echo "RB_SYS_DOCK_GID=$(id -g)" >> $GITHUB_ENV
+          rb_sys_version="$((grep rb_sys Gemfile.lock | head -n 1 | grep -oE '[0-9]+\.[0-9]+\.[0-9]+') || (gem info rb_sys --remote | grep -oE '[0-9]+\.[0-9]+\.[0-9]+') || echo "latest")"
+          rb_sys_dock_cache_dir="$HOME/.cache/rb-sys-$rb_sys_version"
+          mkdir -p "$rb_sys_dock_cache_dir"
+          echo "RB_SYS_DOCK_CACHE_DIR=$rb_sys_dock_cache_dir" >> $GITHUB_ENV
+          echo "rb_sys_version=$rb_sys_version" >> $GITHUB_OUTPUT
+
+      - name: Setup caching
+        uses: actions/cache@v4
+        with:
+          path: |
+            ${{ env.RB_SYS_DOCK_CACHE_DIR }}
+            ruby-sdk/tmp/rb-sys-dock/${{ matrix._.platform }}/target
+          key: rb-sys-dock-v0-${{ matrix._.platform }}-${{ hashFiles('**/Gemfile.lock', '**/Cargo.lock') }}
+          save-always: true
+          restore-keys: |
+            rb-sys-dock-v0-${{ matrix._.platform }}-
+
+      - name: Install cargo-cache
+        uses: oxidize-rb/actions/cargo-binstall@v1
+        id: install-cargo-cache
+        with:
+          crate: cargo-cache
+          version: 0.8.3
+          strategies: quick-install
+
+      - name: Clean the cargo cache
+        uses: oxidize-rb/actions/post-run@v1
+        with:
+          run: cargo-cache --autoclean
+          cwd: ruby-sdk
+          always: true
+
+      - name: Setup rb-sys
+        shell: bash
+        working-directory: ruby-sdk
+        run: |
+          version="${{ steps.configure.outputs.rb_sys_version }}"
+          echo "Installing rb_sys@$version"
+
+          if [ "$version" = "latest" ]; then
+            gem install rb_sys
+          else
+            gem install rb_sys -v $version
+          fi
+
+      - name: Build gem
+        shell: bash
+        run: |
+          : Compile gem
+          echo "Docker Working Directory: $(pwd)"
+          set -x
+
+          # We can't actually parallelize the Ruby versions because
+          # they get bundled into the same gem.
+          #
+          # However, not parallelizing versions is actually helpful
+          # because Cargo is able to reuse most of compile work
+          # between versions.
+          rb-sys-dock \
+            --platform ${{ matrix._.platform }} \
+            --mount-toolchains \
+            --ruby-versions 3.3,3.2,3.1,3.0 \
+            --build \
+            -- ${{ matrix._.rb-sys-dock-setup }}
+
+      - name: Set outputs
+        id: set-outputs
+        shell: bash
+        run: |
+          : Set output
+          echo "gem-path=ruby-sdk/$(find pkg -name '*-${{ matrix._.platform }}.gem')" >> $GITHUB_OUTPUT
+
+      - name: Upload the cross-compiled gems
+        uses: actions/upload-artifact@v3
+        with:
+          name: cross-gem
+          path: ${{ steps.set-outputs.outputs.gem-path }}
+
   publish_ruby:
     name: Publish to RubyGems
     runs-on: ubuntu-latest
     if: ${{ startsWith(github.ref_name, 'ruby-sdk@') }}
+    needs: cross_gems
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: true
+
       - uses: actions/setup-node@v3
         with:
           node-version: '20'
+
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: '3.3'
+
+      - name: Download the cross-compiled gems
+        uses: actions/download-artifact@v3
+        with:
+          name: cross-gem
+
       - name: Check Cargo.lock
         # Ensure that Cargo.lock matches Cargo.toml
         run: cargo update --workspace --locked --verbose
         working-directory: ruby-sdk
+
       - name: Install dependencies
         run: bundle install
         working-directory: ruby-sdk
+
       - name: Build
         run: bundle exec rake build
         working-directory: ruby-sdk
+
+      - name: Move the downloaded artifacts
+        run: |
+          mv *.gem ruby-sdk/pkg
+
       - name: Publish to RubyGems
+        working-directory: ruby-sdk/pkg/
+        env:
+          RUBYGEMS_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
         run: |
           mkdir -p $HOME/.gem
           touch $HOME/.gem/credentials
           chmod 0600 $HOME/.gem/credentials
           printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
-          gem push pkg/eppo-server-sdk-*.gem
-        env:
-          RUBYGEMS_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
-        working-directory: ruby-sdk
+          ls -l
+          for i in *.gem; do
+            if [ -f "$i" ]; then
+              if ! gem push "$i" >push.out; then
+                gemerr=$?
+                sed 's/^/::error:: /' push.out
+                if ! grep -q "Repushing of gem" push.out; then
+                  exit $gemerr
+                fi
+              fi
+            fi
+          done

.github/workflows/ruby.yml

@@ -0,0 +1,55 @@
+---
+name: Ruby SDK
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ruby_test:
+    runs-on: ${{ matrix.os }}-latest
+    outputs:
+      gem-path: ${{ steps.set-outputs.outputs.gem-path }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [3.0, 3.1, 3.2]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Set up Ruby & Rust
+        uses: oxidize-rb/actions/setup-ruby-and-rust@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          cargo-cache: true
+          rubygems: '3.5.11'
+
+      - run: npm ci
+
+      - name: Override eppo_core for testing
+        run: |
+          mkdir -p ~/.cargo/
+          echo "[patch.crates-io.eppo_core]" >> "${CARGO_HOME:-$HOME/.cargo}/config.toml"
+          echo "path = '$PWD/eppo_core'" >> "${CARGO_HOME:-$HOME/.cargo}/config.toml"
+
+      - name: Install dependencies
+        run: bundle install
+        working-directory: ruby-sdk
+
+      - name: Build
+        run: bundle exec rake build
+        working-directory: ruby-sdk
+
+      - name: Run tests
+        run: npm run with-server test:ruby

ruby-sdk/Gemfile

@@ -5,11 +5,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in eppo-server-sdk.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+group :test do
+  gem "rspec", "~> 3.0"
+end
 
-gem "rake-compiler"
-gem "rb_sys", "~> 0.9.63"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+group :development do
+  gem "rake", "~> 13.0"
+  gem "rake-compiler"
+  gem "rb_sys", "~> 0.9.102"
+  gem "rubocop", "~> 1.21"
+end

ruby-sdk/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eppo-server-sdk (3.2.0)
+    eppo-server-sdk (3.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -19,7 +19,7 @@ GEM
     rake (13.2.1)
     rake-compiler (1.2.7)
       rake
-    rb_sys (0.9.97)
+    rb_sys (0.9.102)
     regexp_parser (2.9.2)
     rexml (3.3.0)
       strscan
@@ -60,9 +60,9 @@ DEPENDENCIES
   eppo-server-sdk!
   rake (~> 13.0)
   rake-compiler
-  rb_sys (~> 0.9.63)
+  rb_sys (~> 0.9.102)
   rspec (~> 3.0)
   rubocop (~> 1.21)
 
 BUNDLED WITH
-   2.5.9
+   2.4.4