Class: SvelteOnRails::SsrServer

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dry_run_ppid: nil) ⇒ SsrServer

Returns a new instance of SsrServer.



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

def initialize(dry_run_ppid: nil)

  SvelteOnRails::Lib::Utils.secure_debug_log("SOR Server initialize called")

  @socket_namespace = [
    "svelte-ssr",
    Rails.application.class.module_parent_name[0..30],
    Rails.env,
  ].join("-")
  @dry_run_ppid = dry_run_ppid if dry_run_ppid

  @logfile_path = Rails.root.join("log/svelte-ssr-server-#{Rails.env}.log")
  @logfile_max_lines = build_logfile_max_lines
  @socket_path = build_socket_path
  @use_ssr_server = SvelteOnRails::Configuration.instance.configs[:use_ssr_server]
  @node_bin = SvelteOnRails::Configuration.instance.node_bin_path
  @ssr_server_bin_path = Rails.root.join(Pathname('node_modules/@csedl/svelte-on-rails/bin/svelte-ssr-server.js'))
  @ssr_server_ppid_file = Rails.root.join("tmp", "pids", 'svelte_on_rails.ppid')

  if @use_ssr_server && defined?(Rails::Server)
    SvelteOnRails::Lib::Utils.secure_debug_log("SOR using svelte-ssr-server called, now starting node-server...")

    start_node_server!

    at_exit do
      kill_my_server
    end
  end

end

Instance Attribute Details

#logfile_max_lines ⇒ Object (readonly)

Returns the value of attribute logfile_max_lines.



9
10
11
 
# File 'lib/svelte_on_rails/ssr_server.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_server.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_server.rb', line 9

def node_bin
  @node_bin
end

#socket_namespace ⇒ Object (readonly)

Returns the value of attribute socket_namespace.



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

def socket_namespace
  @socket_namespace
end

#socket_path ⇒ Object (readonly)

Returns the value of attribute socket_path.



9
10
11
 
# File 'lib/svelte_on_rails/ssr_server.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_server.rb', line 9

def ssr_server_bin_path
  @ssr_server_bin_path
end

#ssr_server_ppid_file ⇒ Object (readonly)

Returns the value of attribute ssr_server_ppid_file.



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

def ssr_server_ppid_file
  @ssr_server_ppid_file
end

Class Method Details

.instance(dry_run_ppid: nil) ⇒ Object

methods



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

def self.instance(dry_run_ppid: nil)
  SvelteOnRails::Lib::Utils.secure_debug_log("SOR Server instance called")
  @instance ||= new(dry_run_ppid: dry_run_ppid)
end

Instance Method Details

#alive? ⇒ Boolean

Returns:

  • (Boolean) 


267
268
269
 
# File 'lib/svelte_on_rails/ssr_server.rb', line 267

def alive?
  @alive
end

#configured? ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/svelte_on_rails/ssr_server.rb', line 143

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

#kill_leftover_processes ⇒ Object 



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

def kill_leftover_processes
  stdout, stderr, status = Open3.capture3(
    "ps aux | grep svelte"
  )

  leftover = stdout.split("\n").map do |line|
    if line.match?(/\/#{@socket_namespace}-[0-9]+.sock$/)
      unless line.match?(/\/#{@socket_namespace}-#{Process.ppid}.sock$/)
        line.match(/[0-9]+/).to_s.to_i
      end
    end
  end.compact

  stdout, stderr, status = Open3.capture3(
    "kill #{leftover.join(' ')}"
  )

  start_server_log(nil, "Killed #{leftover.length} leftover processes") if leftover.length >= 1
end

#kill_my_server ⇒ Object 



248
249
250
251
252
253
 
# File 'lib/svelte_on_rails/ssr_server.rb', line 248

def kill_my_server
  Process.kill("SIGINT", (node_server_pid || 0)) if node_server_pid
  File.delete(@ssr_server_ppid_file)
rescue

end

#node_server_pid ⇒ Object 



271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/svelte_on_rails/ssr_server.rb', line 271

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

#parse_body_json(response_string) ⇒ Object 



133
134
135
136
137
138
139
140
141
 
# File 'lib/svelte_on_rails/ssr_server.rb', line 133

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) 


147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/svelte_on_rails/ssr_server.rb', line 147

def ping?
  @alive = false
  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
    @alive = r['status'] == 'alive'
  end
end

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



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

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
    if e.is_a?(Errno::ECONNREFUSED)
      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 }
    else
      raise e
    end
    restart_my_server
  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 ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/svelte_on_rails/ssr_server.rb', line 255

def restart_my_server
  return unless @server_restarted_time > 1.minutes.ago
  @server_restarted_count ||= 1
  kill_my_server
  begin
    start_node_server!("Restart-after-failure-#{@server_restarted_count}")
    @server_restarted_time = Time.now
    @server_restarted_count += 1
  rescue
  end
end

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



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

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

  SvelteOnRails::Lib::Utils.secure_debug_log("SOR start_node_server! called")

  # notice ppid
  unless @dry_run_ppid
    FileUtils.mkdir_p(@ssr_server_ppid_file.dirname)
    File.write(@ssr_server_ppid_file, Process.ppid.to_s)
  end

  start = Time.now
  cmd = [
    "SVELTE_SSR_SERVER_STARTED_BY=r#{started_by}",
    @node_bin,
    @ssr_server_bin_path,
    @socket_path
  ].join(' ')

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

  until node_server_pid do
    sleep 0.12
    start_server_log(start, "Waiting for node server process-id")
    start_server_timeout!(start)
  end

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

  until ping? do
    start_server_log(start, "Waiting for successful server-response")
    start_server_timeout!(start)
    sleep 0.1
  end
  start_server_log(start, "Server responded successfully")

  kill_leftover_processes
end