coverband-service-client 0.0.12.rc → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b21c24a8ca01191ebb807640f09555b360ba6f0333b86d6e0c109387832bb35a
-  data.tar.gz: 7657f2a6942d2474d196f470c1fbaca8b069ae49619c483e8e0e2c1787b39410
+  metadata.gz: 6391e88b97c48592f2adcaa31d2870589fc5a370e23a9fa12dba5d9c5344016a
+  data.tar.gz: cabef455a4fbe75afa34d28a6f24686cd536bb1fded5745fd35987425a925512
 SHA512:
-  metadata.gz: ef97e09b88610ae38f45295e650e8b79b5cdaf77e46d616753ffcc1aa98cb34f5f0267b30a1ca7dc3a859df55f9b4305b150e7412dc05ad1062504777be819d2
-  data.tar.gz: c4cae237dd5fbf03da3ddb8061ee76cc597e5fcc44d45b6351d2a2fad646bf6f4e3ff035dd9dba803e4cb70c421bfeeea1b09544dcb4d837b9ad9135d7bec1cc
+  metadata.gz: 2d2e149104351ff97918e921875044d6d05cf1ce5d0fd5ca7456a09892d65b659c0d771b7a5d61353aa5985e78c6bb96b0af8bbe8d77781a640586a1873d9e3c
+  data.tar.gz: 8a44da13a736a3f47935b38d3a59591a62b31471559842bc6ac9cfab2fa2d6b5d3019a5fbb173bd3bced1c387c92d79588bb57b447a5c0fd986a442c0f79b6db

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coverband-service-client (0.0.12.rc)
+    coverband-service-client (0.0.12)
       coverband (~> 4.2.4)
 
 GEM

data/bin/stats

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+ENV['COVERBAND_ENABLE_DEV_MODE'] = 'true'
+ENV['COVERBAND_ENABLE_TEST_MODE'] = 'true'
+ENV['PROCESS_TYPE'] = 'debug'
+ENV['COVERBAND_REPORT_PERIOD'] = '30'
+ENV['COVERBAND_API_KEY'] ||= 'set this'
+ENV['COVERBAND_STATS_KEY'] ||='set this'
+
+require "pry-byebug";
+require "dogapi";
+require "net/http/persistent";
+# require "httplog";
+require 'benchmark'
+
+require_relative "../lib/coverband-service-client"
+
+# HttpLog.configure do |config|
+#   config.url_SAFElist_pattern = /coverband/
+# end
+
+data = {
+  'app/helpers/posts_helper.rb' => [1, nil]
+}
+
+collector = Coverband::Collectors::Coverage.instance
+store = Coverband.configuration.store
+
+# What is the recommended timeout against the target, from the lib
+# puts store.recommended_timeout
+
+Benchmark.bmbm do |x|
+  x.report("connection") do
+    30.times do
+      store.save_report(data)
+    end
+  end
+end
+
+puts "done"

data/coverband-service-client.gemspec

@@ -28,6 +28,14 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
+
+  # For benchmarking stats
+  # spec.add_development_dependency "pry-byebug"
+  # spec.add_development_dependency "dogapi"
+  # spec.add_development_dependency "httplog"
+  # # to benchmark persistent connections
+  # spec.add_development_dependency "net-http-persistent"
+
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_runtime_dependency "coverband", "~> 4.2.4"
 end

data/lib/coverband-service-client.rb

@@ -10,11 +10,12 @@ require 'securerandom'
 module Coverband
   COVERBAND_ENV = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || (defined?(Rails) ? Rails.env : 'unknown')
   COVERBAND_SERVICE_URL = ENV['COVERBAND_URL'] || 'https://coverband.io'
-  COVERBAND_TIMEOUT = (COVERBAND_ENV == 'development') ? 5 : 1
+  COVERBAND_TIMEOUT = (COVERBAND_ENV == 'development') ? 5 : 2
   COVERBAND_ENABLE_DEV_MODE = ENV['COVERBAND_ENABLE_DEV_MODE'] || false
   COVERBAND_ENABLE_TEST_MODE = ENV['COVERBAND_ENABLE_TEST_MODE'] || false
   COVERBAND_PROCESS_TYPE = ENV['PROCESS_TYPE'] || 'unknown'
   COVERBAND_REPORT_PERIOD = (ENV['COVERBAND_REPORT_PERIOD'] || 600).to_i
+  COVERBAND_PERSISTENT_HTTP = ENV['COVERBAND_PERSISTENT_HTTP'] || false
 
   def self.service_disabled_dev_test_env?
     (COVERBAND_ENV == 'test' && !COVERBAND_ENABLE_TEST_MODE) ||
@@ -39,14 +40,36 @@ module Coverband
       # * currently JSON, but likely better to move to something faster
       ###
       class Service < Base
-        attr_reader :coverband_url, :process_type, :runtime_env, :hostname, :pid
+        attr_reader :coverband_url, :process_type, :runtime_env, :hostname, :pid, :stats
 
         def initialize(coverband_url, opts = {})
           super()
           @coverband_url = coverband_url
           @process_type = opts.fetch(:process_type) { $PROGRAM_NAME&.split('/')&.last || COVERBAND_PROCESS_TYPE }
           @hostname = opts.fetch(:hostname) { ENV["DYNO"] || Socket.gethostname.force_encoding('utf-8').encode }
+          @hostname = @hostname.gsub("'",'').gsub("’",'')
           @runtime_env = opts.fetch(:runtime_env) { COVERBAND_ENV }
+          @failed_coverage_reports = []
+          initialize_stats
+        end
+
+        def initialize_stats
+          return unless ENV['COVERBAND_STATS_KEY']
+          return unless defined?(Dogapi::Client)
+
+          @stats = Dogapi::Client.new(ENV['COVERBAND_STATS_KEY'])
+          @app_name = defined?(Rails) ? Rails.application.class.module_parent.to_s : "unknown"
+        end
+
+        def report_timing(timing)
+          return unless @stats
+
+          @stats.emit_point(
+            'coverband.save.time',
+            timing,
+            host: hostname,
+            device: "coverband_#{self.class.name.split("::").last}",
+            options: {tags: [runtime_env]})
         end
 
         def logger
@@ -110,7 +133,12 @@ module Coverband
                 file_coverage: data
               }
             }
+
+            starting = Process.clock_gettime(Process::CLOCK_MONOTONIC) if @stats
             save_coverage(full_package)
+            ending = Process.clock_gettime(Process::CLOCK_MONOTONIC) if @stats
+            report_timing((ending - starting)) if @stats
+            retry_failed_reports
           end&.join
         end
 
@@ -120,20 +148,48 @@ module Coverband
 
         private
 
+        def retry_failed_reports
+          retries = []
+          @failed_coverage_reports.any? do
+            report_body = arr.pop
+            send_report_body(report_body)
+          rescue StandardError
+            retries << report_body
+          end
+          retries.each do |report_body|
+            add_retry_message(report_body)
+          end
+        end
+
+        def add_retry_message(report_body)
+          if @failed_coverage_reports.length > 5
+            logger&.info "Coverband: The errored reporting queue has reached 5. Subsequent reports will not be transmitted"
+          else
+            @failed_coverage_reports << report_body
+          end
+        end
+
         def save_coverage(data)
           if api_key.nil?
             puts "Coverband: Error: no Coverband API key was found!"
             return
           end
 
+          coverage_body = { remote_uuid: SecureRandom.uuid, data: data }.to_json
+          send_report_body(coverage_body)
+        rescue StandardError => e
+          add_retry_message(coverage_body)
+          logger&.info "Coverband: Error while saving coverage #{e}" if Coverband.configuration.verbose || COVERBAND_ENABLE_DEV_MODE
+        end
+
+        def send_report_body(coverage_body)
           uri = URI("#{coverband_url}/api/collector")
-          req = Net::HTTP::Post.new(uri,
+          req = ::Net::HTTP::Post.new(uri,
                                     'Content-Type' => 'application/json',
                                     'Coverband-Token' => api_key)
-          req.body = { remote_uuid: SecureRandom.uuid, data: data }.to_json
-
+          req.body = coverage_body
           logger&.info "Coverband: saving (#{uri}) #{req.body}" if Coverband.configuration.verbose
-          res = Net::HTTP.start(
+          res = ::Net::HTTP.start(
             uri.hostname,
             uri.port,
             open_timeout: COVERBAND_TIMEOUT,
@@ -143,19 +199,24 @@ module Coverband
             ) do |http|
             http.request(req)
           end
-        rescue StandardError => e
-          logger&.info "Coverband: Error while saving coverage #{e}" if Coverband.configuration.verbose || COVERBAND_ENABLE_DEV_MODE
+          if res.code.to_i >= 500
+            add_retry_message(coverage_body)
+          end
         end
       end
 
       class PersistentService < Service
-        attr_reader :http
+        attr_reader :http, :stats
 
         def initialize(coverband_url, opts = {})
           super
           initiate_http
         end
 
+        def recommended_timeout
+          puts Net::HTTP::Persistent.detect_idle_timeout URI("#{coverband_url}/api/collector")
+        end
+
         private
 
         def initiate_http
@@ -164,7 +225,13 @@ module Coverband
           @http.headers['Coverband-Token'] = api_key
           @http.open_timeout = COVERBAND_TIMEOUT
           @http.read_timeout = COVERBAND_TIMEOUT
-          @http.ssl_timeout = COVERBAND_TIMEOUT
+          # the two below seem inconsistent in terms of how they are set
+          # leaving off for now
+          # @http.ssl_timeout = COVERBAND_TIMEOUT
+          # @http.write_timeout = COVERBAND_TIMEOUT
+          # default is 5-10 seconds but we report ever few min, heroku kills them
+          # before our reporting period... ;(
+          # @http.idle_timeout = 1000
         end
 
         def save_coverage(data)
@@ -269,7 +336,7 @@ end
 ENV['COVERBAND_DISABLE_AUTO_START'] = COVERBAND_ORIGINAL_START
 Coverband.configure do |config|
   # Use the Service Adapter
-  if defined?(Net::HTTP::Persistent)
+  if Coverband::COVERBAND_PERSISTENT_HTTP && defined?(Net::HTTP::Persistent)
     config.store = Coverband::Adapters::PersistentService.new(Coverband::COVERBAND_SERVICE_URL)
   else
     config.store = Coverband::Adapters::Service.new(Coverband::COVERBAND_SERVICE_URL)

data/lib/coverband/service/client/version.rb

@@ -1,7 +1,7 @@
 module Coverband
   module Service
     module Client
-      VERSION = '0.0.12.rc'
+      VERSION = '0.0.12'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband-service-client
 version: !ruby/object:Gem::Version
-  version: 0.0.12.rc
+  version: 0.0.12
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-15 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/stats
 - changelog.md
 - coverband-service-client.gemspec
 - lib/coverband-service-client.rb
@@ -106,9 +107,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: