Make deep merging shared data optional, either with global config or per action via the renderer

Author: bknoles

lib/inertia_rails.rb

@@ -15,6 +15,7 @@
     method(:render),
     props: options[:props],
     view_data: options[:view_data],
+    deep_merge: options[:deep_merge],
   ).render
 end
 

lib/inertia_rails/inertia_rails.rb

@@ -13,7 +13,9 @@ def self.configure
 
   # "Getters"
   def self.shared_data(controller)
-    shared_plain_data.merge!(evaluated_blocks(controller, shared_blocks))
+    shared_plain_data.
+      merge!(evaluated_blocks(controller, shared_blocks)).
+      with_indifferent_access
   end
 
   def self.version
@@ -40,6 +42,10 @@ def self.html_headers
     self.threadsafe_html_headers || []
   end
 
+  def self.deep_merge_shared_data?
+    Configuration.deep_merge_shared_data
+  end
+
   # "Setters"
   def self.share(**args)
     self.shared_plain_data = self.shared_plain_data.merge(args)
@@ -71,6 +77,7 @@ module Configuration
     mattr_accessor(:ssr_enabled) { false }
     mattr_accessor(:ssr_url) { 'http://localhost:13714' }
     mattr_accessor(:default_render) { false }
+    mattr_accessor(:deep_merge_shared_data) { false }
 
     def self.evaluated_version
       self.version.respond_to?(:call) ? self.version.call : self.version

lib/inertia_rails/renderer.rb

@@ -6,14 +6,15 @@ module InertiaRails
   class Renderer
     attr_reader :component, :view_data
 
-    def initialize(component, controller, request, response, render_method, props:, view_data:)
+    def initialize(component, controller, request, response, render_method, props:, view_data:, deep_merge:)
       @component = component.is_a?(TrueClass) ? "#{controller.controller_path}/#{controller.action_name}" : component
       @controller = controller
       @request = request
       @response = response
       @render_method = render_method
-      @props = props || controller.inertia_view_assigns
+      @props = props ? props.with_indifferent_access : controller.inertia_view_assigns.with_indifferent_access
       @view_data = view_data || {}
+      @deep_merge = !deep_merge.nil? ? deep_merge : InertiaRails.deep_merge_shared_data?
     end
 
     def render
@@ -42,15 +43,15 @@ def layout
     end
 
     def props
-      _props = ::InertiaRails.shared_data(@controller).deep_merge(@props).select do |key, prop|
+      _props = ::InertiaRails.shared_data(@controller).send(prop_merge_method, @props).select do |key, prop|
         if rendering_partial_component?
           key.in? partial_keys
         else
           !prop.is_a?(InertiaRails::Lazy)
         end
       end
 
-      deep_transform_values(_props, lambda {|prop| prop.respond_to?(:call) ? @controller.instance_exec(&prop) : prop })
+      deep_transform_values(_props, lambda {|prop| prop.respond_to?(:call) ? @controller.instance_exec(&prop) : prop }).with_indifferent_access
     end
 
     def page
@@ -75,5 +76,9 @@ def partial_keys
     def rendering_partial_component?
       @request.inertia_partial? && @request.headers['X-Inertia-Partial-Component'] == component
     end
+
+    def prop_merge_method
+      @deep_merge ? :deep_merge : :merge
+    end
   end
 end

lib/inertia_rails/rspec.rb

@@ -74,7 +74,7 @@ def inertia_tests_setup?
 
 RSpec::Matchers.define :have_exact_props do |expected_props|
   match do |inertia|
-    expect(inertia.props).to eq expected_props
+    expect(inertia.props).to eq expected_props.with_indifferent_access
   end
 
   failure_message do |inertia|
@@ -84,7 +84,7 @@ def inertia_tests_setup?
 
 RSpec::Matchers.define :include_props do |expected_props|
   match do |inertia|
-      expect(inertia.props).to include expected_props
+    expect(inertia.props).to include expected_props.with_indifferent_access
   end
 
   failure_message do |inertia|

spec/dummy/app/controllers/inertia_merge_instance_props_controller.rb

@@ -0,0 +1,19 @@
+class InertiaMergeInstancePropsController < ApplicationController
+  use_inertia_instance_props
+  inertia_share do
+    {
+      nested: {
+        points: 55,
+        rebounds: 10,
+      }
+    }
+  end
+
+  def merge_instance_props
+    @nested = {
+      points: 100,
+    }
+
+    render inertia: 'InertiaTestComponent', deep_merge: true
+  end
+end

spec/dummy/app/controllers/inertia_merge_shared_controller.rb

@@ -15,4 +15,20 @@ def merge_shared
       }
     }
   end
+
+  def deep_merge_shared
+    render inertia: 'ShareTestComponent', props: {
+      nested: {
+        assists: 300,
+      }
+    }, deep_merge: true
+  end
+
+  def shallow_merge_shared
+    render inertia: 'ShareTestComponent', props: {
+      nested: {
+        assists: 200,
+      }
+    }, deep_merge: false
+  end
 end

spec/dummy/config/routes.rb

@@ -36,4 +36,7 @@
   inertia 'inertia_route' => 'TestComponent'
 
   get 'merge_shared' => 'inertia_merge_shared#merge_shared'
+  get 'deep_merge_shared' => 'inertia_merge_shared#deep_merge_shared'
+  get 'shallow_merge_shared' => 'inertia_merge_shared#shallow_merge_shared'
+  get 'merge_instance_props' => 'inertia_merge_instance_props#merge_instance_props'
 end

spec/inertia/rendering_spec.rb

@@ -4,10 +4,10 @@
   let(:controller) { double('Controller', inertia_view_assigns: {})}
 
   context 'first load' do
-    let(:page) { InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: nil, view_data: nil).send(:page) }
+    let(:page) { InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: nil, view_data: nil, deep_merge: nil).send(:page) }
 
     context 'with props' do
-      let(:page) { InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: {name: 'Brandon', sport: 'hockey'}, view_data: nil).send(:page) }
+      let(:page) { InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: {name: 'Brandon', sport: 'hockey'}, view_data: nil, deep_merge: nil).send(:page) }
       before { get props_path }
 
       it { is_expected.to include inertia_div(page) }
@@ -39,7 +39,7 @@
   end
 
   context 'subsequent requests' do
-    let(:page) { InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: {name: 'Brandon', sport: 'hockey'}, view_data: nil).send(:page) }
+    let(:page) { InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: {name: 'Brandon', sport: 'hockey'}, view_data: nil, deep_merge: nil).send(:page) }
     let(:headers) { {'X-Inertia' => true} }
 
     before { get props_path, headers: headers }
@@ -64,7 +64,7 @@
 
   context 'partial rendering' do
     let (:page) {
-      InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: { sport: 'hockey'}, view_data: nil).send(:page)
+      InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: { sport: 'hockey'}, view_data: nil, deep_merge: nil).send(:page)
     }
     let(:headers) {{
       'X-Inertia' => true,
@@ -94,7 +94,7 @@
   context 'lazy prop rendering' do
     context 'on first load' do
       let (:page) {
-        InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: { name: 'Brian'}, view_data: nil).send(:page)
+        InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: { name: 'Brian'}, view_data: nil, deep_merge: nil).send(:page)
       }
       before { get lazy_props_path }
 
@@ -103,7 +103,7 @@
 
     context 'with a partial reload' do
       let (:page) {
-        InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: { sport: 'basketball', level: 'worse than he believes', grit: 'intense'}, view_data: nil).send(:page)
+        InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: { sport: 'basketball', level: 'worse than he believes', grit: 'intense'}, view_data: nil, deep_merge: nil).send(:page)
       }
       let(:headers) {{
         'X-Inertia' => true,

spec/inertia/sharing_spec.rb

@@ -100,9 +100,51 @@
     end
   end
 
-  describe 'deep merging with shared data' do
-    let(:props) { { nested: { goals: 100, assists: 200 } } }
-    before { get merge_shared_path, headers: {'X-Inertia' => true} }
-    it { is_expected.to eq props }
+  # Tests:
+  # 1. By default, merging is shallow
+  # 2. You can concifgure InertiaRails to deep merge by default
+  # 3. You can override shallow merging in a specific action
+  # 4. You can override deep merging in a specific action
+  # 5. Make sure that the shorthand @thing-goes-to-props works
+  describe 'deep or shallow merging shared data' do
+    context 'with default settings (shallow merge)' do
+      describe 'shallow merging by default' do
+        let(:props) { { nested: { assists: 200 } } }
+        before { get merge_shared_path, headers: {'X-Inertia' => true} }
+        it { is_expected.to eq props }
+      end
+
+      context 'with deep merge added to the renderer' do
+        let(:props) { { nested: { goals: 100, assists: 300 } } }
+        before { get deep_merge_shared_path, headers: {'X-Inertia' => true} }
+        it { is_expected.to eq props }
+      end
+    end
+
+    context 'with deep merge configured as the default' do
+      before {
+        InertiaRails.configure { |config| config.deep_merge_shared_data = true }
+      }
+      after {
+        InertiaRails.configure { |config| config.deep_merge_shared_data = false }
+      }
+      describe 'deep merging by default' do
+        let(:props) { { nested: { goals: 100, assists: 200 } } }
+        before { get merge_shared_path, headers: {'X-Inertia' => true} }
+        it { is_expected.to eq props }
+      end
+
+      describe 'overriding deep merge in a specific action' do
+        let(:props) { { nested: { assists: 200 } } }
+        before { get shallow_merge_shared_path, headers: {'X-Inertia' => true} }
+        it { is_expected.to eq props }
+      end
+    end
+
+    context 'merging with instance props' do
+      let(:props) { { nested: { points: 100, rebounds: 10 } } }
+      before { get merge_instance_props_path, headers: {'X-Inertia' => true} }
+      it { is_expected.to eq props }
+    end
   end
 end