specwrk 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f06b10c3a81644d436c6b7b636c97c83b2b5bbb4c43065fa4a27554a5870b873
-  data.tar.gz: '002619c27e85bbd6abaab2cb86a6e622549f20e5548087c87908421eb4aa78e4'
+  metadata.gz: 2c16c0b37ed56096253bc295ee77360813c5d1363a68cbd75f3694545448a588
+  data.tar.gz: 365e391b1075fead8b38c00ba57d307c0ee47107acec2a946d2c9484abe89fee
 SHA512:
-  metadata.gz: 61735c8eebc5bd13bdaafefd0925ed597b102fdb785bb821437bfb415654907a6262f11b8c2710b9c3913a6752816b4381c9315c55b0959877abb89e16280b46
-  data.tar.gz: 97773a5c2e828e6fbf4562aa6eaea2e5f9ac9cf6e733959cb634b18e984e7e1ee48384eb5aa170bd89cd4de41f17cb14f372b6057e6ecbfc3c64cf9bcb3491fc
+  metadata.gz: 28ecd7dd329f4ca7db54c27fbf1454810c8cf06966c8317e51611820c9ab39adba812377ec2ac99e2c9d902b5456a60e4696545662e2952c2768bdc2a6777477
+  data.tar.gz: 642b25bcf069fd689472c408408baa48e25b9fe8bb32989b89b68e68f210381c9f0e9b160d2c6207e700c356bd9a668b30ae29f093b1c69c0dd42debaf02b72b

data/exe/specwrk

@@ -5,7 +5,7 @@ require "specwrk/cli"
 
 trap("INT") do
   if Specwrk.starting_pid == Process.pid && !Specwrk.force_quit
-    warn "Waiting for in-progress work to finish. Interrupt again to force quit (warning: at_exit hooks will be skipped if you force quit)."
+    warn " ↓ Waiting for in-progress work to finish. Interrupt again to force quit (warning: at_exit hooks will be skipped if you force quit)."
 
     Specwrk.force_quit = true
   elsif Specwrk.starting_pid != Process.pid

data/lib/specwrk/cli.rb

@@ -15,10 +15,10 @@ module Specwrk
       extend Hookable
 
       on_included do |base|
-        base.option :uri, type: :string, default: ENV.fetch("SPECWRK_SRV_URI", "https://localhost:#{ENV.fetch("SPECWRK_SRV_PORT", "5138")}"), desc: "HTTP URI of the server to pull jobs from"
-        base.option :key, type: :string, default: ENV.fetch("SPECWRK_SRV_KEY", ""), aliases: ["-k"], desc: "Authentication key for accessing the server"
-        base.option :run, type: :string, default: ENV.fetch("SPECWRK_SRV_KEY", "main"), aliases: ["-r"], desc: "The run identifier for this job execution"
-        base.option :timeout, type: :integer, default: ENV.fetch("SPECWRK_TIMEOUT", "5"), aliases: ["-t"], desc: "The amount of time to wait for the server to respond"
+        base.unique_option :uri, type: :string, default: ENV.fetch("SPECWRK_SRV_URI", "https://localhost:#{ENV.fetch("SPECWRK_SRV_PORT", "5138")}"), desc: "HTTP URI of the server to pull jobs from. Overrides SPECWRK_SRV_PORT. Default 5138."
+        base.unique_option :key, type: :string, default: ENV.fetch("SPECWRK_SRV_KEY", ""), aliases: ["-k"], desc: "Authentication key clients must use for access. Overrides SPECWRK_SRV_KEY. Default ''."
+        base.unique_option :run, type: :string, default: ENV.fetch("SPECWRK_RUN", "main"), aliases: ["-r"], desc: "The run identifier for this job execution. Overrides SPECWRK_RUN. Default main."
+        base.unique_option :timeout, type: :integer, default: ENV.fetch("SPECWRK_TIMEOUT", "5"), aliases: ["-t"], desc: "The amount of time to wait for the server to respond. Overrides SPECWRK_TIMEOUT. Default 5."
       end
 
       on_setup do |uri:, key:, run:, timeout:, **|
@@ -33,9 +33,9 @@ module Specwrk
       extend Hookable
 
       on_included do |base|
-        base.option :id, type: :string, default: "specwrk-worker", desc: "The identifier for this worker"
-        base.option :count, type: :integer, default: 1, aliases: ["-c"], desc: "The number of worker processes you want to start"
-        base.option :output, type: :string, default: ENV.fetch("SPECWRK_OUT", ".specwrk/"), aliases: ["-o"], desc: "Directory where worker output is stored"
+        base.unique_option :id, type: :string, default: "specwrk-worker", desc: "The identifier for this worker. Default specwrk-worker(-COUNT_INDEX)."
+        base.unique_option :count, type: :integer, default: 1, aliases: ["-c"], desc: "The number of worker processes you want to start. Default 1."
+        base.unique_option :output, type: :string, default: ENV.fetch("SPECWRK_OUT", ".specwrk/"), aliases: ["-o"], desc: "Directory where worker output is stored. Overrides SPECWRK_OUT. Default '.specwrk/'."
       end
 
       on_setup do |id:, count:, output:, **|
@@ -66,14 +66,16 @@ module Specwrk
       extend Hookable
 
       on_included do |base|
-        base.option :port, type: :integer, default: ENV.fetch("SPECWRK_SRV_PORT", "5138"), aliases: ["-p"], desc: "Server port"
-        base.option :key, type: :string, aliases: ["-k"], default: ENV.fetch("SPECWRK_SRV_KEY", ""), desc: "Authentication key clients must use for access"
-        base.option :output, type: :string, default: ENV.fetch("SPECWRK_OUT", ".specwrk/"), aliases: ["-o"], desc: "Directory where worker output is stored"
-        base.option :single_run, type: :boolean, default: !ENV["SPECWRK_SRV_SINGLE_RUN"].nil?, desc: "Act on shutdown requests from clients"
-        base.option :group_by, values: %w[file timings], default: ENV.fetch("SPECWERK_SRV_GROUP_BY", "timings"), desc: "How examples will be grouped for workers; fallback to file if no timings are found"
+        base.unique_option :port, type: :integer, default: ENV.fetch("SPECWRK_SRV_PORT", "5138"), aliases: ["-p"], desc: "Server port. Overrides SPECWRK_SRV_PORT. Default 5138."
+        base.unique_option :key, type: :string, aliases: ["-k"], default: ENV.fetch("SPECWRK_SRV_KEY", ""), desc: "Authentication key clients must use for access. Overrides SPECWRK_SRV_KEY. Default ''."
+        base.unique_option :output, type: :string, default: ENV.fetch("SPECWRK_OUT", ".specwrk/"), aliases: ["-o"], desc: "Directory where worker output is stored. Overrides SPECWRK_OUT. Default '.specwrk/'."
+        base.unique_option :group_by, values: %w[file timings], default: ENV.fetch("SPECWERK_SRV_GROUP_BY", "timings"), desc: "How examples will be grouped for workers; fallback to file if no timings are found. Overrides SPECWERK_SRV_GROUP_BY. Default timings."
+        base.unique_option :single_run, type: :boolean, default: false, desc: "Act on shutdown requests from clients. Default: false."
+        base.unique_option :verbose, type: :boolean, default: false, desc: "Run in verbose mode. Default false."
       end
 
-      on_setup do |output:, port:, key:, single_run:, group_by:, **|
+      on_setup do |output:, port:, key:, single_run:, group_by:, verbose:, **|
+        ENV["SPECWRK_SRV_LOG"] = Pathname.new(File.join(output, "server.log")).expand_path(Dir.pwd).to_s if output && !verbose
         ENV["SPECWRK_SRV_OUTPUT"] = Pathname.new(File.join(output, "report.json")).expand_path(Dir.pwd).to_s if output
         ENV["SPECWRK_SRV_PORT"] = port
         ENV["SPECWRK_SRV_KEY"] = key
@@ -136,7 +138,7 @@ module Specwrk
     class Serve < Dry::CLI::Command
       include Servable
 
-      desc "Start a server"
+      desc "Start a queue server"
 
       def call(**args)
         self.class.setup(**args)
@@ -170,6 +172,7 @@ module Specwrk
           Specwrk::Web::App.run!
         end
 
+        return if Specwrk.force_quit
         seed_pid = Process.fork do
           require "specwrk/list_examples"
           require "specwrk/client"
@@ -186,12 +189,15 @@ module Specwrk
 
         wait_for_pids_exit([seed_pid])
 
+        return if Specwrk.force_quit
         status "Starting #{worker_count} workers..."
         start_workers
 
         status "#{worker_count} workers started ✓\n"
         wait_for_pids_exit(@worker_pids)
 
+        return if Specwrk.force_quit
+
         require "specwrk/cli_reporter"
         status = Specwrk::CLIReporter.new.report
 

data/lib/specwrk/hookable.rb

@@ -35,6 +35,10 @@ module Hookable
   end
 
   module ClassMethods
+    def unique_option(name, opts = {})
+      option(name, opts) unless options.find { |existing_option| existing_option.name == name }
+    end
+
     def setup(**args)
       setup_hooks.each { |blk| blk.call(**args) }
     end

data/lib/specwrk/version.rb

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

data/lib/specwrk/web/app.rb

@@ -10,33 +10,49 @@ rescue LoadError
   require "rack/handler/webrick"
 end
 
+require "specwrk/web/logger"
 require "specwrk/web/auth"
 require "specwrk/web/endpoints"
 
 module Specwrk
   class Web
     class App
-      def self.run!
-        Process.setproctitle "specwrk-server"
+      class << self
+        def run!
+          Process.setproctitle "specwrk-server"
 
-        server_opts = {
-          Port: ENV.fetch("SPECWRK_SRV_PORT", "5138").to_i,
-          Logger: WEBrick::Log.new($stdout, WEBrick::Log::FATAL),
-          AccessLog: [],
-          KeepAliveTimeout: 300
-        }
+          if ENV["SPECWRK_SRV_LOG"]
+            $stdout.reopen(ENV["SPECWRK_SRV_LOG"], "w")
+          end
+
+          server_opts = {
+            Port: ENV.fetch("SPECWRK_SRV_PORT", "5138").to_i,
+            Logger: WEBrick::Log.new($stdout, WEBrick::Log::FATAL),
+            AccessLog: [],
+            KeepAliveTimeout: 300
+          }
 
-        # rack v3 or v2
-        handler_klass = defined?(Rackup::Handler) ? Rackup::Handler::WEBrick : Rack::Handler.get("webrick")
+          # rack v3 or v2
+          handler_klass = defined?(Rackup::Handler) ? Rackup::Handler::WEBrick : Rack::Handler.get("webrick")
 
-        handler_klass.run(rackup, **server_opts) do |server|
-          ["INT", "TERM"].each do |sig|
-            trap(sig) do
-              puts "\n→ Shutting down gracefully..." unless ENV["SPECWRK_FORKED"]
-              server.shutdown
+          handler_klass.run(rackup, **server_opts) do |server|
+            ["INT", "TERM"].each do |sig|
+              trap(sig) do
+                puts "\n→ Shutting down gracefully..." unless ENV["SPECWRK_FORKED"]
+                server.shutdown
+              end
             end
           end
         end
+
+        def rackup
+          Rack::Builder.new do
+            use Rack::Runtime
+            use Specwrk::Web::Logger, $stdout
+            use Specwrk::Web::Auth          # global auth check
+            run Specwrk::Web::App.new       # your router
+          end
+        end
       end
 
       def call(env)
@@ -47,13 +63,6 @@ module Specwrk
           .response
       end
 
-      private_class_method def self.rackup
-        Rack::Builder.new do
-          use Specwrk::Web::Auth          # global auth check
-          run Specwrk::Web::App.new       # your router
-        end
-      end
-
       def route(method:, path:)
         case [method, path]
         when ["GET", "/heartbeat"]

data/lib/specwrk/web/logger.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Specwrk
+  class Web
+    class Logger
+      def initialize(app, out = $stdout)
+        @app, @out = app, out
+      end
+
+      def call(env)
+        start_time = Time.now
+        start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        status, headers, body = @app.call(env)
+        dur_ms = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start) * 1000).round(4)
+
+        remote = env["REMOTE_ADDR"] || env["REMOTE_HOST"] || "-"
+        @out.puts "#{remote} [#{start_time.iso8601(6)}] #{env["REQUEST_METHOD"]} #{env["PATH_INFO"]} → #{status} (#{dur_ms}ms)"
+        [status, headers, body]
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: specwrk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Daniel Westendorf
@@ -147,6 +147,7 @@ files:
 - lib/specwrk/web/app.rb
 - lib/specwrk/web/auth.rb
 - lib/specwrk/web/endpoints.rb
+- lib/specwrk/web/logger.rb
 - lib/specwrk/worker.rb
 - lib/specwrk/worker/completion_formatter.rb
 - lib/specwrk/worker/executor.rb