Module: Isomorfeus::ReactViewHelper

Defined in:
lib/isomorfeus/react_view_helper.rb

Instance Method Summary collapse

Instance Method Details

#cached_mount_component(component_name, props = {}, asset = 'web_ssr.js', static = false) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
 
# File 'lib/isomorfeus/react_view_helper.rb', line 3

def cached_mount_component(component_name, props = {}, asset = 'web_ssr.js', static = false)
  key = "#{component_name}#{props}#{asset}"
  if Isomorfeus.production?
    render_result, @ssr_response_status, @ssr_styles = component_cache.fetch(key)
    return render_result if render_result
  end
  render_result = mount_component(component_name, props, asset, static)
  status = ssr_response_status
  component_cache.store(key, render_result, status, ssr_styles) if status >= 200 && status < 300
  render_result
end

#cached_mount_static_component(component_name, props = {}, asset = 'web_ssr.js') ⇒ Object 



15
16
17
 
# File 'lib/isomorfeus/react_view_helper.rb', line 15

def cached_mount_static_component(component_name, props = {}, asset = 'web_ssr.js')
  cached_mount_component(component_name, props, asset, true)
end

#mount_component(component_name, props = {}, asset = 'web_ssr.js', static = false) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/isomorfeus/react_view_helper.rb', line 19

def mount_component(component_name, props = {}, asset = 'web_ssr.js', static = false)
  @ssr_response_status = nil
  @ssr_styles = nil
  thread_id_asset = "#{Thread.current.object_id}#{asset}"
  render_result = if static
                    '<div>'
                  else
                    "<div data-iso-env=\"#{Isomorfeus.env}\" data-iso-root=\"#{component_name}\" data-iso-props='#{Oj.dump(props, mode: :strict)}'"
                  end
  if Isomorfeus.server_side_rendering

    if Isomorfeus.development?
      # always create a new context, effectively reloading code
      # delete the existing context first, saves memory
      if Isomorfeus.ssr_contexts.key?(thread_id_asset)
        uuid = Isomorfeus.ssr_contexts[thread_id_asset].instance_variable_get(:@uuid)
        runtime = Isomorfeus.ssr_contexts[thread_id_asset].instance_variable_get(:@runtime)
        runtime.vm.delete_context(uuid)
      end
      asset_path = "#{Isomorfeus.ssr_hot_asset_url}#{asset}"
      begin
        asset = Net::HTTP.get(URI(asset_path))
      rescue Exception => e
        Isomorfeus.raise_error(message: "Server Side Rendering: Failed loading asset #{asset_path} from webpack dev server. Error: #{e.message}", stack: e.backtrace )
      end
      if asset.strip.start_with?('<')
        Isomorfeus.raise_error(message: "Server Side Rendering: Failed loading asset #{asset_path} from webpack dev server, asset is not javascript. Did the webpack build succeed?")
      end
      begin
        Isomorfeus.ssr_contexts[thread_id_asset] = ExecJS.permissive_compile(asset)
      rescue Exception => e
        Isomorfeus.raise_error(message: "Server Side Rendering: Failed creating context for #{asset_path}. Error: #{e.message}", stack: e.backtrace)
      end
    else
      # initialize speednode context
      unless Isomorfeus.ssr_contexts.key?(thread_id_asset)
        asset_file_name = OpalWebpackLoader::Manifest.lookup_path_for(asset)
        Isomorfeus.raise_error(message: "Server Side Rendering: Build asset file not found for #{asset}. Has it been build?") unless asset_file_name
        asset_path = File.join('public', asset_file_name)
        Isomorfeus.ssr_contexts[thread_id_asset] = ExecJS.permissive_compile(File.read(asset_path))
      end
    end

    # build javascript for rendering first pass
    # it will initialize buffers to guard against leaks, maybe caused by previous exceptions
    javascript = <<~JAVASCRIPT
      global.Opal.React.render_buffer = [];
      global.Opal.React.active_components = [];
      global.Opal.React.active_redux_components = [];
      global.FirstPassFinished = false;
      global.Exception = false;
      global.IsomorfeusSessionId = '#{Thread.current[:isomorfeus_session_id]}';
      global.Opal.Isomorfeus['$env=']('#{Isomorfeus.env}');
      if (typeof global.Opal.Isomorfeus.$negotiated_locale === 'function') {
        global.Opal.Isomorfeus["$negotiated_locale="]('#{props[:locale]}');
      }
      global.Opal.Isomorfeus['$force_init!']();
      global.Opal.Isomorfeus['$ssr_response_status='](200);
      global.Opal.Isomorfeus.TopLevel['$ssr_route_path=']('#{props[:location]}');
    JAVASCRIPT

    # if location_host and scheme are given and if Transport is loaded, connect and then render,
    # otherwise do not render because only one pass is required
    ws_scheme = props[:location_scheme] == 'https:' ? 'wss:' : 'ws:'
    location_host = props[:location_host] ? props[:location_host] : 'localhost'
    api_ws_path = Isomorfeus.respond_to?(:api_websocket_path) ? Isomorfeus.api_websocket_path : ''
    transport_ws_url = ws_scheme + location_host + api_ws_path
    javascript << <<~JAVASCRIPT
      let api_ws_path = '#{api_ws_path}';
      let exception;
      if (typeof global.Opal.Isomorfeus.Transport !== 'undefined' && api_ws_path !== '') {
        global.Opal.Isomorfeus.TopLevel["$transport_ws_url="]("#{transport_ws_url}");
        global.Opal.send(global.Opal.Isomorfeus.Transport.$promise_connect(), 'then', [], ($$1 = function(){
          try {
            if (#{static}) { global.Opal.Isomorfeus.TopLevel.$render_component_to_static_markup('#{component_name}', #{Oj.dump(props, mode: :strict)}); }
            else { global.Opal.Isomorfeus.TopLevel.$render_component_to_string('#{component_name}', #{Oj.dump(props, mode: :strict)}); }
            global.FirstPassFinished = 'transport';
          } catch (e) {
            global.Exception = e;
            global.FirstPassFinished = 'transport';
          }
        }, $$1.$$s = this, $$1.$$arity = 0, $$1))
      } else { return global.FirstPassFinished = true; };
    JAVASCRIPT

    # execute first render pass
    first_pass_skipped = Isomorfeus.ssr_contexts[thread_id_asset].exec(javascript)

    # wait for first pass to finish
    unless first_pass_skipped
      first_pass_finished, exception = Isomorfeus.ssr_contexts[thread_id_asset].exec('return [global.FirstPassFinished, global.Exception ? { message: global.Exception.message, stack: global.Exception.stack } : false ]')
      Isomorfeus.raise_error(message: "Server Side Rendering: #{exception['message']}", stack: exception['stack']) if exception
      unless first_pass_finished
        start_time = Time.now
        while !first_pass_finished
          break if (Time.now - start_time) > 10
          sleep 0.01
          first_pass_finished = Isomorfeus.ssr_contexts[thread_id_asset].exec('return global.FirstPassFinished')
        end
      end

      # wait for transport requests to finish
      if first_pass_finished == 'transport'
        transport_busy = Isomorfeus.ssr_contexts[thread_id_asset].exec('return global.Opal.Isomorfeus.Transport["$busy?"]()')
        if transport_busy
          start_time = Time.now
          while transport_busy
            break if (Time.now - start_time) > 10
            sleep 0.01
            transport_busy = Isomorfeus.ssr_contexts[thread_id_asset].exec('return global.Opal.Isomorfeus.Transport["$busy?"]()')
          end
        end
      end
    end

    # build javascript for second render pass
    # guard against leaks from first pass, maybe because of a exception
    javascript = <<~JAVASCRIPT
      global.Opal.React.render_buffer = [];
      global.Opal.React.active_components = [];
      global.Opal.React.active_redux_components = [];
      global.Exception = false;
      let rendered_tree;
      let ssr_styles;
      let component;
      if (typeof global.Opal.global.MuiStyles !== 'undefined' && typeof global.Opal.global.MuiStyles.ServerStyleSheets !== 'undefined') {
        component = '#{component_name}'.split(".").reduce(function(o, x) {
          return (o !== null && typeof o[x] !== "undefined" && o[x] !== null) ? o[x] : null;
        }, global.Opal.global)
        if (!component) { component = global.Opal.Isomorfeus.$cached_component_class('#{component_name}'); }
        try {
          let sheets = new global.Opal.global.MuiStyles.ServerStyleSheets();
          let app = global.Opal.React.$create_element(component, global.Opal.Hash.$new(#{Oj.dump(props, mode: :strict)}));
          if (#{static}) { rendered_tree = global.Opal.global.ReactDOMServer.renderToStaticMarkup(sheets.collect(app)); }
          else { rendered_tree = global.Opal.global.ReactDOMServer.renderToString(sheets.collect(app)); }
          ssr_styles = sheets.toString();
        } catch (e) {
          global.Exception = e;
        }
      } else if (typeof global.Opal.global.ReactJSS !== 'undefined' && typeof global.Opal.global.ReactJSS.SheetsRegistry !== 'undefined') {
        component = '#{component_name}'.split(".").reduce(function(o, x) {
          return (o !== null && typeof o[x] !== "undefined" && o[x] !== null) ? o[x] : null;
        }, global.Opal.global)
        if (!component) { component = global.Opal.Isomorfeus.$cached_component_class('#{component_name}'); }
        try {
          let sheets = new global.Opal.global.ReactJSS.SheetsRegistry();
          let generate_id = global.Opal.global.ReactJSS.createGenerateId();
          let app = global.Opal.React.$create_element(component, global.Opal.Hash.$new(#{Oj.dump(props, mode: :strict)}));
          let element = global.Opal.global.React.createElement(global.Opal.global.ReactJSS.JssProvider, { registry: sheets, generateId: generate_id }, app);
          if (#{static}) { rendered_tree = global.Opal.global.ReactDOMServer.renderToStaticMarkup(element); }
          else { rendered_tree = global.Opal.global.ReactDOMServer.renderToString(element); }
          ssr_styles = sheets.toString();
        } catch (e) {
          global.Exception = e;
        }
      } else {
        try {
          if (#{static}) { rendered_tree = global.Opal.Isomorfeus.TopLevel.$render_component_to_static_markup('#{component_name}', #{Oj.dump(props, mode: :strict)}); } 
          else { rendered_tree = global.Opal.Isomorfeus.TopLevel.$render_component_to_string('#{component_name}', #{Oj.dump(props, mode: :strict)}); }
        } catch (e) {
          global.Exception = e;
        }
      }
      let application_state = global.Opal.Isomorfeus.store.native.getState();
      if (typeof global.Opal.Isomorfeus.Transport !== 'undefined') { global.Opal.Isomorfeus.Transport.$disconnect(); }
      return [rendered_tree, application_state, ssr_styles, global.Opal.Isomorfeus['$ssr_response_status'](), global.Exception ? { message: global.Exception.message, stack: global.Exception.stack } : false];
    JAVASCRIPT

    # execute second render pass
    rendered_tree, application_state, @ssr_styles, @ssr_response_status, exception = Isomorfeus.ssr_contexts[thread_id_asset].exec(javascript)
    Isomorfeus.raise_error(message: exception['message'], stack: exception['stack']) if exception

    # build result
    unless static
      render_result << " data-iso-hydrated='true'" if rendered_tree
      if Isomorfeus.respond_to?(:current_user) && Isomorfeus.current_user && !Isomorfeus.current_user.anonymous?
        render_result << " data-iso-usid=#{Oj.dump(Isomorfeus.current_user.to_sid, mode: :strict)}"
      end
      render_result << " data-iso-nloc='#{props[:locale]}'>"
    end
    render_result << (rendered_tree ? rendered_tree : "SSR didn't work")
  else
    if Isomorfeus.respond_to?(:current_user) && Isomorfeus.current_user && !Isomorfeus.current_user.anonymous?
      render_result << " data-iso-usid=#{Oj.dump(Isomorfeus.current_user.to_sid, mode: :strict)}"
    end
    render_result << " data-iso-nloc='#{props[:locale]}'>" unless static
  end
  render_result << '</div>'
  if Isomorfeus.server_side_rendering && !static
    render_result = "<script type='application/javascript'>\nServerSideRenderingStateJSON = #{Oj.dump(application_state, mode: :strict)}\n</script>\n" << render_result
  end
  render_result
end

#mount_static_component(component_name, props = {}, asset = 'web_ssr.js') ⇒ Object 



213
214
215
 
# File 'lib/isomorfeus/react_view_helper.rb', line 213

def mount_static_component(component_name, props = {}, asset = 'web_ssr.js')
  mount_component(component_name, props, asset, true)
end

#ssr_response_status ⇒ Object 



217
218
219
 
# File 'lib/isomorfeus/react_view_helper.rb', line 217

def ssr_response_status
  @ssr_response_status || 200
end

#ssr_styles ⇒ Object 



221
222
223
 
# File 'lib/isomorfeus/react_view_helper.rb', line 221

def ssr_styles
  @ssr_styles || ''
end