fly-ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59f0a5a6d3bbfc27e9440a2a96f230b662d42628c0d520df2cfb8269ada04a33
-  data.tar.gz: b21db455e7927c6c10219db01d2ba38fe24c258b3bfe454fd5f25212b95e78c5
+  metadata.gz: 79850f3de9e2a7e78ff9d46ba7728c605fae5651786d3a425dec0d12056d75b6
+  data.tar.gz: 5349dfbb16a8a257a909c68410f2041bf5202bbeed5ae88e496a9efa2e1c9478
 SHA512:
-  metadata.gz: 0a1a404ac38a7ee8a257bcd97f9e32c25d990b7ba61e9fb4226fe49862934aa7bfbf00e947b39981903a42e54ce232dad508faaadac1b9724ccb7ce01236bdca
-  data.tar.gz: 7cb20aec2cc044cca21d3010cf80da5f3ce902b269b72ffa6739bb61f4abb5fac32e95d57faef5d18c98fc27603704420ae1deb9250cdbf52ba8d5d937c75851
+  metadata.gz: e43ad67e8d81f5d817ad274bb0f2e2a97d276fc1a9f0bb78549ea6cc06b5c2e5a90fd2ddd03f7529f592cf037bed68ed9f172945425829b7952acbdd4c20df58
+  data.tar.gz: d91c4fd6e1a5d3619165c9a44076840ac331c8533f0cb94f34001022d987bca1f7b654de34668cc6029305341f39bc7caa22b31ad76968802261fd884816b878

data/.github/workflows/test.yml

@@ -7,12 +7,35 @@ jobs:
     strategy:
       matrix:
         include:
-          - { os: ubuntu-latest, ruby_version: 2.4 }
           - { os: ubuntu-latest, ruby_version: 2.5 }
           - { os: ubuntu-latest, ruby_version: 2.6 }
           - { os: ubuntu-latest, ruby_version: 2.7 }
           - { os: ubuntu-latest, ruby_version: '3.0' }
-          - { os: ubuntu-latest, ruby_version: jruby }
+    services:
+    # label used to access the service container
+      postgres:
+        # Docker Hub image
+        image: postgres:latest
+        # service environment variables
+        # `POSTGRES_HOST` is `postgres`
+        env:
+          # optional (defaults to `postgres`)
+          POSTGRES_DB: fly_ruby_test
+          # required
+          POSTGRES_PASSWORD: postgres_password
+          # optional (defaults to `5432`)
+          POSTGRES_PORT: 5432
+          # optional (defaults to `postgres`)
+          POSTGRES_USER: postgres_user
+        ports:
+          # maps tcp port 5432 on service container to the host
+          - 5432:5432
+        # set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
     steps:
     - name: Setup Ruby, JRuby and TruffleRuby
       uses: ruby/setup-ruby@v1.75.0
@@ -22,6 +45,8 @@ jobs:
     - name: Checkout code
       uses: actions/checkout@v2
     - name: Run tests
+      env:
+        DATABASE_USER: postgres_user
       run: |
         bundle install --jobs 4 --retry 3
         rake

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.2.1
+
+### Bug fixes
+
+- Only hijack the database connection for requests in secondary regions
+
+## 0.2.0
+
+### Features
+
+- Add `Fly-Region` and `Fly-Database-Host` response headers for easier debugging

data/README.md

@@ -6,7 +6,7 @@ This gem contains helper code and Rack middleware for deploying Ruby web apps on
 
 ## Speed up apps using region-local database replicas
 
-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.
+Fly's [cross-region private networking](https://fly.io/docs/reference/privatenetwork/) 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 and application performance.
 
 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.
 

data/lib/fly-ruby/configuration.rb

@@ -56,6 +56,10 @@ module Fly
       database_url && primary_region && current_region && web?
     end
 
+    def in_secondary_region?
+      primary_region && primary_region != current_region
+    end
+
     # Is the current process a Rails console?
     def console?
       defined?(::Rails::Console) && $stdout.isatty && $stdin.isatty

data/lib/fly-ruby/railtie.rb

@@ -1,27 +1,35 @@
 require_relative '../fly-ruby'
 
 class Fly::Railtie < Rails::Railtie
+  def hijack_database_connection
+    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)
+        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
+    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"]
+    end
+  end
+
   initializer("fly.regional_database") do |app|
+    set_debug_response_headers
     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
 
-      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
-
+      # Run the middleware high in the stack, but after static file delivery
+      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."
     end

data/lib/fly-ruby/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fly-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Joshua Sierles
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/test.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md