Module: Rage::Ext::ActiveRecord::ConnectionPool

Includes:
ConnectionWithVerify
Defined in:
lib/rage/ext/active_record/connection_pool.rb

Defined Under Namespace

Modules: ConnectionWithVerify Classes: BlackHoleList

Instance Method Summary collapse

Instance Method Details

#__init_rage_extension ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 57

def __init_rage_extension
  # a map of fibers that are currently waiting for a
  # connection in the format of { Fiber => timestamp }
  @__blocked = {}

  # a map of fibers that are currently hodling connections
  # in the format of { Fiber => Connection }
  @__in_use = {}

  # how long a fiber can wait for a connection to become available
  @__checkout_timeout = checkout_timeout

  # how long a connection can be idle for before disconnecting
  @__idle_timeout = respond_to?(:db_config) ? db_config.idle_timeout : @idle_timeout

  # pool will maintain at least this many connections
  @__min_connections = respond_to?(:min_connections) ? min_connections : 0

  # connections older than this are automatically disconnected
  @__max_age = respond_to?(:max_age) ? max_age : Float::INFINITY

  # seconds between keepalive pings on idle connections
  @__keepalive = respond_to?(:keepalive) ? keepalive : nil

  # how often should we check for fibers that wait for a connection for too long
  @__timeout_worker_frequency = 0.5

  # a list of all DB connections that are currently idle
  @__connections = build_new_connections

  # reject fibers that wait for a connection for more than `@__checkout_timeout`
  Iodine.run_every((@__timeout_worker_frequency * 1_000).to_i) do
    if @__blocked.length > 0
      current_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
      @__blocked.each do |fiber, blocked_since|
        if (current_time - blocked_since) > @__checkout_timeout
          @__blocked.delete(fiber)
          fiber.raise(ActiveRecord::ConnectionTimeoutError, "could not obtain a connection from the pool within #{@__checkout_timeout} seconds; all pooled connections were in use")
        end
      end
    end
  end

  # monitor connections health
  if Rage.config.internal.should_manually_restore_ar_connections?
    Iodine.run_every(1_000) do
      i = 0
      while i < @__connections.length
        conn = @__connections[i]

        unless conn.__needs_reconnect
          needs_reconnect = !conn.active? rescue true
          if needs_reconnect
            conn.__needs_reconnect = true
            conn.disconnect!
          end
        end

        i += 1
      end
    end
  end

  @release_connection_channel = "ext:ar-connection-released:#{object_id}"
  @__owner_thread = Thread.current
  @__background_maintenance_disabled = (ActiveRecord.version < Gem::Version.create("8.1"))

  # resume blocked fibers once connections become available
  Iodine.subscribe(@release_connection_channel) do
    if @__blocked.length > 0 && @__connections.length > 0
      f, _ = @__blocked.shift
      f.resume
    end
  end

  # unsubscribe on shutdown
  Iodine.on_state(:on_finish) do
    Iodine.unsubscribe(@release_connection_channel)
  end

  Iodine.run_every((db_config.reaping_frequency * 1_000).to_i) do
    reap
    flush
    disconnected = retire_old_connections
    keep_alive
    preconnect if disconnected
  end
end

#active_connection? ⇒ Boolean

Returns true if there is an open connection being used for the current fiber.

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 147

def active_connection?
  @__in_use[Fiber.current]
end

#checkin(conn) ⇒ Object

Check in a database connection back into the pool, indicating that you no longer need this connection.



399
400
401
402
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 399

def checkin(conn)
  fiber = @__in_use.key(conn)
  release_connection(fiber)
end

#checkout(_ = nil) ⇒ Object

Check out a database connection from the pool, indicating that you want to use it. You should call #checkin when you no longer need this.



386
387
388
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 386

def checkout(_ = nil)
  connection
end

#clear_reloadable_connections(raise_on_acquisition_timeout = true) ⇒ Object 



412
413
414
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 412

def clear_reloadable_connections(raise_on_acquisition_timeout = true)
  disconnect(raise_on_acquisition_timeout)
end

#clear_reloadable_connections! ⇒ Object 



416
417
418
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 416

def clear_reloadable_connections!
  disconnect(false)
end

#connected? ⇒ Boolean

Returns true if a connection has already been opened.

Returns:

  • (Boolean) 


317
318
319
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 317

def connected?
  true
end

#connection ⇒ Object

Retrieve the connection associated with the current fiber, or obtain one if necessary.



152
153
154
155
156
157
158
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 152

def connection
  @__in_use[Fiber.current] ||= @__connections.pop || begin
    @__blocked[Fiber.current] = Process.clock_gettime(Process::CLOCK_MONOTONIC)
    Fiber.yield
    @__connections.pop
  end
end

#connections ⇒ Object

Returns an array containing the connections currently in the pool.



312
313
314
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 312

def connections
  @__connections.to_a
end

#discard! ⇒ Object

Discards all connections in the pool (even if they're currently in use!), along with the pool itself. Any further interaction with the pool is undefined.



426
427
428
429
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 426

def discard!
  @__discarded = true
  (@__connections + @__in_use.values).each { |conn| conn.discard! }
end

#discarded? ⇒ Boolean

Returns:

  • (Boolean) 


431
432
433
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 431

def discarded?
  !!@__discarded
end

#disconnect(raise_on_acquisition_timeout = true, disconnect_attempts = 0) ⇒ Object

Disconnects all connections in the pool, and clears the pool. Raises ActiveRecord::ExclusiveConnectionTimeoutError if unable to gain ownership of all connections in the pool within a timeout interval (default duration is checkout_timeout * 2 seconds).



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 337

def disconnect(raise_on_acquisition_timeout = true, disconnect_attempts = 0)
  return if @__connections.is_a?(BlackHoleList)

  # allow request fibers to release connections, but block from acquiring new ones
  if disconnect_attempts == 0
    @__connections = BlackHoleList.new(@__connections)
  end

  # if some connections are in use, we will wait for up to `@__checkout_timeout * 2` seconds
  if @__in_use.length > 0 && disconnect_attempts <= @__checkout_timeout * 4
    Iodine.run_after(500) { disconnect(raise_on_acquisition_timeout, disconnect_attempts + 1) }
    return
  end

  pool_connections = @__connections.to_a

  # check if there are still some connections in use
  if @__in_use.length > 0
    raise(ActiveRecord::ExclusiveConnectionTimeoutError, "could not obtain ownership of all database connections") if raise_on_acquisition_timeout
    pool_connections += @__in_use.values
    @__in_use.clear
  end

  # disconnect all connections
  pool_connections.each do |conn|
    conn.disconnect!
    __remove__(conn)
  end

  # create a new pool
  self.automatic_reconnect = true
  @__connections = build_new_connections

  # notify blocked fibers that there are new connections available
  [@__blocked.length, @__connections.length].min.times do
    Iodine.publish(@release_connection_channel, "", Iodine::PubSub::PROCESS)
  end
end

#disconnect! ⇒ Object

Disconnects all connections in the pool, and clears the pool. The pool first tries to gain ownership of all connections. If unable to do so within a timeout interval (default duration is checkout_timeout * 2 seconds), then the pool is forcefully disconnected without any regard for other connection owning fibers.



380
381
382
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 380

def disconnect!
  disconnect(false)
end

#flush(minimum_idle = @__idle_timeout) ⇒ Object

Disconnect all connections that have been idle for at least minimum_idle seconds. Connections currently checked out, or that were checked in less than minimum_idle seconds ago, are unaffected.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 204

def flush(minimum_idle = @__idle_timeout)
  return if Thread.current != @__owner_thread || minimum_idle.nil? || @__connections.length == 0

  current_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  i = @__connections.length - 1
  connections_to_preserve = @__min_connections

  while i >= 0
    conn = @__connections[i]

    if connections_to_preserve > 0 && conn.connected? && conn.verified?
      connections_to_preserve -= 1
      i -= 1
      next
    end

    if conn.__idle_since && current_time - conn.__idle_since >= minimum_idle
      conn.__idle_since = nil
      conn.__needs_reconnect = true
      conn.disconnect!
    end
    i -= 1
  end
end

#flush! ⇒ Object

Disconnect all currently idle connections. Connections currently checked out are unaffected.



295
296
297
298
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 295

def flush!
  reap
  flush(-1)
end

#keep_alive(threshold = @__keepalive) ⇒ Object

Ping idle connections to prevent firewall/server timeouts



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 248

def keep_alive(threshold = @__keepalive)
  return if threshold.nil? || @__connections.length == 0

  to_ping = nil

  @__connections.delete_if do |conn|
    if (conn.seconds_since_last_activity || 0) >= conn.pool_jitter(threshold)
      (to_ping ||= []) << conn
      true
    end
  end

  to_ping&.each do |conn|
    Fiber.schedule do
      if conn.active?
        @__connections << conn
      else
        conn.disconnect!
        @__connections.unshift(conn)
      end
      Iodine.publish(@release_connection_channel, "", Iodine::PubSub::PROCESS) if @__blocked.length > 0
    end
  end
end

#lease_connection ⇒ Object 



390
391
392
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 390

def lease_connection
  connection
end

#maintainable? ⇒ Boolean

Returns:

  • (Boolean) 


394
395
396
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 394

def maintainable?
  false
end

#num_waiting_in_queue ⇒ Object 



420
421
422
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 420

def num_waiting_in_queue
  @__blocked.length
end

#preconnect ⇒ Object

Proactively establish DB connections



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 274

def preconnect
  return if @__connections.length == 0 || @__background_maintenance_disabled

  active_connections_count = @__in_use.length + @__connections.count { |conn| conn.connected? && conn.verified? }

  while @__min_connections - active_connections_count > 0
    i = @__connections.rindex { |conn| !conn.connected? || !conn.verified? }
    return unless i

    Fiber.schedule do
      conn = @__connections.delete_at(i)
      conn.connect! rescue nil
      @__connections << conn
      Iodine.publish(@release_connection_channel, "", Iodine::PubSub::PROCESS) if @__blocked.length > 0
    end

    active_connections_count += 1
  end
end

#reap ⇒ Object

Recover lost connections for the pool.



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 172

def reap
  return unless Thread.current == @__owner_thread

  dead = nil

  @__in_use.delete_if do |fiber, conn|
    unless fiber.alive?
      (dead ||= []) << [fiber, conn]
      true
    end
  end

  dead&.each do |fiber, conn|
    Fiber.schedule do
      if conn.active?
        conn.reset!
        @__in_use[fiber] = conn
        release_connection(fiber)
      else
        conn.disconnect!
        __remove__(conn)
        self.automatic_reconnect = true
        @__connections.unshift(*build_new_connections(1))
        Iodine.publish(@release_connection_channel, "", Iodine::PubSub::PROCESS) if @__blocked.length > 0
      end
    end
  end
end

#release_connection(owner = Fiber.current) ⇒ Object

Signal that the fiber is finished with the current connection and it can be returned to the pool.



161
162
163
164
165
166
167
168
169
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 161

def release_connection(owner = Fiber.current)
  if (conn = @__in_use.delete(owner))
    conn.__idle_since = Process.clock_gettime(Process::CLOCK_MONOTONIC)
    @__connections << conn
    Iodine.publish(@release_connection_channel, "", Iodine::PubSub::PROCESS) if @__blocked.length > 0
  end

  conn
end

#remove(conn) ⇒ Object

Remove a connection from the connection pool. The connection will remain open and active but will no longer be managed by this pool.



406
407
408
409
410
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 406

def remove(conn)
  __remove__(conn)
  @__in_use.delete_if { |_, c| c == conn }
  @__connections.delete(conn)
end

#retire_old_connections(max_age = @__max_age) ⇒ Object

Disconnect connections exceeding max_age



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 230

def retire_old_connections(max_age = @__max_age)
  return false if max_age.nil? || max_age.infinite?

  i, disconnected = 0, false

  while i < @__connections.length
    conn = @__connections[i]
    if (conn.connection_age || 0) >= conn.pool_jitter(max_age)
      conn.disconnect!
      disconnected = true
    end
    i += 1
  end

  disconnected
end

#stat ⇒ Object

Return connection pool's usage statistic.



322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 322

def stat
  {
    size: size,
    connections: size,
    busy: @__in_use.count { |fiber, _| fiber.alive? },
    dead: @__in_use.count { |fiber, _| !fiber.alive? },
    idle: @__connections.length,
    waiting: @__blocked.length,
    checkout_timeout: @__checkout_timeout
  }
end

#with_connection(_ = nil) ⇒ Object

Yields a connection from the connection pool to the block.



301
302
303
304
305
306
307
308
309
 
# File 'lib/rage/ext/active_record/connection_pool.rb', line 301

def with_connection(_ = nil)
  unless (conn = @__in_use[Fiber.current])
    conn = connection
    fresh_connection = true
  end
  yield conn
ensure
  release_connection if fresh_connection
end