Module: PgRls

Extended by:
Forwardable
Defined in:
lib/pg_rls/middleware/sidekiq/client.rb,
lib/pg_rls/logger.rb,
lib/pg_rls/tenant.rb,
lib/pg_rls/railtie.rb,
lib/pg_rls/version.rb,
lib/generators/pg_rls.rb,
lib/pg_rls/middleware.rb,
lib/pg_rls/multi_tenancy.rb,
lib/pg_rls/schema/dumper.rb,
lib/generators/pg_rls/base.rb,
lib/pg_rls/current/context.rb,
lib/pg_rls/database/prepared.rb,
lib/pg_rls/schema/statements.rb,
lib/pg_rls/middleware/sidekiq.rb,
lib/pg_rls/schema/up_statements.rb,
lib/pg_rls/errors/rake_only_error.rb,
lib/pg_rls/schema/down_statements.rb,
lib/pg_rls/errors/tenant_not_found.rb,
lib/pg_rls/database/admin_statements.rb,
lib/pg_rls/middleware/sidekiq/server.rb,
lib/generators/pg_rls/pg_rls_generator.rb,
lib/generators/pg_rls/install_generator.rb,
lib/pg_rls/middleware/set_reset_connection.rb,
lib/pg_rls/middleware/set_reset_connection.rb,
lib/generators/pg_rls/active_record/active_record_generator.rb,
lib/pg_rls.rb

Overview

PostgreSQL Row Level Security

Defined Under Namespace

Modules: Admin, Base, Current, Database, Errors, Generators, Middleware, MultiTenancy, Schema, Tenant Classes: Error, FrozenConfiguration, Logger, Railtie

Constant Summary collapse

VERSION = 
'0.2.2'
WRITER_METHODS = 
%i[table_name class_name search_methods logger excluded_shards].freeze
READER_METHODS = 
%i[connection_class execute table_name class_name search_methods logger excluded_shards].freeze
DELEGATORS_METHODS = 
%i[connection_class execute table_name search_methods class_name main_model logger
excluded_shards].freeze
@@table_name = 
'companies'
@@class_name = 
'Company'
@@username = 
'app_user'
@@password = 
'password'
@@test_inline_tenant = 
false
@@search_methods = 
%i[subdomain id tenant_id]
@@logger = 
PgRls::Logger.new
@@excluded_shards = 
[]

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.admin_connection? ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/pg_rls.rb', line 120

def admin_connection?
  current_db_username != username
end

.admin_execute(query = nil) ⇒ Object 



53
54
55
56
57
58
 
# File 'lib/pg_rls.rb', line 53

def admin_execute(query = nil, &)
  current_tenant, reset_rls_connection = establish_admin_connection
  execute_query_or_block(query, &)
ensure
  reset_connection_if_needed(current_tenant, reset_rls_connection)
end

.as_db_admin? ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/pg_rls.rb', line 116

def as_db_admin?
  @as_db_admin || false
end

.connection_class ⇒ Object 



49
50
51
 
# File 'lib/pg_rls.rb', line 49

def connection_class
  @connection_class ||= ActiveRecord::Base
end

.current_db_username ⇒ Object 



112
113
114
 
# File 'lib/pg_rls.rb', line 112

def current_db_username
  ActiveRecord::Base.connection_db_config.configuration_hash[:username]
end

.establish_new_connection!(admin: false) ⇒ Object 



60
61
62
63
64
65
66
67
68
 
# File 'lib/pg_rls.rb', line 60

def establish_new_connection!(admin: false)
  self.as_db_admin = admin

  execute_rls_in_shards do |connection_class, pool|
    connection_class.connection_pool.disconnect!
    connection_class.remove_connection
    connection_class.establish_connection(pool.db_config)
  end
end

.execute_rls_in_shards ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/pg_rls.rb', line 94

def execute_rls_in_shards
  connection_pool_list = PgRls.connection_class.connection_handler.connection_pool_list
  result = []

  connection_pool_list.each do |pool|
    connection = pool_connection(pool)
    next if excluded_shards.include?(connection.connection_class.connection_db_config.name)

    connection.transaction do
      Rails.logger.info("Executing in #{connection.connection_class}")

      result << yield(connection.connection_class, pool)
    end
  end

  result
end

.main_model ⇒ Object 



70
71
72
 
# File 'lib/pg_rls.rb', line 70

def main_model
  class_name.to_s.camelize.constantize
end

.on_each_tenant(ids: [], scope: nil) ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/pg_rls.rb', line 74

def on_each_tenant(ids: [], scope: nil, &)
  logger.deprecation_warning(
    'PgRls.on_each_tenant is deprecated and will be removed in future versions. ' \
    'Please use PgRls::Tenant.on_find_each instead.'
  )
  Tenant.on_find_each(ids:, scope:, &)
end

.session_key_prefix ⇒ Object 



30
31
32
 
# File 'lib/pg_rls/middleware/set_reset_connection.rb', line 30

def self.session_key_prefix
  @session_key_prefix ||= @session_key_prefix || @session_store_server[:key_prefix]
end

.session_key_prefix=(val) ⇒ Object

Raises:

  • (Errors::FrozenConfiguration) 


34
35
36
37
38
 
# File 'lib/pg_rls/middleware/set_reset_connection.rb', line 34

def self.session_key_prefix=(val)
  raise Errors::FrozenConfiguration unless @sessions.nil?

  @session_key_prefix = val
end

.session_prefix ⇒ Object 



10
11
12
13
14
15
16
 
# File 'lib/pg_rls/middleware/set_reset_connection.rb', line 10

def self.session_prefix
  @session_prefix ||= begin
    store_default_warden_key = @session_store_default_warden_key || '2'

    "#{session_key_prefix}:#{store_default_warden_key}::"
  end
end

.session_store_default_warden_key=(val) ⇒ Object

Raises:

  • (Errors::FrozenConfiguration) 


24
25
26
27
28
 
# File 'lib/pg_rls/middleware/set_reset_connection.rb', line 24

def self.session_store_default_warden_key=(val)
  raise Errors::FrozenConfiguration unless @sessions.nil?

  @session_store_default_warden_key = val
end

.session_store_server=(opts = {}) ⇒ Object

Raises:

  • (Errors::FrozenConfiguration) 


18
19
20
21
22
 
# File 'lib/pg_rls/middleware/set_reset_connection.rb', line 18

def self.session_store_server=(opts = {})
  raise Errors::FrozenConfiguration unless @sessions.nil?

  @session_store_server = opts.deep_symbolize_keys
end

.sessions ⇒ Object 



6
7
8
 
# File 'lib/pg_rls/middleware/set_reset_connection.rb', line 6

def self.sessions
  @sessions ||= Redis.new(@session_store_server)
end

.setup {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:

  • _self (PgRls) —

    the object that the method was called on



39
40
41
42
43
44
45
46
47
 
# File 'lib/pg_rls.rb', line 39

def setup
  ActiveRecord::Base.ignored_columns += %w[tenant_id]

  yield self

  Rails.application.config.to_prepare do
    PgRls.main_model.ignored_columns = [] # rubocop:disable Rails/IgnoredColumnsAssignment
  end
end

Instance Method Details

#pool_connection(pool) ⇒ Object 



84
85
86
 
# File 'lib/pg_rls.rb', line 84

def pool_connection(pool)
  pool.lease_connection
end