Class: SvelteOnRails::SsrClient

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
lib/svelte_on_rails/ssr_client.rb

Defined Under Namespace

Classes: SsrProcess

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(caller: nil) ⇒ SsrClient

Returns a new instance of SsrClient.



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
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 24

def initialize(caller: nil)

  @initialized_by = caller

  File.open(SvelteOnRails::Lib::Utils.ssr_server_logfile, 'w') do |f|
    f.sync = true
    f.puts("[#{Time.now.utc.iso8601(3)} ppid:#{Process.ppid} pid:#{Process.pid}]   >>>  Logfile deleted on initializing SsrClient, called by #{caller}  <<<")
  end

  @socket_namespace = [
    "svelte",
    Rails.application.class.module_parent_name[0..15],
    Rails.env
  ].join("-")
  @socket_path = socket_path_fresh

  @logfile_path = Rails.root.join("log/svelte-ssr-server-#{Rails.env}.log")
  @logfile_max_lines = build_logfile_max_lines
  @ssr_server = SvelteOnRails::Configuration.instance.configs[:ssr_server]
  @ssr_server_bin_path = SvelteOnRails::Configuration.instance.ssr_server_bin_path
  @started = Time.now

  File.delete(restart_marker_file) if File.exist?(restart_marker_file)

  SvelteOnRails::SsrClientControlChannel.install_control_listener

  if @ssr_server

    start_node_server!

    at_exit do
      shutdown(caller: 'at_exit')
      File.delete(restart_marker_file) if File.exist?(restart_marker_file)
    end
  else
    SvelteOnRails::Lib::Utils.ssr_server_log("SSR Server NOT used => @ssr_server #{@ssr_server}")
    SvelteOnRails::Lib::Utils.ssr_server_log("SSR Server NOT used => @ssr_server #{defined?(Rails::Server)}")
  end

end

Instance Attribute Details

#initialized_by ⇒ Object (readonly)

Returns the value of attribute initialized_by.



9
10
11
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 9

def initialized_by
  @initialized_by
end

#logfile_max_lines ⇒ Object (readonly)

Returns the value of attribute logfile_max_lines.



9
10
11
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 9

def logfile_max_lines
  @logfile_max_lines
end

#logfile_path ⇒ Object (readonly)

Returns the value of attribute logfile_path.



9
10
11
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 9

def logfile_path
  @logfile_path
end

#node_bin ⇒ Object (readonly)

Returns the value of attribute node_bin.



9
10
11
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 9

def node_bin
  @node_bin
end

#socket_path ⇒ Object (readonly)

Returns the value of attribute socket_path.



9
10
11
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 9

def socket_path
  @socket_path
end

#ssr_server_bin_path ⇒ Object (readonly)

Returns the value of attribute ssr_server_bin_path.



9
10
11
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 9

def ssr_server_bin_path
  @ssr_server_bin_path
end

Class Method Details

.instance(caller: nil) ⇒ Object

methods



18
19
20
21
22
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 18

def self.instance(caller: nil)

  @instance ||= new(caller: caller)
  @instance
end

Instance Method Details

#cleanup_leftover_processes ⇒ Object 



308
309
310
311
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 308

def cleanup_leftover_processes
  terminate_node_processes(leftover_processes, label: "leftover")
  delete_sockets(leftover_sockets.map { |s| s[:path] }, label: "leftover")
end

#configured? ⇒ Boolean

Returns:

  • (Boolean) 


154
155
156
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 154

def configured?
  @configured ||= File.exist?(@ssr_server_bin_path)
end

#leftover_processes ⇒ Object 



300
301
302
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 300

def leftover_processes
  scan_processes.reject { |p| p.ppid == Process.ppid }
end

#leftover_sockets ⇒ Object 



304
305
306
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 304

def leftover_sockets
  scan_sockets.reject { |s| s[:ppid] == Process.ppid }
end

#node_server_pid ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 252

def node_server_pid
  stdout, stderr, status = Open3.capture3(
    "ps aux | grep svelte"
  )
  stdout.split("\n").each do |line|
    if line.include?("#{@socket_namespace}-#{Process.ppid}.sock")
      return line.match(/[0-9]+/).to_s.to_i
    end
  end
  nil
end

#own_processes ⇒ Object 



296
297
298
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 296

def own_processes
  scan_processes.select { |p| p.ppid == Process.ppid }
end

#parse_body_json(response_string) ⇒ Object 



144
145
146
147
148
149
150
151
152
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 144

def parse_body_json(response_string)
  return {} unless response_string.to_s.present?

  body = response_string.split("\r\n\r\n", 2)[1]
  json_start = body.index('{')
  json_end = body.rindex('}')
  json_str = body[json_start..json_end]
  JSON.parse(json_str)
end

#ping? ⇒ Boolean

Returns:

  • (Boolean) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 158

def ping?
  shorten_logfile
  unless File.exist?(socket_path)
    return false
  end
  response = ''
  begin
    sock = UNIXSocket.new(socket_path)
    request = "GET /health HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n"
    sock.write(request)
    response = sock.read
    sock.close
  rescue => e
    puts "[SOR] Ping Failed: #{e.message}"
  end
  if response.match?(/^HTTP\/\d\.\d 200/)
    r = parse_body_json(response)
    unless r['version'].split('.').first.to_i >= 14
      puts "[SOR] WARNING: Required SSR Server version is at least 14.x, you have installed @csedl/svelte-on-rails: #{r['version']}"
    end
    r['status'] == 'alive'
  end
end

#render(component, props, debug, view_path_proc) ⇒ Object 



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
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 65

def render(component, props, debug, view_path_proc)

  # fetch asset
  manifest = SvelteOnRails::Configuration.instance.manifest(debug, component[:name])
  _asset_path = manifest[component[:path]]['file']
  full_asset_path = Rails.root.join('public', 'svelte-ssr', _asset_path)

  body_json = { component: full_asset_path, props: props }.to_json

  request = "POST /render HTTP/1.1\r\n" +
            "Host: localhost\r\n" +
            "Content-Type: application/json\r\n" +
            "Content-Length: #{body_json.bytesize}\r\n" +
            "Connection: close\r\n\r\n"

  begin
    socket = UNIXSocket.new(socket_path)
    socket.write(request + body_json)
    response = socket.read
    socket.close
  rescue => e

    restart_my_server('Restart-after-failure')

    SvelteOnRails::Lib::Utils.error_log(
      :ssr_server_unreachable,
      "Render #{component[:file_basename]}.svelte",
      [
        "The SSR Server is not reachable.\nYou may need to restart your app.",
        "#{e}",
        SvelteOnRails::Lib::Utils.backtrace_until_sor(e).join("\n")
      ]
    )
    return { success: false, ssr_server_unreachable: true }

  end

  shorten_logfile

  raw_response = parse_body_json(response)
  if raw_response['status'] == 'SUCCESS'

    htm = raw_response['html'].to_s
                              .gsub('<!--[-->', '')
                              .gsub('<!--]-->', '')
                              .gsub('<!---->', '')

    {
      success: true,
      html: htm,
      head: raw_response['head'].to_s,
    }
  else
    config = SvelteOnRails::Configuration.instance
    comp = Rails.root.join(component[:path]).to_s
    imps = if config.watch_changes?
             _src = config.fetch_source_files(component[:path], false, '')
             sources = _src.select { |f| f != comp }
             (sources.present? ? "\nImports:\n#{sources.join("\n")}" : '')
           else
             ''
           end

    utils = SvelteOnRails::Lib::Utils
    utils.error_log(
      :render_failed,
      "Render #{component[:file_basename]}.svelte",
      [
        raw_response['logs'].to_a.join("\n"),
        "View:\n#{view_path_proc.call}\nComponent:\n#{Rails.root.join(component[:path]).to_s}#{imps}",
      ]
    )
    {
      success: false,
    }
  end

end

#restart_my_server(tag = nil) ⇒ Object 



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 229

def restart_my_server(tag = nil)

  marker = restart_marker_file
  if File.exist?(marker) && File.mtime(marker) > 10.seconds.ago
    SvelteOnRails::Lib::Utils.ssr_server_log("[ERROR] Prevented Server Restart because server was restarted too recently: #{marker}")
    return
  end

  FileUtils.mkdir_p(marker.dirname)
  File.open(marker, "a") { |f| f.puts(Time.now.utc.iso8601) }
  count = File.read(marker).lines.count

  msg = "Restarting SSR server (#{tag})"
  Rails.logger.error(msg)
  SvelteOnRails::Lib::Utils.ssr_server_log("[ERROR] #{msg}")

  shutdown(caller: 'restart')
  begin
    start_node_server!("#{tag.gsub(' ', '-') + '-' if tag}#{count}", restart_after_failure: true)
  rescue
  end
end

#shutdown(caller: '') ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 279

def shutdown(caller: '')
  SsrClient.instance_variable_set(:@instance, nil)
  SvelteOnRails::Lib::Utils.ssr_server_log("Shutting down SSR client, ppid: #{Process.ppid} (#{caller})")
  terminate_node_processes(own_processes, label: "own")
  {
    success: true
  }
rescue => e
  {
    error: e
  }
end

#start_node_server!(started_by = "rails-boot-#{Rails.env}-#{Process.ppid}", restart_after_failure: false) ⇒ Object 



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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 182

def start_node_server!(
  started_by = "rails-boot-#{Rails.env}-#{Process.ppid}",
  restart_after_failure: false
)

  SvelteOnRails::Lib::Utils.ssr_server_log("SOR start_node_server! called", ssr_logfile_only: !restart_after_failure)

  start = Time.now

  @node_server_output = {}
  Thread.new do
    stdout, stderr, status = Open3.capture3(
      start_node_server_command(started_by),
      chdir: Rails.root
    )
    @node_server_output = {
      stdout: stdout,
      stderr: stderr,
      status: status
    }
  end
  SvelteOnRails::Lib::Utils.ssr_server_log("Node Version: #{Configuration.instance.node_version_test}, package version: #{Configuration.instance.npm_package_version_test}")
  SvelteOnRails::Lib::Utils.ssr_server_log("Start running Svelte-SSR-Server... (#{started_by})")

  until node_server_pid do
    sleep 0.12
    SvelteOnRails::Lib::Utils.ssr_server_log("Waiting for node server process-id")
    start_server_timeout!(start)
  end

  until File.exist?(socket_path) do
    sleep 0.1
    SvelteOnRails::Lib::Utils.ssr_server_log("Waiting for socket to be created")
    start_server_timeout!(start)
  end
  SvelteOnRails::Lib::Utils.ssr_server_log("Socket created: #{socket_path}")

  until ping? do
    SvelteOnRails::Lib::Utils.ssr_server_log("Waiting for successful server-response")
    start_server_timeout!(start)
    sleep 0.1
  end
  SvelteOnRails::Lib::Utils.ssr_server_log("Server responded successfully")

  cleanup_leftover_processes
end

#start_node_server_command(started_by = '') ⇒ Object 



268
269
270
271
272
273
274
275
276
277
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 268

def start_node_server_command(started_by = '')
  workers = SvelteOnRails::Configuration.instance.configs[:ssr_server_workers]
  [
    (started_by ? "SVELTE_SSR_SERVER_STARTED_BY=#{started_by}" : nil),
    SvelteOnRails::Configuration.instance.node_bin_path,
    @ssr_server_bin_path,
    socket_path,
    (workers > 1 ? "--workers=#{workers}" : nil)
  ].compact.join(' ')
end

#uptime ⇒ Object 



264
265
266
 
# File 'lib/svelte_on_rails/ssr_client.rb', line 264

def uptime
  Time.now - @started
end