coverband-service-client 0.0.8 → 0.0.12.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d70bb9e3268a13b06640e0437e517cf00ccc4030f2b7f2c20e7b314d26828e2
-  data.tar.gz: 3400abcd93c90f5f8bb011757933dd08b0619ef907d3f2675a1326bb5eb7a102
+  metadata.gz: 9b93d9abe50ba1657318562b8fa04b645cfdd2fc22bca0f711cbde57b6d6b3c7
+  data.tar.gz: 1918f4689b50c6bda5b51d2f578b13b4bf439d38fb3510318165152b9093f1d2
 SHA512:
-  metadata.gz: fd6972fc75a2e8320a6ce2f991e871df0fed4c6a1298e0d2a443c479d309aca58d56f6c9c0aa346731fec7e1a9e12836e2cdb18480bd687667804f7b3d2a802d
-  data.tar.gz: e4bd36b15a82c5ab95fcc770909d04b3426d818a1468b90cf1f45667facd1f4fda9d37809c667c85b822b7b8651f3f8576d8323914c331bf207a6458bad81e99
+  metadata.gz: 33c461c2915ef4f9582fd8f87b5b2afa230076f1349e88ef7f66987cb1a8dda25d97c26983421ca52f900c3dd2d48d313e44dd69a8b15984a349dbe3fe4b3fd9
+  data.tar.gz: 0ea1b378ae8044400d50ad33944881d27552b42296cae06ceda360617b30d26a9bb3614e6a81c10b0bd530bcf59ca10ef9be3fba928e4c98b2f22929c21f4a66

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    coverband-service-client (0.0.8)
+    coverband-service-client (0.0.12.rc.1)
       coverband (~> 4.2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coverband (4.2.4)
+    coverband (4.2.5)
       redis
     minitest (5.14.0)
     rake (13.0.1)
-    redis (4.1.3)
+    redis (4.1.4)
 
 PLATFORMS
   ruby

data/lib/coverband-service-client.rb

@@ -1,24 +1,32 @@
 # frozen_string_literal: true
+require 'socket'
 
+COVERBAND_ORIGINAL_START = ENV['COVERBAND_DISABLE_AUTO_START']
+ENV['COVERBAND_DISABLE_AUTO_START'] = 'true'
 require 'coverband'
 require 'coverband/service/client/version'
 require 'securerandom'
 
-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_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
-
 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 : 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
+
+  def self.service_disabled_dev_test_env?
+    (COVERBAND_ENV == 'test' && !COVERBAND_ENABLE_TEST_MODE) ||
+      (COVERBAND_ENV == 'development' && !COVERBAND_ENABLE_DEV_MODE)
+  end
 
-  if ((COVERBAND_ENV == 'test' && !COVERBAND_ENABLE_TEST_MODE) ||
-       COVERBAND_ENV == 'development' && !COVERBAND_ENABLE_DEV_MODE
-     )
+  if service_disabled_dev_test_env?
     def self.report_coverage
-      # for now disable coverband reporting in test env by default
+      # for now disable coverband reporting in test & dev env by default
+      if Coverband.configuration.verbose
+        puts "Coverband: disabled for #{COVERBAND_ENV}, set COVERBAND_ENABLE_DEV_MODE or COVERBAND_ENABLE_TEST_MODE to enable" if Coverband.configuration.verbose || COVERBAND_ENABLE_DEV_MODE
+      end
     end
   end
 
@@ -28,16 +36,40 @@ module Coverband
       #
       # NOTES:
       # * uses net/http to avoid any dependencies
-      # * currently JSON, but likely better to move to something simpler / faster
+      # * currently JSON, but likely better to move to something faster
       ###
       class Service < Base
-        attr_reader :coverband_url, :process_type, :runtime_env
+        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) { COVERBAND_PROCESS_TYPE }
+          @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 }
           @runtime_env = opts.fetch(:runtime_env) { COVERBAND_ENV }
+          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'])
+        end
+
+        def report_timing(timing)
+          return unless @stats
+
+          @stats.emit_point(
+            'coverband.save.time',
+            timing,
+            host: hostname,
+            env: runtime_env,
+            client: "coverband_#{self.class.name.split("::").last}")
+        end
+
+        def logger
+          Coverband.configuration.logger
         end
 
         def clear!
@@ -53,28 +85,35 @@ module Coverband
           0
         end
 
-        # TODO: no longer get by type just get both reports in a single request
+        def api_key
+          ENV['COVERBAND_API_KEY'] || Coverband.configuration.api_key
+        end
+
+        ###
+        # Fetch coverband coverage via the API
+        ###
         def coverage(local_type = nil, opts = {})
           local_type ||= opts.key?(:override_type) ? opts[:override_type] : type
-          uri = URI("#{coverband_url}/api/coverage/#{ENV['COVERBAND_ID']}?type=#{local_type}")
-          req = Net::HTTP::Get.new(uri, 'Content-Type' => 'application/json', 'Coverband-Token' => ENV['COVERBAND_API_KEY'])
+          env_filter = opts.key?(:env_filter) ? opts[:env_filter] : 'production'
+          uri = URI("#{coverband_url}/api/coverage?type=#{local_type}&env_filter=#{env_filter}",)
+          req = Net::HTTP::Get.new(uri, 'Content-Type' => 'application/json', 'Coverband-Token' => api_key)
           res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
             http.request(req)
           end
           coverage_data = JSON.parse(res.body)
-          # puts "coverage data: "
-          # puts coverage_data
           coverage_data
         rescue StandardError => e
-          puts "Coverband: Error while retrieving coverage #{e}"
+          logger&.error "Coverband: Error while retrieving coverage #{e}" if Coverband.configuration.verbose || COVERBAND_ENABLE_DEV_MODE
         end
 
         def save_report(report)
-          #puts caller.join(',')
           return if report.empty?
 
+          # We set here vs initialize to avoid setting on the primary process vs child processes
+          @pid ||= ::Process.pid
+
           # TODO: do we need dup
-          # TODO: remove timestamps, server will track first_seen
+          # TODO: remove upstream timestamps, server will track first_seen
           Thread.new do
             data = expand_report(report.dup)
             full_package = {
@@ -83,12 +122,18 @@ module Coverband
                 tags: {
                   process_type: process_type,
                   app_loading: type == Coverband::EAGER_TYPE,
-                  runtime_env: runtime_env
+                  runtime_env: runtime_env,
+                  pid: pid,
+                  hostname: hostname,
                 },
                 file_coverage: data
               }
             }
+
+            starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
             save_coverage(full_package)
+            ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            report_timing((ending - starting))
           end&.join
         end
 
@@ -99,12 +144,18 @@ module Coverband
         private
 
         def save_coverage(data)
+          if api_key.nil?
+            puts "Coverband: Error: no Coverband API key was found!"
+            return
+          end
+
           uri = URI("#{coverband_url}/api/collector")
           req = Net::HTTP::Post.new(uri,
                                     'Content-Type' => 'application/json',
-                                    'Coverband-Token' => ENV['COVERBAND_API_KEY'])
-          # puts "sending #{data}"
+                                    'Coverband-Token' => api_key)
           req.body = { remote_uuid: SecureRandom.uuid, data: data }.to_json
+
+          logger&.info "Coverband: saving (#{uri}) #{req.body}" if Coverband.configuration.verbose
           res = Net::HTTP.start(
             uri.hostname,
             uri.port,
@@ -116,7 +167,51 @@ module Coverband
             http.request(req)
           end
         rescue StandardError => e
-          puts "Coverband: Error while saving coverage #{e}"
+          logger&.info "Coverband: Error while saving coverage #{e}" if Coverband.configuration.verbose || COVERBAND_ENABLE_DEV_MODE
+        end
+      end
+
+      class PersistentService < Service
+        attr_reader :http, :stats
+
+        def initialize(coverband_url, opts = {})
+          super
+          initiate_http
+        end
+
+        private
+
+        def initiate_http
+          @http = Net::HTTP::Persistent.new name: 'coverband_persistent'
+          @http.headers['Content-Type'] = 'application/json'
+          @http.headers['Coverband-Token'] = api_key
+          @http.open_timeout = COVERBAND_TIMEOUT
+          @http.read_timeout = COVERBAND_TIMEOUT
+          @http.ssl_timeout = COVERBAND_TIMEOUT
+        end
+
+        def save_coverage(data)
+          persistent_attempts = 0
+          begin
+            if api_key.nil?
+              puts "Coverband: Error: no Coverband API key was found!"
+              return
+            end
+
+            post_uri = URI("#{coverband_url}/api/collector")
+            post = Net::HTTP::Post.new post_uri.path
+            body = { remote_uuid: SecureRandom.uuid, data: data }.to_json
+            post.body = body
+            logger&.info "Coverband: saving (#{post_uri}) #{body}" if Coverband.configuration.verbose
+            res = http.request post_uri, post
+          rescue Net::HTTP::Persistent::Error => e
+            persistent_attempts += 1
+            http.shutdown
+            initiate_http
+            retry if persistent_attempts < 2
+          end
+        rescue StandardError => e
+          logger&.info "Coverband: Error while saving coverage #{e}" if Coverband.configuration.verbose || COVERBAND_ENABLE_DEV_MODE
         end
       end
     end
@@ -150,14 +245,22 @@ module Coverband
       rescue StandardError => e
         # we don't want to raise errors if Coverband can't reach redis.
         # This is a nice to have not a bring the system down
-        logger&.error "Coverband: view_tracker failed to store, error #{e.class.name}"
+        logger&.error "Coverband: view_tracker failed to store, error #{e.class.name}" if Coverband.configuration.verbose || COVERBAND_ENABLE_DEV_MODE
       end
 
       private
 
+      def api_key
+        ENV['COVERBAND_API_KEY'] || Coverband.configuration.api_key
+      end
+
+      def logger
+        Coverband.configuration.logger
+      end
+
       def save_tracked_views(views:, reported_time:)
         uri = URI("#{COVERBAND_SERVICE_URL}/api/collector")
-        req = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json', 'Coverband-Token' => ENV['COVERBAND_API_KEY'])
+        req = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json', 'Coverband-Token' => api_key)
         data = {
           collection_type: 'view_tracker_delta',
           collection_data: {
@@ -174,25 +277,53 @@ module Coverband
           http.request(req)
         end
       rescue StandardError => e
-        puts "Coverband: Error while saving coverage #{e}"
+        logger&.error "Coverband: Error while saving coverage #{e}" if Coverband.configuration.verbose || COVERBAND_ENABLE_DEV_MODE
       end
     end
   end
 end
 
+module Coverband
+  class Configuration
+    attr_accessor :api_key
+  end
+end
+
+ENV['COVERBAND_DISABLE_AUTO_START'] = COVERBAND_ORIGINAL_START
 Coverband.configure do |config|
-  # Use The Test Service Adapter
-  config.store = Coverband::Adapters::Service.new(COVERBAND_SERVICE_URL)
+  # Use the Service Adapter
+  if 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)
+  end
 
   # default to tracking views true
-  config.track_views = ENV['COVERBAND_DISABLE_VIEW_TRACKER'] ? false : true
+  config.track_views = if ENV['COVERBAND_DISABLE_VIEW_TRACKER']
+      false
+    elsif Coverband.service_disabled_dev_test_env?
+      false
+    else
+      true
+    end
 
   # report every 10m by default
-  config.background_reporting_sleep_seconds = COVERBAND_ENV == 'production' ? COVERBAND_REPORT_PERIOD : 60
+  config.background_reporting_sleep_seconds = Coverband::COVERBAND_ENV == 'production' ? Coverband::COVERBAND_REPORT_PERIOD : 60
   # add a wiggle to avoid service stampede
-  config.reporting_wiggle = COVERBAND_ENV == 'production' ? 90 : 6
+  config.reporting_wiggle = Coverband::COVERBAND_ENV == 'production' ? 90 : 6
 
-  if COVERBAND_ENV == 'test'
+  if Coverband::COVERBAND_ENV == 'test'
     config.background_reporting_enabled = false
   end
 end
+
+# NOTE: it is really hard to bypass / overload our config we should fix this in Coverband
+# this hopefully detects anyone that has both gems and was trying to configure Coverband themselves.
+if File.exist?('./config/coverband.rb')
+  puts "Warning: config/coverband.rb found, this overrides coverband service allowing one to setup open source Coverband" if Coverband.configuration.verbose || COVERBAND_ENABLE_DEV_MODE
+end
+
+Coverband.configure('./config/coverband_service.rb') if File.exist?('./config/coverband_service.rb')
+Coverband.start
+require "coverband/utils/railtie" if defined? ::Rails::Railtie
+require "coverband/integrations/resque" if defined? ::Resque

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband-service-client
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.12.rc.1
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,9 +106,9 @@ 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: []
 rubygems_version: 3.0.3
 signing_key: