libhoney 1.14.0 → 1.14.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acad70fa5327549aaf1faca4fff6eeab79cdc72e7bab0cd3b6eb44fad49f2333
-  data.tar.gz: 15fb1bdfaa6770ebe836764217a24f7f4410a38096409b7c3c64b775b4116349
+  metadata.gz: 02c56fa15226ad661c0d1a4e3d2f461a7f0037f0b1b1abe536d88592e998974b
+  data.tar.gz: f2b08f84d02ada29ee8d546a7afb6c95a911e717ee3e799c7682715b018b13f1
 SHA512:
-  metadata.gz: e7a813d6e5b8a0f25f70f3e978a9b9a42e169f62d9b740829e784cf4f92c48531800fc93b69aa8f1aee4f6acebef0f648405db66418ca38e39c46042d02214d8
-  data.tar.gz: 4d764b9c4bfb0b244bb5bf97275730b77c5e70d7720bfeac2cac39ae5d2a858b9fe5ed935379a08ee77a827b29262f787c9fd8ad1ae5ae529efa20fa8a03626e
+  metadata.gz: b9d152b6ec888487e465e3e2dab280859104c73be09ff600983999896db866e050a0047348008042d1a08bda2d96921236d0720b44ba2a420662d4cd06bba7ff
+  data.tar.gz: a95954263471061d71ad2b367bb515561a124e9ae8bc25096343dc992897b414ffeaa5a8a5612da44e697ff38fb2cb5390f46dd1d184861c2926ec65fb978fb7

data/.circleci/config.yml

@@ -2,6 +2,13 @@ version: 2.0
 
 test_steps: &test_steps
   - checkout
+  - run:
+      name: Force Bundler Version
+      command: |
+        sudo gem update --system
+        echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+        source $BASH_ENV
+        gem install bundler
   - restore_cache:
       keys:
         - v1-dependencies-{{ checksum "Gemfile.lock" }}
@@ -45,10 +52,14 @@ jobs:
     docker:
       - image: circleci/ruby:2.6
     steps: *test_steps
+  ruby-2.7:
+    docker:
+      - image: circleci/ruby:2.7
+    steps: *test_steps
   publish:
     docker:
       # Just randomly pick one recent ruby version
-      - image: circleci/ruby:2.6
+      - image: circleci/ruby:2.7
     working_directory: ~/repo
     steps:
       - checkout
@@ -63,18 +74,34 @@ jobs:
 
 workflows:
   version: 2
+  nightly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - main
+    jobs:
+      - ruby-2.3: *tag_filters
+      - ruby-2.4: *tag_filters
+      - ruby-2.5: *tag_filters
+      - ruby-2.6: *tag_filters
+      - ruby-2.7: *tag_filters
   build:
     jobs:
       - ruby-2.3: *tag_filters
       - ruby-2.4: *tag_filters
       - ruby-2.5: *tag_filters
       - ruby-2.6: *tag_filters
+      - ruby-2.7: *tag_filters
       - publish:
           requires:
             - ruby-2.3
             - ruby-2.4
             - ruby-2.5
             - ruby-2.6
+            - ruby-2.7
           filters:
             tags:
               only: /^v.*/

data/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# Code owners file.
+# This file controls who is tagged for review for any given pull request.
+
+# For anything not explicitly taken by someone else:
+* @honeycombio/integrations-team @martin308

data/.rubocop.yml

@@ -19,7 +19,7 @@ Metrics/ClassLength:
     - test/*
 
 Metrics/MethodLength:
-  Max: 25
+  Max: 40
   Exclude:
     - lib/libhoney/transmission.rb
     - test/*

data/.rubocop_todo.yml

@@ -14,17 +14,17 @@ Lint/HandleExceptions:
 
 # Offense count: 7
 Metrics/AbcSize:
-  Max: 35
+  Max: 40
 
 # Offense count: 1
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 27
+  Max: 30
 
 # Offense count: 2
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Max: 12
 
 # Offense count: 2
 # Configuration parameters: CountKeywordArgs.
@@ -33,4 +33,4 @@ Metrics/ParameterLists:
 
 # Offense count: 1
 Metrics/PerceivedComplexity:
-  Max: 8
+  Max: 10

data/Gemfile.lock

@@ -1,42 +1,48 @@
 PATH
   remote: .
   specs:
-    libhoney (1.14.0)
+    libhoney (1.14.5)
       addressable (~> 2.0)
       http (>= 2.0, < 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    backports (3.15.0)
+    backports (3.16.0)
     bump (0.8.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    ffi (1.13.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
     hashdiff (1.0.0)
-    http (4.1.1)
+    http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
-      http_parser.rb (~> 0.6.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    http-form_data (2.1.1)
-    http_parser.rb (0.6.0)
-    jaro_winkler (1.5.3)
-    minitest (5.11.3)
-    multi_json (1.13.1)
-    mustermann (1.0.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    multi_json (1.14.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    parallel (1.19.1)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
-    public_suffix (3.1.1)
-    rack (2.0.7)
-    rack-protection (2.0.5)
+    public_suffix (4.0.3)
+    rack (2.1.4)
+    rack-protection (2.0.8.1)
       rack
     rainbow (3.0.0)
     rake (12.3.3)
@@ -48,30 +54,31 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
     safe_yaml (1.0.5)
-    sinatra (2.0.5)
+    sinatra (2.0.8.1)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.5)
+      rack-protection (= 2.0.8.1)
       tilt (~> 2.0)
-    sinatra-contrib (2.0.5)
+    sinatra-contrib (2.0.8.1)
       backports (>= 2.8.2)
       multi_json
       mustermann (~> 1.0)
-      rack-protection (= 2.0.5)
-      sinatra (= 2.0.5)
-      tilt (>= 1.3, < 3)
+      rack-protection (= 2.0.8.1)
+      sinatra (= 2.0.8.1)
+      tilt (~> 2.0)
     spy (1.0.0)
-    tilt (2.0.9)
+    tilt (2.0.10)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.7.7)
     unicode-display_width (1.5.0)
-    webmock (3.6.2)
+    webmock (3.8.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.20)
+    yard (0.9.24)
     yardstick (0.9.9)
       yard (~> 0.8, >= 0.8.7.2)
 
@@ -93,4 +100,4 @@ DEPENDENCIES
   yardstick (~> 0.9)
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/lib/libhoney/cleaner.rb

@@ -0,0 +1,62 @@
+module Libhoney
+  module Cleaner
+    ENCODING_OPTIONS = { invalid: :replace, undef: :replace }.freeze
+    RECURSION = '[RECURSION]'.freeze
+    RAISED = '[RAISED]'.freeze
+
+    # Cleans an object for converting to JSON. Checks for recursion,
+    # exceptions generated, and non UTF8 encoded strings.
+    # @param data the data to clean
+    # @param seen [Hash] used to check for recursion
+    # @return the cleaned object
+    def clean_data(data, seen = {})
+      return nil if data.nil?
+
+      # check for recursion here, by tracking all of the potentially nested
+      # objects that we have seen before.
+      protection =  case data
+                    when Hash, Array, Set
+                      # bail here if we have already seen this object
+                      return seen[data] if seen[data]
+
+                      seen[data] = RECURSION
+                    end
+
+      value = case data
+              when Hash
+                clean_hash = {}
+                data.each do |key, val|
+                  clean_hash[key] = clean_data(val, seen)
+                end
+                clean_hash
+              when Array, Set
+                data.map do |element|
+                  clean_data(element, seen)
+                end
+              when Numeric, TrueClass, FalseClass
+                data
+              when String
+                clean_string(data)
+              else
+                str = begin
+                        data.to_s
+                      rescue StandardError
+                        RAISED
+                      end
+                clean_string(str)
+              end
+
+      seen[data] = value if protection
+      value
+    end
+
+    # Converts a string to UTF8 encoding if required using the ENCODING_OPTIONS
+    # @param str [String] the string to convert
+    # @return [String] the UTF8 encoded string
+    def clean_string(str)
+      return str if str.encoding == Encoding::UTF_8 && str.valid_encoding?
+
+      str.encode(Encoding::UTF_8, **ENCODING_OPTIONS)
+    end
+  end
+end

data/lib/libhoney/event.rb

@@ -121,8 +121,6 @@ module Libhoney
     #
     # @return [self] this event.
     def send_presampled
-      raise ArgumentError, "No metrics added to event. Won't send empty event." if data.empty?
-
       @libhoney.send_event(self)
       self
     end

data/lib/libhoney/log_transmission.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'libhoney/cleaner'
 
 module Libhoney
   # For debugging use: a mock version of TransmissionClient that simply prints
@@ -9,6 +10,8 @@ module Libhoney
   #       to verify what events your instrumented code is sending. Use in
   #       production is not recommended.
   class LogTransmissionClient
+    include Cleaner
+
     def initialize(output:, verbose: false)
       @output  = output
       @verbose = verbose
@@ -21,7 +24,9 @@ module Libhoney
         metadata << " (sample rate: #{event.sample_rate})" if event.sample_rate != 1
         @output.print("#{metadata} | ")
       end
-      @output.puts(event.data.to_json)
+      clean_data(event.data).tap do |data|
+        @output.puts(data.to_json)
+      end
     end
 
     # Flushes the output (but does not close it)

data/lib/libhoney/transmission.rb

@@ -1,10 +1,13 @@
 require 'json'
 require 'timeout'
 require 'libhoney/response'
+require 'libhoney/cleaner'
 
 module Libhoney
   # @api private
   class TransmissionClient
+    include Cleaner
+
     def initialize(max_batch_size: 50,
                    send_frequency: 100,
                    max_concurrent_batches: 10,
@@ -37,10 +40,6 @@ module Libhoney
     end
 
     def add(event)
-      raise ArgumentError, "No APIHost for Honeycomb. Can't send to the Great Unknown." if event.api_host == ''
-      raise ArgumentError, "No WriteKey specified. Can't send event."                   if event.writekey == ''
-      raise ArgumentError, "No Dataset for Honeycomb. Can't send datasetless."          if event.dataset  == ''
-
       begin
         @batch_queue.enq(event, !@block_on_send)
       rescue ThreadError
@@ -63,6 +62,7 @@ module Libhoney
         begin
           http = http_clients[api_host]
           body = serialize_batch(batch)
+
           next if body.nil?
 
           headers = {
@@ -135,9 +135,11 @@ module Libhoney
 
       loop do
         begin
-          while (event = Timeout.timeout(@send_frequency) { @batch_queue.pop })
-            key = [event.api_host, event.writekey, event.dataset]
-            batched_events[key] << event
+          Thread.handle_interrupt(Timeout::Error => :on_blocking) do
+            while (event = Timeout.timeout(@send_frequency) { @batch_queue.pop })
+              key = [event.api_host, event.writekey, event.dataset]
+              batched_events[key] << event
+            end
           end
 
           break
@@ -179,11 +181,14 @@ module Libhoney
       payload = []
       batch.map! do |event|
         begin
+          data = clean_data(event.data)
+
           e = {
             time: event.timestamp.iso8601(3),
             samplerate: event.sample_rate,
-            data: event.data
+            data: data
           }
+
           payload << JSON.generate(e)
 
           event

data/lib/libhoney/version.rb

@@ -1,3 +1,3 @@
 module Libhoney
-  VERSION = '1.14.0'.freeze
+  VERSION = '1.14.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libhoney
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.14.5
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -206,6 +206,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".circleci/setup-rubygems.sh"
+- ".github/CODEOWNERS"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -219,6 +220,7 @@ files:
 - example/factorial.rb
 - lib/libhoney.rb
 - lib/libhoney/builder.rb
+- lib/libhoney/cleaner.rb
 - lib/libhoney/client.rb
 - lib/libhoney/event.rb
 - lib/libhoney/log_client.rb
@@ -250,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: send data to Honeycomb