svcbase 0.1.16

data/lib/svcbase/thresholder.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Core
+  # Thresholder is an object that keeps track of how many calls are made
+  # to it and uses the volume over time to determine whether or not to
+  # run the associated block.
+  #
+  # -- get or create a thresholder named 'foo'
+  # thresholder = Core::Thresholder.instance('foo', count: 60, seconds: 60)
+  #
+  # -- run block only if threshold is exceeded
+  # thresholder.exceeded { |count| puts "i have been called #{count} times" }
+  #
+  # -- run block only if threshold has not been exceeded
+  # thresholder.limit { |count| puts "i have been called #{count} times" }
+  #
+  # -- always run block and include current count
+  # thresholder.run { |count| puts "i have been called #{count} times" }
+  #
+  # -- reset counter
+  # thresholder.reset
+  #
+  class Thresholder
+    @instances = {}
+    @class_mutex = Mutex.new
+
+    # return existing thresholder if it exists, otherwise create one
+    def self.instance(*names, **args)
+      raise ArgumentError, 'no identifiers for threshold instance call' if names.empty?
+
+      obj = @instances.dig(*names, :_instance)
+      return obj if obj
+
+      # create the appropriate instance
+      @class_mutex.synchronize do
+        obj = names.inject(@instances) { |buf, key| buf[key] ||= {} }
+        obj[:_instance] ||= new(*names, **args)
+      end
+    end
+
+    # forget a previously created thresholder
+    def self.forget(*names)
+      raise ArgumentError, 'no identifiers for threshold instance call' if names.empty?
+
+      return unless @instances.dig(*names)
+      @class_mutex.synchronize do
+        if names.length == 1
+          @instances.delete names.last
+        else
+          @instances.dig(*names[0..-2])&.delete(names.last)
+        end
+      end
+    end
+
+    # run block if threshold is not exceeded
+    def limit
+      raise 'No block passed to Thresholder#limit' unless block_given?
+      count = update_and_return_count
+      yield(count) if count <= @max_count
+    end
+
+    # run block if threshold is exceeded
+    def exceeded
+      raise 'No block passed to Thresholder#exceeded' unless block_given?
+      count = update_and_return_count
+      yield(count) if count > @max_count
+    end
+
+    # always run block
+    def run
+      raise 'No block passed to Thresholder#run' unless block_given?
+      yield(update_and_return_count)
+    end
+
+    # reset internal counters
+    def reset
+      @instance_mutex.synchronize do
+        @queue = [] # each entry is a tuple [ <time>, <count> ]
+        @count = 0  # current total count
+      end
+    end
+
+    # forbid direct instantiation
+    private_class_method :new, :allocate
+
+    private def initialize(*names, seconds: nil, count: nil)
+      seconds ||= Config.get_i!(:THRESHOLDER_SECONDS, 60)
+      count ||= Config.get_i!(:THRESHOLDER_COUNT, 60)
+      @names = names
+      @instance_mutex = Mutex.new
+      @max_count = count
+      @max_ds = seconds * 10
+      reset
+    end
+
+    private def remove_stale_entries(cutoff)
+      while !@queue.empty? && @queue.last[0] <= cutoff
+        @count -= @queue.last[1]
+        @queue.pop
+      end
+    end
+
+    private def update_and_return_count
+      @instance_mutex.synchronize do
+        # compute current time in deci-seconds (10th of a second)
+        now_ds = (Time.now.to_f * 10).to_i
+
+        # reduce @count by popping old entries from @queue and decrementing
+        remove_stale_entries(now_ds - @max_ds)
+
+        # increment @count and update @queue
+        if !@queue.empty? && @queue.first[0] == now_ds
+          @queue.first[1] += 1
+        else
+          @queue.unshift [now_ds, 1]
+        end
+        @count += 1
+
+        # directly return the count to avoid races in calling methods
+        return @count
+      end
+    end
+  end
+end

data/lib/svcbase/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Svcbase
+  VERSION = '0.1.16'
+end

data/lib/svcbase/worker.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Core
+  # common start/stop
+  module Worker
+    private def worker_loop(queue)
+      loop do
+        msg = queue.pop # block until there's a msg
+        do_work unless worker_stopping?
+        if worker_stopping?
+          do_stop if respond_to?(:do_stop, true) # check for private and protected too
+          return
+        end
+        queue.clear # ignore work that came in while we were working
+      rescue StandardError => e
+        log.fatal('worker') { ["Worker #{self.class} raised an uncaught exception", e] }
+        return if msg == :do_stop
+      end
+    end
+
+    def run_at_startup
+      false
+    end
+
+    def worker_start
+      worker_stop
+
+      queue = Queue.new
+      @worker_thread = Thread.new do
+        log.debug "Worker thread started for #{self.class}"
+        worker_loop queue
+        log.debug "Worker thread exited for #{self.class}"
+      end
+      @worker_thread[:queue] = queue
+
+      queue.push :do_work if run_at_startup
+
+      @worker_thread[:timer] = Thread.new do
+        loop do
+          sleep interval_seconds
+          queue.push :do_work
+        end
+      end
+    end
+
+    def worker_stop
+      return unless (w = @worker_thread)
+      @worker_thread = nil
+      w[:timer].kill
+      w[:stopping] = true
+      w[:queue].push :do_stop
+
+      # wait a little bit to see if it shuts down then log
+      log.debug "Worker thread draining for #{self.class} #{w.object_id.to_s(32)}" unless w.join(0.2)
+
+      # wait 15 seconds for worker to finish -- if not, kill it
+      return if w.join(Config.get_f!(:WORKER_SHUTDOWN_GRACE_PERIOD, 15))
+      w.kill
+      log.warn "Worker thread killed for #{self.class} #{w.object_id.to_s(32)}"
+    end
+
+    def worker_stopping?
+      Thread.current[:stopping]
+    end
+  end
+end

data/lib/svcbase.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'svcbase/appversion'
+require 'svcbase/config'
+require 'svcbase/corelogger'
+require 'svcbase/dumpstats'
+require 'svcbase/exceptions'
+require 'svcbase/ipaddr_helper'
+require 'svcbase/random'
+require 'svcbase/server'
+require 'svcbase/stats'
+require 'svcbase/thresholder'
+require 'svcbase/worker'
+require 'svcbase/version'

data/locale/en.yml

@@ -0,0 +1,28 @@
+en:
+  grape:
+    errors:
+      messages:
+        value_not_allowed: 'value is not allowed'
+        invalid: 'is not valid'
+
+  app:
+    errors:
+      # http rc default messages
+      not_modified: 'not modified'                   # 304
+      bad_request: 'bad request'                     # 400
+      unauthorized: 'unauthorized'                   # 401
+      forbidden: 'forbidden'                         # 403
+      not_found: '%{msgobj} not found'               # 404
+      conflict: 'conflict'                           # 409
+      gone: 'gone/expired'                           # 410
+      unsupported_media_type: 'unsupported format'   # 415
+      unprocessable: 'unprocessable'                 # 422
+      too_many_requests: 'too many requests'         # 429
+      internal_server_error: 'internal server error' # 500
+
+      invalid: '%{msgobj} is not valid'
+      missing: '%{msgobj} is missing'
+      not_allowed: '%{msgobj} is not allowed'
+      expired: '%{msgobj} is expired'
+      already_processed: '%{msgobj} already processed'
+      not_supported: '%{msgobj} is not supported'

data/locale/zz.yml

@@ -0,0 +1,21 @@
+en:
+  grape:
+    errors:
+      messages:
+        value_not_allowed: 'value is not allowed'
+        invalid: 'is not valid'
+
+  app:
+    errors:
+      # http rc default messages
+      not_modified: 'not modified' # 304
+      bad_request: 'bad request'   # 400
+      unauthorized: 'unauthorized' # 401
+      forbidden: 'forbidden'       # 403
+      not_found: '%{msgobj} not found'       # 404
+      too_many_requests: 'too many requests' # 429
+      internal_server_error: 'internal server error' # 500
+
+      invalid: '%{msgobj} is not valid'
+      missing: '%{msgobj} is missing'
+      not_allowed: '%{msgobj} is not allowed'

data/svcbase.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__) # rubocop:disable Style/ExpandPathArguments
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'svcbase/version'
+
+# rubocop:disable BlockLength
+Gem::Specification.new do |spec|
+  spec.name = 'svcbase'
+  spec.version = Svcbase::VERSION
+  spec.authors = ['Joe Nardone']
+  spec.email = ['jnardone@secureauth.com']
+
+  spec.summary = 'Base service code'
+  #spec.homepage = 'http://no'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'https://artifactory.secureauth.com/artifactory/api/gems/rubygems-local'
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'climate_control'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-rcov'
+  spec.add_development_dependency 'timecop'
+
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'grape'
+  spec.add_runtime_dependency 'http_accept_language'
+  spec.add_runtime_dependency 'i18n'
+  spec.add_runtime_dependency 'rack'
+  spec.add_runtime_dependency 'request_store'
+  spec.add_runtime_dependency 'shortuuid'
+end
+# rubocop:enable BlockLength

metadata

@@ -0,0 +1,305 @@
+--- !ruby/object:Gem::Specification
+name: svcbase
+version: !ruby/object:Gem::Version
+  version: 0.1.16
+platform: ruby
+authors:
+- Joe Nardone
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: climate_control
+  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: rack-test
+  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: rake
+  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: rspec
+  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
+  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
+    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-rcov
+  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: timecop
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http_accept_language
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shortuuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jnardone@secureauth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Jenkinsfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/configs/base.yml
+- config/configs/local.yml
+- lib/svcbase.rb
+- lib/svcbase/api/base.rb
+- lib/svcbase/api/etag.rb
+- lib/svcbase/api/requesthelpers.rb
+- lib/svcbase/appversion.rb
+- lib/svcbase/config.rb
+- lib/svcbase/config/config_helper.rb
+- lib/svcbase/corelogger.rb
+- lib/svcbase/dumpstats.rb
+- lib/svcbase/exceptions.rb
+- lib/svcbase/formatter.rb
+- lib/svcbase/ipaddr_helper.rb
+- lib/svcbase/middleware/apilogger.rb
+- lib/svcbase/middleware/dateheader.rb
+- lib/svcbase/middleware/requestid.rb
+- lib/svcbase/random.rb
+- lib/svcbase/server.rb
+- lib/svcbase/stats.rb
+- lib/svcbase/thresholder.rb
+- lib/svcbase/version.rb
+- lib/svcbase/worker.rb
+- locale/en.yml
+- locale/zz.yml
+- svcbase.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Base service code
+test_files: []