startback 0.9.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2a20858c9d0287af3cfaa8e60c6f59630f1d258de469f7c50ffe1e6529742ca
-  data.tar.gz: c5d3fb83ab9a7aa0b1bb6fbec2f0bfeef40b4c51c15c602d9a2bca85b17e8d26
+  metadata.gz: fe59e5315c100c9f8c83a100e0a9f538d50946dabdd504db2b5d17ba41738a23
+  data.tar.gz: 8e12f2e1571e80afe5acc8049e719fb8a06aecfdcb2ba9ed2b1a05fe0941244d
 SHA512:
-  metadata.gz: ee763fb9d8be8ca1f6cc8a541b70df6b72ae982e2026b04286ec5b6a208aba31641ea8062330f7efc8d01e548bfbca408edb115678dbc6fefa707e3d98fc8f0e
-  data.tar.gz: ec3607dec57ff640d4b49afb147a5c6893e45844e5d53cf07e8ca26ea709341260c02f01a25bad7fc68f231e859986ce2bb0604de7e6031f59f97d1f0a06a464
+  metadata.gz: 7f7e1f0aa41d8ca9a1fcdd11a3fcca551b061bbe8dd7bff1dfe03ecad9b3e39f43a6be3abcd3f3915a98ee101979092e376c076d98e6d87e5ce402373d0c9867
+  data.tar.gz: d06499ef6a32fd68fce71a240649b32e991d8c0b704a6f848ad126f8577a1d707411d781620790cdc3943694ad79153eb364cd96a988184480cc339878df7bf4

data/lib/startback/audit/trailer.rb

@@ -74,13 +74,13 @@ module Startback
 
     protected
 
-      def op_to_trail(op, time, ex = nil)
+      def op_to_trail(op, time = nil, ex = nil)
         log_msg = {
           op_took: time ? time.round(8) : nil,
           op: op_name(op),
           context: op_context(op),
           op_data: op_data(op)
-        }
+        }.compact
         log_msg[:error] = ex if ex
         log_msg
       end
@@ -104,6 +104,8 @@ module Startback
           op.input
         elsif op.respond_to?(:request, false)
           op.request
+        elsif op.is_a?(Operation::MultiOperation)
+          op.ops.map{ |sub_op| op_to_trail(sub_op) }
         end
         sanitize(data)
       end

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/operation/multi_operation.rb

@@ -1,6 +1,6 @@
 module Startback
   class Operation
-    class MultiOperation
+    class MultiOperation < Operation
 
       def initialize(ops = [])
         @ops = ops

data/lib/startback/operation.rb

@@ -29,6 +29,7 @@ module Startback
   #     end
   #
   class Operation
+    extend Support::TransactionPolicy
     include Errors
     include Support::OperationRunner
     include Support::Hooks.new(:call)

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/support/transaction_manager.rb

@@ -0,0 +1,25 @@
+module Startback
+  module Support
+    class TransactionManager
+
+      def initialize(db, method = :transaction)
+        @db = db
+        @method = method
+      end
+
+      def call(runner, op, &then_block)
+        raise ArgumentError, "A block is required" unless then_block
+
+        before = (op.class.transaction_policy == :before_call)
+        if before
+          @db.send(@method) do
+            then_block.call
+          end
+        else
+          then_block.call
+        end
+      end
+
+    end # class TransactionManager
+  end # module Support
+end # module Startback

data/lib/startback/support/transaction_policy.rb

@@ -0,0 +1,33 @@
+module Startback
+  module Support
+    module TransactionPolicy
+
+      # Returns the operation's transaction policy
+      def transaction_policy
+        @transaction_policy || :before_call
+      end
+
+      # Sets the transaction policy to use. Valid values are:
+      # - before_call : the transaction is started by the operation
+      #   runner, right before calling the #call method on operation
+      #   instance
+      # - within_call: the transaction is started by the operation
+      #   itself, as part of its internal logic.
+      def transaction_policy=(policy)
+        unless [:before_call, :within_call].include?(policy)
+          raise ArgumentError, "Unknown policy `#{policy}`"
+        end
+        @transaction_policy = policy
+      end
+
+      def after_commit(&bl)
+        after_call do
+          db.after_commit do
+            instance_exec(&bl)
+          end
+        end
+      end
+
+    end # module TransactionPolicy
+  end # module Support
+end # module Startback

data/lib/startback/support.rb

@@ -19,3 +19,5 @@ require_relative 'support/logger'
 require_relative 'support/robustness'
 require_relative 'support/hooks'
 require_relative 'support/operation_runner'
+require_relative 'support/transaction_policy'
+require_relative 'support/transaction_manager'

data/lib/startback/version.rb

@@ -1,8 +1,8 @@
 module Startback
   module Version
     MAJOR = 0
-    MINOR = 9
-    TINY  = 1
+    MINOR = 11
+    TINY  = 0
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

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/support/operation_runner/test_around_run.rb

@@ -68,7 +68,7 @@ module Startback
       end
 
       context 'the around feature with a class' do
-        class TransactionManager
+        class SomeTransactionManager
           include Singleton
 
           def initialize
@@ -87,7 +87,7 @@ module Startback
 
         class RunnerTest3
           include OperationRunner
-          around_run TransactionManager.instance
+          around_run SomeTransactionManager.instance
 
           def operation_world(op)
             { hello: "world" }
@@ -97,7 +97,7 @@ module Startback
         it 'calls the proc with expected parameters' do
           test = RunnerTest3.new
           got = test.run(op)
-          expect(TransactionManager.instance.called).to eql(true)
+          expect(SomeTransactionManager.instance.called).to eql(true)
           expect(got).to eql({
             seen_hello: "world"
           })
@@ -154,4 +154,3 @@ module Startback
     end # module OperationRunner
   end # module Support
 end # module Startback
-

data/spec/unit/support/test_transaction_manager.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+module Startback
+  module Support
+    describe TransactionManager do
+      subject do
+        TransactionManager.new(db).call(nil, op) do
+          op.call
+        end
+      end
+
+      class FakeDatabase
+        def initialize
+          @called = false
+        end
+        attr_reader :called
+
+        def transaction
+          @called = true
+          yield
+        end
+      end
+
+      let(:db) do
+        FakeDatabase.new
+      end
+
+      context 'when called with a default operation' do
+        class OperationNotManagingTransactions < Startback::Operation
+          def call
+            12
+          end
+        end
+
+        let(:op) do
+          OperationNotManagingTransactions.new
+        end
+
+        it 'calls db.transaction' do
+          expect(subject).to eql(12)
+          expect(db.called).to eql(true)
+        end
+      end
+
+      context 'when called with an operation that manages the transactions itself' do
+        class OperationManagingTransactions < Startback::Operation
+          self.transaction_policy = :within_call
+
+          def call
+            12
+          end
+        end
+
+        let(:op) do
+          OperationManagingTransactions.new
+        end
+
+        it 'calls db.transaction' do
+          expect(subject).to eql(12)
+          expect(db.called).to eql(false)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: startback
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-13 00:00:00.000000000 Z
+date: 2022-04-21 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
@@ -380,7 +380,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- VERSION
 - lib/startback.rb
 - lib/startback/audit.rb
 - lib/startback/audit/prometheus.rb
@@ -411,6 +410,8 @@ files:
 - lib/startback/support/logger.rb
 - lib/startback/support/operation_runner.rb
 - lib/startback/support/robustness.rb
+- lib/startback/support/transaction_manager.rb
+- lib/startback/support/transaction_policy.rb
 - lib/startback/version.rb
 - lib/startback/web/api.rb
 - lib/startback/web/auto_caching.rb
@@ -438,6 +439,7 @@ files:
 - spec/unit/support/operation_runner/test_around_run.rb
 - spec/unit/support/operation_runner/test_before_after_call.rb
 - spec/unit/support/test_robusteness.rb
+- spec/unit/support/test_transaction_manager.rb
 - spec/unit/test_event.rb
 - spec/unit/test_operation.rb
 - spec/unit/test_support.rb
@@ -470,7 +472,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

data/VERSION

@@ -1 +0,0 @@
-0.9.1