Class: Spring::Client::Run

Inherits:
Command
  • Object
show all
Defined in:
lib/spring/client/run.rb

Constant Summary collapse

FORWARDED_SIGNALS = 
%w(INT QUIT USR1 USR2 INFO WINCH) & Signal.list.keys
CONNECT_TIMEOUT = 
1
BOOT_TIMEOUT = 
20

Instance Attribute Summary collapse

Attributes inherited from Command

#args, #env

Instance Method Summary collapse

Methods inherited from Command

call

Constructor Details

#initialize(args) ⇒ Run

Returns a new instance of Run.



14
15
16
17
18
19
 
# File 'lib/spring/client/run.rb', line 14

def initialize(args)
  super

  @signal_queue  = []
  @server_booted = false
end

Instance Attribute Details

#server ⇒ Object (readonly)

Returns the value of attribute server.



12
13
14
 
# File 'lib/spring/client/run.rb', line 12

def server
  @server
end

Instance Method Details

#boot_server ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/spring/client/run.rb', line 73

def boot_server
  env.socket_path.unlink if env.socket_path.exist?

  pid     = Process.spawn(gem_env, env.server_command, out: File::NULL)
  timeout = Time.now + BOOT_TIMEOUT

  @server_booted = true

  until env.socket_path.exist?
    _, status = Process.waitpid2(pid, Process::WNOHANG)

    if status
      exit status.exitstatus
    elsif Time.now > timeout
      $stderr.puts "Starting Spring server with `#{env.server_command}` " \
                   "timed out after #{BOOT_TIMEOUT} seconds"
      exit 1
    end

    sleep 0.1
  end
end

#call ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/spring/client/run.rb', line 29

def call
  begin
    connect
  rescue Errno::ENOENT, Errno::ECONNRESET, Errno::ECONNREFUSED
    cold_run
  else
    warm_run
  end
ensure
  server.close if server
end

#cold_run ⇒ Object 



55
56
57
58
59
 
# File 'lib/spring/client/run.rb', line 55

def cold_run
  boot_server
  connect
  run
end

#connect ⇒ Object 



25
26
27
 
# File 'lib/spring/client/run.rb', line 25

def connect
  @server = UNIXSocket.open(env.socket_name)
end

#connect_to_application(client) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
 
# File 'lib/spring/client/run.rb', line 133

def connect_to_application(client)
  server.send_io client
  send_json server, "args" => args, "default_rails_env" => default_rails_env

  if IO.select([server], [], [], CONNECT_TIMEOUT)
    server.gets or raise CommandNotFound
  else
    raise "Error connecting to Spring server"
  end
end

#default_rails_env ⇒ Object 



227
228
229
 
# File 'lib/spring/client/run.rb', line 227

def default_rails_env
  ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
end

#forward_signal(sig, application) ⇒ Object 



206
207
208
209
210
211
212
213
 
# File 'lib/spring/client/run.rb', line 206

def forward_signal(sig, application)
  if kill(sig, application) != 0
    # If the application process is gone, then don't block the
    # signal on this process.
    trap(sig, 'DEFAULT')
    Process.kill(sig, Process.pid)
  end
end

#forward_signals(application) ⇒ Object 



198
199
200
201
202
203
204
 
# File 'lib/spring/client/run.rb', line 198

def forward_signals(application)
  @signal_queue.each { |sig| kill sig, application }

  FORWARDED_SIGNALS.each do |sig|
    trap(sig) { forward_signal sig, application }
  end
end

#gem_env ⇒ Object 



100
101
102
103
104
105
106
107
108
 
# File 'lib/spring/client/run.rb', line 100

def gem_env
  bundle = Bundler.bundle_path.to_s
  paths  = Gem.path + ENV["GEM_PATH"].to_s.split(File::PATH_SEPARATOR)

  {
    "GEM_PATH" => [bundle, *paths].uniq.join(File::PATH_SEPARATOR),
    "GEM_HOME" => bundle
  }
end

#kill(sig, application) ⇒ Object 



215
216
217
218
 
# File 'lib/spring/client/run.rb', line 215

def kill(sig, application)
  application.puts(sig)
  application.gets.to_i
end

#log(message) ⇒ Object 



21
22
23
 
# File 'lib/spring/client/run.rb', line 21

def log(message)
  env.log "[client] #{message}"
end

#queue_signals ⇒ Object 



180
181
182
183
184
 
# File 'lib/spring/client/run.rb', line 180

def queue_signals
  FORWARDED_SIGNALS.each do |sig|
    trap(sig) { @signal_queue << sig }
  end
end

#run ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/spring/client/run.rb', line 61

def run
  verify_server_version

  application, client = UNIXSocket.pair

  queue_signals
  connect_to_application(client)
  run_command(client, application)
rescue Errno::ECONNRESET
  exit 1
end

#run_command(client, application) ⇒ Object 



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
 
# File 'lib/spring/client/run.rb', line 144

def run_command(client, application)
  log "sending command"

  application.send_io STDOUT
  application.send_io STDERR
  application.send_io STDIN

  send_json application, "args" => args, "env" => ENV.to_hash

  pid = server.gets
  pid = pid.chomp if pid

  # We must not close the client socket until we are sure that the application has
  # received the FD. Otherwise the FD can end up getting closed while it's in the server
  # socket buffer on OS X. This doesn't happen on Linux.
  client.close

  if pid && !pid.empty?
    log "got pid: #{pid}"

    suspend_resume_on_tstp_cont(pid)

    forward_signals(application)
    status = application.read.to_i

    log "got exit status #{status}"

    exit status
  else
    log "got no pid"
    exit 1
  end
ensure
  application.close
end

#send_json(socket, data) ⇒ Object 



220
221
222
223
224
225
 
# File 'lib/spring/client/run.rb', line 220

def send_json(socket, data)
  data = JSON.dump(data)

  socket.puts  data.bytesize
  socket.write data
end

#server_booted? ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/spring/client/run.rb', line 96

def server_booted?
  @server_booted
end

#stop_server ⇒ Object 



110
111
112
113
114
 
# File 'lib/spring/client/run.rb', line 110

def stop_server
  server.close
  @server = nil
  env.stop
end

#suspend_resume_on_tstp_cont(pid) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/spring/client/run.rb', line 186

def suspend_resume_on_tstp_cont(pid)
  trap("TSTP") {
    log "suspended"
    Process.kill("STOP", pid.to_i)
    Process.kill("STOP", Process.pid)
  }
  trap("CONT") {
    log "resumed"
    Process.kill("CONT", pid.to_i)
  }
end

#verify_server_version ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/spring/client/run.rb', line 116

def verify_server_version
  server_version = server.gets.chomp
  if server_version != env.version
    $stderr.puts "There is a version mismatch between the Spring client " \
                   "(#{env.version}) and the server (#{server_version})."

    if server_booted?
      $stderr.puts "We already tried to reboot the server, but the mismatch is still present."
      exit 1
    else
      $stderr.puts "Restarting to resolve."
      stop_server
      cold_run
    end
  end
end

#warm_run ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/spring/client/run.rb', line 41

def warm_run
  run
rescue CommandNotFound
  require "spring/commands"

  if Spring.command?(args.first)
    # Command installed since Spring started
    stop_server
    cold_run
  else
    raise
  end
end