fly-ruby 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82d6cde56b619737984124f61e7fc526129eebb493e1954f9b9b171202d8eed0
-  data.tar.gz: 2a14fee50d07739be04a19476128671878fb448fbe1cf23654df254beba4507a
+  metadata.gz: 59f0a5a6d3bbfc27e9440a2a96f230b662d42628c0d520df2cfb8269ada04a33
+  data.tar.gz: b21db455e7927c6c10219db01d2ba38fe24c258b3bfe454fd5f25212b95e78c5
 SHA512:
-  metadata.gz: 87c976601cddc300a435f503983f5de87e54c7965b07fd36232526c8e3da26e4ac2f40b729e6f701924d9371872adeaafd780937eb9a750af95c8f6cb59b9012
-  data.tar.gz: 0c528dbb8a6d4035a754f8b580562c21194a37e999c64f82831aa2c70e0cb53b3687d9e94bbcaf67fe7ca1526f96232b87bb77a4dac1d017b30dcca080c9315d
+  metadata.gz: 0a1a404ac38a7ee8a257bcd97f9e32c25d990b7ba61e9fb4226fe49862934aa7bfbf00e947b39981903a42e54ce232dad508faaadac1b9724ccb7ce01236bdca
+  data.tar.gz: 7cb20aec2cc044cca21d3010cf80da5f3ce902b269b72ffa6739bb61f4abb5fac32e95d57faef5d18c98fc27603704420ae1deb9250cdbf52ba8d5d937c75851

data/Gemfile

@@ -1,5 +1,11 @@
 source 'https://rubygems.org'
 
+gemspec
+
 gem 'rack-test'
 gem 'minitest'
-gemspec
+gem "rails"
+gem "pg"
+gem "climate_control"
+gem "minitest-around"
+gem "m"

data/README.md

@@ -1,23 +1,25 @@
 [![Test](https://github.com/superfly/fly-ruby/actions/workflows/test.yml/badge.svg)](https://github.com/superfly/fly-ruby/actions/workflows/test.yml)
 
-# Augment Ruby web apps on Fly.io
+This gem contains helper code and Rack middleware for deploying Ruby web apps on [Fly.io](https://fly.io). Supported features:
 
-[Fly.io](https://fly.io) offers a number of native features that can improve the perceived speed and observability of web applications with minimal configuration. This gem automates some of the work required to take advantage of these features.
+* Speed up apps by using region-local Postgresql replicas for database reads
 
-## Regional replicas 
+## Speed up apps using region-local database replicas
 
-Running database replicas alongside your apps in multiple regions [is quick and easy with Fly's Postgresql cluster](https://fly.io/docs/getting-started/multi-region-databases/). This can increase the perceived speed of read-heavy applications.
+Fly's cross-region private networking makes it easy to run database replicas [alongside your app instances in multiple regions](https://fly.io/docs/getting-started/multi-region-databases/). These replicas can be used for faster reads, leading to faster application performance.
 
-The catch: in most primary/replica setups, you have one writeable primary located in a specific region. Fly solves this by allowing requests to be *replyed*, at the routing layer, in another region.
+Writes, however, will be slow if performed across regions. Fly allows web apps to specify that a request be *replayed*, at the routing layer, in another region.
 
-This repository includes the `fly-ruby` gem which will utomatcally route requests that write to the database to the primary region. It should work
-with any Rack-compatible Ruby framework.
+This gem includes Rack middleware to automatically route such requests to the primary region. It's designed should work with any Rack-compatible Ruby framework.
 
 Currently, it does this by:
 
 * modifying the `DATABASE_URL` to point apps to their local regional replica
 * replaying non-idempotent (post/put/patch/delete) requests in the primary region
-* catching Postgresql exceptions caused by writes to a read-only replica, and replaying these requests in the primary region
+* catching Postgresql exceptions caused by writes to a read-only replica, and asking for
+  these requests to be replayed in the primary region
+* replaying all requests within a time threshold after a write, to avoid users seeing
+  their own stale data due to replication lag
 
 ## Requirements
 
@@ -35,7 +37,7 @@ Add to your Gemfile and `bundle install`:
 
 `gem "fly-ruby"`
 
-If you're on Rails, the middleware will insert itself automatically at the top of the Rack middleware stack.
+If you're on Rails, the middleware will insert itself automatically, and attempt to reconnect the database.
 
 ## Configuration
 
@@ -52,7 +54,7 @@ See [the source code](https://github.com/soupedup/fly-rails/blob/main/lib/fly-ra
 
 This middleware send all requests to the primary if you do something like update a user's database session on every GET request.
 
-If your replica becomes writeable for some reason, your custer may get out of sync.
+If your replica becomes writeable for some reason, your cluster may get out of sync.
 
 ## TODO
 

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require_relative "lib/fly-ruby/version"
 
 Rake::TestTask.new do |t|
   t.libs << "test"
@@ -10,7 +11,15 @@ end
 desc "Run tests"
 task default: :test
 
-
 task :top do
   puts Rake.application.top_level_tasks
 end
+
+task :publish do
+  version = Fly::VERSION
+  puts "Publishing fly-ruby #{version}..."
+  sh "git tag -f v#{version}"
+  sh "gem build"
+  sh "gem push fly-ruby-#{version}.gem"
+  sh "git push --tags"
+end

data/lib/fly-ruby/configuration.rb

@@ -24,6 +24,8 @@ module Fly
     # primary region after a successful write replay
     attr_accessor :replay_threshold_in_seconds
 
+    attr_accessor :database_url
+
     def initialize
       self.primary_region = ENV["PRIMARY_REGION"]
       self.current_region = ENV["FLY_REGION"]
@@ -33,14 +35,39 @@ module Fly
       self.database_port_env_var = "DATABASE_PORT"
       self.replay_threshold_cookie = "fly-replay-threshold"
       self.replay_threshold_in_seconds = 5
+      self.database_url = ENV[database_url_env_var]
+    end
+
+    def regional_database_uri
+      @uri ||= URI.parse(database_url)
+      @uri
     end
 
-    def database_url
-      ENV[database_url_env_var]
+    # Rails-compatible database configuration
+    def regional_database_config
+      {
+        "host" => "#{current_region}.#{regional_database_uri.hostname}",
+        "port" => 5433,
+        "adapter" => "postgresql"
+      }
     end
 
     def eligible_for_activation?
-      database_url && primary_region && current_region
+      database_url && primary_region && current_region && web?
+    end
+
+    # Is the current process a Rails console?
+    def console?
+      defined?(::Rails::Console) && $stdout.isatty && $stdin.isatty
+    end
+
+    # Is the current process a rake task?
+    def rake_task?
+      defined?(::Rake) && !Rake.application.top_level_tasks.empty?
+    end
+
+    def web?
+      !console? && !rake_task?
     end
   end
 end

data/lib/fly-ruby/railtie.rb

@@ -1,8 +1,28 @@
+require_relative '../fly-ruby'
+
 class Fly::Railtie < Rails::Railtie
   initializer("fly.regional_database") do |app|
     if Fly.configuration.eligible_for_activation?
+      # Run the middleware high in the stack, but after static file delivery
       app.config.middleware.insert_after ActionDispatch::Executor, Fly::RegionalDatabase
-    elsif !ENV["TESTING"]
+
+      ActiveSupport::Reloader.to_prepare do
+        # If we already have a database connection when this initializer runs,
+        # we should reconnect to the region-local database. This may need some additional
+        # hooks for forking servers to work correctly.
+        if defined?(ActiveRecord) && ActiveRecord::Base.connected?
+          config = ActiveRecord::Base.connection_db_config.configuration_hash
+          ActiveRecord::Base.establish_connection(config.merge(Fly.configuration.regional_database_config))
+        end
+
+        # Set useful headers for debugging
+        ::ApplicationController.send(:after_action) do
+          response.headers['Fly-Region'] = ENV['FLY_REGION']
+          response.headers['Fly-Database-Host'] = Fly.configuration.regional_database_config["host"]
+        end
+      end
+
+    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."
     end
   end

data/lib/fly-ruby/regional_database.rb

@@ -8,33 +8,23 @@ module Fly
   class RegionalDatabase
     def initialize(app)
       @app = app
-      prefer_regional_database! unless in_primary_region?
     end
 
-    def console?
-      defined?(::Rails::Console) && $stdout.isatty && $stdin.isatty
-    end
-
-    def rake_task?
-      defined?(::Rake) && !Rake.application.top_level_tasks.empty?
-    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.
 
-    # Overwrite the primary database URL with that of the regional replica
     def prefer_regional_database!
-      # Don't override the database if migrations are running
-      return if console? || rake_task?
-
-      uri = URI.parse(Fly.configuration.database_url)
-      hostname = "#{Fly.configuration.current_region}.#{uri.hostname}"
-      port = 5433
+      return if Fly.configuration.web?
 
-      uri.hostname = hostname
-      uri.port = port
-      uri.to_s
+      uri = Fly.configuration.database_uri
 
       ENV[Fly.configuration.database_url_env_var] = uri.to_s
-      ENV[Fly.configuration.database_host_env_var] = hostname
-      ENV[Fly.configuration.database_port_env_var] = port.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?

data/lib/fly-ruby/version.rb

@@ -1,3 +1,3 @@
-class Fly
-  VERSION = "0.1.1"
+module Fly
+  VERSION = "0.2.0"
 end

metadata

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