Merge pull request #3682 from DataDog/tonycthsu/backkport-ffi-changes

backport ffi changes

.gitlab-ci.yml

@@ -76,7 +76,7 @@ build-gem:
       when: on_success
     - if: $CI_COMMIT_TAG
       when: on_success
-    - if: $CI_COMMIT_BRANCH == 'master'
+    - if: $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_BRANCH == '1.x-stable'
       when: on_success
     - when: manual
       allow_failure: true
@@ -107,6 +107,9 @@ build-gem:
   script:
     - export RUBY_PACKAGE_VERSION=$(cat tmp/version.txt)
     - export DDTRACE_GEM_LOCATION=$(readlink -f pkg/ddtrace-*.gem)
+    - ruby -v
+    - gem -v
+    - bundler -v
     - ruby .gitlab/install_ddtrace_deps.rb
   artifacts:
     paths:

.gitlab/Dockerfile-2.7.8

@@ -1,4 +1,5 @@
-# This is copied from official Docker image, but compile Ruby with `--disable-shared` instead.
+# This is copied from official Docker image
+# but compile Ruby with `--disable-shared` and update gem version
 
 FROM registry.ddbuild.io/images/mirror/buildpack-deps:buster
 
@@ -75,6 +76,8 @@ RUN set -eux; \
 # verify we have no "ruby" packages installed
 	if dpkg -l | grep -i ruby; then exit 1; fi; \
 	[ "$(command -v ruby)" = '/usr/local/bin/ruby' ]; \
+# update gem version
+	gem update --system 3.3.27;\
 # rough smoke test
 	ruby --version; \
 	gem --version; \

.gitlab/Dockerfile-3.0.6

@@ -1,4 +1,5 @@
-# This is copied from official Docker image, but compile Ruby with `--disable-shared` instead.
+# This is copied from official Docker image
+# but compile Ruby with `--disable-shared` and update gem version
 
 FROM registry.ddbuild.io/images/mirror/buildpack-deps:buster
 
@@ -75,6 +76,8 @@ RUN set -eux; \
 # verify we have no "ruby" packages installed
 	if dpkg -l | grep -i ruby; then exit 1; fi; \
 	[ "$(command -v ruby)" = '/usr/local/bin/ruby' ]; \
+# update gem version
+	gem update --system;\
 # rough smoke test
 	ruby --version; \
 	gem --version; \

.gitlab/Dockerfile-3.1.4

@@ -1,4 +1,5 @@
-# This is copied from official Docker image, but compile Ruby with `--disable-shared` instead.
+# This is copied from official Docker image
+# but compile Ruby with `--disable-shared` and update gem version
 
 FROM registry.ddbuild.io/images/mirror/buildpack-deps:buster
 
@@ -75,6 +76,8 @@ RUN set -eux; \
 # verify we have no "ruby" packages installed
 	if dpkg -l | grep -i ruby; then exit 1; fi; \
 	[ "$(command -v ruby)" = '/usr/local/bin/ruby' ]; \
+# update gem version
+	gem update --system;\
 # rough smoke test
 	ruby --version; \
 	gem --version; \

.gitlab/Dockerfile-3.2.2

@@ -1,4 +1,5 @@
-# This is copied from official Docker image, but compile Ruby with `--disable-shared` instead.
+# This is copied from official Docker image, but
+# compile Ruby with `--disable-shared` and update gem version
 
 FROM registry.ddbuild.io/images/mirror/buildpack-deps:buster
 
@@ -99,6 +100,8 @@ RUN set -eux; \
 # verify we have no "ruby" packages installed
 	if dpkg -l | grep -i ruby; then exit 1; fi; \
 	[ "$(command -v ruby)" = '/usr/local/bin/ruby' ]; \
+# update gem version
+	gem update --system;\
 # rough smoke test
 	ruby --version; \
 	gem --version; \

.gitlab/install_ddtrace_deps.rb

@@ -4,8 +4,22 @@
 require 'fileutils'
 require 'pathname'
 
+puts '=== RUBY_VERSION ==='
+puts RUBY_VERSION
+puts '=== RUBY_ENGINE ==='
+puts RUBY_ENGINE
+puts '=== RUBY_ENGINE_VERSION ==='
+puts RUBY_ENGINE_VERSION
+puts '=== RUBY_PLATFORM ==='
+puts RUBY_PLATFORM
+puts '=== GEM PLATFORM ==='
+puts Gem::Platform.local
+
 ruby_api_version = Gem.ruby_api_version
 
+puts '=== RUBY API VERISON ==='
+puts ruby_api_version
+
 current_path = Pathname.new(FileUtils.pwd)
 
 tmp_path = current_path.join('tmp')
@@ -18,7 +32,8 @@
 
 File.open(gemfile_file_path, 'w') do |file|
   file.write("source 'https://rubygems.org'\n")
-  file.write("gem 'ddtrace', '#{ENV.fetch('RUBY_PACKAGE_VERSION')}', path: '#{current_path}'")
+  file.write("gem 'ddtrace', '#{ENV.fetch('RUBY_PACKAGE_VERSION')}', path: '#{current_path}'\n")
+  file.write("gem 'ffi', '1.16.3'\n")
 end
 
 puts '=== Reading Gemfile ==='

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "files.associations": {
+    "Dockerfile*": "dockerfile"
+  }
+}

Gemfile

@@ -117,5 +117,13 @@ group :check do
 end
 
 gem 'docile', '~> 1.3.5' if RUBY_VERSION < '2.5'
-gem 'ffi', '~> 1.12.2' if RUBY_VERSION < '2.3'
+if RUBY_VERSION < '2.3'
+  gem 'ffi', '~> 1.12.2', require: false
+else
+  # `1.17.0` provides broken RBS type definitions
+  # https://github.com/ffi/ffi/blob/master/CHANGELOG.md#1170rc1--2024-04-08
+  #
+  # TODO: Remove this once the issue is resolved: https://github.com/ffi/ffi/issues/1107
+  gem 'ffi', '< 1.17.0', require: false
+end
 gem 'msgpack', '~> 1.3.3' if RUBY_VERSION < '2.4'