rails_surrogate_key_logging 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4508c5a982897fd625ce7ee7625cedd7a78691b42a6562f9e036e2577f54b91
+  data.tar.gz: 5d5b0395a7cb737fd5f1dc90f0dbbf74a493fcdb91ad8644a9e802584b649e9a
+SHA512:
+  metadata.gz: 3201bc7f7e84b36813141a3c9e24883d1fd3a416ec4f05d6e6345fd46d063ebf494bcf39ca333f5292eed7ca845e0604d80f4907064b3db78aac6a496a477a08
+  data.tar.gz: 105d8ed9be27bf5e3f633f230b5836668793c45960628749b09e71570279d7f754207ce4275542fd886129975a6e342da0ac221c32c7ba4b81d27ddc49e12d68

data/README.md

@@ -0,0 +1 @@
+# rails-surrogate-key-logging

data/lib/rails_surrogate_key_logging.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'surrogate_key_logging'

data/lib/surrogate_key_logging/action_controller/log_subscriber.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'action_controller/log_subscriber'
+
+module SurrogateKeyLogging
+  module ActionController
+    class LogSubscriber < ::ActionController::LogSubscriber
+
+      def start_processing(event)
+        event.payload[:params] = SurrogateKeyLogging.filter_parameters event.payload[:params]
+        super
+      end
+
+    end
+  end
+end

data/lib/surrogate_key_logging/action_controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module SurrogateKeyLogging
+  module ActionController
+    extend ActiveSupport::Autoload
+
+    autoload :LogSubscriber
+
+  end
+end

data/lib/surrogate_key_logging/action_dispatch/request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SurrogateKeyLogging
+  module ActionDispatch
+    module Request
+
+      def filtered_query_string
+        super.gsub(::ActionDispatch::Request::PAIR_RE) do |_|
+          SurrogateKeyLogging.filter_parameters(::Regexp.last_match(1) => ::Regexp.last_match(2)).first.join('=')
+        end
+      end
+
+    end
+  end
+end

data/lib/surrogate_key_logging/action_dispatch.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module SurrogateKeyLogging
+  module ActionDispatch
+    extend ActiveSupport::Autoload
+
+    autoload :Request
+
+  end
+end

data/lib/surrogate_key_logging/active_record/attributes.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module SurrogateKeyLogging
+  module ActiveRecord
+    module Attributes
+      extend ActiveSupport::Concern
+
+      included do
+        surrogate_parent_names model_name.singular, model_name.plural
+      end
+
+      class_methods do
+        def surrogate_parent_names(*names)
+          @surrogate_parent_names ||= []
+          names.each do |name|
+            @surrogate_parent_names << name.to_sym
+            surrogate_attributes.each do |attr|
+              SurrogateKeyLogging.add_param_to_filter(attr, name)
+            end
+          end
+          @surrogate_parent_names
+        end
+
+        def surrogate_attributes(*attrs)
+          @surrogate_attributes ||= []
+          attrs.each do |attr|
+            @surrogate_attributes << attr.to_sym
+            surrogate_parent_names.each do |parent|
+              SurrogateKeyLogging.add_param_to_filter(attr, parent)
+            end
+          end
+          @surrogate_attributes
+        end
+      end
+
+    end
+  end
+end

data/lib/surrogate_key_logging/active_record/log_subscriber.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module SurrogateKeyLogging
+  module ActiveRecord
+    class LogSubscriber < ::ActiveRecord::LogSubscriber
+
+      def sql(event) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+        self.class.runtime += event.duration
+        return unless logger.debug?
+
+        payload = event.payload
+
+        return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+        name  = "#{payload[:name]} (#{event.duration.round(1)}ms)"
+        name  = "CACHE #{name}" if payload[:cached]
+        sql   = payload[:sql]
+        binds = nil
+
+        name_match = /([A-Za-z]+) (Load|Update|Cache)/.match(payload[:name])
+        model = if name_match && name_match[1] && ::ActiveRecord::Base.descendants.map(&:to_s).include?(name_match[1])
+                  name_match[1].safe_constantize
+                end
+
+        if payload[:binds]&.any?
+          casted_params = type_casted_binds(payload[:type_casted_binds])
+
+          binds = []
+          payload[:binds].each_with_index do |attr, i|
+            binds << render_bind(attr, casted_params[i], payload, model)
+          end
+          binds = binds.inspect
+          binds.prepend('  ')
+        end
+
+        name = colorize_payload_name(name, payload[:name])
+        sql  = color(sql, sql_color(sql), true) if colorize_logging
+
+        debug "  #{name}  #{sql}#{binds}"
+      end
+
+      private
+
+        def basic_parameter_filter
+          @basic_parameter_filter ||= ::ActiveSupport::ParameterFilter.new(Rails.application.config.filter_parameters)
+        end
+
+        def type_casted_binds(casted_binds)
+          casted_binds.respond_to?(:call) ? casted_binds.call : casted_binds
+        end
+
+        def render_bind(attr, value, _payload, model) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          case attr
+          when ActiveModel::Attribute
+            value = "<#{attr.value_for_database.to_s.bytesize} bytes of binary data>" if attr.type.binary? && attr.value
+          when Array
+            attr = attr.first
+          else
+            attr = nil
+          end
+
+          attr_name = attr&.name
+          if model && attr_name && model.respond_to?(:surrogate_attributes) && model.surrogate_attributes.include?(attr_name.to_sym)
+            value = SurrogateKeyLogging.key_manager.call(attr_name, value, model.to_s.underscore)
+          elsif attr_name
+            value = basic_parameter_filter.filter(attr_name => value)[attr_name]
+          end
+          [attr_name, value]
+        end
+
+    end
+  end
+end

data/lib/surrogate_key_logging/active_record.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SurrogateKeyLogging
+  module ActiveRecord
+    extend ActiveSupport::Autoload
+
+    autoload :Attributes
+    autoload :LogSubscriber
+
+  end
+end

data/lib/surrogate_key_logging/active_support.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'active_support/parameter_filter'
+
+# Add ability for @mask to be a class/instance/lambda/proc
+module ActiveSupport
+  module ParameterFilter
+    class CompiledFilter
+
+      def value_for_key(key, value, parents = [], original_params = nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+        parents.push(key) if deep_regexps
+        if regexps.any? { |r| r.match?(key.to_s) }
+          value = @mask.respond_to?(:call) ? @mask.call(key, value, parents, original_params) : @mask
+        elsif deep_regexps && (joined = parents.join('.')) && deep_regexps.any? { |r| r.match?(joined) } # rubocop:disable Lint/DuplicateBranch
+          value = @mask.respond_to?(:call) ? @mask.call(key, value, parents, original_params) : @mask
+        elsif value.is_a?(Hash)
+          value = call(value, parents, original_params)
+        elsif value.is_a?(Array)
+          # If we don't pop the current parent it will be duplicated as we
+          # process each array value.
+          parents.pop if deep_regexps
+          value = value.map { |v| value_for_key(key, v, parents, original_params) }
+          # Restore the parent stack after processing the array.
+          parents.push(key) if deep_regexps
+        elsif blocks.any?
+          key = key.dup if key.duplicable?
+          value = value.dup if value.duplicable?
+          blocks.each { |b| b.arity == 2 ? b.call(key, value) : b.call(key, value, original_params) }
+        end
+        parents.pop if deep_regexps
+        value
+      end
+
+    end
+  end
+end

data/lib/surrogate_key_logging/key_manager.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SurrogateKeyLogging
+  class KeyManager
+
+    def call(key, value, _parents = [], _original_params = nil)
+      surrogate = "SK#{Digest::SHA512.hexdigest(value.to_s)}"
+      puts "surrogate for key: `#{key}`, value: `#{value}`, surrogate: `#{surrogate}`"
+      surrogate
+    end
+
+  end
+end

data/lib/surrogate_key_logging/middleware.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SurrogateKeyLogging
+  class Middleware
+    attr_reader :app
+
+    def initialize(app)
+      @app = app
+      puts 'surrogate new'
+    end
+
+    def call(env)
+      SurrogateKeyLogging.reset
+      @app.call(env)
+    end
+
+  end
+end

data/lib/surrogate_key_logging/railtie.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module SurrogateKeyLogging
+  class Railtie < Rails::Railtie
+    railtie_name :surrogate_key_logging
+
+    initializer 'surrogate_key_logging.filter_parameters' do
+      puts 'surrogate_key_logging.filter_parameters'
+    end
+
+    initializer 'surrogate_key_logging.logs' do
+      puts 'surrogate_key_logging.logs'
+      ::ActiveRecord::LogSubscriber.detach_from(:active_record)
+      ::SurrogateKeyLogging::ActiveRecord::LogSubscriber.attach_to(:active_record)
+      ::ActiveSupport::LogSubscriber.detach_from(:action_controller)
+      ::SurrogateKeyLogging::ActionController::LogSubscriber.attach_to(:action_controller)
+      ::ActionDispatch::Request.include SurrogateKeyLogging::ActionDispatch::Request
+    end
+
+    initializer 'surrogate_key_logging.middleware' do
+      puts 'surrogate_key_logging.middleware'
+      Rails.application.config.middleware.insert_before 0, Middleware
+    end
+
+  end
+end

data/lib/surrogate_key_logging/version.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SurrogateKeyLogging
+
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+  end
+
+  VERSION = [
+    Version::MAJOR,
+    Version::MINOR,
+    Version::PATCH,
+  ].join('.').freeze
+
+end

data/lib/surrogate_key_logging.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+# Container Module
+module SurrogateKeyLogging
+  extend ActiveSupport::Autoload
+
+  autoload :Railtie
+  autoload :Version
+  autoload :ActionController
+  autoload :ActionDispatch
+  autoload :ActiveSupport
+  autoload :ActiveRecord
+  autoload :KeyManager
+  autoload :Middleware
+
+  class << self
+
+    def surrogate_attributes(*attrs)
+      @surrogate_attributes ||= []
+      attrs.each do |attr|
+        @surrogate_attributes << attr.to_s
+      end
+      @surrogate_attributes
+    end
+
+    def reset
+      @key_manager = @parameter_filter = nil
+    end
+
+    def key_manager
+      @key_manager ||= KeyManager.new
+    end
+
+    def parameter_filter
+      @parameter_filter ||= ::ActiveSupport::ParameterFilter.new(surrogate_attributes, mask: key_manager)
+    end
+
+    def filter_parameters(params)
+      parameter_filter.filter params
+    end
+
+    def add_param_to_filter(attr, parent = nil)
+      if parent.nil?
+        surrogate_attributes attr.to_s
+      else
+        surrogate_attributes(
+          "#{parent}.#{attr}",
+          "#{parent}[#{attr}]",
+          "[#{parent}][#{attr}]"
+        )
+      end
+    end
+
+  end
+
+end
+
+require 'surrogate_key_logging/railtie'

data/rails_surrogate_key_logging.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'surrogate_key_logging/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rails_surrogate_key_logging'
+  s.version     = SurrogateKeyLogging::VERSION
+  s.authors     = ['Taylor Yelverton']
+  s.email       = 'rubygems@yelvert.io'
+  s.homepage    = 'https://github.com/ComplyMD/rails_surrogate_key_logging'
+  s.summary     = ''
+  s.license     = 'MIT'
+  s.description = ''
+  s.metadata    = {
+    'bug_tracker_uri' => 'https://github.com/ComplyMD/rails_surrogate_key_logging/issues',
+    'changelog_uri' => 'https://github.com/ComplyMD/rails_surrogate_key_logging/commits/master',
+    'documentation_uri' => 'https://github.com/ComplyMD/rails_surrogate_key_logging/wiki',
+    'homepage_uri' => 'https://github.com/ComplyMD/rails_surrogate_key_logging',
+    'source_code_uri' => 'https://github.com/ComplyMD/rails_surrogate_key_logging',
+    'rubygems_mfa_required' => 'true',
+  }
+
+  s.files = Dir['lib/**/*', 'README.md', 'MIT-LICENSE', 'rails_surrogate_key_logging.gemspec']
+
+  s.require_paths = %w[ lib ]
+
+  s.required_ruby_version = '>= 2.7.0'
+
+  s.add_dependency('actionpack', '>= 6.0.0')
+  s.add_dependency('activerecord', '>= 6.0.0')
+  s.add_dependency('activesupport', '>= 6.0.0')
+  s.add_dependency('railties', '>= 6.0.0')
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: rails_surrogate_key_logging
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Taylor Yelverton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: ''
+email: rubygems@yelvert.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/rails_surrogate_key_logging.rb
+- lib/surrogate_key_logging.rb
+- lib/surrogate_key_logging/action_controller.rb
+- lib/surrogate_key_logging/action_controller/log_subscriber.rb
+- lib/surrogate_key_logging/action_dispatch.rb
+- lib/surrogate_key_logging/action_dispatch/request.rb
+- lib/surrogate_key_logging/active_record.rb
+- lib/surrogate_key_logging/active_record/attributes.rb
+- lib/surrogate_key_logging/active_record/log_subscriber.rb
+- lib/surrogate_key_logging/active_support.rb
+- lib/surrogate_key_logging/key_manager.rb
+- lib/surrogate_key_logging/middleware.rb
+- lib/surrogate_key_logging/railtie.rb
+- lib/surrogate_key_logging/version.rb
+- rails_surrogate_key_logging.gemspec
+homepage: https://github.com/ComplyMD/rails_surrogate_key_logging
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/ComplyMD/rails_surrogate_key_logging/issues
+  changelog_uri: https://github.com/ComplyMD/rails_surrogate_key_logging/commits/master
+  documentation_uri: https://github.com/ComplyMD/rails_surrogate_key_logging/wiki
+  homepage_uri: https://github.com/ComplyMD/rails_surrogate_key_logging
+  source_code_uri: https://github.com/ComplyMD/rails_surrogate_key_logging
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []