service_skeleton 0.0.0.44.g75d07d7 → 1.0.3

data/lib/service_skeleton/signals_methods.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ServiceSkeleton
+  module SignalsMethods
+    def registered_signal_handlers
+      @registered_signal_handlers || []
+    end
+
+    def hook_signal(sigspec, &blk)
+      @registered_signal_handlers ||= []
+
+      @registered_signal_handlers << [sigspec, blk]
+    end
+  end
+end

data/lib/service_skeleton/ultravisor_children.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ServiceSkeleton
+  module UltravisorChildren
+    def register_ultravisor_children(ultravisor, config:, metrics_registry:)
+      begin
+        ultravisor.add_child(
+          id: self.service_name.to_sym,
+          klass: self,
+          method: :run,
+          args: [config: config, metrics: metrics_registry],
+          access: :unsafe
+        )
+      rescue Ultravisor::InvalidKAMError
+        raise ServiceSkeleton::Error::InvalidServiceClassError,
+              "Class #{self.to_s} does not implement the `run' instance method"
+      end
+    end
+  end
+end

data/lib/service_skeleton/ultravisor_loggerstash.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ServiceSkeleton
+  module UltravisorLoggerstash
+    def logstash_writer
+      #:nocov:
+      @ultravisor[:logstash_writer].unsafe_instance
+      #:nocov:
+    end
+  end
+end

data/service_skeleton.gemspec

@@ -24,22 +24,20 @@ Gem::Specification.new do |s|
     common aspects of a system service.
   EOF
 
-  s.authors  = ["Matt Palmer"]
-  s.email    = ["matt.palmer@discourse.org"]
+  s.authors  = ["Matt Palmer", "Sam Saffron"]
+  s.email    = ["sam.saffron@discourse.org"]
   s.homepage = "https://github.com/discourse/service_skeleton"
 
   s.files = `git ls-files -z`.split("\0").reject { |f| f =~ /^(G|spec|Rakefile)/ }
 
   s.required_ruby_version = ">= 2.5.0"
 
-  s.add_runtime_dependency "frankenstein", "~> 1.2"
-  s.add_runtime_dependency "loggerstash", "~> 0.0"
-  # prometheus-client provides no guaranteed backwards compatibility,
-  # and in fact happily breaks things with no notice, so we're stuck
-  # with hard-coding a specific version to avoid unexpected disaster.
-  s.add_runtime_dependency "prometheus-client", "0.8.0"
+  s.add_runtime_dependency "frankenstein", "~> 2.0"
+  s.add_runtime_dependency "loggerstash", ">= 0.0.9", "< 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 "ultravisor", "~> 0.a"
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'github-release'
@@ -47,10 +45,11 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'guard-rubocop'
   s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'rake', "~> 12.0"
+  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 'simplecov'
   s.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: service_skeleton
 version: !ruby/object:Gem::Version
-  version: 0.0.0.44.g75d07d7
+  version: 1.0.3
 platform: ruby
 authors:
 - Matt Palmer
-autorequire: 
+- Sam Saffron
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-26 00:00:00.000000000 Z
+date: 2021-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: frankenstein
@@ -16,42 +17,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: loggerstash
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.0.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: prometheus-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: sigdump
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +87,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: ultravisor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.a
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -168,16 +189,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +241,20 @@ dependencies:
     - - ">="
       - !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -256,23 +291,23 @@ description: |
   for your services, as well as a collection of helper classes to manage
   common aspects of a system service.
 email:
-- matt.palmer@discourse.org
+- sam.saffron@discourse.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - LICENCE
 - README.md
 - lib/service_skeleton.rb
-- lib/service_skeleton/background_worker.rb
 - lib/service_skeleton/config.rb
+- lib/service_skeleton/config_class.rb
 - lib/service_skeleton/config_variable.rb
 - lib/service_skeleton/config_variable/boolean.rb
 - lib/service_skeleton/config_variable/enum.rb
@@ -282,17 +317,25 @@ files:
 - lib/service_skeleton/config_variable/path_list.rb
 - lib/service_skeleton/config_variable/string.rb
 - lib/service_skeleton/config_variable/url.rb
+- lib/service_skeleton/config_variable/yaml_file.rb
 - lib/service_skeleton/config_variables.rb
 - lib/service_skeleton/error.rb
 - lib/service_skeleton/filtering_logger.rb
+- lib/service_skeleton/generator.rb
 - lib/service_skeleton/logging_helpers.rb
+- lib/service_skeleton/metric_method_name.rb
 - lib/service_skeleton/metrics_methods.rb
-- lib/service_skeleton/signal_handler.rb
+- lib/service_skeleton/runner.rb
+- lib/service_skeleton/service_name.rb
+- lib/service_skeleton/signal_manager.rb
+- lib/service_skeleton/signals_methods.rb
+- lib/service_skeleton/ultravisor_children.rb
+- lib/service_skeleton/ultravisor_loggerstash.rb
 - service_skeleton.gemspec
 homepage: https://github.com/discourse/service_skeleton
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -303,12 +346,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: The bare bones of a service
 test_files: []

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-
-rvm:
-  - 2.5.3
-  - 2.4.5
-  - 2.3.8
-
-gemfile:
-  - Gemfile

data/lib/service_skeleton/background_worker.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-class ServiceSkeleton
-  module BackgroundWorker
-    include ServiceSkeleton::LoggingHelpers
-
-    # async code is a shit to test, and rarely finds bugs anyway, so let's
-    # just
-    #:nocov:
-    # this whole thing.
-
-    # This signal is raised internally if needed to shut down a worker thread.
-    class TerminateBackgroundThread < Exception; end
-    private_constant :TerminateBackgroundThread
-
-    def initialize(*_)
-      @bg_worker_op_mutex = Mutex.new
-      @bg_worker_op_cv    = ConditionVariable.new
-
-      begin
-        super
-      rescue ArgumentError => ex
-        if ex.message =~ /wrong number of arguments.*expected 0/
-          super()
-        else
-          raise
-        end
-      end
-    end
-
-    def start!
-      @bg_worker_op_mutex.synchronize do
-        return if @bg_worker_thread
-
-        @bg_worker_thread = Thread.new do
-          Thread.current.name = self.class.to_s
-
-          Thread.handle_interrupt(Exception => :never) do
-            logger.debug("BackgroundWorker(#{self.class})#start!") { "Background worker thread #{Thread.current.object_id} starting" }
-            begin
-              Thread.handle_interrupt(Exception => :immediate) do
-                @bg_worker_op_mutex.synchronize { @bg_worker_op_cv.signal }
-                self.start
-              end
-            rescue TerminateBackgroundThread
-              logger.debug("BackgroundWorker(#{self.class})#start!") { "Background worker thread #{Thread.current.object_id} received magical termination exception" }
-            rescue Exception => ex
-              log_exception(ex) { "Background worker thread #{Thread.current.object_id} received fatal exception" }
-            else
-              logger.debug("BackgroundWorker(#{self.class})#start!") { "Background worker thread #{Thread.current.object_id} terminating" }
-            end
-          end
-          logger.debug("BackgroundWorker(#{self.class})#start!") { "Background worker thread #{Thread.current.object_id} is now done" }
-        end
-
-        @bg_worker_op_cv.wait(@bg_worker_op_mutex) until @bg_worker_thread
-      end
-    end
-
-    def stop!(force = nil)
-      @bg_worker_op_mutex.synchronize do
-        return if @bg_worker_thread.nil?
-
-        logger.debug("BackgroundWorker(#{self.class})#stop!") { "Terminating worker thread #{@bg_worker_thread.object_id} as requested" }
-
-        if force == :force
-          logger.debug(logloc) { "Forcing termination" }
-          @bg_worker_thread.raise(TerminateBackgroundThread)
-        else
-          logger.debug(logloc) { "Gracefully terminating worker thread" }
-          shutdown
-        end
-
-        begin
-          logger.debug(logloc) { "Waiting for worker thread #{@bg_worker_thread.object_id} to finish itself off" }
-          @bg_worker_thread.join unless @bg_worker_thread == Thread.current
-        rescue TerminateBackgroundThread
-          nil
-        end
-
-        @bg_worker_thread = nil
-
-        logger.debug("BackgroundWorker(#{self.class})#stop!") { "Worker thread #{@bg_worker_thread.object_id} terminated" }
-      end
-    end
-
-    private
-
-    attr_reader :logger
-
-    def shutdown
-      logger.debug("BackgroundWorker(#{self.class})#stop!") { "Using default shutdown method" }
-      @bg_worker_thread.raise(TerminateBackgroundThread) if @bg_worker_thread
-    end
-  end
-end

data/lib/service_skeleton/signal_handler.rb

@@ -1,197 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./background_worker"
-require_relative "./logging_helpers"
-
-class ServiceSkeleton
-  # Manage signals in a sane and safe manner.
-  #
-  # Signal handling is a shit of a thing.  The code that runs when a signal is
-  # triggered can't use mutexes (which are used in all sorts of places you
-  # might not expect, like Logger!) or anything else that might block.  This
-  # greatly constrains what you can do inside a signal handler, so the standard
-  # approach is to stuff a character down a pipe, and then have the *real*
-  # signal handling run later.
-  #
-  # Also, there's always the (slim) possibility that something else might have
-  # hooked into a signal we want to receive.  Because only a single signal
-  # handler can be active for a given signal at a time, we need to "chain" the
-  # existing handler, by calling the previous signal handler from our signal
-  # handler after we've done what we need to do.  This class takes care of
-  # that, too, because it's a legend.
-  #
-  # So that's what this class does: it allows you to specify signals and
-  # associated blocks of code to run, it sets up signal handlers which send
-  # notifications to a background thread and chain correctly, and it manages
-  # the background thread to receive the notifications and execute the
-  # associated blocks of code outside of the context of the signal handler.
-  #
-  class SignalHandler
-    include ServiceSkeleton::LoggingHelpers
-    include ServiceSkeleton::BackgroundWorker
-
-    # Setup a signal handler instance.
-    #
-    # A single signal handler instance can handle up to 256 hooks, potentially
-    # hooking the same signal more than once.  Use #hook_signal to register
-    # signal handling callbacks.
-    #
-    # @param logger [Logger] the logger to use for all the interesting information
-    #   about what we're up to.
-    #
-    def initialize(logger:, service:, signal_counter:)
-      @logger, @service, @signal_counter = logger, service, signal_counter
-
-      @signal_registry = []
-
-      @handler_install_mutex = Mutex.new
-
-      super
-    end
-
-    #:nocov:
-
-    # Register a callback to be executed on the receipt of a specified signal.
-    #
-    # @param sig [String, Symbol, Integer] the signal to hook into.  Anything that
-    #   `Signal.trap` will accept is OK by us, too.
-    #
-    # @param blk [Proc] the code to run when the signal is received.
-    #
-    # @return [void]
-    #
-    # @raise [RuntimeError] if you try to create more than 256 signal hooks.
-    #
-    # @raise [ArgumentError] if `sig` isn't recognised as a valid signal
-    #   specifier by `Signal.trap`.
-    #
-    def hook_signal(sig, &blk)
-      logger.debug(logloc) { "Hooking signal #{sig}" }
-
-      handler_num = @signal_registry.length
-
-      if handler_num > 255
-        raise RuntimeError,
-              "Signal hook limit reached.  Slow down there, pardner"
-      end
-
-      sigspec = { signal: sig, callback: blk }
-
-      @handler_install_mutex.synchronize do
-        if @bg_worker_thread
-          install_handler(sigspec, handler_num)
-        else
-          # If the background thread isn't running yet, the signal handler will
-          # be installed when that is started.
-          logger.debug(logloc) { "Deferring installation of handler for #{sig} (#{handler_num})" }
-        end
-
-        @signal_registry << sigspec
-      end
-    end
-
-    def start
-      @handler_install_mutex.synchronize do
-        logger.info(logloc) { "Starting signal handler with #{@signal_registry.length} hooks" }
-
-        @r, @w = IO.pipe
-
-        install_signal_handlers
-      end
-
-      loop do
-        begin
-          if ios = IO.select([@r])
-            if ios.first.include?(@r)
-              if ios.first.first.eof?
-                logger.info(logloc) { "Signal pipe closed; shutting down" }
-                break
-              else
-                c = ios.first.first.read_nonblock(1)
-                logger.debug(logloc) { "Received character #{c.inspect} from signal pipe" }
-                handle_signal(c)
-              end
-            else
-              logger.error(logloc) { "Mysterious return from select: #{ios.inspect}" }
-            end
-          end
-        rescue IOError
-          # Something has gone terribly wrong here... bail
-          break
-        rescue StandardError => ex
-          log_exception(ex) { "Exception in select loop" }
-        end
-      end
-    end
-
-    private
-
-    attr_reader :logger
-
-    # Given a character (presumably) received via the signal pipe, execute the
-    # associated handler.
-    #
-    # @param char [String] a single character, corresponding to an entry in the
-    #   signal registry.
-    #
-    # @return [void]
-    #
-    def handle_signal(char)
-      handler = @signal_registry[char.ord]
-
-      if handler
-        logger.debug(logloc) { "#{handler[:signal]} received" }
-        @signal_counter.increment(signal: handler[:signal].to_s)
-        begin
-          handler[:callback].call
-        rescue => ex
-          log_exception(ex) { "Exception in signal handler" }
-        end
-      else
-        logger.error(logloc) { "Unrecognised signal character: #{char.inspect}" }
-      end
-    end
-
-    def install_signal_handlers
-      @signal_registry.each_with_index do |sigspec, i|
-        install_handler(sigspec, i)
-      end
-    end
-
-    def install_handler(sigspec, i)
-      logger.debug(logloc) { "Installing signal handler for #{sigspec[:signal]}" }
-      chain = nil
-
-      p = ->(*args) do
-        @w.write_nonblock(i.chr) rescue nil
-        chain.call(*args) if chain.respond_to?(:call)
-      end
-      chain = Signal.trap(sigspec[:signal], &p)
-
-      sigspec[:chain] = chain
-      sigspec[:handler] = p
-    end
-
-    def shutdown
-      uninstall_signal_handlers
-
-      @r.close
-    end
-
-    def uninstall_signal_handlers
-      @signal_registry.reverse.each do |sigspec|
-        tmp_sig = Signal.trap(sigspec[:signal], "IGNORE")
-        if tmp_sig == sigspec[:handler]
-          # The current handler is ours, so we can replace
-          # it with the chained handler
-          Signal.trap(sigspec[:signal], sigspec[:chain])
-        else
-          # The current handler *isn't* this one, so we better
-          # put it back, because whoever owns it might get
-          # angry.
-          Signal.trap(sigspec[:signal], tmp_sig)
-        end
-      end
-    end
-  end
-end