govuk_sidekiq 4.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2df36f07a855664bcd0022727e6b7e6d0b255df9e28d82e256d8542cc68a99ae
-  data.tar.gz: 61e191ea3d6f277a5bfc72d50c0e794d2bc58471e91b3af5bbf97d0586b5fd4b
+  metadata.gz: 0b29995a70caf772608c804cddc8f38fedc0d79c5a02157a8c9d1c46576403fc
+  data.tar.gz: 660d8a260f5a175c4bea49e978eb2d302fad1d0a35672e2740770908e134f789
 SHA512:
-  metadata.gz: 9dbf5756a97595d4ceaa3e02ce941d949f44f904ad43b5f0bd7e0a713a2cef45e4976c50ae13cafc2ae654a49d29c06955dd4ec0d05fc808e26c2621f9ad8263
-  data.tar.gz: 21ac94434996452d35bde7ffed3e1ca46ed64b5482573dc2a5ffb0d5b2cfc64d822f4f1a72b042a527b6d434b9a2448f58e52af963f80f54143f16b766e2bec6
+  metadata.gz: 2c2ef5066358f76e4c6b4452bb452d498f8c4e7fe38363b570488457cbe3d8c687aec4fac3fee9c5a6208e9e8f57015b7e8ee6fc277246e7e1626b6dcd25c5f2
+  data.tar.gz: 9982cee079fc37d903726c2c6ef259d48884802fa410b071a07ae16d32f1169d0f5a7bba1d4484fac0836dfa9fbbf062f0afb8606e223f232f56851390423981

data/README.md

@@ -25,7 +25,7 @@ What does `govuk_sidekiq` do for you?
 
 ```ruby
 # Gemfile
-gem "govuk_sidekiq", "~> VERSION"
+gem "govuk_sidekiq"
 ```
 
 ### 2. Add a Sidekiq config file
@@ -50,12 +50,10 @@ worker: bundle exec sidekiq -C ./config/sidekiq.yml
 
 ### 4. Configure puppet
 
-- Set `REDIS_HOST` and `REDIS_PORT` variables. `GOVUK_APP_NAME` should also be
-set, but this is already done by the default `govuk::app::config`. If your Redis instance
-requires more advanced connection settings (eg username and password) you can instead
-set a `REDIS_URL` variable, this will take precidence over `REDIS_HOST` and `REDIS_PORT`.
+- Set a `REDIS_URL` environment variable. `GOVUK_APP_NAME` should also be
+set, but this is already done by the default `govuk::app::config`.
 
-    Apply redis variables for your app in [the default config](https://github.com/alphagov/govuk-puppet/blob/master/hieradata/common.yaml). For example:
+    Apply redis variables for your app in [the default config](https://github.com/alphagov/govuk-puppet/blob/main/hieradata_aws/common.yaml). For example:
 
     ```
     govuk::apps::your_app::redis_host: "%{hiera('sidekiq_host')}"
@@ -63,7 +61,7 @@ set a `REDIS_URL` variable, this will take precidence over `REDIS_HOST` and `RED
     ```
 - Make sure puppet creates and starts the Procfile worker.
 
-There's no step-by-step guide for this, but [you can copy the config from collections-publisher](https://github.com/alphagov/govuk-puppet/blob/master/modules/govuk/manifests/apps/collections_publisher.pp).
+There's no step-by-step guide for this, but [you can copy the config from collections-publisher](https://github.com/alphagov/govuk-puppet/blob/main/modules/govuk/manifests/apps/collections_publisher.pp).
 
 ### 5. Configure deployment scripts
 
@@ -74,18 +72,9 @@ Make sure you restart the worker after deploying by adding a hook to the [capist
 after "deploy:restart", "deploy:restart_procfile_worker"
 ```
 
-### 6. Add your worker to the Procfile & Pinfile
+### 6. Add app to sidekiq-monitoring
 
-This makes sure that your development environment behaves like production.
-
-See the [Pinfile][] and [Procfile][] for examples.
-
-[Pinfile]: https://github.com/alphagov/govuk-puppet/tree/master/development-vm/Pinfile
-[Procfile]: https://github.com/alphagov/govuk-puppet/tree/master/development-vm/Procfile
-
-### 7. Add app to sidekiq-monitoring
-
-See the opsmanual for a step-by-step guide: [Add sidekiq-monitoring to your application][monitoring]
+See the dev docs for a step-by-step guide: [Add sidekiq-monitoring to your application][monitoring]
 
 [monitoring]: https://docs.publishing.service.gov.uk/manual/setting-up-new-sidekiq-monitoring-app.html
 
@@ -121,7 +110,3 @@ require 'govuk_sidekiq/testing'
 ## Licence
 
 [MIT License](LICENCE)
-
-## Versioning policy
-
-See https://github.com/alphagov/styleguides/blob/master/rubygems.md#versioning

data/lib/govuk_sidekiq/api_headers.rb

@@ -22,8 +22,8 @@ module GovukSidekiq
 
       def header_arguments
         {
-          authenticated_user: GdsApi::GovukHeaders.headers[:x_govuk_authenticated_user],
-          request_id: GdsApi::GovukHeaders.headers[:govuk_request_id],
+          "authenticated_user" => GdsApi::GovukHeaders.headers[:x_govuk_authenticated_user],
+          "request_id" => GdsApi::GovukHeaders.headers[:govuk_request_id],
         }
       end
 

data/lib/govuk_sidekiq/railtie.rb

@@ -3,18 +3,9 @@ require "govuk_sidekiq/sidekiq_initializer"
 module GovukSidekiq
   class Railtie < Rails::Railtie
     initializer "govuk_sidekiq.initialize_sidekiq" do |app|
-      config = if ENV["REDIS_URL"]
-                 { url: ENV["REDIS_URL"] }
-               else
-                 {
-                   host: ENV.fetch("REDIS_HOST", "127.0.0.1"),
-                   port: ENV.fetch("REDIS_PORT", 6379),
-                 }
-               end
-
       SidekiqInitializer.setup_sidekiq(
-        ENV["GOVUK_APP_NAME"] || app.root.basename.to_s,
-        config,
+        ENV.fetch("GOVUK_APP_NAME", app.root.basename.to_s),
+        { url: ENV.fetch("REDIS_URL", "redis://127.0.0.1:6379") },
       )
     end
   end

data/lib/govuk_sidekiq/sidekiq_initializer.rb

@@ -1,18 +1,28 @@
 require "sidekiq"
-require "sidekiq/logging/json"
 require "sidekiq-statsd"
 require "govuk_sidekiq/api_headers"
 require "govuk_app_config/govuk_statsd"
 
 module GovukSidekiq
   module SidekiqInitializer
-    def self.setup_sidekiq(govuk_app_name, redis_config)
+    def self.setup_sidekiq(govuk_app_name, redis_config = {})
       redis_config = redis_config.merge(
         namespace: govuk_app_name,
         reconnect_attempts: 1,
       )
 
       Sidekiq.configure_server do |config|
+        config.log_formatter = Sidekiq::Logger::Formatters::JSON.new if ENV["GOVUK_SIDEKIQ_JSON_LOGGING"]
+
+        # $real_stdout is defined by govuk_app_config and is used to point to
+        # STDOUT as that redirects $stdout to actually be $stderr.
+        # When govuk_app_config does this we need to use $real_stdout to output logs to STDOUT.
+        # https://github.com/alphagov/govuk_app_config/blob/08fd9cf6a848615261b3cef021e34490ed72ee55/lib/govuk_app_config/govuk_logging.rb#L18-L24
+
+        # rubocop:disable Style/GlobalVars
+        config.logger = Sidekiq::Logger.new($real_stdout) if defined?($real_stdout)
+        # rubocop:enable Style/GlobalVars
+
         config.redis = redis_config
 
         config.server_middleware do |chain|
@@ -28,8 +38,6 @@ module GovukSidekiq
           chain.add GovukSidekiq::APIHeaders::ClientMiddleware
         end
       end
-
-      Sidekiq.logger.formatter = Sidekiq::Logging::Json::Logger.new if Sidekiq.options[:logfile]
     end
   end
 end

data/lib/govuk_sidekiq/version.rb

@@ -1,3 +1,3 @@
 module GovukSidekiq
-  VERSION = "4.0.0".freeze
+  VERSION = "6.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_sidekiq
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2023-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
@@ -54,38 +54,18 @@ dependencies:
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-- !ruby/object:Gem::Dependency
-  name: sidekiq-logging-json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: sidekiq-statsd
   requirement: !ruby/object:Gem::Requirement
@@ -101,75 +81,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '7'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.9.0
 description: 
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -197,14 +177,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: Provides standard setup and behaviour for Sidekiq in GOV.UK applications.