sidekiq-activerecord-shard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2e44ce2e8eb14ffe2a5d28c3e09ded3aab7e90b113be16e9599c483e24880c6
+  data.tar.gz: '08cc893a7882520acd9a57e5d71e6166e635da77ca6c5e305e2789cf689c0a34'
+SHA512:
+  metadata.gz: 6073afb41c1ff90745b5084e2a7482586c0fd7262d2152c42957635778cfdfd48fe5c343ebea5d69af721879d90f0a53923e7d8e58085c0d9ff61672a2c0075e
+  data.tar.gz: 0ee0dd719e024ca5559e1b8ce70159c806775b7ea4f9ae7851874990857e379aa54c10018a79b69c28d9fc007e98f797f61c6d4a602b1569048f235e0af5dee4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Jason Lee
+
+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,60 @@
+# Sidekiq Activerecord::Shard Middleware
+
+A Sidekiq middleware for supports ActiveRecord Shard with [ActiveSupport:CurrentAttribute](https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sidekiq-activerecord-shard"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+
+Add follow code into `config/initializers/sidekiq-activerecord-shard.rb`:
+
+```rb
+SidekiqActiveRecordShard.configure do
+  self.selected_shard = -> do
+    case Current.tenant_id
+    when "company1"
+      :company1
+    else
+      :default
+    end
+  end
+end
+```
+
+Create `app/models/current.rb`:
+
+```rb
+class Current < ActiveSupport::CurrentAttributes
+  attribute :tenant_id
+end
+```
+
+Set `Current.tenant_id` on ApplicationController:
+
+```rb
+class ApplicationController < ActionController::Base
+  before_action :set_current_tenant_id
+
+  def set_current_tenant_id
+    Current.tenant_id = request.headers["x-tenant-id"]
+  end
+end
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## 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,3 @@
+require "bundler/gem_tasks"
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"

data/lib/sidekiq-activerecord-shard/config.rb

@@ -0,0 +1,17 @@
+module SidekiqActiveRecordShard
+  class Configuration
+    attr_accessor :selected_shard
+  end
+
+  class << self
+    def config
+      return @config if defined?(@config)
+
+      @config = Configuration.new
+    end
+
+    def configure(&block)
+      config.instance_exec(&block)
+    end
+  end
+end

data/lib/sidekiq-activerecord-shard/middleware.rb

@@ -0,0 +1,45 @@
+require "sidekiq"
+
+module SidekiqActiveRecordShard
+  class Client
+    include ::Sidekiq::ClientMiddleware
+
+    def call(_jobclass, job, _queue, _redis)
+      # Store shard value in Job arguments
+      job["_active_record_shard"] = SidekiqActiveRecordShard.selected_shard.call
+      yield
+    end
+  end
+
+  class Server
+    include Sidekiq::ServerMiddleware
+    def call(_jobclass, job, _queue, &block)
+      set_shard(job["_active_record_shard"], &block)
+    end
+
+    # Inspired by ActiveRecord::Middleware::ShardSelector
+    # https://github.com/rails/rails/blob/v7.0.3/activerecord/lib/active_record/middleware/shard_selector.rb#L54
+    def set_shard(shared, &block)
+      options = Rails.application.config.active_record.shard_selector
+
+      ActiveRecord::Base.connected_to(shard: shard.to_sym) do
+        ActiveRecord::Base.prohibit_shard_swapping(options.fetch(:lock, true), &block)
+      end
+    end
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add SidekiqActiveRecordShard::Client
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add SidekiqActiveRecordShard::Client
+  end
+  config.server_middleware do |chain|
+    chain.add SidekiqActiveRecordShard::Server
+  end
+end

data/lib/sidekiq-activerecord-shard/version.rb

@@ -0,0 +1,3 @@
+module SidekiqActiveRecordShard
+  VERSION = "0.1.0"
+end

data/lib/sidekiq-activerecord-shard.rb

@@ -0,0 +1,3 @@
+require_relative "./sidekiq-activerecord-shard/version"
+require_relative "./sidekiq-activerecord-shard/config"
+require_relative "./sidekiq-activerecord-shard/middleware"

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-activerecord-shard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Lee
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-15 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+description: A Sidekiq middleware for supports ActiveRecord Shard.
+email:
+- huacnlee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq-activerecord-shard.rb
+- lib/sidekiq-activerecord-shard/config.rb
+- lib/sidekiq-activerecord-shard/middleware.rb
+- lib/sidekiq-activerecord-shard/version.rb
+homepage: https://github.com/huacnlee/sidekiq-activerecord-shard
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/huacnlee/sidekiq-activerecord-shard
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.12
+signing_key:
+specification_version: 4
+summary: Add ActiveRecord Shard supports for Sidekiq.
+test_files: []