oyencov 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9619610f6cb878e1b7cd8729db4fe34785fce3e467b286bef49856715ca45cf5
-  data.tar.gz: 35ca4fc3632905729f2be3d828f5ee9430b0a5d8c78ef5cc33564a4ebb11674a
+  metadata.gz: c88552b88f48f6474413438e3b4043802ead52f3db1b9d26642468f361dc15cc
+  data.tar.gz: 9e5244ef06ef4d24911ac0e86d58986bb36de6b2f660b0412e93f3e8a08f9014
 SHA512:
-  metadata.gz: 683e8bade439c6f5a20e635a64cbd28c9f3655bc952c3001706567c01f7f0a97cfdd8427e3a3141869e743cd0313ce7731d41c204b88624368b18f557fdac12e
-  data.tar.gz: 99abe33fd7b0e80bc0674e1fbe8c53c19af45a3951ac7cbcceb99b1c0fca1d5576adb176f30d156fee9974f9627609854930a30f0ee59b1e7a5a05127c994599
+  metadata.gz: 8a50ad8ce049257eb6f6c93f3316cc59efaefcf1f2fcace72bd5d072d4e3c123bc4dafd2c1f8e974bc72d1ecf0786dda47ef2aa144d9ee446e8e6832721ba049
+  data.tar.gz: a95d62de2c84555c2935f826271f09473ebf85f77c041f32823724d091b7b149035976f5ca3a4c5f451950d81b79ea74d626c2185d6fdf08de403ce51f67ed71

data/lib/oyencov/api_connection.rb

@@ -1,6 +1,7 @@
 require "faraday"
 require "singleton"
 require_relative "version"
+require_relative "logger"
 
 module OyenCov
   class APIConnection < Faraday::Connection
@@ -26,9 +27,7 @@ module OyenCov
       begin
         response = get("/v1/data_submission_clearance")
       rescue Faraday::Error => e
-        if ENV["OYENCOV_DEBUG"]
-          warn(e)
-        end
+        OyenCov::Logger.log(e, 2)
 
         if attempts > 0
           attempts -= 1

data/lib/oyencov/background.rb

@@ -2,6 +2,7 @@ require "securerandom"
 require "singleton"
 require_relative "api_connection"
 require_relative "coverage_peek_delta"
+require_relative "logger"
 
 # Bootstrap the thread that starts Coverage module data collection.
 #
@@ -23,11 +24,12 @@ module OyenCov
     @config = OyenCov.config
 
     def self.start
-      if ENV["OYENCOV_DEBUG"]
-        puts "[OyenCov] Env: #{Rails.env}"
-        puts "[OyenCov] $PROGRAM_NAME: #{$PROGRAM_NAME || "nil"}"
-        puts "[OyenCov] @process_type: #{@config.process_type}"
-      end
+      OyenCov::Logger.log(<<~TXT)
+        Env: #{@config.mode}
+        $PROGRAM_NAME: #{$PROGRAM_NAME || "nil"}
+        @process_type: #{@config.process_type}
+        Env vars set: #{ENV.keys.grep(/^OYENCOV_/)}
+      TXT
 
       # Start `Coverage` as soon as possible before other codes are loaded
       CoveragePeekDelta.start
@@ -41,35 +43,41 @@ module OyenCov
           clearance = @api_conn.get_data_submission_clearance
 
           if clearance.nil?
-            puts "[OyenCov] Unable to obtain oyencov submission clearance. Stopping OyenCov background thread."
+            OyenCov::Logger.log "Unable to obtain oyencov submission clearance. Stopping OyenCov background thread."
             Thread.stop
           end
 
-          if ENV["OYENCOV_DEBUG"]
-            puts(clearance.body)
-          end
+          # OyenCov::Logger.log("clearance.body:-\n" + clearance.body)
         end
 
         @config.mode == "production" && loop do
           sleep(@loop_interval + 3 - rand(6))
           new_method_hits = CoveragePeekDelta.snapshot_delta
+          OyenCov::Logger.log "ControllerTracking.hits = #{ControllerTracking.hits}"
           new_controller_hits = ControllerTracking.snapshot_and_reset!
 
-          puts new_method_hits
-
           runtime_report = {
-            git_commit_sha: @config.release,
             controller_action_hits: new_controller_hits,
             method_hits: new_method_hits
           }
+
+          unless runtime_report.values.any?(&:any?)
+            OyenCov::Logger.log("All #{runtime_report.keys.join(", ")} are empty. Skipping submission.")
+            next
+          end
+
+          runtime_report[:git_commit_sha] = @config.release
+
           response = @api_conn.post_runtime_report(runtime_report)
 
           if response && response.body["status"] == "ok"
-            puts "[OyenCov] POST runtime_report ok."
+            OyenCov::Logger.log "POST runtime_report ok."
           else
-            warn "[OyenCov] POST runtime_report failed. Stopping background thread."
+            OyenCov::Logger.log "POST runtime_report failed. Stopping background thread."
             Thread.stop
           end
+
+          # TODO: Set new interval & wiggle.
         end # loop
       }
 

data/lib/oyencov/cli.rb

@@ -2,6 +2,7 @@ require "thor"
 require_relative "api_connection"
 require_relative "test_report_merger"
 require_relative "simplecov_resultset_translator"
+require_relative "logger"
 
 # Bootstrapped from `bin/oyencov`
 #
@@ -63,17 +64,17 @@ module OyenCov
 
     desc "submit tmp/coverage-jsons-*/oyencov-resultset.json",
       "submits the oyencov resultsets data"
-    option :files, type: :array, required: true
+    option :files, type: :array, default: ["coverage/oyencov-resultset.json"]
     option :git_commit_sha, required: true
     option :token
     def submit
       resultset_files = options[:files]
-      ENV["OYENCOV_DEBUG"] && if resultset_files.any?
-                                puts "Found #{resultset_files.join(", ")}"
-                              else
-                                puts "No resultset files found"
-                                exit 1
-                              end
+      if resultset_files.any?
+        OyenCov::Logger.log "Found #{resultset_files.join(", ")}"
+      else
+        puts "No resultset files found"
+        exit 1
+      end
 
       collated_report = OyenCov::TestReportMerger
         .collate_job_reports(options[:files])

data/lib/oyencov/configuration.rb

@@ -13,7 +13,7 @@ module OyenCov
       PROGRAM_NAME
     ]
 
-    attr :api_key, :api_url, :mode, :including_file_paths, :excluding_file_paths, :release, :test_reporting_dir, :test_resultset_path, :program_name, :process_type
+    attr_reader :api_key, :api_url, :mode, :including_file_paths, :excluding_file_paths, :release, :test_reporting_dir, :test_resultset_path, :program_name, :process_type
 
     def initialize
       reset_to_defaults
@@ -60,7 +60,6 @@ module OyenCov
     #
     # Method 1: $PROGRAM_NAME.split("/")[-1]
     def suggest_process_type
-      answer = nil
       sliced_program_name = File.basename($PROGRAM_NAME)
 
       if %w[sidekiq resque].include?(sliced_program_name)

data/lib/oyencov/controller_tracking.rb

@@ -1,21 +1,33 @@
+require_relative "logger"
+
 # This module is merely the container data structure.
 #
 # The ACTUAL code that tracks controller is in `railtie.rb`
 module OyenCov
   module ControllerTracking
-    @hits = {}
+    @@hits = {}
+
+    def self.hits
+      @@hits
+    end
 
     def self.bump(controller_action_name)
-      if @hits[controller_action_name]
-        @hits[controller_action_name] += 1
+      if @@hits[controller_action_name]
+        @@hits[controller_action_name] += 1
       else
-        @hits[controller_action_name] = 1
+        @@hits[controller_action_name] = 1
       end
+
+      OyenCov::Logger.log "ControllerTracking.bump self.object_id = #{object_id}"
+      OyenCov::Logger.log "ControllerTracking.bump @@hits[#{controller_action_name}] = #{@@hits[controller_action_name]}"
     end
 
     def self.snapshot_and_reset!
-      current_hits = @hits
-      @hits = {}
+      OyenCov::Logger.log "ControllerTracking.snapshot_and_reset! self.object_id = #{object_id}"
+      OyenCov::Logger.log "ControllerTracking.snapshot_and_reset! @@hits = #{@@hits}"
+
+      current_hits = @@hits.dup
+      @@hits = {}
       current_hits
     end
   end

data/lib/oyencov/coverage_peek_delta.rb

@@ -1,5 +1,6 @@
 require "coverage"
 require_relative "method_range_parser"
+require_relative "logger"
 
 # `CoveragePeekDelta` utility is meant to take...
 #
@@ -28,9 +29,7 @@ module OyenCov
     def self.snapshot_delta
       current_peek = Coverage.peek_result
 
-      if ENV["OYENCOV_DEBUG"]
-        $stdout.puts "current_peek size = #{current_peek.size}, keys like: #{current_peek.keys[0, 3]}"
-      end
+      # OyenCov::Logger.log "1st current_peek size = #{current_peek.size}, keys like: #{current_peek.keys[0, 3]}"
 
       # Filter into project
       filtered = current_peek.select do |k, _|
@@ -39,18 +38,14 @@ module OyenCov
         k.gsub(/#{PWD}\//o, "")
       end
 
-      if ENV["OYENCOV_DEBUG"]
-        $stdout.puts "filtered size = #{filtered.size}, keys like: #{filtered.keys[0, 3]}"
-      end
+      # OyenCov::Logger.log "2nd filtered size = #{filtered.size}, keys like: #{filtered.keys[0, 3]}"
 
       # Filter inside project to just the paths
       filtered = filtered.select do |k, _|
         /^(app|lib)/.match?(k)
       end
 
-      if ENV["OYENCOV_DEBUG"]
-        $stdout.puts "filtered size = #{filtered.size}, keys like: #{filtered.keys[0, 3]}"
-      end
+      # OyenCov::Logger.log "3rd filtered size = #{filtered.size}, keys like: #{filtered.keys[0, 3]}"
 
       # Find the method ranges, set
       current_method_hits = {}

data/lib/oyencov/logger.rb

@@ -0,0 +1,24 @@
+module OyenCov
+  module Logger
+    # ANSI escape code for orange text
+    ORANGE_TEXT = "\e[38;5;214m"
+    RESET_COLOR = "\e[0m"
+
+    # Level 0 = stdout for common users
+    # Level 1 = debug stdout
+    # Level 2 = debug stderr
+    def self.log(msg, level = 1)
+      return unless ENV["OYENCOV_DEBUG"] || level == 0
+      if Exception === msg
+        msg = msg.inspect
+      end
+      formatted_msg = msg.split("\n").map { |m| "#{ORANGE_TEXT}[OyenCov] #{m}#{RESET_COLOR}" }.join("\n")
+
+      if level == 2
+        warn formatted_msg
+      else
+        puts formatted_msg
+      end
+    end
+  end
+end

data/lib/oyencov/puma/plugin/oyencov.rb

@@ -0,0 +1,16 @@
+require "puma/plugin"
+require_relative "../../background"
+require_relative "../../logger"
+
+Puma::Plugin.create do
+  OyenCov::Logger.log("Puma::Plugin.create running...")
+
+  def config(c)
+    OyenCov::Logger.log("Puma::Plugin.create config(c) running...")
+
+    c.on_worker_boot do
+      OyenCov::Logger.log("Puma::Plugin.create config on_worker_boot called")
+      OyenCov::Background.start
+    end
+  end
+end

data/lib/oyencov/railtie.rb

@@ -1,24 +1,43 @@
 require_relative "background"
 require_relative "controller_tracking"
 require_relative "test_reporting"
+require_relative "logger"
 
 module OyenCov
   class Railtie < Rails::Railtie
+    def install_puma_hooks
+      return unless defined?(Puma)
+      OyenCov::Logger.log("Puma defined, installing puma hooks")
+
+      begin
+        require "puma/plugin"
+      rescue LoadError => e
+        OyenCov::Logger.log("Load errors: #{e}")
+      end
+
+      # # Cluster mode
+      if defined?(Puma::Plugin)
+        OyenCov::Logger.log("Puma::Plugin defined, installing hooks for CLUSTER MODE")
+        require_relative "puma/plugin/oyencov"
+      end
+    end
+
     initializer "oyencov.configure" do
-      # puts "lib/oyencov/railtie.rb initializer oyencov.configure"
       OyenCov::Background.start
+      install_puma_hooks
     end
 
     config.after_initialize do
-      !!ENV["OYENCOV_DEBUG"] && puts("lib/oyencov/railtie.rb config.after_initialize")
+      OyenCov::Logger.log("lib/oyencov/railtie.rb config.after_initialize")
+
       ActiveSupport::Notifications.subscribe("start_processing.action_controller") do |name, start, finish, id, payload|
-        # puts(payload)
         ControllerTracking.bump("#{payload[:controller]}##{payload[:action]}")
+        OyenCov::Logger.log "ControllerTracking.bump(#{payload[:controller]}##{payload[:action]})"
       end
 
       if OyenCov.config.mode == "test"
         at_exit do
-          !!ENV["OYENCOV_DEBUG"] && puts("[OyenCov] Testing mode, persisting rails controller action data.")
+          OyenCov::Logger.log("Testing mode, persisting rails controller action data.")
           OyenCov::TestReporting.persist_controller_actions!
         end
       end

data/lib/oyencov/simplecov_resultset_translator.rb

@@ -36,7 +36,7 @@ module OyenCov
       all_methods_hits = resultset[resultset.keys[0]]["coverage"].each_pair.map do |file_path, file_attr|
         # file_path = file_path.gsub(/#{PWD}\//o, "")
         line_hits = file_attr["lines"]
-        methods_hits = MethodRangeParser[file_path]&.each_pair&.map do |method_name, line_num|
+        MethodRangeParser[file_path]&.each_pair&.map do |method_name, line_num|
           next if line_num.nil? || line_hits[line_num].nil?
           [method_name, line_hits[line_num]]
         end&.compact.to_h

data/lib/oyencov/version.rb

@@ -1,3 +1,3 @@
 module OyenCov
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.4".freeze
 end

data/lib/oyencov.rb

@@ -1,6 +1,7 @@
 require_relative "oyencov/configuration"
 require_relative "oyencov/simplecov_resultset_translator"
 require_relative "oyencov/version"
+require_relative "oyencov/logger"
 
 # For now, support only Rails. We bootstrap from Railtie.
 module OyenCov
@@ -8,9 +9,9 @@ module OyenCov
     @config ||= OyenCov::Configuration.new
   end
 
-  !!ENV["OYENCOV_DEBUG"] && puts("[OyenCov] Checking Rails existence")
+  OyenCov::Logger.log("Checking Rails existence")
   if defined?(Rails::Railtie) # && ENV["OYENCOV_API_KEY"]
-    puts "[OyenCov] Starting Railtie"
+    OyenCov::Logger.log("Starting Railtie")
     require_relative "oyencov/railtie"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oyencov
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Anonoz Chong
@@ -35,78 +35,84 @@ cert_chain:
   K18ySnv/ePkrL7AJhCgkP4tlJvrBvWnt30OuFfFf4K64ja+Hgqren8UabRQGIzn+
   JcaIEQ0pXyjnNFwGBhHBjPXKHvRYuw/LNUPXBmP/k1a0WY6H
   -----END CERTIFICATE-----
-date: 2023-11-10 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.20'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.33'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.33'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -133,15 +139,23 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: Runtime and test reporters.
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |2
+      OyenCov is a service that measures usage-weighted test coverage by
+      profiling the codebase line executions in production runtime.
 email: anonoz@oyencov.com
 executables:
 - oyencov
@@ -156,7 +170,9 @@ files:
 - lib/oyencov/configuration.rb
 - lib/oyencov/controller_tracking.rb
 - lib/oyencov/coverage_peek_delta.rb
+- lib/oyencov/logger.rb
 - lib/oyencov/method_range_parser.rb
+- lib/oyencov/puma/plugin/oyencov.rb
 - lib/oyencov/railtie.rb
 - lib/oyencov/simplecov_resultset_translator.rb
 - lib/oyencov/test_report_merger.rb
@@ -164,9 +180,13 @@ files:
 - lib/oyencov/version.rb
 homepage: https://www.oyencov.com
 licenses:
-- MIT
+- Nonstandard
 metadata:
+  homepage_uri: https://www.oyencov.com
   source_code_uri: https://github.com/oyencov/sdk-ruby
+  documentation_uri: https://docs.oyencov.com/category/ruby-on-rails
+  changelog_uri: https://github.com/oyencov/sdk-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/oyencov/sdk-ruby/issues
 post_install_message:
 rdoc_options: []
 require_paths: