startback 0.10.0 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10937b9e7877dd7393837c70185fe245493a35234d66a899efee5fbebb539b75
-  data.tar.gz: 5fd7234b34b09f875dcf9b21ad819eb5072ffed902ddd08ca6c2e6a68e3ec1df
+  metadata.gz: 83733eb966d9d9679a15840dfa76f717aacaacc5c3eb417c6bf518a3eea1e3cd
+  data.tar.gz: f13815553606f4567e136beb86fc19a066720a3bcdf520c3781c12a732808f47
 SHA512:
-  metadata.gz: 37df032165dd22b0680f8eaf874bada4810707253e06677c6a80b5d21afc87062643143e5f2b50e0f3adbe48d9df00368bb5f7070068e8458565e0d0fb8f1112
-  data.tar.gz: 754c4703f78bca862a4a7b2f8d973609ec44fab70368fe6d6d371050c140592a5706720ef0208ac4002ce434d85ad8e4d095d07840cd7993e2cb698cd116da5d
+  metadata.gz: 0a2c80c7c65fbe845784a6ee1326bed2a1d6f89eed591580800e1ee9f403fea24b61e92b1f1ad13356f612308a30c6ecc17f6c6a16fadb9c82ae6dec61b68d31
+  data.tar.gz: 18dc6c715ba6ed1715c6d838421476959942611a120ba04eed7a72d40d505e53c60b64ecbf4e877d2a99d2c46300cfa8e83f6cb70960bb72ad599d7d5802509f

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

@@ -2,8 +2,13 @@ module Startback
   module Errors
 
     class Error < StandardError
-      class << self
+      def initialize(message = nil, causes = nil)
+        super(message)
+        @causes = Array(causes)
+      end
+      attr_reader :causes
 
+      class << self
         def status(code = nil)
           if code.nil?
             @code || (superclass.respond_to?(:status) ? superclass.status : 500)
@@ -22,11 +27,19 @@ module Startback
         msg = super
         return msg unless msg == self.class.name
         parts = self.class.name.split('::').last.gsub(/[A-Z]/){|x|
-          " #{x.downcase}" 
+          " #{x.downcase}"
         }.strip.split(" ")
         parts = parts[0...-1] unless self.class.keep_error
         parts.join(" ").capitalize
       end
+
+      def has_causes?
+        causes && !causes.empty?
+      end
+
+      def cause
+        causes&.first
+      end
     end
 
     class BadRequestError < Error

data/lib/startback/support/log_formatter.rb

@@ -3,14 +3,28 @@ module Startback
     class LogFormatter
 
       def call(severity, time, progname, msg)
-        if msg[:error] && msg[:error].respond_to?(:message, true)
-          msg[:backtrace] = msg[:error].backtrace[0..25] if severity == "FATAL"
-          msg[:error] = msg[:error].message
-        end
         {
           severity: severity,
-          time: time,
-        }.merge(msg).to_json << "\n"
+          time: time
+        }.merge(msg)
+         .merge(error: error_to_json(msg[:error], severity))
+         .compact
+         .to_json << "\n"
+      end
+
+      def error_to_json(error, severity = nil)
+        return error if error.nil?
+        return error if error.is_a?(String)
+        return error.to_s unless error.is_a?(Exception)
+
+        backtrace = error.backtrace[0..25] if severity == "FATAL"
+        causes = error.causes.map{|c| error_to_json(c) } if error.respond_to?(:causes)
+        causes = nil if causes && causes.empty?
+        {
+          message: error.message,
+          backtrace: backtrace,
+          causes: causes
+        }.compact
       end
 
     end # class LogFormatter

data/lib/startback/version.rb

@@ -1,8 +1,8 @@
 module Startback
   module Version
     MAJOR = 0
-    MINOR = 10
-    TINY  = 0
+    MINOR = 11
+    TINY  = 3
   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/lib/startback/web/shield.rb

@@ -34,10 +34,25 @@ module Startback
       # A bit of logic to choose the best error message for the user
       # according to the error class
       self.body{|ex|
-        ex = ex.root_cause if ex.is_a?(Finitio::TypeError)
-        { code: ex.class.name, description: ex.message }.to_json
+        body_for(ex).to_json
       }
 
+      def body_for(ex)
+        ex = ex.root_cause if ex.is_a?(Finitio::TypeError)
+        body = { code: ex.class.name, description: ex.message }
+        return body unless ex.is_a?(Startback::Errors::Error)
+        return body unless ex.has_causes?
+
+        body[:causes] = ex.causes
+          .filter{|cause|
+            cause.is_a?(Startback::Errors::Error)
+          }
+          .map{|cause|
+            body_for(cause)
+          }
+        body
+      end
+
     end # class Shield
   end # module Web
 end # module Startback

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: startback
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.3
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-22 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -270,20 +270,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -472,7 +473,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Got Your Ruby Back