sidekiq-serialized_current_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21dbbeb4be1ba5aae80db8434a3708247e43844aae1dc733ab18cbfed82b7dad
+  data.tar.gz: 0113e0e2fe42bc22e570290c785482696eaf4da1fda0de83d7a757d2d8159ba2
+SHA512:
+  metadata.gz: a22ed569eb797e646694f592baf787570f2b8841b14f2655091e66260289bf1049d07f1de8881de540be66cc0b00be8cc6ab754c46172972b78123dfe4ef6efe
+  data.tar.gz: 1a463411930f80a1fe92d59c52abcc87206582bfb9315a0424ef352a2e92bc6860bb75c86a5b7cbea403bcfa81e02574f8aee4b63256662ac407ac77d5ffa929

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Fabian Schwahn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Sidekiq::SerializedCurrentAttributes
+
+Extends Sidekiq::CurrentAttributes to serialize values (such as activerecord objects).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```sh
+bundle add sidekiq-serialized_current_attributes
+```
+
+## Usage
+
+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.
+
+```ruby
+# in your initializer
+require "sidekiq/serialized_current_attributes"
+Sidekiq::SerializedCurrentAttributes.persist("Myapp::Current")
+# or multiple current attributes
+Sidekiq::SerializedCurrentAttributes.persist(["Myapp::Current", "Myapp::OtherCurrent"])
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/sidekiq/serialized_current_attributes/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module SerializedCurrentAttributes
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq/serialized_current_attributes.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+require "active_support/current_attributes"
+require "active_job/arguments"
+
+require_relative "serialized_current_attributes/version"
+
+# Code is pretty directly taken from https://github.com/sidekiq/sidekiq/blob/main/lib/sidekiq/middleware/current_attributes.rb, and adjusted so it uses ActiveJob argument serialization to support storing models.
+module Sidekiq
+  module SerializedCurrentAttributes
+    class Save
+      include Sidekiq::ClientMiddleware
+
+      def initialize(cattrs)
+        @cattrs = cattrs
+      end
+
+      def call(_, job, _, _)
+        @cattrs.each do |(key, strklass)|
+          if !job.has_key?(key)
+            attrs = serialize(strklass.constantize.attributes)
+            # Retries can push the job N times, we don't
+            # want retries to reset cattr. #5692, #5090
+            job[key] = attrs if attrs.any?
+          end
+        end
+        yield
+      end
+
+      def serialize(attributes)
+        serialized_values = ActiveJob::Arguments.serialize(attributes.values)
+        attributes.keys.zip(serialized_values).to_h
+      end
+    end
+
+    class Load
+      include Sidekiq::ServerMiddleware
+
+      def initialize(cattrs)
+        @cattrs = cattrs
+      end
+
+      def call(_, job, _, &block)
+        cattrs_to_reset = []
+
+        @cattrs.each do |(key, strklass)|
+          if job.has_key?(key)
+            constklass = strklass.constantize
+            cattrs_to_reset << constklass
+
+            attributes = deserialize(job[key])
+            attributes.each do |(attribute, value)|
+              constklass.public_send("#{attribute}=", value)
+            end
+          end
+        end
+
+        yield
+      ensure
+        cattrs_to_reset.each(&:reset)
+      end
+
+      def deserialize(attributes)
+        deserialized_values = ActiveJob::Arguments.deserialize(attributes.values)
+        attributes.keys.zip(deserialized_values).to_h
+      end
+    end
+
+    class << self
+      def persist(klass_or_array, config = Sidekiq.default_configuration)
+        cattrs = build_cattrs_hash(klass_or_array)
+
+        config.client_middleware.add Save, cattrs
+        config.server_middleware.add Load, cattrs
+      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 == 0) ? "cattr" : "cattr_#{index}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-serialized_current_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabian Schwahn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- fabian.schwahn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/serialized_current_attributes.rb
+- lib/sidekiq/serialized_current_attributes/version.rb
+homepage: https://github.com/denkungsart/sidekiq-serialized_current_attributes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/denkungsart/sidekiq-serialized_current_attributes
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Serialize CurrentAttributes for Sidekiq
+test_files: []