skylight 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66c646baeaeddece5a75140908f8c7d1aec447945903ff5681c1e4de58839e79
-  data.tar.gz: a3fe10a6b05963038f40f4b82d77cd545c42fa546d63cd440a21eb3839280b71
+  metadata.gz: 76c9ece1445d480897ecc306024fe939dacb94c14a02e68f7e33f5d722955284
+  data.tar.gz: 839b19ed8b3846003b3a54e5d0f3e327b0f969f2672b267dcaf4d1aa27df6254
 SHA512:
-  metadata.gz: ca6b42cfa51a39f1cccfc8f169a9bdc1560ec9774423c1ca335ec6fc26bd70d47f40c62d9e645ea626b00626e962a9ef3dbda49c693de0a56fef10bc04ab1d76
-  data.tar.gz: ccb18fe7cc713c03544db2a0d1dc5c42d86fe5ee14c0db11e208884203b7141cd39032bdb75f5c7eaf341b1ded6e9c761e8529e1bf50d1c499b1bab85a545fcd
+  metadata.gz: 2cbbcfd4a159b6abfa976f9d8ad4a87317973955d058408b681b1564d6d54bacadcb0e60c4bbac9ea03383dfed6d9355ac953a0b636c50a60ff99e52bcb3c5a2
+  data.tar.gz: b338f0d0a22d0b904600d050f217758d3b07c28e66c88c6f5eb961cd8701750b58a7175e3e9e31dad604c6c58c2d1b22197517c239192f41b9579c5c08a9ca5b

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 5.0.1 (March 11, 2021)
+* [IMPROVEMENT] Use argument-forwarding (...) where available in custom instrumentation
+
 ## 5.0.0 (March 5, 2021)
 
 * [FEATURE] Add normalizer for Shrine events (thanks @janko!)

data/lib/skylight/helpers.rb

@@ -130,7 +130,7 @@ module Skylight
 
       private
 
-        HAS_KW_ARGUMENT_FORWARDING = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7.0")
+        HAS_ARGUMENT_FORWARDING = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7.0")
 
         def __sk_instrument_method_on(klass, name, title, **opts)
           category = (opts[:category] || "app.method").to_s
@@ -145,13 +145,31 @@ module Skylight
           # source_file and source_line to be removed from the trace span before it is submitted.
           source_file, source_line = klass.instance_method(name).source_location
 
+          # We should strongly prefer using the new argument-forwarding syntax (...) where available.
+          # In Ruby 2.7, the following are known to be syntax errors:
+          #
+          # - mixing positional arguments with argument forwarding (e.g., send(:method_name, ...))
+          # - calling a setter method with multiple arguments, unless dispatched via send or public_send.
+          #
+          # So it is possible, though not recommended, to define setter methods that take multiple arguments,
+          # keywords, and/or blocks. Unfortunately, this means that for setters, we still need to explicitly
+          # forward the different argument types.
+          is_setter_method = name.to_s.end_with?("=")
+
           arg_string =
-            if HAS_KW_ARGUMENT_FORWARDING
-              "*args, **kwargs, &blk"
+            if HAS_ARGUMENT_FORWARDING
+              is_setter_method ? "*args, **kwargs, &blk" : "..."
             else
               "*args, &blk"
             end
 
+          original_method_dispatch =
+            if is_setter_method
+              "self.send(:before_instrument_#{name}, #{arg_string})"
+            else
+              "before_instrument_#{name}(#{arg_string})"
+            end
+
           klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
             alias_method :"before_instrument_#{name}", :"#{name}"       # alias_method :"before_instrument_process", :"process"
             def #{name}(#{arg_string})                                  # def process(*args, **kwargs, &blk)
@@ -165,7 +183,7 @@ module Skylight
               meta = {}                                                 #   meta = {}
                                                                         #
               begin                                                     #   begin
-                send(:before_instrument_#{name}, #{arg_string})         #     send(:before_instrument_process, *args, **kwargs, &blk)
+                #{original_method_dispatch}                             #     self.before_instrument_process(...)
               rescue Exception => e                                     #   rescue Exception => e
                 meta[:exception_object] = e                             #     meta[:exception_object] = e
                 raise e                                                 #     raise e

data/lib/skylight/version.rb

@@ -3,5 +3,5 @@ module Skylight
   # for compatibility with semver when it is parsed by the rust agent.
   # This string will be transformed in the gemspec to "5.0.0.alpha"
   # to conform with rubygems.
-  VERSION = "5.0.0".freeze
+  VERSION = "5.0.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport