Class: RailsMultisite::ConnectionManagement

Inherits:
Object
  • Object
show all
Defined in:
lib/rails_multisite/connection_management.rb,
lib/rails_multisite/connection_management/rails_60_compat.rb,
lib/rails_multisite/connection_management/rails_61_compat.rb

Defined Under Namespace

Classes: ConnectionSpecification

Constant Summary collapse

DEFAULT = 
'default'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config_filename) ⇒ ConnectionManagement

Returns a new instance of ConnectionManagement.



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/rails_multisite/connection_management.rb', line 160

def initialize(config_filename)
  @config_filename = config_filename

  @connection_handlers = begin
    if ActiveRecord::Base.respond_to?(:connection_handlers)
      ActiveRecord::Base.connection_handlers
    else
      {}
    end
  end

  @db_spec_cache = {}
  @default_spec = ConnectionSpecification.default
  @default_connection_handler = ActiveRecord::Base.connection_handler

  @reload_mutex = Mutex.new

  load_config!
end

Instance Attribute Details

#config_filename ⇒ Object (readonly)

Returns the value of attribute config_filename.



157
158
159
 
# File 'lib/rails_multisite/connection_management.rb', line 157

def config_filename
  @config_filename
end

#connection_handlers ⇒ Object (readonly)

Returns the value of attribute connection_handlers.



157
158
159
 
# File 'lib/rails_multisite/connection_management.rb', line 157

def connection_handlers
  @connection_handlers
end

#db_spec_cache ⇒ Object (readonly)

Returns the value of attribute db_spec_cache.



157
158
159
 
# File 'lib/rails_multisite/connection_management.rb', line 157

def db_spec_cache
  @db_spec_cache
end

#default_connection_handler=(value) ⇒ Object (writeonly)

Sets the attribute default_connection_handler

Parameters:

  • value —

    the value to set the attribute default_connection_handler to.



158
159
160
 
# File 'lib/rails_multisite/connection_management.rb', line 158

def default_connection_handler=(value)
  @default_connection_handler = value
end

Class Method Details

.all_dbs ⇒ Object 



94
95
96
97
98
99
100
 
# File 'lib/rails_multisite/connection_management.rb', line 94

def self.all_dbs
  if @instance
    @instance.all_dbs
  else
    [DEFAULT]
  end
end

.asset_hostnames ⇒ Object 



42
43
44
 
# File 'lib/rails_multisite/connection_management.rb', line 42

def self.asset_hostnames
  @asset_hostnames
end

.asset_hostnames=(h) ⇒ Object 



46
47
48
 
# File 'lib/rails_multisite/connection_management.rb', line 46

def self.asset_hostnames=(h)
  @asset_hostnames = h
end

.clear_settings! ⇒ Object 



17
18
19
20
21
22
23
 
# File 'lib/rails_multisite/connection_management.rb', line 17

def self.clear_settings!
  @instance&.db_spec_cache&.each do |key, spec|
    @instance.connection_handlers.delete(self.handler_key(spec))
  end

  @instance = nil
end

.config_filename ⇒ Object 



50
51
52
 
# File 'lib/rails_multisite/connection_management.rb', line 50

def self.config_filename
  @instance.config_filename
end

.config_filename=(config_filename) ⇒ Object 



34
35
36
37
38
39
40
 
# File 'lib/rails_multisite/connection_management.rb', line 34

def self.config_filename=(config_filename)
  if config_filename.nil?
    @instance = nil
  else
    @instance = new(config_filename)
  end
end

.connection_spec(opts) ⇒ Object 



119
120
121
122
123
124
125
 
# File 'lib/rails_multisite/connection_management.rb', line 119

def self.connection_spec(opts)
  if @instance
    @instance.connection_spec(opts)
  else
    ConnectionSpecification.current
  end
end

.current_db ⇒ Object 



102
103
104
105
106
107
108
 
# File 'lib/rails_multisite/connection_management.rb', line 102

def self.current_db
  if @instance
    instance.current_db
  else
    DEFAULT
  end
end

.current_db_hostnames ⇒ Object 



114
115
116
117
 
# File 'lib/rails_multisite/connection_management.rb', line 114

def self.current_db_hostnames
  config = (@instance&.connection_spec(db: current_db) || ConnectionSpecification.current).config
  config[:host_names].nil? ? [config[:host]] : config[:host_names]
end

.current_hostname ⇒ Object 



110
111
112
 
# File 'lib/rails_multisite/connection_management.rb', line 110

def self.current_hostname
  current_db_hostnames.first
end

.default_config_filename ⇒ Object 



13
14
15
 
# File 'lib/rails_multisite/connection_management.rb', line 13

def self.default_config_filename
  File.absolute_path(Rails.root.to_s + "/config/multisite.yml")
end

.default_connection_handler=(connection_handler) ⇒ Object 



147
148
149
150
151
152
153
154
155
 
# File 'lib/rails_multisite/connection_management.rb', line 147

def self.default_connection_handler=(connection_handler)
  if @instance
    unless connection_handler.is_a?(ActiveRecord::ConnectionAdapters::ConnectionHandler)
      raise ArgumentError.new("Invalid connection handler")
    end

    @instance.default_connection_handler = connection_handler
  end
end

.each_connection(opts = nil, &blk) ⇒ Object 



86
87
88
89
90
91
92
 
# File 'lib/rails_multisite/connection_management.rb', line 86

def self.each_connection(opts = nil, &blk)
  if @instance
    @instance.each_connection(opts, &blk)
  else
    with_connection(&blk)
  end
end

.establish_connection(opts) ⇒ Object 



63
64
65
 
# File 'lib/rails_multisite/connection_management.rb', line 63

def self.establish_connection(opts)
  @instance.establish_connection(opts) if @instance
end

.handler_key(spec) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/rails_multisite/connection_management.rb', line 135

def self.handler_key(spec)
  @handler_key_suffix ||= begin
    if ActiveRecord::Base.respond_to?(:writing_role)
      "_#{ActiveRecord::Base.writing_role}"
    else
      ""
    end
  end

  :"#{spec.name}#{@handler_key_suffix}"
end

.has_db?(db) ⇒ Boolean

Returns:

  • (Boolean) 


58
59
60
61
 
# File 'lib/rails_multisite/connection_management.rb', line 58

def self.has_db?(db)
  return true if db == DEFAULT
  !!(@instance && @instance.has_db?(db))
end

.host(env) ⇒ Object 



127
128
129
130
131
132
133
 
# File 'lib/rails_multisite/connection_management.rb', line 127

def self.host(env)
  if @instance
    @instance.host(env)
  else
    env["HTTP_HOST"]
  end
end

.instance ⇒ Object 



30
31
32
 
# File 'lib/rails_multisite/connection_management.rb', line 30

def self.instance
  @instance
end

.load_settings! ⇒ Object 



25
26
27
28
 
# File 'lib/rails_multisite/connection_management.rb', line 25

def self.load_settings!
  # no op only here backwards compat
  STDERR.puts "RailsMultisite::ConnectionManagement.load_settings! is deprecated"
end

.reload ⇒ Object 



54
55
56
 
# File 'lib/rails_multisite/connection_management.rb', line 54

def self.reload
  @instance.reload
end

.with_connection(db = DEFAULT, &blk) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/rails_multisite/connection_management.rb', line 75

def self.with_connection(db = DEFAULT, &blk)
  if @instance
    @instance.with_connection(db, &blk)
  else
    connected = ActiveRecord::Base.connection_pool.connected?
    result = blk.call db
    ActiveRecord::Base.clear_active_connections! unless connected
    result
  end
end

.with_hostname(hostname, &blk) ⇒ Object 



67
68
69
70
71
72
73
 
# File 'lib/rails_multisite/connection_management.rb', line 67

def self.with_hostname(hostname, &blk)
  if @instance
    @instance.with_hostname(hostname, &blk)
  else
    blk.call hostname
  end
end

Instance Method Details

#all_dbs ⇒ Object 



353
354
355
 
# File 'lib/rails_multisite/connection_management.rb', line 353

def all_dbs
  [DEFAULT] + @db_spec_cache.keys.to_a
end

#connection_spec(opts) ⇒ Object 



383
384
385
386
387
388
389
 
# File 'lib/rails_multisite/connection_management.rb', line 383

def connection_spec(opts)
  if opts[:host]
    @host_spec_cache[opts[:host]]
  else
    @db_spec_cache[opts[:db]]
  end
end

#current_db ⇒ Object 



357
358
359
 
# File 'lib/rails_multisite/connection_management.rb', line 357

def current_db
  ConnectionSpecification.current.config[:db_key] || DEFAULT
end

#current_hostname ⇒ Object 



361
362
363
 
# File 'lib/rails_multisite/connection_management.rb', line 361

def current_hostname
  ConnectionManagement.current_hostname
end

#each_connection(opts = nil, &blk) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/rails_multisite/connection_management.rb', line 296

def each_connection(opts = nil, &blk)

  old = current_db
  connected = ActiveRecord::Base.connection_pool.connected?

  queue = nil
  threads = nil

  if (opts && (threads = opts[:threads]))
    queue = Queue.new
    all_dbs.each { |db| queue << db }
  end

  errors = nil

  if queue
    threads.times.map do
      Thread.new do

        while true
          begin
            db = queue.deq(true)
          rescue ThreadError
            db = nil
          end

          break unless db

          establish_connection(db: db)
          # no choice but to rescue, should probably log

          begin
            blk.call(db)
          rescue => e
            (errors ||= []) << e
          end
          ActiveRecord::Base.connection_handler.clear_active_connections!
        end
      end
    end.map(&:join)
  else
    all_dbs.each do |db|
      establish_connection(db: db)
      blk.call(db)
      ActiveRecord::Base.connection_handler.clear_active_connections!
    end
  end

  if errors && errors.length > 0
    raise StandardError, "Failed to run queries #{errors.inspect}"
  end

ensure
  establish_connection(db: old)
  ActiveRecord::Base.connection_handler.clear_active_connections! unless connected
end

#establish_connection(opts) ⇒ Object 



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/rails_multisite/connection_management.rb', line 235

def establish_connection(opts)
  opts[:db] = opts[:db].to_s

  if opts[:db] != DEFAULT
    spec = connection_spec(opts)

    if (!spec && opts[:raise_on_missing])
      raise "ERROR: #{opts[:db]} not found!"
    end
  end

  spec ||= @default_spec
  handler = nil
  if spec != @default_spec
    handler = @connection_handlers[handler_key(spec)]
    unless handler
      handler = ActiveRecord::ConnectionAdapters::ConnectionHandler.new
      handler_establish_connection(handler, spec)
      @connection_handlers[handler_key(spec)] = handler
    end
  else
    handler = @default_connection_handler
  end

  ActiveRecord::Base.connection_handler = handler
end

#has_db?(db) ⇒ Boolean

Returns:

  • (Boolean) 


230
231
232
233
 
# File 'lib/rails_multisite/connection_management.rb', line 230

def has_db?(db)
  return true if db == DEFAULT
  @db_spec_cache[db]
end

#host(env) ⇒ Object 



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/rails_multisite/connection_management.rb', line 365

def host(env)
  if host = env["RAILS_MULTISITE_HOST"]
    return host
  end

  request = Rack::Request.new(env)

  host =
    if request['__ws'] && self.class.asset_hostnames&.include?(request.host)
      request.cookies.clear
      request['__ws']
    else
      request.host
    end

  env["RAILS_MULTISITE_HOST"] = host
end

#load_config! ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/rails_multisite/connection_management.rb', line 180

def load_config!
  configs = YAML::load(File.open(@config_filename))

  no_prepared_statements = @default_spec.config[:prepared_statements] == false

  configs.each do |k, v|
    raise ArgumentError.new("Please do not name any db default!") if k == DEFAULT
    v[:db_key] = k
    v[:prepared_statements] = false if no_prepared_statements
  end

  # Build a hash of db name => spec
  new_db_spec_cache = ConnectionSpecification.db_spec_cache(configs)
  new_db_spec_cache.each do |k, v|
    # If spec already existed, use the old version
    if v&.to_hash == @db_spec_cache[k]&.to_hash
      new_db_spec_cache[k] = @db_spec_cache[k]
    end
  end

  # Build a hash of hostname => spec
  new_host_spec_cache = {}
  configs.each do |k, v|
    next unless v["host_names"]
    v["host_names"].each do |host|
      new_host_spec_cache[host] = new_db_spec_cache[k]
    end
  end

  # Add the default hostnames as well
  @default_spec.config[:host_names].each do |host|
    new_host_spec_cache[host] = @default_spec
  end

  removed_dbs = @db_spec_cache.keys - new_db_spec_cache.keys
  removed_specs = @db_spec_cache.values_at(*removed_dbs)

  @host_spec_cache = new_host_spec_cache
  @db_spec_cache = new_db_spec_cache

  # Clean up connection handler cache.
  removed_specs.each { |s| @connection_handlers.delete(handler_key(s)) }
end

#reload ⇒ Object 



224
225
226
227
228
 
# File 'lib/rails_multisite/connection_management.rb', line 224

def reload
  @reload_mutex.synchronize do
    load_config!
  end
end

#with_connection(db = DEFAULT) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/rails_multisite/connection_management.rb', line 279

def with_connection(db = DEFAULT)
  old = current_db
  connected = ActiveRecord::Base.connection_pool.connected?

  establish_connection(db: db) unless connected && db == old
  rval = yield db

  unless connected && db == old
    ActiveRecord::Base.connection_handler.clear_active_connections!

    establish_connection(db: old)
    ActiveRecord::Base.connection_handler.clear_active_connections! unless connected
  end

  rval
end

#with_hostname(hostname) ⇒ Object 



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/rails_multisite/connection_management.rb', line 262

def with_hostname(hostname)
  old = current_hostname
  connected = ActiveRecord::Base.connection_pool.connected?

  establish_connection(host: hostname) unless connected && hostname == old
  rval = yield hostname

  unless connected && hostname == old
    ActiveRecord::Base.connection_handler.clear_active_connections!

    establish_connection(host: old)
    ActiveRecord::Base.connection_handler.clear_active_connections! unless connected
  end

  rval
end