service_skeleton 2.0.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d49a02ddaf68cb61da78352ed7f114f1ba12034dcd02852ce20aab2c87ea390
-  data.tar.gz: 9090f37cac4cc61fa538fc56a34c859fd44adc252e0fd212ea3a63a877a46666
+  metadata.gz: f06ab46da1ee2c8366933e34efe02686cfca1758cff0667fb05b6ef5a42e9db6
+  data.tar.gz: 17cc7ba27c8cd63f6e74831e69da68c860803af15e77eb6f4a52686754107138
 SHA512:
-  metadata.gz: 85685190eb12f5072744e7098f529cf12fc4755483fee50a47f8f46db7b83acf587eed549e973a02d903dd4a5d9bf9929c24a515996002e6b072629ff780af9d
-  data.tar.gz: e80d673512846c362094c962b21ffdababeae718194d9ba48b60dc73f733b8ccc820fbff8c1766f1a48eb4ccc2deb912fb6194bd788d526d7241bfd10b9d9295
+  metadata.gz: c3137b6133e59bd2c9aa990bd85216b6acdf09a1d6174ae0fa06a1c2ff55e898f266f131a69457dd39f363fcdef35d67d0f9fd1e9255f6a8e9b4ebdd2f4a5ed9
+  data.tar.gz: dbba001733bcf0717673335d1ff52d6eb33b0a88b602c7f3be2d378addb37c0da585fba5c15d6ddff106f0dd69663935d541583ea521376b8136711eef53f3b8

data/.github/workflows/ci.yml

@@ -4,23 +4,41 @@ on:
   pull_request:
   push:
     branches:
-      - master
       - main
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.2"
+          bundler-cache: true
+
+      - name: Lint
+        run: bundle exec rubocop
+
   build:
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
+
       matrix:
         ruby:
-          - 2.5
-          - 2.6
-          - 2.7
-          - 3.0
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
@@ -28,22 +46,19 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - name: Lint
-        run: bundle exec rubocop
-
       - name: Tests
         run: bundle exec rake test
 
   publish:
-    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
-    needs: build
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: [lint, build]
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@v2-beta
+        uses: discourse/publish-rubygems-action@v3
         env:
           RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
           GIT_EMAIL: team@discourse.org

data/.rubocop.yml

@@ -8,4 +8,4 @@ inherit_mode:
 RSpec/MessageSpies:
   EnforcedStyle: receive
   Exclude:
-    - "ultravisor/**/*"
+    - "ultravisor/**/*"

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"
 
       # ...
 

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.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

@@ -3,7 +3,7 @@
 Gem::Specification.new do |s|
   s.name = "service_skeleton"
 
-  s.version = '2.0.2'
+  s.version = '2.2.0'
 
   s.platform = Gem::Platform::RUBY
 
@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'redcarpet'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop-discourse', '~> 2.4.1'
+  s.add_development_dependency 'rubocop-discourse', '~> 3.4.1'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'yard'
 end

data/ultravisor/lib/ultravisor/child/call_receiver.rb

@@ -11,4 +11,5 @@ class Ultravisor::Child::CallReceiver < BasicObject
     @blk.call(callback)
     rv_q.pop.tap { |rv| ::Kernel.raise ::Ultravisor::ChildRestartedError.new if rv == rv_fail }
   end
+  ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
 end

data/ultravisor/lib/ultravisor/child/cast_receiver.rb

@@ -8,4 +8,5 @@ class Ultravisor::Child::CastReceiver < BasicObject
     castback = ::Ultravisor::Child::Cast.new(name, args, blk)
     @blk.call(castback)
   end
+  ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
 end

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/cast_spec.rb

@@ -106,6 +106,30 @@ describe Ultravisor::Child do
 
         expect { child.cast.to_s }.to_not raise_error
       end
+
+      context "with keyword arguments" do
+        class Child
+          def run
+          end
+
+          def process
+            process_castcall
+          end
+
+          def kwarg(message:)
+            raise "#{message} was passed"
+          end
+        end
+
+        let(:args) do
+          { id: :child, klass: Child, method: :run, enable_castcall: true, access: :unsafe }
+        end
+
+        it "forwards them" do
+          child.cast.kwarg(message: "hey")
+          expect { child.unsafe_instance.process }.to raise_error("hey was passed")
+        end
+      end
     end
   end
 end

data/ultravisor/spec/ultravisor/child/restart_delay_spec.rb

@@ -10,7 +10,7 @@ describe Ultravisor::Child do
   let(:mock_class) { Class.new.tap { |k| k.class_eval { def run; end } } }
 
   describe "#restart_delay" do
-    context "by default" do
+    context "with default args" do
       let(:args) { base_args }
 
       it "returns the default delay" do

data/ultravisor/spec/ultravisor/child/shutdown_spec.rb

@@ -77,7 +77,7 @@ describe Ultravisor::Child do
           expect(@thread).to have_received(:join).with(0.05)
         end
 
-        context "the worker doesn't finish quickly enough" do
+        context "when the worker doesn't finish quickly enough" do
           before(:each) do
             allow(mock_instance).to receive(:run) { sleep 15 }
           end

data/ultravisor/spec/ultravisor/child/unsafe_instance_spec.rb

@@ -10,7 +10,7 @@ describe Ultravisor::Child do
   let(:child) { Ultravisor::Child.new(**args) }
 
   describe "#unsafe_instance" do
-    context "by default" do
+    context "with default args" do
       it "explodes" do
         expect { child.unsafe_instance }.to raise_error(Ultravisor::ThreadSafetyError)
       end

data/ultravisor/spec/ultravisor/run_spec.rb

@@ -69,13 +69,13 @@ describe Ultravisor do
         ultravisor.run
       end
 
-      context "that terminates" do
+      context "when the child terminates" do
         before(:each) do
           allow(ultravisor.instance_variable_get(:@queue)).to receive(:pop).and_return(child, :shutdown)
           allow(ultravisor).to receive(:sleep)
         end
 
-        context "within the limits of its restart policy" do
+        context "when in the limits of its restart policy" do
           it "spawns the child again" do
             expect(child).to receive(:spawn).exactly(:twice)
 
@@ -89,7 +89,7 @@ describe Ultravisor do
           end
         end
 
-        context "too often for its restart policy" do
+        context "when it terminates too often for its restart policy" do
           before(:each) do
             allow(child).to receive(:restart?).and_raise(Ultravisor::BlownRestartPolicyError)
             allow(logger).to receive(:error)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: service_skeleton
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Matt Palmer
 - Sam Saffron
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: frankenstein
@@ -199,14 +199,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 3.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 3.4.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -275,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
@@ -319,7 +321,7 @@ files:
 homepage: https://github.com/discourse/service_skeleton
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -334,8 +336,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: The bare bones of a service
 test_files: []