honeycomb-beeline 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0f7fd0a816bb7817900181d110a0f95d63b3191aeca362bbe0aadbc18609d7a
-  data.tar.gz: '0702890fe4606c12f68ee032578a8b6f896fcc17c454794f23b3f0705a762c5a'
+  metadata.gz: d99297b1c5e39a9a250cc298aac8282da89dc29247d2ea03567111f47001d14e
+  data.tar.gz: 78233609ea887df63e5890476e8bae8b62e904db968f429d22c8562eaa62204e
 SHA512:
-  metadata.gz: 96266118829b42c517e4a20e5d42b7d6bea65d8d5d65dd750c78d9825517070f7d1c15167c1dd6d5502be585c9621229369fa036e0c84fa8482cf109b91fcad7
-  data.tar.gz: 9a9ced838db3c0b5948555042b80a1876270e36de75c69b490c8bf55c9150b32c59aa7d2db6e61bd845d131aa83e644e8116f12f8d266957b628a3672f79de54
+  metadata.gz: 4745aa8377bcd8fc7665431754d5e8e7f6ec067c8cb157d6ea463b8270b46b1fd87206432e2b8b0a68cbd3465914479c31dd185d2888087173da26f0cfa276fc
+  data.tar.gz: 397aa8cd262415e7e1a83fb135b01e18d40a73f924a6526a7d4b5974cc9aef8e82a96906b0d6b8246cfcb45bcf474f5854f81c98766080cb29040736f3453f60

data/.circleci/bundler_version.sh

@@ -3,6 +3,10 @@
 set -ux
 
 if [[ "$BUNDLE_GEMFILE" =~ (rails_41.gemfile|rails_42.gemfile)$ ]]; then
+  echo "Rails 4.1 and 4.2 require an old Bundler"
   gem uninstall -v '>= 2' -ax bundler
   gem install bundler -v '< 2'
+else
+  echo "Get the latest Bundler"
+  gem update bundler
 fi

data/.circleci/config.yml

@@ -6,7 +6,6 @@ commands:
         type: string
       gemfile:
         type: string
-        default: Gemfile
       command:
         type: string
         default: bundle exec rake test
@@ -14,16 +13,19 @@ commands:
       - checkout
       - restore_cache:
           keys:
-            - gems-v1-<< parameters.ruby-version >>-{{ checksum "Gemfile.lock" }}
+            - gems-v1-<< parameters.ruby-version >>-<< parameters.gemfile >>-{{ checksum "Gemfile.lock" }}
+            - gems-v1-<< parameters.ruby-version >>-<< parameters.gemfile >>
             - gems-v1-<< parameters.ruby-version >>
-      - run: gem update bundler
-      - run: BUNDLE_GEMFILE=<< parameters.gemfile >> ./.circleci/bundler_version.sh
-      - run: BUNDLE_GEMFILE=<< parameters.gemfile >> bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - run: .circleci/bundler_version.sh
+      - run: bundle config set --local path $HOME/project/vendor/bundle
+      - run: bundle install --jobs=4 --retry=3
+      - run: bundle clean --force
+      - run: bundle env
       - save_cache:
           paths:
             - ./vendor/bundle
-          key: gems-v1-<< parameters.ruby-version >>-{{ checksum "Gemfile.lock" }}
-      - run: BUNDLE_GEMFILE=<< parameters.gemfile >> << parameters.command >>
+          key: gems-v1-<< parameters.ruby-version >>-<< parameters.gemfile >>-{{ checksum "Gemfile.lock" }}
+      - run: << parameters.command >>
 
 jobs:
   build_artifacts:
@@ -80,9 +82,12 @@ jobs:
         default: "2.6"
     docker:
         - image: circleci/ruby:<< parameters.ruby-version >>
+    environment:
+      BUNDLE_GEMFILE: ./Gemfile
     steps:
       - ruby:
           ruby-version: << parameters.ruby-version >>
+          gemfile: root
           command: bundle exec rake rubocop
   test:
     parameters:
@@ -92,11 +97,15 @@ jobs:
         type: string
     docker:
         - image: circleci/ruby:<< parameters.ruby-version >>
+    environment:
+      BUNDLE_GEMFILE: gemfiles/<< parameters.gemfile >>.gemfile
     steps:
       - ruby:
           ruby-version: << parameters.ruby-version >>
           gemfile: << parameters.gemfile >>
           command: bundle exec rake test
+      - store_test_results:
+          path: test/reports
 
 workflows:
   nightly:
@@ -110,49 +119,57 @@ workflows:
     jobs:
       - lint
       - test: &test
+          name: test-<< matrix.gemfile >>-ruby_<< matrix.ruby-version >>
           requires:
             - lint
           matrix:
             parameters:
               ruby-version: ["2.2", "2.3", "2.4", "2.5", "2.6", "2.7"]
               gemfile:
-                - gemfiles/aws_2.gemfile
-                - gemfiles/aws_3.gemfile
-                - gemfiles/faraday_0.gemfile
-                - gemfiles/faraday_1.gemfile
-                - gemfiles/sequel4.gemfile
-                - gemfiles/sequel5.gemfile
-                - gemfiles/sinatra.gemfile
-                - gemfiles/rack.gemfile
-                - gemfiles/rails_41.gemfile
-                - gemfiles/rails_42.gemfile
-                - gemfiles/rails_5.gemfile
-                - gemfiles/rails_51.gemfile
-                - gemfiles/rails_52.gemfile
-                - gemfiles/rails_6.gemfile
-                - gemfiles/redis_3.gemfile
-                - gemfiles/redis_4.gemfile
+                - aws_2
+                - aws_3
+                - faraday_0
+                - faraday_1
+                - sequel4
+                - sequel5
+                - sinatra
+                - rack
+                - rails_41
+                - rails_42
+                - rails_5
+                - rails_51
+                - rails_52
+                - rails_6
+                - rails_61
+                - redis_3
+                - redis_4
             exclude:
               - ruby-version: "2.2"
-                gemfile: gemfiles/faraday_1.gemfile
+                gemfile: faraday_1
               - ruby-version: "2.2"
-                gemfile: gemfiles/rails_52.gemfile
+                gemfile: rails_52
               - ruby-version: "2.2"
-                gemfile: gemfiles/rails_6.gemfile
+                gemfile: rails_6
               - ruby-version: "2.3"
-                gemfile: gemfiles/rails_6.gemfile
+                gemfile: rails_6
               - ruby-version: "2.4"
-                gemfile: gemfiles/rails_6.gemfile
+                gemfile: rails_6
+              - ruby-version: "2.2"
+                gemfile: rails_61
+              - ruby-version: "2.3"
+                gemfile: rails_61
+              - ruby-version: "2.4"
+                gemfile: rails_61
               - ruby-version: "2.4"
-                gemfile: gemfiles/rails_41.gemfile
+                gemfile: rails_41
               - ruby-version: "2.5"
-                gemfile: gemfiles/rails_41.gemfile
+                gemfile: rails_41
               - ruby-version: "2.6"
-                gemfile: gemfiles/rails_41.gemfile
+                gemfile: rails_41
               - ruby-version: "2.7"
-                gemfile: gemfiles/rails_41.gemfile
+                gemfile: rails_41
               - ruby-version: "2.7"
-                gemfile: gemfiles/rails_42.gemfile
+                gemfile: rails_42
   beeline:
     jobs:
       - lint:

data/.gitignore

@@ -5,6 +5,7 @@
 /doc/
 /pkg/
 /spec/reports/
+/test/reports/
 /tmp/
 .idea/
 

data/.rspec

@@ -1,3 +1,7 @@
+<% if ENV['CI'] %>
+--format RspecJunitFormatter
+--out test/reports/result.xml
+<% end %>
 --format documentation
 --color
 --require spec_helper

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # beeline-ruby changelog
 
+## 2.4.2 2021-06-25
+
+### Fixes
+
+- Update Rails middleware to get status code even on raised error. (#153) [@lirossarvet](https://github.com/lirossarvet)
+- Make Rails spec consistent with Honeycomb Railtie Initialization. (#154) [@robbkidd](https://github.com/robbkidd)
+- CI Improvements (#155) [@robbkidd](https://github.com/robbkidd)
+- Improve performance of Redis command serialization. (#146) [@ajvondrak](https://github.com/ajvondrak)
+
 ## 2.4.1 2021-06-01
 
 ### Fixes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    honeycomb-beeline (2.4.1)
+    honeycomb-beeline (2.4.2)
       libhoney (~> 1.14, >= 1.14.2)
 
 GEM
@@ -40,7 +40,7 @@ GEM
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       http-parser (~> 1.2.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.4)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
     http-parser (1.2.3)
@@ -81,6 +81,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (0.68.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -126,6 +128,7 @@ DEPENDENCIES
   pry-byebug (~> 3.6.0)
   rake
   rspec (~> 3.0)
+  rspec_junit_formatter
   rubocop (< 0.69)
   rubocop-performance (< 1.3.0)
   simplecov
@@ -133,4 +136,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.21

data/honeycomb-beeline.gemspec

@@ -48,6 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-byebug", "~> 3.6.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "rubocop", "< 0.69"
   spec.add_development_dependency "rubocop-performance", "< 1.3.0"
   spec.add_development_dependency "simplecov"

data/lib/honeycomb/beeline/version.rb

@@ -3,7 +3,7 @@
 module Honeycomb
   module Beeline
     NAME = "honeycomb-beeline".freeze
-    VERSION = "2.4.1".freeze
+    VERSION = "2.4.2".freeze
     USER_AGENT_SUFFIX = "#{NAME}/#{VERSION}".freeze
   end
 end

data/lib/honeycomb/integrations/rack.rb

@@ -48,11 +48,12 @@ module Honeycomb
         span.add_field("request.secure", req.ssl?)
         span.add_field("request.xhr", req.xhr?)
 
-        status, headers, body = app.call(env)
-
-        add_package_information(env, &add_field)
-
-        extract_user_information(env, &add_field)
+        begin
+          status, headers, body = call_with_hook(env, span, &add_field)
+        ensure
+          add_package_information(env, &add_field)
+          extract_user_information(env, &add_field)
+        end
 
         span.add_field("response.status_code", status)
         span.add_field("response.content_type", headers["Content-Type"])
@@ -72,6 +73,12 @@ module Honeycomb
       end
     end
 
+    private
+
+    def call_with_hook(env, _span, &_add_field)
+      app.call(env)
+    end
+
     # Rack middleware
     class Middleware
       include Rack

data/lib/honeycomb/integrations/rails.rb

@@ -89,6 +89,16 @@ module Honeycomb
       include Rack
       include Warden
       include Rails
+
+      def call_with_hook(env, span, &_add_field)
+        super
+      rescue StandardError => e
+        wrapped = ActionDispatch::ExceptionWrapper.new(nil, e)
+
+        span.add_field "response.status_code", wrapped.status_code
+
+        raise e
+      end
     end
   end
 end

data/lib/honeycomb/integrations/redis.rb

@@ -187,16 +187,6 @@ module Honeycomb
         args.map! { "[sanitized]" }
       end
 
-      def prettify(arg)
-        quotes = false
-        pretty = "".dup
-        arg.to_s.each_char do |c|
-          quotes ||= needs_quotes?(c)
-          pretty << escape(c)
-        end
-        quotes ? "\"#{pretty}\"" : pretty
-      end
-
       # This aims to replicate the algorithms used by redis-cli.
       #
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L940-L1067
@@ -204,54 +194,15 @@ module Honeycomb
       #
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L878-L907
       #   The redis-cli printing algorithm
-      def escape(char)
-        return escape_with_backslash(char) if escape_with_backslash?(char)
-        return escape_with_hex_codes(char) if escape_with_hex_codes?(char)
-
-        char
-      end
-
-      # A lookup table for backslash-escaped characters.
-      #
-      # This is used by {#escape_with_backslash?} and {#escape_with_backslash}
-      # to replicate the hard-coded `case` statements in redis-cli. As of this
-      # writing, Redis recognizes a handful of standard C escape sequences,
-      # like "\n" for newlines.
-      #
-      # Because {#prettify} will output double quoted strings if any escaping
-      # is needed, this table must additionally consider the double-quote to be
-      # a backslash-escaped character. For example, instead of generating
-      #
-      #   '"hello"'
-      #
-      # we'll generate
-      #
-      #   "\"hello\""
-      #
-      # even though redis-cli would technically recognize the single-quoted
-      # version.
-      #
-      # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L888-L896
-      #   The redis-cli algorithm for outputting standard escape sequences
-      BACKSLASHES = {
-        "\\" => "\\\\",
-        '"' => '\\"',
-        "\n" => "\\n",
-        "\r" => "\\r",
-        "\t" => "\\t",
-        "\a" => "\\a",
-        "\b" => "\\b",
-      }.freeze
-
-      def escape_with_backslash?(char)
-        BACKSLASHES.key?(char)
-      end
-
-      def escape_with_backslash(char)
-        BACKSLASHES.fetch(char, char)
+      def prettify(arg)
+        pretty = arg.to_s.dup
+        pretty.encode!("UTF-8", "binary", fallback: ->(c) { hex(c) })
+        pretty.gsub!(NEEDS_BACKSLASH, BACKSLASH)
+        pretty.gsub!(NEEDS_HEX) { |c| hex(c) }
+        pretty =~ NEEDS_QUOTES ? "\"#{pretty}\"" : pretty
       end
 
-      # Do we need to hex-encode this character?
+      # A regular expression matching characters that need to be hex-encoded.
       #
       # This replicates the C isprint() function that redis-cli uses to decide
       # whether to escape a character in hexadecimal notation, "\xhh". Any
@@ -287,18 +238,95 @@ module Honeycomb
       # escape it.
       #
       # What's more, Ruby's Regexp#=~ method will blow up if the string does
-      # not have a valid encoding (e.g., in UTF-8). In this case, though,
-      # {#escape_with_hex_codes} can still convert the bytes that make up the
-      # invalid character into a hex code. So we preemptively check for
-      # invalidly-encoded characters before testing the above match.
+      # not have a valid encoding (e.g., in UTF-8). We handle this case
+      # separately, though, using String#encode! with a :fallback option to
+      # hex-encode invalid UTF-8 byte sequences with {#hex}.
       #
       # @see https://ruby-doc.org/core-2.6.5/Regexp.html
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L878-L880
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L898-L901
       # @see https://www.justinweiss.com/articles/3-steps-to-fix-encoding-problems-in-ruby/
-      def escape_with_hex_codes?(char)
-        !char.valid_encoding? || char =~ /[^[:print:]&&[:ascii:]]/
-      end
+      NEEDS_HEX = /[^[:print:]&&[:ascii:]]/.freeze
+
+      # A regular expression for characters that need to be backslash-escaped.
+      #
+      # Any match of this regexp will be substituted according to the
+      # {BACKSLASH} table. This includes standard C escape sequences (newlines,
+      # tabs, etc) as well as a couple special considerations:
+      #
+      # 1. Because {#prettify} will output double quoted strings if any
+      #    escaping is needed, we must match double quotes (") so they'll be
+      #    replaced by escaped quotes (\").
+      #
+      # 2. Backslashes themselves get backslash-escaped, so \ becomes \\.
+      #    However, strings with invalid UTF-8 encoding will blow up when we
+      #    try to use String#gsub!, so {#prettify} must first use
+      #    String#encode! to scrub out invalid characters. It does this by
+      #    replacing invalid bytes with hex-encoded escape sequences using
+      #    {#hex}. This will insert sequences like \xhh, which contains a
+      #    backslash that we *don't* want to escape.
+      #
+      #    Unfortunately, this regexp can't really distinguish between
+      #    backslashes in the original input vs backslashes resulting from the
+      #    UTF-8 fallback. We make an effort by using a negative lookahead.
+      #    That way, only backslashes that *aren't* followed by x + hex digit +
+      #    hex digit will be escaped.
+      NEEDS_BACKSLASH = /["\n\r\t\a\b]|\\(?!x\h\h)/.freeze
+
+      # A lookup table for backslash-escaped characters.
+      #
+      # This is used by {#prettify} to replicate the hard-coded `case`
+      # statements in redis-cli. As of this writing, Redis recognizes a handful
+      # of standard C escape sequences, like "\n" for newlines.
+      #
+      # Because {#prettify} will output double quoted strings if any escaping
+      # is needed, this table must additionally consider the double-quote to be
+      # a backslash-escaped character. For example, instead of generating
+      #
+      #   '"hello"'
+      #
+      # we'll generate
+      #
+      #   "\"hello\""
+      #
+      # even though redis-cli would technically recognize the single-quoted
+      # version.
+      #
+      # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L888-L896
+      #   The redis-cli algorithm for outputting standard escape sequences
+      BACKSLASH = {
+        "\\" => "\\\\",
+        '"' => '\\"',
+        "\n" => "\\n",
+        "\r" => "\\r",
+        "\t" => "\\t",
+        "\a" => "\\a",
+        "\b" => "\\b",
+      }.freeze
+
+      # If the final escaped string needs quotes, it will match this regexp.
+      #
+      # The overall string returned by {#prettify} should only be quoted if at
+      # least one of the following holds:
+      #
+      # 1. The string contains an escape sequence, broadly demarcated by a
+      #    backslash. This includes standard escape sequences like "\n" and
+      #    "\t" as well as hex-encoded bytes using the "\x" escape sequence.
+      #    Since {#prettify} uses double quotes on its output string, we must
+      #    also force quotes if the string itself contains a literal
+      #    double quote. This double quote behavior is handled tacitly by the
+      #    {NEEDS_BACKSLASH} + {BACKSLASH} replacement.
+      #
+      # 2. The string contains a single quote. Since redis-cli recognizes
+      #    single-quoted strings, we want to wrap the {#prettify} output in
+      #    double quotes so that the literal single quote character isn't
+      #    mistaken as the delimiter of a new string.
+      #
+      # 3. The string contains any whitespace characters. If the {#prettify}
+      #    output weren't wrapped in quotes, whitespace would act as a
+      #    separator between arguments to the Redis command. To group things
+      #    together, we need to quote the string.
+      NEEDS_QUOTES = /[\\'\s]/.freeze
 
       # Hex-encodes a (presumably non-printable or non-ASCII) character.
       #
@@ -326,38 +354,9 @@ module Honeycomb
       # @see https://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap07.html
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L878-L880
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L898-L901
-      def escape_with_hex_codes(char)
+      def hex(char)
         char.bytes.map { |b| Kernel.format("\\x%02x", b) }.join
       end
-
-      def escape?(char)
-        escape_with_backslash?(char) || escape_with_hex_codes?(char)
-      end
-
-      # Should this character cause {#prettify} to wrap its output in quotes?
-      #
-      # The overall string returned by {#prettify} should only be quoted if at
-      # least one of the following holds:
-      #
-      # 1. The string contains a character that needs to be escaped. This
-      #    includes standard backslash escape sequences (like "\n" and "\t") as
-      #    well as hex-encoded bytes using the "\x" escape sequence. Since
-      #    {#prettify} uses double quotes on its output string, we must also
-      #    force quotes if the string itself contains a literal double quote.
-      #    This double quote behavior is handled tacitly by {BACKSLASHES}.
-      #
-      # 2. The string contains a single quote. Since redis-cli recognizes
-      #    single-quoted strings, we want to wrap the {#prettify} output in
-      #    double quotes so that the literal single quote character isn't
-      #    mistaken as the delimiter of a new string.
-      #
-      # 3. The string contains any whitespace characters. If the {#prettify}
-      #    output weren't wrapped in quotes, whitespace would act as a
-      #    separator between arguments to the Redis command. To group things
-      #    together, we need to quote the string.
-      def needs_quotes?(char)
-        escape?(char) || char == "'" || char =~ /\s/
-      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-beeline
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.2
 platform: ruby
 authors:
 - Martin Holman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -156,6 +156,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement