specwrk 0.15.2 → 0.15.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 361cb3f6e2abf6270f164554f9b6c251c4337353490dd90c46d15c8c8bec102a
-  data.tar.gz: d12fd20a3fca8159fdbf67495314052763fb7f6d867cdb1234ca744af6e2d8cf
+  metadata.gz: e7c81e77211a27632313439e1fb98376798e5c606151fa0e110ae2f64823ccda
+  data.tar.gz: 9fdb03226d2d3a57e79ee3701ede4e36bf12a43369ecb298dca40999813d4606
 SHA512:
-  metadata.gz: 67f5e4f5b98b12f8ca5b0d1a97da4b997a26d055e0f241433b7bdf3fa7f02e2b45cfeacb98ec1b851956e092de8a3fe16390a6bb3c4b67c6a3343ebfe7d09e69
-  data.tar.gz: 17b9ee079bb353bfe1c0ca295029f1653552886470ac93b9c3a24bf643b36f0cd2dbf7a80fe31d22adc9e9ab5f57e435922daa7162e352482100be36e9d332e7
+  metadata.gz: c3822e6d7f2de884e56ce1374abf05809f7c7bc24c8c06fafc46e69a1b5a2ae796abedc7fc0b0be2ab6b468f36cf9370469ac1e5c0e9696b96496f21a5bf391e
+  data.tar.gz: ef4829b50269101858c6b95dfd51ed4671eda52319c552e624f47a8b7d028c8f4347d38fd8c8acfcc0853625dff6f3838d5ae2330b3db0a02a0d07d2ee35dedd

data/CHANGELOG.md

@@ -1,5 +1,119 @@
 ## [Unreleased]
 
+# Changelog
+
+## v0.15.2 — 2025-08-15
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.15.1...v0.15.2)
+- Fix bug where ruby objects were being written to ndjson files isntead of json — [#119](https://github.com/danielwestendorf/specwrk/pull/119) by @danielwestendorf
+
+## v0.15.1 — 2025-08-14
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.15.0...v0.15.1)
+- Add `watch` command to split spec files across processes as they change — [#117](https://github.com/danielwestendorf/specwrk/pull/117) by @danielwestendorf
+- Readme formatting tweaks — @danielwestendorf
+
+## v0.15.0 — 2025-08-08
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.14.1...v0.15.0)
+- When output path is specified, write an `.ndjson` file per worker of all examples executed — [#113](https://github.com/danielwestendorf/specwrk/pull/113) (fixes [#10](https://github.com/danielwestendorf/specwrk/issues/10)) by @danielwestendorf
+- Print re-run commands for failures — [#114](https://github.com/danielwestendorf/specwrk/pull/114) (fixes [#7](https://github.com/danielwestendorf/specwrk/issues/7)) by @danielwestendorf
+- Show count of examples that did not execute; make runs resumable by only clearing stores on seed — [#115](https://github.com/danielwestendorf/specwrk/pull/115) by @danielwestendorf
+- Report flake counts and provide flake re-run commands — [#116](https://github.com/danielwestendorf/specwrk/pull/116) (fixes [#112](https://github.com/danielwestendorf/specwrk/issues/112)) by @danielwestendorf
+
+## v0.14.1 — 2025-08-07
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.14.0...v0.14.1)
+- Fix CLI typo — @danielwestendorf
+
+## v0.14.0 — 2025-08-07
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.13.1...v0.14.0)
+- Add support for example retries (`--max-retries` for `start` and `seed`) — [#111](https://github.com/danielwestendorf/specwrk/pull/111) (addresses [#96](https://github.com/danielwestendorf/specwrk/issues/96)) by @danielwestendorf
+
+## v0.13.1 — 2025-08-07
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.13.0...v0.13.1)
+- Require `securerandom` in the FileAdapter to ensure availability — @danielwestendorf
+
+## v0.13.0 — 2025-08-07
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.12.0...v0.13.0)
+- Avoid multi-process tempfile conflicts by adding a UUID to tempfile names — [#108](https://github.com/danielwestendorf/specwrk/pull/108) (fixes [#107](https://github.com/danielwestendorf/specwrk/issues/107)) by @danielwestendorf
+- Remove deprecated `complete` endpoint — [#109](https://github.com/danielwestendorf/specwrk/pull/109) (fixes [#95](https://github.com/danielwestendorf/specwrk/issues/95)) by @danielwestendorf
+- Track worker success metrics (succeeded/pending/failed) and use them to instruct worker exit behavior — [#110](https://github.com/danielwestendorf/specwrk/pull/110) (fixes [#97](https://github.com/danielwestendorf/specwrk/issues/97)) by @danielwestendorf
+
+## v0.12.0 — 2025-08-06
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.11.1...v0.12.0)
+- Don’t return a body for `HEAD` requests in auth middleware — refs [#102](https://github.com/danielwestendorf/specwrk/issues/102) — @danielwestendorf
+- Filter `specwrk` from backtraces — @danielwestendorf
+- Move store order tracking to the only store class that needs it (performance improvement) — [#105](https://github.com/danielwestendorf/specwrk/pull/105) by @danielwestendorf
+- Humanize seconds output — [#106](https://github.com/danielwestendorf/specwrk/pull/106) (fixes [#11](https://github.com/danielwestendorf/specwrk/issues/11)) by @danielwestendorf
+
+## v0.11.1 — 2025-08-05
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.11.0...v0.11.1)
+- Avoid doing work in `before_lock` for `complete` and `pop` endpoints — [#104](https://github.com/danielwestendorf/specwrk/pull/104) (fixes [#103](https://github.com/danielwestendorf/specwrk/issues/103)) by @danielwestendorf
+
+## v0.10.2 — 2025-08-01
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.10.1...v0.10.2)
+- Add `complete_and_pop` endpoint to reduce HTTP requests ~50% — [#88](https://github.com/danielwestendorf/specwrk/pull/88) by @danielwestendorf
+- File-per-example file store — [#87](https://github.com/danielwestendorf/specwrk/pull/87) by @danielwestendorf
+- Remove thread safety (follow-up to thread pool changes) — [#89](https://github.com/danielwestendorf/specwrk/pull/89) by @danielwestendorf
+- Fix thread pool start — [#90](https://github.com/danielwestendorf/specwrk/pull/90) by @danielwestendorf
+
+## v0.10.1 — 2025-08-01
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.10.0...v0.10.1)
+- Internal cleanups and versioning adjustments for the 0.10.x line
+
+## v0.10.0 — 2025-08-01
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.9.1...v0.10.0)
+- Prep for 0.10 baseline (no PRs explicitly tied beyond those in 0.10.1/0.10.2)
+
+## v0.9.1 — 2025-08-01
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.9.0...v0.9.1)
+- Minor fixes and tag adjustments
+
+## v0.9.0 — 2025-07-30
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.8.0...v0.9.0)
+- File-per-example store groundwork — see [#87](https://github.com/danielwestendorf/specwrk/pull/87) by @danielwestendorf
+
+## v0.8.0 — 2025-07-22
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.7.1...v0.8.0)
+- Revert datastore and related adjustments — [#86](https://github.com/danielwestendorf/specwrk/pull/86) by @danielwestendorf
+- Just return response if no `run_id` header — [#85](https://github.com/danielwestendorf/specwrk/pull/85) by @danielwestendorf
+- On `INT`, if RSpec is defined set `wants_to_quit = true` — [#84](https://github.com/danielwestendorf/specwrk/pull/84) by @danielwestendorf
+- Datastore for queues — [#83](https://github.com/danielwestendorf/specwrk/pull/83) by @danielwestendorf
+
+## v0.7.1 — 2025-07-22
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.7.0...v0.7.1)
+- Minor tag-only bump
+
+## v0.7.0 — 2025-07-22
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.6.3...v0.7.0)
+- Only exit 1 when no examples processed and run not completed — [#82](https://github.com/danielwestendorf/specwrk/pull/82) by @danielwestendorf
+- Switch from Puma to Pitchfork — [#79](https://github.com/danielwestendorf/specwrk/pull/79) by @danielwestendorf
+- Dump all runs as unique — [#78](https://github.com/danielwestendorf/specwrk/pull/78) by @danielwestendorf
+
+## v0.6.3 — 2025-07-17
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.6.2...v0.6.3)
+- Reap queues based on staleness of workers — [#76](https://github.com/danielwestendorf/specwrk/pull/76) by @danielwestendorf
+- Track worker `first_seen_at` / `last_seen_at` — [#75](https://github.com/danielwestendorf/specwrk/pull/75) by @danielwestendorf
+- Unique default ID when no `SPECWRK_ID` provided — [#74](https://github.com/danielwestendorf/specwrk/pull/74) by @danielwestendorf
+- Send `X-Specwrk-Id` and `User-Agent` headers — [#71](https://github.com/danielwestendorf/specwrk/pull/71) by @danielwestendorf
+
+## v0.6.2 — 2025-07-17
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.6.1...v0.6.2)
+- Tag-only bump
+
+## v0.6.1 — 2025-07-17
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.6.0...v0.6.1)
+- Tag-only bump
+
+## v0.6.0 — 2025-07-17
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.5.0...v0.6.0)
+- Output success message when seeding succeeds — [#67](https://github.com/danielwestendorf/specwrk/pull/67) by @danielwestendorf
+
+## v0.5.0 — 2025-07-15
+[Compare](https://github.com/danielwestendorf/specwrk/compare/v0.4.11...v0.5.0)
+- Support specifying if subsequent seeds should be ignored for a run — [#37](https://github.com/danielwestendorf/specwrk/pull/37) by @danielwestendorf
+- Make number of seed waits configurable — [#35](https://github.com/danielwestendorf/specwrk/pull/35) by @danielwestendorf
+- Worker wait for seeding — [#32](https://github.com/danielwestendorf/specwrk/pull/32) by @danielwestendorf
+- Track if the worker has processed *any* examples — [#31](https://github.com/danielwestendorf/specwrk/pull/31) by @danielwestendorf
+
+
 ## v0.4.11
 
 - Move logic out of CLI methods ([#64](https://github.com/danielwestendorf/specwrk/issues/64)) by @danielwestendorf  

data/README.md

@@ -26,6 +26,7 @@ Commands:
   specwrk serve                 # Start a queue server
   specwrk start [DIR]           # Start a server and workers, monitor until complete
   specwrk version               # Print version
+  specwrk watch                 # Start a server and workers, watch for file changes in the current directory, and execute specs
   specwrk work                  # Start one or more worker processes
 ```
 
@@ -261,6 +262,22 @@ end
 # end
 ```
 
+## Prior/other works
+There are many prior works for running rspec tests across multiple processes. Most of them combine process output making failures hard to grok. Some are good at running tests locally, but not on CI, while others are invserly true. Others are comercial or impactical without making a purchase.
+
+specwrk is different because it:
+1. Puts your developer experience first. Easy execution. No messy outputs. Retries built in. Easy(er) debugging of flaky tests. 
+2. Is the same tool you use in development on your local box, in CI with a single runner, or CI with N number of runners.
+3. Is easy to deploy and manage a queue server.
+4. RSpec-only.
+5. Is free.
+
+[parallel_rspec](https://github.com/willbryant/parallel_rspec)
+[Knapsack](https://github.com/KnapsackPro/knapsack)
+[parallel_tests](https://github.com/grosser/parallel_tests)
+[rspecq](https://github.com/skroutz/rspecq)
+[RSpec ABQ](https://github.com/rwx-research/rspec-abq)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/dwestendorf/specwrk.

data/lib/specwrk/cli.rb

@@ -288,6 +288,8 @@ module Specwrk
 
         require "specwrk/cli_reporter"
 
+        title "👀 for changes"
+
         loop do
           status "👀 Watching for file changes..."
 
@@ -309,6 +311,7 @@ module Specwrk
           end
 
           next if example_count.zero?
+          title "👷 on #{example_count} examples"
 
           return if Specwrk.force_quit
           start_workers
@@ -318,8 +321,17 @@ module Specwrk
           drain_outputs
           return if Specwrk.force_quit
 
-          Specwrk::CLIReporter.new.report
+          reporter = Specwrk::CLIReporter.new
+
+          status = reporter.report
           puts
+
+          if status.zero?
+            title "🟢 #{reporter.example_count} examples passed"
+          else
+            title " 🔴 #{reporter.failure_count}/#{reporter.example_count} examples failed"
+          end
+
           $stdout.flush
         end
 
@@ -329,6 +341,11 @@ module Specwrk
 
       private
 
+      def title(str)
+        $stdout.write "\e]0;#{str}\a"
+        $stdout.flush
+      end
+
       def web_pid
         @web_pid ||= Process.fork do
           require "specwrk/web"

data/lib/specwrk/cli_reporter.rb

@@ -54,8 +54,6 @@ module Specwrk
       1
     end
 
-    private
-
     def totals_line
       summary = RSpec::Core::Formatters::Helpers.pluralize(example_count, "example") +
         ", " + RSpec::Core::Formatters::Helpers.pluralize(failure_count, "failure")

data/lib/specwrk/list_examples.rb

@@ -59,6 +59,8 @@ module Specwrk
       RSpec.world.wants_to_quit = Specwrk.force_quit
 
       RSpec.configuration.silence_filter_announcements = true
+      RSpec.configuration.filter_manager.inclusions.clear
+      RSpec.configuration.filter_manager.exclusions.clear
 
       true
     end

data/lib/specwrk/version.rb

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

data/lib/specwrk/web/app.rb

@@ -16,7 +16,13 @@ end
 require "specwrk/web"
 require "specwrk/web/logger"
 require "specwrk/web/auth"
-require "specwrk/web/endpoints"
+require "specwrk/web/endpoints/health"
+require "specwrk/web/endpoints/heartbeat"
+require "specwrk/web/endpoints/seed"
+require "specwrk/web/endpoints/pop"
+require "specwrk/web/endpoints/complete_and_pop"
+require "specwrk/web/endpoints/report"
+require "specwrk/web/endpoints/shutdown"
 
 module Specwrk
   class Web

data/lib/specwrk/web/endpoints/base.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require "json"
+
+require "specwrk/store"
+
+module Specwrk
+  class Web
+    module Endpoints
+      class Base
+        attr_reader :started_at
+
+        def initialize(request)
+          @request = request
+        end
+
+        def response
+          before_lock
+
+          return with_response unless run_id # No run_id, no datastore usage in the endpoint
+
+          payload # parse the payload before any locking
+
+          worker[:first_seen_at] ||= Time.now.iso8601
+          worker[:last_seen_at] = Time.now.iso8601
+
+          final_response = with_lock do
+            started_at = metadata[:started_at] ||= Time.now.iso8601
+            @started_at = Time.parse(started_at)
+
+            with_response
+          end
+
+          after_lock
+
+          final_response[1]["x-specwrk-status"] = worker_status.to_s
+
+          final_response
+        end
+
+        def with_response
+          not_found
+        end
+
+        private
+
+        attr_reader :request
+
+        def before_lock
+        end
+
+        def after_lock
+        end
+
+        def not_found
+          if request.head?
+            [404, {}, []]
+          else
+            [404, {"content-type" => "text/plain"}, ["This is not the path you're looking for, 'ol chap..."]]
+          end
+        end
+
+        def ok
+          if request.head?
+            [200, {}, []]
+          else
+            [200, {"content-type" => "text/plain"}, ["OK, 'ol chap"]]
+          end
+        end
+
+        def payload
+          return unless request.content_type&.start_with?("application/json")
+          return unless request.post? || request.put? || request.delete?
+          return if body.empty?
+
+          @payload ||= JSON.parse(body, symbolize_names: true)
+        end
+
+        def body
+          @body ||= request.body.read
+        end
+
+        def pending
+          @pending ||= PendingStore.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "pending"))
+        end
+
+        def processing
+          @processing ||= ProcessingStore.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "processing"))
+        end
+
+        def completed
+          @completed ||= CompletedStore.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "completed"))
+        end
+
+        def failure_counts
+          @failure_counts ||= Store.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "failure_counts"))
+        end
+
+        def metadata
+          @metadata ||= Store.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "metadata"))
+        end
+
+        def run_times
+          @run_times ||= Store.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "file://#{File.join(Dir.tmpdir, "specwrk")}"), "run_times")
+        end
+
+        def worker
+          @worker ||= Store.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "workers", request.get_header("HTTP_X_SPECWRK_ID").to_s))
+        end
+
+        def worker_status
+          return 0 if worker[:failed].nil? && completed.any? # worker starts after run has completed
+
+          worker[:failed] || 1
+        end
+
+        def run_id
+          request.get_header("HTTP_X_SPECWRK_RUN")
+        end
+
+        def with_lock
+          Store.with_lock(URI(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///")), "server") { yield }
+        end
+      end
+
+      # Base default response is 404
+      NotFound = Class.new(Base)
+    end
+  end
+end

data/lib/specwrk/web/endpoints/complete_and_pop.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "specwrk/web/endpoints/popable"
+
+module Specwrk
+  class Web
+    module Endpoints
+      class CompleteAndPop < Popable
+        EXAMPLE_STATUSES = %w[passed failed pending]
+
+        def with_response
+          completed.merge!(completed_examples)
+          processing.delete(*(completed_examples.keys + retry_examples.keys))
+          pending.merge!(retry_examples)
+          failure_counts.merge!(retry_examples_new_failure_counts)
+
+          with_pop_response
+        end
+
+        private
+
+        def all_examples
+          @all_examples ||= payload.map { |example| [example[:id], example] if processing[example[:id]] }.compact.to_h
+        end
+
+        def completed_examples
+          @completed_examples ||= all_examples.map do |id, example|
+            next if retry_example?(example)
+
+            [id, example]
+          end.compact.to_h
+        end
+
+        def retry_examples
+          @retry_examples ||= all_examples.map do |id, example|
+            next unless retry_example?(example)
+
+            [id, example]
+          end.compact.to_h
+        end
+
+        def retry_examples_new_failure_counts
+          @retry_examples_new_failure_counts ||= retry_examples.map do |id, _example|
+            [id, all_example_failure_counts.fetch(id, 0) + 1]
+          end.to_h
+        end
+
+        def retry_example?(example)
+          return false unless example[:status] == "failed"
+          return false unless pending.max_retries.positive?
+
+          example_failure_count = all_example_failure_counts.fetch(example[:id], 0)
+
+          example_failure_count < pending.max_retries
+        end
+
+        def all_example_failure_counts
+          @all_example_failure_counts ||= failure_counts.multi_read(*all_examples.keys)
+        end
+
+        def completed_examples_status_counts
+          @completed_examples_status_counts ||= completed_examples.values.map { |example| example[:status] }.tally
+        end
+
+        def after_lock
+          # We don't care about exact values here, just approximate run times are fine
+          # So if we overwrite run times from another process it is nbd
+          run_times.merge! run_time_data
+
+          # workers are single proces, single-threaded, so safe to do this work without the lock
+          existing_status_counts = worker.multi_read(*EXAMPLE_STATUSES)
+          new_status_counts = EXAMPLE_STATUSES.map do |status|
+            [status, existing_status_counts.fetch(status, 0) + completed_examples_status_counts.fetch(status, 0)]
+          end.to_h
+
+          worker.merge!(new_status_counts)
+        end
+
+        def run_time_data
+          @run_time_data ||= payload.map { |example| [example[:id], example[:run_time]] }.to_h
+        end
+      end
+    end
+  end
+end

data/lib/specwrk/web/endpoints/health.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "specwrk/web/endpoints/base"
+
+module Specwrk
+  class Web
+    module Endpoints
+      class Health < Base
+        def with_response
+          ok
+        end
+      end
+    end
+  end
+end

data/lib/specwrk/web/endpoints/heartbeat.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "specwrk/web/endpoints/base"
+
+module Specwrk
+  class Web
+    module Endpoints
+      class Heartbeat < Base
+        def with_response
+          ok
+        end
+      end
+    end
+  end
+end

data/lib/specwrk/web/endpoints/pop.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "specwrk/web/endpoints/popable"
+
+module Specwrk
+  class Web
+    module Endpoints
+      class Pop < Popable
+        def with_response
+          with_pop_response
+        end
+      end
+    end
+  end
+end

data/lib/specwrk/web/endpoints/popable.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "specwrk/web/endpoints/base"
+
+module Specwrk
+  class Web
+    module Endpoints
+      class Popable < Base
+        private
+
+        def with_pop_response
+          if examples.any?
+            [200, {"content-type" => "application/json"}, [JSON.generate(examples)]]
+          elsif pending.empty? && processing.empty? && completed.empty?
+            [204, {"content-type" => "text/plain"}, ["Waiting for sample to be seeded."]]
+          elsif completed.any? && processing.empty?
+            [410, {"content-type" => "text/plain"}, ["That's a good lad. Run along now and go home."]]
+          elsif processing.any? && processing.expired.keys.any?
+            pending.merge!(processing.expired)
+            processing.delete(*processing.expired.keys)
+            @examples = nil
+
+            [200, {"content-type" => "application/json"}, [JSON.generate(examples)]]
+          else
+            not_found
+          end
+        end
+
+        def examples
+          @examples ||= begin
+            examples = pending.shift_bucket
+            bucket_run_time_total = examples.map { |example| example.fetch(:expected_run_time, 10.0) }.compact.sum * 2
+            maximum_completion_threshold = (pending.run_time_bucket_maximum || 30.0) * 2
+            completion_threshold = Time.now + [bucket_run_time_total, maximum_completion_threshold, 20.0].max
+
+            processing_data = examples.map do |example|
+              [
+                example[:id], example.merge(completion_threshold: completion_threshold.to_f)
+              ]
+            end
+
+            processing.merge!(processing_data.to_h)
+
+            examples
+          end
+        end
+      end
+    end
+  end
+end

data/lib/specwrk/web/endpoints/report.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "specwrk/web/endpoints/base"
+
+module Specwrk
+  class Web
+    module Endpoints
+      class Report < Base
+        def with_response
+          completed_dump = completed.dump
+          completed_dump[:meta][:unexecuted] = pending.length + processing.length
+          completed_dump[:flakes] = failure_counts.to_h.reject { |id, _count| completed_dump.dig(:examples, id, :status) == "failed" }
+
+          [200, {"content-type" => "application/json"}, [JSON.generate(completed_dump)]]
+        end
+      end
+    end
+  end
+end

data/lib/specwrk/web/endpoints/seed.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "specwrk/web/endpoints/base"
+
+module Specwrk
+  class Web
+    module Endpoints
+      class Seed < Base
+        def before_lock
+          examples_with_run_times
+        end
+
+        def with_response
+          pending.clear
+          processing.clear
+          failure_counts.clear
+
+          pending.max_retries = payload.fetch(:max_retries, "0").to_i
+
+          new_run_time_bucket_maximums = [pending.run_time_bucket_maximum, @seeds_run_time_bucket_maximum.to_f].compact
+          pending.run_time_bucket_maximum = new_run_time_bucket_maximums.sum.to_f / new_run_time_bucket_maximums.length.to_f
+
+          pending.merge!(examples_with_run_times)
+          processing.clear
+          completed.clear
+
+          ok
+        end
+
+        def examples_with_run_times
+          @examples_with_run_times ||= begin
+            unsorted_examples_with_run_times = []
+            all_ids = payload[:examples].map { |example| example[:id] }
+            all_run_times = run_times.multi_read(*all_ids)
+
+            payload[:examples].each do |example|
+              run_time = all_run_times[example[:id]]
+
+              unsorted_examples_with_run_times << [example[:id], example.merge(expected_run_time: run_time)]
+            end
+
+            sorted_examples_with_run_times = if sort_by == :timings
+              unsorted_examples_with_run_times.sort_by do |entry|
+                -(entry.last[:expected_run_time] || Float::INFINITY)
+              end
+            else
+              unsorted_examples_with_run_times.sort_by do |entry|
+                entry.last[:file_path]
+              end
+            end
+
+            @seeds_run_time_bucket_maximum = run_time_bucket_maximum(all_run_times.values.compact)
+            @examples_with_run_times = sorted_examples_with_run_times.to_h
+          end
+        end
+
+        private
+
+        # Average + standard deviation
+        def run_time_bucket_maximum(values)
+          return 0 if values.length.zero?
+
+          mean = values.sum.to_f / values.size
+          variance = values.map { |v| (v - mean)**2 }.sum / values.size
+          (mean + Math.sqrt(variance)).round(2)
+        end
+
+        def sort_by
+          if ENV["SPECWRK_SRV_GROUP_BY"] == "file" || run_times.empty?
+            :file
+          else
+            :timings
+          end
+        end
+      end
+    end
+  end
+end

data/lib/specwrk/web/endpoints/shutdown.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "specwrk/web/endpoints/base"
+
+module Specwrk
+  class Web
+    module Endpoints
+      class Shutdown < Base
+        def with_response
+          interupt! if ENV["SPECWRK_SRV_SINGLE_RUN"]
+
+          [200, {"content-type" => "text/plain"}, ["✌️"]]
+        end
+
+        def interupt!
+          Thread.new do
+            # give the socket a moment to flush the response
+            sleep 0.2
+            Process.kill("INT", Process.pid)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: specwrk
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.15.4
 platform: ruby
 authors:
 - Daniel Westendorf
@@ -202,7 +202,7 @@ files:
 - ".rspec"
 - ".standard.yml"
 - CHANGELOG.md
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - Specwrk.watchfile.rb
@@ -231,7 +231,15 @@ files:
 - lib/specwrk/web.rb
 - lib/specwrk/web/app.rb
 - lib/specwrk/web/auth.rb
-- lib/specwrk/web/endpoints.rb
+- lib/specwrk/web/endpoints/base.rb
+- lib/specwrk/web/endpoints/complete_and_pop.rb
+- lib/specwrk/web/endpoints/health.rb
+- lib/specwrk/web/endpoints/heartbeat.rb
+- lib/specwrk/web/endpoints/pop.rb
+- lib/specwrk/web/endpoints/popable.rb
+- lib/specwrk/web/endpoints/report.rb
+- lib/specwrk/web/endpoints/seed.rb
+- lib/specwrk/web/endpoints/shutdown.rb
 - lib/specwrk/web/logger.rb
 - lib/specwrk/worker.rb
 - lib/specwrk/worker/completion_formatter.rb

data/lib/specwrk/web/endpoints.rb

@@ -1,360 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-require "specwrk/store"
-
-module Specwrk
-  class Web
-    module Endpoints
-      class Base
-        attr_reader :started_at
-
-        def initialize(request)
-          @request = request
-        end
-
-        def response
-          before_lock
-
-          return with_response unless run_id # No run_id, no datastore usage in the endpoint
-
-          payload # parse the payload before any locking
-
-          worker[:first_seen_at] ||= Time.now.iso8601
-          worker[:last_seen_at] = Time.now.iso8601
-
-          final_response = with_lock do
-            started_at = metadata[:started_at] ||= Time.now.iso8601
-            @started_at = Time.parse(started_at)
-
-            with_response
-          end
-
-          after_lock
-
-          final_response[1]["x-specwrk-status"] = worker_status.to_s
-
-          final_response
-        end
-
-        def with_response
-          not_found
-        end
-
-        private
-
-        attr_reader :request
-
-        def before_lock
-        end
-
-        def after_lock
-        end
-
-        def not_found
-          if request.head?
-            [404, {}, []]
-          else
-            [404, {"content-type" => "text/plain"}, ["This is not the path you're looking for, 'ol chap..."]]
-          end
-        end
-
-        def ok
-          if request.head?
-            [200, {}, []]
-          else
-            [200, {"content-type" => "text/plain"}, ["OK, 'ol chap"]]
-          end
-        end
-
-        def payload
-          return unless request.content_type&.start_with?("application/json")
-          return unless request.post? || request.put? || request.delete?
-          return if body.empty?
-
-          @payload ||= JSON.parse(body, symbolize_names: true)
-        end
-
-        def body
-          @body ||= request.body.read
-        end
-
-        def pending
-          @pending ||= PendingStore.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "pending"))
-        end
-
-        def processing
-          @processing ||= ProcessingStore.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "processing"))
-        end
-
-        def completed
-          @completed ||= CompletedStore.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "completed"))
-        end
-
-        def failure_counts
-          @failure_counts ||= Store.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "failure_counts"))
-        end
-
-        def metadata
-          @metadata ||= Store.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "metadata"))
-        end
-
-        def run_times
-          @run_times ||= Store.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "file://#{File.join(Dir.tmpdir, "specwrk")}"), "run_times")
-        end
-
-        def worker
-          @worker ||= Store.new(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///"), File.join(run_id, "workers", request.get_header("HTTP_X_SPECWRK_ID").to_s))
-        end
-
-        def worker_status
-          return 0 if worker[:failed].nil? && completed.any? # worker starts after run has completed
-
-          worker[:failed] || 1
-        end
-
-        def run_id
-          request.get_header("HTTP_X_SPECWRK_RUN")
-        end
-
-        def with_lock
-          Store.with_lock(URI(ENV.fetch("SPECWRK_SRV_STORE_URI", "memory:///")), "server") { yield }
-        end
-      end
-
-      # Base default response is 404
-      NotFound = Class.new(Base)
-
-      class Health < Base
-        def with_response
-          ok
-        end
-      end
-
-      class Heartbeat < Base
-        def with_response
-          ok
-        end
-      end
-
-      class Seed < Base
-        def before_lock
-          examples_with_run_times
-        end
-
-        def with_response
-          pending.clear
-          processing.clear
-          failure_counts.clear
-
-          pending.max_retries = payload.fetch(:max_retries, "0").to_i
-
-          new_run_time_bucket_maximums = [pending.run_time_bucket_maximum, @seeds_run_time_bucket_maximum.to_f].compact
-          pending.run_time_bucket_maximum = new_run_time_bucket_maximums.sum.to_f / new_run_time_bucket_maximums.length.to_f
-
-          pending.merge!(examples_with_run_times)
-          processing.clear
-          completed.clear
-
-          ok
-        end
-
-        def examples_with_run_times
-          @examples_with_run_times ||= begin
-            unsorted_examples_with_run_times = []
-            all_ids = payload[:examples].map { |example| example[:id] }
-            all_run_times = run_times.multi_read(*all_ids)
-
-            payload[:examples].each do |example|
-              run_time = all_run_times[example[:id]]
-
-              unsorted_examples_with_run_times << [example[:id], example.merge(expected_run_time: run_time)]
-            end
-
-            sorted_examples_with_run_times = if sort_by == :timings
-              unsorted_examples_with_run_times.sort_by do |entry|
-                -(entry.last[:expected_run_time] || Float::INFINITY)
-              end
-            else
-              unsorted_examples_with_run_times.sort_by do |entry|
-                entry.last[:file_path]
-              end
-            end
-
-            @seeds_run_time_bucket_maximum = run_time_bucket_maximum(all_run_times.values.compact)
-            @examples_with_run_times = sorted_examples_with_run_times.to_h
-          end
-        end
-
-        private
-
-        # Average + standard deviation
-        def run_time_bucket_maximum(values)
-          return 0 if values.length.zero?
-
-          mean = values.sum.to_f / values.size
-          variance = values.map { |v| (v - mean)**2 }.sum / values.size
-          (mean + Math.sqrt(variance)).round(2)
-        end
-
-        def sort_by
-          if ENV["SPECWRK_SRV_GROUP_BY"] == "file" || run_times.empty?
-            :file
-          else
-            :timings
-          end
-        end
-      end
-
-      class Popable < Base
-        private
-
-        def with_pop_response
-          if examples.any?
-            [200, {"content-type" => "application/json"}, [JSON.generate(examples)]]
-          elsif pending.empty? && processing.empty? && completed.empty?
-            [204, {"content-type" => "text/plain"}, ["Waiting for sample to be seeded."]]
-          elsif completed.any? && processing.empty?
-            [410, {"content-type" => "text/plain"}, ["That's a good lad. Run along now and go home."]]
-          elsif processing.any? && processing.expired.keys.any?
-            pending.merge!(processing.expired)
-            processing.delete(*processing.expired.keys)
-            @examples = nil
-
-            [200, {"content-type" => "application/json"}, [JSON.generate(examples)]]
-          else
-            not_found
-          end
-        end
-
-        def examples
-          @examples ||= begin
-            examples = pending.shift_bucket
-            maximum_completion_threshold = (Time.now + ((pending.run_time_bucket_maximum || 30) * 2)).to_i
-
-            processing_data = examples.map do |example|
-              example_run_time_completion_threshold = (Time.now + example[:expected_run_time].to_f * 2).to_i
-
-              [
-                example[:id], example.merge(completion_threshold: [maximum_completion_threshold, example_run_time_completion_threshold].compact.max)
-              ]
-            end
-
-            processing.merge!(processing_data.to_h)
-
-            examples
-          end
-        end
-      end
-
-      class Pop < Popable
-        def with_response
-          with_pop_response
-        end
-      end
-
-      class CompleteAndPop < Popable
-        EXAMPLE_STATUSES = %w[passed failed pending]
-
-        def with_response
-          completed.merge!(completed_examples)
-          processing.delete(*(completed_examples.keys + retry_examples.keys))
-          pending.merge!(retry_examples)
-          failure_counts.merge!(retry_examples_new_failure_counts)
-
-          with_pop_response
-        end
-
-        private
-
-        def all_examples
-          @all_examples ||= payload.map { |example| [example[:id], example] if processing[example[:id]] }.compact.to_h
-        end
-
-        def completed_examples
-          @completed_examples ||= all_examples.map do |id, example|
-            next if retry_example?(example)
-
-            [id, example]
-          end.compact.to_h
-        end
-
-        def retry_examples
-          @retry_examples ||= all_examples.map do |id, example|
-            next unless retry_example?(example)
-
-            [id, example]
-          end.compact.to_h
-        end
-
-        def retry_examples_new_failure_counts
-          @retry_examples_new_failure_counts ||= retry_examples.map do |id, _example|
-            [id, all_example_failure_counts.fetch(id, 0) + 1]
-          end.to_h
-        end
-
-        def retry_example?(example)
-          return false unless example[:status] == "failed"
-          return false unless pending.max_retries.positive?
-
-          example_failure_count = all_example_failure_counts.fetch(example[:id], 0)
-
-          example_failure_count < pending.max_retries
-        end
-
-        def all_example_failure_counts
-          @all_example_failure_counts ||= failure_counts.multi_read(*all_examples.keys)
-        end
-
-        def completed_examples_status_counts
-          @completed_examples_status_counts ||= completed_examples.values.map { |example| example[:status] }.tally
-        end
-
-        def after_lock
-          # We don't care about exact values here, just approximate run times are fine
-          # So if we overwrite run times from another process it is nbd
-          run_times.merge! run_time_data
-
-          # workers are single proces, single-threaded, so safe to do this work without the lock
-          existing_status_counts = worker.multi_read(*EXAMPLE_STATUSES)
-          new_status_counts = EXAMPLE_STATUSES.map do |status|
-            [status, existing_status_counts.fetch(status, 0) + completed_examples_status_counts.fetch(status, 0)]
-          end.to_h
-
-          worker.merge!(new_status_counts)
-        end
-
-        def run_time_data
-          @run_time_data ||= payload.map { |example| [example[:id], example[:run_time]] }.to_h
-        end
-      end
-
-      class Report < Base
-        def with_response
-          completed_dump = completed.dump
-          completed_dump[:meta][:unexecuted] = pending.length + processing.length
-          completed_dump[:flakes] = failure_counts.to_h.reject { |id, _count| completed_dump.dig(:examples, id, :status) == "failed" }
-
-          [200, {"content-type" => "application/json"}, [JSON.generate(completed_dump)]]
-        end
-      end
-
-      class Shutdown < Base
-        def with_response
-          interupt! if ENV["SPECWRK_SRV_SINGLE_RUN"]
-
-          [200, {"content-type" => "text/plain"}, ["✌️"]]
-        end
-
-        def interupt!
-          Thread.new do
-            # give the socket a moment to flush the response
-            sleep 0.2
-            Process.kill("INT", Process.pid)
-          end
-        end
-      end
-    end
-  end
-end