specwrk 0.4.11 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e85bdff31c7f1312b12a9a823200a5da5b36653433496556cc1bce274a3dc90a
-  data.tar.gz: fa73aebb69753d7b528d333f2fca589e0e5525bd12b71e4c5b7815df0932b9a1
+  metadata.gz: bf78cf2d1c82bc0878e1e89777eb8de0ab04af441e210c64a15c2bad1277c1fa
+  data.tar.gz: 3701d6f676e4c31c3fb787f4ca59a8aaa7aa412118371470b069471da4e6c933
 SHA512:
-  metadata.gz: 9467744c0cd676bdeb312b3f1deb4190113601cb01bb9ce939acdfa1c6170897904f3125b43c90dde536459ed56b2623be132bfeed84725c1f6b098ea65ae6a9
-  data.tar.gz: f8cd7800b9f117567c1aa53404f2ca7f9a99a907c4b46c1c05da34d7534a2743c68960c50ffd9555de82430f582cb6a042a70579e4a8a44f53dea136f72cd8ae
+  metadata.gz: debda5ab7128ae03e74652196da8783b4d78ddf3648ccfd2c3e62104fe8a3fb87b98abbc68deb7d66565d66474a504a8d778ca0de44eef311e14188a4258f856
+  data.tar.gz: 1a4089b567a0840f91a133fef5580b6c5bd3c43190eb7cd1156fe3439e042f727b62bdf69ee1624815ac741f738907e43c92559be1f4c4d55268b2db1625b074

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 ## [Unreleased]
 
+## v0.4.11
+
+- Move logic out of CLI methods ([#64](https://github.com/danielwestendorf/specwrk/issues/64)) by @danielwestendorf  
+- Add thruster in front of puma ([#65](https://github.com/danielwestendorf/specwrk/issues/65)) by @danielwestendorf  
+- Revise heartbeats logic ([#66](https://github.com/danielwestendorf/specwrk/issues/66)) by @danielwestendorf  
+
+## v0.4.9
+
+- Remove single-run env var (it was not what I wanted) by @danielwestendorf  
+
+## v0.4.8
+
+- Fix `config.ru` by @danielwestendorf  
+
+## v0.4.7
+
+- Switch to Puma for the Docker image (#59) by @danielwestendorf  
+
+## v0.4.6
+
+- Nil env var that will prevent start command from completing ([#56](https://github.com/danielwestendorf/specwrk/issues/56)) by @danielwestendorf  
+- Better handling of seed failing ([#57](https://github.com/danielwestendorf/specwrk/issues/57)) by @danielwestendorf  
+- Silence health logging ([#58](https://github.com/danielwestendorf/specwrk/issues/58)) by @danielwestendorf  
+- Add missing CCI caching of `report.json` ([#55](https://github.com/danielwestendorf/specwrk/issues/55)) by @danielwestendorf  
+- Add CircleCI examples ([#50](https://github.com/danielwestendorf/specwrk/issues/50)) by @danielwestendorf  
+- Better GHA Examples ([#49](https://github.com/danielwestendorf/specwrk/issues/49)) by @danielwestendorf  
+- Skip key lookup and rely on the result of `Hash#delete` instead by @danielwestendorf  
+
 ## v0.4.5
 
 - Set ENV var when generating seed examples [#47](https://github.com/danielwestendorf/specwrk/issues/47). by @danielwestendorf 

data/README.md

@@ -129,7 +129,7 @@ Description:
   Start one or more worker processes
 
 Options:
-  --id=VALUE                        # The identifier for this worker. Default specwrk-worker(-COUNT_INDEX), default: "specwrk-worker"
+  --id=VALUE                        # The identifier for this worker. Overrides SPECWRK_ID. If none provided one in the format of specwrk-worker-8_RAND_CHARS-COUNT_INDEX will be used
   --count=VALUE, -c VALUE           # The number of worker processes you want to start, default: 1
   --output=VALUE, -o VALUE          # Directory where worker output is stored. Overrides SPECWRK_OUT, default: ".specwrk/"
   --seed-waits=VALUE, -w VALUE      # Number of times the worker will wait for examples to be seeded to the server. 1sec between attempts. Overrides SPECWRK_SEED_WAITS, default: "10"

data/lib/specwrk/cli.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "pathname"
+require "securerandom"
 
 require "dry/cli"
 
@@ -33,14 +34,15 @@ module Specwrk
       extend Hookable
 
       on_included do |base|
-        base.unique_option :id, type: :string, default: "specwrk-worker", desc: "The identifier for this worker. Default specwrk-worker(-COUNT_INDEX)"
+        base.unique_option :id, type: :string, desc: "The identifier for this worker. Overrides SPECWRK_ID. If none provided one in the format of specwrk-worker-8_RAND_CHARS-COUNT_INDEX will be used"
         base.unique_option :count, type: :integer, default: 1, aliases: ["-c"], desc: "The number of worker processes you want to start"
         base.unique_option :output, type: :string, default: ENV.fetch("SPECWRK_OUT", ".specwrk/"), aliases: ["-o"], desc: "Directory where worker output is stored. Overrides SPECWRK_OUT"
         base.unique_option :seed_waits, type: :integer, default: ENV.fetch("SPECWRK_SEED_WAITS", "10"), aliases: ["-w"], desc: "Number of times the worker will wait for examples to be seeded to the server. 1sec between attempts. Overrides SPECWRK_SEED_WAITS"
       end
 
-      on_setup do |id:, count:, output:, seed_waits:, **|
-        ENV["SPECWRK_ID"] = id
+      on_setup do |count:, output:, seed_waits:, id: "specwrk-worker-#{SecureRandom.uuid[0, 8]}", **|
+        ENV["SPECWRK_ID"] ||= id # Unique default. Don't override the ENV value here
+
         ENV["SPECWRK_COUNT"] = count.to_s
         ENV["SPECWRK_SEED_WAITS"] = seed_waits.to_s
         ENV["SPECWRK_OUT"] = Pathname.new(output).expand_path(Dir.pwd).to_s
@@ -115,6 +117,8 @@ module Specwrk
 
         Client.wait_for_server!
         Client.new.seed(examples)
+        file_count = examples.group_by { |e| e[:file_path] }.keys.size
+        puts "🌱 Seeded #{examples.size} examples across #{file_count} files"
       rescue Errno::ECONNREFUSED
         puts "Server at #{ENV.fetch("SPECWRK_SRV_URI", "http://localhost:5138")} is refusing connections, exiting...#{ENV["SPECWRK_FLUSH_DELIMINATOR"]}"
         exit 1

data/lib/specwrk/cli_reporter.rb

@@ -11,7 +11,10 @@ require "rspec/core/formatters/console_codes"
 module Specwrk
   class CLIReporter
     def report
-      return 1 unless Client.connect?
+      unless Client.connect?
+        puts colorizer.wrap("\nCannot connect to server to generate report. Assuming failure.", :red)
+        return 1
+      end
 
       puts "\nFinished in #{total_duration} " \
                           "(total execution time of #{total_run_time})\n"
@@ -28,8 +31,11 @@ module Specwrk
         puts colorizer.wrap(totals_line, :green)
         0
       end
-    rescue Specwrk::UnhandledResponseError
-      puts colorizer.wrap("No examples run.", :red)
+    rescue Specwrk::UnhandledResponseError => e
+      puts colorizer.wrap("\nCannot report, #{e.message}.", :red)
+
+      client.shutdown
+
       1
     end
 
@@ -43,28 +49,28 @@ module Specwrk
       summary
     end
 
-    def stats
-      @stats ||= client.stats
+    def report_data
+      @report_data ||= client.report
     end
 
     def total_duration
-      Time.parse(stats.dig(:completed, :meta, :last_finished_at)) - Time.parse(stats.dig(:completed, :meta, :first_started_at))
+      Time.parse(report_data.dig(:meta, :last_finished_at)) - Time.parse(report_data.dig(:meta, :first_started_at))
     end
 
     def total_run_time
-      stats.dig(:completed, :meta, :total_run_time)
+      report_data.dig(:meta, :total_run_time)
     end
 
     def failure_count
-      stats.dig(:completed, :meta, :failures)
+      report_data.dig(:meta, :failures)
     end
 
     def pending_count
-      stats.dig(:completed, :meta, :pending)
+      report_data.dig(:meta, :pending)
     end
 
     def example_count
-      stats.dig(:completed, :examples).length
+      report_data.dig(:examples).length
     end
 
     def client

data/lib/specwrk/client.rb

@@ -62,8 +62,8 @@ module Specwrk
       response.code == "200"
     end
 
-    def stats
-      response = get "/stats"
+    def report
+      response = get "/report"
 
       if response.code == "200"
         JSON.parse(response.body, symbolize_names: true)
@@ -150,7 +150,9 @@ module Specwrk
 
     def default_headers
       @default_headers ||= {}.tap do |h|
+        h["User-Agent"] = "Specwrk/#{VERSION}"
         h["Authorization"] = "Bearer #{ENV["SPECWRK_SRV_KEY"]}" if ENV["SPECWRK_SRV_KEY"]
+        h["X-Specwrk-Id"] = ENV.fetch("SPECWRK_ID", "specwrk-client")
         h["X-Specwrk-Run"] = ENV["SPECWRK_RUN"] if ENV["SPECWRK_RUN"]
         h["Content-Type"] = "application/json"
       end

data/lib/specwrk/queue.rb

@@ -6,7 +6,11 @@ require "json"
 module Specwrk
   # Thread-safe Hash access
   class Queue
+    attr_reader :created_at
+
     def initialize(hash = {})
+      @created_at = Time.now
+
       if block_given?
         @mutex = Monitor.new # Reentrant locking is required here
         # It's possible to enter the proc from two threads, so we need to ||= in case
@@ -40,8 +44,6 @@ module Specwrk
   end
 
   class PendingQueue < Queue
-    attr_reader :previous_run_times
-
     def shift_bucket
       return bucket_by_file unless previous_run_times
 
@@ -59,17 +61,22 @@ module Specwrk
       previous_run_times.dig(:meta, :average_run_time)
     end
 
-    # TODO: move reading the file to the getter method
-    def previous_run_times_file=(path)
-      return unless path
-      return unless File.exist? path
+    def previous_run_times
+      return unless ENV["SPECWRK_OUT"]
 
-      File.open(path, "r") do |file|
-        file.flock(File::LOCK_EX)
+      @previous_run_times ||= begin
+        return unless previous_run_times_file_path
+        return unless File.exist? previous_run_times_file_path
 
-        @previous_run_times = JSON.parse(file.read, symbolize_names: true)
+        raw_data = File.open(previous_run_times_file_path, "r") do |file|
+          file.flock(File::LOCK_SH)
+          file.read
+        end
 
-        file.flock(File::LOCK_UN)
+        @previous_run_times = JSON.parse(raw_data, symbolize_names: true)
+      rescue JSON::ParserError => e
+        warn "#{e.inspect} in file #{previous_run_times_file_path}"
+        nil
       end
     end
 
@@ -84,6 +91,15 @@ module Specwrk
 
     private
 
+    # We want the most recently modified run time file
+    # report files are prefixed with a timestamp, and Dir.glob should order
+    # alphanumericly
+    def previous_run_times_file_path
+      return unless ENV["SPECWRK_OUT"]
+
+      @previous_run_times_file_path ||= Dir.glob(File.join(ENV["SPECWRK_OUT"], "*-report-*.json")).last
+    end
+
     # Take elements from the hash where the file_path is the same
     def bucket_by_file
       bucket = []
@@ -163,7 +179,7 @@ module Specwrk
         @hash.values.each { |example| calculate(example) }
 
         @output[:meta][:total_run_time] = @run_times.sum
-        @output[:meta][:average_run_time] = @output[:meta][:total_run_time] / @run_times.length.to_f
+        @output[:meta][:average_run_time] = @output[:meta][:total_run_time] / [@run_times.length, 1].max.to_f
         @output[:meta][:first_started_at] = @first_started_at.iso8601(6)
         @output[:meta][:last_finished_at] = @last_finished_at.iso8601(6)
 

data/lib/specwrk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Specwrk
-  VERSION = "0.4.11"
+  VERSION = "0.6.0"
 end

data/lib/specwrk/web/app.rb

@@ -13,6 +13,7 @@ rescue LoadError
   require "rack/handler/webrick"
 end
 
+require "specwrk/web"
 require "specwrk/web/logger"
 require "specwrk/web/auth"
 require "specwrk/web/endpoints"
@@ -20,6 +21,8 @@ require "specwrk/web/endpoints"
 module Specwrk
   class Web
     class App
+      REAP_INTERVAL = 330 # HTTP connection timeout + some buffer
+
       class << self
         def run!
           Process.setproctitle "specwrk-server"
@@ -49,10 +52,8 @@ module Specwrk
 
         def setup!
           if ENV["SPECWRK_OUT"]
-
             FileUtils.mkdir_p(ENV["SPECWRK_OUT"])
             ENV["SPECWRK_SRV_LOG"] ||= Pathname.new(File.join(ENV["SPECWRK_OUT"], "server.log")).to_s unless ENV["SPECWRK_SRV_VERBOSE"]
-            ENV["SPECWRK_SRV_OUTPUT"] ||= Pathname.new(File.join(ENV["SPECWRK_OUT"], "report.json")).expand_path(Dir.pwd).to_s
           end
 
           if ENV["SPECWRK_SRV_LOG"]
@@ -73,6 +74,10 @@ module Specwrk
         end
       end
 
+      def initialize
+        @reaper_thread = Thread.new { reaper } unless ENV["SPECWRK_SRV_SINGLE_RUN"]
+      end
+
       def call(env)
         env[:request] ||= Rack::Request.new(env)
 
@@ -93,14 +98,34 @@ module Specwrk
           Endpoints::Complete
         when ["POST", "/seed"]
           Endpoints::Seed
-        when ["GET", "/stats"]
-          Endpoints::Stats
+        when ["GET", "/report"]
+          Endpoints::Report
         when ["DELETE", "/shutdown"]
           Endpoints::Shutdown
         else
           Endpoints::NotFound
         end
       end
+
+      def reaper
+        until Specwrk.force_quit
+          sleep REAP_INTERVAL
+
+          reap
+        end
+      end
+
+      def reap
+        Web::WORKERS.each do |run, workers|
+          most_recent_last_seen_at = workers.map { |id, worker| worker[:last_seen_at] }.max
+          next unless most_recent_last_seen_at
+
+          # Don't consider runs which aren't at least REAP_INTERVAL sec stale
+          if most_recent_last_seen_at < Time.now - REAP_INTERVAL
+            Web.clear_run_queues(run)
+          end
+        end
+      end
     end
   end
 end

data/lib/specwrk/web/endpoints.rb

@@ -8,6 +8,9 @@ module Specwrk
       class Base
         def initialize(request)
           @request = request
+
+          worker[:first_seen_at] ||= Time.now
+          worker[:last_seen_at] = Time.now
         end
 
         def response
@@ -35,7 +38,7 @@ module Specwrk
         end
 
         def pending_queue
-          Web::PENDING_QUEUES[request.get_header("HTTP_X_SPECWRK_RUN")]
+          Web::PENDING_QUEUES[run_id]
         end
 
         def processing_queue
@@ -45,6 +48,22 @@ module Specwrk
         def completed_queue
           Web::COMPLETED_QUEUES[request.get_header("HTTP_X_SPECWRK_RUN")]
         end
+
+        def workers
+          Web::WORKERS[request.get_header("HTTP_X_SPECWRK_RUN")]
+        end
+
+        def worker
+          workers[request.get_header("HTTP_X_SPECWRK_ID")]
+        end
+
+        def run_id
+          request.get_header("HTTP_X_SPECWRK_RUN")
+        end
+
+        def run_report_file_path
+          @run_report_file_path ||= File.join(ENV["SPECWRK_OUT"], "#{completed_queue.created_at.strftime("%Y%m%dT%H%M%S")}-report-#{run_id}.json").to_s
+        end
       end
 
       # Base default response is 404
@@ -87,8 +106,8 @@ module Specwrk
             end
           end
 
-          if pending_queue.length.zero? && processing_queue.length.zero? && completed_queue.length.positive? && ENV["SPECWRK_SRV_OUTPUT"]
-            completed_queue.dump_and_write(ENV["SPECWRK_SRV_OUTPUT"])
+          if pending_queue.length.zero? && processing_queue.length.zero? && completed_queue.length.positive? && ENV["SPECWRK_OUT"]
+            completed_queue.dump_and_write(run_report_file_path)
           end
 
           ok
@@ -117,43 +136,37 @@ module Specwrk
         end
       end
 
-      class Stats < Base
+      class Report < Base
         def response
-          data = {
-            pending: {count: pending_queue.length},
-            processing: {count: processing_queue.length},
-            completed: completed_queue.dump
-          }
-
-          if data.dig(:completed, :examples).length.positive?
-            [200, {"Content-Type" => "application/json"}, [JSON.generate(data)]]
+          if data
+            [200, {"Content-Type" => "application/json"}, [data]]
           else
-            not_found
+            [404, {"Content-Type" => "text/plain"}, ["Unable to report on run #{run_id}; no file matching #{"*-report-#{run_id}.json"}"]]
           end
         end
-      end
 
-      class Shutdown < Base
-        def response
-          if ENV["SPECWRK_SRV_SINGLE_RUN"]
-            interupt!
-          elsif processing_queue.length.positive?
-            # Push any processing jobs back into the pending queue
-            processing_queue.synchronize do |processing_queue_hash|
-              pending_queue.synchronize do |pending_queue_hash|
-                processing_queue_hash.each do |id, example|
-                  pending_queue_hash[id] = example
-                  processing_queue_hash.delete(id)
-                end
-              end
-            end
+        private
 
-          elsif processing_queue.length.zero? && pending_queue.length.zero?
-            # All done, we can clear the completed queue
-            completed_queue.clear
+        def data
+          return @data if defined? @data
+
+          return unless most_recent_run_report_file
+          return unless File.exist?(most_recent_run_report_file)
+
+          @data = File.open(most_recent_run_report_file, "r") do |file|
+            file.flock(File::LOCK_SH)
+            file.read
           end
+        end
 
-          # TODO: clear any zombie queues
+        def most_recent_run_report_file
+          @most_recent_run_report_file ||= Dir.glob(File.join(ENV["SPECWRK_OUT"], "*-report-#{run_id}.json")).last
+        end
+      end
+
+      class Shutdown < Base
+        def response
+          interupt! if ENV["SPECWRK_SRV_SINGLE_RUN"]
 
           [200, {"Content-Type" => "text/plain"}, ["✌️"]]
         end

data/lib/specwrk/web.rb

@@ -4,12 +4,19 @@ require "specwrk/queue"
 
 module Specwrk
   class Web
-    PENDING_QUEUES = Queue.new { |h, key| h[key] = PendingQueue.new.tap { |q| q.previous_run_times_file = ENV["SPECWRK_SRV_OUTPUT"] } }
+    PENDING_QUEUES = Queue.new { |h, key| h[key] = PendingQueue.new }
     PROCESSING_QUEUES = Queue.new { |h, key| h[key] = Queue.new }
     COMPLETED_QUEUES = Queue.new { |h, key| h[key] = CompletedQueue.new }
+    WORKERS = Hash.new { |h, key| h[key] = Hash.new { |h, key| h[key] = {} } }
 
     def self.clear_queues
-      [PENDING_QUEUES, PROCESSING_QUEUES, COMPLETED_QUEUES].each(&:clear)
+      [PENDING_QUEUES, PROCESSING_QUEUES, COMPLETED_QUEUES, WORKERS].each(&:clear)
+    end
+
+    def self.clear_run_queues(run)
+      [PENDING_QUEUES, PROCESSING_QUEUES, COMPLETED_QUEUES, WORKERS].each do |queue|
+        queue.delete(run)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: specwrk
 version: !ruby/object:Gem::Version
-  version: 0.4.11
+  version: 0.6.0
 platform: ruby
 authors:
 - Daniel Westendorf