bc-lightstep-ruby 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c51308f745da6f5f2054977944d4d833c1be333d084cf9b929c6160cc9bdd9e8
-  data.tar.gz: 7dacfc839a37d78d7088ef9d6a4eb24e412fc8742a40ccdfac67eb64aa54629a
+  metadata.gz: dea96b1f8199a7f6f69a07e76849d5d1fffaa6a2875abb428766cd34717e230b
+  data.tar.gz: e3f42dcd9d466d5cb20b3aefe7d0a63fb18fc4e9004d534214e1cc8a67533454
 SHA512:
-  metadata.gz: 0b7451b70f574837c7758c32d2cef0c8a1d076931618524aa2e330c69a6bd4d520242a843432415bcba3987026c7c3ea65f0a3234075797864b6979b6512f777
-  data.tar.gz: 985b16c6abbe8513a829bd74d3928d42c252ea14719aadb964115aaa351e3c7d3c2e0457902c4f53cee1f4d634027ca3951fc3616b469a16a5beb6ea227f969c
+  metadata.gz: c6a1267f116201b2f1f40d115c0fec8cd38b5b9b954a364bb21f73aa5651b1eee1734e1a00fd3543d6b933b7a90206f1f88e90786dd60c15c1e2862e4edd8d0b
+  data.tar.gz: dc9124a5acfa9872af9fa5208fc858dee5041737e8c9c8c898ea618363f8f23c74d6507ffe17421fb9327734f687c2403136b30bc2afad7fccefca8b57f6e517

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Changelog for the bc-lightstep-ruby gem.
 
 ### Pending Release
 
+### 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/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.4.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Shaun McCormick