Module: ReactOnRails::Helper

Includes:
ProHelper, Utils::Required
Included in:
ReactOnRailsHelper
Defined in:
lib/react_on_rails/helper.rb

Constant Summary collapse

COMPONENT_HTML_KEY = 
"componentHtml"

Instance Method Summary collapse

Methods included from ProHelper

#generate_component_script, #generate_store_script

Methods included from Utils::Required

#required

Instance Method Details

#build_react_component_result_for_server_rendered_hash(server_rendered_html: required("server_rendered_html"), component_specification_tag: required("component_specification_tag"), console_script: required("console_script"), render_options: required("render_options")) ⇒ Object 



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/react_on_rails/helper.rb', line 449

def build_react_component_result_for_server_rendered_hash(
  server_rendered_html: required("server_rendered_html"),
  component_specification_tag: required("component_specification_tag"),
  console_script: required("console_script"),
  render_options: required("render_options")
)
  content_tag_options = render_options.html_options
  content_tag_options[:id] = render_options.dom_id

  unless server_rendered_html[COMPONENT_HTML_KEY]
    raise ReactOnRails::Error, "server_rendered_html hash expected to contain \"#{COMPONENT_HTML_KEY}\" key."
  end

  rendered_output = content_tag(:div,
                                server_rendered_html[COMPONENT_HTML_KEY].html_safe,
                                content_tag_options)

  result_console_script = render_options.replay_console ? wrap_console_script_with_nonce(console_script) : ""
  result = compose_react_component_html_with_spec_and_console(
    component_specification_tag, rendered_output, result_console_script
  )

  # Other HTML strings need to be marked as html_safe too:
  server_rendered_hash_except_component = server_rendered_html.except(COMPONENT_HTML_KEY)
  server_rendered_hash_except_component.each do |key, html_string|
    server_rendered_hash_except_component[key] = html_string.html_safe
  end

  result_with_rails_context = prepend_render_rails_context(result)
  { COMPONENT_HTML_KEY => result_with_rails_context }.merge(
    server_rendered_hash_except_component
  )
end

#build_react_component_result_for_server_rendered_string(server_rendered_html: required("server_rendered_html"), component_specification_tag: required("component_specification_tag"), console_script: required("console_script"), render_options: required("render_options")) ⇒ Object 



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/react_on_rails/helper.rb', line 422

def build_react_component_result_for_server_rendered_string(
  server_rendered_html: required("server_rendered_html"),
  component_specification_tag: required("component_specification_tag"),
  console_script: required("console_script"),
  render_options: required("render_options")
)
  content_tag_options = render_options.html_options
  if content_tag_options.key?(:tag)
    content_tag_options_html_tag = content_tag_options[:tag]
    content_tag_options.delete(:tag)
  else
    content_tag_options_html_tag = "div"
  end
  content_tag_options[:id] = render_options.dom_id

  rendered_output = content_tag(content_tag_options_html_tag.to_sym,
                                server_rendered_html.html_safe,
                                content_tag_options)

  result_console_script = render_options.replay_console ? wrap_console_script_with_nonce(console_script) : ""
  result = compose_react_component_html_with_spec_and_console(
    component_specification_tag, rendered_output, result_console_script
  )

  prepend_render_rails_context(result)
end

#client_prop_target_key(props, key) ⇒ Object 



638
639
640
641
642
643
644
 
# File 'lib/react_on_rails/helper.rb', line 638

def client_prop_target_key(props, key)
  string_key = key.to_s
  symbol_key = string_key.to_sym
  # Preserve an existing symbol key when clientProps arrives from JSON with string keys,
  # otherwise we would create duplicate entries that serialize to the same JSON key.
  props.key?(symbol_key) && !props.key?(string_key) ? symbol_key : string_key
end

#compose_react_component_html_with_spec_and_console(component_specification_tag, rendered_output, console_script) ⇒ Object 



513
514
515
516
517
518
519
520
 
# File 'lib/react_on_rails/helper.rb', line 513

def compose_react_component_html_with_spec_and_console(component_specification_tag, rendered_output,
                                                       console_script)
  # IMPORTANT: Ensure that we mark string as html_safe to avoid escaping.
  added_html = "#{component_specification_tag}\n#{console_script}".strip
  added_html = added_html.present? ? "\n#{added_html}" : ""

  "#{rendered_output}#{added_html}".html_safe
end

#create_render_options(react_component_name, options) ⇒ Object 



404
405
406
407
408
409
410
411
412
 
# File 'lib/react_on_rails/helper.rb', line 404

def create_render_options(react_component_name, options)
  # If no store dependencies are passed, default to all registered stores up till now
  unless options.key?(:store_dependencies)
    store_dependencies = registered_stores_including_deferred.map { |store| store[:store_name] }
    options = options.merge(store_dependencies: store_dependencies.presence)
  end
  ReactOnRails::ReactComponent::RenderOptions.new(react_component_name: react_component_name,
                                                  options: options)
end

#csp_nonce ⇒ Object

Returns the CSP script nonce for the current request, or nil if CSP is not enabled. Rails 5.2-6.0 use content_security_policy_nonce with no arguments. Rails 6.1+ accept an optional directive argument.



486
487
488
489
490
491
492
493
494
495
 
# File 'lib/react_on_rails/helper.rb', line 486

def csp_nonce
  return unless respond_to?(:content_security_policy_nonce)

  begin
    content_security_policy_nonce(:script)
  rescue ArgumentError
    # Fallback for Rails versions that don't accept arguments
    content_security_policy_nonce
  end
end

#generated_components_pack_path(component_name) ⇒ Object 



414
415
416
 
# File 'lib/react_on_rails/helper.rb', line 414

def generated_components_pack_path(component_name)
  "#{ReactOnRails::PackerUtils.packer_source_entry_path}/generated/#{component_name}.js"
end

#generated_stores_pack_path(store_name) ⇒ Object 



418
419
420
 
# File 'lib/react_on_rails/helper.rb', line 418

def generated_stores_pack_path(store_name)
  "#{ReactOnRails::PackerUtils.packer_source_entry_path}/generated/#{store_name}.js"
end

#in_mailer? ⇒ Boolean

Returns:

  • (Boolean) 


776
777
778
779
780
781
 
# File 'lib/react_on_rails/helper.rb', line 776

def in_mailer?
  return false unless defined?(controller)
  return false unless defined?(ActionMailer::Base)

  controller.is_a?(ActionMailer::Base)
end

#initialize_redux_stores(render_options) ⇒ Object 



746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/react_on_rails/helper.rb', line 746

def initialize_redux_stores(render_options)
  result = +<<-JS
  ReactOnRails.clearHydratedStores();
  JS

  store_dependencies = render_options.store_dependencies
  return result unless store_dependencies.present?

  declarations = +"var reduxProps, store, storeGenerator;\n"
  store_objects = registered_stores_including_deferred.select do |store|
    store_dependencies.include?(store[:store_name])
  end

  result << store_objects.each_with_object(declarations) do |redux_store_data, memo|
    store_name = redux_store_data[:store_name]
    props = props_string(redux_store_data[:props])
    memo << <<-JS.strip_heredoc
    reduxProps = #{props};
    storeGenerator = ReactOnRails.getStoreGenerator(#{store_name.to_json});
    store = storeGenerator(reduxProps, railsContext);
    ReactOnRails.setStore(#{store_name.to_json}, store);
    JS
  end
  result
end

#internal_react_component(react_component_name, options = {}) ⇒ Object 



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/react_on_rails/helper.rb', line 555

def internal_react_component(react_component_name, options = {})
  # Create the JavaScript and HTML to allow either client or server rendering of the
  # react_component.
  #
  # Create the JavaScript setup of the global to initialize the client rendering
  # (re-hydrate the data). This enables react rendered on the client to see that the
  # server has already rendered the HTML.

  render_options = create_render_options(react_component_name, options)

  load_pack_for_generated_component(react_component_name, render_options)
  # Create the HTML rendering part
  result = server_rendered_react_component(render_options)

  # clientProps are only expected on successful SSR hashes. Current error hashes do not
  # include that key, so non-SSR/error paths skip this merge entirely.
  merge_server_rendered_client_props!(render_options, result) if result.is_a?(Hash)

  # Setup the page_loaded_js, which is the same regardless of prerendering or not!
  # The reason is that React is smart about not doing extra work if the server rendering did its job.
  component_specification_tag = generate_component_script(render_options)

  {
    render_options: render_options,
    tag: component_specification_tag,
    result: result
  }
end

#json_safe_and_pretty(hash_or_string) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/react_on_rails/helper.rb', line 265

def json_safe_and_pretty(hash_or_string)
  return "{}" if hash_or_string.nil?

  unless hash_or_string.is_a?(String) || hash_or_string.is_a?(Hash)
    raise ReactOnRails::Error, "#{__method__} only accepts String or Hash as argument " \
                               "(#{hash_or_string.class} given)."
  end

  json_value = hash_or_string.is_a?(String) ? hash_or_string : hash_or_string.to_json

  ReactOnRails::JsonOutput.escape(json_value)
end

#load_pack_for_generated_component(react_component_name, render_options) ⇒ Object 



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/react_on_rails/helper.rb', line 344

def load_pack_for_generated_component(react_component_name, render_options)
  return unless render_options.auto_load_bundle

  ReactOnRails::PackerUtils.raise_nested_entries_disabled unless ReactOnRails::PackerUtils.nested_entries?
  if Rails.env.development?
    is_component_pack_present = File.exist?(generated_components_pack_path(react_component_name))
    raise_missing_autoloaded_bundle(react_component_name) unless is_component_pack_present
  end

  options = { defer: ReactOnRails.configuration.generated_component_packs_loading_strategy == :defer }
  # Old versions of Shakapacker don't support async script tags.
  # ReactOnRails.configure already validates if async loading is supported by the installed Shakapacker version.
  # Therefore, we only need to pass the async option if the loading strategy is explicitly set to :async
  options[:async] = true if ReactOnRails.configuration.generated_component_packs_loading_strategy == :async
  append_javascript_pack_tag("generated/#{react_component_name}", **options)
  append_stylesheet_pack_tag("generated/#{react_component_name}")
end

#load_pack_for_generated_store(store_name, explicit_auto_load: false) ⇒ Object 



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/react_on_rails/helper.rb', line 362

def load_pack_for_generated_store(store_name, explicit_auto_load: false)
  unless ReactOnRails.configuration.stores_subdirectory.present?
    if explicit_auto_load
      raise ReactOnRails::SmartError.new(
        error_type: :configuration_error,
        details: "auto_load_bundle is enabled for store " \
                 "'#{store_name}', but " \
                 "stores_subdirectory is not configured. " \
                 "Set config.stores_subdirectory (e.g., " \
                 "'ror_stores') in your ReactOnRails " \
                 "configuration so that store packs can " \
                 "be generated and loaded."
      )
    end
    return
  end

  ReactOnRails::PackerUtils.raise_nested_entries_disabled unless ReactOnRails::PackerUtils.nested_entries?
  if Rails.env.development?
    is_store_pack_present = File.exist?(generated_stores_pack_path(store_name))
    raise_missing_autoloaded_store_bundle(store_name) unless is_store_pack_present
  end

  options = { defer: ReactOnRails.configuration.generated_component_packs_loading_strategy == :defer }
  options[:async] = true if ReactOnRails.configuration.generated_component_packs_loading_strategy == :async
  append_javascript_pack_tag("generated/#{store_name}", **options)
end

#merge_client_props(existing_props, client_props) ⇒ Object 



619
620
621
622
623
624
625
626
 
# File 'lib/react_on_rails/helper.rb', line 619

def merge_client_props(existing_props, client_props)
  merged_props = existing_props.dup
  client_props.each do |key, value|
    raise_if_duplicate_client_prop_key_types!(merged_props, key)
    merged_props[client_prop_target_key(merged_props, key)] = value
  end
  merged_props
end

#merge_server_rendered_client_props!(render_options, result) ⇒ Object 



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/react_on_rails/helper.rb', line 584

def merge_server_rendered_client_props!(render_options, result)
  client_props = result["clientProps"]
  return if client_props.nil?

  unless client_props.is_a?(Hash)
    raise ReactOnRails::Error, "Expected result[\"clientProps\"] to be a Hash, got #{client_props.class.name}."
  end

  return if client_props.empty?

  raw_existing_props = render_options.props
  existing_props = if raw_existing_props.nil?
                     {}
                   elsif raw_existing_props.is_a?(String)
                     begin
                       JSON.parse(raw_existing_props)
                     rescue JSON::ParserError
                       raise ReactOnRails::Error,
                             "Cannot merge result[\"clientProps\"] into props: failed to parse props JSON " \
                             "string. Ensure props is a Ruby Hash or a JSON string representing an object."
                     end
                   else
                     raw_existing_props
                   end

  unless existing_props.is_a?(Hash)
    class_name = existing_props.class.name
    raise ReactOnRails::Error,
          "Cannot merge result[\"clientProps\"] into non-Hash props. " \
          "Pass props as a Hash, not #{class_name}."
  end

  render_options.set_option(:props, merge_client_props(existing_props, client_props))
end

#prepend_render_rails_context(render_value) ⇒ Object

prepend the rails_context if not yet applied



549
550
551
552
553
 
# File 'lib/react_on_rails/helper.rb', line 549

def prepend_render_rails_context(render_value)
  rails_context_content = rails_context_if_not_already_rendered
  rails_context_content = rails_context_content.present? ? "#{rails_context_content}\n" : ""
  "#{rails_context_content}#{render_value}".html_safe
end

#props_string(props) ⇒ Object 



652
653
654
 
# File 'lib/react_on_rails/helper.rb', line 652

def props_string(props)
  props.is_a?(String) ? props : props.to_json
end

#rails_context(server_side: true) ⇒ Object

This is the definitive list of the default values used for the rails_context, which is the second parameter passed to both component and store Render-Functions. This method can be called from views and from the controller, as ‘helpers.rails_context`

rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/react_on_rails/helper.rb', line 283

def rails_context(server_side: true)
  # ALERT: Keep in sync with packages/react-on-rails/src/types/index.ts for the properties of RailsContext
  @rails_context ||= begin
    result = {
      componentRegistryTimeout: ReactOnRails.configuration.component_registry_timeout,
      railsEnv: Rails.env,
      inMailer: in_mailer?,
      # Locale settings
      i18nLocale: I18n.locale,
      i18nDefaultLocale: I18n.default_locale,
      rorVersion: ReactOnRails::VERSION,
      # TODO: v13 just use the version if existing
      rorPro: ReactOnRails::Utils.react_on_rails_pro?
    }

    if ReactOnRails::Utils.react_on_rails_pro?
      result[:rorProVersion] = ReactOnRails::Utils.react_on_rails_pro_version

      if ReactOnRails::Utils.rsc_support_enabled?
        rsc_payload_url = ReactOnRailsPro.configuration.rsc_payload_generation_url_path
        result[:rscPayloadGenerationUrlPath] = rsc_payload_url
      end
    end

    if defined?(request) && request.present?
      # Check for encoding of the request's original_url and try to force-encoding the
      # URLs as UTF-8. This situation can occur in browsers that do not encode the
      # entire URL as UTF-8 already, mostly on the Windows platform (IE11 and lower).
      original_url_normalized = request.original_url
      if original_url_normalized.encoding == Encoding::BINARY
        original_url_normalized = original_url_normalized.force_encoding(Encoding::ISO_8859_1)
                                                         .encode(Encoding::UTF_8)
      end

      # Using Addressable instead of standard URI to better deal with
      # non-ASCII characters (see https://github.com/shakacode/react_on_rails/pull/405)
      uri = Addressable::URI.parse(original_url_normalized)
      # uri = Addressable::URI.parse("http://foo.com:3000/posts?id=30&limit=5#time=1305298413")

      result.merge!(
        # URL settings
        href: uri.to_s,
        location: "#{uri.path}#{"?#{uri.query}" if uri.query.present?}",
        scheme: uri.scheme, # http
        host: uri.host, # foo.com
        port: uri.port,
        pathname: uri.path, # /posts
        search: uri.query, # id=30&limit=5
        httpAcceptLanguage: request.env["HTTP_ACCEPT_LANGUAGE"]
      )
    end
    if ReactOnRails.configuration.rendering_extension
      custom_context = ReactOnRails.configuration.rendering_extension.custom_context(self)
      result.merge!(custom_context) if custom_context
    end
    result
  end

  @rails_context.merge(serverSide: server_side)
end

#rails_context_if_not_already_rendered ⇒ Object 



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/react_on_rails/helper.rb', line 522

def rails_context_if_not_already_rendered
  return "" if @rendered_rails_context

  data = rails_context(server_side: false)

  @rendered_rails_context = true

  attribution_comment = react_on_rails_attribution_comment
  script_tag = content_tag(:script,
                           json_safe_and_pretty(data).html_safe,
                           type: "application/json",
                           id: "js-react-on-rails-context")

  "#{attribution_comment}\n#{script_tag}".html_safe
end

#raise_if_duplicate_client_prop_key_types!(props, key) ⇒ Object

Raises:



628
629
630
631
632
633
634
635
636
 
# File 'lib/react_on_rails/helper.rb', line 628

def raise_if_duplicate_client_prop_key_types!(props, key)
  string_key = key.to_s
  symbol_key = string_key.to_sym
  return unless props.key?(string_key) && props.key?(symbol_key)

  raise ReactOnRails::Error,
        "Cannot merge result[\"clientProps\"] when props contains both string and symbol versions of " \
        "#{string_key.inspect}. Normalize props keys before calling react_component."
end

#raise_missing_autoloaded_bundle(react_component_name) ⇒ Object

Raises:



783
784
785
786
787
788
789
 
# File 'lib/react_on_rails/helper.rb', line 783

def raise_missing_autoloaded_bundle(react_component_name)
  raise ReactOnRails::SmartError.new(
    error_type: :missing_auto_loaded_bundle,
    component_name: react_component_name,
    expected_path: generated_components_pack_path(react_component_name)
  )
end

#raise_missing_autoloaded_store_bundle(store_name) ⇒ Object

Raises:



791
792
793
794
795
796
797
 
# File 'lib/react_on_rails/helper.rb', line 791

def raise_missing_autoloaded_store_bundle(store_name)
  raise ReactOnRails::SmartError.new(
    error_type: :missing_auto_loaded_store_bundle,
    component_name: store_name,
    expected_path: generated_stores_pack_path(store_name)
  )
end

#raise_prerender_error(json_result, react_component_name, props, js_code) ⇒ Object

Raises:



656
657
658
659
660
661
662
663
664
 
# File 'lib/react_on_rails/helper.rb', line 656

def raise_prerender_error(json_result, react_component_name, props, js_code)
  raise ReactOnRails::PrerenderError.new(
    component_name: react_component_name,
    props: sanitized_props_string(props),
    err: nil,
    js_code: js_code,
    console_messages: json_result["consoleReplayScript"]
  )
end

#react_component(component_name, options = {}) ⇒ Object

react_component_name: can be a React function or class component or a “Render-Function”. “Render-Functions” differ from a React function in that they take two parameters, the

props and the railsContext, like this:

let MyReactComponentApp = (props, railsContext) => <MyReactComponent {...props}/>;

Alternately, you can define the Render-Function with an additional property
`.renderFunction = true`:

let MyReactComponentApp = (props) => <MyReactComponent {...props}/>;
MyReactComponent.renderFunction = true;

Exposing the react_component_name is necessary to both a plain ReactComponent as well as
  a generator:
See README.md for how to "register" your React components.
See spec/dummy/client/app/packs/server-bundle.js and
  spec/dummy/client/app/packs/client-bundle.js for examples of this.

options:

props: Ruby Hash or JSON string which contains the properties to pass to the react object. Do
   not pass any props if you are separately initializing the store by the `redux_store` helper.
prerender: <true/false> set to false when debugging!
id: You can optionally set the id, or else a unique one is automatically generated.
html_options: You can set other html attributes that will go on this component
trace: <true/false> set to true to print additional debugging information in the browser
       default is true for development, off otherwise
replay_console: <true/false> Default is true. False will disable echoing server rendering
                logs to browser. While this can make troubleshooting server rendering difficult,
                so long as you have the default configuration of logging_on_server set to
                true, you'll still see the errors on the server.
raise_on_prerender_error: <true/false> Default to false. True will raise exception on server
   if the JS code throws

Any other options are passed to the content tag, including the id. random_dom_id can be set to override the default from the config/initializers. That’s only used if you have multiple instance of the same component on the Rails view.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/react_on_rails/helper.rb', line 59

def react_component(component_name, options = {})
  internal_result = internal_react_component(component_name, options)
  server_rendered_html = internal_result[:result]["html"]
  console_script = internal_result[:result]["consoleReplayScript"]
  render_options = internal_result[:render_options]

  case server_rendered_html
  when String
    html = build_react_component_result_for_server_rendered_string(
      server_rendered_html: server_rendered_html,
      component_specification_tag: internal_result[:tag],
      console_script: console_script,
      render_options: render_options
    )
    html.html_safe
  when Hash
    msg = <<~MSG
      Use react_component_hash (not react_component) to return a Hash to your ruby view code. See
      https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
      for an example of the necessary javascript configuration.
    MSG
    raise ReactOnRails::Error, msg
  else
    class_name = server_rendered_html.class.name
    msg = <<~MSG
      ReactOnRails: server_rendered_html is expected to be a String or Hash for #{component_name}.
      Type is #{class_name}
      Value:
      #{server_rendered_html}

      If you're trying to use a Render-Function to return a Hash to your ruby view code, then use
      react_component_hash instead of react_component and see
      https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
      for an example of the JavaScript code.
    MSG
    raise ReactOnRails::Error, msg
  end
end

#react_component_hash(component_name, options = {}) ⇒ Object

react_component_hash is used to return multiple HTML strings for server rendering, such as for adding meta-tags to a page. It is exactly like react_component except for the following:

  1. prerender: true is automatically added, as this method doesn’t make sense for client only rendering.

  2. Your JavaScript Render-Function for server rendering must return an Object rather than a React component.

  3. Your view code must expect an object and not a string.

Here is an example of the view code:

<% react_helmet_app = react_component_hash("ReactHelmetApp", prerender: true,
                                           props: { helloWorldData: { name: "Mr. Server Side Rendering"}},
                                           id: "react-helmet-0", trace: true) %>
<% content_for :title do %>
  <%= react_helmet_app['title'] %>
<% end %>
<%= react_helmet_app["componentHtml"] %>



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/react_on_rails/helper.rb', line 115

def react_component_hash(component_name, options = {})
  options[:prerender] = true

  internal_result = internal_react_component(component_name, options)
  server_rendered_html = internal_result[:result]["html"]
  console_script = internal_result[:result]["consoleReplayScript"]
  render_options = internal_result[:render_options]

  if server_rendered_html.is_a?(String) && internal_result[:result]["hasErrors"]
    server_rendered_html = { COMPONENT_HTML_KEY => internal_result[:result]["html"] }
  end

  if server_rendered_html.is_a?(Hash)
    build_react_component_result_for_server_rendered_hash(
      server_rendered_html: server_rendered_html,
      component_specification_tag: internal_result[:tag],
      console_script: console_script,
      render_options: render_options
    )

  else
    msg = <<~MSG
      Render-Function used by react_component_hash for #{component_name} is expected to return
      an Object. See https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
      for an example of the JavaScript code.
      Note, your Render-Function must either take 2 params or have the property
      `.renderFunction = true` added to it to distinguish it from a React Function Component.
    MSG
    raise ReactOnRails::Error, msg
  end
end

#react_on_rails_attribution_comment ⇒ Object

Generates the HTML attribution comment Pro version calls ReactOnRailsPro::Utils for license-specific details



540
541
542
543
544
545
546
 
# File 'lib/react_on_rails/helper.rb', line 540

def react_on_rails_attribution_comment
  if ReactOnRails::Utils.react_on_rails_pro?
    ReactOnRailsPro::Utils.pro_attribution_comment
  else
    "<!-- Powered by React on Rails (c) ShakaCode | Open Source -->"
  end
end

#redux_store(store_name, props: {}, defer: false, immediate_hydration: nil, auto_load_bundle: nil) ⇒ Object

Separate initialization of store from react_component allows multiple react_component calls to use the same Redux store.

NOTE: This technique not recommended as it prevents dynamic code splitting for performance. Instead, you should use the standard react_component view helper.

store_name: name of the store, corresponding to your call to ReactOnRails.registerStores in your

JavaScript code. When using auto-bundling, this should match the filename of your
store file (e.g., "commentsStore" for commentsStore.js).

props: Ruby Hash or JSON string which contains the properties to pass to the redux store. Options

defer: false -- pass as true if you wish to render this below your component.
immediate_hydration: nil -- React on Rails Pro (licensed) feature. When nil (default), Pro users
                    get immediate hydration, non-Pro users don't. Can be explicitly overridden.
auto_load_bundle: nil -- If true, automatically loads the generated pack for this store.
                  Defaults to ReactOnRails.configuration.auto_load_bundle if not specified.
                  Requires config.stores_subdirectory to be set (e.g., "ror_stores").
                  Store files should be placed in directories matching this name, e.g.:
                    app/javascript/bundles/ror_stores/commentsStore.js
                  The store file must export default a store generator function.



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/react_on_rails/helper.rb', line 167

def redux_store(store_name, props: {}, defer: false, immediate_hydration: nil, auto_load_bundle: nil)
  immediate_hydration = ReactOnRails::Utils.normalize_immediate_hydration(immediate_hydration, store_name, "Store")

  # Auto-load store pack if configured
  should_auto_load = auto_load_bundle.nil? ? ReactOnRails.configuration.auto_load_bundle : auto_load_bundle
  load_pack_for_generated_store(store_name, explicit_auto_load: auto_load_bundle == true) if should_auto_load

  redux_store_data = { store_name: store_name,
                       props: props,
                       immediate_hydration: immediate_hydration }
  if defer
    registered_stores_defer_render << redux_store_data
    "YOU SHOULD NOT SEE THIS ON YOUR VIEW -- Uses as a code block, like <% redux_store %> " \
      "and not <%= redux store %>"
  else
    registered_stores << redux_store_data
    result = render_redux_store_data(redux_store_data)
    prepend_render_rails_context(result).html_safe
  end
end

#redux_store_hydration_data ⇒ Object

Place this view helper (no parameters) at the end of your shared layout. This tell ReactOnRails where to client render the redux store hydration data. Since we’re going to be setting up the stores in the controllers, we need to know where on the view to put the client side rendering of this hydration data, which is a hidden div with a matching class that contains a data props.



193
194
195
196
197
198
199
 
# File 'lib/react_on_rails/helper.rb', line 193

def redux_store_hydration_data
  return if registered_stores_defer_render.blank?

  registered_stores_defer_render.reduce(+"") do |accum, redux_store_data|
    accum << render_redux_store_data(redux_store_data)
  end.html_safe
end

#registered_stores ⇒ Object

rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity



392
393
394
 
# File 'lib/react_on_rails/helper.rb', line 392

def registered_stores
  @registered_stores ||= []
end

#registered_stores_defer_render ⇒ Object 



396
397
398
 
# File 'lib/react_on_rails/helper.rb', line 396

def registered_stores_defer_render
  @registered_stores_defer_render ||= []
end

#registered_stores_including_deferred ⇒ Object 



400
401
402
 
# File 'lib/react_on_rails/helper.rb', line 400

def registered_stores_including_deferred
  registered_stores + registered_stores_defer_render
end

#render_redux_store_data(redux_store_data) ⇒ Object 



646
647
648
649
650
 
# File 'lib/react_on_rails/helper.rb', line 646

def render_redux_store_data(redux_store_data)
  store_hydration_data = generate_store_script(redux_store_data)

  prepend_render_rails_context(store_hydration_data)
end

#replay_console_option(val) ⇒ Object 



772
773
774
 
# File 'lib/react_on_rails/helper.rb', line 772

def replay_console_option(val)
  val.nil? ? ReactOnRails.configuration.replay_console : val
end

#sanitized_props_string(props) ⇒ Object 



201
202
203
 
# File 'lib/react_on_rails/helper.rb', line 201

def sanitized_props_string(props)
  ReactOnRails::JsonOutput.escape(props.is_a?(String) ? props : props.to_json)
end

#server_render_js(js_expression, options = {}) ⇒ Object

Helper method to take javascript expression and returns the output from evaluating it. If you have more than one line that needs to be executed, wrap it in an IIFE. JS exceptions are caught and console messages are handled properly. Options include:{ prerender:, trace:, raise_on_prerender_error:, throw_js_errors: }



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/react_on_rails/helper.rb', line 209

def server_render_js(js_expression, options = {})
  render_options = ReactOnRails::ReactComponent::RenderOptions
                   .new(react_component_name: "generic-js", options: options)

  js_code = <<-JS.strip_heredoc
  (function() {
    var htmlResult = '';
    var consoleReplayScript = '';
    var hasErrors = false;
    var renderingError = null;
    var renderingErrorObject = {};

    try {
      htmlResult =
        (function() {
          return #{js_expression};
        })();
    } catch(e) {
      renderingError = e;
      if (#{render_options.throw_js_errors}) {
        throw e;
      }
      htmlResult = ReactOnRails.handleError({e: e, name: null,
        jsCode: '#{escape_javascript(js_expression)}', serverSide: true});
      hasErrors = true;
      renderingErrorObject = {
        message: renderingError.message,
        stack: renderingError.stack,
      }
    }

    consoleReplayScript = ReactOnRails.getConsoleReplayScript();

    return JSON.stringify({
        html: htmlResult,
        consoleReplayScript: consoleReplayScript,
        hasErrors: hasErrors,
        renderingError: renderingErrorObject
    });

  })()
  JS

  result = ReactOnRails::ServerRenderingPool
           .server_render_js_with_console_logging(js_code, render_options)

  html = result["html"]
  console_script = result["consoleReplayScript"]
  console_script_tag = wrap_console_script_with_nonce(console_script) if render_options.replay_console
  raw("#{html}#{console_script_tag}")
rescue ExecJS::ProgramError => err
  raise ReactOnRails::PrerenderError.new(component_name: "N/A (server_render_js called)",
                                         err: err,
                                         js_code: js_code)
end

#server_rendered_react_component(render_options) ⇒ Object

Returns object with values that are NOT html_safe!



676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
 
# File 'lib/react_on_rails/helper.rb', line 676

def server_rendered_react_component(render_options)
  return { "html" => "", "consoleReplayScript" => "" } unless render_options.prerender

  react_component_name = render_options.react_component_name
  props = render_options.props

  # On server `location` option is added (`location = request.fullpath`)
  # React Router needs this to match the current route

  # Make sure that we use up-to-date bundle file used for server rendering, which is defined
  # by config file value for config.server_bundle_js_file
  ReactOnRails::ServerRenderingPool.reset_pool_if_server_bundle_was_modified

  # Since this code is not inserted on a web page, we don't need to escape props
  #
  # However, as JSON (returned from `props_string(props)`) isn't JavaScript,
  # but we want treat it as such, we need to compensate for the difference.
  #
  # \u2028 and \u2029 are valid characters in strings in JSON, but are treated
  # as newline separators in JavaScript. As no newlines are allowed in
  # strings in JavaScript, this causes an exception.
  #
  # We fix this by replacing these unicode characters with their escaped versions.
  # This should be safe, as the only place they can appear is in strings anyway.
  #
  # Read more here: http://timelessrepo.com/json-isnt-a-javascript-subset

  js_code = ReactOnRails::ServerRenderingJsCode.server_rendering_component_js_code(
    props_string: props_string(props).gsub("\u2028", '\u2028').gsub("\u2029", '\u2029'),
    rails_context: rails_context(server_side: true).to_json,
    redux_stores: initialize_redux_stores(render_options),
    react_component_name: react_component_name,
    render_options: render_options
  )

  begin
    result = ReactOnRails::ServerRenderingPool.server_render_js_with_console_logging(js_code, render_options)
  rescue StandardError => err
    # This error came from the renderer
    raise ReactOnRails::PrerenderError.new(component_name: react_component_name,
                                           # Sanitize as this might be browser logged
                                           props: sanitized_props_string(props),
                                           err: err,
                                           js_code: js_code)
  end

  if render_options.streaming?
    result.transform do |chunk_json_result|
      if should_raise_streaming_prerender_error?(chunk_json_result, render_options)
        raise_prerender_error(chunk_json_result, react_component_name, props, js_code)
      end
      # It doesn't make any transformation, it listens and raises error if a chunk has errors
      chunk_json_result
    end

    result.rescue do |err|
      # This error came from the renderer
      raise ReactOnRails::PrerenderError.new(component_name: react_component_name,
                                             # Sanitize as this might be browser logged
                                             props: sanitized_props_string(props),
                                             err: err,
                                             js_code: js_code)
    end
  elsif result["hasErrors"] && render_options.raise_on_prerender_error
    raise_prerender_error(result, react_component_name, props, js_code)
  end

  result
end

#should_raise_streaming_prerender_error?(chunk_json_result, render_options) ⇒ Boolean

Returns:

  • (Boolean) 


666
667
668
669
670
671
672
673
 
# File 'lib/react_on_rails/helper.rb', line 666

def should_raise_streaming_prerender_error?(chunk_json_result, render_options)
  chunk_json_result["hasErrors"] &&
    (if chunk_json_result["isShellReady"]
       render_options.raise_non_shell_server_rendering_errors
     else
       render_options.raise_on_prerender_error
     end)
end

#wrap_console_script_with_nonce(console_script_code) ⇒ Object

Wraps console replay JavaScript code in a script tag with CSP nonce if available. The console_script_code is already sanitized by scriptSanitizedVal() in the JavaScript layer, so using html_safe here is secure.



500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/react_on_rails/helper.rb', line 500

def wrap_console_script_with_nonce(console_script_code)
  return "" if console_script_code.blank?

  nonce = csp_nonce

  # Build the script tag with nonce if available
  script_options = { id: "consoleReplayLog" }
  script_options[:nonce] = nonce if nonce.present?

  # Safe to use html_safe because content is pre-sanitized via scriptSanitizedVal()
  content_tag(:script, console_script_code.html_safe, script_options)
end