sidekiq-activerecord-shard 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 758bc7c30968cfc3961024118a4e4dd4f0bbefd4d99995ad7465f05691bac4eb
-  data.tar.gz: ae47127827bf9933229f22a3e104b698e2591e79acbba39e929b2515220bdb98
+  metadata.gz: bc3fd046c8730189dc8afc6549c1182e4ae0777e5dc686ad50765c2e0f577945
+  data.tar.gz: 570c63c2c849cf1e563da69ffd40cc4079d4a3cace6919e81aa97819ea45dada
 SHA512:
-  metadata.gz: 17fcce8d7723e936f85bc1a8d15448dc7ce89035f29cfc0f1f0d9484bae5793adf66d01c05dc2e00af36e576d1a01e12810ad103d75215d3d269a7be79b59248
-  data.tar.gz: fafdc2936270b3bc3237baa794559632977c304c69c01ff8057d5c6ea0379c57df8771cf9a0d9e7f32cc28c16b5ab290167e76e03192ff8ac2c46d04813d3500
+  metadata.gz: 6ec87050a506362f909b2327c25752e953080faebb41f43c2efe58148fe43da9778468bceb8268f96ae6bda9970f9383cf6ddd8aba5f41aa04da45819ef53bfe
+  data.tar.gz: 21e121eded72e9530548eea897e8132ca3fd79190b4f4d51ab10fbd4ac5d8b1bde36a6d52abbf5e020acdf13663ba81b9df93ec9c87d60e92386a79fdb5528c2

data/README.md

@@ -2,6 +2,9 @@
 
 A Sidekiq middleware for supports ActiveRecord Shard with [ActiveSupport:CurrentAttribute](https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html).
 
+> **Warning** 
+> This gem can work with [sidekiq-cron](https://github.com/ondrejbartas/sidekiq-cron) or other schedulers, because when Schedule perform a job, they can't know the which shard to use.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -17,9 +20,33 @@ $ bundle
 
 ## Usage
 
-Add follow code into `config/initializers/sidekiq-activerecord-shard.rb`:
+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
+```
+
+Add sidekiq config `config/initializers/sidekiq-activerecord-shard.rb`:
 
 ```rb
+# Enable Sidekiq CurrentAttributes middleware for store Current
+require "sidekiq/middleware/current_attributes"
+Sidekiq::CurrentAttributes.persist(Current)
+
 SidekiqActiveRecordShard.configure do
   self.selected_shard = -> do
     case Current.tenant_id
@@ -32,24 +59,19 @@ SidekiqActiveRecordShard.configure do
 end
 ```
 
-Create `app/models/current.rb`:
 
-```rb
-class Current < ActiveSupport::CurrentAttributes
-  attribute :tenant_id
-end
-```
+### Perform Job by set shared
 
-Set `Current.tenant_id` on ApplicationController:
+Some times, you want to perform a job without Request context, or start Job in schedulers.
+
+Now use can use `set(shard: "shard_name")` to set shared in directly.
 
 ```rb
-class ApplicationController < ActionController::Base
-  before_action :set_current_tenant_id
+# Call job with "other" shard db
+MyJob.set(shard: "other").perform_later
 
-  def set_current_tenant_id
-    Current.tenant_id = request.headers["x-tenant-id"]
-  end
-end
+# Call job with "primary" shard db
+MyJob.set(shard: "primary").perform_later
 ```
 
 ## Contributing

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

@@ -2,24 +2,34 @@ require "sidekiq"
 
 module SidekiqActiveRecordShard
   class Client
-    include Sidekiq::ClientMiddleware
+    if Sidekiq::VERSION >= "6.5"
+      include Sidekiq::ClientMiddleware
+    end
 
     def call(_jobclass, job, _queue, _redis)
       # Store shard value in Job arguments
-      job["_active_record_shard"] = SidekiqActiveRecordShard.config.selected_shard.call
+      job["shard"] ||= SidekiqActiveRecordShard.config.selected_shard.call
+
       yield
     end
   end
 
   class Server
-    include Sidekiq::ServerMiddleware
+    if Sidekiq::VERSION >= "6.5"
+      include Sidekiq::ServerMiddleware
+    end
+
     def call(_jobclass, job, _queue, &block)
-      set_shard(job["_active_record_shard"], &block)
+      if job["shard"].nil?
+        yield
+      else
+        set_shard(job["shard"], &block)
+      end
     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)
+    def set_shard(shard, &block)
       options = Rails.application.config.active_record.shard_selector
 
       ActiveRecord::Base.connected_to(shard: shard.to_sym) do

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

@@ -1,3 +1,3 @@
 module SidekiqActiveRecordShard
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-activerecord-shard
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Jason Lee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails