quilt_rails 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cb007cf5708ce9cc49b8eea19e79e8922faeaddf91223348962242c1ce03a8f
-  data.tar.gz: d351101e370001003ce4f75c613922c72263998fad1d449f29ac023584112284
+  metadata.gz: 7327df33398c0cf113388e765ed893ba61d6d90c0eeec85989a52f0974da4d77
+  data.tar.gz: c99c5ae5c7cfc371e7687741fcd36fed8dfa002d64d9f52eeacb8d27598c5c08
 SHA512:
-  metadata.gz: dc19e93667fc50d44613cc76d6a63ede39cd7b855850ab9c6e3257637754b066969351d17421f244ac5c6ffe75ee33f9e9363ab546f89bf80269ad3ffecb2840
-  data.tar.gz: 61c9d32098b159d7a0b940b96ba02eb274e53dae54e252a25a6ed430c9446cbda9859e9e7ca15808f464833f015a1e32c6bf6e23d5addcdcc0a9c70bb5c49b62
+  metadata.gz: '09c0e63254e5c3e18ac56a52eb28470fd5994a8c1887052d26c2b385391f5fe9ba294f3afd43e8942a039bb5a4d12fab2746e38a1f924de8c920f08c67e1176c'
+  data.tar.gz: d97df6949379a1ec9a6f7ae9636f7008f0a791065a37ba6e5715bf0f489ce7bb7135a44817f6fb5ea4915b1cfea7810fe75f9f54db807b79f5d14c3fbd014315

data/lib/quilt_rails/monkey_patches/active_support_reloader.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require 'rails'
+
+# The default ActiveSupport::Reloader memoizes `@should_reload` for the
+# lifetime of each request. This is a problem for quilt_rails apps because:
+# - QuiltRails::ReactRenderable#render holds an exclusive lock until the Node
+#   server returns a result
+# - Any controller calls during Node rendering (e.g., GraphQL fetches) will
+#   hang if they try to obtain a lock
+# - Class unloading needs a lock, and so nested controller calls risk
+#   deadlocking whenever @should_reload is true
+#
+# Forcing `@should_reload` evaluation at the start of each thread prevents
+# nested controller calls from attempting class unloading.  This eliminates
+# one source of lock contention.
+#
+# The affected flow is:
+# - A developer saves a change to a Ruby file
+# - The developer refreshes their browser
+#
+# Rails processes the request:
+# - Thread0 - ActiveSupport::Reloader is called by middleware
+# - Thread0 - An exclusive class unloader lock is obtained, classes are
+#             unloaded, and the lock is released
+# - Thread0 - `Quilt::ReactRenderable#render_react` calls `reverse_proxy`,
+#             which grabs a general exclusive lock
+# - Node    - starts rendering, and calls out to a Rails controller for data
+# - Thread1 - ActiveSupport::Reloader is called by the second controller's
+#             middleware
+# - Thread1 - `@should_reload` is still true, so an attempt is made to grab an
+#              exclusive class unloader lock
+# - Thread1 - waits for Thread0 to release its lock; Thread0 never unlocks
+#             because it needs Thread1's result
+#
+module ActiveSupport
+  class Reloader
+    def self.check! # :nodoc:
+      @should_reload = check.call
+    end
+  end
+end

data/lib/quilt_rails/react_renderable.rb

@@ -9,6 +9,16 @@ module Quilt
     def render_react
       raise DoNotIntegrationTestError if Rails.env.test?
 
+      # Allow concurrent loading to prevent this thread from blocking class
+      # loading in controllers called by the Node server.
+      ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+        call_proxy
+      end
+    end
+
+    private
+
+    def call_proxy
       if defined? ShopifySecurityBase
         ShopifySecurityBase::HTTPHostRestriction.whitelist([Quilt.configuration.react_server_host]) do
           proxy
@@ -18,8 +28,6 @@ module Quilt
       end
     end
 
-    private
-
     def proxy
       url = "#{Quilt.configuration.react_server_protocol}://#{Quilt.configuration.react_server_host}"
       Quilt::Logger.log("[ReactRenderable] proxying to React server at #{url}")

data/lib/quilt_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Quilt
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

data/lib/quilt_rails.rb

@@ -8,3 +8,4 @@ require "quilt_rails/logger"
 require "quilt_rails/configuration"
 require "quilt_rails/react_renderable"
 require "quilt_rails/trusted_ui_server_csrf_strategy"
+require "quilt_rails/monkey_patches/active_support_reloader" if Rails.env.development?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quilt_rails
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Mathew Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-18 00:00:00.000000000 Z
+date: 2019-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -89,6 +89,7 @@ files:
 - lib/quilt_rails/configuration.rb
 - lib/quilt_rails/engine.rb
 - lib/quilt_rails/logger.rb
+- lib/quilt_rails/monkey_patches/active_support_reloader.rb
 - lib/quilt_rails/react_renderable.rb
 - lib/quilt_rails/trusted_ui_server_csrf_strategy.rb
 - lib/quilt_rails/version.rb