Merge branch 'feat/DEX-2166/query-logs-contexts' into 'master'

[DEX-2166] feat: Add ContextItemProcessMiddleware for execution context tracking

Closes DEX-2166

See merge request nstmrt/rubygems/outbox!100

CHANGELOG.md

@@ -13,6 +13,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+## [6.8.0] - 2024-09-05
+
+### Added
+
+- Add outbox context to ActiveRecord query log tags
+
 ## [6.7.0] - 2024-08-29
 
 ### Added

config/initializers/active_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+if ActiveRecord.version >= Gem::Version.new("7.0.0")
+  Rails.application.config.active_record.tap do |config|
+    config.query_log_tags << {
+      box_name: ->(context) { context[:box_item]&.class&.box_name },
+      box_item_id: ->(context) { context[:box_item]&.uuid }
+    }
+  end
+end

lib/sbmt/outbox/engine.rb

@@ -69,6 +69,11 @@ class Engine < Rails::Engine
           c.batch_process_middlewares.push("Sbmt::Outbox::Middleware::Sentry::TracingBatchProcessMiddleware")
           c.item_process_middlewares.push("Sbmt::Outbox::Middleware::Sentry::TracingItemProcessMiddleware")
         end
+
+        if defined?(ActiveSupport::ExecutionContext)
+          require_relative "middleware/execution_context/context_item_process_middleware"
+          c.item_process_middlewares.push("Sbmt::Outbox::Middleware::ExecutionContext::ContextItemProcessMiddleware")
+        end
       end
 
       rake_tasks do

lib/sbmt/outbox/middleware/execution_context/context_item_process_middleware.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "sbmt/outbox/middleware/execution_context/context_item_process_middleware"
+
+module Sbmt
+  module Outbox
+    module Middleware
+      module ExecutionContext
+        class ContextItemProcessMiddleware
+          def call(item)
+            ActiveSupport::ExecutionContext[:box_item] = item
+
+            yield
+          end
+        end
+      end
+    end
+  end
+end

lib/sbmt/outbox/version.rb

@@ -2,6 +2,6 @@
 
 module Sbmt
   module Outbox
-    VERSION = "6.7.0"
+    VERSION = "6.8.0"
   end
 end

spec/lib/sbmt/outbox/middleware/execution_context/context_item_process_middleware_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "sbmt/outbox/middleware/execution_context/context_item_process_middleware"
+
+describe Sbmt::Outbox::Middleware::ExecutionContext::ContextItemProcessMiddleware do
+  let(:outbox_item) { create(:outbox_item) }
+
+  before do
+    skip("not supported in the current Rails version") unless defined?(ActiveSupport::ExecutionContext)
+  end
+
+  it "sets execution context" do
+    described_class.new.call(outbox_item) {}
+    expect(ActiveSupport::ExecutionContext.to_h[:box_item]).to eq outbox_item
+  end
+end

spec/lib/sbmt/outbox_spec.rb

@@ -9,7 +9,12 @@
 
   describe "item_process_middlewares" do
     it "returns default middlewares" do
-      expect(described_class.item_process_middlewares).to eq([described_class::Middleware::Sentry::TracingItemProcessMiddleware])
+      expect(described_class.item_process_middlewares)
+        .to include described_class::Middleware::Sentry::TracingItemProcessMiddleware
+      if defined?(ActiveSupport::ExecutionContext)
+        expect(described_class.item_process_middlewares)
+          .to include described_class::Middleware::ExecutionContext::ContextItemProcessMiddleware
+      end
     end
   end
 end