Merge pull request #277 from inertiajs/fix-for-shared-scroll-and-deferred-props

Fix for shared scroll and deferred props

Author: bknoles

lib/inertia_rails/renderer.rb

@@ -6,15 +6,15 @@
 
 module InertiaRails
   class Renderer
-    attr_reader(
-      :component,
-      :configuration,
-      :controller,
-      :props,
-      :view_data,
-      :encrypt_history,
-      :clear_history
-    )
+    %i[component configuration controller props view_data encrypt_history
+       clear_history].each do |method_name|
+      define_method(method_name) do
+        InertiaRails.deprecator.warn(
+          "[DEPRECATION] Accessing `InertiaRails::Renderer##{method_name}` is deprecated and will be removed in v4.0"
+        )
+        instance_variable_get("@#{method_name}")
+      end
+    end
 
     def initialize(component, controller, request, response, render_method, **options)
       if component.is_a?(Hash) && options.key?(:props)
@@ -24,15 +24,20 @@ def initialize(component, controller, request, response, render_method, **option
 
       @controller = controller
       @configuration = controller.__send__(:inertia_configuration)
-      @component = resolve_component(component)
       @request = request
       @response = response
       @render_method = render_method
-      @props = options.fetch(:props, component.is_a?(Hash) ? component : controller.__send__(:inertia_view_assigns))
       @view_data = options.fetch(:view_data, {})
-      @deep_merge = options.fetch(:deep_merge, configuration.deep_merge_shared_data)
-      @encrypt_history = options.fetch(:encrypt_history, configuration.encrypt_history)
+      @encrypt_history = options.fetch(:encrypt_history, @configuration.encrypt_history)
       @clear_history = options.fetch(:clear_history, controller.session[:inertia_clear_history] || false)
+
+      deep_merge = options.fetch(:deep_merge, @configuration.deep_merge_shared_data)
+      passed_props = options.fetch(:props,
+                                   component.is_a?(Hash) ? component : @controller.__send__(:inertia_view_assigns))
+      @props = merge_props(shared_data, passed_props, deep_merge)
+
+      @component = resolve_component(component)
+
       @controller.instance_variable_set('@_inertia_rendering', true)
       controller.inertia_meta.add(options[:meta]) if options[:meta]
     end
@@ -48,41 +53,41 @@ def render
         @render_method.call json: page.to_json, status: @response.status, content_type: Mime[:json]
       else
         begin
-          return render_ssr if configuration.ssr_enabled
+          return render_ssr if @configuration.ssr_enabled
         rescue StandardError
           nil
         end
-        controller.instance_variable_set('@_inertia_page', page)
-        @render_method.call template: 'inertia', layout: layout, locals: view_data.merge(page: page)
+        @controller.instance_variable_set('@_inertia_page', page)
+        @render_method.call template: 'inertia', layout: layout, locals: @view_data.merge(page: page)
       end
     end
 
     private
 
     def render_ssr
-      uri = URI("#{configuration.ssr_url}/render")
+      uri = URI("#{@configuration.ssr_url}/render")
       res = JSON.parse(Net::HTTP.post(uri, page.to_json, 'Content-Type' => 'application/json').body)
 
-      controller.instance_variable_set('@_inertia_ssr_head', res['head'].join.html_safe)
-      @render_method.call html: res['body'].html_safe, layout: layout, locals: view_data.merge(page: page)
+      @controller.instance_variable_set('@_inertia_ssr_head', res['head'].join.html_safe)
+      @render_method.call html: res['body'].html_safe, layout: layout, locals: @view_data.merge(page: page)
     end
 
     def layout
-      layout = configuration.layout
+      layout = @configuration.layout
       layout.nil? || layout
     end
 
     def shared_data
-      controller.__send__(:inertia_shared_data)
+      @controller.__send__(:inertia_shared_data)
     end
 
     # Cast props to symbol keyed hash before merging so that we have a consistent data structure and
     # avoid duplicate keys after merging.
     #
     # Functionally, this permits using either string or symbol keys in the controller. Since the results
     # is cast to json, we should treat string/symbol keys as identical.
-    def merge_props(shared_props, props)
-      if @deep_merge
+    def merge_props(shared_props, props, deep_merge)
+      if deep_merge
         shared_props.deep_symbolize_keys.deep_merge!(props.deep_symbolize_keys)
       else
         shared_props.symbolize_keys.merge(props.symbolize_keys)
@@ -91,16 +96,15 @@ def merge_props(shared_props, props)
 
     def computed_props
       # rubocop:disable Style/MultilineBlockChain
-      merge_props(shared_data, props)
-        .then do |merged_props| # Always keep errors in the props
+      @props
+        .tap do |merged_props| # Always keep errors in the props
           if merged_props.key?(:errors) && !merged_props[:errors].is_a?(BaseProp)
             errors = merged_props[:errors]
             merged_props[:errors] = InertiaRails.always { errors }
           end
-          merged_props
         end
         .then { |props| deep_transform_props(props) } # Internal hydration/filtering
-        .then { |props| configuration.prop_transformer(props: props) } # Apply user-defined prop transformer
+        .then { |props| @configuration.prop_transformer(props: props) } # Apply user-defined prop transformer
         .tap do |props| # Add meta tags last (never transformed)
         props[:_inertia_meta] = meta_tags if meta_tags.present?
       end
@@ -111,12 +115,12 @@ def page
       return @page if defined?(@page)
 
       @page = {
-        component: component,
+        component: @component,
         props: computed_props,
         url: @request.original_fullpath,
-        version: configuration.version,
-        encryptHistory: encrypt_history,
-        clearHistory: clear_history,
+        version: @configuration.version,
+        encryptHistory: @encrypt_history,
+        clearHistory: @clear_history,
       }
 
       deferred_props = deferred_props_keys
@@ -138,9 +142,9 @@ def deep_transform_props(props, parent_path = [])
           transformed_props[key] =
             case prop
             when BaseProp
-              prop.call(controller)
+              prop.call(@controller)
             when Proc
-              controller.instance_exec(&prop)
+              @controller.instance_exec(&prop)
             else
               prop
             end
@@ -248,12 +252,12 @@ def partial_except_keys
     end
 
     def rendering_partial_component?
-      @request.headers['X-Inertia-Partial-Component'] == component
+      @request.headers['X-Inertia-Partial-Component'] == @component
     end
 
     def resolve_component(component)
       if component == true || component.is_a?(Hash)
-        configuration.component_path_resolver(path: controller.controller_path, action: controller.action_name)
+        @configuration.component_path_resolver(path: @controller.controller_path, action: @controller.action_name)
       else
         component
       end
@@ -289,7 +293,7 @@ def excluded_by_except_partial_keys?(path_with_prefixes)
     end
 
     def meta_tags
-      controller.inertia_meta.meta_tags
+      @controller.inertia_meta.meta_tags
     end
   end
 end

spec/dummy/app/controllers/inertia_render_test_controller.rb

@@ -129,6 +129,17 @@ def deferred_props
     }
   end
 
+  inertia_share only: [:shared_deferred_props] do
+    {
+      grit: InertiaRails.defer { 'intense' },
+    }
+  end
+  def shared_deferred_props
+    render inertia: 'TestComponent', props: {
+      name: 'Brian',
+    }
+  end
+
   def scroll_test
     pagy = (defined?(Pagy::Offset) ? Pagy::Offset : Pagy).new(
       next: 2,
@@ -141,6 +152,21 @@ def scroll_test
     }
   end
 
+  inertia_share only: [:shared_scroll_test] do
+    pagy = (defined?(Pagy::Offset) ? Pagy::Offset : Pagy).new(
+      next: 2,
+      page: 1,
+      count: 100
+    )
+    {
+      users: InertiaRails.scroll(pagy) { [{ id: 1, name: 'User 1' }, { id: 2, name: 'User 2' }] },
+    }
+  end
+
+  def shared_scroll_test
+    render inertia: 'TestComponent'
+  end
+
   def prepend_merge_test
     render inertia: 'TestComponent', props: {
       prepend_prop: InertiaRails.merge(prepend: true) { %w[item1 item2] },

spec/dummy/config/routes.rb

@@ -38,7 +38,9 @@
   get 'except_props' => 'inertia_render_test#except_props'
   get 'merge_props' => 'inertia_render_test#merge_props'
   get 'deferred_props' => 'inertia_render_test#deferred_props'
+  get 'shared_deferred_props' => 'inertia_render_test#shared_deferred_props'
   get 'scroll_test' => 'inertia_render_test#scroll_test'
+  get 'shared_scroll_test' => 'inertia_render_test#shared_scroll_test'
   get 'prepend_merge_test' => 'inertia_render_test#prepend_merge_test'
   get 'nested_paths_test' => 'inertia_render_test#nested_paths_test'
   get 'reset_test' => 'inertia_render_test#reset_test'

spec/inertia/renderer_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+RSpec.describe InertiaRails::Renderer do
+  let(:deprecator) do
+    double(warn: nil).tap do |deprecator|
+      allow(InertiaRails).to receive(:deprecator).and_return(deprecator)
+    end
+  end
+
+  %i[component configuration controller props view_data encrypt_history clear_history].each do |method_name|
+    it "has a deprecated #{method_name} accessor" do
+      configuration = double('configuration',
+                             encrypt_history: true,
+                             deep_merge_shared_data: false,
+                             clear_history: false)
+
+      controller = double('controller',
+                          inertia_configuration: configuration,
+                          inertia_view_assigns: {},
+                          session: {},
+                          inertia_shared_data: {})
+
+      request = double('request', headers: {})
+      response = double('response', headers: {}, set_header: nil)
+      render_method = ->(args) {}
+
+      renderer = InertiaRails::Renderer.new('MyComponent', controller, request, response, render_method)
+
+      expect(deprecator).to receive(:warn)
+        .with(
+          "[DEPRECATION] Accessing `InertiaRails::Renderer##{method_name}` is deprecated and will be removed in v4.0"
+        )
+
+      renderer.send(method_name)
+    end
+  end
+end

spec/inertia/rendering_spec.rb

@@ -661,6 +661,27 @@
     end
   end
 
+  context 'shared scroll props rendering' do
+    let(:headers) { { 'X-Inertia' => true } }
+
+    before do
+      # Create a mock controller action that returns scroll props
+      get '/shared_scroll_test', headers: headers
+    end
+
+    it 'includes scroll props metadata in response without reset' do
+      expect(response).to be_successful
+      expect(response.parsed_body['scrollProps']).to include('users')
+      expect(response.parsed_body['scrollProps']['users']).to include(
+        'pageName' => 'page',
+        'currentPage' => 1,
+        'nextPage' => 2,
+        'previousPage' => nil,
+        'reset' => false
+      )
+    end
+  end
+
   context 'prepend merge props rendering' do
     let(:headers) { { 'X-Inertia' => true } }
 
@@ -759,6 +780,22 @@
         expect(response.parsed_body['deferredProps']).to eq(nil)
       end
     end
+
+    context 'with shared data' do
+      let(:headers) { { 'X-Inertia' => true } }
+
+      before { get shared_deferred_props_path, headers: headers }
+
+      it 'does not include defer props inside props in first load' do
+        expect(response.parsed_body['props']).to eq({ 'name' => 'Brian' })
+      end
+
+      it 'returns deferredProps' do
+        expect(response.parsed_body['deferredProps']).to eq(
+          'default' => ['grit']
+        )
+      end
+    end
   end
 end