bugsnag 6.5.0 → 6.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75340d844c86f98e0ef2519d4ca1416bf9de8ab8
-  data.tar.gz: 7a384090af717661a8acdcd2e2b3184b138b77e9
+  metadata.gz: 4c03a7b5fcc7e028efedba3fa34ec2e212ac51a6
+  data.tar.gz: 5be7d2ae911cde691ff88655a8bc6d44647b3119
 SHA512:
-  metadata.gz: eb256344706e647174e3dc9abac3376b7b3966c6f706fdb77dbaf2ae9c50527490d4ee591265a14a0787678f018affde73a0b3a5c7a30ea676da27bc7731612f
-  data.tar.gz: 71b8138725c4b11278eafef1e9a02c61977fe4a6f0460684e582ca9276b1bc4d7841cd0130b643882e0fc7e640e0eb33df7456c6004f6bb5d3b1ee3c031bac0d
+  metadata.gz: 8fe2cf08fafd1828e2bc0d9cf80e1e2bd63268ec529f3cab6e5153502354cb6404b315215c2573f76db6bf54cc5a688dcd4a66c8d14f19cd5d7588099acf56f0
+  data.tar.gz: 107e95f0ee4f2d7a78cff8ec7d9907f5a70cda75cd3c833c0d2c135800ec5885ae2396a7c6506a371d1b8b055a30e9c1c8c6700bfc78e25c67b3ce46d031ceca

data/CHANGELOG.md

@@ -1,12 +1,24 @@
 Changelog
 =========
 
+## 6.6.0 (09 Jan 2018)
+
+### Enhancements
+
+* Session tracking update:
+  * Refactor of session tracking to adhere to a common interface, and simplify usage.
+  * Includes several performance enhancements.
+  * Reverts potentially breaking change of json body sanitation within delivery function.
+  | [#412](https://github.com/bugsnag/bugsnag-ruby/pull/412)
+  * Maintains backwards compatibility with previous session-tracking changes.
+  | [#413](https://github.com/bugsnag/bugsnag-ruby/pull/413)
+
 ## 6.5.0 (04 Jan 2018)
 
 ### Enhancements
 
-* Adds support for tracking sessions and crash rate by setting the configuration option `configuration.track_sessions` to `true`.
-  Sessions can be manually created using `Bugsnag.start_session`, and manually delivered using `Bugsnag.send_sessions`.
+* Adds support for tracking sessions and crash rate by setting the configuration option `configuration.auto_capture_sessions` to `true`.
+  Sessions can be manually created using `Bugsnag.start_session`.
   | [#411](https://github.com/bugsnag/bugsnag-ruby/pull/411)
 
 ## 6.4.0 (21 Dec 2017)

data/VERSION

@@ -1 +1 @@
-6.5.0
+6.6.0

data/bugsnag.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |s|
   ]
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 1.9.2'
+  s.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
 end

data/lib/bugsnag.rb

@@ -39,8 +39,6 @@ module Bugsnag
         configuration.warn("No valid API key has been set, notifications will not be sent")
         @key_warning = true
       end
-
-      session_tracker.config = configuration
     end
 
     # Explicitly notify of an exception
@@ -116,8 +114,9 @@ module Bugsnag
 
         # Deliver
         configuration.info("Notifying #{configuration.endpoint} of #{report.exceptions.last[:errorClass]}")
-        options = {:headers => report.headers, :trim_payload => true}
-        Bugsnag::Delivery[configuration.delivery_method].deliver(configuration.endpoint, report.as_json, configuration, options)
+        options = {:headers => report.headers}
+        payload = ::JSON.dump(Bugsnag::Helpers.trim_if_needed(report.as_json))
+        Bugsnag::Delivery[configuration.delivery_method].deliver(configuration.endpoint, payload, configuration, options)
       end
     end
 
@@ -127,9 +126,14 @@ module Bugsnag
       @configuration || LOCK.synchronize { @configuration ||= Bugsnag::Configuration.new }
     end
 
+    # Session tracking
     def session_tracker
       @session_tracker = nil unless defined?(@session_tracker)
-      @session_tracker || LOCK.synchronize { @session_tracker ||= Bugsnag::SessionTracker.new(configuration)}
+      @session_tracker || LOCK.synchronize { @session_tracker ||= Bugsnag::SessionTracker.new}
+    end
+
+    def start_session
+      session_tracker.start_session
     end
 
     # Allow access to "before notify" callbacks

data/lib/bugsnag/configuration.rb

@@ -23,7 +23,7 @@ module Bugsnag
     attr_accessor :app_type
     attr_accessor :meta_data_filters
     attr_accessor :endpoint
-    attr_accessor :logger 
+    attr_accessor :logger
     attr_accessor :middleware
     attr_accessor :internal_middleware
     attr_accessor :proxy_host
@@ -33,6 +33,7 @@ module Bugsnag
     attr_accessor :timeout
     attr_accessor :hostname
     attr_accessor :ignore_classes
+    attr_accessor :auto_capture_sessions
     attr_accessor :track_sessions
     attr_accessor :session_endpoint
 
@@ -49,6 +50,9 @@ module Bugsnag
       "rack.request.form_vars"
     ].freeze
 
+    alias :track_sessions :auto_capture_sessions
+    alias :track_sessions= :auto_capture_sessions=
+
     def initialize
       @mutex = Mutex.new
 
@@ -61,7 +65,7 @@ module Bugsnag
       self.hostname = default_hostname
       self.timeout = 15
       self.notify_release_stages = nil
-      self.track_sessions = false
+      self.auto_capture_sessions = false
       self.session_endpoint = DEFAULT_SESSION_ENDPOINT
 
       # SystemExit and Interrupt are common Exception types seen with successful

data/lib/bugsnag/delivery/synchronous.rb

@@ -4,18 +4,13 @@ require "uri"
 module Bugsnag
   module Delivery
     class Synchronous
-      BACKOFF_THREADS = {}
-      BACKOFF_REQUESTS = {}
-      BACKOFF_LOCK = Mutex.new
-
       class << self
         def deliver(url, body, configuration, options={})
           begin
             response = request(url, body, configuration, options)
             configuration.debug("Request to #{url} completed, status: #{response.code}")
-            success = options[:success] || '200'
-            if options[:backoff] && !(response.code == success)
-              backoff(url, body, configuration, options)
+            if response.code[0] != "2"
+              configuration.warn("Notifications to #{url} was reported unsuccessful with code #{response.code}")
             end
           rescue StandardError => e
             # KLUDGE: Since we don't re-raise http exceptions, this breaks rspec
@@ -31,11 +26,6 @@ module Bugsnag
         def request(url, body, configuration, options)
           uri = URI.parse(url)
 
-          if options[:trim_payload]
-            body = Bugsnag::Helpers.trim_if_needed(body)
-          end
-          payload = ::JSON.dump(body)
-
           if configuration.proxy_host
             http = Net::HTTP.new(uri.host, uri.port, configuration.proxy_host, configuration.proxy_port, configuration.proxy_user, configuration.proxy_password)
           else
@@ -54,90 +44,11 @@ module Bugsnag
           headers.merge!(default_headers)
 
           request = Net::HTTP::Post.new(path(uri), headers)
-          request.body = payload
+          request.body = body
 
           http.request(request)
         end
 
-        def backoff(url, body, configuration, options)
-          # Ensure we have the latest configuration for making these requests
-          @latest_configuration = configuration
-          
-          BACKOFF_LOCK.lock
-          begin
-            # Define an exit function once to handle outstanding requests
-            @registered_at_exit = false unless defined?(@registered_at_exit)
-            if !@registered_at_exit
-              @registered_at_exit = true
-              at_exit do
-                backoff_exit
-              end
-            end
-            if BACKOFF_REQUESTS[url] && !BACKOFF_REQUESTS[url].empty?
-              last_request = BACKOFF_REQUESTS[url].last
-              new_body_length = ::JSON.dump(body).length
-              old_body_length = ::JSON.dump(last_request[:body]).length
-              if new_body_length + old_body_length >= Bugsnag::Helpers::MAX_PAYLOAD_LENGTH
-                BACKOFF_REQUESTS[url].push({:body => body, :options => options})
-              else
-                Bugsnag::Helpers::deep_merge!(last_request, {:body => body, :options => options})
-              end
-            else
-              BACKOFF_REQUESTS[url] = [{:body => body, :options => options}]
-            end
-            if !(BACKOFF_THREADS[url] && BACKOFF_THREADS[url].status)
-              spawn_backoff_thread(url)
-            end
-          ensure
-            BACKOFF_LOCK.unlock
-          end
-        end
-
-        def backoff_exit
-          # Kill existing threads
-          BACKOFF_THREADS.each do |url, thread|
-            thread.exit
-          end
-          # Retry outstanding requests once, then exit
-          BACKOFF_REQUESTS.each do |url, requests|
-            requests.map! do |req|
-              response = request(url, req[:body], @latest_configuration, req[:options])
-              success = req[:options][:success] || '200'
-              response.code == success
-            end
-            requests.reject! { |i| i }
-            @latest_configuration.warn("Requests to #{url} finished, #{requests.size} failed")
-          end
-        end
-        
-        def spawn_backoff_thread(url)
-          new_thread = Thread.new(url) do |url|
-            interval = 2
-            while BACKOFF_REQUESTS[url].size > 0
-              sleep(interval)
-              interval = interval * 2
-              interval = 600 if interval > 600
-              BACKOFF_LOCK.lock
-              begin
-                BACKOFF_REQUESTS[url].map! do |req|
-                  response = request(url, req[:body], @latest_configuration, req[:options])
-                  success = req[:options][:success] || '200'
-                  if response.code == success
-                    @latest_configuration.debug("Request to #{url} completed, status: #{response.code}")
-                    false
-                  else
-                    req
-                  end
-                end
-                BACKOFF_REQUESTS[url].reject! { |i| !i }
-              ensure
-                BACKOFF_LOCK.unlock
-              end
-            end
-          end
-          BACKOFF_THREADS[url] = new_thread
-        end
-
         def path(uri)
           uri.path == "" ? "/" : uri.path
         end

data/lib/bugsnag/integrations/rack.rb

@@ -34,7 +34,9 @@ module Bugsnag
     def call(env)
       # Set the request data for bugsnag middleware to use
       Bugsnag.configuration.set_request_data(:rack_env, env)
-      Bugsnag.session_tracker.create_session
+      if Bugsnag.configuration.auto_capture_sessions
+        Bugsnag.start_session
+      end
 
       begin
         response = @app.call(env)

data/lib/bugsnag/session_tracker.rb

@@ -1,18 +1,16 @@
 require 'thread'
 require 'time'
 require 'securerandom'
+require 'concurrent'
 
 module Bugsnag
   class SessionTracker
 
     THREAD_SESSION = "bugsnag_session"
-    TIME_THRESHOLD = 60
-    FALLBACK_TIME = 300
-    MAXIMUM_SESSION_COUNT = 50
     SESSION_PAYLOAD_VERSION = "1.0"
+    MUTEX = Mutex.new
 
     attr_reader :session_counts
-    attr_writer :config
 
     def self.set_current_session(session)
       Thread.current[THREAD_SESSION] = session
@@ -22,15 +20,12 @@ module Bugsnag
       Thread.current[THREAD_SESSION]
     end
 
-    def initialize(configuration)
-      @session_counts = {}
-      @config = configuration
-      @mutex = Mutex.new
-      @last_sent = Time.now
+    def initialize
+      @session_counts = Concurrent::Hash.new(0)
     end
 
-    def create_session
-      return unless @config.track_sessions
+    def start_session
+      start_delivery_thread
       start_time = Time.now().utc().strftime('%Y-%m-%dT%H:%M:00')
       new_session = {
         :id => SecureRandom.uuid,
@@ -41,117 +36,93 @@ module Bugsnag
         }
       }
       SessionTracker.set_current_session(new_session)
-      add_thread = Thread.new { add_session(start_time) }
-      add_thread.join()
+      add_session(start_time)
     end
 
-    def send_sessions
-      @mutex.lock
-      begin
-        deliver_sessions
-      ensure
-        @mutex.unlock
-      end
-    end
-
-    private
-    def add_session(min)
-      @mutex.lock
-      begin
-        @registered_at_exit = false unless defined?(@registered_at_exit)
-        if !@registered_at_exit
-          @registered_at_exit = true
-          at_exit do
-            if !@deliver_fallback.nil? && @deliver_fallback.status == 'sleep'
-              @deliver_fallback.terminate
-            end
-            deliver_sessions
-          end
-        end
-        @session_counts[min] ||= 0
-        @session_counts[min] += 1
-        if Time.now() - @last_sent > TIME_THRESHOLD
-          deliver_sessions
-        end
-      ensure
-        @mutex.unlock
-      end
-    end
+    alias_method :create_session, :start_session
 
-    def deliver_sessions
-      return unless @config.track_sessions
+    def send_sessions
       sessions = []
-      @session_counts.each do |min, count|
+      counts = @session_counts
+      @session_counts = Concurrent::Hash.new(0)
+      counts.each do |min, count|
         sessions << {
           :startedAt => min,
           :sessionsStarted => count
         }
-        if sessions.size >= MAXIMUM_SESSION_COUNT
-          deliver(sessions)
-          sessions = []
-        end
       end
-      @session_counts = {}
-      reset_delivery_thread
       deliver(sessions)
     end
 
-    def reset_delivery_thread
-      if !@deliver_fallback.nil? && @deliver_fallback.status == 'sleep'
-        @deliver_fallback.terminate
-      end
-      @deliver_fallback = Thread.new do
-        sleep(FALLBACK_TIME)
-        deliver_sessions
+    def start_delivery_thread
+      MUTEX.synchronize do
+        @started = nil unless defined?(@started)
+        return if @started == Process.pid
+        @started = Process.pid
+        at_exit do
+          if !@delivery_thread.nil?
+            @delivery_thread.execute
+            @delivery_thread.shutdown
+          else
+            if @session_counts.size > 0
+              send_sessions
+            end
+          end
+        end
+        @delivery_thread = Concurrent::TimerTask.new(execution_interval: 30) do
+          if @session_counts.size > 0
+            send_sessions
+          end
+        end
       end
     end
 
-    def deliver(sessionCounts)
-      if sessionCounts.length == 0
-        @config.debug("No sessions to deliver")
-        return
-      end
-      
-      if !@config.valid_api_key?
-        @config.debug("Not delivering sessions due to an invalid api_key")
+    private
+    def add_session(min)
+      @session_counts[min] += 1
+    end
+
+    def deliver(session_payload)
+      if session_payload.length == 0
+        Bugsnag.configuration.debug("No sessions to deliver")
         return
       end
-      
-      if !@config.should_notify_release_stage?
-        @config.debug("Not delivering sessions due to notify_release_stages :#{@config.notify_release_stages.inspect}")
+
+      if !Bugsnag.configuration.valid_api_key?
+        Bugsnag.configuration.debug("Not delivering sessions due to an invalid api_key")
         return
       end
 
-      if @config.delivery_method != :thread_queue
-        @config.debug("Not delivering sessions due to asynchronous delivery being disabled")
+      if !Bugsnag.configuration.should_notify_release_stage?
+        Bugsnag.configuration.debug("Not delivering sessions due to notify_release_stages :#{Bugsnag.configuration.notify_release_stages.inspect}")
         return
       end
-      
-      payload = {
+
+      body = {
         :notifier => {
           :name => Bugsnag::Report::NOTIFIER_NAME,
           :url => Bugsnag::Report::NOTIFIER_URL,
           :version => Bugsnag::Report::NOTIFIER_VERSION
         },
         :device => {
-          :hostname => @config.hostname
+          :hostname => Bugsnag.configuration.hostname
         },
         :app => {
-          :version => @config.app_version,
-          :releaseStage => @config.release_stage,
-          :type => @config.app_type
+          :version => Bugsnag.configuration.app_version,
+          :releaseStage => Bugsnag.configuration.release_stage,
+          :type => Bugsnag.configuration.app_type
         },
-        :sessionCounts => sessionCounts
+        :sessionCounts => session_payload
       }
+      payload = ::JSON.dump(body)
 
       headers = {
-        "Bugsnag-Api-Key" => @config.api_key,
+        "Bugsnag-Api-Key" => Bugsnag.configuration.api_key,
         "Bugsnag-Payload-Version" => SESSION_PAYLOAD_VERSION
       }
 
-      options = {:headers => headers, :backoff => true, :success => '202'}
-      @last_sent = Time.now
-      Bugsnag::Delivery[@config.delivery_method].deliver(@config.session_endpoint, payload, @config, options)
+      options = {:headers => headers}
+      Bugsnag::Delivery[Bugsnag.configuration.delivery_method].deliver(Bugsnag.configuration.session_endpoint, payload, Bugsnag.configuration, options)
     end
   end
 end

data/spec/configuration_spec.rb

@@ -25,7 +25,7 @@ describe Bugsnag::Configuration do
 
     it "should have sensible defaults for session tracking" do
       expect(subject.session_endpoint).to eq("https://sessions.bugsnag.com")
-      expect(subject.track_sessions).to be false
+      expect(subject.auto_capture_sessions).to be false
     end
   end
 

data/spec/report_spec.rb

@@ -1006,7 +1006,7 @@ describe Bugsnag::Report do
     Bugsnag.notify(exception)
     expect(Bugsnag).not_to have_sent_notification
   end
-    
+
 
   if defined?(JRUBY_VERSION)
 

data/spec/session_tracker_spec.rb

@@ -8,8 +8,6 @@ describe Bugsnag::SessionTracker do
   queue = Queue.new
 
   before do
-    @config = Bugsnag::Configuration.new
-    @config.track_sessions = true
     server = WEBrick::HTTPServer.new :Port => 0, :Logger => WEBrick::Log.new("/dev/null"), :AccessLog => []
     server.mount_proc '/' do |req, res|
       headers = []
@@ -21,26 +19,18 @@ describe Bugsnag::SessionTracker do
     Thread.new{ server.start }
   end
 
-  after do    
+  after do
     Bugsnag.configure do |conf|
-      conf.track_sessions = false
+      conf.auto_capture_sessions = false
       conf.delivery_method = :synchronous
     end
     server.stop
     queue.clear
   end
 
-  it 'does not create session object if disabled' do
-    config = Bugsnag::Configuration.new
-    config.track_sessions = false
-    tracker = Bugsnag::SessionTracker.new(config)
-    tracker.create_session
-    expect(tracker.session_counts.size).to eq(0)
-  end
-
   it 'adds session object to queue' do
-    tracker = Bugsnag::SessionTracker.new(@config)
-    tracker.create_session
+    tracker = Bugsnag::SessionTracker.new
+    tracker.start_session
     expect(tracker.session_counts.size).to eq(1)
     time = tracker.session_counts.keys.last
     count = tracker.session_counts[time]
@@ -49,8 +39,8 @@ describe Bugsnag::SessionTracker do
   end
 
   it 'stores session in thread' do
-    tracker = Bugsnag::SessionTracker.new(@config)
-    tracker.create_session
+    tracker = Bugsnag::SessionTracker.new
+    tracker.start_session
     session = Thread.current[Bugsnag::SessionTracker::THREAD_SESSION]
     expect(session.include? :id).to be true
     expect(session.include? :startedAt).to be true
@@ -62,28 +52,25 @@ describe Bugsnag::SessionTracker do
   end
 
   it 'gives unique ids to each session' do
-    tracker = Bugsnag::SessionTracker.new(@config)
-    tracker.create_session
+    tracker = Bugsnag::SessionTracker.new
+    tracker.start_session
     session_one = Thread.current[Bugsnag::SessionTracker::THREAD_SESSION]
-    tracker.create_session
+    tracker.start_session
     session_two = Thread.current[Bugsnag::SessionTracker::THREAD_SESSION]
     expect(session_one[:id]).to_not eq(session_two[:id])
   end
 
   it 'sends sessions when send_sessions is called' do
     Bugsnag.configure do |conf|
-      conf.track_sessions = true
-      conf.delivery_method = :thread_queue
+      conf.auto_capture_sessions = true
+      conf.delivery_method = :synchronous
       conf.session_endpoint = "http://localhost:#{server.config[:Port]}"
     end
     WebMock.allow_net_connect!
-    Bugsnag.session_tracker.create_session
+    Bugsnag.start_session
     expect(Bugsnag.session_tracker.session_counts.size).to eq(1)
     Bugsnag.session_tracker.send_sessions
     expect(Bugsnag.session_tracker.session_counts.size).to eq(0)
-    while queue.empty?
-      sleep(0.05)
-    end
     payload, headers = queue.pop
     expect(payload.include?("app")).to be true
     expect(payload.include?("notifier")).to be true
@@ -94,19 +81,16 @@ describe Bugsnag::SessionTracker do
 
   it 'sets details from config' do
     Bugsnag.configure do |conf|
-      conf.track_sessions = true
+      conf.auto_capture_sessions = true
       conf.release_stage = "test_stage"
-      conf.delivery_method = :thread_queue
+      conf.delivery_method = :synchronous
       conf.session_endpoint = "http://localhost:#{server.config[:Port]}"
     end
     WebMock.allow_net_connect!
-    Bugsnag.session_tracker.create_session
+    Bugsnag.start_session
     expect(Bugsnag.session_tracker.session_counts.size).to eq(1)
     Bugsnag.session_tracker.send_sessions
     expect(Bugsnag.session_tracker.session_counts.size).to eq(0)
-    while queue.empty?
-      sleep(0.05)
-    end
     payload, headers = queue.pop
     notifier = payload["notifier"]
     expect(notifier.include?("name")).to be true
@@ -131,10 +115,10 @@ describe Bugsnag::SessionTracker do
 
   it 'uses middleware to attach session to notification' do
     Bugsnag.configure do |conf|
-      conf.track_sessions = true
+      conf.auto_capture_sessions = true
       conf.release_stage = "test_stage"
     end
-    Bugsnag.session_tracker.create_session
+    Bugsnag.start_session
     Bugsnag.notify(BugsnagTestException.new("It crashed"))
     expect(Bugsnag).to have_sent_notification{ |payload, headers|
       event = payload["events"][0]

data/spec/spec_helper.rb

@@ -23,10 +23,6 @@ def get_event_from_payload(payload)
   payload["events"].first
 end
 
-def get_headers_from_payload(payload)
-
-end
-
 def get_exception_from_payload(payload)
   event = get_event_from_payload(payload)
   expect(event["exceptions"].size).to eq(1)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.5.0
+  version: 6.6.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
-dependencies: []
+date: 2018-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Ruby notifier for bugsnag.com
 email: james@bugsnag.com
 executables: []