quilt_rails 3.5.5 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 592c0b080cb38e2f3441388b089c9de398f1ac6d9a8374fcc0e07497d3105311
-  data.tar.gz: f24e29204dbd946dd4c97182f7e61888e769790097295443f8c8f1bcb8ba46e0
+  metadata.gz: fff813b5d675694dfec8b04064856c359aa0462cce93078b459253cde856abc7
+  data.tar.gz: 949129ceeba74281875f07c81e677e09121bfb55b9ca8a34b4391470b51c9524
 SHA512:
-  metadata.gz: fae414a9e0d56917e5bbe809e21eda522215a182bb144f8849c1cdf27eb6c7b1514e400e8b51e30ee6de798ac296e29e083b964dd94068f0e6908b8c7f938d01
-  data.tar.gz: 9de5aa59ffee287534e46e13c430d4400e78e70953fd363cd60fb7d9b8069e2b4c8ca33f5ccfdb811b98859a5058c60cc6d1f8f19a48a025d3d97a90f351c365
+  metadata.gz: dd0bb599660139c21c7931f65b43fd031cebcb9faf4965983e46aab8a08bd52f7560a14583e4e2ee18a04de9f79997ea01132d7f50ccf699773563beda356805
+  data.tar.gz: bc962fca99d3b892e5178f11b437dd64e8c1462d1a6d62ae52fdc2282fd2ddb924237fbbad028c1dba9c880b8eee6d65086d74907066c0feb4c501f9a30fa7ad

data/README.md

@@ -20,6 +20,8 @@ A turn-key solution for integrating [Quilt](https://github.com/Shopify/quilt) cl
     - [Fixing rejected CSRF tokens for new user sessions](#fixing-rejected-csrf-tokens-for-new-user-sessions)
 - [Performance tracking a React app](#performance-tracking-a-react-app)
 - [API](#api)
+- [Shopify embedded app](#shopify-embedded-app)
+- [FAQ](#faq)
 
 ## Server-side-rendering
 
@@ -315,6 +317,20 @@ Follow details guide [here](./docs/performance-tracking.md).
 
 Find all features this gem offer in this [API doc](./docs/api.md).
 
+## Shopify embedded app
+
+[See here for Dev Docs for Apps](https://shopify.dev/apps). Make sure to add the line: `include ShopifyApp::EmbeddedApp` if you are using Quilt for server-side rendering of React for an embedded application:
+
+```ruby
+class ReactController < ApplicationController
+  include ShopifyApp::EmbeddedApp
+  include Quilt::ReactRenderable
+  def index
+    render_react
+  end
+end
+```
+
 ## FAQ
 
 Find your [here](./docs/FAQ.md).

data/Rakefile

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
 Bundler::GemHelper.install_tasks
 
-require File.expand_path('../test/dummy/config/application', __FILE__)
+require File.expand_path("../test/dummy/config/application", __FILE__)
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
 end
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.name = 'test:unit'
-  t.pattern = 'test/quilt_rails/**/*_test.rb'
+  t.libs << "test"
+  t.name = "test:unit"
+  t.pattern = "test/quilt_rails/**/*_test.rb"
 end
 
-task(default: %i(test))
+task(default: [:test])

data/config/routes.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Quilt::Engine.routes.draw do
-  post '/performance_report', to: 'performance_report#create'
-  get '/*path', to: 'ui#index'
-  root 'ui#index'
+  post "/performance_report", to: "performance_report#create"
+  get "/*path", to: "ui#index"
+  root "ui#index"
 end

data/lib/generators/quilt/rails_setup/rails_setup_generator.rb

@@ -2,7 +2,7 @@
 
 module Quilt
   class RailsSetupGenerator < Rails::Generators::Base
-    source_root File.expand_path('templates', __dir__)
+    source_root File.expand_path("templates", __dir__)
 
     desc "This generator mounts the Quilt engine and add Procfile."
 

data/lib/generators/quilt/rails_setup/templates/routes.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 Rails.application.routes.draw do
-  mount Quilt::Engine, at: '/'
+  mount Quilt::Engine, at: "/"
 end

data/lib/generators/quilt/react_app/react_app_generator.rb

@@ -2,7 +2,7 @@
 
 module Quilt
   class ReactAppGenerator < Rails::Generators::Base
-    source_root File.expand_path('templates', __dir__)
+    source_root File.expand_path("templates", __dir__)
 
     desc "This generator adds a React app."
 

data/lib/generators/quilt/react_setup/react_setup_generator.rb

@@ -2,7 +2,7 @@
 
 module Quilt
   class ReactSetupGenerator < Rails::Generators::Base
-    source_root File.expand_path('templates', __dir__)
+    source_root File.expand_path("templates", __dir__)
     class_option :skip_yarn, type: :boolean, default: false
 
     desc "This generator adds a React app."

data/lib/quilt_rails/configuration.rb

@@ -6,11 +6,11 @@ module Quilt
   class Configuration < ActiveSupport::OrderedOptions
     def initialize
       super
-      react_server_ip   = ENV['REACT_SERVER_IP'] || "localhost"
-      react_server_port = ENV['REACT_SERVER_PORT'] || 8081
+      react_server_ip   = ENV["REACT_SERVER_IP"] || "localhost"
+      react_server_port = ENV["REACT_SERVER_PORT"] || 8081
 
       self.react_server_host     = "#{react_server_ip}:#{react_server_port}"
-      self.react_server_protocol = ENV['REACT_SERVER_PROTOCOL'] || "http"
+      self.react_server_protocol = ENV["REACT_SERVER_PROTOCOL"] || "http"
       self.logger                = ::Logger.new($stdout)
       self.mount                 = true
       self.allow_integration_test = false

data/lib/quilt_rails/engine.rb

@@ -13,7 +13,7 @@ module Quilt
     initializer(:mount_quilt, before: :add_builtin_route) do |app|
       if config.quilt.mount?
         app.routes.append do
-          mount(Quilt::Engine, at: '/') unless has_named_route?(:quilt)
+          mount(Quilt::Engine, at: "/") unless has_named_route?(:quilt)
         end
       end
     end

data/lib/quilt_rails/monkey_patches/active_support_reloader.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'rails'
+
+require "rails"
 
 # The default ActiveSupport::Reloader memoizes `@should_reload` for the
 # lifetime of each request. This is a problem for quilt_rails apps because:

data/lib/quilt_rails/performance/event.rb

@@ -4,17 +4,17 @@ module Quilt
   module Performance
     class Event
       TYPE = {
-        time_to_first_byte: 'ttfb',
-        time_to_first_paint: 'ttfp',
-        time_to_first_contentful_paint: 'ttfcp',
-        dom_content_loaded: 'dcl',
-        first_input_delay: 'fid',
-        load: 'load',
-        long_task: 'longtask',
-        usable: 'usable',
-        graphql: 'graphql',
-        script_download: 'script',
-        style_download: 'style',
+        time_to_first_byte: "ttfb",
+        time_to_first_paint: "ttfp",
+        time_to_first_contentful_paint: "ttfcp",
+        dom_content_loaded: "dcl",
+        first_input_delay: "fid",
+        load: "load",
+        long_task: "longtask",
+        usable: "usable",
+        graphql: "graphql",
+        script_download: "script",
+        style_download: "style",
       }
 
       attr_accessor :type

data/lib/quilt_rails/performance/navigation.rb

@@ -74,6 +74,7 @@ module Quilt
         events_with_size.reduce(nil) do |total, current|
           current_size = current.metadata.size
           return current_size + total unless total.nil?
+
           current_size
         end
       end

data/lib/quilt_rails/performance/report.rb

@@ -10,7 +10,7 @@ module Quilt
       class << self
         def from_params(params)
           params.transform_keys! { |key| key.underscore.to_sym }
-          params[:connection] = { effectiveType: 'unknown' } if params[:connection].blank?
+          params[:connection] = { effectiveType: "unknown" } if params[:connection].blank?
 
           connection = Connection.from_params(params[:connection])
 

data/lib/quilt_rails/performance/reportable.rb

@@ -10,7 +10,7 @@ module Quilt
       private
 
       def normalized_params
-        return params unless request.content_type == 'text/plain'
+        return params unless request.content_type == "text/plain"
 
         ActionController::Parameters.new(JSON.parse(request.body.read))
       end

data/lib/quilt_rails/performance.rb

@@ -12,19 +12,19 @@ require "quilt_rails/performance/reportable"
 module Quilt
   module Performance
     LIFECYCLE = {
-      time_to_first_byte: 'time_to_first_byte',
-      time_to_first_contentful_paint: 'time_to_first_contentful_paint',
-      time_to_first_paint: 'time_to_first_paint',
-      dom_content_loaded: 'dom_content_loaded',
-      first_input_delay: 'first_input_delay',
-      load: 'dom_load',
+      time_to_first_byte: "time_to_first_byte",
+      time_to_first_contentful_paint: "time_to_first_contentful_paint",
+      time_to_first_paint: "time_to_first_paint",
+      dom_content_loaded: "dom_content_loaded",
+      first_input_delay: "first_input_delay",
+      load: "dom_load",
     }
 
     NAVIGATION = {
-      complete: 'navigation_complete',
-      usable: 'navigation_usable',
-      download_size: 'navigation_download_size',
-      cache_effectiveness: 'navigation_cache_effectiveness',
+      complete: "navigation_complete",
+      usable: "navigation_usable",
+      download_size: "navigation_download_size",
+      cache_effectiveness: "navigation_cache_effectiveness",
     }
   end
 end

data/lib/quilt_rails/react_renderable.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rails-reverse-proxy'
+require "rails-reverse-proxy"
 
 module Quilt
   module ReactRenderable
@@ -22,7 +22,9 @@ module Quilt
 
     def call_proxy(headers, data)
       if defined? ShopifySecurityBase
+        # rubocop:disable Naming/InclusiveLanguage
         allowlist = ShopifySecurityBase::HTTPHostRestriction.respond_to?(:allowlist) ? :allowlist : :whitelist
+        # rubocop:enable Naming/InclusiveLanguage
         ShopifySecurityBase::HTTPHostRestriction.send(allowlist, [Quilt.configuration.react_server_host]) do
           proxy(headers, data)
         end
@@ -43,12 +45,8 @@ module Quilt
         data_json = JSON.generate(data.as_json, ascii_only: true)
         reverse_proxy(
           url,
-          headers: headers.merge('X-Request-ID': request.request_id, 'X-Quilt-Data': data_json)
-        ) do |callbacks|
-          callbacks.on_response do |status_code, _response|
-            Quilt.logger.info("[ReactRenderable] #{url} returned #{status_code}")
-          end
-        end
+          headers: headers.merge("X-Request-ID": request.request_id, "X-Quilt-Data": data_json)
+        )
       rescue Errno::ECONNREFUSED
         raise ReactServerNoResponseError, url
       end

data/lib/quilt_rails/trusted_ui_server_csrf_strategy.rb

@@ -15,7 +15,7 @@ module Quilt
     private
 
     def node_server_side_render?
-      @controller.request.headers['x-shopify-server-side-rendered'] == '1'
+      @controller.request.headers["x-shopify-server-side-rendered"] == "1"
     end
 
     def fallback_handler

data/lib/quilt_rails/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Quilt
-  VERSION = "3.5.5"
+  VERSION = "3.6.0"
 end

data/lib/quilt_rails.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Quilt
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quilt_rails
 version: !ruby/object:Gem::Version
-  version: 3.5.5
+  version: 3.6.0
 platform: ruby
 authors:
 - Mathew Allen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -42,14 +42,14 @@ dependencies:
   name: rails-reverse-proxy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
@@ -66,20 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '1.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '1.28'
 - !ruby/object:Gem::Dependency
   name: rubocop-git
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description: A turn-key solution for integrating server-rendered React into your Rails
   app using Quilt libraries.
 email:
@@ -142,7 +170,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,8 +185,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
-signing_key: 
+rubygems_version: 3.5.14
+signing_key:
 specification_version: 4
 summary: A turn-key solution for integrating server-rendered React into your Rails
   app using Quilt libraries.