quilt_rails 1.9.2 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19ed91c686fab67ad1642a071a8d62214c154c246cf4d8cb4027ac3a50483620
-  data.tar.gz: 73ad8104d3e54a5b3ba56aa912fa7147eaeab671f75e310c5dd1dcb6d297471b
+  metadata.gz: f4580b1b1870a7fb2afa9bc64bab975e8ec3c7041f775de16356d31151ab4768
+  data.tar.gz: 8914278b57d9bb8bad32c33c2e9697289073fe80576248b08bfe60f0b6f2536d
 SHA512:
-  metadata.gz: 10618fcc4252375f45e54b98ed366c47fa06de9541b57e748081dab0ba66d0817f78e38c4d3a8e23315f2402c79d4dde5c86c85132e3b7e97534a0165166fee0
-  data.tar.gz: 838be176ef13ae501f40c2eb6763a7d0416d42ce6908650dd03ecfdcc6039dc35d7769518b60f977dda0d3fa81cffc10a7e6656beeda9e510c74e4c5587d0321
+  metadata.gz: e908b7d01e781f43ccf9c3a21d595aef8fffb612fe5da76d29f1cbef9a635ef5cbd8b8b29e6e9cbd8a9bdf170ac7fbabe7a4e0c8880a3bd81a90fde2d2da5a03
+  data.tar.gz: 66fe45a859a30dde3a31e76563cb6d5ef5c0d6621f9127cb1a41c270dde190b47227a5d31bcca81bdb26098e172a67e811d7c58c551a74fa8b7d6d8e0d1968bb

data/README.md

@@ -300,6 +300,67 @@ function App() {
 export default App;
 ```
 
+##### Example: sending headers from Rails controller
+
+```ruby
+class ReactController < ApplicationController
+  include Quilt::ReactRenderable
+
+  def index
+    render_react(headers: { 'x-custom-header': 'header-value-a' })
+  end
+end
+```
+
+You will need to serialize the result of the useRequestHeader hook in order for it to persist to the client
+
+```tsx
+// app/ui/foundation/CustomUniversalProvider.tsx
+import {createContext} from 'react';
+import {createUniversalProvider} from '@shopify/react-universal-provider';
+
+export const CustomContext = createContext<string | null>(null);
+export const CustomUniversalProvider = createUniversalProvider('custom-key', CustomContext);
+```
+
+```tsx
+// app/ui/index.tsx
+
+import React from 'react';
+import {useRequestHeader} from '@shopify/react-network';
+import {CustomUniversalProvider} from './foundation/CustomUniversalProvider';
+import {ComponentWithCustomHeader} from './components/ComponentWithCustomHeader';
+
+function App() {
+  // get `x-custom-header` from the request that was sent through Rails ReactController
+  const customHeader = useRequestHeader('x-custom-header');
+
+  return (
+    <CustomUniversalProvider value={customHeader}>
+      <h1>My application ❤️</h1>
+      <ComponentWithCustomHeader />
+    </CustomUniversalProvider>
+  );
+}
+
+export default App;
+```
+
+```tsx
+// app/ui/components/ComponentWithCustomHeader.tsx
+
+import React, {useContext} from 'react';
+import {CustomContext} from '../foundation/CustomUniversalProvider';
+
+export function ComponentWithCustomHeader() {
+  // get `x-custom-header` from serialized context
+  // will be 'header-value-a' in this example
+  const customHeader = useContext(CustomContext);
+
+  return <span>{customHeader}</span>;
+}
+```
+
 ##### Example: redirecting
 
 ```tsx

data/lib/quilt_rails/react_renderable.rb

@@ -6,34 +6,38 @@ module Quilt
   module ReactRenderable
     include ReverseProxy::Controller
 
-    def render_react
+    def render_react(headers: {})
       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
+        call_proxy(headers)
       end
     end
 
     private
 
-    def call_proxy
+    def call_proxy(headers)
       if defined? ShopifySecurityBase
         ShopifySecurityBase::HTTPHostRestriction.whitelist([Quilt.configuration.react_server_host]) do
-          proxy
+          proxy(headers)
         end
       else
-        proxy
+        proxy(headers)
       end
     end
 
-    def proxy
+    def proxy(headers)
       url = "#{Quilt.configuration.react_server_protocol}://#{Quilt.configuration.react_server_host}"
       Quilt::Logger.log("[ReactRenderable] proxying to React server at #{url}")
 
+      unless headers.blank?
+        Quilt::Logger.log("[ReactRenderable] applying custom headers #{headers.inspect}")
+      end
+
       begin
-        reverse_proxy(url, headers: { 'X-CSRF-Token': form_authenticity_token }) do |callbacks|
+        reverse_proxy(url, headers: headers.merge('X-CSRF-Token': form_authenticity_token)) do |callbacks|
           callbacks.on_response do |status_code, _response|
             Quilt::Logger.log("[ReactRenderable] #{url} returned #{status_code}")
           end

data/lib/quilt_rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quilt_rails
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.10.0
 platform: ruby
 authors:
 - Mathew Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2020-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties