analytics-ruby 2.2.5 → 2.2.6.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f217e8929c1705f8602e90bdd0f23b2e77fdb97aa57c530e7ae325005a640258
-  data.tar.gz: 2a5674bf8575c46c472622cd2c2974a0f110215edb76dbce90126f1e62b43a99
+  metadata.gz: 16a399d60ac370a68cbb28f5887da70711403133e683d7acfe5db4b6eb8fb78d
+  data.tar.gz: 02c96de2188fb9b79b4d567c36a61ddf2ce0b62610adb6848a777ad327e47535
 SHA512:
-  metadata.gz: 5a118f808ca6a2fb9235ac9464665b618213e0e8ff372e001d4243da059e8cd4b5c2f8fbbac0c1eb8590f637c2d6594d5a5624183f11ba54355dc52769e8177c
-  data.tar.gz: 1ab60c691e8422bb33b7e14b1803cab36e457056871c366dabc1143289fede5e174c812dbca492176189f79a33419b1d2d3ea90ea61f827bd0e7248bef61cc95
+  metadata.gz: 69d989c8e9483dea80c707ddd4ca456d0d7891cd8b5624056a2131bd006dca153b00e46a22c582e26b0ad94978bd6beca4036a13b9921b1511b4d3ffb76b1339
+  data.tar.gz: 2c9a86a62efe64cbe7baea4faa9b605e32394b207eac8bd277bf1b3ca420aea6f9e34c7da4d476996f38907d1ca7a0d9e4d3abf2bd5088bd397d94a1db6641cc

data/History.md

@@ -1,3 +1,15 @@
+2.2.6.pre / 2018-06-27
+==================
+
+  * [Fix](https://github.com/segmentio/analytics-ruby/pull/168): Revert 'reuse
+    TCP connections' to fix EMFILE errors
+  * [Fix](https://github.com/segmentio/analytics-ruby/pull/166): Fix oj/rails
+    conflict
+  * [Fix](https://github.com/segmentio/analytics-ruby/pull/162): Add missing
+    'Forwardable' requirement
+  * [Improvement](https://github.com/segmentio/analytics-ruby/pull/163): Better
+    logging
+
 2.2.5 / 2018-05-01
 ==================
 

data/Rakefile

@@ -3,12 +3,22 @@ require 'rspec/core/rake_task'
 default_tasks = []
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+  spec.pattern = 'spec/segment/**/*_spec.rb'
   spec.rspec_opts = "--tag ~e2e" if ENV["RUN_E2E_TESTS"] != "true"
 end
 
 default_tasks << :spec
 
+# Isolated tests are run as separate rake tasks so that gem conflicts can be
+# tests in different processes
+Dir.glob('spec/isolated/**/*.rb').each do |isolated_test_path|
+  RSpec::Core::RakeTask.new(isolated_test_path) do |spec|
+    spec.pattern = isolated_test_path
+  end
+
+  default_tasks << isolated_test_path
+end
+
 # Rubocop doesn't support < 2.1
 if RUBY_VERSION >= "2.1"
   require 'rubocop/rake_task'

data/analytics-ruby.gemspec

@@ -25,6 +25,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'faraday', '~> 0.13'
   spec.add_development_dependency 'pmap', '~> 1.1'
 
+  if RUBY_VERSION >= '2.0' && RUBY_PLATFORM != 'java'
+    spec.add_development_dependency 'oj', '~> 3.6.2'
+  end
+
   if RUBY_VERSION >= "2.1"
     spec.add_development_dependency 'rubocop', '~> 0.51.0'
   end

data/lib/segment/analytics/logging.rb

@@ -2,16 +2,43 @@ require 'logger'
 
 module Segment
   class Analytics
+    # Wraps an existing logger and adds a prefix to all messages
+    class PrefixedLogger
+      def initialize(logger, prefix)
+        @logger = logger
+        @prefix = prefix
+      end
+
+      def debug(msg)
+        @logger.debug("#{@prefix} #{msg}")
+      end
+
+      def info(msg)
+        @logger.info("#{@prefix} #{msg}")
+      end
+
+      def warn(msg)
+        @logger.warn("#{@prefix} #{msg}")
+      end
+
+      def error(msg)
+        @logger.error("#{@prefix} #{msg}")
+      end
+    end
+
     module Logging
       class << self
         def logger
-          @logger ||= if defined?(Rails)
-                        Rails.logger
-                      else
-                        logger = Logger.new STDOUT
-                        logger.progname = 'Segment::Analytics'
-                        logger
-                      end
+          return @logger if @logger
+
+          base_logger = if defined?(Rails)
+                          Rails.logger
+                        else
+                          logger = Logger.new STDOUT
+                          logger.progname = 'Segment::Analytics'
+                          logger
+                        end
+          @logger = PrefixedLogger.new(base_logger, '[analytics-ruby]')
         end
 
         attr_writer :logger

data/lib/segment/analytics/message_batch.rb

@@ -1,3 +1,4 @@
+require 'forwardable'
 require 'segment/analytics/logging'
 
 module Segment
@@ -15,11 +16,13 @@ module Segment
       end
 
       def <<(message)
-        if message.too_big?
+        message_json_size = message.to_json.bytesize
+
+        if message_too_big?(message_json_size)
           logger.error('a message exceeded the maximum allowed size')
         else
           @messages << message
-          @json_size += message.json_size + 1 # One byte for the comma
+          @json_size += message_json_size + 1 # One byte for the comma
         end
       end
 
@@ -42,6 +45,10 @@ module Segment
         @messages.length >= @max_message_count
       end
 
+      def message_too_big?(message_json_size)
+        message_json_size > Defaults::Message::MAX_BYTES
+      end
+
       # We consider the max size here as just enough to leave room for one more
       # message of the largest size possible. This is a shortcut that allows us
       # to use a native Ruby `Queue` that doesn't allow peeking. The tradeoff

data/lib/segment/analytics/request.rb

@@ -38,10 +38,14 @@ module Segment
       #
       # returns - Response of the status and error if it exists
       def post(write_key, batch)
+        logger.debug("Sending request for #{batch.length} items")
+
         last_response, exception = retry_with_backoff(@retries) do
           status_code, body = send_request(write_key, batch)
           error = JSON.parse(body)['error']
           should_retry = should_retry_request?(status_code, body)
+          logger.debug("Response status code: #{status_code}")
+          logger.debug("Response error: #{error}") if error
 
           [Response.new(status_code, error), should_retry]
         end
@@ -90,6 +94,7 @@ module Segment
         end
 
         if should_retry && (retries_remaining > 1)
+          logger.debug("Retrying request, #{retries_remaining} retries left")
           sleep(@backoff_policy.next_interval.to_f / 1000)
           retry_with_backoff(retries_remaining - 1, &block)
         else
@@ -112,11 +117,6 @@ module Segment
 
           [200, '{}']
         else
-          # If `start` is not called, Ruby adds a 'Connection: close' header to
-          # all requests, preventing us from reusing a connection for multiple
-          # HTTP requests
-          @http.start unless @http.started?
-
           response = @http.request(request, payload)
           [response.code.to_i, response.body]
         end

data/lib/segment/analytics/version.rb

@@ -1,5 +1,5 @@
 module Segment
   class Analytics
-    VERSION = '2.2.5'
+    VERSION = '2.2.6.pre'
   end
 end

data/lib/segment/analytics/worker.rb

@@ -1,5 +1,4 @@
 require 'segment/analytics/defaults'
-require 'segment/analytics/message'
 require 'segment/analytics/message_batch'
 require 'segment/analytics/request'
 require 'segment/analytics/utils'
@@ -9,6 +8,7 @@ module Segment
     class Worker
       include Segment::Analytics::Utils
       include Segment::Analytics::Defaults
+      include Segment::Analytics::Logging
 
       # public: Creates a new worker
       #
@@ -29,7 +29,6 @@ module Segment
         batch_size = options[:batch_size] || Defaults::MessageBatch::MAX_SIZE
         @batch = MessageBatch.new(batch_size)
         @lock = Mutex.new
-        @request = Request.new
       end
 
       # public: Continuously runs the loop to check for new events
@@ -39,12 +38,11 @@ module Segment
           return if @queue.empty?
 
           @lock.synchronize do
-            until @batch.full? || @queue.empty?
-              @batch << Message.new(@queue.pop)
-            end
+            @batch << @queue.pop until @batch.full? || @queue.empty?
           end
 
-          res = @request.post(@write_key, @batch)
+          res = Request.new.post @write_key, @batch
+
           @on_error.call(res.status, res.error) unless res.status == 200
 
           @lock.synchronize { @batch.clear }

data/spec/isolated/json_example.rb

@@ -0,0 +1,9 @@
+RSpec.shared_examples 'message_batch_json' do
+  it 'MessageBatch generates proper JSON' do
+    batch = Segment::Analytics::MessageBatch.new(100)
+    batch << { 'a' => 'b' }
+    batch << { 'c' => 'd' }
+
+    expect(JSON.generate(batch)).to eq('[{"a":"b"},{"c":"d"}]')
+  end
+end

data/spec/isolated/with_active_support.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'isolated/json_example'
+
+describe 'with active_support' do
+  before do
+    require 'active_support'
+    require 'active_support/json'
+  end
+
+  include_examples 'message_batch_json'
+end

data/spec/isolated/with_active_support_and_oj.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'isolated/json_example'
+
+if RUBY_VERSION >= '2.0' && RUBY_PLATFORM != 'java'
+  describe 'with active_support and oj' do
+    before do
+      require 'active_support'
+      require 'active_support/json'
+
+      require 'oj'
+      Oj.mimic_JSON
+    end
+
+    include_examples 'message_batch_json'
+  end
+end

data/spec/isolated/with_oj.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'isolated/json_example'
+
+if RUBY_VERSION >= '2.0' && RUBY_PLATFORM != 'java'
+  describe 'with oj' do
+    before do
+      require 'oj'
+      Oj.mimic_JSON
+    end
+
+    include_examples 'message_batch_json'
+  end
+end

data/spec/segment/analytics/e2e_spec.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 require 'spec_helper'
 
 module Segment
@@ -19,6 +21,10 @@ module Segment
     let(:runscope_client) { RunscopeClient.new(ENV.fetch('RUNSCOPE_TOKEN')) }
 
     it 'tracks events' do
+      # Runscope inspector has shut down, disable for a while until we've
+      # found a replacement.
+      skip if Date.today < Date.new(2018, 7, 27)
+
       id = SecureRandom.uuid
       client.track(
         user_id: 'dummy_user_id',

data/spec/segment/analytics/message_batch_spec.rb

@@ -7,14 +7,13 @@ module Segment
 
       describe '#<<' do
         it 'appends messages' do
-          subject << Message.new('a' => 'b')
+          subject << { 'a' => 'b' }
           expect(subject.length).to eq(1)
         end
 
         it 'rejects messages that exceed the maximum allowed size' do
           max_bytes = Defaults::Message::MAX_BYTES
-          hash = { 'a' => 'b' * max_bytes }
-          message = Message.new(hash)
+          message = { 'a' => 'b' * max_bytes }
 
           subject << message
           expect(subject.length).to eq(0)
@@ -23,21 +22,23 @@ module Segment
 
       describe '#full?' do
         it 'returns true once item count is exceeded' do
-          99.times { subject << Message.new(a: 'b') }
+          99.times { subject << { a: 'b' } }
           expect(subject.full?).to be(false)
 
-          subject << Message.new(a: 'b')
+          subject << { a: 'b' }
           expect(subject.full?).to be(true)
         end
 
         it 'returns true once max size is almost exceeded' do
-          message = Message.new(a: 'b' * (Defaults::Message::MAX_BYTES - 10))
+          message = { a: 'b' * (Defaults::Message::MAX_BYTES - 10) }
+
+          message_size = message.to_json.bytesize
 
           # Each message is under the individual limit
-          expect(message.json_size).to be < Defaults::Message::MAX_BYTES
+          expect(message_size).to be < Defaults::Message::MAX_BYTES
 
           # Size of the batch is over the limit
-          expect(50 * message.json_size).to be > Defaults::MessageBatch::MAX_BYTES
+          expect(50 * message_size).to be > Defaults::MessageBatch::MAX_BYTES
 
           expect(subject.full?).to be(false)
           50.times { subject << message }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: analytics-ruby
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.2.6.pre
 platform: ruby
 authors:
 - Segment.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +173,6 @@ files:
 - lib/segment/analytics/client.rb
 - lib/segment/analytics/defaults.rb
 - lib/segment/analytics/logging.rb
-- lib/segment/analytics/message.rb
 - lib/segment/analytics/message_batch.rb
 - lib/segment/analytics/request.rb
 - lib/segment/analytics/response.rb
@@ -167,11 +180,14 @@ files:
 - lib/segment/analytics/version.rb
 - lib/segment/analytics/worker.rb
 - spec/helpers/runscope_client.rb
+- spec/isolated/json_example.rb
+- spec/isolated/with_active_support.rb
+- spec/isolated/with_active_support_and_oj.rb
+- spec/isolated/with_oj.rb
 - spec/segment/analytics/backoff_policy_spec.rb
 - spec/segment/analytics/client_spec.rb
 - spec/segment/analytics/e2e_spec.rb
 - spec/segment/analytics/message_batch_spec.rb
-- spec/segment/analytics/message_spec.rb
 - spec/segment/analytics/request_spec.rb
 - spec/segment/analytics/response_spec.rb
 - spec/segment/analytics/worker_spec.rb
@@ -192,12 +208,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Segment.io analytics library

data/lib/segment/analytics/message.rb

@@ -1,26 +0,0 @@
-require 'segment/analytics/defaults'
-
-module Segment
-  class Analytics
-    # Represents a message to be sent to the API
-    class Message
-      def initialize(hash)
-        @hash = hash
-      end
-
-      def too_big?
-        json_size > Defaults::Message::MAX_BYTES
-      end
-
-      def json_size
-        to_json.bytesize
-      end
-
-      # Since the hash is expected to not be modified (set at initialization),
-      # the JSON version can be cached after the first computation.
-      def to_json(*args)
-        @json ||= @hash.to_json(*args)
-      end
-    end
-  end
-end

data/spec/segment/analytics/message_spec.rb

@@ -1,35 +0,0 @@
-require 'spec_helper'
-
-module Segment
-  class Analytics
-    describe Message do
-      describe '#to_json' do
-        it 'caches JSON conversions' do
-          # Keeps track of the number of times to_json was called
-          nested_obj = Class.new do
-            attr_reader :to_json_call_count
-
-            def initialize
-              @to_json_call_count = 0
-            end
-
-            def to_json(*_)
-              @to_json_call_count += 1
-              '{}'
-            end
-          end.new
-
-          message = Message.new('some_key' => nested_obj)
-          expect(nested_obj.to_json_call_count).to eq(0)
-
-          message.to_json
-          expect(nested_obj.to_json_call_count).to eq(1)
-
-          # When called a second time, the call count shouldn't increase
-          message.to_json
-          expect(nested_obj.to_json_call_count).to eq(1)
-        end
-      end
-    end
-  end
-end