publishing_platform_sidekiq 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a959eb18ffd887bb982fa36be08a917123a0a0a2494c699d202906a8b9ae9e0
-  data.tar.gz: 9f4b4ea0d98e7e74c6c5ac28b7a12c11eb310d2c78bece5a1f7e5e4c7a20c0ca
+  metadata.gz: 136a31161907be3c379bd2eb113953524904733a0483349a4f20cd7cbed85e01
+  data.tar.gz: 05335effa99619570ad4566fddc96cfb2d991104cd6bda2ba6ad96d86283b241
 SHA512:
-  metadata.gz: 9c2ca9260720f6e4f446f56bbd828dc0f504631ced5be62a8100036e7b4d2c146455e8c5fd978d5cff20b12a775f92b775a2c161714f7b899e5035e4b6d61c96
-  data.tar.gz: a121c393d3db6ffbd4c18098d754d0d298f226b5705d4aed7eb050008df49a210755ce9ce766702d0b11b9970cd35d25f385029d97e87c24139371fbb86d9712
+  metadata.gz: 97dc0696f8fb84b740f8f4ac861e324d1a9dc685c722378b207e53e7bf82a54cbb35a5a74251d59cd5fb7d3ed9595db60c2c5f050088d5a6566d878016c34dc7
+  data.tar.gz: e7238f347a080e864e2eca13f1de876ecc123aad92cf3ca92aaaa601fb1c921380c2207864350a8ff5a0c4666f80bde65273cf45df7755fb70cb0b43ffb5aab9

data/lib/publishing_platform_sidekiq/api_headers.rb

@@ -0,0 +1,54 @@
+require "publishing_platform_api/publishing_platform_headers"
+require "sidekiq"
+
+module PublishingPlatformSidekiq
+  module APIHeaders
+    # Client-side middleware runs before the pushing of the job to Redis and
+    # allows you to modify/stop the job before it gets pushed.
+    #
+    # https://github.com/mperham/sidekiq/wiki/Middleware#client-side-middleware
+    class ClientMiddleware
+      def call(_worker_class, job, _queue, _redis_pool)
+        last_arg = job["args"].last
+        if is_header_hash(last_arg)
+          job["args"].pop
+          job["args"] << header_arguments.merge(last_arg)
+        else
+          job["args"] << header_arguments
+        end
+        yield
+      end
+
+      def header_arguments
+        {
+          "authenticated_user" => PublishingPlatformApi::PublishingPlatformHeaders.headers[:x_publishing_platform_authenticated_user],
+          "request_id" => PublishingPlatformApi::PublishingPlatformHeaders.headers[:publishing_platform_request_id],
+        }
+      end
+
+      def is_header_hash(arg)
+        arg.is_a?(Hash) && (arg.symbolize_keys.keys.include?(:authenticated_user) || arg.symbolize_keys.keys.include?(:request_id))
+      end
+    end
+
+    # Server-side middleware runs 'around' job processing.
+    #
+    # https://github.com/mperham/sidekiq/wiki/Middleware#server-side-middleware
+    class ServerMiddleware
+      def call(_worker, message, _queue)
+        last_arg = message["args"].last
+
+        if last_arg.is_a?(Hash) && last_arg.keys.include?("request_id")
+          message["args"].pop
+          request_id = last_arg["request_id"]
+          authenticated_user = last_arg["authenticated_user"]
+          PublishingPlatformApi::PublishingPlatformHeaders.set_header(:publishing_platform_request_id, request_id)
+          PublishingPlatformApi::PublishingPlatformHeaders.set_header(:x_publishing_platform_authenticated_user, authenticated_user)
+          Sidekiq::Context.add("publishing_platform_request_id", request_id)
+        end
+
+        yield
+      end
+    end
+  end
+end

data/lib/publishing_platform_sidekiq/railtie.rb

@@ -2,11 +2,14 @@ require "publishing_platform_sidekiq/sidekiq_initializer"
 
 module PublishingPlatformSidekiq
   class Railtie < Rails::Railtie
-    initializer "publishing_platform_sidekiq.initialize_sidekiq" do |app|
-      SidekiqInitializer.setup_sidekiq(
-        ENV.fetch("PUBLISHING_PLATFORM_APP_NAME", app.root.basename.to_s),
-        { url: ENV.fetch("REDIS_URL", "redis://127.0.0.1:6379") },
-      )
+    initializer "publishing_platform_sidekiq.initialize_sidekiq" do
+      redis_options = { url: ENV.fetch("REDIS_URL", "redis://127.0.0.1:6379") }
+
+      if ENV["REDIS_SSL_VERIFY_NONE"] == "true"
+        redis_options[:ssl_params] = { verify_mode: OpenSSL::SSL::VERIFY_NONE }
+      end
+
+      SidekiqInitializer.setup_sidekiq(redis_options)
     end
   end
 end

data/lib/publishing_platform_sidekiq/sidekiq_initializer.rb

@@ -1,22 +1,26 @@
 require "sidekiq"
+require "publishing_platform_sidekiq/api_headers"
 
 module PublishingPlatformSidekiq
   module SidekiqInitializer
-    def self.setup_sidekiq(publishing_platform_app_name, redis_config = {})
-      redis_config = redis_config.merge(
-        namespace: publishing_platform_app_name,
-        reconnect_attempts: 4,
-        reconnect_delay: 15,
-        reconnect_delay_max: 60,
-      )
+    def self.setup_sidekiq(redis_config = {})
+      redis_config = redis_config.merge(reconnect_attempts: [15, 30, 45, 60])
 
       Sidekiq.configure_server do |config|
         config.logger = Sidekiq::Logger.new($stdout)
         config.redis = redis_config
+
+        config.server_middleware do |chain|
+          chain.add PublishingPlatformSidekiq::APIHeaders::ServerMiddleware
+        end
       end
 
       Sidekiq.configure_client do |config|
         config.redis = redis_config
+
+        config.client_middleware do |chain|
+          chain.add PublishingPlatformSidekiq::APIHeaders::ClientMiddleware
+        end
       end
     end
   end

data/lib/publishing_platform_sidekiq/testing.rb

@@ -0,0 +1,6 @@
+require "sidekiq/testing"
+require "publishing_platform_sidekiq/api_headers"
+
+Sidekiq::Testing.server_middleware do |chain|
+  chain.add PublishingPlatformSidekiq::APIHeaders::ServerMiddleware
+end

data/lib/publishing_platform_sidekiq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PublishingPlatformSidekiq
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,63 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Publishing Platform
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: publishing_platform_api_adapters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis-namespace
+  name: redis-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.22.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.22.2
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.5'
-    - - ">="
+        version: '7.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 6.5.12
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.5'
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  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: 6.5.12
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: publishing_platform_rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -72,8 +85,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: 
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -81,14 +120,14 @@ files:
 - LICENSE
 - README.md
 - lib/publishing_platform_sidekiq.rb
+- lib/publishing_platform_sidekiq/api_headers.rb
 - lib/publishing_platform_sidekiq/railtie.rb
 - lib/publishing_platform_sidekiq/sidekiq_initializer.rb
+- lib/publishing_platform_sidekiq/testing.rb
 - lib/publishing_platform_sidekiq/version.rb
-homepage: 
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Provides standard setup and behaviour for Sidekiq in Publishing Platform
   applications.