light-service-ext 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587a60d79dffd34dfbdbdbfc28e024c3a2983310209a8169e555e9ae88c8592b
-  data.tar.gz: 817889b86ce56ae818070d9bf938a34c8efca969729a51a8c4d37d738d20e821
+  metadata.gz: ce41945d8919b3cef73709b2a43f77621fb19019d35f22b6719de3d4c4af7948
+  data.tar.gz: 1f899858676cc260d26d381a4d2c8dbb19688b3aedd666d5e3380c164bf6f495
 SHA512:
-  metadata.gz: 538351e6b9c9050dcc81f91487c4fcd81e48e822589b5b3a77fa39909b733964d383241bd236c9ac199a32b018b8f9c6edf11efa5ef37d4051f1d0d0212810bd
-  data.tar.gz: 8ebd87e41ceb3bb2db3982289ded3281fd0c0234a33f255c95f9ff926b0a1a62231ade022b9c251246b1f1af6ee4ff4e0e5afe9b7e452ad8c8f41a3489022dbd
+  metadata.gz: 7a60af56510f4c620b78d97f2609c668b69fd595e6ed6f1acd50056a963ffd9a499e8843ff0147c533f184901f3e636d2e397bfc536b7eeb68af0ec19f970dee
+  data.tar.gz: e0c0bcb40521c6ea56cec36a555f1ffc6ebb11b7942b4709d616e7ce75ddb34aa79132f4396602cdacb534338e72d7f37a8e62b51f0609ad636fbae5564a18fb

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_action.rb

@@ -4,9 +4,31 @@ module LightServiceExt
   class ApplicationAction
     extend LightService::Action
 
+
     def self.inherited(base)
+      base.extend LifecycleMethods
       base.singleton_class.prepend AroundActionExecuteExtension
       super
     end
+
+    module LifecycleMethods
+      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
+    end
   end
 end

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

@@ -3,10 +3,17 @@
 module LightServiceExt
   module AroundActionExecuteExtension
     def execute(context)
+      return context if context.status == Status::COMPLETE
+      self.before_execute_block.call(context)
+
       result = super(context.merge(invoked_action: self))
 
       context.merge!(result)
       context.fail! if result.errors.present?
+
+      self.after_execute_block.call(context)
+      self.after_success_block.call(context) if result.success?
+      self.after_failure_block.call(context) if result.failure?
       result
     end
   end

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

@@ -6,21 +6,26 @@ module LightServiceExt
 
     def self.call(context)
       with_error_handler(ctx: context) do
-        result = yield
+        result = yield || context
         return context if outcomes_complete?(ctx: context, result: result)
 
+        invoked_action = result.invoked_action
+        return context if invoked_action.nil?
+
+        context.add_to_successful_actions(invoked_action.name)
+
         merge_api_responses!(ctx: context, result: result)
+        context
       end
     end
 
     class << self
       def merge_api_responses!(ctx:, result:)
-        invoked_action = result.invoked_action
-        return if invoked_action.nil?
+        api_response = result.current_api_response
+        return if api_response.blank?
 
-        ctx.add_to_successful_actions(invoked_action.name)
-        ctx.add_to_api_responses(result.current_api_response)
-        ctx
+        ctx.add_to_api_responses(api_response)
+        nil
       end
 
       def outcomes_complete?(ctx:, result:)

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LightServiceExt
-  VERSION = "0.1.9"
+  VERSION = "0.1.11"
 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_action_spec.rb

@@ -1,19 +1,17 @@
 module LightServiceExt
   RSpec.describe ApplicationAction do
-    FakeApplicationAction = Class.new(described_class) do
-      executed do |context|
-        value = context.dig(:input, :callback).call
-        context.add_params(value: value)
-        context.add_errors!(value: value)
+    let(:fake_action) do
+      Class.new(described_class) do
+        executed do |context|
+          value = context.dig(:input, :callback).call
+          context.add_params(value: value)
+          context.add_errors!(value: value)
+        end
       end
     end
 
     let(:organizer_class) do
-      Class.new(ApplicationOrganizer) do
-        def self.steps
-          [FakeApplicationAction]
-        end
-      end
+      Class.new(ApplicationOrganizer) do end
     end
 
     let(:value) { 'some-value' }
@@ -22,18 +20,54 @@ module LightServiceExt
     let(:ctx) do
       LightService::Testing::ContextFactory
         .make_from(organizer_class)
-        .for(FakeApplicationAction)
+        .for(fake_action)
         .with(callback: callback)
     end
 
-    subject(:context) do
-      FakeApplicationAction.execute(ctx)
+    subject(:executed_ctx) { fake_action.execute(ctx) }
+
+    before do
+      allow(organizer_class).to receive(:steps) { [fake_action] }
     end
 
     it 'adds value returned by callback to params' do
-      expect(context.keys).to include(:input, :errors, :params)
+      expect(executed_ctx.keys).to include(:input, :errors, :params)
+
+      expect(executed_ctx[:params]).to eql({ value: value })
+    end
+
+    describe 'lifecycle callbacks' do
+      before do
+        allow(fake_action.before_execute_block).to receive(:call)
+        allow(fake_action.after_execute_block).to receive(:call)
+        allow(fake_action.after_success_block).to receive(:call)
+        allow(fake_action.after_failure_block).to receive(:call)
+      end
 
-      expect(context[:params]).to eql({ value: value })
+      it 'calls appropriate lifecycle callbacks' do
+        executed_ctx
+
+        expect(fake_action.before_execute_block).to have_received(:call).with(kind_of(ApplicationContext)).at_least(:once)
+        expect(fake_action.after_execute_block).to have_received(:call).with(kind_of(ApplicationContext))
+        expect(fake_action.after_success_block).not_to have_received(:call).with(kind_of(ApplicationContext))
+        expect(fake_action.after_failure_block).to have_received(:call).at_least(:once)
+      end
+
+      context 'with failure' do
+        before do
+          allow_any_instance_of(ApplicationContext).to receive(:errors) { {} }
+          allow_any_instance_of(ApplicationContext).to receive(:success?) { true }
+        end
+
+        it 'calls appropriate lifecycle callbacks' do
+          executed_ctx
+
+          expect(fake_action.before_execute_block).to have_received(:call).with(kind_of(ApplicationContext)).at_least(:once)
+          expect(fake_action.after_execute_block).to have_received(:call).with(kind_of(ApplicationContext)).at_least(:once)
+          expect(fake_action.after_success_block).to have_received(:call).with(kind_of(ApplicationContext))
+          expect(fake_action.after_failure_block).to_not have_received(:call)
+        end
+      end
     end
   end
 end

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' } }
 
@@ -346,6 +361,7 @@ module LightServiceExt
                                                         invoked_action
                                                         current_api_response
                                                         last_failed_context
+                                                        meta
                                                       ])
 
         expect(ctx_with_defaults[:input]).to eql(input)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light-service-ext
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Desmond O'Leary
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-24 00:00:00.000000000 Z
+date: 2023-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: light-service
@@ -205,7 +205,6 @@ files:
 - spec/light-service-ext/application_orchestrator_spec.rb
 - spec/light-service-ext/application_organizer_spec.rb
 - spec/light-service-ext/application_validator_action_spec.rb
-- spec/light-service-ext/around_action_execute_extension_spec.rb
 - spec/light-service-ext/configuration_spec.rb
 - spec/light-service-ext/context_error_spec.rb
 - spec/light-service-ext/error_info_spec.rb
@@ -229,7 +228,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:
   - - ">="
@@ -249,7 +248,6 @@ test_files:
 - spec/light-service-ext/application_orchestrator_spec.rb
 - spec/light-service-ext/application_organizer_spec.rb
 - spec/light-service-ext/application_validator_action_spec.rb
-- spec/light-service-ext/around_action_execute_extension_spec.rb
 - spec/light-service-ext/configuration_spec.rb
 - spec/light-service-ext/context_error_spec.rb
 - spec/light-service-ext/error_info_spec.rb

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

@@ -1,56 +0,0 @@
-module LightServiceExt
-  RSpec.describe AroundActionExecuteExtension do
-    let(:fake_action) do
-      Class.new do
-        prepend AroundActionExecuteExtension
-
-        def execute(_ctx)
-          fake_resultant_ctx # HACK: to allow us to control returned value from prepended execute method
-        end
-
-        def fake_resultant_ctx; end
-      end.new
-    end
-
-    describe '#execute' do
-      let(:input) { { key: 'some-value' } }
-      let(:orig_ctx) { ApplicationContext.make_with_defaults }
-      let(:errors) { {} }
-      let(:frozen_resultant_ctx) do
-        ApplicationContext.make_with_defaults.merge({ key: 'some-value', errors: errors }).freeze
-      end
-
-      subject(:executed_ctx) { fake_action.execute(orig_ctx) }
-
-      before do
-        allow(fake_action).to receive(:fake_resultant_ctx) { frozen_resultant_ctx }
-      end
-
-      it 'returns unmodified resultant context' do
-        expect(executed_ctx).to eql(frozen_resultant_ctx)
-      end
-
-      it 'calls underlying prepended execute method' do
-        executed_ctx
-
-        expect(fake_action).to have_received(:fake_resultant_ctx)
-      end
-
-      it 'merges key value pairs from underlying execute to original context' do
-        executed_ctx
-
-        expect(orig_ctx.keys).to include(:key)
-      end
-
-      context 'with resultant ctx with errors' do
-        let(:errors) { { key: 'must be filled' } }
-
-        it 'fails original context' do
-          executed_ctx
-
-          expect(orig_ctx.failure?).to be_truthy
-        end
-      end
-    end
-  end
-end