config_skeleton 1.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b419f026421b513b20f2950609f9b45339d86433b88e8372bd94746f6a72091
-  data.tar.gz: 7e0a5ac1b0dfe9ad7ee989aeb9d0051b06d179190328460ba09c273312b36b7d
+  metadata.gz: f85f27d60f4dcaf253af5ecff4d6fcc6d851e5b54ad85d3f8cdf2bae4ac4a541
+  data.tar.gz: fa4ca080415307e4d44e19f12fc5799fc3b8b8f750eda72c7d543491cd37e7fb
 SHA512:
-  metadata.gz: c36398b332b1bfa53a66d11a2c083af4a0f794e53fba518278fcef7ef41dfc63d51b4b010f508eeb898bf99c10ff55a2f813251bdfefe122a70e3254b87da46a
-  data.tar.gz: 53acc41e5da3aea61cda288cfe90f122e8d8871eea594d5e4b0857d127c01ba20a542df7087884c34e0e75589e968820d53b41db62c3f85f91d49eea9dbf88a2
+  metadata.gz: bc6ad4e7c89e473d0902c44b160040da924943d3437310a2edb202a3bab246259f238691bbb81696cc7cf0f0bbe635444dab8add65d0d56790907014aa973293
+  data.tar.gz: 9659f0fd04bf6d2e89bc2d58ecc82dd741dd6b1f266d7ff36e621fcb0e5c3774e524c7b02187d90c699d7d2163412505bf55501e35c679d25f1f1f2dd590e755

data/.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          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
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Release Gem
+        uses: discourse/publish-rubygems-action@v2-beta
+        env:
+          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
 /cfg.txt
-
-.rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml

data/.rubocop.yml

@@ -1 +1,2 @@
-inherit_from: https://raw.githubusercontent.com/discourse/discourse/master/.rubocop.yml
+inherit_gem:
+  rubocop-discourse: default.yml

data/config_skeleton.gemspec

@@ -1,29 +1,28 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |s|
   s.name = "config_skeleton"
-
-  s.version = "1.1.0"
+  s.version = "2.2.0"
 
   s.platform = Gem::Platform::RUBY
-
   s.summary  = "Dynamically generate configs and reload servers"
-
   s.authors  = ["Matt Palmer", "Discourse Team"]
   s.email    = ["matt.palmer@discourse.org", "team@discourse.org"]
   s.homepage = "https://github.com/discourse/config_skeleton"
 
   s.files = `git ls-files -z`.split("\0").reject { |f| f =~ /^(G|spec|Rakefile)/ }
 
-  s.required_ruby_version = ">= 2.3.0"
+  s.required_ruby_version = ">= 2.5.0"
 
   s.add_runtime_dependency 'diffy', '~> 3.0'
   s.add_runtime_dependency 'rb-inotify', '~> 0.9'
-  s.add_runtime_dependency 'service_skeleton', "~> 1.0"
+  s.add_runtime_dependency 'service_skeleton', "~> 2.0"
+  s.add_runtime_dependency 'webrick'
 
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'github-release'
-  s.add_development_dependency 'rake', "~> 12.0"
+  s.add_development_dependency 'rake', "~> 13.0"
   s.add_development_dependency 'redcarpet'
-  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-discourse', '~> 2.4.1'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'pry'

data/lib/config_skeleton.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'diffy'
 require 'fileutils'
 require 'frankenstein'
@@ -162,11 +164,12 @@ class ConfigSkeleton
   end
 
   def self.inherited(klass)
+    klass.gauge :"#{klass.service_name}_config_ok", docstring: "Whether the last config change was accepted by the server"
+    klass.gauge :"#{klass.service_name}_generation_ok", docstring: "Whether the last config generation completed without error"
     klass.gauge :"#{klass.service_name}_last_generation_timestamp", docstring: "When the last config generation run was made"
     klass.gauge :"#{klass.service_name}_last_change_timestamp", docstring: "When the config file was last written to"
     klass.counter :"#{klass.service_name}_reload_total", docstring: "How many times we've asked the server to reload", labels: [:status]
     klass.counter :"#{klass.service_name}_signals_total", docstring: "How many signals have been received (and handled)"
-    klass.gauge :"#{klass.service_name}_config_ok", docstring: "Whether the last config change was accepted by the server"
 
     klass.hook_signal("HUP") do
       logger.info("SIGHUP") { "received SIGHUP, triggering config regeneration" }
@@ -205,11 +208,15 @@ class ConfigSkeleton
     @watches || []
   end
 
-  def initialize(*_)
+  def initialize(*_, metrics:, config:)
     super
     initialize_config_skeleton_metrics
     @trigger_regen_r, @trigger_regen_w = IO.pipe
     @terminate_r, @terminate_w = IO.pipe
+
+    raise "cooldown_duration invalid" if cooldown_duration < 0
+    raise "sleep_duration invalid" if sleep_duration < 0
+    raise "sleep_duration must not be less than cooldown_duration" if sleep_duration < cooldown_duration
   end
 
   # Expose the write pipe which can be written to to trigger a config
@@ -323,6 +330,7 @@ class ConfigSkeleton
     metrics.last_generation_timestamp.set(0)
     metrics.last_change_timestamp.set(0)
     metrics.config_ok.set(0)
+    metrics.generation_ok.set(0)
   end
 
   # Write out a config file if one doesn't exist, or do an initial regen run
@@ -425,9 +433,15 @@ class ConfigSkeleton
   #
   def instrumented_config_data
     begin
-      @config_generation.measure { config_data.tap { metrics.last_generation_timestamp.set(Time.now.to_f) } }
+      @config_generation.measure do
+        config_data.tap do
+          metrics.last_generation_timestamp.set(Time.now.to_f)
+          metrics.generation_ok.set(1)
+        end
+      end
     rescue => ex
       log_exception(ex, logloc) { "Call to config_data raised exception" }
+      metrics.generation_ok.set(0)
       nil
     end
   end
@@ -457,6 +471,10 @@ class ConfigSkeleton
   # duration, regardless of any CONT signals or inotify events. Those events
   # will be queued up, and processed at the end of the cooldown.
   #
+  # The cooldown_duration is counted as part of the sleep_duration. So for
+  # the default values of 60 and 5, the service will cooldown for 5s, then wait
+  # for 55s.
+  #
   # @return [Integer] the number of seconds to 'cooldown' for.  This *must* be
   #   greater than zero, and less than sleep_duration
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: config_skeleton
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Matt Palmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-11 00:00:00.000000000 Z
+date: 2022-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -45,22 +45,22 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !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:
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: github-release
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -110,19 +110,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  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: yard
   requirement: !ruby/object:Gem::Requirement
@@ -187,7 +187,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -209,14 +209,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Dynamically generate configs and reload servers

data/.github/workflows/ruby.yml

@@ -1,48 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches:
-      - master
-    tags:
-      - v*
-  pull_request:
-    branches:
-      - master
-  workflow_dispatch:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.6
-      - name: Install dependencies
-        run: bundle install
-      - name: Run specs
-        run: bundle exec rspec
-
-  publish:
-    if: contains(github.ref, 'refs/tags/v')
-    needs: build
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Release Gem
-        uses: discourse/publish-rubygems-action@main
-        env:
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}