govuk_app_config 9.11.0 → 9.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b999667300e1c7039636683bbec26d0876bba98d909766de7f2a900cbe8fec
-  data.tar.gz: 9f256df66ab205142cf4e53d0fe868bb57d9f17e2465906f10f5be6fc8abdf1e
+  metadata.gz: 2f502d5ff732d2ef2693fca10c8c4366180ca91a1e243aabc2e9c3a8c6081b7f
+  data.tar.gz: cab52af8090596b98a8ba84f90105a161c8f64d293c437030de7c1a964832ad9
 SHA512:
-  metadata.gz: e12b4f83286dde0a7be9a252e85f0ec6284e86396b7a8f2888c0c34591c41e5acf9c6b685d0c04310d44e8c990b103a2581905c11280beda39863c8ee601b7ae
-  data.tar.gz: 754946671f494b0be22851f8c7b0926fd79a7bbce1a39a7cb5adf8a1ffff12ba2a27ca3997bf32945b8f7b8e9ee7fbe27de5939b9f37e0887e830aac95c7b83e
+  metadata.gz: a88e6b1158e9ece8c93469d5c8b1b6a8af894bc79096353ca6540c632d9459d3ea46718b8e1181a4ac75a1d5580ba54d786317fb17e71bdc282babda20ee78c2
+  data.tar.gz: bb215c586b2c3bde4119df0cca8845cdb6b06d6eeb266a9fcfd70f3fd263944f2aeaf718f3fbe8a50d93915e90b8e67b8818a6301da008bfbaa38dd5b8561d7f

data/.github/pull_request_template.md

@@ -0,0 +1,3 @@
+⚠️ Make sure you [release a new version of this gem](https://github.com/alphagov/govuk_app_config/pull/356/files) after merging your changes. ⚠️
+
+Refer to the [existing docs](https://docs.publishing.service.gov.uk/manual/publishing-a-ruby-gem.html#ruby-version-compatibility) if you are making changes to the supported Ruby versions.

data/.github/workflows/autorelease.yml

@@ -1,7 +1,7 @@
 on:
   workflow_dispatch: {}
   schedule:
-    - cron: '00 13 * * 2'
+    - cron: '30 10 * * 1-5' # 10:30am UTC, Mon-Fri.
 
 jobs:
   autorelease:

data/.github/workflows/ci.yml

@@ -11,17 +11,6 @@ on:
         type: string
 
 jobs:
-  snyk-security:
-    name: SNYK security analysis
-    uses: alphagov/govuk-infrastructure/.github/workflows/snyk-security.yml@main
-    with:
-      skip_sca: true
-    secrets: inherit
-    permissions:
-      contents: read
-      security-events: write
-      actions: read
-  
   codeql-sast:
     name: CodeQL SAST scan
     uses: alphagov/govuk-infrastructure/.github/workflows/codeql-analysis.yml@main

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 9.11.2
+
+* Fix Logstasher monkey patch overriding patch from this library for OpenTelemetry errors ([#377](https://github.com/alphagov/govuk_app_config/pull/377))
+
+# 9.11.1
+
+* Fix OpenTelemetry errors when using with Logstasher gem ([#372](https://github.com/alphagov/govuk_app_config/pull/372))
+
 # 9.11.0
 
 * Add GDS::SSO::PermissionDeniedError to excluded exceptions list ([#366](https://github.com/alphagov/govuk_app_config/pull/366))

data/govuk_app_config.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "rspec-its", "~> 1.3"
-  spec.add_development_dependency "rubocop-govuk", "4.16.1"
+  spec.add_development_dependency "rubocop-govuk", "4.18.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "webmock"
 end

data/lib/govuk_app_config/govuk_json_logging/rails_ext/action_controller/metal/instrumentation.rb

@@ -0,0 +1,65 @@
+# This is copied from
+# https://github.com/shadabahmed/logstasher/blob/main/lib/logstasher/rails_ext/action_controller/metal/instrumentation.rb
+# Changes have been highlight in comments, otherwise the code is the same.
+
+module ActionController
+  module Instrumentation
+    alias_method "orig_process_action", "process_action"
+
+    def process_action(*args)
+      # The raw payload has been updated to reflect the payload structure used
+      # in Rails 7.1, primarily the addition of the `headers`, `request` keys
+      # and using `request.filtered_path` instead of `request.fullpath`.
+      # https://github.com/rails/rails/blame/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/action_controller/metal/instrumentation.rb#L60
+      raw_payload = {
+        controller: self.class.name,
+        action: action_name,
+        request:,
+        params: request.filtered_parameters,
+        headers: request.headers,
+        format: request.format.ref,
+        method: request.request_method,
+        path: begin
+          request.filtered_path
+        rescue StandardError
+          "unknown"
+        end,
+      }
+
+      LogStasher.add_default_fields_to_payload(raw_payload, request)
+
+      LogStasher.clear_request_context
+      LogStasher.add_default_fields_to_request_context(request)
+
+      ActiveSupport::Notifications.instrument("start_processing.action_controller", raw_payload.dup)
+
+      ActiveSupport::Notifications.instrument("process_action.action_controller", raw_payload) do |payload|
+        if respond_to?(:logstasher_add_custom_fields_to_request_context)
+          logstasher_add_custom_fields_to_request_context(LogStasher.request_context)
+        end
+
+        if respond_to?(:logstasher_add_custom_fields_to_payload)
+          before_keys = raw_payload.keys.clone
+          logstasher_add_custom_fields_to_payload(raw_payload)
+          after_keys = raw_payload.keys
+          # Store all extra keys added to payload hash in payload itself. This is a thread safe way
+          LogStasher::CustomFields.add(*(after_keys - before_keys))
+        end
+
+        result = super
+
+        payload[:status] = response.status
+        append_info_to_payload(payload)
+        LogStasher.store.each do |key, value|
+          payload[key] = value
+        end
+
+        LogStasher.request_context.each do |key, value|
+          payload[key] = value
+        end
+        result
+      end
+    end
+    alias_method "logstasher_process_action", "process_action"
+  end
+end

data/lib/govuk_app_config/govuk_json_logging.rb

@@ -16,6 +16,14 @@ module GovukJsonLogging
   end
 
   def self.configure(&block)
+    # Fixes the monkey patch from the logstasher gem to support Rails 7
+    config = Rails.application.config.logstasher
+    if (!config.controller_monkey_patch && config.controller_monkey_patch != false) || config.controller_monkey_patch == true
+      require_relative "./govuk_json_logging/rails_ext/action_controller/metal/instrumentation"
+      # Prevent the old monkey patch being applied
+      config.controller_monkey_patch = false
+    end
+
     configuration = Configuration.new
 
     configuration.instance_eval(&block) if block_given?

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "9.11.0".freeze
+  VERSION = "9.11.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 9.11.0
+  version: 9.11.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2024-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -292,14 +292,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.16.1
+        version: 4.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.16.1
+        version: 4.18.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -336,6 +336,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/pull_request_template.md"
 - ".github/workflows/autorelease.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
@@ -365,6 +366,7 @@ files:
 - lib/govuk_app_config/govuk_healthcheck/redis.rb
 - lib/govuk_app_config/govuk_healthcheck/sidekiq_redis.rb
 - lib/govuk_app_config/govuk_json_logging.rb
+- lib/govuk_app_config/govuk_json_logging/rails_ext/action_controller/metal/instrumentation.rb
 - lib/govuk_app_config/govuk_open_telemetry.rb
 - lib/govuk_app_config/govuk_prometheus_exporter.rb
 - lib/govuk_app_config/govuk_proxy/static_proxy.rb
@@ -391,7 +393,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications