Class: ReactOnRails::ServerRenderingPool::RubyEmbeddedJavaScript

Inherits:
Object
  • Object
show all
Includes:
ScoutApm::Tracer
Defined in:
lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb

Overview

rubocop:disable Metrics/ClassLength

Class Method Summary collapse

Class Method Details

.console_polyfill ⇒ Object

Reimplement console methods for replaying on the client Save a handle to the original console if needed.



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb', line 201

def console_polyfill
  <<~JS
    var debugConsole = console;
    var console = { history: [] };
    ['error', 'log', 'info', 'warn'].forEach(function (level) {
      console[level] = function () {
        var argArray = Array.prototype.slice.call(arguments);
        if (argArray.length > 0) {
          argArray[0] = '[SERVER] ' + argArray[0];
        }
        console.history.push({level: level, arguments: argArray});
      };
    });
  JS
end

.create_js_context ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb', line 130

def create_js_context
  return if ReactOnRails.configuration.server_bundle_js_file.blank?

  bundle_js_code = read_bundle_js_code
  base_js_code = <<~JS
    #{console_polyfill}
    #{execjs_timer_polyfills}
    #{bundle_js_code};
  JS

  file_name = "tmp/base_js_code.js"
  begin
    if ReactOnRails.configuration.trace
      Rails.logger.info do
        "[react_on_rails] Created JavaScript context with file " \
          "#{ReactOnRails::Utils.server_bundle_js_file_path}"
      end
    end
    ExecJS.compile(base_js_code)
  rescue StandardError => e
    msg = "ERROR when compiling base_js_code! " \
          "See file #{file_name} to " \
          "correlate line numbers of error. Error is\n\n#{e.message}" \
          "\n\n#{e.backtrace.join("\n")}" \
          "\n\n#{Utils.default_troubleshooting_section}"
    Rails.logger.error(msg)
    trace_js_code_used("Error when compiling JavaScript code for the context.", base_js_code,
                       file_name, force: true)
    raise e
  end
end

.eval_js(js_code, _render_options) ⇒ Object 



110
111
112
113
114
 
# File 'lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb', line 110

def eval_js(js_code, _render_options)
  @js_context_pool.with do |js_context|
    js_context.eval(js_code)
  end
end

.exec_server_render_js(js_code, render_options, js_evaluator = nil) ⇒ Object

js_code: JavaScript expression that returns a string. render_options: lib/react_on_rails/react_component/render_options.rb Using these options:

trace: saves the executed JS to a file, used in development
logging_on_server: put on server logs, not just in browser console

Returns a Hash:

html: string of HTML for direct insertion on the page by evaluating js_code
consoleReplayScript: script for replaying console
hasErrors: true if server rendering errors

Note, js_code does not have to be based on React. js_code MUST RETURN json stringify Object Calling code will probably call ‘html_safe’ on return value before rendering to the view. rubocop:disable Metrics/CyclomaticComplexity



54
55
56
57
58
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
 
# File 'lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb', line 54

def exec_server_render_js(js_code, render_options, js_evaluator = nil)
  js_evaluator ||= self
  if render_options.trace
    @file_index ||= 1
    trace_js_code_used("Evaluating code to server render.", js_code,
                       "tmp/server-generated-#{@file_index % 10}.js")
    @file_index += 1
  end
  begin
    result = if render_options.streaming?
               js_evaluator.eval_streaming_js(js_code, render_options)
             else
               js_evaluator.eval_js(js_code, render_options)
             end
  rescue StandardError => err
    msg = <<~MSG
      Error evaluating server bundle. Check your webpack configuration.
      ===============================================================
      Caught error:
      #{err.message}
      ===============================================================
    MSG

    if err.message.include?("ReferenceError: self is not defined")
      msg << "\nError indicates that you may have code-splitting incorrectly enabled.\n"
    end
    msg << "\n#{Utils.default_troubleshooting_section}\n"
    raise ReactOnRails::Error, msg, err.backtrace
  end

  return parse_result_and_replay_console_messages(result, render_options) unless render_options.streaming?

  # Streamed component is returned as stream of strings.
  # We need to parse each chunk and replay the console messages.
  result.transform { |chunk| parse_result_and_replay_console_messages(chunk, render_options) }
end

.execjs_timer_polyfills ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb', line 162

def execjs_timer_polyfills
  <<~JS
    function getStackTrace () {
      var stack;
      try {
        throw new Error('');
      }
      catch (error) {
        stack = error.stack || '';
      }
      stack = stack.split('\\n').map(function (line) { return line.trim(); });
      return stack.splice(stack[0] == 'Error' ? 2 : 1);
    }

    function setInterval() {
      #{undefined_for_exec_js_logging('setInterval')}
    }

    function setTimeout() {
      #{undefined_for_exec_js_logging('setTimeout')}
    }

    function clearTimeout() {
      #{undefined_for_exec_js_logging('clearTimeout')}
    }
  JS
end

.read_bundle_js_code ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb', line 116

def read_bundle_js_code
  server_js_file = ReactOnRails::Utils.server_bundle_js_file_path
  if ReactOnRails::Utils.server_bundle_path_is_http?
    file_url_to_string(server_js_file)
  else
    File.read(server_js_file)
  end
rescue StandardError => e
  msg = "You specified server rendering JS file: #{server_js_file}, but it cannot be " \
        "read. You may set the server_bundle_js_file in your configuration to be \"\" to " \
        "avoid this warning.\nError is: #{e}\n\n#{Utils.default_troubleshooting_section}"
  raise ReactOnRails::Error, msg
end

.reset_pool ⇒ Object 



11
12
13
14
15
16
17
 
# File 'lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb', line 11

def reset_pool
  options = {
    size: ReactOnRails.configuration.server_renderer_pool_size,
    timeout: ReactOnRails.configuration.server_renderer_timeout
  }
  @js_context_pool = ConnectionPool.new(options) { create_js_context }
end

.reset_pool_if_server_bundle_was_modified ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb', line 19

def reset_pool_if_server_bundle_was_modified
  return unless ReactOnRails.configuration.development_mode

  # RSC (React Server Components) bundle changes are not monitored here since:
  # 1. RSC is only supported in the Pro version of React on Rails
  # 2. This RubyEmbeddedJavaScript pool is used exclusively in the non-Pro version
  # 3. This pool uses ExecJS for JavaScript evaluation which does not support RSC
  if ReactOnRails::Utils.server_bundle_path_is_http?
    return if @server_bundle_url == ReactOnRails::Utils.server_bundle_js_file_path

    @server_bundle_url = ReactOnRails::Utils.server_bundle_js_file_path
  else
    file_mtime = File.mtime(ReactOnRails::Utils.server_bundle_js_file_path)
    @server_bundle_timestamp ||= file_mtime
    return if @server_bundle_timestamp == file_mtime

    @server_bundle_timestamp = file_mtime
  end
  ReactOnRails::ServerRenderingPool.reset_pool
end

.trace_js_code_used(msg, js_code, file_name = "tmp/server-generated.js", force: false) ⇒ Object

rubocop:enable Metrics/CyclomaticComplexity



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb', line 92

def trace_js_code_used(msg, js_code, file_name = "tmp/server-generated.js", force: false)
  return unless ReactOnRails.configuration.trace || force

  # Set to anything to print generated code.
  File.write(file_name, js_code)
  msg = <<-MSG.strip_heredoc
    #{'Z' * 80}
    [react_on_rails] #{msg}
    JavaScript code used: #{file_name}
    #{'Z' * 80}
  MSG
  if force
    Rails.logger.error(msg)
  else
    Rails.logger.info(msg)
  end
end

.undefined_for_exec_js_logging(function_name) ⇒ Object 



190
191
192
193
194
195
196
197
 
# File 'lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb', line 190

def undefined_for_exec_js_logging(function_name)
  if ReactOnRails.configuration.trace
    "console.error('[React on Rails Rendering] #{function_name} is not defined for server rendering.');\n  " \
      "console.error(getStackTrace().join('\\n'));"
  else
    ""
  end
end