ekylibre-plugin_system 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31fa595ea20dee0bbf28b84fb549a4728e9c5420585d1414ab88378eceee9d0d
-  data.tar.gz: c53e1a49c95655a86ea85b44cee8f276ff1d229fc9ed6055c96662043d22168c
+  metadata.gz: e67301a6ea670850bd6794f51d287fabb277f209fbbf5983d3e29540de7fefb4
+  data.tar.gz: 5fe4b34bdad1085b5484ba7ebf809466005ca01343634aa5942596e9bf7d0d18
 SHA512:
-  metadata.gz: '0078f0864c44175b792d194f89db19ccf28473f6881a0447cd762c3b43ce1934898f8f1fa8f3da091b1f76f7c3d32064cbfe37d39218314f9fb50ab96653be16'
-  data.tar.gz: ef004b7fa8ee0ca120acd0f263a7851f551a63a8ec06630d7b22bd82d6a97a6b96e1c07c9513794f774e1206da4168fd4d9e76ef2d687388e550dc980e65f546
+  metadata.gz: 81ff8b3f60e94fca1a5ecf30ad0ebdd39c946af640ec6ab15e578a72fc881d2096bdcc7f96d2dc531111e5f83e57a04abdd0c9cfef61753e9fd1a63b512631b9
+  data.tar.gz: 38521c74d7ef72588fe61d8b0e7d27f04260c2d964e2b36c5715052e2c8ebf8f7d741608f44376ecfa2b0c5ea832391982b14f9197cd2791c7063319497901fc

data/ekylibre-plugin_system.gemspec

@@ -22,7 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'corindon', '~> 0.7.0'
   spec.add_dependency 'railties', '> 4'
   spec.add_dependency 'request_store', '~> 1.5.0'
-  spec.add_dependency 'request_store-sidekiq', '~> 0.1.0'
   spec.add_dependency 'zeitwerk', '~> 2.4'
 
   spec.add_development_dependency 'bundler', '>= 1.17'

data/lib/ekylibre-plugin_system.rb

@@ -2,7 +2,6 @@
 
 require 'corindon'
 require 'request_store'
-require 'request_store/sidekiq'
 require 'zeitwerk'
 
 module Ekylibre # :nodoc:
@@ -12,7 +11,6 @@ end
 loader = Zeitwerk::Loader.for_gem
 loader.ignore(__FILE__)
 loader.ignore("#{__dir__}/plugin_system/rails/**/*.rb")
-loader.ignore("#{__dir__}/plugin_system/multi_tenancy/railtie.rb")
 loader.setup
 
 require_relative 'ekylibre/plugin_system/rails/railtie' if defined?(::Rails)

data/lib/ekylibre/plugin_system/console_helper.rb

@@ -8,7 +8,10 @@ module Ekylibre
 
       # @return [Corindon::DependencyInjection::Container]
       def container
-        ::Rails.application.system.container
+        instance = ::Rails.application.system.container
+        RequestStore['container'] = instance
+
+        instance
       end
     end
   end

data/lib/ekylibre/plugin_system/middleware/sidekiq_middleware.rb

@@ -3,22 +3,45 @@
 module Ekylibre
   module PluginSystem
     module Middleware
-      # Sidekiq server middleware adding the provided container to the job context
-      class SidekiqMiddleware
-        def initialize(container)
-          @container = container
-        end
+      module SidekiqMiddleware
+        class << self
+          # This method sets up sidekiq middlewares allowing to access the container natively inside jobs.
+          #
+          # In addition, it also stores the job's container inside RequestStore so that
+          # the legacy code of Ekylibre can globally access the container when needed.
+          #
+          # The client middleware is called when a job is enqueued, the server middleware when the job is executed.
+          #
+          def setup(container:)
+            ::Sidekiq.configure_client do |config|
+              configure_client(config, container: container)
+            end
 
-        def call(_worker_class, item, _queue)
-          RequestStore['container'] = container
-          item['container'] = container
+            ::Sidekiq.configure_server do |config|
+              configure_client(config, container: container)
 
-          yield
-        end
+              configure_server(config, container: container)
+            end
+          end
+
+          private
 
-        private
-          # @return [Corindon::DependencyInjection::Container]
-          attr_reader :container
+            def configure_client(config, container:)
+              config.client_middleware do |chain|
+                chain.add ClientMiddleware, container
+              end
+            end
+
+            def configure_server(config, container:)
+              config.server_middleware do |chain|
+                if defined?(::Sidekiq::Batch::Server)
+                  chain.insert_before ::Sidekiq::Batch::Server, ServerMiddleware, container
+                else
+                  chain.add ServerMiddleware, container
+                end
+              end
+            end
+        end
       end
     end
   end

data/lib/ekylibre/plugin_system/middleware/sidekiq_middleware/client_middleware.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    module Middleware
+      # Sidekiq client middleware adding the provided container to the job context
+      # so that all other middlewares can access it for configuring newly enqueued jobs.
+      module SidekiqMiddleware
+        class ClientMiddleware
+          def initialize(container)
+            @container = container
+          end
+
+          def call(worker_class, item, queue, redis_pool = nil)
+            item['container'] = container
+
+            yield
+          end
+
+          private
+
+            # @return [Corindon::DependencyInjection::Container]
+            attr_reader :container
+        end
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/middleware/sidekiq_middleware/server_middleware.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    module Middleware
+      # Sidekiq server middleware adding the provided container to the job context.
+      # It also makes the container accessible through RequestStore for the legacy code to be able to access it globally.
+      module SidekiqMiddleware
+        class ServerMiddleware
+          def initialize(container)
+            @container = container
+          end
+
+          def call(_worker_class, item, _queue)
+            RequestStore['container'] = container
+            item['container'] = container
+
+            yield
+          ensure
+            # We want to have the same behavior as the request_store-sidekiq gem.
+            # However, we want to insert our middleware BEFORE the Batch middleware.
+            RequestStore.clear!
+          end
+
+          private
+
+            # @return [Corindon::DependencyInjection::Container]
+            attr_reader :container
+        end
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/rails/railtie.rb

@@ -14,20 +14,11 @@ module Ekylibre
         end
 
         initializer(:register_middleware, after: :engines_blank_point) do |app|
-          # app.config.middleware.insert_after(apartment_middleware, Ekylibre::PluginSystem::Middleware::RackMiddleware, app.system.container)
           app.config.middleware.use(Middleware::RackMiddleware, app.system.container)
         end
 
         initializer(:register_sidekiq_middleware, after: :engines_blank_point) do |app|
-          ::Sidekiq.configure_server do |config|
-            config.server_middleware do |chain|
-              if defined?(::Sidekiq::Batch::Server)
-                chain.insert_before ::Sidekiq::Batch::Server, Middleware::SidekiqMiddleware, app.system.container
-              else
-                chain.add Middleware::SidekiqMiddleware, app.system.container
-              end
-            end
-          end
+          Middleware::SidekiqMiddleware.setup(container: app.system.container)
         end
 
         # rubocop:disable Lint/Debugger

data/lib/ekylibre/plugin_system/sugar/rights.rb

@@ -9,10 +9,17 @@ module Ekylibre
           using Corindon::DependencyInjection::Injectable
 
           # @param [Corindon::DependencyInjection::Container] container
-          def register_rights(container:)
+          # @param [String] origin
+          def register_rights(container:, origin:)
+            root_param = Corindon::DependencyInjection::Token::ValueToken.new(value: engine.root)
+            origin_param = Corindon::DependencyInjection::Token::ValueToken.new(value: origin)
+
             container.add_definition(
-              self.class.make_definition('rights_loader', Ekylibre::Access::RightsLoader, context: engine.root.join('config', 'rights.yml')) do |path|
-                args path, origin: value(:hajimari)
+              self.class.make_definition(
+                'rights_loader',
+                Ekylibre::Access::RightsLoader,
+                root: root_param, origin: origin_param
+              ) do
                 tag 'ekylibre.access.rights_loader'
               end
             )

data/lib/ekylibre/plugin_system/version.rb

@@ -2,6 +2,6 @@
 
 module Ekylibre
   module PluginSystem
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ekylibre-plugin_system
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ekylibre developers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: corindon
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
-- !ruby/object:Gem::Dependency
-  name: request_store-sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
-description: 
+description:
 email:
 - dev@ekylibre.com
 executables: []
@@ -149,6 +135,8 @@ files:
 - lib/ekylibre/plugin_system/controller_mixin.rb
 - lib/ekylibre/plugin_system/middleware/rack_middleware.rb
 - lib/ekylibre/plugin_system/middleware/sidekiq_middleware.rb
+- lib/ekylibre/plugin_system/middleware/sidekiq_middleware/client_middleware.rb
+- lib/ekylibre/plugin_system/middleware/sidekiq_middleware/server_middleware.rb
 - lib/ekylibre/plugin_system/parameters.rb
 - lib/ekylibre/plugin_system/plugin.rb
 - lib/ekylibre/plugin_system/plugin_registration.rb
@@ -163,7 +151,7 @@ homepage: https://www.ekylibre.com
 licenses:
 - AGPL-3.0-only
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Plugin system for Rails built around a Dependency Injection Container
 test_files: []