oyencov 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04c350bbf1306fce55e708d2526c3a470fc332e4439c088e7622cd43cdf2cb89
-  data.tar.gz: 42218942c44d0f82127071bce83c9fa0ef5207d5e1a242b503144b7e5a656378
+  metadata.gz: 9a4f51c426c0d097999e548f0ba5920105655e1fbb04b731055573889239fb85
+  data.tar.gz: 57eee19f6e39579159c9175ee78faf3b8b7e6e40d8f1adb15fe85d325ee0c652
 SHA512:
-  metadata.gz: 1440c17139801da23ee1588134628c544524c2bbc2e1ef4be9584a3673d9618d3a3f69ba76c6bb98d072720281bd02e80032696802b420536c964ae0158ebd34
-  data.tar.gz: d24dd05b6f3b2a0d2caa0e65a3b0cf1cc803d6fdf6f6df1867cee8c2931751ce4f6ba949b15e2bd518e59ea4bfa35e82d9f959c841ef69effb59a6609b826860
+  metadata.gz: cf0d4fd53946d6fe3e43155a3dd9aa3dca94d81054a8b8b0789e29a3241cb26589f25e565fb0b31e4874ae5ec91f8e69c47defc275a4d2272259f4c8823ec7bf
+  data.tar.gz: 106e34406d36a110d79f21b536c0deaa304ff3ed927b100c7343917b5a6c4dbe0d05c70a400d84e69d2e97d5a7a918e3d1fa712474ca896a506c13d84f35dc45

data/lib/oyencov/api_connection.rb

@@ -27,7 +27,7 @@ module OyenCov
       begin
         response = get("/v1/data_submission_clearance")
 
-        if Hash === response.body && response.body["status"] == "ok"
+        if Hash === response.body # && response.body["status"] == "ok"
           response.body
         else
           false

data/lib/oyencov/background.rb

@@ -1,6 +1,7 @@
 require "securerandom"
 require "singleton"
 require_relative "api_connection"
+require_relative "controller_tracking"
 require_relative "coverage_peek_delta"
 require_relative "logger"
 
@@ -16,18 +17,29 @@ require_relative "logger"
 #
 module OyenCov
   class Background
+    # Added to be more fork-aware. Ruby/Puma can fork a process copy-on-write, 
+    #   but it won't start the threads that are running in the parent process.
+    # 
+    # If the PID > 0 but also not the current process_id, make the thread run.
+    @@running_pid = 0
+
     @loop_interval = 60 # seconds, can be set from server
-    @semaphore = Mutex.new
     @thread = nil
     @reporter = nil
     @api_conn = OyenCov::APIConnection.instance
     @config = OyenCov.config
 
     def self.start
+      if @@running_pid == $$
+        OyenCov::Logger.log("OyenCov Background thread is already running.")
+        return false
+      end
+
       OyenCov::Logger.log(<<~TXT)
         Env: #{@config.mode}
-        $PROGRAM_NAME: #{$PROGRAM_NAME || "nil"}
-        @process_type: #{@config.process_type}
+        program_name: #{$PROGRAM_NAME || "nil"}
+        process_type: #{@config.process_type}
+        release/git_commit_sha: #{@config.release}
         Env vars set: #{ENV.keys.grep(/^OYENCOV_/)}
       TXT
 
@@ -43,7 +55,7 @@ module OyenCov
           clearance = @api_conn.get_data_submission_clearance
 
           unless clearance && clearance["status"] == "ok"
-            OyenCov::Logger.log "Unable to obtain oyencov submission clearance. Stopping OyenCov background thread."
+            OyenCov::Logger.log "Unable to obtain oyencov submission clearance. Stopping OyenCov background thread. #{clearance.inspect}"
             Thread.stop
           end
 
@@ -77,6 +89,7 @@ module OyenCov
             OyenCov::Logger.log "POST runtime_report ok."
           else
             OyenCov::Logger.log "POST runtime_report failed. Stopping background thread."
+            @@running_pid = 0
             Thread.stop
           end
 
@@ -85,6 +98,8 @@ module OyenCov
       }
 
       @thread.run
+      OyenCov::Logger.log("OyenCov Background thread starts.")
+      @@running_pid = $$
 
       nil
     end
@@ -93,6 +108,7 @@ module OyenCov
     # For `test`, persist controller report.
     def self.stop
       @thread.stop
+      @@running_pid = 0
     end
 
     private_class_method

data/lib/oyencov/cli.rb

@@ -82,11 +82,9 @@ module OyenCov
           "git_commit_sha" => options[:git_commit_sha]
         })
 
-      # puts JSON.pretty_generate(collated_report)
-
-      # Add metadaata
-
-      ENV["OYENCOV_API_KEY"] ||= options[:token]
+      if options[:token]
+        ENV["OYENCOV_API_KEY"] = options[:token]
+      end
       unless ENV["OYENCOV_API_KEY"]
         warn "API token not set. Unable to submit."
         exit(1)

data/lib/oyencov/configuration.rb

@@ -42,7 +42,7 @@ module OyenCov
 
     # Lots of ideas came from sentry-ruby, thanks to nate berkopec.
     def suggest_release
-      release = `git rev-parse HEAD ||:`.strip
+      release = `git rev-parse HEAD 2>/dev/null || true`.strip
 
       if release == "" || release.nil?
         [".source_version", "REVISION"].each do |version_clue|
@@ -52,7 +52,8 @@ module OyenCov
             Bundler.root.join(version_clue)
           elsif defined?(Pathname.pwd) && Pathname.pwd
             Pathname.pwd.join(version_clue)
-          else next
+          else
+            next
           end
 
           if File.exist?(version_clue_path)
@@ -85,10 +86,13 @@ module OyenCov
         end
       end
 
-      if /^puma/.match?($PROGRAM_NAME)
-        if defined?(Rails)
-          return "rails-server"
-        end
+      # If its cluster mode & we are in worker process, puma is at the beginning.
+      # If it's `bundle exec puma` then it comes in the end
+      #
+      # If it's booted up by puma not rails server, `Rails` module wont be defined.
+      # We will just assume puma = rails-server
+      if /^puma/.match?($0) || sliced_program_name == "puma"
+        return "rails-server"
       end
 
       # Rails can be server or rake task

data/lib/oyencov/logger.rb

@@ -12,7 +12,7 @@ module OyenCov
       if Exception === msg
         msg = msg.inspect
       end
-      formatted_msg = msg.split("\n").map { |m| "#{ORANGE_TEXT}[OyenCov] #{m}#{RESET_COLOR}" }.join("\n")
+      formatted_msg = msg.split("\n").map { |m| "#{ORANGE_TEXT}[OyenCov] PID##{$$} #{m}#{RESET_COLOR}" }.join("\n")
 
       if level == 2
         warn formatted_msg

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

@@ -2,15 +2,30 @@ require "puma/plugin"
 require_relative "../../background"
 require_relative "../../logger"
 
-Puma::Plugin.create do
+defined?(Puma::Plugin.create) && 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_booted do
+      OyenCov::Logger.log("Puma::Plugin.create config on_booted called")
+      OyenCov::Background.start
+      if defined?(Rails::Railtie)
+        load(File.expand_path("../../railtie.rb", File.dirname(__FILE__)))
+      else
+        OyenCov::Logger.log("on_booted: Railtie undefined 😭")
+      end
+    end
+
     c.on_worker_boot do
       OyenCov::Logger.log("Puma::Plugin.create config on_worker_boot called")
       OyenCov::Background.start
+      if defined?(Rails::Railtie)
+        load(File.expand_path("../../railtie.rb", File.dirname(__FILE__)))
+      else
+        OyenCov::Logger.log("on_worker_boot: Railtie undefined 😭")
+      end
     end
   end
 end

data/lib/oyencov/railtie.rb

@@ -5,6 +5,9 @@ require_relative "logger"
 
 module OyenCov
   class Railtie < Rails::Railtie
+    @@controller_tracker_notification = nil
+
+    # This is only useful when `rails s` is run in lieu of webserver command first.
     def install_puma_hooks
       return unless defined?(Puma)
       OyenCov::Logger.log("Puma defined, installing puma hooks")
@@ -15,7 +18,7 @@ module OyenCov
         OyenCov::Logger.log("Load errors: #{e}")
       end
 
-      # # Cluster mode
+      # Cluster mode
       if defined?(Puma::Plugin)
         OyenCov::Logger.log("Puma::Plugin defined, installing hooks for CLUSTER MODE")
         require_relative "puma/plugin/oyencov"
@@ -25,12 +28,14 @@ module OyenCov
     initializer "oyencov.configure" do
       OyenCov::Background.start
       install_puma_hooks
-    end
 
-    config.after_initialize do
-      OyenCov::Logger.log("lib/oyencov/railtie.rb config.after_initialize")
+      if @@controller_tracker_notification.nil?
+        OyenCov::Logger.log "@@controller_tracker_notification is nil"
+      else
+        OyenCov::Logger.log "@@controller_tracker_notification is already set, Railtie init rerun."
+      end
 
-      ActiveSupport::Notifications.subscribe("start_processing.action_controller") do |name, start, finish, id, payload|
+      @@controller_tracker_notification ||= ActiveSupport::Notifications.subscribe("start_processing.action_controller") do |name, start, finish, id, payload|
         ControllerTracking.bump("#{payload[:controller]}##{payload[:action]}")
         OyenCov::Logger.log "ControllerTracking.bump(#{payload[:controller]}##{payload[:action]})"
       end

data/lib/oyencov/version.rb

@@ -1,3 +1,3 @@
 module OyenCov
-  VERSION = "0.0.8".freeze
+  VERSION = "0.0.10".freeze
 end

data/lib/oyencov.rb

@@ -3,17 +3,33 @@ require_relative "oyencov/simplecov_resultset_translator"
 require_relative "oyencov/version"
 require_relative "oyencov/logger"
 
-# For now, support only Rails. We bootstrap from Railtie.
+# For now, support only Rails. We bootstrap background thread and controller tracking from Railtie.
 module OyenCov
   def self.config
     @config ||= OyenCov::Configuration.new
   end
 
+  # Sometimes oyencov cant start on their own, maybe when oyencov is loaded
+  #   before Rails did.
+  #
+  # For Rails, put `OyenCov.start!` in `config/initializers/oyencov.rb`.
+  def self.start!
+    require_relative "oyencov/railtie"
+  end
+
   OyenCov::Logger.log("Hello! Booting from #{__FILE__}")
-  
-  OyenCov::Logger.log("Checking Rails existence")
+  OyenCov::Logger.log("Checking/Forcing Rails existence")
+
+  begin
+    require "rails"
+  rescue LoadError
+    # do nothing
+  end
+
   if defined?(Rails::Railtie) # && ENV["OYENCOV_API_KEY"]
-    OyenCov::Logger.log("Starting Railtie")
+    OyenCov::Logger.log("Rails::Railtie already present, starting oyencov/railtie")
     require_relative "oyencov/railtie"
+  else
+    OyenCov::Logger.log("Rails::Railtie absent, cannot start tracking & reporting yet.")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oyencov
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - Anonoz Chong
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday