pgbus 0.9.6 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71ef7f4e4fa290e422b8ce72402833f6a31fd7cb3d081aef8a4bfcc09fc467eb
-  data.tar.gz: 31a6522c809392316d28125b0fe8e972c6e18ca8b48510d8f891135b75c3e63c
+  metadata.gz: a8282d1403685f1543b1df1394cc6199e9f9182f697db151c4d6cd22f20018b9
+  data.tar.gz: 83ff9056787cd40b38a8724a55cb2e23b670f446a37f9612c38a561ea1120c37
 SHA512:
-  metadata.gz: 7554038df6c2a70435a615a2594425ff05ce102953b445a7ad5f47ee3d69a7e81e32445f9e790d987d71b5b17aa807250ebadae6d50f191da3eb23c0676b8f98
-  data.tar.gz: fadb07428ddbaead22200de2ff1031ff924d75e4fa5cc7ea48307ab7a22e8cf84b7528ea3a69f25baab402732a7804046005e6c1b1fd33fced91823de4702896
+  metadata.gz: 4095c65e96196ba5cb87d4e1df86c4066d5534610ff210c919f4b1f4d26d97005025add8d4ac97a8f153a2a340f0fa20cf66fdca79f8695bd30b537a899eb404
+  data.tar.gz: cba33628e71e9670d991abaf75c34ac53152e3a721734a13dca8bed262bcc2bda931f0721767395829c3f4e415245564d11f7e927608699f9bba76cb29485089

data/app/helpers/pgbus/application_helper.rb

@@ -109,11 +109,12 @@ module Pgbus
     def pgbus_parse_message(message)
       return {} unless message
 
-      case message
-      when Hash then message
-      when String then JSON.parse(message)
-      else {}
-      end
+      parsed = case message
+               when Hash then message
+               when String then JSON.parse(message)
+               else {}
+               end
+      Pgbus::Web::PayloadFilter.filter(parsed)
     rescue JSON::ParserError
       {}
     end
@@ -121,7 +122,8 @@ module Pgbus
     def pgbus_json_preview(json_string, max_length: 120)
       return "—" unless json_string
 
-      text = json_string.is_a?(String) ? json_string : JSON.generate(json_string)
+      filtered = Pgbus::Web::PayloadFilter.filter_json(json_string)
+      text = filtered.is_a?(String) ? filtered : JSON.generate(filtered)
       text.length > max_length ? "#{text[0...max_length]}..." : text
     end
 

data/app/views/pgbus/jobs/show.html.erb

@@ -40,7 +40,7 @@
 
   <div class="rounded-lg bg-white dark:bg-gray-800 shadow ring-1 ring-gray-200 dark:ring-gray-700 p-6 mb-6">
     <h2 class="text-sm font-medium text-gray-500 mb-2"><%= t("pgbus.jobs.show.payload") %></h2>
-    <pre class="text-xs text-gray-600 bg-gray-50 dark:bg-gray-900 rounded p-4 overflow-x-auto"><%= JSON.pretty_generate(JSON.parse(@job["payload"])) rescue @job["payload"] %></pre>
+    <pre class="text-xs text-gray-600 bg-gray-50 dark:bg-gray-900 rounded p-4 overflow-x-auto"><%= JSON.pretty_generate(pgbus_parse_message(@job["payload"])) %></pre>
   </div>
 
   <div class="flex space-x-2">

data/lib/pgbus/configuration.rb

@@ -109,7 +109,8 @@ module Pgbus
     # Web dashboard
     attr_accessor :web_auth, :web_refresh_interval, :web_per_page, :web_live_updates, :web_data_source,
                   :insights_default_minutes, :base_controller_class, :return_to_app_url,
-                  :metrics_enabled
+                  :metrics_enabled,
+                  :dashboard_filter_parameters, :dashboard_filter_sensitive
 
     # Streams (turbo-rails replacement, SSE-based)
     attr_accessor :streams_enabled, :streams_path, :streams_queue_prefix, :streams_signed_name_secret,
@@ -220,6 +221,8 @@ module Pgbus
       @base_controller_class = "::ActionController::Base"
       @return_to_app_url = nil
       @metrics_enabled = true
+      @dashboard_filter_parameters = nil # nil = auto-detect from Rails, then fall back to defaults
+      @dashboard_filter_sensitive = true
 
       @streams_enabled = true
       @streams_path = nil

data/lib/pgbus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pgbus
-  VERSION = "0.9.6"
+  VERSION = "0.9.7"
 end

data/lib/pgbus/web/payload_filter.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Pgbus
+  module Web
+    module PayloadFilter
+      module_function
+
+      DEFAULT_FILTER_PATTERNS = [
+        :password, :passphrase, :secret, :token, :authorization,
+        :api_key, :private_key, :access_key, :secret_key,
+        /(_|-)key$/
+      ].freeze
+
+      FILTERED = "[FILTERED]"
+
+      def filter(value)
+        return value unless Pgbus.configuration.dashboard_filter_sensitive
+
+        case value
+        when Hash
+          parameter_filter.filter(value)
+        when Array
+          value.map { |element| filter(element) }
+        else
+          value
+        end
+      end
+
+      def filter_json(value)
+        return value unless Pgbus.configuration.dashboard_filter_sensitive
+
+        case value
+        when nil then nil
+        when Hash, Array
+          JSON.generate(filter(value))
+        when String
+          parsed = JSON.parse(value)
+          JSON.generate(filter(parsed))
+        else
+          value
+        end
+      rescue JSON::ParserError
+        value
+      end
+
+      def parameter_filter
+        patterns = Pgbus.configuration.dashboard_filter_parameters ||
+                   rails_filter_parameters ||
+                   DEFAULT_FILTER_PATTERNS
+        ActiveSupport::ParameterFilter.new(patterns)
+      end
+
+      def rails_filter_parameters
+        return unless defined?(Rails) &&
+                      Rails.respond_to?(:application) &&
+                      Rails.application.respond_to?(:config) &&
+                      Rails.application.config.respond_to?(:filter_parameters)
+
+        params = Rails.application.config.filter_parameters
+        params if params.is_a?(Array) && params.any?
+      end
+
+      private_class_method :parameter_filter, :rails_filter_parameters
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgbus
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -356,6 +356,7 @@ files:
 - lib/pgbus/web/authentication.rb
 - lib/pgbus/web/data_source.rb
 - lib/pgbus/web/metrics_serializer.rb
+- lib/pgbus/web/payload_filter.rb
 - lib/pgbus/web/stream_app.rb
 - lib/pgbus/web/streamer.rb
 - lib/pgbus/web/streamer/connection.rb