RubyGems - fly-ruby - Versions diffs - 0.2.1 → 0.2.2 - Mend

fly-ruby 0.2.1 → 0.2.2

Files changed (6) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +6 -0
data/lib/fly-ruby/railtie.rb +10 -9
data/lib/fly-ruby/regional_database.rb +61 -80
data/lib/fly-ruby/version.rb +1 -1
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79850f3de9e2a7e78ff9d46ba7728c605fae5651786d3a425dec0d12056d75b6
-  data.tar.gz: 5349dfbb16a8a257a909c68410f2041bf5202bbeed5ae88e496a9efa2e1c9478
+  metadata.gz: dacb7a202a7a167f2ef451373f29893ca4efe7c0a46e60aeb4d958883a6cd3ec
+  data.tar.gz: d650c2d9459908dc81f5bdf8f72f6744c097b5f40de20fc7c339b64b96797361
 SHA512:
-  metadata.gz: e43ad67e8d81f5d817ad274bb0f2e2a97d276fc1a9f0bb78549ea6cc06b5c2e5a90fd2ddd03f7529f592cf037bed68ed9f172945425829b7952acbdd4c20df58
-  data.tar.gz: d91c4fd6e1a5d3619165c9a44076840ac331c8533f0cb94f34001022d987bca1f7b654de34668cc6029305341f39bc7caa22b31ad76968802261fd884816b878
+  metadata.gz: d5cad909dcf688f11958ebb2012c4388d685ca9d691c4db7bc9b2fd43e3522dd6c52b4c98ac7a7f5ae9937a285069bf68608dbec27477d86ac4fad52cdbe624e
+  data.tar.gz: 93879cc71887b23c2f8082b44ee3630844f2b5fc493b9daebff964b119a090ba8e1b28b62f844c239c27b011b852f5a978b12ba27f85aa5fc3607c4f3dea0397

data/CHANGELOG.md CHANGED Viewed

@@ -2,6 +2,12 @@
 ### Bug fixes
+- Run the database exception handler at the bottom of the stack to ensure it will take priority over other exception handlers
+## 0.2.1
+### Bug fixes
 - Only hijack the database connection for requests in secondary regions
 ## 0.2.0

data/lib/fly-ruby/railtie.rb CHANGED Viewed

@@ -15,20 +15,21 @@ class Fly::Railtie < Rails::Railtie
   # Set useful headers for debugging
   def set_debug_response_headers
-    return unless defined?(ApplicationController)
-    ApplicationController.send(:after_action) do
-      response.headers['Fly-Region'] = ENV['FLY_REGION']
-      response.headers['Fly-Database-Host'] = Fly.configuration.regional_database_config["host"]
+    ActiveSupport::Reloader.to_prepare do
+      ApplicationController.send(:after_action) do
+        response.headers['Fly-Region'] = ENV['FLY_REGION']
+      end
     end
   end
   initializer("fly.regional_database") do |app|
-    set_debug_response_headers
-    if Fly.configuration.eligible_for_activation?
-      app.config.middleware.insert_after ActionDispatch::Executor, Fly::RegionalDatabase
+    set_debug_response_headers if Fly.configuration.web?
-      # Run the middleware high in the stack, but after static file delivery
+    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
+      # 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
       hijack_database_connection if Fly.configuration.in_secondary_region?
     elsif Fly.configuration.web?
       puts "Warning: DATABASE_URL, PRIMARY_REGION and FLY_REGION must be set to activate the fly-ruby middleware. Middleware not loaded."

data/lib/fly-ruby/regional_database.rb CHANGED Viewed

@@ -5,39 +5,7 @@ module Fly
   # multithreaded environments. Instead of using dirty tricks like using Object#dup,
   # values are passed to methods.
-  class RegionalDatabase
-    def initialize(app)
-      @app = app
-    end
-    # Overwrite the database connection string environment variable
-    # to prefer connections to the regional replica.
-    #
-    # For Rails apps, this process will be repeated at middleware insertion time,
-    # to support situations where the database is already accessed by other
-    # initialization code. See Fly::Railtie.
-    def prefer_regional_database!
-      return if Fly.configuration.web?
-      uri = Fly.configuration.database_uri
-      ENV[Fly.configuration.database_url_env_var] = uri.to_s
-      ENV[Fly.configuration.database_host_env_var] = uri.hostname
-      ENV[Fly.configuration.database_port_env_var] = uri.port.to_s
-    end
-    def in_primary_region?
-      Fly.configuration.primary_region == Fly.configuration.current_region
-    end
-    def regional_database_url
-    end
-    def response_body
-      "<html>Replaying request in #{Fly.configuration.primary_region}</html>"
-    end
+  module RegionalDatabase
     # Stop the current request and ask for it to be replayed in the primary region.
     # Pass one of three states to the target region, to determine how to handle the request:
     #
@@ -45,70 +13,83 @@ module Fly
     # captured_write: A write was rejected by the database
     # http_method: A non-idempotent HTTP method was replayed before hitting the application
     # threshold: A recent write set a threshold during which all requests are replayed
-    #
-    def replay_in_primary_region!(state:)
+    def self.replay_in_primary_region!(state:)
       res = Rack::Response.new(
-        response_body,
+        "",
         409,
-        {"fly-replay" => "region=#{Fly.configuration.primary_region};state=#{state}"}
+        {"Fly-Replay" => "region=#{Fly.configuration.primary_region};state=#{state}"}
       )
       res.finish
     end
-    def within_replay_threshold?(threshold)
-      threshold && (threshold.to_i - Time.now.to_i) > 0
-    end
+    class DbExceptionHandlerMiddleware
+      def initialize(app)
+        @app = app
+      end
-    def replayable_http_method?(http_method)
-      Fly.configuration.replay_http_methods.include?(http_method)
+      def call(env)
+        @app.call(env)
+      rescue PG::ReadOnlySqlTransaction, ActiveRecord::StatementInvalid => e
+        if e.is_a?(PG::ReadOnlySqlTransaction) || e&.cause&.is_a?(PG::ReadOnlySqlTransaction)
+          RegionalDatabase.replay_in_primary_region!(state: "captured_write")
+        else
+          raise e
+        end
+      end
     end
-    def replay_request_state(header_value)
-      header_value&.scan(/(.*?)=(.*?)($|;)/)&.detect { |v| v[0] == "state" }&.at(1)
-    end
+    class ReplayableRequestMiddleware
+      def initialize(app)
+        @app = app
+      end
-    def call(env)
-      request = Rack::Request.new(env)
+      def within_replay_threshold?(threshold)
+        threshold && (threshold.to_i - Time.now.to_i) > 0
+      end
-    # Check whether this request satisfies any of the following conditions for replaying in the primary region:
-    #
-    # 1. Its HTTP method matches those configured for automatic replay (post/patch/put/delete by default).
-    #    This approach should avoid potentially slow code execution - before_actions or other controller code -
-    #    happening before a request reaches a database write.
-    # 2. It arrived before the threshold defined by the last write request. This threshold
-    #    helps avoid the same client from missing its own write due to replication lag,
-    #    like when a user adds to a todo list via XHR
-      if !in_primary_region?
-        if replayable_http_method?(request.request_method)
-          return replay_in_primary_region!(state: "http_method")
-        elsif within_replay_threshold?(request.cookies[Fly.configuration.replay_threshold_cookie])
-          return replay_in_primary_region!(state: "threshold")
-        end
+      def replayable_http_method?(http_method)
+        Fly.configuration.replay_http_methods.include?(http_method)
       end
-      begin
-        status, headers, body = @app.call(env)
-      rescue ActiveRecord::StatementInvalid => e
-        if e.cause.is_a?(PG::ReadOnlySqlTransaction)
-          return replay_in_primary_region!(state: "captured_write")
-        else
-          raise e
-        end
+      def replay_request_state(header_value)
+        header_value&.scan(/(.*?)=(.*?)($|;)/)&.detect { |v| v[0] == "state" }&.at(1)
       end
-      response = Rack::Response.new(body, status, headers)
-      replay_state = replay_request_state(request.get_header("HTTP_FLY_REPLAY_SRC"))
+      def call(env)
+        request = Rack::Request.new(env)
+        # Does this request satisfiy a condition for replaying in the primary region?
+        #
+        # 1. Its HTTP method matches those configured for automatic replay
+        # 2. It arrived before the threshold defined by the last write request.
+        #    This threshold helps avoid the same client from missing its own
+        #    write due to replication lag.
+        if Fly.configuration.in_secondary_region?
+          if replayable_http_method?(request.request_method)
+            return RegionalDatabase.replay_in_primary_region!(state: "http_method")
+          elsif within_replay_threshold?(request.cookies[Fly.configuration.replay_threshold_cookie])
+            return RegionalDatabase.replay_in_primary_region!(state: "threshold")
+          end
+        end
-      # Request was replayed, but not by a threshold
-      if replay_state && replay_state != "threshold"
-        response.set_cookie(
-          Fly.configuration.replay_threshold_cookie,
-          Time.now.to_i + Fly.configuration.replay_threshold_in_seconds
-        )
-      end
+        status, headers, body = @app.call(env)
-      response.finish
+        response = Rack::Response.new(body, status, headers)
+        replay_state = replay_request_state(request.get_header("HTTP_FLY_REPLAY_SRC"))
+        # Request was replayed, but not by a threshold, so set a threshold within which
+        # all requests should be replayed to the primary region
+        if replay_state && replay_state != "threshold"
+          response.set_cookie(
+            Fly.configuration.replay_threshold_cookie,
+            Time.now.to_i + Fly.configuration.replay_threshold_in_seconds
+          )
+        end
+        response.finish
+      end
     end
   end
 end

data/lib/fly-ruby/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Fly
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fly-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Joshua Sierles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack