coverband 4.2.1.rc3 → 4.2.1.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cb0c3fd4256ad4d254c22cd98528bc34528e968ca65cfebc3a4720844e2a07d
-  data.tar.gz: 83cb0d9d97861c92e688274dc6885025ff2282d6a2625e473b148a3f68be0c05
+  metadata.gz: d0848a662aca5276be0eca2ac39bf30cd55a45e50ef85416d217a316e7f317fc
+  data.tar.gz: 22e16b8e9096dbb86e117e9ff7956fd11bfed781ab9807dc8e82af36ca966ccb
 SHA512:
-  metadata.gz: 2d1206b71ffe2fddb8145a5f168a317a5e54373dd2b8b708ae6c86da800d015215c7d60b9906c791b725c8127add8bfb59343cad812f4f70ddc69b00d7a179a3
-  data.tar.gz: d2c1e07f8df62c8b4c4be64f009e2206b103b1685e2064664b1042d6ae25c9196247832007e707b6b3a7e1aa67aed454857bc64f13d44d594d86878f903d1a02
+  metadata.gz: 8d191007b78a0d53f4d9138a9ea13b7a9d5cd98636c1b87f0b53f71754a5cd6b3356ba5765857383b62b99b9f3afcf754d51244ea9296f61f9d58c6262e29338
+  data.tar.gz: 0fce0a7624708291b3ca61b8d494980bbfe2a96fe6460a3e6508922ab17ab5e077488edf2d9eeaa73cf1db1ad15e77bd61b0a7fb8f885a1283112913c9a69bd4

data/.travis.yml

@@ -13,6 +13,10 @@ script:
   - bundle exec rake rubocop
   - bundle exec rake
   - bundle exec rake forked_tests
+  # remove this for now as it is flaky
+  # passes locally on 2.3.5 on travis passes sometimes on 2.4 and always on 2.6.1
+  #- bundle exec rake benchmarks:memory
+  - bundle exec rake benchmarks
 before_install:
   - echo 'this is a hack to clear default bundler and force bundler 1.17.3'
   - ls /home/travis/.rvm/gems/

data/Gemfile

@@ -6,5 +6,6 @@ source 'https://rubygems.org'
 gemspec
 gem 'rails', '~>5'
 # these gems are used for testing gem tracking
+gem 'irb', require: false
 gem 'pundit'
 gem 'rainbow', require: false

data/README.md

@@ -10,7 +10,6 @@
   <a href="#key-features">Key Features</a> •
   <a href="#installation">Installation</a> •
   <a href="#coverage-report">Coverage Report</a> •
-  <a href="#verify-correct-installation">Verify Correct Installation</a> •
   <a href="#advanced-config">Advanced Config</a> •
   <a href="#license">License</a> •
   <a href="/changes.md">Change Log / Roadmap</a>
@@ -29,7 +28,7 @@ The primary goal of Coverband is giving deep insight into your production runtim
 - Out of the box support for all standard code execution paths (web, cron, background jobs, rake tasks, etc)
 - Splits load time (Rails eager load) and Run time metrics
 - Easy to understand actionable insights from the report
-- Tracks Gem usage
+- Tracks Gem usage (still in experimental stages and not recommended for production)
 - Development mode, offers deep insight of code usage details (number of LOC execution during single request, etc) during development.
 - Mountable web interface to easily share reports
 
@@ -99,6 +98,8 @@ Rails.application.routes.draw do
 end
 ```
 
+or you can enable basic auth by setting `ENV['COVERBAND_PASSWORD']` or via your configuration `config.password = 'my_pass'`
+
 ### Coverband Web Endpoint
 
 The web endpoint is a barebones endpoint that you can either expose direct (after authentication) or you can just link to the actions you wish to expose. The index is intended as a example to showcase all the features.
@@ -108,8 +109,9 @@ The web endpoint is a barebones endpoint that you can either expose direct (afte
 > The web index as available on the Coverband Demo site
 
 - **force coverage collection:** This triggers coverage collection on the current webserver process
-- **reload Coverband files:** This has Coverband reload files as configured (force reload of some files that might not capture Coverage on boot). This can be used to reload files on demand.
 - **clear coverage report:** This will clear the coverage data. This wipes out all collected data (**dangerous**)
+- View individual file details
+- **clear individual file coverage:** This will clear the details of the file you are looking at. This is helpful if you don't want to loose all Coverage data but made a change that you expect would impact a particular file.
 
 ### Rake Tasks
 
@@ -254,7 +256,7 @@ By adding any files above you will get reporting on those files as part of your
 
 ### Collecting Gem / Library Usage
 
-__NOTE:__ Gem Tracking is still in testing stagings we have some performance issues on the reporting side and have heard reports of increased memory usage. We recommend deploying WITHOUT `track_gems` first and only enabling it after confirming that Coverband is working and performing well.
+__WARNING:__ Gem Tracking is still in experimental stages and not recommended for production. We have some performance issues when view reports on large applications. Gem tracing also during background thread data collection has HIGH memory requirements, during report merging (seemingly around 128mb of extra memory, which is crazy). We recommend deploying WITHOUT `track_gems` first and only enabling it after confirming that Coverband is working and performing well.
 
 Gem usage can be tracked by enabling the `track_gems` config.
 

data/Rakefile

@@ -6,7 +6,9 @@ require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-task default: %i[test benchmarks]
+task default: %i[test]
+
+task 'test:all': %i[rubocop test forked_tests benchmarks:memory benchmarks]
 
 task :test
 require 'rake/testtask'
@@ -27,7 +29,8 @@ end
 
 desc 'load irb with this gem'
 task :console do
-  exec 'irb -I lib -r coverband'
+  puts 'running console'
+  exec 'bundle exec console'
 end
 
 # This is really just for testing and development because without configuration

data/changes.md

@@ -78,20 +78,39 @@ Feature Ideas:
 
 ### Coverband 4.2.1
 
-- further improvements on eager_loading detection
-- fix on ignore configuration options
-- fix broken static server
-- fix issue where clear and coverage trigger coverage reports
-- improved logging
-- fix sorting of runtime coverage
-- add runtime coverage to gem summary pages
-- fix issue where reports didn't include files with 0 activity
-- add Oneshot coverage support for Ruby 2.6.0 thanks @zwalker
+- larger changes
+  - reduce memory usage
+  - fix issue where reports didn't include files with 0 activity
+  - updated runtime relavent lines and runtime percentages
+  - add Oneshot coverage support for Ruby 2.6.0 thanks @zwalker
    - I would consider this our test oneshot release, please report any issues
-- resolve regression on coverband rake tasks recording coverage
-- improved runtime / eager loading tracking
-- updated runtime relavent lines and runtime percentages
-- fix on gem runtime code coverage support, thanks @kbaum
+   - improved control over memory vs functionality
+     - oneshot support is the best memory and speed if you are on Ruby 2.6.*
+     - simulated_oneshot works for Ruby prior to 2.6.*, keeps lower runtime memory, at a trade of only being able to detect eager_load or runtime hits not both
+     - full hit tracking (The previous and current default), this uses more memory than other options, but provides full robust data
+
+
+- small changes fixes
+  - further improvements on eager_loading detection, thanks @kbaum
+  - fix on ignore configuration options
+  - fix broken static server
+  - fix issue where clear and coverage trigger coverage reports
+  - improved logging
+  - fix on gem runtime code coverage support, thanks @kbaum
+  - fix sorting of runtime coverage
+  - add runtime coverage to gem summary pages
+  - documented redis TTL, thanks @jjb
+  - resolve regression on coverband rake tasks recording coverage
+  - improved runtime / eager loading tracking
+  - fix on small memory leaks
+  - added warnings that gem tracking isn't production ready
+  - built in support for basic auth on the web rack app, thanks @jjb
+  - don't clobber rake environment method definition, thanks @shioyama
+  - readme improvements, thanks @yuriyalekseyev
+  - fix duplicate requires thanks @yuriyalekseyev
+  - various cleanups and improvements, thanks @kbaum
+  - additional benchmarks to ensure proper memory handling, thanks @kbaum
+  - default redis TTL, thanks @jjb
 
 
 # Released

data/lib/coverband.rb

@@ -23,16 +23,15 @@ require 'coverband/collectors/coverage'
 require 'coverband/reporters/base'
 require 'coverband/reporters/html_report'
 require 'coverband/reporters/console_report'
-require 'coverband/integrations/background'
-require 'coverband/integrations/rack_server_check'
 require 'coverband/reporters/web'
-require 'coverband/integrations/background_middleware'
 require 'coverband/integrations/background'
+require 'coverband/integrations/background_middleware'
+require 'coverband/integrations/rack_server_check'
 
 module Coverband
   @@configured = false
   CONFIG_FILE = './config/coverband.rb'
-  RUNTIME_TYPE = nil
+  RUNTIME_TYPE = :runtime
   EAGER_TYPE = :eager_loading
   MERGED_TYPE = :merged
   TYPES = [RUNTIME_TYPE, EAGER_TYPE]

data/lib/coverband/adapters/base.rb

@@ -4,26 +4,42 @@ module Coverband
   module Adapters
     class Base
       include Coverband::Utils::FilePathHelper
+
+      DATA_KEY = 'data'
+      FIRST_UPDATED_KEY = 'first_updated_at'
+      LAST_UPDATED_KEY = 'last_updated_at'
+      FILE_HASH = 'file_hash'
+      ABSTRACT_KEY = 'abstract'
+
       attr_accessor :type
 
       def initialize
         @file_hash_cache = {}
+        @type = Coverband::RUNTIME_TYPE
       end
 
       def clear!
-        raise 'abstract'
+        raise ABSTRACT_KEY
       end
 
-      def clear_file!(_file)
-        raise 'abstract'
+      def clear_file!(_file = nil)
+        raise ABSTRACT_KEY
       end
 
       def migrate!
-        raise 'abstract'
+        raise ABSTRACT_KEY
       end
 
       def size
-        raise 'abstract'
+        raise ABSTRACT_KEY
+      end
+
+      def save_coverage
+        raise ABSTRACT_KEY
+      end
+
+      def coverage(_local_type = nil)
+        raise ABSTRACT_KEY
       end
 
       def size_in_mib
@@ -36,14 +52,10 @@ module Coverband
       # and the tradeoff has always been acceptable
       def save_report(report)
         data = report.dup
-        data = merge_reports(data, get_report)
+        data = merge_reports(data, coverage)
         save_coverage(data)
       end
 
-      def coverage
-        get_report
-      end
-
       def get_coverage_report
         data = Coverband.configuration.store.split_coverage(Coverband::TYPES)
         data.merge(Coverband::MERGED_TYPE => Coverband.configuration.store.merged_coverage(Coverband::TYPES))
@@ -57,38 +69,44 @@ module Coverband
 
       def split_coverage(types)
         types.reduce({}) do |data, type|
-          data.update(type => get_report(type))
+          if type == Coverband::RUNTIME_TYPE && Coverband.configuration.simulate_oneshot_lines_coverage
+            data.update(type => simulated_runtime_coverage)
+          else
+            data.update(type => coverage(type))
+          end
         end
       end
 
-      def merged_coverage(types)
-        types.reduce({}) do |data, type|
-          merge_reports(data, get_report(type), skip_expansion: true)
+      def simulated_runtime_coverage
+        runtime_data = coverage(Coverband::RUNTIME_TYPE)
+        eager_data = coverage(Coverband::EAGER_TYPE)
+        eager_data.values do |vals|
+          vals['data'].map! { |line_coverage| line_coverage ? (0 - line_coverage) : line_coverage }
         end
+        merge_reports(runtime_data, eager_data, skip_expansion: true)
       end
 
-      def save_coverage
-        raise 'abstract'
-      end
-
-      def get_report(_type = nil)
-        raise 'abstract'
+      def merged_coverage(types)
+        types.reduce({}) do |data, type|
+          merge_reports(data, coverage(type), skip_expansion: true)
+        end
       end
 
       def file_hash(file)
         @file_hash_cache[file] ||= Digest::MD5.file(file).hexdigest
       end
 
+      # TODO: modify to extend report inline?
       def expand_report(report)
         expanded = {}
         report_time = Time.now.to_i
         updated_time = type == Coverband::EAGER_TYPE ? nil : report_time
         report.each_pair do |key, line_data|
           extended_data = {
-            'first_updated_at' => report_time,
-            'last_updated_at' => updated_time,
-            'file_hash' => file_hash(key),
-            'data' => line_data
+            FIRST_UPDATED_KEY => report_time,
+            LAST_UPDATED_KEY => updated_time,
+            FILE_HASH => file_hash(key),
+            DATA_KEY => line_data
           }
           expanded[full_path_to_relative(key)] = extended_data
         end
@@ -96,12 +114,16 @@ module Coverband
       end
 
       def merge_reports(new_report, old_report, options = {})
+        # transparently update from RUNTIME_TYPE = nil to RUNTIME_TYPE = :runtime
+        # transparent update for format coveband_3_2
+        old_report = coverage(nil, override_type: nil) if old_report.nil? && type == Coverband::RUNTIME_TYPE
+
         new_report = expand_report(new_report) unless options[:skip_expansion]
         keys = (new_report.keys + old_report.keys).uniq
         keys.each do |file|
           new_report[file] = if new_report[file] &&
                                 old_report[file] &&
-                                new_report[file]['file_hash'] == old_report[file]['file_hash']
+                                new_report[file][FILE_HASH] == old_report[file][FILE_HASH]
                                merge_expanded_data(new_report[file], old_report[file])
                              elsif new_report[file]
                                new_report[file]
@@ -114,15 +136,22 @@ module Coverband
 
       def merge_expanded_data(new_expanded, old_expanded)
         {
-          'first_updated_at' => old_expanded['first_updated_at'],
-          'last_updated_at' => new_expanded['last_updated_at'],
-          'file_hash' => new_expanded['file_hash'],
-          'data' => array_add(new_expanded['data'], old_expanded['data'])
+          FIRST_UPDATED_KEY => old_expanded[FIRST_UPDATED_KEY],
+          LAST_UPDATED_KEY => new_expanded[LAST_UPDATED_KEY],
+          FILE_HASH => new_expanded[FILE_HASH],
+          DATA_KEY => array_add(new_expanded[DATA_KEY], old_expanded[DATA_KEY])
         }
       end
 
+      # TODO: This should only be 2 cases get our dup / not dups aligned
       def array_add(latest, original)
-        latest.map.with_index { |v, i| (v && original[i]) ? v + original[i] : nil }
+        if Coverband.configuration.use_oneshot_lines_coverage
+          latest.map!.with_index { |v, i| (v + original[i] >= 1 ? 1 : 0) if v && original[i] }
+        elsif Coverband.configuration.simulate_oneshot_lines_coverage
+          latest.map.with_index { |v, i| (v + original[i] >= 1 ? 1 : 0) if v && original[i] }
+        else
+          latest.map.with_index { |v, i| (v && original[i]) ? v + original[i] : nil }
+        end
       end
     end
   end

data/lib/coverband/adapters/file_store.rb

@@ -28,6 +28,14 @@ module Coverband
         raise NotImplementedError, "FileStore doesn't support migrations"
       end
 
+      def coverage(_local_type = nil)
+        if File.exist?(path)
+          JSON.parse(File.read(path))
+        else
+          {}
+        end
+      end
+
       private
 
       attr_accessor :path
@@ -35,14 +43,6 @@ module Coverband
       def save_coverage(report)
         File.open(path, 'w') { |f| f.write(report.to_json) }
       end
-
-      def get_report(_local_type = nil)
-        if File.exist?(path)
-          JSON.parse(File.read(path))
-        else
-          {}
-        end
-      end
     end
   end
 end

data/lib/coverband/adapters/redis_store.rb

@@ -13,23 +13,31 @@ module Coverband
       ###
       REDIS_STORAGE_FORMAT_VERSION = 'coverband_3_2'
 
+      attr_reader :redis_namespace
+
       def initialize(redis, opts = {})
         super()
         @redis           = redis
         @ttl             = opts[:ttl]
         @redis_namespace = opts[:redis_namespace]
         @format_version  = REDIS_STORAGE_FORMAT_VERSION
+        @keys            = {}
+        Coverband::TYPES.each do |type|
+          @keys[type] = [@format_version, @redis_namespace, type].compact.join('.')
+        end
       end
 
       def clear!
         Coverband::TYPES.each do |type|
           @redis.del(type_base_key(type))
         end
+        # temporarily clear the old namespace of coverband_3_2
+        @redis.del(type_base_key(nil))
       end
 
       def clear_file!(filename)
         Coverband::TYPES.each do |type|
-          data = get_report(type)
+          data = coverage(type)
           data.delete(filename)
           save_coverage(data, type)
         end
@@ -47,7 +55,7 @@ module Coverband
       def migrate!
         reset_base_key
         @format_version = 'coverband3_1'
-        previous_data = get_report
+        previous_data = coverage
         if previous_data.empty?
           puts 'no previous data to migrate found'
           exit 0
@@ -58,7 +66,7 @@ module Coverband
         clear!
         reset_base_key
         @format_version = REDIS_STORAGE_FORMAT_VERSION
-        save_coverage(merge_reports(get_report, relative_path_report, skip_expansion: true))
+        save_coverage(merge_reports(coverage, relative_path_report, skip_expansion: true))
       end
 
       def type=(type)
@@ -66,6 +74,12 @@ module Coverband
         reset_base_key
       end
 
+      def coverage(local_type = nil, opts = {})
+        local_type ||= opts.key?(:override_type) ? opts[:override_type] : type
+        data = redis.get type_base_key(local_type)
+        data ? JSON.parse(data) : {}
+      end
+
       private
 
       attr_reader :redis
@@ -79,7 +93,7 @@ module Coverband
       end
 
       def type_base_key(local_type)
-        [@format_version, @redis_namespace, local_type].compact.join('.')
+        @keys[local_type]
       end
 
       def save_coverage(data, local_type = nil)
@@ -87,12 +101,6 @@ module Coverband
         redis.set type_base_key(local_type), data.to_json
         redis.expire(type_base_key(local_type), @ttl) if @ttl
       end
-
-      def get_report(local_type = nil)
-        local_type ||= type
-        data = redis.get type_base_key(local_type)
-        data ? JSON.parse(data) : {}
-      end
     end
   end
 end