Fix scroll and deferred props from shared data by merging shared data in renderer initializer

Author: bknoles

lib/inertia_rails/renderer.rb

@@ -24,15 +24,19 @@ 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)
       @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
@@ -81,8 +85,8 @@ def shared_data
     #
     # 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,13 +95,12 @@ 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

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/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,23 @@
         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