atatus 1.6.2 → 2.0.0

data/lib/atatus/spies/sqs.rb

@@ -0,0 +1,231 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module Atatus
+  # @api private
+  module Spies
+    # @api private
+    class SQSSpy
+      TYPE = 'messaging'
+      SUBTYPE = 'sqs'
+
+      REGION_REGEXP = %r{https://sqs\.([a-z0-9-]+)\.amazonaws}
+
+      def self.without_net_http
+        return yield unless defined?(NetHTTPSpy)
+
+        # rubocop:disable Style/ExplicitBlockArgument
+        Atatus::Spies::NetHTTPSpy.disable_in do
+          yield
+        end
+        # rubocop:enable Style/ExplicitBlockArgument
+      end
+
+      def self.queue_name(params)
+        if params[:queue_url]
+          params[:queue_url].split('/')[-1]
+        end
+      end
+
+      def self.region_from_url(url)
+        if match = REGION_REGEXP.match(url)
+          match[1]
+        end
+      end
+
+      def self.span_context(queue_name, region)
+        Atatus::Span::Context.new(
+          message: { queue_name: queue_name },
+          destination: {
+            service: { resource: "#{SUBTYPE}/#{queue_name}" },
+            cloud: { region: region }
+          }
+          # span links added here?
+        )
+      end
+
+      # @api private
+      module Ext
+        def self.prepended(mod)
+          def send_message(params = {}, options = {})
+            unless (transaction = Atatus.current_transaction)
+              return super(params, options)
+            end
+
+            queue_name = Atatus::Spies::SQSSpy.queue_name(params)
+            span_name = queue_name ? "SQS SEND to #{queue_name}" : 'SQS SEND'
+            region = Atatus::Spies::SQSSpy.region_from_url(params[:queue_url])
+            context = Atatus::Spies::SQSSpy.span_context(
+              queue_name,
+              region || config.region
+            )
+
+            Atatus.with_span(
+              span_name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: 'send',
+              context: context
+            ) do |span|
+              trace_context = span&.trace_context || transaction.trace_context
+              trace_context.apply_headers do |key, value|
+                params[:message_attributes] ||= {}
+                params[:message_attributes][key] ||= {}
+                params[:message_attributes][key][:string_value] = value
+                params[:message_attributes][key][:data_type] = 'String'
+              end
+
+              Atatus::Spies::SQSSpy.without_net_http do
+                super(params, options)
+              end
+            end
+          end
+
+          def send_message_batch(params = {}, options = {})
+            unless (transaction = Atatus.current_transaction)
+              return super(params, options)
+            end
+
+            queue_name = Atatus::Spies::SQSSpy.queue_name(params)
+            span_name =
+              queue_name ? "SQS SEND_BATCH to #{queue_name}" : 'SQS SEND_BATCH'
+            region = Atatus::Spies::SQSSpy.region_from_url(params[:queue_url])
+            context = Atatus::Spies::SQSSpy.span_context(
+              queue_name,
+              region || config.region
+            )
+
+            Atatus.with_span(
+              span_name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: 'send_batch',
+              context: context
+            ) do |span|
+              trace_context = span&.trace_context || transaction.trace_context
+
+              trace_context.apply_headers do |key, value|
+                params[:entries].each do |message|
+                  message[:message_attributes] ||= {}
+                  message[:message_attributes][key] ||= {}
+                  message[:message_attributes][key][:string_value] = value
+                  message[:message_attributes][key][:data_type] = 'String'
+                end
+              end
+
+              Atatus::Spies::SQSSpy.without_net_http do
+                super(params, options)
+              end
+            end
+          end
+
+          def receive_message(params = {}, options = {})
+            unless Atatus.current_transaction
+              return super(params, options)
+            end
+
+            queue_name = Atatus::Spies::SQSSpy.queue_name(params)
+            span_name =
+              queue_name ? "SQS RECEIVE from #{queue_name}" : 'SQS RECEIVE'
+            region = Atatus::Spies::SQSSpy.region_from_url(params[:queue_url])
+            context = Atatus::Spies::SQSSpy.span_context(
+              queue_name,
+              region || config.region
+            )
+
+            Atatus.with_span(
+              span_name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: 'receive',
+              context: context
+            ) do
+              Atatus::Spies::SQSSpy.without_net_http do
+                super(params, options)
+              end
+            end
+          end
+
+          def delete_message(params = {}, options = {})
+            unless Atatus.current_transaction
+              return super(params, options)
+            end
+
+            queue_name = Atatus::Spies::SQSSpy.queue_name(params)
+            span_name = queue_name ? "SQS DELETE from #{queue_name}" : 'SQS DELETE'
+            region = Atatus::Spies::SQSSpy.region_from_url(params[:queue_url])
+            context = Atatus::Spies::SQSSpy.span_context(
+              queue_name,
+              region || config.region
+            )
+
+            Atatus.with_span(
+              span_name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: 'delete',
+              context: context
+            ) do
+              Atatus::Spies::SQSSpy.without_net_http do
+                super(params, options)
+              end
+            end
+          end
+
+          def delete_message_batch(params = {}, options = {})
+            unless Atatus.current_transaction
+              return super(params, options)
+            end
+
+            queue_name = Atatus::Spies::SQSSpy.queue_name(params)
+            span_name =
+              queue_name ? "SQS DELETE_BATCH from #{queue_name}" : 'SQS DELETE_BATCH'
+            region = Atatus::Spies::SQSSpy.region_from_url(params[:queue_url])
+            context = Atatus::Spies::SQSSpy.span_context(
+              queue_name,
+              region || config.region
+            )
+
+            Atatus.with_span(
+              span_name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: 'delete_batch',
+              context: context
+            ) do
+              Atatus::Spies::SQSSpy.without_net_http do
+                super(params, options)
+              end
+            end
+          end
+        end
+      end
+
+      def install
+        ::Aws::SQS::Client.prepend(Ext)
+      end
+    end
+
+    register(
+      'Aws::SQS::Client',
+      'aws-sdk-sqs',
+      SQSSpy.new
+    )
+  end
+end

data/lib/atatus/spies/sucker_punch.rb

@@ -25,30 +25,28 @@ module Atatus
       TYPE = 'sucker_punch'
 
       def install
-        if defined?(::SuckerPunch) && defined?(::SuckerPunch::Job) && defined?(::SuckerPunch::Job::ClassMethods)
+        ::SuckerPunch::Job::ClassMethods.class_eval do
+          alias :__run_perform_without_atatus :__run_perform
 
-          ::SuckerPunch::Job::ClassMethods.class_eval do
-            alias :__run_perform_without_atatus :__run_perform
-
-            def __run_perform(*args)
-              # This method is reached via JobClass#async_perform
-              # or JobClass#perform_in.
-              name = to_s
-              transaction = Atatus.start_transaction(name, TYPE)
-              __run_perform_without_atatus(*args)
-              transaction.done 'success'
-            rescue ::Exception => e
-              # Note that SuckerPunch by default doesn't raise the errors from
-              # the user-defined JobClass#perform method as it uses an error
-              # handler, accessed via `SuckerPunch.exception_handler`.
-              Atatus.report(e, handled: false)
-              transaction.done 'error'
-              raise
-            ensure
-              Atatus.end_transaction
-            end
+          def __run_perform(*args)
+            # This method is reached via JobClass#async_perform
+            # or JobClass#perform_in.
+            name = to_s
+            transaction = Atatus.start_transaction(name, TYPE)
+            __run_perform_without_atatus(*args)
+            transaction.done 'success'
+            transaction&.outcome = Transaction::Outcome::SUCCESS
+          rescue ::Exception => e
+            # Note that SuckerPunch by default doesn't raise the errors from
+            # the user-defined JobClass#perform method as it uses an error
+            # handler, accessed via `SuckerPunch.exception_handler`.
+            Atatus.report(e, handled: false)
+            transaction.done 'error'
+            transaction&.outcome = Transaction::Outcome::FAILURE
+            raise
+          ensure
+            Atatus.end_transaction
           end
-
         end
       end
     end

data/lib/atatus/spies/tilt.rb

@@ -24,23 +24,20 @@ module Atatus
     class TiltSpy
       TYPE = 'template.tilt'
 
-      def install
-        if defined?(::Tilt) && defined?(::Tilt::Template)
-
-          ::Tilt::Template.class_eval do
-            alias render_without_apm render
+      # @api private
+      module Ext
+        def render(*args, &block)
+          name = options[:__atatus_template_name] || 'Unknown template'
 
-            def render(*args, &block)
-              name = options[:__atatus_template_name] || 'Unknown template'
-
-              Atatus.with_span name, TYPE do
-                render_without_apm(*args, &block)
-              end
-            end
+          Atatus.with_span name, TYPE do
+            super(*args, &block)
           end
-
         end
       end
+
+      def install
+        ::Tilt::Template.prepend(Ext)
+      end
     end
 
     register 'Tilt::Template', 'tilt/template', TiltSpy.new

data/lib/atatus/spies.rb

@@ -56,6 +56,26 @@ module Atatus
       end
     end
 
+    def self.without_faraday
+      return yield unless defined?(FaradaySpy)
+
+      # rubocop:disable Style/ExplicitBlockArgument
+      Atatus::Spies::FaradaySpy.disable_in do
+        yield
+      end
+      # rubocop:enable Style/ExplicitBlockArgument
+    end
+
+    def self.without_net_http
+      return yield unless defined?(NetHTTPSpy)
+
+      # rubocop:disable Style/ExplicitBlockArgument
+      Atatus::Spies::NetHTTPSpy.disable_in do
+        yield
+      end
+      # rubocop:enable Style/ExplicitBlockArgument
+    end
+
     def self.register_require_hook(registration)
       registration.require_paths.each do |path|
         require_hooks[path] = registration

data/lib/atatus/sql/signature.rb

@@ -36,8 +36,8 @@ module Atatus
       end
 
       def initialize(sql)
-        @sql = sql
-        @tokenizer = Tokenizer.new(sql)
+        @sql = sql.encode('utf-8', invalid: :replace, undef: :replace)
+        @tokenizer = Tokenizer.new(@sql)
       end
 
       def parse
@@ -158,9 +158,11 @@ module Atatus
       def scan_dotted_identifier
         table = @tokenizer.text
 
+        # rubocop:disable Style/WhileUntilModifier
         while scan_token(PERIOD) && scan_token(IDENT)
           table += ".#{@tokenizer.text}"
         end
+        # rubocop:enable Style/WhileUntilModifier
 
         table
       end

data/lib/atatus/sql/tokenizer.rb

@@ -69,7 +69,7 @@ module Atatus
         when '['   then scan_quoted_indentifier(']')
         when '('   then LPAREN
         when ')'   then RPAREN
-        when '/'   then scan_bracketed_comment
+        when '/'   then scan_bracketed_or_cql_comment
         when '-'   then scan_simple_comment
         when "'"   then scan_string_literal
         when ALPHA then scan_keyword_or_identifier(possible_keyword: true)
@@ -110,7 +110,7 @@ module Atatus
             next next_char
           end
 
-          next next_char if peek =~ ALPHA
+          next next_char if ALPHA.match?(peek)
 
           break
         end
@@ -130,7 +130,7 @@ module Atatus
       end
       # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/CyclomaticComplexity
       def scan_dollar_sign
         while (peek = peek_char)
           case peek
@@ -165,7 +165,7 @@ module Atatus
 
         OTHER
       end
-      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       def scan_quoted_indentifier(delimiter)
         while (char = next_char)
@@ -185,10 +185,16 @@ module Atatus
         IDENT
       end
 
+      def scan_bracketed_or_cql_comment
+        case peek_char
+        when '*' then scan_bracketed_comment
+        when '/' then scan_cql_comment
+        else OTHER
+        end
+      end
+
       # rubocop:disable Metrics/CyclomaticComplexity
       def scan_bracketed_comment
-        return OTHER unless peek_char == '*'
-
         nesting = 1
 
         while (char = next_char)
@@ -207,6 +213,16 @@ module Atatus
       end
       # rubocop:enable Metrics/CyclomaticComplexity
 
+      def scan_cql_comment
+        return OTHER unless peek_char == '/'
+
+        while (char = next_char)
+          break if char == "\n"
+        end
+
+        COMMENT
+      end
+
       def scan_simple_comment
         return OTHER unless peek_char == '-'
 
@@ -251,7 +267,7 @@ module Atatus
           when 'e', 'E'
             return NUMBER if exponent
             next_char
-            next_char if peek_char =~ /[+-]/
+            next_char if /[+-]/.match?(peek_char)
           else break
           end
         end

data/lib/atatus/stacktrace/frame.rb

@@ -38,6 +38,7 @@ module Atatus
         :module,
         :colno
       )
+
       def build_context(context_line_count)
         return unless abs_path && context_line_count > 0
 

data/lib/atatus/stacktrace_builder.rb

@@ -23,7 +23,7 @@ require 'atatus/util/lru_cache'
 module Atatus
   # @api private
   class StacktraceBuilder
-    JAVA_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/.freeze
+    JAVA_FORMAT = /^(.+)\.([^.]+)\(([^:]+):(\d+)\)$/.freeze
     RUBY_FORMAT = /^(.+?):(\d+)(?::in `(.+?)')?$/.freeze
 
     RUBY_VERS_REGEX = %r{ruby(/gems)?[-/](\d+\.)+\d}.freeze
@@ -38,7 +38,9 @@ module Atatus
 
     def initialize(config)
       @config = config
-      @cache = Util::LruCache.new(2048, &method(:build_frame))
+      @cache = Util::LruCache.new(2048) do |cache, frame|
+        build_frame(cache, frame)
+      end
     end
 
     attr_reader :config
@@ -59,7 +61,7 @@ module Atatus
 
       frame = Stacktrace::Frame.new
       frame.abs_path = abs_path
-      frame.filename = strip_load_path(config, abs_path)
+      frame.filename = strip_load_path(abs_path)
       frame.function = function
       frame.lineno = lineno.to_i
       frame.library_frame = library_frame?(config, abs_path)
@@ -86,14 +88,13 @@ module Atatus
       [file, number, method, module_name]
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def library_frame?(config, abs_path)
       return false unless abs_path
 
       return true if abs_path.start_with?(GEMS_PATH)
 
       if abs_path.start_with?(config.__root_path)
-        return true if abs_path.start_with?(config.__root_path + '/vendor')
+        return true if abs_path.start_with?("#{config.__root_path}/vendor")
         return false
       end
 
@@ -102,20 +103,15 @@ module Atatus
 
       false
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
-    def strip_load_path(config, path)
+    def strip_load_path(path)
       return nil if path.nil?
 
-      if path.start_with?(config.__root_path)
-        prefix = config.__root_path
-      else
-        prefix =
-          $LOAD_PATH
-          .map(&:to_s)
-          .select { |s| path.start_with?(s) }
-          .max_by(&:length)
-      end
+      prefix =
+        $LOAD_PATH
+        .map(&:to_s)
+        .select { |s| path.start_with?(s) }
+        .max_by(&:length)
 
       prefix ? path[prefix.chomp(File::SEPARATOR).length + 1..-1] : path
     end

data/lib/atatus/subscriber.rb

@@ -45,6 +45,7 @@ module Atatus
     # AS::Notifications API
 
     Notification = Struct.new(:id, :span)
+
     def start(name, id, payload)
       return unless (transaction = @agent.current_transaction)
 

data/lib/atatus/trace_context/traceparent.rb

@@ -22,27 +22,24 @@ module Atatus
     # @api private
     class Traceparent
       VERSION = '00'
-      HEX_REGEX = /[^[:xdigit:]]/.freeze
+      NON_HEX_REGEX = /[^[:xdigit:]]/.freeze
 
       TRACE_ID_LENGTH = 16
       ID_LENGTH = 8
 
-      # rubocop:disable Metrics/ParameterLists
       def initialize(
         version: VERSION,
         trace_id: nil,
-        span_id: nil,
+        parent_id: nil,
         id: nil,
         recorded: true
       )
         @version = version
         @trace_id = trace_id || hex(TRACE_ID_LENGTH)
-        # TODO: rename span_id kw arg to parent_id with next major version bump
-        @parent_id = span_id
+        @parent_id = parent_id
         @id = id || hex(ID_LENGTH)
         @recorded = recorded
       end
-      # rubocop:enable Metrics/ParameterLists
 
       attr_accessor :version, :id, :trace_id, :parent_id, :recorded
 
@@ -58,8 +55,8 @@ module Atatus
               values[-1] = Util.hex_to_bits(values[-1])
             end
 
-          raise_invalid(header) if HEX_REGEX =~ t.trace_id
-          raise_invalid(header) if HEX_REGEX =~ t.parent_id
+          raise_invalid(header) if NON_HEX_REGEX.match?(t.trace_id)
+          raise_invalid(header) if NON_HEX_REGEX.match?(t.parent_id)
         end
       end
 

data/lib/atatus/trace_context/tracestate.rb

@@ -17,6 +17,8 @@
 
 # frozen_string_literal: true
 
+require 'atatus/util/precision_validator'
+
 module Atatus
   class TraceContext
     # @api private
@@ -35,12 +37,13 @@ module Atatus
         end
       end
 
+      # @api private
       class EsEntry
         ASSIGN = ':'
         SPLIT = ';'
 
-        SHORT_TO_LONG = { 's' => 'sample_rate' }
-        LONG_TO_SHORT = { 'sample_rate' => 's' }
+        SHORT_TO_LONG = { 's' => 'sample_rate' }.freeze
+        LONG_TO_SHORT = { 'sample_rate' => 's' }.freeze
 
         def initialize(values = nil)
           parse(values)
@@ -63,13 +66,9 @@ module Atatus
         end
 
         def sample_rate=(val)
-          float = Float(val).round(3)
-
-          return nil unless (0.0..1.0).include?(float)
-
-          @sample_rate = float
-        rescue ArgumentError => e
-          nil
+          @sample_rate = Util::PrecisionValidator.validate(
+            val, precision: 4, minimum: 0.0001
+          )
         end
 
         def to_s
@@ -85,7 +84,7 @@ module Atatus
 
           values.split(SPLIT).map do |kv|
             k, v = kv.split(ASSIGN)
-            next unless SHORT_TO_LONG.keys.include?(k)
+            next unless SHORT_TO_LONG.key?(k)
             send("#{SHORT_TO_LONG[k]}=", v)
           end
         end
@@ -93,6 +92,8 @@ module Atatus
 
       extend Forwardable
 
+      ENTRY_SPLIT_REGEX = /\s*[\n,]+\s*/
+
       def initialize(entries: {}, sample_rate: nil)
         @entries = entries
 
@@ -108,7 +109,7 @@ module Atatus
           split_by_nl_and_comma(header)
           .each_with_object({}) do |entry, hsh|
             k, v = entry.split('=')
-
+            next unless k && v && !k.empty? && !v.empty?
             hsh[k] =
               case k
               when 'es' then EsEntry.new(v)
@@ -138,9 +139,10 @@ module Atatus
         def split_by_nl_and_comma(str)
           # HTTP allows multiple headers with the same name, eg. multiple
           # Set-Cookie headers per response.
-          # Rack handles this by joining the headers under the same key, separated
-          # by newlines, see https://www.rubydoc.info/github/rack/rack/file/SPEC
-          String(str).split("\n").map { |s| s.split(',') }.flatten
+          # Rack handles this by joining the headers under the same key,
+          # separated by newlines.
+          # See https://www.rubydoc.info/github/rack/rack/file/SPEC
+          String(str).split(ENTRY_SPLIT_REGEX).flatten
         end
       end
     end