startback 0.11.0 → 0.11.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe59e5315c100c9f8c83a100e0a9f538d50946dabdd504db2b5d17ba41738a23
-  data.tar.gz: 8e12f2e1571e80afe5acc8049e719fb8a06aecfdcb2ba9ed2b1a05fe0941244d
+  metadata.gz: fa9e440ddba682a1c59c98a5635b0febafe08222e9cee2de68d3262c6da6d8d4
+  data.tar.gz: '09a4748015aa374687c4016341d7f6a699d80718da7f9b4a6449294d69cf7897'
 SHA512:
-  metadata.gz: 7f7e1f0aa41d8ca9a1fcdd11a3fcca551b061bbe8dd7bff1dfe03ecad9b3e39f43a6be3abcd3f3915a98ee101979092e376c076d98e6d87e5ce402373d0c9867
-  data.tar.gz: d06499ef6a32fd68fce71a240649b32e991d8c0b704a6f848ad126f8577a1d707411d781620790cdc3943694ad79153eb364cd96a988184480cc339878df7bf4
+  metadata.gz: 6f832ba94f865dfd66c372fcf19623c68f43c76019623fd49da96e88fa2c7355bc78916ae98f3ae32de7e4deb0f08d9ade5d7eb2b3fa9f9bebb5544c0de698d4
+  data.tar.gz: 6ec4e88b7f2bc2ffd58d6e0cddb5bfffc5411149b71a97d1a51e7195105bd907568b45afec40f47916c17dbc45dfe81a5e6432781fa821dbdb2b1ba47f614c86

data/lib/startback/audit/prometheus.rb

@@ -1,3 +1,4 @@
+require_relative 'shared'
 require 'prometheus/client'
 
 module Startback
@@ -23,6 +24,7 @@ module Startback
     # input at construction time.
     #
     class Prometheus
+      include Shared
 
       def initialize(options = {})
         @prefix = options[:prefix] || "startback"
@@ -62,7 +64,6 @@ module Startback
       def ignore_safely
         yield
       rescue => ex
-        puts ex.class.to_s + "\n" + ex.message + "\n" + ex.backtrace.join("\n")
         nil
       end
 
@@ -81,14 +82,6 @@ module Startback
         Startback::VERSION
       end
 
-      def op_name(op)
-        case op
-        when String then op
-        when Class  then op.name
-        else op.class.name
-        end
-      end
-
     end # class Prometheus
   end # module Audit
 end # module Startback

data/lib/startback/audit/shared.rb

@@ -0,0 +1,17 @@
+module Startback
+  module Audit
+    module Shared
+
+      def op_name(op)
+        return op.op_name if op.respond_to?(:op_name)
+
+        case op
+        when String then op
+        when Class  then op.name
+        else op.class.name
+        end
+      end
+
+    end # module Shared
+  end # module Audit
+end # module Startback

data/lib/startback/audit/trailer.rb

@@ -1,3 +1,4 @@
+require_relative 'shared'
 require 'forwardable'
 module Startback
   module Audit
@@ -45,6 +46,7 @@ module Startback
     # input at construction time.
     #
     class Trailer
+      include Shared
       extend Forwardable
       def_delegators :@logger, :debug, :info, :warn, :error, :fatal
 
@@ -85,20 +87,14 @@ module Startback
         log_msg
       end
 
-      def op_name(op)
-        case op
-        when String then op
-        when Class  then op.name
-        else op.class.name
-        end
-      end
-
       def op_context(op)
         sanitize(op.respond_to?(:context, false) ? op.context.to_h : {})
       end
 
       def op_data(op)
-        data = if op.respond_to?(:to_trail, false)
+        data = if op.respond_to?(:op_data, false)
+          op.op_data
+        elsif op.respond_to?(:to_trail, false)
           op.to_trail
         elsif op.respond_to?(:input, false)
           op.input

data/lib/startback/audit.rb

@@ -1,2 +1,3 @@
+require_relative 'audit/shared'
 require_relative 'audit/trailer'
 require_relative 'audit/prometheus'

data/lib/startback/event/agent.rb

@@ -0,0 +1,8 @@
+module Startback
+  class Event
+    class Agent
+      include Support::OperationRunner
+
+    end # class Agent
+  end # class Event
+end # module Starback

data/lib/startback/event/engine.rb

@@ -0,0 +1,100 @@
+require 'rack'
+require 'webrick'
+require 'startback'
+module Startback
+  class Event
+    #
+    # This class runs an infinite loop using ServerEngine.
+    # It is intended to be used to run jobs that listen to
+    # a Startback Bus instance without having the main process
+    # terminating immediately.
+    #
+    # The Engine automatically runs a Webrick small webapp
+    # with a /healthcheck webservice. The class can be extended
+    # and method `on_health_check` overriden to run specific
+    # checks.
+    #
+    # This class goes hand in hand with the `startback:engine`
+    # docker image.
+    #
+    # Example:
+    #
+    #     # Dockerfile
+    #     FROM enspirit/startback:engine-0.11
+    #
+    #     # engine.rb
+    #     require 'startback/event/engine'
+    #     Startback::Event::Engine.run
+    #
+    class Engine
+
+      DEFAULT_OPTIONS = {
+        daemonize: false,
+        worker_type: 'process',
+        workers: 1
+      }
+
+      def initialize
+        require 'serverengine'
+      end
+
+      def on_health_check
+        "Ok"
+      end
+
+      def run(options = {})
+        options = DEFAULT_OPTIONS.merge(options)
+        health = Engine.build_health_check(self)
+        worker = Engine.build_worker(health)
+        se = ServerEngine.create(nil, worker, options)
+        se.run
+        se
+      end
+
+      class << self
+        def run(*args, &bl)
+          new.run(*args, &bl)
+        end
+
+        def build_health_check(engine)
+          Rack::Builder.new do
+            map '/health-check' do
+              health = Startback::Web::HealthCheck.new {
+                engine.on_health_check
+              }
+              run(health)
+            end
+          end
+        end
+
+        def build_worker(health)
+          Module.new do
+            include Support::Env
+
+            def initialize
+              @stop_flag = ServerEngine::BlockingFlag.new
+            end
+
+            define_method(:health) do
+              health
+            end
+
+            def run
+              until @stop_flag.set?
+                Rack::Handler::WEBrick.run(health, {
+                  :Port => env('STARTBACK_ENGINE_PORT', '3000').to_i,
+                  :Host => env('STARTBACK_ENGINE_LISTEN', '0.0.0.0')
+                })
+              end
+            end
+
+            def stop
+              @stop_flag.set!
+              Rack::Handler::WEBrick.shutdown
+            end
+          end
+        end
+      end # class << self
+    end # class Engine
+  end # class Event
+end # module Startback

data/lib/startback/event.rb

@@ -41,3 +41,5 @@ module Startback
 
   end # class Event
 end # module Startback
+require_relative 'event/agent'
+require_relative 'event/engine'

data/lib/startback/support/env.rb

@@ -0,0 +1,41 @@
+module Startback
+  module Support
+    # This method provides the `env` and `env!` methods that
+    # help querying environment variables easily.
+    module Env
+
+      # Returns an environment variable or raise an error if
+      # not set.
+      #
+      # The result is always a String with no leading/trailing
+      # spaces.
+      #
+      # If a block is given, the environment variable is yield
+      # and the result of the block returned.
+      def env!(key, default = nil, &bl)
+        v = ENV[key].to_s.strip
+        raise Startback::Error, "Missing ENV var `#{key}`" if v.empty?
+
+        env(key, default, &bl)
+      end
+      module_function :env!
+
+      # Returns an environment variable or the default value
+      # passed as second argument.
+      #
+      # The result is always a String with no leading/trailing
+      # spaces.
+      #
+      # If a block is given, the environment variable is yield
+      # and the result of the block returned.
+      def env(key, default = nil, &bl)
+        v = ENV[key].to_s.strip
+        v = v.empty? ? default : v
+        v = bl.call(v) if bl && v
+        v
+      end
+      module_function :env
+
+    end # module Env
+  end # module Support
+end # module Startback

data/lib/startback/support/log_formatter.rb

@@ -3,6 +3,8 @@ module Startback
     class LogFormatter
 
       def call(severity, time, progname, msg)
+        msg = { message: msg } if msg.is_a?(String)
+        msg = { error: msg } if msg.is_a?(Exception)
         {
           severity: severity,
           time: time

data/lib/startback/support/robustness.rb

@@ -43,7 +43,7 @@ module Startback
           @@default_logger ||= begin
             l = ::Logger.new(STDOUT)
             l.formatter = LogFormatter.new
-            l.warn(op: "#{self}", op_data: { msg: "Using default logger", trace: caller })
+            l.warn(op: "#{self}", op_data: { msg: "Using default logger to STDOUT" })
             @@default_logger = l
           end
           @@default_logger
@@ -67,6 +67,8 @@ module Startback
             log_msg.dup
           elsif log_msg.is_a?(String)
             log_msg = { op: "#{log_msg}#{method.nil? ? '' : '#'+method.to_s}" }
+          elsif log_msg.is_a?(Exception)
+            log_msg = { error: log_msg }
           else
             log_msg = log_msg.class unless log_msg.is_a?(Module)
             log_msg = { op: "#{log_msg.name}##{method}" }

data/lib/startback/support.rb

@@ -14,6 +14,7 @@ module Startback
 
   end # module Support
 end # module Startback
+require_relative 'support/env'
 require_relative 'support/log_formatter'
 require_relative 'support/logger'
 require_relative 'support/robustness'

data/lib/startback/version.rb

@@ -2,7 +2,7 @@ module Startback
   module Version
     MAJOR = 0
     MINOR = 11
-    TINY  = 0
+    TINY  = 5
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/lib/startback/web/api.rb

@@ -6,6 +6,7 @@ module Startback
 
       set :raise_errors, true
       set :show_exceptions, false
+      set :dump_errors, false
 
     protected
 

data/spec/unit/audit/test_trailer.rb

@@ -8,13 +8,30 @@ module Startback
         Trailer.new("/tmp/trail.log")
       }
 
+      describe "op_name" do
+
+        def op_name(op, trailer = self.trailer)
+          trailer.send(:op_name, op)
+        end
+
+        it 'uses op_name in priority if provided' do
+          op = OpenStruct.new(op_name: "foo")
+          expect(op_name(op)).to eql("foo")
+        end
+      end
+
       describe "op_data" do
 
         def op_data(op, trailer = self.trailer)
           trailer.send(:op_data, op)
         end
 
-        it 'uses to_trail in priority if provided' do
+        it 'uses op_data in priority if provided' do
+          op = OpenStruct.new(op_data: { foo: "bar" }, input: 12, request: 13)
+          expect(op_data(op)).to eql({ foo: "bar" })
+        end
+
+        it 'uses to_trail then' do
           op = OpenStruct.new(to_trail: { foo: "bar" }, input: 12, request: 13)
           expect(op_data(op)).to eql({ foo: "bar" })
         end

data/spec/unit/support/test_env.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+module Startback
+  module Support
+    describe Env do
+      include Env
+
+      before do
+        ENV['FOO'] = 'BAR'
+        ENV['FOOL'] = ''
+        ENV['FOOLISH'] = ' BAR '
+      end
+
+      after do
+        ENV.delete('FOO')
+        ENV.delete('FOOL')
+      end
+
+      describe "env" do
+        it 'returns an env variable' do
+          expect(env('FOO')).to eql('BAR')
+        end
+
+        it 'returns nil otherwise' do
+          expect(env('BAR')).to be_nil
+        end
+
+        it 'strips the value' do
+          expect(env('FOOLISH')).to eql('BAR')
+        end
+
+        it 'yields the block if any' do
+          expect(env('FOO'){|x| x.downcase }).to eql('bar')
+        end
+
+        it 'support a default value' do
+          expect(env('BAR', 'BAZ')).to eql('BAZ')
+        end
+
+        it 'yields the block with the default if any' do
+          expect(env('BAR', 'BAZ'){|x| x.downcase }).to eql('baz')
+        end
+
+        it 'returns nil when empty' do
+          expect(env('FOOL')).to be_nil
+        end
+
+        it 'yields the block with the default if empty' do
+          expect(env('FOOL', 'BAZ'){|x| x.downcase }).to eql('baz')
+        end
+      end
+
+      describe "env!" do
+        it 'returns an env variable' do
+          expect(env!('FOO')).to eql('BAR')
+        end
+
+        it 'strips the value' do
+          expect(env!('FOOLISH')).to eql('BAR')
+        end
+
+        it 'raise otherwise' do
+          expect{ env!('BAR') }.to raise_error(Startback::Errors::Error, /BAR/)
+        end
+
+        it 'raise on empty' do
+          expect{ env!('FOOL') }.to raise_error(Startback::Errors::Error, /FOOL/)
+        end
+
+        it 'yields the block if any' do
+          expect(env('FOO'){|x| x.downcase }).to eql('bar')
+        end
+      end
+    end
+  end
+end

data/spec/unit/support/test_robusteness.rb

@@ -135,6 +135,16 @@ module Startback
           expect(logger).to be_a(::Logger)
         end
 
+        it 'works fine with a Exception only' do
+          exception = StandardError.new('hello')
+          expected = {
+            error: exception
+          }
+          log_msg, logger = parse_args(exception)
+          expect(log_msg).to eql(expected)
+          expect(logger).to be_a(::Logger)
+        end
+
         it 'works fine with a string and a context with logger' do
           expected = {
             op: "a message"
@@ -216,4 +226,4 @@ module Startback
 
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: startback
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.5
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -383,6 +383,7 @@ files:
 - lib/startback.rb
 - lib/startback/audit.rb
 - lib/startback/audit/prometheus.rb
+- lib/startback/audit/shared.rb
 - lib/startback/audit/trailer.rb
 - lib/startback/bus.rb
 - lib/startback/bus/bunny.rb
@@ -397,6 +398,8 @@ files:
 - lib/startback/context/middleware.rb
 - lib/startback/errors.rb
 - lib/startback/event.rb
+- lib/startback/event/agent.rb
+- lib/startback/event/engine.rb
 - lib/startback/ext.rb
 - lib/startback/ext/date_time.rb
 - lib/startback/ext/time.rb
@@ -404,6 +407,7 @@ files:
 - lib/startback/operation/error_operation.rb
 - lib/startback/operation/multi_operation.rb
 - lib/startback/support.rb
+- lib/startback/support/env.rb
 - lib/startback/support/fake_logger.rb
 - lib/startback/support/hooks.rb
 - lib/startback/support/log_formatter.rb
@@ -438,6 +442,7 @@ files:
 - spec/unit/support/hooks/test_before_hook.rb
 - spec/unit/support/operation_runner/test_around_run.rb
 - spec/unit/support/operation_runner/test_before_after_call.rb
+- spec/unit/support/test_env.rb
 - spec/unit/support/test_robusteness.rb
 - spec/unit/support/test_transaction_manager.rb
 - spec/unit/test_event.rb