[CI] Package and test gem install during CI build (#63)

* Use thermite gem for invoking cargo compiler

* Add extension-specific Rakefile

* Switch to using the main Rakefile for the build

* Fix Rubocop

* Include Cargo.toml in .gem

* Include Bridge src files in .gem

* fixup! Include Bridge src files in .gem

* Include all sdk-core in .gem

* Use separate Rakefile for native extension build

* Use gem build/install instead of rake install in CI

Author: antstorm

.github/workflows/ci.yml

@@ -63,3 +63,7 @@ jobs:
       - run: bundle exec rake bridge:release
       - run: bundle exec rake test_server:build
       - run: bundle exec rspec
+      - name: Package and install the gem
+        run: |
+          gem build temporal.gemspec
+          gem install $(echo temporal-ruby-*.gem)

.gitignore

@@ -10,6 +10,10 @@ _yardoc/
 /spec/reports/
 /tmp/
 
+# Thermite artefacts
+mkmf.log
+lib/bridge.so
+
 # rspec failure tracking
 .rspec_status
 

.rubocop.yml

@@ -55,6 +55,7 @@ Metrics/AbcSize:
 
 Metrics/BlockLength:
   Exclude:
+    - temporal.gemspec
     - spec/**/*_spec.rb
 
 Metrics/ClassLength:

Rakefile

@@ -1,13 +1,19 @@
 require 'bundler/gem_tasks'
 require 'rbs_protobuf'
 require 'fileutils'
+require 'thermite/tasks'
 
 API_PROTO_ROOT = 'bridge/sdk-core/protos/api_upstream'.freeze
 CORE_PROTO_ROOT = 'bridge/sdk-core/protos/local'.freeze
 PROTOBUF_PATH = 'lib/gen'.freeze
 RBS_SIG_PATH = 'sig/protos'.freeze
 GRPC_PATH = 'spec/support/grpc'.freeze
 
+Thermite::Tasks.new(
+  cargo_project_path: File.expand_path('bridge', __dir__),
+  ruby_project_path: __dir__,
+)
+
 namespace :bridge do
   desc 'Run a linter on SDK Core Bridge'
   task :lint do
@@ -16,21 +22,18 @@ namespace :bridge do
 
   desc 'Build SDK Core Bridge'
   task :build do
-    sh 'cd bridge && cargo build'
+    ENV['CARGO_PROFILE'] = 'debug'
+    Rake::Task['thermite:build'].invoke
   end
 
   desc 'Release SDK Core Bridge'
-  task :release do
-    sh 'cd bridge && cargo build --release'
-  end
+  task release: ['thermite:build']
 
   # Mac OS with rbenv users keep leaving behind build artifacts from
   #   when they tried to build against a statically linked Ruby and then
   #   try against a dynamically linked one causing errors in the build result
   desc 'Clean up previous build artefacts'
-  task :clean do
-    sh 'cd bridge && cargo clean'
-  end
+  task clean: ['thermite:clean']
 end
 
 namespace :test_server do

bridge/Cargo.toml

@@ -3,6 +3,7 @@ name = "bridge"
 version = "0.0.1"
 authors = ["Anthony D <anthony@temporal.io>"]
 edition = "2021"
+repository = "https://github.com/temporalio/sdk-ruby"
 
 [dependencies]
 lazy_static = "1.4.0"
@@ -20,3 +21,6 @@ url = "2.2"
 [lib]
 name = "bridge"
 crate-type = ["dylib"]
+
+[package.metadata.thermite]
+github_releases = true

ext/Rakefile

@@ -0,0 +1,8 @@
+require 'thermite/tasks'
+
+Thermite::Tasks.new(
+  cargo_project_path: File.expand_path('../bridge', __dir__),
+  ruby_project_path: File.expand_path('..', __dir__),
+)
+
+task default: 'thermite:build'

lib/temporal/bridge.rb

@@ -1,12 +1,14 @@
 require 'rutie'
 
-BRIDGE_DIR = File.expand_path('../../bridge/src', File.dirname(__FILE__))
+BRIDGE_DIR = File.expand_path('..', __dir__)
 
 module Temporal
   module Bridge
     # TODO: Expand this into more specific error types
     class Error < StandardError; end
 
-    Rutie.new(:bridge, release: ENV['DEBUG'] ? :debug : :release).init('init_bridge', BRIDGE_DIR)
+    Rutie
+      .new(:bridge, lib_path: '', lib_suffix: 'so', lib_prefix: '')
+      .init('init_bridge', BRIDGE_DIR)
   end
 end

temporal.gemspec

@@ -12,12 +12,18 @@ Gem::Specification.new do |spec|
   spec.email         = ['anthony@temporal.io']
 
   spec.require_paths = ['lib']
-  spec.files         = Dir['{lib}/**/*.*'] + %w[temporal.gemspec Gemfile LICENSE README.md]
+  spec.extensions    = ['ext/Rakefile']
+
+  spec.files =
+    Dir['lib/**/*.*'] +
+    Dir['bridge/**/*.*'].reject { |x| x.include?('/target/') } +
+    %w[ext/Rakefile temporal.gemspec Gemfile LICENSE README.md]
 
   spec.required_ruby_version = '>= 2.7.0'
 
   spec.add_dependency 'google-protobuf', '~> 3.21.1' # Protobuf
   spec.add_dependency 'rutie', '~> 0.0.4' # Rust bindings
+  spec.add_dependency 'thermite', '~> 0.13.0' # For compiling Rust ext
 
   spec.add_development_dependency 'grpc' # Ruby GRPC for the mock server
   spec.add_development_dependency 'grpc-tools' # GRPC generator for the mock server