sidekiq_current_model_middleware 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21bd7e76952cdd1ae2dbc3fceb860acd135affef33a8eab7ef4d3671fba60eae
+  data.tar.gz: 28d837555a7ddedd10ce018caf93067e7aa9938524f7d7534aca4119b527b99f
+SHA512:
+  metadata.gz: 2504b2be2e663161fdc48326a92b275ea1315866345f1e239450a3d214065d1157906efad362e9e96197c6874eb520b20667a0b689008ca0ca8dc97226cd2bdc
+  data.tar.gz: 5d23431c6469736a28387dbac509efad43c861ce2a5c97fb1890c87fb05f47a8b49852b3207bb9e9abf7f50f448b47072b436b918287d00315896250dc430df9

data/lib/sidekiq_current_model_middleware.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+# SidekiqCurrentModelMiddleware
+#
+# This gem provides middleware for Sidekiq to persist ActiveSupport::CurrentAttributes
+# across job boundaries, including support for ActiveRecord models.
+#
+# It extends the functionality of Sidekiq's built-in CurrentAttributes middleware
+# by adding serialization and deserialization of ActiveRecord models using GlobalID.
+#
+# Key features:
+# - Persists CurrentAttributes from Rails actions into associated Sidekiq jobs
+# - Supports multiple CurrentAttributes classes
+# - Handles serialization of ActiveRecord models using GlobalID
+# - Provides both client-side and server-side middleware
+#
+# Usage:
+#   SidekiqCurrentModelMiddleware.persist("MyApp::Current")
+#   # or for multiple current attributes:
+#   SidekiqCurrentModelMiddleware.persist(["MyApp::Current", "MyApp::OtherCurrent"])
+#
+# This file was modified from https://github.com/sidekiq/sidekiq/blob/main/lib/sidekiq/middleware/current_attributes.rb
+# It extends the original implementation to handle serialization and deserialization of ActiveRecord models.
+
+require 'active_support/current_attributes'
+require 'active_record'
+require 'global_id'
+require 'sidekiq/client'
+require 'sidekiq'
+
+##
+# Automatically save and load any current attributes in the execution context
+# so context attributes "flow" from Rails actions into any associated jobs.
+# This can be useful for multi-tenancy, i18n locale, timezone, any implicit
+# per-request attribute. See +ActiveSupport::CurrentAttributes+.
+#
+# For multiple current attributes, pass an array of current attributes.
+#
+# @example
+#
+#   # in your initializer
+#   require "sidekiq_current_model_middleware"
+#   SidekiqCurrentModelMiddleware.persist("Myapp::Current")
+#   # or multiple current attributes
+#   SidekiqCurrentModelMiddleware.persist(["Myapp::Current", "Myapp::OtherCurrent"])
+#
+# SidekiqCurrentModelMiddleware module
+#
+# This module provides middleware for Sidekiq to persist ActiveSupport::CurrentAttributes
+# across job boundaries, including support for ActiveRecord models.
+#
+# It extends the functionality of Sidekiq's built-in CurrentAttributes middleware
+# by adding serialization and deserialization of ActiveRecord models using GlobalID.
+module SidekiqCurrentModelMiddleware
+  # Save class
+  #
+  # Client middleware that saves CurrentAttributes to the Sidekiq job payload.
+  # It handles serialization of ActiveRecord models using GlobalID.
+  class Save
+    include Sidekiq::ClientMiddleware
+
+    # Initialize the Save middleware
+    #
+    # @param cattrs [Hash] A hash of CurrentAttributes classes to persist
+    def initialize(cattrs)
+      @cattrs = cattrs
+    end
+
+    def call(_, job, _, _)
+      @cattrs.each do |(key, strklass)|
+        next if job.key?(key)
+
+        # Add the global id if the attribute is an ActiveRecord model
+        attrs = strklass.constantize.attributes.transform_values do |attr|
+          attr.class <= ActiveRecord::Base ? attr.to_global_id : attr
+        end
+        # Retries can push the job N times, we don't
+        # want retries to reset cattr. #5692, #5090 (from orig Sidekiq repo)
+        job[key] = attrs if attrs.any?
+      end
+      yield
+    end
+  end
+
+  # Load class
+  #
+  # Server middleware that loads CurrentAttributes from the Sidekiq job payload.
+  # It handles deserialization of ActiveRecord models using GlobalID.
+  class Load
+    include Sidekiq::ServerMiddleware
+
+    # Initialize the Load middleware
+    #
+    # @param cattrs [Hash] A hash of CurrentAttributes classes to load
+    def initialize(cattrs)
+      @cattrs = cattrs
+    end
+
+    def call(_, job, _, &block)
+      klass_attrs = {}
+
+      @cattrs.each do |(key, strklass)|
+        next unless job.key?(key)
+
+        klass_attrs[strklass.constantize] = job[key]
+      end
+
+      wrap(klass_attrs.to_a, &block)
+    end
+
+    private
+
+    def wrap(klass_attrs, &block)
+      klass, attrs = klass_attrs.shift
+      return block.call unless klass
+
+      retried = false
+
+      begin
+        klass.set(current_attributes(attrs)) do
+          wrap(klass_attrs, &block)
+        end
+      rescue NoMethodError
+        raise if retried
+
+        # It is possible that the `CurrentAttributes` definition
+        # was changed before the job started processing.
+        attrs = attrs.select { |attr| klass.respond_to?(attr) }
+        retried = true
+        retry
+      end
+    end
+
+    def current_attributes(attrs)
+      attrs.transform_values do |attr|
+        GlobalID::Locator.locate(attr) || attr
+      end
+    end
+  end
+
+  class << self
+    # Persist CurrentAttributes across Sidekiq job boundaries
+    #
+    # @param klass_or_array [String, Array<String>] The CurrentAttributes class(es) to persist
+    # @param config [Sidekiq::Config] The Sidekiq configuration to use (default: Sidekiq.default_configuration)
+    #
+    # @example
+    #   SidekiqCurrentModelMiddleware.persist("MyApp::Current")
+    #   # or for multiple current attributes:
+    #   SidekiqCurrentModelMiddleware.persist(["MyApp::Current", "MyApp::OtherCurrent"])
+    def persist(klass_or_array)
+      cattrs = build_cattrs_hash(klass_or_array)
+
+      Sidekiq.configure_server do |config|
+        config.server_middleware do |chain|
+          chain.add Sidekiq::Middleware::MultiTenant::Server
+        end
+        config.client_middleware do |chain|
+          chain.add Sidekiq::Middleware::MultiTenant::Client
+        end
+      end
+
+      Sidekiq.configure_client do |config|
+        config.client_middleware do |chain|
+          chain.add Sidekiq::Middleware::MultiTenant::Client
+        end
+      end
+    end
+
+    private
+
+    def build_cattrs_hash(klass_or_array)
+      if klass_or_array.is_a?(Array)
+        {}.tap do |hash|
+          klass_or_array.each_with_index do |klass, index|
+            hash[key_at(index)] = klass.to_s
+          end
+        end
+      else
+        { key_at(0) => klass_or_array.to_s }
+      end
+    end
+
+    def key_at(index)
+      index.zero? ? 'cattr' : "cattr_#{index}"
+    end
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_current_model_middleware
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Zavier Miller
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides Sidekiq middleware that extends the functionality of
+  Sidekiq's built-in CurrentAttributes to persist and restore ActiveSupport::CurrentAttributes
+  across Sidekiq jobs, with added support for ActiveRecord models. It uses GlobalID
+  for serialization and deserialization of ActiveRecord objects, allowing seamless
+  integration with Rails applications to maintain context between web requests and
+  background jobs. The middleware supports multiple CurrentAttributes classes and
+  handles both client-side and server-side persistence.
+email: zavierjmiller@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sidekiq_current_model_middleware.rb
+homepage: https://rubygems.org/gems/sidekiq_current_model_middleware
+licenses:
+- LGPLv3
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Sidekiq Middleware for persisting ActiveSupport::CurrentAttributes with ActiveRecord
+  model support
+test_files: []