react_on_rails 12.1.0 → 12.4.0

data/lib/react_on_rails/helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # rubocop:disable Metrics/ModuleLength
+# rubocop:disable Metrics/MethodLength
 # NOTE:
 # For any heredoc JS:
 # 1. The white spacing in this file matters!
@@ -182,7 +183,7 @@ module ReactOnRails
     # 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: }
+    # Options include:{ prerender:, trace:, raise_on_prerender_error:, throw_js_errors: }
     def server_render_js(js_expression, options = {})
       render_options = ReactOnRails::ReactComponent::RenderOptions
                        .new(react_component_name: "generic-js", options: options)
@@ -192,6 +193,8 @@ module ReactOnRails
         var htmlResult = '';
         var consoleReplayScript = '';
         var hasErrors = false;
+        var renderingError = null;
+        var renderingErrorObject = {};
 
         try {
           htmlResult =
@@ -199,9 +202,17 @@ module ReactOnRails
               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.buildConsoleReplay();
@@ -209,7 +220,8 @@ module ReactOnRails
         return JSON.stringify({
             html: htmlResult,
             consoleReplayScript: consoleReplayScript,
-            hasErrors: hasErrors
+            hasErrors: hasErrors,
+            renderingError: renderingErrorObject
         });
 
       })()
@@ -524,6 +536,13 @@ module ReactOnRails
 
       controller.is_a?(ActionMailer::Base)
     end
+
+    if defined?(ScoutApm)
+      include ScoutApm::Tracer
+      instrument_method :react_component, type: "ReactOnRails", name: "react_component"
+      instrument_method :react_component_hash, type: "ReactOnRails", name: "react_component_hash"
+    end
   end
 end
 # rubocop:enable Metrics/ModuleLength
+# rubocop:enable Metrics/MethodLength

data/lib/react_on_rails/locales/base.rb

@@ -54,15 +54,13 @@ module ReactOnRails
       end
 
       def locale_files
-        @locale_files ||= begin
-          if i18n_yml_dir.present?
-            Dir["#{i18n_yml_dir}/**/*.yml"]
-          else
-            ReactOnRails::Utils.truthy_presence(
-              Rails.application && Rails.application.config.i18n.load_path
-            ).presence
-          end
-        end
+        @locale_files ||= if i18n_yml_dir.present?
+                            Dir["#{i18n_yml_dir}/**/*.yml"]
+                          else
+                            ReactOnRails::Utils.truthy_presence(
+                              Rails.application && Rails.application.config.i18n.load_path
+                            ).presence
+                          end
       end
 
       def i18n_dir

data/lib/react_on_rails/react_component/render_options.rb

@@ -11,6 +11,7 @@ module ReactOnRails
 
       NO_PROPS = {}.freeze
 
+      # TODO: remove the required for named params
       def initialize(react_component_name: required("react_component_name"), options: required("options"))
         @react_component_name = react_component_name.camelize
         @options = options
@@ -18,12 +19,16 @@ module ReactOnRails
 
       attr_reader :react_component_name
 
+      def throw_js_errors
+        options.fetch(:throw_js_errors, false)
+      end
+
       def props
         options.fetch(:props) { NO_PROPS }
       end
 
       def random_dom_id
-        retrieve_key(:random_dom_id)
+        retrieve_configuration_value_for(:random_dom_id)
       end
 
       def dom_id
@@ -49,23 +54,23 @@ module ReactOnRails
       end
 
       def prerender
-        retrieve_key(:prerender)
+        retrieve_configuration_value_for(:prerender)
       end
 
       def trace
-        retrieve_key(:trace)
+        retrieve_configuration_value_for(:trace)
       end
 
       def replay_console
-        retrieve_key(:replay_console)
+        retrieve_configuration_value_for(:replay_console)
       end
 
       def raise_on_prerender_error
-        retrieve_key(:raise_on_prerender_error)
+        retrieve_configuration_value_for(:raise_on_prerender_error)
       end
 
       def logging_on_server
-        retrieve_key(:logging_on_server)
+        retrieve_configuration_value_for(:logging_on_server)
       end
 
       def to_s
@@ -76,6 +81,10 @@ module ReactOnRails
         options[key]
       end
 
+      def set_option(key, value)
+        options[key] = value
+      end
+
       private
 
       attr_reader :options
@@ -88,7 +97,7 @@ module ReactOnRails
         "#{base_dom_id}-#{SecureRandom.uuid}"
       end
 
-      def retrieve_key(key)
+      def retrieve_configuration_value_for(key)
         options.fetch(key) do
           ReactOnRails.configuration.public_send(key)
         end

data/lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb

@@ -150,6 +150,10 @@ module ReactOnRails
         end
 
         def execjs_timer_polyfills
+          if ReactOnRails::Utils.react_on_rails_pro? && ReactOnRailsPro.configuration.include_execjs_polyfills == false
+            return ""
+          end
+
           <<~JS
             function getStackTrace () {
               var stack;
@@ -187,8 +191,10 @@ module ReactOnRails
         end
 
         # Reimplement console methods for replaying on the client
+        # Save a handle to the original console if needed.
         def console_polyfill
           <<~JS
+            var debugConsole = console;
             var console = { history: [] };
             ['error', 'log', 'info', 'warn'].forEach(function (level) {
               console[level] = function () {
@@ -202,6 +208,11 @@ module ReactOnRails
           JS
         end
 
+        if defined?(ScoutApm)
+          include ScoutApm::Tracer
+          instrument_method :exec_server_render_js, type: "ReactOnRails", name: "ExecJs React Server Rendering"
+        end
+
         private
 
         def file_url_to_string(url)

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "12.1.0"
+  VERSION = "12.4.0"
 end

data/lib/tasks/assets.rake

@@ -7,7 +7,9 @@ require "active_support"
 
 ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
 
-unless ReactOnRails::WebpackerUtils.webpacker_webpack_production_config_exists?
+skip_react_on_rails_precompile = %w[no false n f].include?(ENV["REACT_ON_RAILS_PRECOMPILE"])
+
+if !skip_react_on_rails_precompile && !ReactOnRails::WebpackerUtils.webpacker_webpack_production_config_exists?
   # Ensure that rails/webpacker does not call bin/webpack if we're providing
   # the build command.
   ENV["WEBPACKER_PRECOMPILE"] = "false"

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "12.1.0",
+  "version": "12.4.0",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {

data/rakelib/release.rake

@@ -21,7 +21,7 @@ for the node package version. This only makes a difference for pre-release
 versions such as `3.0.0.beta.1` (yarn version would be `3.0.0-beta.1`).
 
 This task depends on the gem-release (ruby gem) and release-it (node package)
-which are installed via `bundle install` and `yarn`
+which are installed via `bundle install` and `yarn global add release-it`
 
 1st argument: The new version in rubygem format (no dashes). Pass no argument to
               automatically perform a patch version bump.
@@ -58,9 +58,9 @@ task :release, %i[gem_version dry_run tools_install] do |_t, args|
   bundle_install_in(dummy_app_dir)
 
   # Will bump the yarn version, commit, tag the commit, push to repo, and release on yarn
-  release_it_command = +"$(yarn bin)/release-it"
+  release_it_command = +"release-it"
   release_it_command << " #{npm_version}" unless npm_version.strip.empty?
-  release_it_command << " --non-interactive --npm.publish"
+  release_it_command << " --ci --npm.publish --no-git.requireCleanWorkingDir"
   release_it_command << " --dry-run --verbose" if is_dry_run
   sh_in_dir(gem_root, release_it_command)