light-service-ext 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587a60d79dffd34dfbdbdbfc28e024c3a2983310209a8169e555e9ae88c8592b
-  data.tar.gz: 817889b86ce56ae818070d9bf938a34c8efca969729a51a8c4d37d738d20e821
+  metadata.gz: aad64b8f2360c7b9e4576bcfe6e167f10a87424392b9677ca620b973ba3dc8ef
+  data.tar.gz: 18a7ff6bde7fab9b58eb1e883fbb79cc346be9d98e9516135de3b5e6eabd570c
 SHA512:
-  metadata.gz: 538351e6b9c9050dcc81f91487c4fcd81e48e822589b5b3a77fa39909b733964d383241bd236c9ac199a32b018b8f9c6edf11efa5ef37d4051f1d0d0212810bd
-  data.tar.gz: 8ebd87e41ceb3bb2db3982289ded3281fd0c0234a33f255c95f9ff926b0a1a62231ade022b9c251246b1f1af6ee4ff4e0e5afe9b7e452ad8c8f41a3489022dbd
+  metadata.gz: c0f1d41f1530c3b8e9624f0c3ef360464b9a67d8c7e21893b4ecea3db8b09d19b967e7a0dbbc6d66cc1e90677186954c62ab1d734e026ca434b183d7ad3bbdc8
+  data.tar.gz: d81ae82181b451ad2330dc42ccbf33f11cab6b99a0afaa47ba77d4a8bf88bcb6903b486439be926ea408fc2dc06b8e27626843f45a69e6053c9afb4d3dd4f401

data/README.md

@@ -173,12 +173,14 @@ end
   - `LightServiceExt::Status::INCOMPLETE`
 - `:last_failed_context` ~ copy of context that failed e.g. with `errors` field present
 - `internal_only` ~ includes the likes of raised error summary and should never be passed to endpoint responses
+- `meta` ~ used to store any additional information that could be helpful especially for debugging purposes.
 Example
 
 ````ruby
 input = { order: order }
 overrides = {} # optionally override `params`, `errors` and `allow_raise_on_failure`
-LightServiceExt::ApplicationContext.make_with_defaults(input, overrides)
+meta = { current_user_id: 12345, request_id: some-unique-request-id, impersonator_id: 54321 }
+LightServiceExt::ApplicationContext.make_with_defaults(input, overrides, meta: meta)
 
 # => { input: { order: order },
 #      errors: { email: ['not found'] },
@@ -190,7 +192,8 @@ LightServiceExt::ApplicationContext.make_with_defaults(input, overrides)
 #      api_responses: [ { user_id: 1, status: 'ACTIVE' } ],
 #      last_failed_context: {input: { order: order }, params: {}, ...},
 #      allow_raise_on_failure: true,
-#      internal_only: { error_info: ErrorInfoInstance }
+#      internal_only: { error_info: ErrorInfoInstance },
+#     meta: { current_user_id: 12345, request_id: some-unique-request-id, impersonator_id: 54321 }
 #    }
 ````
 

data/lib/light-service-ext/application_context.rb

@@ -25,7 +25,8 @@ module LightServiceExt
           api_responses: [],
           last_failed_context: nil,
           allow_raise_on_failure: LightServiceExt.config.allow_raise_on_failure?,
-          internal_only: {}
+          internal_only: {},
+          meta: {}
         }.freeze
       end
     end
@@ -63,6 +64,11 @@ module LightServiceExt
       add_attrs_to_ctx(:internal_only, **attrs)
     end
 
+    def add_meta(**attrs)
+      add_attrs_to_ctx(:meta, **attrs)
+    end
+
+
     def record_raised_error(error)
       @error_info = ErrorInfo.new(error)
       error_type = @error_info.type

data/lib/light-service-ext/record_actions.rb

@@ -6,14 +6,37 @@ module LightServiceExt
 
     def self.call(context)
       with_error_handler(ctx: context) do
-        result = yield
-        return context if outcomes_complete?(ctx: context, result: result)
+        self.before_execute_block.call(context)
+
+        result = yield || context
+
+        self.after_execute_block.call(context)
+        self.after_success_block.call(context) if result.success?
+        self.after_failure_block.call(context) if result.failure?
 
+        return context if outcomes_complete?(ctx: context, result: result)
         merge_api_responses!(ctx: context, result: result)
       end
     end
 
     class << self
+      attr_writer :before_execute_block, :after_execute_block, :after_success_block, :after_failure_block
+
+      def before_execute_block
+        @before_execute_block ||= ->(_context) {}
+      end
+
+      def after_execute_block
+        @after_execute_block ||= ->(_context) {}
+      end
+
+      def after_success_block
+        @after_success_block ||= ->(_context) {}
+      end
+
+      def after_failure_block
+        @after_failure_block ||= ->(_context) {}
+      end
       def merge_api_responses!(ctx:, result:)
         invoked_action = result.invoked_action
         return if invoked_action.nil?

data/lib/light-service-ext/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LightServiceExt
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

data/lib/light-service-ext/with_error_handler.rb

@@ -4,7 +4,7 @@
 module LightServiceExt
   module WithErrorHandler
     def with_error_handler(ctx:)
-      @result = yield || ApplicationContext.make_with_defaults
+      @result = yield || ctx
     rescue StandardError => e
       ctx.record_raised_error(e)
       ctx.add_status(Status::COMPLETE)

data/light-service-ext.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.name = "light-service-ext"
   gem.require_paths = ["lib"]
   gem.version = LightServiceExt::VERSION
-  gem.required_ruby_version = ">= 3"
+  gem.required_ruby_version = ">= 2.7"
 
   gem.metadata["homepage_uri"] = gem.homepage
   gem.metadata["source_code_uri"] = gem.homepage

data/spec/light-service-ext/application_context_spec.rb

@@ -325,6 +325,21 @@ module LightServiceExt
 
       subject(:ctx_with_defaults) { described_class.make_with_defaults(input, overrides) }
 
+      describe '#add_meta' do
+        it 'adds meta to context' do
+          ctx_with_defaults.add_meta(key => value)
+          expect(ctx_with_defaults.meta).to eql(key => value)
+        end
+      end
+
+      context 'with meta as an override' do
+        let(:overrides) { { meta: { key: 'some-value' } } }
+
+        it 'adds meta to context' do
+          expect(ctx_with_defaults.meta).to eql(key => value)
+        end
+      end
+
       context 'with non symbolized input keys' do
         let(:input) { { "key" => 'some-value' } }
 

data/spec/light-service-ext/record_actions_spec.rb

@@ -19,6 +19,40 @@ module LightServiceExt
 
       subject(:called_ctx) { described_class.call(ctx, &proc) }
 
+      describe 'lifecycle callbacks' do
+        before do
+          allow(described_class.before_execute_block).to receive(:call)
+          allow(described_class.after_execute_block).to receive(:call)
+          allow(described_class.after_success_block).to receive(:call)
+          allow(described_class.after_failure_block).to receive(:call)
+        end
+
+        it 'calls appropriate lifecycle callbacks' do
+          called_ctx
+
+          expect(described_class.before_execute_block).to have_received(:call).with(kind_of(ApplicationContext))
+          expect(described_class.after_execute_block).to have_received(:call).with(kind_of(ApplicationContext))
+          expect(described_class.after_success_block).to have_received(:call).with(kind_of(ApplicationContext))
+          expect(described_class.after_failure_block).not_to have_received(:call)
+        end
+
+        context 'with failure' do
+          before do
+            allow_any_instance_of(ApplicationContext).to receive(:success?) { false }
+            allow_any_instance_of(ApplicationContext).to receive(:failure?) { true }
+          end
+
+          it 'calls appropriate lifecycle callbacks' do
+            called_ctx
+
+            expect(described_class.before_execute_block).to have_received(:call).with(kind_of(ApplicationContext))
+            expect(described_class.after_execute_block).to have_received(:call).with(kind_of(ApplicationContext))
+            expect(described_class.after_failure_block).to have_received(:call).with(kind_of(ApplicationContext))
+            expect(described_class.after_success_block).not_to have_received(:call)
+          end
+        end
+      end
+
       it 'returns expected context' do
         expect(called_ctx.success?).to be_truthy
         expect(called_ctx.successful_actions).to be_empty

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: light-service-ext
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Desmond O'Leary
@@ -229,7 +229,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="