bc-lightstep-ruby 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c51308f745da6f5f2054977944d4d833c1be333d084cf9b929c6160cc9bdd9e8
-  data.tar.gz: 7dacfc839a37d78d7088ef9d6a4eb24e412fc8742a40ccdfac67eb64aa54629a
+  metadata.gz: a5690f617aac90d828163b980e6315bcf21a5f4c2e81d46c660e275f8e51df20
+  data.tar.gz: a89ce02ec2b20b0d716e63f5ac3c3251a7c437063e91a8a4ab729c512108375d
 SHA512:
-  metadata.gz: 0b7451b70f574837c7758c32d2cef0c8a1d076931618524aa2e330c69a6bd4d520242a843432415bcba3987026c7c3ea65f0a3234075797864b6979b6512f777
-  data.tar.gz: 985b16c6abbe8513a829bd74d3928d42c252ea14719aadb964115aaa351e3c7d3c2e0457902c4f53cee1f4d634027ca3951fc3616b469a16a5beb6ea227f969c
+  metadata.gz: 4beeba6a2d87513ac111a48319988f8a8c46542eb326b1ad179fa87802eb8d9a90ee1694e1ff676a33490ce7e9a4a962bbd6e5066589d8eaf98c7ae03cd256e1
+  data.tar.gz: 8695c5d8d79085eba12d1e1796990ac88f755826369cdce32283205f01580515f06a0ab164b629eb27646039a0794d987be60cee76c4f08361b485a1e9f2089d

data/CHANGELOG.md

@@ -2,6 +2,20 @@ Changelog for the bc-lightstep-ruby gem.
 
 ### Pending Release
 
+### 2.6.0
+
+* Add support for Rails/ActiveRecord 7
+* Add test coverage for Ruby 3.2
+
+### 2.5.x
+
+* Drop support for Ruby 2
+* Remove unused NullLogger dev dependency
+
+### 2.4.1
+
+* Support positional argument methods when using the `Traceable` trace method
+
 ### 2.4.0
 
 * Add `::Bigcommerce::Lightstep::Traceable` module for tracing individual methods

data/README.md

@@ -114,7 +114,7 @@ class MyService
   include ::Bigcommerce::Lightstep::Traceable
 
   trace :call, 'operation.do-my-thing' do |span:, product:, options:|
-    span.set_tag('store_id', request.store_id)
+    span.set_tag('product_id', product.id)
   end
   # or, with no block:
   trace :call, 'operation.do-my-thing'
@@ -125,6 +125,45 @@ class MyService
 end
 ```
 
+#### Tracing Positional Argument Methods
+
+For positional argument methods, the behavior is a bit different. In your trace call, if tracing a method with
+positional arguments, you'll need to have the block arguments be positional as well:
+
+```ruby
+class MyService
+  include ::Bigcommerce::Lightstep::Traceable
+
+  trace :positional, 'operation.do-my-thing' do |span, product, options|
+    span.set_tag('product_id', product.id)
+  end
+  def positional(product, options = {})
+    # ...
+  end
+end
+```
+
+Note that any default values in the argument will not carry over into the trace block. Secondly, with positional
+argument methods that have only a _single_ hash argument, since this library has no way to detect in that case if it
+is keyword-arguments or a single hash argument, the library will simply add the `span` to the hash itself, and you'll
+need to adjust the trace block accordingly:
+
+```ruby
+
+class MyService
+  include ::Bigcommerce::Lightstep::Traceable
+
+  trace :positional_single_hash_arg, 'operation.do-my-thing' do |my_hash|
+    my_hash[:span].set_tag('product_id', my_hash[:product_id])
+  end
+  def positional_single_hash_arg(my_hash)
+    # ...
+  end
+end
+```
+
+It is recommended for this reason - and others - to never use single-hash positional arguments in Ruby.
+
 ## RSpec
 
 This library comes with a built-in matcher for testing span blocks. In your rspec config:

data/bc-lightstep-ruby.gemspec

@@ -31,22 +31,20 @@ Gem::Specification.new do |spec|
 
   spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'bc-lightstep-ruby.gemspec']
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.0'
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.add_development_dependency 'activerecord', '> 4'
   spec.add_development_dependency 'bundler-audit', '~> 0.6'
   spec.add_development_dependency 'rake', '>= 12.0'
-  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'redis', '~> 4'
+  spec.add_development_dependency 'rspec', '>= 3.8'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
-  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'rubocop', '>= 1.0'
   spec.add_development_dependency 'rubocop-performance', '>= 1.5'
   spec.add_development_dependency 'simplecov', '~> 0.15'
   spec.add_development_dependency 'pry', '>= 0.12'
 
-  spec.add_development_dependency 'null-logger', '~> 0.1'
-  spec.add_development_dependency 'redis', '~> 4'
-
   spec.add_runtime_dependency 'activesupport', '>= 4'
   spec.add_runtime_dependency 'lightstep', '~> 0.17.0'
   spec.add_runtime_dependency 'faraday', ['>= 0.8', '< 2']

data/lib/bigcommerce/lightstep/active_record/adapter.rb

@@ -36,12 +36,21 @@ module Bigcommerce
         end
 
         ##
-        # Note: we only support patching mysql2 gem at this point
+        # Note: we only support patching mysql2 gem at this point.
         #
         # @return [Boolean]
         #
         def self.enabled?
-          defined?(::ActiveRecord) && ::Bigcommerce::Lightstep.active_record && ::ActiveRecord::Base.connection_config[:adapter].to_s.casecmp('mysql2').zero?
+          return false unless defined?(::ActiveRecord) && ::Bigcommerce::Lightstep.active_record
+
+          adapter_name = if ::ActiveRecord::Base.respond_to?(:connection_config) # rails 6
+                           ::ActiveRecord::Base.connection_config[:adapter].to_s
+                         elsif ::ActiveRecord::Base.respond_to?(:connection_db_config) # rails 7
+                           ::ActiveRecord::Base.connection_db_config.configuration_hash[:adapter].to_s
+                         else
+                           'unknown'
+                         end
+          adapter_name.casecmp('mysql2')&.zero? == true
         rescue StandardError => e
           ::Bigcommerce::Lightstep.logger&.warn "Failed to determine ActiveRecord database adapter in bc-lightstep-ruby initializer: #{e.message}"
           false
@@ -51,9 +60,9 @@ module Bigcommerce
         # @param [String] sql The raw sql query
         # @param [String] name The type of sql query
         #
-        def execute_with_inst(sql, name = 'SQL')
+        def execute_with_inst(sql, name = 'SQL', async: false)
           # bail out early if not enabled. This should not get here, but is provided as a failsafe.
-          return execute_without_inst(sql, name) unless ::Bigcommerce::Lightstep.active_record
+          return execute_without_inst(sql, name, async: async) unless ::Bigcommerce::Lightstep.active_record
 
           sanitized_sql = lightstep_sanitize_sql(sql)
           name = 'QUERY' if name.to_s.strip.empty?

data/lib/bigcommerce/lightstep/traceable.rb

@@ -41,13 +41,22 @@ module Bigcommerce
         def trace(method_name, operation_name, tags: nil, &span_block)
           method_name = method_name.to_sym
           mod = Module.new
-          mod.define_method(method_name) do |args, &block|
+          mod.define_method(method_name) do |*args, &block|
             tracer = ::Bigcommerce::Lightstep::Tracer.instance
             tracer.start_span(operation_name) do |span|
               tags&.each { |k, v| span.set_tag(k.to_s, v) }
-              span_block&.send(:call, **args.merge(span: span))
               begin
-                super(**args, &block)
+                arg1 = args.first
+                # method has keyword argument signature (or single-hash positional argument)
+                if arg1.is_a?(Hash) && args.count == 1
+                  # add span as a kwarg
+                  span_block&.send(:call, **arg1.merge(span: span))
+                  super(**arg1, &block)
+                else
+                  # method has positional argument signature, so just add span to front
+                  span_block&.send(:call, *([span] + args))
+                  super(*args, &block)
+                end
               rescue StandardError => e
                 span.set_tag('error', true)
                 span.set_tag('error.message', e.message)

data/lib/bigcommerce/lightstep/version.rb

@@ -17,6 +17,6 @@
 #
 module Bigcommerce
   module Lightstep
-    VERSION = '2.4.0'
+    VERSION = '2.6.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -53,17 +53,31 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency
@@ -84,14 +98,14 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
@@ -136,34 +150,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: null-logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -269,14 +255,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Gem for lightstep distributed tracing