active_record_serverless 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 52554bbe78950b6e39d662452b8f665a24dfd0c15edfccc8c7a2822a4a7fd0d0
+  data.tar.gz: 84848ac174145998e5a480a99727531d634ec10cb85fde8d5fdbba7f8707a0c7
+SHA512:
+  metadata.gz: 12ccacf518f299a27e3035176e421e1751f300bcce1a7dbe1f0c1e1128500c19e35d31cc51c8b75d0eb816d6f8570b2e2a15484b5fb0e58aecaff793493a6ba4
+  data.tar.gz: e72a10dd5ff32e5b1a5b5d286c767ad8142541c08e2e343b4e0fb1f5cb2281f919911f2882e18e53a472448d9e7793a6405909c66fbc93f8661e38bb03c22f89

data/README.md

@@ -0,0 +1,41 @@
+# ActiveRecordServerless
+
+Handles database connection's to disconnect on a timeout. This allows [Aurora Serverless](https://aws.amazon.com/rds/aurora/serverless/) servers to spin down.
+
+## Installing
+
+In a Gemfile
+
+```ruby
+gem 'active_record_serverless'
+```
+
+Manually
+
+`gem install active_record_serverless`
+
+### Config
+
+```ruby
+# in config/database.yml
+development:
+  # other db params
+  serverless:
+    timeout: 60.0 # Timeout every 60 seconds.
+```
+
+### Forking
+
+```ruby
+after_fork do
+  ActiveRecordServerless.start_timeout
+end
+```
+
+### Non-Rails Application.
+
+#### Setup
+
+```ruby
+ActiveRecordServerless::Installer.install!(nil)
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/lib/active_record_serverless.rb

@@ -0,0 +1,10 @@
+require 'active_record_serverless/installer'
+require 'active_record_serverless/reconnect'
+require 'active_record_serverless/timeout'
+require 'active_record_serverless/version'
+
+require 'active_record_serverless/railtie' if defined?(::Rails)
+
+module ActiveRecordServerless
+  class Error < StandardError; end
+end

data/lib/active_record_serverless/executor.rb

@@ -0,0 +1,17 @@
+require_relative 'timeout'
+
+module ActiveRecordServerless
+  class Executor
+    def self.setup
+      ActiveRecord::Base.connection.class.class_eval do
+        alias_method :serverless_execute, :execute
+
+        def execute(*args)
+          ActiveRecordServerless::Timeout.touch!
+
+          serverless_execute(*args)
+        end
+      end
+    end
+  end
+end

data/lib/active_record_serverless/installer.rb

@@ -0,0 +1,53 @@
+require 'active_record'
+
+require_relative 'timeout'
+require_relative 'logger'
+require_relative 'executor'
+
+module ActiveRecordServerless
+  def self.start_timeout(timeout = nil)
+    ActiveRecordServerless::Installer.start_timeout(timeout)
+  end
+
+  class Installer
+    class << self
+      def config
+        ActiveRecord::Base.connection_config.with_indifferent_access.dig(:serverless)
+      end
+
+      def install!(_app)
+        disabled = config.dig(:disabled).nil? ? false : config.dig(:disabled)
+
+        if disabled == true
+          message = <<~EOF
+            Skipping ActiveRecordServerless Install.
+
+            Connection config explicitly marked serverless as disabled.
+          EOF
+          ActiveRecordServerless.log(message)
+          return
+        end
+
+        _install
+      end
+
+      def start_timeout(timeout = nil)
+        timeout ||= (config.dig(:timeout) || 60.0)
+
+        ActiveRecordServerless.log("Installing ActiveRecordServerless [timeout=#{timeout}]")
+
+        ActiveRecordServerless::Timeout.on_timeout(timeout) do
+          ActiveRecordServerless.log('ActiveRecordServerless timeout...')
+          ActiveRecord::Base.connection_pool.disconnect!
+        end
+      end
+
+      private
+
+      def _install
+        ActiveRecordServerless::Executor.setup
+        ActiveRecordServerless::Installer.start_timeout
+      end
+    end
+  end
+end

data/lib/active_record_serverless/logger.rb

@@ -0,0 +1,9 @@
+module ActiveRecordServerless
+  def self.log(msg)
+    if defined?(::Rails)
+      ::Rails.logger.debug msg
+    else
+      STDERR.puts msg
+    end
+  end
+end

data/lib/active_record_serverless/middleware/ensure_connection.rb

@@ -0,0 +1,20 @@
+require 'active_record'
+
+require_relative '../timeout'
+
+module ActiveRecordServerless
+  module Middleware
+    class EnsureConnection
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        ActiveRecordServerless::Timeout.touch! do
+          ActiveRecord::Base.establish_connection unless ActiveRecord::Base.connected?
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/active_record_serverless/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails'
+
+require_relative 'installer'
+require_relative 'middleware/ensure_connection'
+
+module ActiveRecordServerless
+  class Railtie < ::Rails::Railtie
+    initializer 'active_record_serverless.install', after: 'active_record.initialize_database' do |app|
+      ActiveRecordServerless::Installer.install!(app)
+      app.middleware.insert_before(Rack::Runtime, ActiveRecordServerless::Middleware::EnsureConnection)
+    end
+  end
+end

data/lib/active_record_serverless/reconnect.rb

@@ -0,0 +1,16 @@
+require 'active_record'
+require 'active_support'
+
+require_relative 'timeout'
+
+module ActiveRecordServerless
+  def self.reconnect
+    ActiveRecordServerless::Timeout.touch!
+
+    return if ActiveRecord::Base.connected?
+
+    ActiveSupport::Notifications.instrument('active_record_serverless.reconnect') do
+      ActiveRecord::Base.establish_connection
+    end
+  end
+end

data/lib/active_record_serverless/timeout.rb

@@ -0,0 +1,69 @@
+require 'active_support'
+
+module ActiveRecordServerless
+  class Timeout
+    MUTEX = Mutex.new
+
+    class << self
+      def touch!
+        ActiveSupport::Notifications.instrument('active_record_serverless.touch') do
+          MUTEX.synchronize do
+            _last_used(Time.now)
+            yield if block_given?
+          end
+        end
+      end
+
+      def last_used
+        MUTEX.synchronize { _last_used }
+      end
+
+      def on_timeout(timeout, &block)
+        raise ArgumentError, 'Timeout must be greater than 1' unless timeout.to_f >= 1.0
+
+        touch!
+
+        MUTEX.synchronize do
+          _running_id((_running_id || 0) + 1)
+        end
+
+        _on_timeout(timeout.to_f, running_id, &block)
+      end
+
+      def running?
+        running_id.positive?
+      end
+
+      def running_id
+        MUTEX.synchronize { _running_id }
+      end
+
+      private
+
+      def _on_timeout(timeout, rid, &block)
+        Thread.new do
+          sleep(timeout)
+          last = last_used
+          delta = Time.now.to_f - last.to_f
+          if delta >= timeout
+            opts = { last_time: last, delta: delta, running_id: rid }
+            ActiveSupport::Notifications.instrument('active_record_serverless.timeout', opts) do
+              yield(last, delta)
+            end
+          end
+          _on_timeout(timeout, rid, &block) if rid == running_id
+        end
+      end
+
+      def _last_used(time = nil)
+        @_last_used = time unless time.nil?
+        @_last_used
+      end
+
+      def _running_id(running = nil)
+        @_running_id = running unless running.nil?
+        @_running_id
+      end
+    end
+  end
+end

data/lib/active_record_serverless/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordServerless
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: active_record_serverless
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maddie Schipper
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: ActiveRecord Serverless handle AWS Aurora Serverless
+email:
+- me@maddiesch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/active_record_serverless.rb
+- lib/active_record_serverless/executor.rb
+- lib/active_record_serverless/installer.rb
+- lib/active_record_serverless/logger.rb
+- lib/active_record_serverless/middleware/ensure_connection.rb
+- lib/active_record_serverless/railtie.rb
+- lib/active_record_serverless/reconnect.rb
+- lib/active_record_serverless/timeout.rb
+- lib/active_record_serverless/version.rb
+homepage: https://github.com/maddiesch/active_record_serverless
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: ActiveRecord Serverless handle AWS Aurora Serverless
+test_files: []