add supported versions workflow (#4210)

* add supported version script and table * update script * rubocop lint * modify script locations, add description to md table * improve table output * wip * refactor code * wip * add supported versions * add branch for testing * remove json to avoid merge conflict issues * update PR body * Update .github/scripts/generate_table_versions.rb Co-authored-by: Steven Bouwkamp <[email protected]> * switch to use gem declarations instead of hardcoded mappings * linting checks * cleanup comments * refactor code * cleanup code * Combine duplicate option table rows The documentation for instrumenting rake had two rows for the same option key. This consolidates those entries into a single row. * Enable type checking for AgentSettingsResolver/AgentSettings Steep doesn't seem to be a big fan of Structs so I just went ahead and turned the `AgentSettings` into a regular class that's equivalent to the struct we had before. (In particular, I decided to still keep every field as optional). Ideally this would be a `Data` class, but we're far from dropping support for Rubies that don't have it. * Move url building behavior from `AgentBaseUrl` to `AgentSettings` This is preparation to also share this behavior with profiling. * Refactor crashtracking to use `AgentSettings#url` The behavior from the old `AgentBaseUrl` is now contained in `AgentSettings` so we can clean up the extra logic. * [PROF-11078] Fix profiling exception when agent url is an ipv6 address **What does this PR do?** This PR builds atop #4237 and fixes a similar-ish issue in the profiler caused by the same mishandling of ipv6 addresses. In particular, when provided with an ipv6 address in the agent url, the profiler would fail with an exception: ``` $ env DD_AGENT_HOST=2001:db8:1::2 DD_PROFILING_ENABLED=true \ bundle exec ddprofrb exec ruby -e "sleep 2" dd-trace-rb/lib/datadog/profiling/http_transport.rb:27:in `initialize': Failed to initialize transport: invalid authority (ArgumentError) ``` **Motivation:** Luckily we didn't have any customers using this, as it fails immediately and loudly, but it's still a bug on a configuration that should be supported. **Additional Notes:** Since we had similar buggy logic copy-pasted in crashtracking and profiling (crashtracking had been fixed in #4237) I chose to extract out the relevant logic into the `AgentSettings` class, so that both can reuse it. **How to test the change?** I've added unit test coverage for this issue to profiling, and the snippet above can be used to end-to-end test it's working fine. Here's how it looks on my machine now: ``` E, [2025-01-02T17:32:32.398756 #359317] ERROR -- datadog: [datadog] (dd-trace-rb/lib/datadog/profiling/http_transport.rb:68:in `export') Failed to report profiling data (agent: http://[2001:db8:1::2]:8126/): failed ddog_prof_Exporter_send: error trying to connect: tcp connect error: Network is unreachable (os error 101): tcp connect error: Network is unreachable (os error 101): Network is unreachable (os error 101) ``` E.g. we correctly try to connect to the dummy address, and fail :) (Note: The error message is a bit ugly AND repeats itself a bit. That's being tracked separately in DataDog/libdatadog#283 ) * Implement `==` for new `AgentSettings` class Forgot this one, some of our tests relied on it! * use Ruby 3.4.1 for test-memcheck GHA * Update exceptions file with another variant of thread creation memory leak Since our exceptions match on the stack, they are affected by internal naming changes, and it looks like a new `ruby_xcalloc_body` function is now showing up in the stack. * Introduce Ruby 3.5 gemfile variant for testing with dev builds This is waaay incomplete in terms of adding support for Ruby 3.5 but should get us going for ASAN testing for now. * Update list of files used to compute cache checksum In practice this shouldn't make a difference, since the final lockfiles are supposed to be a superset of the root-level gemfile BUT the `Appraisals` file no longer exists anyway and "just in case" let's have it anyway as it seems more correct. * Bump Ruby 3.4 integration image to stable version * Remove workaround for strscan issue This is not expected to be an issue in 3.5 (and is probably fixed for 3.4 as well, but I'll leave that for a separate PR to not affect the appraisals). * Add unsafe api calls checker to track down issues such as #4195 This checker is used to detect accidental thread scheduling switching points happening during profiling sampling. See the bigger comment in unsafe_api_calls_check.h . I was able to check that this checker correctly triggers for the bug in #4195, and also the bug I'm going to fix next, which is the use of `rb_hash_lookup` in the otel context reading code. * Fix going into Ruby code when looking up otel context `rb_hash_lookup` calls `#hash` on the key being looked up so it's safe to use unless during sampling. This can cause the same issue as we saw in #4195 leading to ``` [BUG] unexpected situation - recordd:1 current:0 -- C level backtrace information ------------------------------------------- ruby(rb_print_backtrace+0x11) [0x55ba03ccf90f] vm_dump.c:820 ruby(rb_vm_bugreport) vm_dump.c:1151 ruby(bug_report_end+0x0) [0x55ba03e91607] error.c:1042 ruby(rb_bug_without_die) error.c:1042 ruby(die+0x0) [0x55ba03ac0998] error.c:1050 ruby(rb_bug) error.c:1052 ruby(disallow_reentry+0x0) [0x55ba03ab6dcc] vm_sync.c:226 ruby(rb_ec_vm_lock_rec_check+0x1a) [0x55ba03cb17aa] eval_intern.h:144 ruby(rb_ec_tag_state) eval_intern.h:155 ruby(rb_vm_exec) vm.c:2484 ruby(vm_invoke_proc+0x201) [0x55ba03cb62b1] vm.c:1509 ruby(rb_vm_invoke_proc+0x33) [0x55ba03cb65d3] vm.c:1728 ruby(thread_do_start_proc+0x176) [0x55ba03c63516] thread.c:598 ruby(thread_do_start+0x12) [0x55ba03c648a2] thread.c:615 ruby(thread_start_func_2) thread.c:672 ruby(nt_start+0x107) [0x55ba03c65137] thread_pthread.c:2187 /lib/x86_64-linux-gnu/libpthread.so.0(start_thread+0xd9) [0x7ff360b66609] /lib/x86_64-linux-gnu/libc.so.6(clone+0x43) [0x7ff360a70353] ``` * Avoid trying to sample allocations when VM is raising exception During my experiments to reproduce issues around allocation profiling, I've noted that the VM is in an especially delicate state during exception raising, so let's just decline to sample in this situation. * Update tests with new signatures for test methods * Check if symbol is static before calling SYM2ID on it It occurs to me that if a symbol is dynamic, we were causing it to become a static symbol (e.g. making it never be able to be garbage collected). This can be very bad! And also, we know the symbol we're looking for must be a static symbol because if nothing else, our initialization caused it to become a static symbol. Thus, if we see a dynamic symbol, we can stop there, since by definition it won't be the symbol we're looking after. This is... really awkward to add a specific unit test for, so I've just relied on our existing test coverage to show that this has not affected the correctness of our otel code. * Document that unsafe api calls checker is only for test code * Add 3.4 support * Update DevelopmentGuide * Remove `racc` gem from 3.3 and 3.4 appraisal files * [🤖] Lock Dependency: https://github.com/DataDog/dd-trace-rb/actions/runs/12595964519 * Remove strscan specification in 3.4 gemfile * [🤖] Lock Dependency: https://github.com/DataDog/dd-trace-rb/actions/runs/12595969993 * add hardcoded update workflow file --------- Co-authored-by: Steven Bouwkamp <[email protected]> Co-authored-by: Bradley Schaefer <[email protected]> Co-authored-by: Ivo Anjo <[email protected]> Co-authored-by: Andrey Marchenko <[email protected]> Co-authored-by: Sarah Chen <[email protected]> Co-authored-by: ivoanjo <[email protected]>
DataDog · Jan 8, 2025 · c3cd448 · c3cd448
1 parent d5f88ea
commit c3cd448
Show file tree

Hide file tree

Showing 18 changed files with 266 additions and 0 deletions.
diff --git a/.github/scripts/find_gem_version_bounds.rb b/.github/scripts/find_gem_version_bounds.rb
@@ -0,0 +1,149 @@
+require 'pathname'
+require 'rubygems'
+require 'json'
+require 'bundler'
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'datadog'
+
+class GemfileProcessor
+  SPECIAL_CASES = {
+    "opensearch" => "OpenSearch" # special case because opensearch = OpenSearch not Opensearch
+  }.freeze
+  EXCLUDED_INTEGRATIONS = ["configuration", "propagation", "utils"].freeze
+
+  def initialize(directory: 'gemfiles/', contrib_dir: 'lib/datadog/tracing/contrib/')
+    @directory = directory
+    @contrib_dir = contrib_dir
+    @min_gems = { 'ruby' => {}, 'jruby' => {} }
+    @max_gems = { 'ruby' => {}, 'jruby' => {} }
+    @integration_json_mapping = {}
+  end
+
+  def process
+    parse_gemfiles
+    process_integrations
+    include_hardcoded_versions
+    write_output
+  end
+
+  private
+
+
+  def parse_gemfiles(directory = 'gemfiles/')
+    gemfiles = Dir.glob(File.join(@directory, '*'))
+    gemfiles.each do |gemfile_name|
+      runtime = File.basename(gemfile_name).split('_').first # ruby or jruby
+      next unless %w[ruby jruby].include?(runtime)
+      # parse the gemfile
+      if gemfile_name.end_with?(".gemfile")
+        process_gemfile(gemfile_name, runtime)
+      elsif gemfile_name.end_with?('.gemfile.lock')
+        process_lockfile(gemfile_name, runtime)
+      end
+    end
+
+  end
+
+  def process_gemfile(gemfile_name, runtime)
+    begin
+      definition = Bundler::Definition.build(gemfile_name, nil, nil)
+      definition.dependencies.each do |dependency|
+        gem_name = dependency.name
+        version = dependency.requirement.to_s
+        update_gem_versions(runtime, gem_name, version)
+      end
+    rescue Bundler::GemfileError => e
+      puts "Error reading Gemfile: #{e.message}"
+    end
+  end
+
+  def process_lockfile(gemfile_name, runtime)
+    lockfile_contents = File.read(gemfile_name)
+    parser = Bundler::LockfileParser.new(lockfile_contents)
+    parser.specs.each do |spec|
+      gem_name = spec.name
+      version = spec.version.to_s
+      update_gem_versions(runtime, gem_name, version)
+    end
+  end
+
+  def update_gem_versions(runtime, gem_name, version)
+    return unless version_valid?(version)
+
+    gem_version = Gem::Version.new(version)
+
+    # Update minimum gems
+    if @min_gems[runtime][gem_name].nil? || gem_version < Gem::Version.new(@min_gems[runtime][gem_name])
+      @min_gems[runtime][gem_name] = version
+    end
+
+    # Update maximum gems
+    if @max_gems[runtime][gem_name].nil? || gem_version > Gem::Version.new(@max_gems[runtime][gem_name])
+      @max_gems[runtime][gem_name] = version
+    end
+  end
+
+  # Helper: Validate the version format
+  def version_valid?(version)
+    return false if version.nil? || version.strip.empty?
+
+    Gem::Version.new(version)
+    true
+  rescue ArgumentError
+    false
+  end
+
+
+  def process_integrations
+    integrations = Datadog::Tracing::Contrib::REGISTRY.map(&:name).map(&:to_s)
+    integrations.each do |integration|
+      next if EXCLUDED_INTEGRATIONS.include?(integration)
+
+      integration_name = resolve_integration_name(integration)
+
+      @integration_json_mapping[integration] = [
+        @min_gems['ruby'][integration_name],
+        @max_gems['ruby'][integration_name],
+        @min_gems['jruby'][integration_name],
+        @max_gems['jruby'][integration_name]
+      ]
+    end
+  end
+
+  def include_hardcoded_versions
+      # `httpx` is maintained externally
+    @integration_json_mapping['httpx'] = [
+      '0.11', # Min version Ruby
+      '0.11', # Max version Ruby
+      nil,     # Min version JRuby
+      nil      # Max version JRuby
+    ]
+
+    # `makara` is part of `activerecord`
+    @integration_json_mapping['makara'] = [
+      '0.3.5', # Min version Ruby
+      '0.3.5', # Max version Ruby
+      nil,     # Min version JRuby
+      nil      # Max version JRuby
+    ]
+  end
+
+  def resolve_integration_name(integration)
+    mod_name = SPECIAL_CASES[integration] || integration.split('_').map(&:capitalize).join
+    module_name = "Datadog::Tracing::Contrib::#{mod_name}"
+    integration_module = Object.const_get(module_name)::Integration
+    integration_module.respond_to?(:gem_name) ? integration_module.gem_name : integration
+  rescue NameError, NoMethodError
+    puts "Fallback for #{integration}: module or gem_name not found."
+    integration
+  end
+
+  def write_output
+    @integration_json_mapping = @integration_json_mapping.sort.to_h
+    File.write("gem_output.json", JSON.pretty_generate(@integration_json_mapping))
+  end
+end
+
+GemfileProcessor.new.process
diff --git a/.github/scripts/generate_table_versions.rb b/.github/scripts/generate_table_versions.rb
@@ -0,0 +1,21 @@
+require 'json'
+
+input_file = 'gem_output.json'
+output_file = 'integration_versions.md'
+
+data = JSON.parse(File.read(input_file))
+
+comment = "# Integrations\n\n"
+header = "| Integration | Ruby Min |  Ruby Max | JRuby Min | JRuby Max |\n"
+separator = "|-------------|----------|-----------|----------|----------|\n"
+rows = data.map do |integration_name, versions|
+    ruby_min, ruby_max, jruby_min, jruby_max = versions.map { |v| v || "None" }
+    "| #{integration_name} | #{ruby_min} | #{ruby_max} | #{jruby_min} | #{jruby_max} |"
+end
+
+File.open(output_file, 'w') do |file|
+  file.puts comment
+  file.puts header
+  file.puts separator
+  rows.each { |row| file.puts row }
+end
diff --git a/.github/workflows/generate-supported-versions.yml b/.github/workflows/generate-supported-versions.yml
@@ -0,0 +1,49 @@
+name: "Generate Supported Versions"
+
+on:
+  workflow_dispatch:
+
+
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true # runs bundle install
+          ruby-version: "3.3"
+
+      - name: Update latest
+        run: bundle exec ruby .github/scripts/find_gem_version_bounds.rb
+
+      - name: Generate versions table
+        run: ruby .github/scripts/generate_table_versions.rb
+
+      - run: git diff
+
+      - name: Create Pull Request
+        id: cpr
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GHA_PAT }}
+          branch: auto-generate/update-supported-versions
+          title: '[🤖] Update Supported Versions'
+          base: master
+          labels: dev/internal, integrations
+          commit-message: "Test creating supported versions"
+          delete-branch: true
+          body: |
+            This is a PR to update the table for supported integration versions.
+            Workflow run: [Generate Supported Versions](https://github.com/DataDog/dd-trace-rb/actions/workflows/generate-supported-versions.yml)
+            This should be tied to tracer releases, or triggered manually.
+
diff --git a/lib/datadog/tracing/contrib/action_cable/integration.rb b/lib/datadog/tracing/contrib/action_cable/integration.rb
@@ -17,6 +17,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :action_cable, auto_patch: false
+          def self.gem_name
+            'actioncable'
+          end
 
           def self.version
             Gem.loaded_specs['actioncable'] && Gem.loaded_specs['actioncable'].version

diff --git a/lib/datadog/tracing/contrib/action_mailer/integration.rb b/lib/datadog/tracing/contrib/action_mailer/integration.rb
@@ -18,6 +18,10 @@ class Integration
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :action_mailer, auto_patch: false
 
+          def self.gem_name
+            'actionmailer'
+          end
+
           def self.version
             Gem.loaded_specs['actionmailer'] && Gem.loaded_specs['actionmailer'].version
           end

diff --git a/lib/datadog/tracing/contrib/action_pack/integration.rb b/lib/datadog/tracing/contrib/action_pack/integration.rb
@@ -18,6 +18,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :action_pack, auto_patch: false
+          def self.gem_name
+            'actionpack'
+          end
 
           def self.version
             Gem.loaded_specs['actionpack'] && Gem.loaded_specs['actionpack'].version

diff --git a/lib/datadog/tracing/contrib/action_view/integration.rb b/lib/datadog/tracing/contrib/action_view/integration.rb
@@ -18,6 +18,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :action_view, auto_patch: false
+          def self.gem_name
+            'actionview'
+          end
 
           def self.version
             # ActionView is its own gem in Rails 4.1+

diff --git a/lib/datadog/tracing/contrib/active_job/integration.rb b/lib/datadog/tracing/contrib/active_job/integration.rb
@@ -17,6 +17,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :active_job, auto_patch: false
+          def self.gem_name
+            'activejob'
+          end
 
           def self.version
             Gem.loaded_specs['activejob'] && Gem.loaded_specs['activejob'].version

diff --git a/lib/datadog/tracing/contrib/active_record/integration.rb b/lib/datadog/tracing/contrib/active_record/integration.rb
@@ -22,6 +22,10 @@ class Integration
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :active_record, auto_patch: false
 
+          def self.gem_name
+            'activerecord'
+          end
+
           def self.version
             Gem.loaded_specs['activerecord'] && Gem.loaded_specs['activerecord'].version
           end

diff --git a/lib/datadog/tracing/contrib/active_support/integration.rb b/lib/datadog/tracing/contrib/active_support/integration.rb
@@ -19,6 +19,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :active_support, auto_patch: false
+          def self.gem_name
+            'activesupport'
+          end
 
           def self.version
             Gem.loaded_specs['activesupport'] && Gem.loaded_specs['activesupport'].version

diff --git a/lib/datadog/tracing/contrib/aws/integration.rb b/lib/datadog/tracing/contrib/aws/integration.rb
@@ -16,6 +16,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :aws, auto_patch: true
+          def self.gem_name
+            'aws-sdk-core'
+          end
 
           def self.version
             if Gem.loaded_specs['aws-sdk']

diff --git a/lib/datadog/tracing/contrib/concurrent_ruby/integration.rb b/lib/datadog/tracing/contrib/concurrent_ruby/integration.rb
@@ -16,6 +16,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :concurrent_ruby
+          def self.gem_name
+            'concurrent-ruby'
+          end
 
           def self.version
             Gem.loaded_specs['concurrent-ruby'] && Gem.loaded_specs['concurrent-ruby'].version

diff --git a/lib/datadog/tracing/contrib/httprb/integration.rb b/lib/datadog/tracing/contrib/httprb/integration.rb
@@ -17,6 +17,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :httprb
+          def self.gem_name
+            'http'
+          end
 
           def self.version
             Gem.loaded_specs['http'] && Gem.loaded_specs['http'].version

diff --git a/lib/datadog/tracing/contrib/kafka/integration.rb b/lib/datadog/tracing/contrib/kafka/integration.rb
@@ -16,6 +16,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :kafka, auto_patch: false
+          def self.gem_name
+            'ruby-kafka'
+          end
 
           def self.version
             Gem.loaded_specs['ruby-kafka'] && Gem.loaded_specs['ruby-kafka'].version

diff --git a/lib/datadog/tracing/contrib/mongodb/integration.rb b/lib/datadog/tracing/contrib/mongodb/integration.rb
@@ -17,6 +17,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :mongo, auto_patch: true
+          def self.gem_name
+            'mongo'
+          end
 
           def self.version
             Gem.loaded_specs['mongo'] && Gem.loaded_specs['mongo'].version

diff --git a/lib/datadog/tracing/contrib/opensearch/integration.rb b/lib/datadog/tracing/contrib/opensearch/integration.rb
@@ -16,6 +16,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :opensearch, auto_patch: true
+          def self.gem_name
+            'opensearch-ruby'
+          end
 
           def self.version
             Gem.loaded_specs['opensearch-ruby'] \

diff --git a/lib/datadog/tracing/contrib/presto/integration.rb b/lib/datadog/tracing/contrib/presto/integration.rb
@@ -16,6 +16,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :presto
+          def self.gem_name
+            'presto-client'
+          end
 
           def self.version
             Gem.loaded_specs['presto-client'] && Gem.loaded_specs['presto-client'].version

diff --git a/lib/datadog/tracing/contrib/rest_client/integration.rb b/lib/datadog/tracing/contrib/rest_client/integration.rb
@@ -16,6 +16,9 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :rest_client
+          def self.gem_name
+            'rest-client'
+          end
 
           def self.version
             Gem.loaded_specs['rest-client'] && Gem.loaded_specs['rest-client'].version