rails_surrogate_key_logging 0.0.1 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/surrogate_key_logging/action_controller/params.rb +34 -0
- data/lib/surrogate_key_logging/action_dispatch/params_filter.rb +42 -0
- data/lib/surrogate_key_logging/action_dispatch/query_string_filter.rb +56 -0
- data/lib/surrogate_key_logging/action_dispatch/request.rb +5 -3
- data/lib/surrogate_key_logging/action_dispatch.rb +2 -0
- data/lib/surrogate_key_logging/active_record/attributes.rb +1 -5
- data/lib/surrogate_key_logging/active_record/log_subscriber.rb +2 -1
- data/lib/surrogate_key_logging/active_support.rb +1 -1
- data/lib/surrogate_key_logging/configuration.rb +15 -0
- data/lib/surrogate_key_logging/engine.rb +53 -0
- data/lib/surrogate_key_logging/key_manager.rb +34 -3
- data/lib/surrogate_key_logging/key_store/active_record.rb +42 -0
- data/lib/surrogate_key_logging/key_store/base.rb +25 -0
- data/lib/surrogate_key_logging/key_store.rb +28 -0
- data/lib/surrogate_key_logging/version.rb +2 -2
- data/lib/surrogate_key_logging.rb +35 -10
- data/lib/tasks/key_store/active_record.rake +119 -0
- data/lib/tasks/surrogate_key_logging.rake +13 -0
- data/rails_surrogate_key_logging.gemspec +4 -4
- metadata +36 -4
- data/lib/surrogate_key_logging/middleware.rb +0 -18
- data/lib/surrogate_key_logging/railtie.rb +0 -28
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 51ed41b166599e90b95c595ecbd87fb3812dbeca4087dec61f4a6d4efc03793f
|
4
|
+
data.tar.gz: 5389b994867bac68b6edaeaf90e2af777af74634bfea2d505378bb8f5ec55432
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 799c109ed078447639c5c06f2f6f20ba9d27d5fa1674b61cfc9f8ac96f0d033fe9c01b8472f03676e2852752ae42ca108b2b5b3f13093f22d03d5ae222b1eb4f
|
7
|
+
data.tar.gz: 2c06278e7a1744f49bd90e88682b82d69b40f502a5af20b69fb0bc1e264110996806a7a340cdd2ab63c5e1cbbbb9a329ff1483273ff8d46fc2c75cc1c6e4b502
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'active_support/concern'
|
4
|
+
|
5
|
+
module SurrogateKeyLogging
|
6
|
+
module ActionController
|
7
|
+
module Params
|
8
|
+
extend ActiveSupport::Concern
|
9
|
+
|
10
|
+
class_methods do
|
11
|
+
def surrogate_params(*params, action: '*')
|
12
|
+
@surrogate_params ||= ActiveSupport::HashWithIndifferentAccess.new {|h,k| h[k] = [] }
|
13
|
+
params.each do |param|
|
14
|
+
param = param.to_s
|
15
|
+
@surrogate_params[action] << param
|
16
|
+
if param.include?('.')
|
17
|
+
dots = param.split('.')
|
18
|
+
@surrogate_params[action] << [dots.first, dots[1..-1].map{|p| "[#{p}]"}].compact.join('')
|
19
|
+
@surrogate_params[action] << URI.encode_www_form_component(@surrogate_params[action].last)
|
20
|
+
@surrogate_params[action] << dots.map{|p| "[#{p}]"}.join('')
|
21
|
+
@surrogate_params[action] << URI.encode_www_form_component(@surrogate_params[action].last)
|
22
|
+
elsif param.include?('[') && param.include?(']')
|
23
|
+
@surrogate_params[action] << URI.encode_www_form_component(param)
|
24
|
+
else
|
25
|
+
@surrogate_params[action] << param
|
26
|
+
end
|
27
|
+
end
|
28
|
+
@surrogate_params
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SurrogateKeyLogging
|
4
|
+
module ActionDispatch
|
5
|
+
class ParamsFilter
|
6
|
+
|
7
|
+
class << self
|
8
|
+
def call(params, req = nil)
|
9
|
+
new(params, req).filtered
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
attr_reader :params, :req
|
14
|
+
|
15
|
+
def initialize(params, req = nil)
|
16
|
+
@params = params
|
17
|
+
@req = req
|
18
|
+
end
|
19
|
+
|
20
|
+
def filterable_params
|
21
|
+
@filterable_params ||= if req.controller_class.respond_to?(:surrogate_params)
|
22
|
+
surrogate_params = req.controller_class.surrogate_params
|
23
|
+
surrogate_params[params[:action]] + surrogate_params['*']
|
24
|
+
else
|
25
|
+
[]
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
def params_filter
|
30
|
+
return @params_filter if @params_filter
|
31
|
+
attrs = SurrogateKeyLogging.parameter_filter.instance_variable_get(:@filters).dup
|
32
|
+
attrs += filterable_params
|
33
|
+
@params_filter = SurrogateKeyLogging.filter_for_attributes(attrs)
|
34
|
+
end
|
35
|
+
|
36
|
+
def filtered
|
37
|
+
@filtered ||= params_filter.filter params
|
38
|
+
end
|
39
|
+
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
@@ -0,0 +1,56 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SurrogateKeyLogging
|
4
|
+
module ActionDispatch
|
5
|
+
class QueryStringFilter
|
6
|
+
|
7
|
+
class << self
|
8
|
+
def call(qs, req = nil)
|
9
|
+
new(qs, req).filtered
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
attr_reader :qs, :req
|
14
|
+
|
15
|
+
def initialize(qs, req = nil)
|
16
|
+
@qs = qs
|
17
|
+
@req = req
|
18
|
+
end
|
19
|
+
|
20
|
+
def path_params
|
21
|
+
@path_params ||= begin
|
22
|
+
req.routes.recognize_path_with_request(req, req.path, {})
|
23
|
+
rescue
|
24
|
+
{}
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
def controller_class
|
29
|
+
@controller_class = req.controller_class_for(path_params[:controller])
|
30
|
+
end
|
31
|
+
|
32
|
+
def filterable_params
|
33
|
+
@filterable_params ||= if controller_class.respond_to?(:surrogate_params)
|
34
|
+
surrogate_params = controller_class.surrogate_params
|
35
|
+
surrogate_params[path_params[:action]] + surrogate_params['*']
|
36
|
+
else
|
37
|
+
[]
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
def params_filter
|
42
|
+
return @params_filter if @params_filter
|
43
|
+
attrs = SurrogateKeyLogging.parameter_filter.instance_variable_get(:@filters).dup
|
44
|
+
attrs += filterable_params
|
45
|
+
@params_filter = SurrogateKeyLogging.filter_for_attributes(attrs)
|
46
|
+
end
|
47
|
+
|
48
|
+
def filtered
|
49
|
+
@filtered ||= qs.gsub(::ActionDispatch::Request::PAIR_RE) do |_|
|
50
|
+
params_filter.filter(::Regexp.last_match(1) => ::Regexp.last_match(2)).first.join('=')
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
@@ -4,10 +4,12 @@ module SurrogateKeyLogging
|
|
4
4
|
module ActionDispatch
|
5
5
|
module Request
|
6
6
|
|
7
|
+
def filtered_parameters
|
8
|
+
@filtered_parameters ||= ParamsFilter.call(super, self)
|
9
|
+
end
|
10
|
+
|
7
11
|
def filtered_query_string
|
8
|
-
|
9
|
-
SurrogateKeyLogging.filter_parameters(::Regexp.last_match(1) => ::Regexp.last_match(2)).first.join('=')
|
10
|
-
end
|
12
|
+
QueryStringFilter.call(super, self)
|
11
13
|
end
|
12
14
|
|
13
15
|
end
|
@@ -7,13 +7,9 @@ module SurrogateKeyLogging
|
|
7
7
|
module Attributes
|
8
8
|
extend ActiveSupport::Concern
|
9
9
|
|
10
|
-
included do
|
11
|
-
surrogate_parent_names model_name.singular, model_name.plural
|
12
|
-
end
|
13
|
-
|
14
10
|
class_methods do
|
15
11
|
def surrogate_parent_names(*names)
|
16
|
-
@surrogate_parent_names ||= []
|
12
|
+
@surrogate_parent_names ||= [model_name.singular, model_name.plural]
|
17
13
|
names.each do |name|
|
18
14
|
@surrogate_parent_names << name.to_sym
|
19
15
|
surrogate_attributes.each do |attr|
|
@@ -17,10 +17,11 @@ module SurrogateKeyLogging
|
|
17
17
|
sql = payload[:sql]
|
18
18
|
binds = nil
|
19
19
|
|
20
|
-
name_match = /([A-Za-z]+) (Load|Update|Cache)/.match(payload[:name])
|
20
|
+
name_match = /([A-Za-z:]+) (Load|Create|Update|Cache)/.match(payload[:name])
|
21
21
|
model = if name_match && name_match[1] && ::ActiveRecord::Base.descendants.map(&:to_s).include?(name_match[1])
|
22
22
|
name_match[1].safe_constantize
|
23
23
|
end
|
24
|
+
return if !SurrogateKeyLogging.config.debug && SurrogateKeyLogging.key_store.is_a?(SurrogateKeyLogging::KeyStore::ActiveRecord) && SurrogateKeyLogging.key_store.model == model
|
24
25
|
|
25
26
|
if payload[:binds]&.any?
|
26
27
|
casted_params = type_casted_binds(payload[:type_casted_binds])
|
@@ -4,7 +4,7 @@ require 'active_support/parameter_filter'
|
|
4
4
|
|
5
5
|
# Add ability for @mask to be a class/instance/lambda/proc
|
6
6
|
module ActiveSupport
|
7
|
-
|
7
|
+
class ParameterFilter
|
8
8
|
class CompiledFilter
|
9
9
|
|
10
10
|
def value_for_key(key, value, parents = [], original_params = nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SurrogateKeyLogging
|
4
|
+
class Config < ActiveSupport::OrderedOptions
|
5
|
+
end
|
6
|
+
|
7
|
+
module Configuration
|
8
|
+
extend ActiveSupport::Concern
|
9
|
+
|
10
|
+
def surrogate_key_logging
|
11
|
+
SurrogateKeyLogging.config
|
12
|
+
end
|
13
|
+
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'rails'
|
4
|
+
require 'securerandom'
|
5
|
+
|
6
|
+
module SurrogateKeyLogging
|
7
|
+
class Engine < ::Rails::Engine
|
8
|
+
isolate_namespace SurrogateKeyLogging
|
9
|
+
|
10
|
+
config.autoload_paths << root.join('lib')
|
11
|
+
|
12
|
+
config.generators do |g|
|
13
|
+
g.test_framework :rspec
|
14
|
+
g.fixture_replacement :factory_bot, dir: 'spec/factories'
|
15
|
+
g.assets false
|
16
|
+
g.helper false
|
17
|
+
g.templates.unshift File.expand_path('lib/templates', root)
|
18
|
+
end
|
19
|
+
|
20
|
+
rake_tasks do
|
21
|
+
load 'tasks/surrogate_key_logging.rake'
|
22
|
+
load 'tasks/key_store/active_record.rake'
|
23
|
+
end
|
24
|
+
|
25
|
+
initializer 'surrogate_key_logging.config' do |app|
|
26
|
+
SurrogateKeyLogging.configure do |config|
|
27
|
+
config.enabled = Rails.env.production? unless config.key?(:enabled)
|
28
|
+
config.debug = !Rails.env.production? unless config.key?(:debug)
|
29
|
+
config.key_prefix = '' unless config.key?(:key_prefix)
|
30
|
+
config.key_for ||= -> (value) { "#{config.key_prefix}#{SecureRandom.uuid}" }
|
31
|
+
config.cache = true unless config.key?(:cache)
|
32
|
+
config.cache_key_for ||= -> (value) { value }
|
33
|
+
config.key_ttl ||= 90.days
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
initializer 'surrogate_key_logging.filter_parameters' do
|
38
|
+
if SurrogateKeyLogging.config.enabled
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
initializer 'surrogate_key_logging.logs' do
|
43
|
+
if SurrogateKeyLogging.config.enabled
|
44
|
+
::ActiveRecord::LogSubscriber.detach_from(:active_record)
|
45
|
+
::SurrogateKeyLogging::ActiveRecord::LogSubscriber.attach_to(:active_record)
|
46
|
+
::ActiveSupport::LogSubscriber.detach_from(:action_controller)
|
47
|
+
::SurrogateKeyLogging::ActionController::LogSubscriber.attach_to(:action_controller)
|
48
|
+
::ActionDispatch::Request.include SurrogateKeyLogging::ActionDispatch::Request
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
end
|
53
|
+
end
|
@@ -3,9 +3,40 @@
|
|
3
3
|
module SurrogateKeyLogging
|
4
4
|
class KeyManager
|
5
5
|
|
6
|
-
|
7
|
-
|
8
|
-
|
6
|
+
attr_reader :should_cache, :cache_key_for, :cache, :key_for
|
7
|
+
|
8
|
+
delegate :key_store, to: SurrogateKeyLogging
|
9
|
+
|
10
|
+
def initialize
|
11
|
+
@should_cache = SurrogateKeyLogging.config.cache
|
12
|
+
@cache_key_for = SurrogateKeyLogging.config.cache_key_for
|
13
|
+
@cache = {}
|
14
|
+
@key_for = SurrogateKeyLogging.config.key_for
|
15
|
+
end
|
16
|
+
|
17
|
+
def get(value)
|
18
|
+
if should_cache
|
19
|
+
get_cached(value)
|
20
|
+
else
|
21
|
+
get_non_cached(value)
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
def get_cached(value)
|
26
|
+
@cache[cache_key_for.call(value)] ||= get_non_cached(value)
|
27
|
+
end
|
28
|
+
|
29
|
+
def get_non_cached(value)
|
30
|
+
stored = key_store.surrogate_for_value(value)
|
31
|
+
return stored if stored.present?
|
32
|
+
surrogate = key_for.call(value)
|
33
|
+
key_store.save(surrogate, value)
|
34
|
+
surrogate
|
35
|
+
end
|
36
|
+
|
37
|
+
def call(_key, value, _parents = [], _original_params = nil)
|
38
|
+
surrogate = get(value)
|
39
|
+
# Rails.logger.tagged('SurrogateKeyLogging') { Rails.logger.info "Surrogate: `#{surrogate}`, value: `#{value}`" } if SurrogateKeyLogging.config.debug
|
9
40
|
surrogate
|
10
41
|
end
|
11
42
|
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SurrogateKeyLogging
|
4
|
+
module KeyStore
|
5
|
+
|
6
|
+
class ActiveRecord < Base
|
7
|
+
|
8
|
+
attr_reader :model
|
9
|
+
|
10
|
+
def initialize
|
11
|
+
if SurrogateKeyLogging.config.key?(:model) && SurrogateKeyLogging.config.model.present?
|
12
|
+
raise 'SurrogateKeyLogging::KeyStore::ActiveRecord config.model must descend from ActiveRecord::Base' unless SurrogateKeyLogging.config <= ::ActiveRecord::Base
|
13
|
+
@model = SurrogateKeyLogging.config.model
|
14
|
+
else
|
15
|
+
@model = SurrogateKeyLogging::Surrogate
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
def surrogate_for_value(value)
|
20
|
+
key = model.surrogate_for_value(value)
|
21
|
+
use(key)
|
22
|
+
key
|
23
|
+
end
|
24
|
+
|
25
|
+
def value_for_surrogate(surrogate)
|
26
|
+
model.value_for_surrogate(surrogate)
|
27
|
+
end
|
28
|
+
|
29
|
+
def save(surrogate, value)
|
30
|
+
model.add(surrogate, value)
|
31
|
+
end
|
32
|
+
|
33
|
+
def use(surrogate)
|
34
|
+
model.use(surrogate)
|
35
|
+
end
|
36
|
+
|
37
|
+
end
|
38
|
+
|
39
|
+
add(:active_record, ActiveRecord)
|
40
|
+
|
41
|
+
end
|
42
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SurrogateKeyLogging
|
4
|
+
module KeyStore
|
5
|
+
class Base
|
6
|
+
|
7
|
+
def surrogate_for_value(value)
|
8
|
+
raise NotImplementedError
|
9
|
+
end
|
10
|
+
|
11
|
+
def value_for_surrogate(surrogate)
|
12
|
+
raise NotImplementedError
|
13
|
+
end
|
14
|
+
|
15
|
+
def save(surrogate, value)
|
16
|
+
raise NotImplementedError
|
17
|
+
end
|
18
|
+
|
19
|
+
def use(surrogate)
|
20
|
+
raise NotImplementedError
|
21
|
+
end
|
22
|
+
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SurrogateKeyLogging
|
4
|
+
module KeyStore
|
5
|
+
extend ActiveSupport::Autoload
|
6
|
+
|
7
|
+
eager_autoload do
|
8
|
+
autoload :Base
|
9
|
+
autoload :ActiveRecord
|
10
|
+
end
|
11
|
+
|
12
|
+
@map = {}.with_indifferent_access
|
13
|
+
|
14
|
+
class << self
|
15
|
+
attr_reader :map
|
16
|
+
|
17
|
+
def get(key_store)
|
18
|
+
map[key_store] || raise("SurrogateKeyLogging unknown key_store: `#{key_store}`")
|
19
|
+
end
|
20
|
+
|
21
|
+
def add(name, klass)
|
22
|
+
map[name] = klass
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
26
|
+
|
27
|
+
end
|
28
|
+
end
|
@@ -6,17 +6,28 @@ require 'active_support'
|
|
6
6
|
module SurrogateKeyLogging
|
7
7
|
extend ActiveSupport::Autoload
|
8
8
|
|
9
|
-
autoload :Railtie
|
10
|
-
autoload :Version
|
11
9
|
autoload :ActionController
|
12
10
|
autoload :ActionDispatch
|
13
11
|
autoload :ActiveSupport
|
14
12
|
autoload :ActiveRecord
|
13
|
+
autoload :Config, 'surrogate_key_logging/configuration'
|
14
|
+
autoload :Configuration
|
15
15
|
autoload :KeyManager
|
16
|
+
autoload :KeyStore
|
16
17
|
autoload :Middleware
|
18
|
+
autoload :Engine
|
19
|
+
autoload :Version
|
20
|
+
|
21
|
+
@config = Config.new
|
17
22
|
|
18
23
|
class << self
|
19
24
|
|
25
|
+
attr_reader :config
|
26
|
+
|
27
|
+
def configure
|
28
|
+
yield config
|
29
|
+
end
|
30
|
+
|
20
31
|
def surrogate_attributes(*attrs)
|
21
32
|
@surrogate_attributes ||= []
|
22
33
|
attrs.each do |attr|
|
@@ -26,6 +37,10 @@ module SurrogateKeyLogging
|
|
26
37
|
end
|
27
38
|
|
28
39
|
def reset
|
40
|
+
reset! if config.cache
|
41
|
+
end
|
42
|
+
|
43
|
+
def reset!
|
29
44
|
@key_manager = @parameter_filter = nil
|
30
45
|
end
|
31
46
|
|
@@ -34,27 +49,37 @@ module SurrogateKeyLogging
|
|
34
49
|
end
|
35
50
|
|
36
51
|
def parameter_filter
|
37
|
-
@parameter_filter ||=
|
52
|
+
@parameter_filter ||= filter_for_attributes(surrogate_attributes)
|
53
|
+
end
|
54
|
+
|
55
|
+
def filter_for_attributes(attrs)
|
56
|
+
::ActiveSupport::ParameterFilter.new(attrs, mask: key_manager)
|
57
|
+
end
|
58
|
+
|
59
|
+
def key_store
|
60
|
+
@key_store ||= KeyStore.get(config.key_store).new
|
38
61
|
end
|
39
62
|
|
40
63
|
def filter_parameters(params)
|
41
64
|
parameter_filter.filter params
|
42
65
|
end
|
43
66
|
|
44
|
-
def add_param_to_filter(attr,
|
45
|
-
if
|
67
|
+
def add_param_to_filter(attr, *parents)
|
68
|
+
if parents.empty?
|
46
69
|
surrogate_attributes attr.to_s
|
47
70
|
else
|
48
71
|
surrogate_attributes(
|
49
|
-
"#{
|
50
|
-
"#{
|
51
|
-
"[#{
|
72
|
+
"#{parents.join('.')}.#{attr}",
|
73
|
+
"#{parents.first}#{parents[1..-1].map{|x|"[#{x}]"}.join('')}[#{attr}]",
|
74
|
+
"#{parents.map{|x|"[#{x}]"}.join('')}[#{attr}]"
|
52
75
|
)
|
53
76
|
end
|
54
77
|
end
|
55
78
|
|
56
79
|
end
|
57
80
|
|
58
|
-
|
81
|
+
KeyStore.eager_load!
|
82
|
+
::Rails::Application::Configuration.send(:include, Configuration)
|
83
|
+
require 'surrogate_key_logging/engine'
|
59
84
|
|
60
|
-
|
85
|
+
end
|
@@ -0,0 +1,119 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
namespace :skl do
|
4
|
+
namespace :key_store do
|
5
|
+
namespace :active_record do |ar_ns|
|
6
|
+
|
7
|
+
task clear: :environment do
|
8
|
+
ActiveRecord::Base.connection.truncate(SurrogateKeyLogging.key_store.model.table_name)
|
9
|
+
end
|
10
|
+
|
11
|
+
namespace :clear do
|
12
|
+
task stale: :environment do
|
13
|
+
if SurrogateKeyLogging.config.key_ttl > 0
|
14
|
+
SurrogateKeyLogging.key_store.model.where('updated_at < ?', Time.now - SurrogateKeyLogging.config.key_ttl).destroy_all
|
15
|
+
else
|
16
|
+
puts "SurrogateKeyLogging config.key_ttl is set to 0, which makes keys never go stale."
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
namespace :db do |db_ns|
|
22
|
+
%i[drop create setup migrate rollback seed version].each do |task_name|
|
23
|
+
task task_name => :environment do
|
24
|
+
Rake::Task["db:#{task_name}"].invoke
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
namespace :migrate do
|
29
|
+
%i[up down redo].each do |task_name|
|
30
|
+
task task_name => :environment do
|
31
|
+
Rake::Task["db:migrate:#{task_name}"].invoke
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
namespace :schema do
|
37
|
+
%i[load dump].each do |task_name|
|
38
|
+
task task_name => :environment do
|
39
|
+
Rake::Task["db:schema:#{task_name}"].invoke
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
namespace :test do
|
45
|
+
task prepare: :environment do
|
46
|
+
Rake::Task['db:test:prepare'].invoke
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
namespace :environment do
|
51
|
+
task set: :environment do
|
52
|
+
Rake::Task['db:environment:set'].invoke
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
namespace :__config__ do
|
57
|
+
task set_surrogate_key_logging_db_config: :environment do
|
58
|
+
# save current vars
|
59
|
+
@original_db_config = {
|
60
|
+
env_schema: ENV['SCHEMA'],
|
61
|
+
config: Rails.application.config.dup,
|
62
|
+
ar_config: ActiveRecord::Base.
|
63
|
+
configurations.
|
64
|
+
configurations.inject({}) do |memo, db_config|
|
65
|
+
memo.merge(db_config.env_name => db_config.configuration_hash.stringify_keys)
|
66
|
+
end,
|
67
|
+
}
|
68
|
+
|
69
|
+
# set config variables for custom database
|
70
|
+
db_dir = SurrogateKeyLogging::Engine.root.join('db')
|
71
|
+
schema_path = Rails.root.join('db', "surrogate_key_logging_schema.#{Rails.application.config.active_record.schema_format}")
|
72
|
+
ENV['SCHEMA'] = schema_path.to_s
|
73
|
+
Rails.application.config.paths['db'] = [db_dir]
|
74
|
+
Rails.application.config.paths['db/migrate'] = [db_dir.join('migrate')]
|
75
|
+
Rails.application.config.paths['db/seeds'] = [db_dir.join('seeds.rb')]
|
76
|
+
Rails.application.config.paths['config/database'] = [SurrogateKeyLogging::Engine.root.join('config', 'database.yml')]
|
77
|
+
ActiveRecord::Base.configurations = ActiveRecord::Base.
|
78
|
+
configurations.
|
79
|
+
configurations.inject({}) do |memo, db_config|
|
80
|
+
next memo unless db_config.env_name.start_with?('surrogate_key_logging_')
|
81
|
+
memo.merge(db_config.env_name.sub(/^surrogate_key_logging_/, '') => db_config.configuration_hash.stringify_keys)
|
82
|
+
end
|
83
|
+
ActiveRecord::Base.establish_connection Rails.application.config.database_configuration[Rails.env]
|
84
|
+
end
|
85
|
+
|
86
|
+
task revert_surrogate_key_logging_db_config: :environment do
|
87
|
+
# reset config variables to original values
|
88
|
+
ENV['SCHEMA'] = @original_db_config[:env_schema]
|
89
|
+
Rails.application.config = @original_db_config[:config]
|
90
|
+
ActiveRecord::Base.configurations = @original_db_config[:ar_config]
|
91
|
+
ActiveRecord::Base.establish_connection Rails.application.config.database_configuration[Rails.env]
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
db_ns.tasks.each do |task|
|
96
|
+
next if task.scope.first == '__config__'
|
97
|
+
task.enhance ['skl:key_store:active_record:db:__config__:set_surrogate_key_logging_db_config'] do
|
98
|
+
Rake::Task['skl:key_store:active_record:db:__config__:revert_surrogate_key_logging_db_config'].invoke
|
99
|
+
Rake::Task['skl:key_store:active_record:db:__config__:set_surrogate_key_logging_db_config'].reenable
|
100
|
+
Rake::Task['skl:key_store:active_record:db:__config__:revert_surrogate_key_logging_db_config'].reenable
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
104
|
+
|
105
|
+
namespace :__config__ do
|
106
|
+
task check_config: :environment do
|
107
|
+
raise "SurrogateKeyLogging config.key_store must be set to :active_record for this task to function, it is currently set to `#{SurrogateKeyLogging.config.key_store.inspect}`" unless SurrogateKeyLogging.config.key_store == :active_record
|
108
|
+
end
|
109
|
+
end
|
110
|
+
|
111
|
+
ar_ns.tasks.each do |task|
|
112
|
+
next if task.scope.first == '__config__'
|
113
|
+
task.prerequisites.prepend('skl:key_store:active_record:__config__:check_config')
|
114
|
+
task.actions.prepend(&Rake::Task['skl:key_store:active_record:__config__:check_config'].method(:reenable))
|
115
|
+
end
|
116
|
+
|
117
|
+
end
|
118
|
+
end
|
119
|
+
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
namespace :skl do
|
4
|
+
task clear: :environment do
|
5
|
+
Rake::Task["skl:key_store:#{SurrogateKeyLogging.config.key_store}:clear"].invoke
|
6
|
+
end
|
7
|
+
|
8
|
+
namespace :clear do
|
9
|
+
task stale: :environment do
|
10
|
+
Rake::Task["skl:key_store:#{SurrogateKeyLogging.config.key_store}:clear:stale"].invoke
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
@@ -27,8 +27,8 @@ Gem::Specification.new do |s|
|
|
27
27
|
|
28
28
|
s.required_ruby_version = '>= 2.7.0'
|
29
29
|
|
30
|
-
s.add_dependency('actionpack', '>= 6.0.0')
|
31
|
-
s.add_dependency('activerecord', '>= 6.0.0')
|
32
|
-
s.add_dependency('activesupport', '>= 6.0.0')
|
33
|
-
s.add_dependency('railties', '>= 6.0.0')
|
30
|
+
s.add_dependency('actionpack', '>= 6.0.0', '< 7.0.0')
|
31
|
+
s.add_dependency('activerecord', '>= 6.0.0', '< 7.0.0')
|
32
|
+
s.add_dependency('activesupport', '>= 6.0.0', '< 7.0.0')
|
33
|
+
s.add_dependency('railties', '>= 6.0.0', '< 7.0.0')
|
34
34
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rails_surrogate_key_logging
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0
|
4
|
+
version: 0.2.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Taylor Yelverton
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-01-
|
11
|
+
date: 2023-01-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: actionpack
|
@@ -17,6 +17,9 @@ dependencies:
|
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
19
|
version: 6.0.0
|
20
|
+
- - "<"
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 7.0.0
|
20
23
|
type: :runtime
|
21
24
|
prerelease: false
|
22
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -24,6 +27,9 @@ dependencies:
|
|
24
27
|
- - ">="
|
25
28
|
- !ruby/object:Gem::Version
|
26
29
|
version: 6.0.0
|
30
|
+
- - "<"
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 7.0.0
|
27
33
|
- !ruby/object:Gem::Dependency
|
28
34
|
name: activerecord
|
29
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -31,6 +37,9 @@ dependencies:
|
|
31
37
|
- - ">="
|
32
38
|
- !ruby/object:Gem::Version
|
33
39
|
version: 6.0.0
|
40
|
+
- - "<"
|
41
|
+
- !ruby/object:Gem::Version
|
42
|
+
version: 7.0.0
|
34
43
|
type: :runtime
|
35
44
|
prerelease: false
|
36
45
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -38,6 +47,9 @@ dependencies:
|
|
38
47
|
- - ">="
|
39
48
|
- !ruby/object:Gem::Version
|
40
49
|
version: 6.0.0
|
50
|
+
- - "<"
|
51
|
+
- !ruby/object:Gem::Version
|
52
|
+
version: 7.0.0
|
41
53
|
- !ruby/object:Gem::Dependency
|
42
54
|
name: activesupport
|
43
55
|
requirement: !ruby/object:Gem::Requirement
|
@@ -45,6 +57,9 @@ dependencies:
|
|
45
57
|
- - ">="
|
46
58
|
- !ruby/object:Gem::Version
|
47
59
|
version: 6.0.0
|
60
|
+
- - "<"
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: 7.0.0
|
48
63
|
type: :runtime
|
49
64
|
prerelease: false
|
50
65
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -52,6 +67,9 @@ dependencies:
|
|
52
67
|
- - ">="
|
53
68
|
- !ruby/object:Gem::Version
|
54
69
|
version: 6.0.0
|
70
|
+
- - "<"
|
71
|
+
- !ruby/object:Gem::Version
|
72
|
+
version: 7.0.0
|
55
73
|
- !ruby/object:Gem::Dependency
|
56
74
|
name: railties
|
57
75
|
requirement: !ruby/object:Gem::Requirement
|
@@ -59,6 +77,9 @@ dependencies:
|
|
59
77
|
- - ">="
|
60
78
|
- !ruby/object:Gem::Version
|
61
79
|
version: 6.0.0
|
80
|
+
- - "<"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: 7.0.0
|
62
83
|
type: :runtime
|
63
84
|
prerelease: false
|
64
85
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -66,6 +87,9 @@ dependencies:
|
|
66
87
|
- - ">="
|
67
88
|
- !ruby/object:Gem::Version
|
68
89
|
version: 6.0.0
|
90
|
+
- - "<"
|
91
|
+
- !ruby/object:Gem::Version
|
92
|
+
version: 7.0.0
|
69
93
|
description: ''
|
70
94
|
email: rubygems@yelvert.io
|
71
95
|
executables: []
|
@@ -77,16 +101,24 @@ files:
|
|
77
101
|
- lib/surrogate_key_logging.rb
|
78
102
|
- lib/surrogate_key_logging/action_controller.rb
|
79
103
|
- lib/surrogate_key_logging/action_controller/log_subscriber.rb
|
104
|
+
- lib/surrogate_key_logging/action_controller/params.rb
|
80
105
|
- lib/surrogate_key_logging/action_dispatch.rb
|
106
|
+
- lib/surrogate_key_logging/action_dispatch/params_filter.rb
|
107
|
+
- lib/surrogate_key_logging/action_dispatch/query_string_filter.rb
|
81
108
|
- lib/surrogate_key_logging/action_dispatch/request.rb
|
82
109
|
- lib/surrogate_key_logging/active_record.rb
|
83
110
|
- lib/surrogate_key_logging/active_record/attributes.rb
|
84
111
|
- lib/surrogate_key_logging/active_record/log_subscriber.rb
|
85
112
|
- lib/surrogate_key_logging/active_support.rb
|
113
|
+
- lib/surrogate_key_logging/configuration.rb
|
114
|
+
- lib/surrogate_key_logging/engine.rb
|
86
115
|
- lib/surrogate_key_logging/key_manager.rb
|
87
|
-
- lib/surrogate_key_logging/
|
88
|
-
- lib/surrogate_key_logging/
|
116
|
+
- lib/surrogate_key_logging/key_store.rb
|
117
|
+
- lib/surrogate_key_logging/key_store/active_record.rb
|
118
|
+
- lib/surrogate_key_logging/key_store/base.rb
|
89
119
|
- lib/surrogate_key_logging/version.rb
|
120
|
+
- lib/tasks/key_store/active_record.rake
|
121
|
+
- lib/tasks/surrogate_key_logging.rake
|
90
122
|
- rails_surrogate_key_logging.gemspec
|
91
123
|
homepage: https://github.com/ComplyMD/rails_surrogate_key_logging
|
92
124
|
licenses:
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
module SurrogateKeyLogging
|
4
|
-
class Middleware
|
5
|
-
attr_reader :app
|
6
|
-
|
7
|
-
def initialize(app)
|
8
|
-
@app = app
|
9
|
-
puts 'surrogate new'
|
10
|
-
end
|
11
|
-
|
12
|
-
def call(env)
|
13
|
-
SurrogateKeyLogging.reset
|
14
|
-
@app.call(env)
|
15
|
-
end
|
16
|
-
|
17
|
-
end
|
18
|
-
end
|
@@ -1,28 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require 'rails'
|
4
|
-
|
5
|
-
module SurrogateKeyLogging
|
6
|
-
class Railtie < Rails::Railtie
|
7
|
-
railtie_name :surrogate_key_logging
|
8
|
-
|
9
|
-
initializer 'surrogate_key_logging.filter_parameters' do
|
10
|
-
puts 'surrogate_key_logging.filter_parameters'
|
11
|
-
end
|
12
|
-
|
13
|
-
initializer 'surrogate_key_logging.logs' do
|
14
|
-
puts 'surrogate_key_logging.logs'
|
15
|
-
::ActiveRecord::LogSubscriber.detach_from(:active_record)
|
16
|
-
::SurrogateKeyLogging::ActiveRecord::LogSubscriber.attach_to(:active_record)
|
17
|
-
::ActiveSupport::LogSubscriber.detach_from(:action_controller)
|
18
|
-
::SurrogateKeyLogging::ActionController::LogSubscriber.attach_to(:action_controller)
|
19
|
-
::ActionDispatch::Request.include SurrogateKeyLogging::ActionDispatch::Request
|
20
|
-
end
|
21
|
-
|
22
|
-
initializer 'surrogate_key_logging.middleware' do
|
23
|
-
puts 'surrogate_key_logging.middleware'
|
24
|
-
Rails.application.config.middleware.insert_before 0, Middleware
|
25
|
-
end
|
26
|
-
|
27
|
-
end
|
28
|
-
end
|