service_skeleton 1.0.5 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 020137b90b172033166a44e4e8f94094a2cb35f8886a185dbfaa8a47a29cff71
-  data.tar.gz: 85da8294b7d0c158404ef42ffb4969a7f02560ad35b4a5b9713bacbfb50ab9f4
+  metadata.gz: 2eb043ee79208c4b1b457b1b9deb2b5901119339c9789d8a6d511870bc038e46
+  data.tar.gz: 6848edcb6fe369e5a6ce0dcf823780ee8047f8953b40ea261e03aa0f47314d27
 SHA512:
-  metadata.gz: 39d9073b15a24f9b13ffc6bcaa7c60756e425301749fdf6b90e08b132bd7eadeb1ac90c75e0398e2704d57e1bc849edb9ecdfd78270d98b033a51dd7277addc0
-  data.tar.gz: 7cc439b11c6f36df6b2b0282e6f7661ef3c78caa496396ce1260a7d6ab66ccc7aef9a7d5debdd5e38ae2ff74d9833c7bf465f0167d74e7e649b952e882c73858
+  metadata.gz: 43fe6a4e0ad9adb50cd78c09c41063df614a0116c194283710660b24f2877994038bb818e35ad78eb7b72da62c3ec7e75646fc2bfae5c6f85ef5fdd7a5289dba
+  data.tar.gz: 9aacd383f2d867a51b19adc8c1d501ad383497d13a72de0b8fa9992301b029cd23e60aaa3c72511e98f240ed060dd1dab6b8b38a89a9de3cce19a40c8c696f39

data/.github/workflows/ci.yml

@@ -4,7 +4,8 @@ on:
   pull_request:
   push:
     branches:
-      - "v1_0"
+      - master
+      - main
 
 jobs:
   build:
@@ -14,6 +15,9 @@ jobs:
       matrix:
         ruby:
           - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
 
     steps:
       - uses: actions/checkout@v2
@@ -31,7 +35,7 @@ jobs:
         run: bundle exec rake test
 
   publish:
-    if: github.event_name == 'push' && (github.ref == 'refs/heads/v1_0')
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
     needs: build
     runs-on: ubuntu-latest
 

data/README.md

@@ -268,7 +268,7 @@ default for a config variable, like so:
     class GenericHelloService
       include ServiceSkeleton
 
-      string :RECIPIENT, match: /\a\w+\z/, default: "Anonymous Coward"
+      string :RECIPIENT, match: /\A\w+\z/, default: "Anonymous Coward"
 
       # ...
 
@@ -448,8 +448,7 @@ portion is the all-uppercase [service name](#the-service-name).
 
         INFO,buggy=DEBUG,/noisy/i=ERROR
 
-  Logging levels can be changed at runtime, via [signals](#default-signals) or
-  [the HTTP admin interface](#http-admin-interface).
+  Logging levels can be changed at runtime via [signals](#default-signals).
 
 * **`<SERVICENAME>_LOGSTASH_SERVER`** (string; default `""`) -- if set to a
   non-empty string, we will engage the services of the [loggerstash
@@ -686,57 +685,6 @@ When the service is shutdown, all signal handlers will be automatically
 unhooked, which saves you having to do it yourself.
 
 
-## HTTP Admin Interface
-
-In these modern times we live in, it seems everything from nuclear reactors to
-toasters can be controlled from a browser.  Why should your services be any
-different?
-
-
-### HTTP Admin Configuration
-
-In the spirit of "secure by default", you must explicitly enable the HTTP admin
-interface, and configure an authentication method.  To do that, use the
-following environment variables, where `<SERVICENAME>_` is the all-uppercase
-version of [the service name](#the-service-name).
-
-* **`<SERVICENAME>_HTTP_ADMIN_PORT`** (integer; range 1..65535; default: `""`)
-  -- if set to a valid port number (`1` to `65535` inclusive), the HTTP admin
-  interface will listen on that port, if also enabled by configuring
-  authentication.
-
-* **`<SERVICENAME>_HTTP_ADMIN_BASIC_AUTH`** (string; default: `""`) -- if set
-  to a string containing a username and password separated by a colon, then
-  authentication via [HTTP Basic auth](https://tools.ietf.org/html/rfc7617)
-  will be supported.  Note that in addition to this setting, an admin port must
-  also be specified in order for the admin interface to be enabled.
-
-* **`<SERVICENAME>_HTTP_ADMIN_PROXY_USERNAME_HEADER`** (string; default: `""`)
-  -- if set to a non-empty string, then incoming requests will be examined for
-  a HTTP header with the specified name.  If such a header exists and has a
-  non-empty value, then the request will be deemed to have been authenticated
-  by an upstream authenticating proxy (such as
-  [`discourse-auth-proxy`](https://github.com/discourse/discourse-auth-proxy))
-  as the user given in the header value.  Note that in addition to this
-  setting, an admin port must also be specified in order for the admin
-  interface to be enabled.
-
-
-### HTTP Admin Usage
-
-The HTTP admin interface provides both an interactive, browser-based mode,
-as well as a RESTful interface, which should, in general, provide equivalent
-functionality.
-
-* Visiting the service's `IP address:port` in a web browser will bring up an HTML
-  interface showing all the features that are available.  Usage should
-  (hopefully) be self-explanatory.
-
-* Visiting the service's `IP address:port` whilst accepting `application/json`
-  responses will provide a directory of links to available endpoints which you
-  can use to interact with the HTTP admin interface programmatically.
-
-
 # Contributing
 
 Patches can be sent as [a Github pull

data/lib/service_skeleton/generator.rb

@@ -16,8 +16,8 @@ module ServiceSkeleton
   module Generator
     def generate(config:, metrics_registry:, service_metrics:, service_signal_handlers:)
       Ultravisor.new(logger: config.logger).tap do |ultravisor|
-        initialize_metrics(ultravisor, config, metrics_registry, service_metrics)
         initialize_loggerstash(ultravisor, config, metrics_registry)
+        initialize_metrics(ultravisor, config, metrics_registry, service_metrics)
         initialize_signals(ultravisor, config, service_signal_handlers, metrics_registry)
       end
     end

data/lib/service_skeleton/hurriable_timer.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# A mechanism for waiting until a timer expires or until another thread signals
+# readiness.
+class ServiceSkeleton::HurriableTimer
+  def initialize(timeout)
+    @mutex = Mutex.new
+    @condition = ConditionVariable.new
+    @end_time = now + timeout
+    @hurried = false
+  end
+
+  # Wait for the timer to elapse
+  #
+  # Any number of threads can wait on the same HurriableTimer
+  def wait(t = nil)
+    end_time =
+      if t
+        [@end_time, now + t].min
+      else
+        @end_time
+      end
+
+    @mutex.synchronize {
+      while true
+        remaining = end_time - now
+
+        if remaining < 0 || @hurried
+          break
+        else
+          @condition.wait(@mutex, remaining)
+        end
+      end
+    }
+
+    nil
+  end
+
+  # Cause the timer to trigger early if it hasn't already expired
+  #
+  # This method is idempotent
+  def hurry!
+    @mutex.synchronize {
+      @hurried = true
+      @condition.broadcast
+    }
+
+    nil
+  end
+
+  def expired?
+    @hurried || @end_time - now < 0
+  end
+
+  private
+
+  def now
+    # Using this instead of Time.now, because it isn't affected by NTP updates
+    Process.clock_gettime(Process::CLOCK_MONOTONIC_RAW)
+  end
+end

data/lib/service_skeleton/hurriable_timer_sequence.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# HurribleTimerSequence is a resettable version of HurriableTimer, designed for
+# cases where some action needs to happen at at least some frequency, but may
+# happen more often when other threads trigger the process early.
+#
+# It would have been possible to implement this without requiring allocation on
+# reset, by reusing the mutex and condition variable in the normal timer, but
+# this version is more obviously correct.
+class ServiceSkeleton::HurriableTimerSequence
+  def initialize(timeout)
+    @mutex = Mutex.new
+    @timeout = timeout
+    @latest = ServiceSkeleton::HurriableTimer.new(@timeout)
+  end
+
+  def reset!
+    @mutex.synchronize {
+      @latest.hurry!
+      @latest = ServiceSkeleton::HurriableTimer.new(@timeout)
+    }
+  end
+
+  def wait(t = nil)
+    @mutex.synchronize { @latest }.wait(t)
+  end
+
+  def hurry!
+    @mutex.synchronize { @latest }.hurry!
+  end
+
+  def expired?
+    @mutex.synchronize { @latest }.expired?
+  end
+end

data/lib/service_skeleton/signal_manager.rb

@@ -81,7 +81,7 @@ module ServiceSkeleton
               logger.error(logloc) { "Mysterious return from select: #{ios.inspect}" }
             end
           end
-        rescue IOError
+        rescue IOError, Errno::EBADF
           # Something has gone terribly wrong here... bail
           break
         rescue StandardError => ex

data/lib/service_skeleton.rb

@@ -3,6 +3,8 @@
 require_relative "service_skeleton/config_class"
 require_relative "service_skeleton/config_variables"
 require_relative "service_skeleton/generator"
+require_relative "service_skeleton/hurriable_timer"
+require_relative "service_skeleton/hurriable_timer_sequence"
 require_relative "service_skeleton/logging_helpers"
 require_relative "service_skeleton/metrics_methods"
 require_relative "service_skeleton/service_name"

data/service_skeleton.gemspec

@@ -1,15 +1,9 @@
 # frozen_string_literal: true
 
-begin
-  require 'git-version-bump'
-rescue LoadError
-  nil
-end
-
 Gem::Specification.new do |s|
   s.name = "service_skeleton"
 
-  s.version = '1.0.5'
+  s.version = '2.1.0'
 
   s.platform = Gem::Platform::RUBY
 
@@ -32,22 +26,20 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.5.0"
 
   s.add_runtime_dependency "frankenstein", "~> 2.0"
-  s.add_runtime_dependency "loggerstash", ">= 0.0.9", "< 1"
+  s.add_runtime_dependency "loggerstash", "~> 1"
   s.add_runtime_dependency "prometheus-client", "~> 2.0"
   s.add_runtime_dependency "sigdump", "~> 0.2"
   s.add_runtime_dependency "to_regexp", "~> 0.2"
+  s.add_runtime_dependency "webrick"
 
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'github-release'
-  s.add_development_dependency 'git-version-bump'
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'guard-rubocop'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'redcarpet'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'rubocop-discourse'
+  s.add_development_dependency 'rubocop-discourse', '~> 2.4.1'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'yard'
 end

data/ultravisor/lib/ultravisor/child.rb

@@ -381,6 +381,10 @@ class Ultravisor
       # urgh.
       if @klass.instance_method(:initialize).arity == 0
         @klass.new()
+      elsif @args.is_a?(Hash)
+        @klass.new(**@args)
+      elsif @args.last.is_a?(Hash)
+        @klass.new(*@args[0...-1], **@args.last)
       else
         @klass.new(*@args)
       end.tap do |i|

data/ultravisor/spec/spec_helper.rb

@@ -7,8 +7,10 @@ require 'rspec/mocks'
 Thread.report_on_exception = false
 
 require 'simplecov'
-SimpleCov.start do
-  add_filter('spec')
+unless SimpleCov.running
+  SimpleCov.start do
+    add_filter('spec')
+  end
 end
 
 class ListIncompletelyCoveredFiles

data/ultravisor/spec/ultravisor/child/spawn_spec.rb

@@ -93,14 +93,123 @@ describe Ultravisor::Child do
       end
     end
 
-    context "with a worker class that takes args" do
+    context "with a worker class that takes only non-keyword args" do
+      let(:args) { { id: :testy, klass: mock_class, args: ["foo", "bar"], method: :run } }
+      let(:mock_class) do
+        Class.new do
+          def initialize(foo, bar)
+          end
+
+          def run
+          end
+        end
+      end
+
+      it "creates the class instance with args" do
+        allow(mock_class).to receive(:new).and_call_original
+
+        child.spawn(term_queue).wait
+        expect(mock_class).to have_received(:new).with("foo", "bar")
+      end
+    end
+
+    context "with a worker class that takes non-keyword and optional args" do
       let(:args) { { id: :testy, klass: mock_class, args: ["foo", "bar", baz: "wombat"], method: :run } }
-      let(:mock_class) { Class.new.tap { |k| k.class_eval { def initialize(*x); end; def run; end } } }
+      let(:mock_class) do
+        Class.new do
+          def initialize(foo, bar, baz = {})
+          end
+
+          def run
+          end
+        end
+      end
 
       it "creates the class instance with args" do
-        expect(mock_class).to receive(:new).with("foo", "bar", baz: "wombat").and_call_original
+        allow(mock_class).to receive(:new).and_call_original
 
         child.spawn(term_queue).wait
+        expect(mock_class).to have_received(:new).with("foo", "bar", { baz: "wombat" })
+      end
+    end
+
+    context "with a worker class that takes mixed args" do
+      let(:args) { { id: :testy, klass: mock_class, args: ["foo", "bar", baz: "wombat"], method: :run } }
+      let(:mock_class) do
+        Class.new do
+          def initialize(foo, bar, baz:)
+          end
+
+          def run
+          end
+        end
+      end
+
+      it "creates the class instance with args" do
+        allow(mock_class).to receive(:new).and_call_original
+
+        child.spawn(term_queue).wait
+        expect(mock_class).to have_received(:new).with("foo", "bar", baz: "wombat")
+      end
+    end
+
+    context "with a worker class that takes keyword args" do
+      let(:args) { { id: :testy, klass: mock_class, args: [foo: "bar", baz: "wombat"], method: :run } }
+      let(:mock_class) do
+        Class.new do
+          def initialize(foo:, baz:)
+          end
+
+          def run
+          end
+        end
+      end
+
+      it "creates the class instance with args" do
+        allow(mock_class).to receive(:new).and_call_original
+
+        child.spawn(term_queue).wait
+        expect(mock_class).to have_received(:new).with(foo: "bar", baz: "wombat")
+      end
+    end
+
+    context "with a worker class that takes optional args" do
+      let(:args) { { id: :testy, klass: mock_class, args: [foo: "bar", baz: "wombat", fib: "wib", woop: "woob"], method: :run } }
+      let(:mock_class) do
+        Class.new do
+          def initialize(foo:, baz:, fib: "none", woop: nil)
+          end
+
+          def run
+          end
+        end
+      end
+
+      it "creates the class instance with args" do
+        allow(mock_class).to receive(:new).and_call_original
+        child.spawn(term_queue).wait
+
+        expect(mock_class).to have_received(:new).with(foo: "bar", baz: "wombat", fib: "wib", woop: "woob")
+      end
+    end
+
+    context "with a worker class that takes keyword args in form of a hash" do
+      let(:args) { { id: :testy, klass: mock_class, args: { foo: "bar", baz: "wombat" }, method: :run } }
+      let(:mock_class) do
+        Class.new do
+          def initialize(foo:, baz:)
+          end
+
+          def run
+          end
+        end
+      end
+
+      it "creates the class instance with args" do
+        allow(mock_class).to receive(:new).and_call_original
+        child.spawn(term_queue).wait
+
+        expect(mock_class).to have_received(:new).with(foo: "bar", baz: "wombat")
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: service_skeleton
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.1.0
 platform: ruby
 authors:
 - Matt Palmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: frankenstein
@@ -29,20 +29,14 @@ dependencies:
   name: loggerstash
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.9
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.9
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
@@ -88,27 +82,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: github-release
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -116,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: git-version-bump
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -213,34 +193,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -309,6 +275,8 @@ files:
 - lib/service_skeleton/error.rb
 - lib/service_skeleton/filtering_logger.rb
 - lib/service_skeleton/generator.rb
+- lib/service_skeleton/hurriable_timer.rb
+- lib/service_skeleton/hurriable_timer_sequence.rb
 - lib/service_skeleton/logging_helpers.rb
 - lib/service_skeleton/metric_method_name.rb
 - lib/service_skeleton/metrics_methods.rb
@@ -368,7 +336,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: The bare bones of a service