service_skeleton 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e244f5193b33614d8466ccb26d2d2d10f8d8d7917c94af1d8a2ddbd492c96cab
-  data.tar.gz: 1a80f5e1ed63a03bc4eb9920bc83a4f175fcd383f7aab1c5e732da2e764416ed
+  metadata.gz: 49be65e767a3910dc054f9409a24ab558181c008549582d139f46db04f4a83b1
+  data.tar.gz: 68fd00df7f28da4ae55e3fe19f4935c109646b2873b3ea1f28b6f0d7d7af6942
 SHA512:
-  metadata.gz: 7f06bfeab8ad7401e2cdfde6ca9b2d89bf2946a65cc319b2861608a3b23a71cab91b9c438f7d212ed8326413a939dbc885d9bbd59871a78172c33e51c8b467a6
-  data.tar.gz: 3b3f6caf8be8d1cb07505b1a84f8212621faddf890c89f21988bc611d5e795e023eacb99ea31ab64de0afbf8c919fcfb1da64269494d3e3a9891ba8aa54b6039
+  metadata.gz: 8c26d8944cbdb9ff40eba5fd7fb4b1f8098f0bbfcb7946712b969a897c7b9fdeb7612e44be5d03603d7e7c11f67ec6389db200e92fef2b323d2f49631e14b994
+  data.tar.gz: f41813b872ad1308b47c1444ec9e6441ea17a8f7dc68a5e865e7d08b08784cfb35d573e38de4799dfa43ab542e09d58f8bb3127e95b7c9dc08123e0497ea7179

data/.github/workflows/ci.yml

@@ -1,52 +1,50 @@
-name: Service Skeleton Tests
+name: CI
 
 on:
   pull_request:
   push:
     branches:
       - master
-    tags:
-      - v*
+      - main
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
+
     strategy:
       matrix:
-        ruby: ["2.5", "2.6", "2.7"]
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+
     steps:
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0 # Fetch all history. Needed for `git describe`
-      - uses: actions/setup-ruby@v1
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: Bundler cache
-        uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-
-      - name: Setup gems
-        run: |
-          gem install bundler
-          bundle config path vendor/bundle
-          bundle install --jobs 4
-      - name: Rubocop
+          bundler-cache: true
+
+      - name: Lint
         run: bundle exec rubocop
+
       - name: Tests
-        run: bundle exec rspec
-      - name: Ultravisor Tests
-        run: bundle exec rspec ultravisor/spec
+        run: bundle exec rake test
+
   publish:
-    if: contains(github.ref, 'refs/tags/v')
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
     needs: build
     runs-on: ubuntu-latest
+
     steps:
       - uses: actions/checkout@v2
+
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@v1
+        uses: discourse/publish-rubygems-action@v2-beta
         env:
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          GIT_EMAIL: team@discourse.org
+          GIT_NAME: discoursebot

data/.gitignore

@@ -1,9 +1,2 @@
 Gemfile.lock
-/pkg
-/doc
-/.yardoc
 /coverage
-/.bundle
-/tmp
-
-.rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml

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

@@ -4,8 +4,16 @@ module ServiceSkeleton
   module UltravisorLoggerstash
     def logstash_writer
       #:nocov:
-      @ultravisor[:logstash_writer].unsafe_instance
+      @ultravisor[:logstash_writer].unsafe_instance(wait: false)
       #:nocov:
     end
+
+    # logstash_writer will be nil if the logstash_writer worker is not running
+    # Ultravisor's restart policy ensures this will never happen at runtime. But
+    # it does happen during startup and shutdown. In this case, we want to skip
+    # writing to logstash, not block forever. STDOUT logging will continue.
+    def loggerstash_log_message(*args)
+      super if !logstash_writer.nil?
+    end
   end
 end

data/service_skeleton.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |s|
   s.name = "service_skeleton"
 
-  s.version = '2.0.0'
+  s.version = '2.0.1'
 
   s.platform = Gem::Platform::RUBY
 
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
   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 'guard-rspec'
@@ -38,8 +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'
-  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

@@ -185,13 +185,13 @@ class Ultravisor
       !!(@restart == :always || (@restart == :on_failure && termination_exception))
     end
 
-    def unsafe_instance
+    def unsafe_instance(wait: true)
       unless @access == :unsafe
         raise Ultravisor::ThreadSafetyError,
               "#unsafe_instance called on a child not declared with access: :unsafe"
       end
 
-      current_instance
+      current_instance(wait: wait)
     end
 
     def cast
@@ -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|
@@ -394,9 +398,9 @@ class Ultravisor
       end
     end
 
-    def current_instance
+    def current_instance(wait: true)
       @spawn_m.synchronize do
-        while @instance.nil?
+        while wait && @instance.nil?
           @spawn_cv.wait(@spawn_m)
         end
 

data/ultravisor/spec/spec_helper.rb

@@ -49,4 +49,8 @@ RSpec.configure do |config|
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end
+
+  config.after(:each) do
+    Thread.current.name = nil
+  end
 end

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: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Matt Palmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: frankenstein
@@ -82,13 +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
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -96,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -110,7 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rubocop
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -138,7 +138,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -152,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,7 +166,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -180,7 +180,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -197,16 +197,16 @@ dependencies:
   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
@@ -334,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: The bare bones of a service