rails_surrogate_key_logging 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f98ce688e0b5bccad6bcfc8e3fe0df9b3796f1a92fd4fe30e17d5093d7a176a8
-  data.tar.gz: efd6b574da4f0ba06d0e47f1564e2f5c049d549d8b0fda59945bb9746028d922
+  metadata.gz: 8ffb01158739d8e9483393f18c917c77a17ef7632153c831f15856ec737faf2f
+  data.tar.gz: 54c085f0021eadfa90cb57c86c72327aa2dece0ff5b21a6b1abbf2dfdcbf6bf2
 SHA512:
-  metadata.gz: 2dbce84a07a1c6146dbf4022d47c6528c1b189c55f053c5671d307ee1d4c378d74a2126fe646728bfbb24b528603ac26d16d777d7e49448a864ade402eedfff0
-  data.tar.gz: e42649376a21bd2838dca825aeee9c27dd8d2ec3921aa1b311e0a3f7c71f8a6e9b029089c7c6d8726b4135dfedb421b5261fdeb24e732ae88e1df1e498549d58
+  metadata.gz: 332f4dbc5a940d9f761236ca335acf8314ed297e32be30146ef2f8b1d12e6c4ae2f3b29ec3c06ec21a16f5d9586134a756c17655446dd79b2d23be5aba464c9c
+  data.tar.gz: d59829e5426f10e971d32d3390017b6c370f4d0552cd84ff5eab16d5224959e75c1769e976f265c03150f86d2ac46913ac86474cf73f1e499813597976325b7d

data/app/models/surrogate_key_logging/surrogate.rb

@@ -15,14 +15,16 @@ module SurrogateKeyLogging
         where(hashed_value: hash_value(value)).select(:key).first&.key
       end
 
-      def add(surrogate, value)
-        s = new(key: surrogate, value: value, hashed_value: hash_value(value))
-        s.save
-      end
-
       def use(surrogate)
         where(key: surrogate).touch_all
       end
+
+      def find_or_create_surrogate_for_value(value, key_for)
+        hashed_value = hash_value(value)
+        upsert_all([{key: key_for.call(value), value: value, hashed_value: hashed_value}], update_only: 'updated_at')
+        where(hashed_value: hashed_value).select(:key).first.key
+      end
+
     end
   end
 end

data/lib/surrogate_key_logging/engine.rb

@@ -34,6 +34,10 @@ module SurrogateKeyLogging
       end
     end
 
+    initializer 'surrogate_key_logging.middleware' do |app|
+      app.middleware.insert_before(0, Middleware)
+    end
+
     initializer 'surrogate_key_logging.filter_parameters' do
       if SurrogateKeyLogging.config.enabled
       end

data/lib/surrogate_key_logging/key_manager.rb

@@ -28,13 +28,9 @@ module SurrogateKeyLogging
     end
 
     def get_non_cached(value)
-      stored = key_store.surrogate_for_value(value)
-      return stored if stored.present?
-      surrogate = key_for.call(value)
-      key_store.save(surrogate, value)
-      surrogate
+      key_store.get(value)
     end
-    
+
     def call(_key, value, _parents = [], _original_params = nil)
       return "" if value.blank?
       surrogate = get(value)

data/lib/surrogate_key_logging/key_store/active_record.rb

@@ -5,7 +5,7 @@ module SurrogateKeyLogging
 
     class ActiveRecord < Base
 
-      attr_reader :model
+      attr_reader :model, :key_for
 
       def initialize
         if SurrogateKeyLogging.config.key?(:model) && SurrogateKeyLogging.config.model.present?
@@ -14,24 +14,16 @@ module SurrogateKeyLogging
         else
           @model = SurrogateKeyLogging::Surrogate
         end
+        @key_for = SurrogateKeyLogging.config.key_for
       end
 
-      def surrogate_for_value(value)
-        key = model.surrogate_for_value(value)
-        use(key)
-        key
-      end
-
-      def value_for_surrogate(surrogate)
-        model.value_for_surrogate(surrogate)
-      end
-
-      def save(surrogate, value)
-        model.add(surrogate, value)
-      end
-
-      def use(surrogate)
-        model.use(surrogate)
+      def get(value)
+        _get = -> { model.find_or_create_surrogate_for_value(value, key_for) }
+        if SurrogateKeyLogging.config.debug
+          _get.call
+        else
+          ::ActiveRecord::Base.logger.silence { _get.call }
+        end
       end
 
     end

data/lib/surrogate_key_logging/key_store/base.rb

@@ -4,19 +4,7 @@ module SurrogateKeyLogging
   module KeyStore
     class Base
 
-      def surrogate_for_value(value)
-        raise NotImplementedError
-      end
-
-      def value_for_surrogate(surrogate)
-        raise NotImplementedError
-      end
-
-      def save(surrogate, value)
-        raise NotImplementedError
-      end
-      
-      def use(surrogate)
+      def get(value, generator)
         raise NotImplementedError
       end
       

data/lib/surrogate_key_logging/middleware.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SurrogateKeyLogging
+  class Middleware
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      SurrogateKeyLogging.reset
+      @app.call(env)
+    end
+
+  end
+end

data/lib/surrogate_key_logging/sidekiq.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+if defined?(::Sidekiq)
+  module Sidekiq
+    if defined?(Worker)
+      module Worker::ClassMethods
+        def surrogate_params(*attrs)
+          @surrogate_params ||= []
+          attrs.each do |attr|
+            @surrogate_params << attr.to_sym
+          end
+          @surrogate_params
+        end
+      end
+    end
+
+    if defined?(JobLogger)
+      class JobLogger
+        alias_method :job_hash_context__before_surrogate_key_logging, :job_hash_context
+        def job_hash_context(job_hash)
+          hash = job_hash_context__before_surrogate_key_logging(job_hash).stringify_keys
+          hash['args'] = {}
+          if job_hash.key?('args')
+            begin
+              klass = hash['class'].constantize
+              perform = klass.instance_method(:perform)
+              params = perform.parameters
+              params.each_with_index do |param, i|
+                hash['args'][param.last] = job_hash['args'][i]
+              end
+              hash['args'] = SurrogateKeyLogging.filter_for_attributes(klass.surrogate_params).filter(hash['args'])
+            end
+          end
+          hash
+        end
+      end
+    end
+
+  end
+end

data/lib/surrogate_key_logging/version.rb

@@ -4,7 +4,7 @@ module SurrogateKeyLogging
 
   module Version
     MAJOR = 1
-    MINOR = 0
+    MINOR = 2
     PATCH = 0
 
   end

data/lib/surrogate_key_logging.rb

@@ -12,12 +12,14 @@ module SurrogateKeyLogging
   autoload :ActiveRecord
   autoload :Config, 'surrogate_key_logging/configuration'
   autoload :Configuration
+  autoload :Engine
   autoload :KeyManager
   autoload :KeyStore
   autoload :Middleware
-  autoload :Engine
   autoload :Version
 
+  require 'surrogate_key_logging/sidekiq' if defined?(::Sidekiq)
+
   @config = Config.new
 
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_surrogate_key_logging
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Taylor Yelverton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-31 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -120,6 +120,8 @@ files:
 - lib/surrogate_key_logging/key_store.rb
 - lib/surrogate_key_logging/key_store/active_record.rb
 - lib/surrogate_key_logging/key_store/base.rb
+- lib/surrogate_key_logging/middleware.rb
+- lib/surrogate_key_logging/sidekiq.rb
 - lib/surrogate_key_logging/version.rb
 - lib/tasks/key_store/active_record.rake
 - lib/tasks/surrogate_key_logging.rake