fly-ruby 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 506556ce79da83a817f5a6a56b336328912730ace3fb26d10ed0d7e97f971abc
-  data.tar.gz: c2c7ceb044a6a9054da36ae775a0693458e91dac271b5d341666995dd59373b5
+  metadata.gz: ea1ca64bcd11ed8a60774f0d8ec255ffb49bc6b8e21a8bd32e7410068bec35c0
+  data.tar.gz: fb55ad6c98cb631bf202aea206c53a9b2e9a7c738cd9835095dd647011cfc7f6
 SHA512:
-  metadata.gz: d7a79ba9b2a2db74515bdce0c606c99072d292813b5ef34c8963d44bcc0366fe0230bc784dcb8e489614ef1dd33ebb447d7cb215fd7f475c0fc00d51487446cf
-  data.tar.gz: 38e26c8853bde15845b1cd1c34bcff68f5f87db5a8e726af4451329619b54f3c4dfa26ffd83832e24ea0a743401b1e28c011316ab78b08c60cc76e42022bec58
+  metadata.gz: 7c3df04f8bb9f97bfb87903b0fffc14ef2b320802e1183752c07f8b769b629f6c66af21ae0e4bb5a23a2608cfdfdda2f3b1c387e3edcd1f64b5d2474a79f7a6f
+  data.tar.gz: ff4ca7c18d4b18ec237c8e1c59bce88dce849198934ed1d42c28ab2a081b577f8fa2cc38930d0478ec94a5bee580e2f12649b38d3ad46d176a774edaba60446c

data/.gitignore

@@ -4,3 +4,4 @@ log/
 Gemfile.lock
 .ruby-version
 *.gem
+db/

data/README.md

@@ -1,8 +1,8 @@
 [![Test](https://github.com/superfly/fly-ruby/actions/workflows/test.yml/badge.svg)](https://github.com/superfly/fly-ruby/actions/workflows/test.yml)
 
-This gem contains helper code and Rack middleware for deploying Ruby web apps on [Fly.io](https://fly.io). Supported features:
+This gem contains helper code and Rack middleware for deploying Ruby web apps on [Fly.io](https://fly.io). It's designed to speed up apps by using region-local Postgresql replicas for database reads. See the blog post for more details:
 
-* Speed up apps by using region-local Postgresql replicas for database reads
+https://fly.io/blog/run-ordinary-rails-apps-globally
 
 ## Speed up apps using region-local database replicas
 
@@ -49,7 +49,7 @@ Fly.configure do |c|
 end
 ```
 
-See [the source code](https://github.com/soupedup/fly-rails/blob/main/lib/fly-rails/configuration.rb) for defaults and available configuration options.
+See [the source code](https://github.com/superfly/fly-ruby/blob/main/lib/fly-ruby/configuration.rb) for defaults and available configuration options.
 ## Known issues
 
 This middleware send all requests to the primary if you do something like update a user's database session on every GET request.

data/lib/fly-ruby/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fly
   class Configuration
     # Set the region where this instance of the application is deployed
@@ -28,6 +30,9 @@ module Fly
     attr_accessor :database_url
     attr_accessor :redis_url
 
+    # An array of string representations of exceptions that should trigger a replay
+    attr_accessor :replayable_exceptions
+
     def initialize
       self.primary_region = ENV["PRIMARY_REGION"]
       self.current_region = ENV["FLY_REGION"]
@@ -40,6 +45,19 @@ module Fly
       self.replay_threshold_in_seconds = 5
       self.database_url = ENV[database_url_env_var]
       self.redis_url = ENV[redis_url_env_var]
+      self.replayable_exceptions = ["SQLite3::CantOpenException", "PG::ReadOnlySqlTransaction"]
+    end
+
+    def replayable_exception_classes
+      @replayable_exception_classes ||= replayable_exceptions.collect {|ex| module_exists?(ex) }.compact
+      @replayable_exception_classes
+    end
+
+    def module_exists?(module_name)
+      mod = Module.const_get(module_name)
+      return mod
+    rescue NameError
+      nil
     end
 
     def database_uri
@@ -60,9 +78,9 @@ module Fly
     # Rails-compatible database configuration
     def regional_database_config
       {
-        "host" => regional_database_host,
-        "port" => 5433,
-        "adapter" => "postgresql"
+        :host => regional_database_host,
+        :port => 5433,
+        :adapter => "postgresql"
       }
     end
 

data/lib/fly-ruby/headers.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Fly
+  class Headers
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      response = Rack::Response.new(body, status, headers)
+      response.set_header('Fly-Region', ENV['FLY_REGION'])
+      response.finish
+    end
+  end
+end

data/lib/fly-ruby/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Fly::Railtie < Rails::Railtie
   def hijack_database_connection
     ActiveSupport::Reloader.to_prepare do
@@ -6,26 +8,17 @@ class Fly::Railtie < Rails::Railtie
       # hooks for forking servers to work correctly.
       if defined?(ActiveRecord)
         config = ActiveRecord::Base.connection_db_config.configuration_hash
-        ActiveRecord::Base.establish_connection(config.merge(Fly.configuration.regional_database_config))
-      end
-    end
-  end
-
-  # Set useful headers for debugging
-  def set_debug_response_headers
-    ActiveSupport::Reloader.to_prepare do
-      ApplicationController.send(:after_action) do
-        response.headers['Fly-Region'] = ENV['FLY_REGION']
+        ActiveRecord::Base.establish_connection(config.symbolize_keys.merge(Fly.configuration.regional_database_config))
       end
     end
   end
 
   initializer("fly.regional_database") do |app|
-    set_debug_response_headers if Fly.configuration.web?
+    # Insert the request middleware high in the stack, but after static file delivery
+    app.config.middleware.insert_after ActionDispatch::Executor, Fly::Headers if Fly.configuration.web?
 
     if Fly.configuration.eligible_for_activation?
-      # Insert the request interceptor high in the stack, but after static file delivery
-      app.config.middleware.insert_after ActionDispatch::Executor, Fly::RegionalDatabase::ReplayableRequestMiddleware
+      app.config.middleware.insert_after Fly::Headers, Fly::RegionalDatabase::ReplayableRequestMiddleware
       # Insert the database exception handler at the bottom of the stack to take priority over other exception handlers
       app.config.middleware.use Fly::RegionalDatabase::DbExceptionHandlerMiddleware
 

data/lib/fly-ruby/regional_database.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake'
 
 module Fly
@@ -29,9 +31,10 @@ module Fly
       end
 
       def call(env)
+        exceptions = Fly.configuration.replayable_exception_classes
         @app.call(env)
-      rescue PG::ReadOnlySqlTransaction, ActiveRecord::StatementInvalid => e
-        if e.is_a?(PG::ReadOnlySqlTransaction) || e&.cause&.is_a?(PG::ReadOnlySqlTransaction)
+      rescue *exceptions, ActiveRecord::RecordInvalid => e
+        if exceptions.any? {|ex| e.is_a?(ex) } || exceptions.any? { e&.cause&.is_a?(e) }
           RegionalDatabase.replay_in_primary_region!(state: "captured_write")
         else
           raise e
@@ -53,7 +56,7 @@ module Fly
       end
 
       def replay_request_state(header_value)
-        header_value&.scan(/(.*?)=(.*?)($|;)/)&.detect { |v| v[0] == "state" }&.at(1)
+        header_value&.slice(/(?:^|;)state=([^;]*)/, 1)
       end
 
       def call(env)

data/lib/fly-ruby/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fly
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/fly-ruby.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 require_relative "fly-ruby/configuration"
 require_relative "fly-ruby/regional_database"
+require_relative "fly-ruby/headers"
+
 require "forwardable"
 
 if defined?(::Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fly-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joshua Sierles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -41,6 +41,7 @@ files:
 - fly-ruby.gemspec
 - lib/fly-ruby.rb
 - lib/fly-ruby/configuration.rb
+- lib/fly-ruby/headers.rb
 - lib/fly-ruby/railtie.rb
 - lib/fly-ruby/regional_database.rb
 - lib/fly-ruby/version.rb
@@ -63,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
 summary: Augment Ruby web apps for deployment in Fly.io