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) & Signal.list.keys
TIMEOUT = 
1

Instance Attribute Summary

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.



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

def initialize(args)
  super
  @signal_queue = []
end

Instance Method Details

#boot_server ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/spring/client/run.rb', line 64

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

  # The GEM_HOME handling is to work around a problem with spring binstubs
  # generated prior to 1.3.0.
  pid = Process.spawn(
    ENV["GEM_HOME"] == "" ? { "GEM_HOME" => nil } : {},
    "ruby",
    "-r", "spring/server",
    "-e", "Spring::Server.boot"
  )

  until env.socket_path.exist?
    _, status = Process.waitpid2(pid, Process::WNOHANG)
    exit status.exitstatus if status
    sleep 0.1
  end
end

#call ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/spring/client/run.rb', line 23

def call
  if env.server_running?
    warm_run
  else
    cold_run
  end
rescue Errno::ECONNRESET
  exit 1
ensure
  server.close if @server
end

#cold_run ⇒ Object 



49
50
51
52
 
# File 'lib/spring/client/run.rb', line 49

def cold_run
  boot_server
  run
end

#connect_to_application(client) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/spring/client/run.rb', line 102

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

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

#default_rails_env ⇒ Object 



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

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

#forward_signal(sig, pid) ⇒ Object 



162
163
164
165
166
167
168
169
 
# File 'lib/spring/client/run.rb', line 162

def forward_signal(sig, pid)
  kill(sig, pid)
rescue Errno::ESRCH
  # If the application process is gone, then don't block the
  # signal on this process.
  trap(sig, 'DEFAULT')
  Process.kill(sig, Process.pid)
end

#forward_signals(pid) ⇒ Object 



153
154
155
156
157
158
159
160
 
# File 'lib/spring/client/run.rb', line 153

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

  FORWARDED_SIGNALS.each do |sig|
    trap(sig) { forward_signal sig, pid }
  end
rescue Errno::ESRCH
end

#kill(sig, pid) ⇒ Object 



171
172
173
 
# File 'lib/spring/client/run.rb', line 171

def kill(sig, pid)
  Process.kill(sig, -Process.getpgid(pid))
end

#log(message) ⇒ Object 



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

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

#queue_signals ⇒ Object 



147
148
149
150
151
 
# File 'lib/spring/client/run.rb', line 147

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

#run ⇒ Object 



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

def run
  verify_server_version

  application, client = UNIXSocket.pair

  queue_signals
  connect_to_application(client)
  run_command(client, application)
end

#run_command(client, application) ⇒ Object 



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

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}"

    forward_signals(pid.to_i)
    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 



175
176
177
178
179
180
 
# File 'lib/spring/client/run.rb', line 175

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

  socket.puts  data.bytesize
  socket.write data
end

#server ⇒ Object 



19
20
21
 
# File 'lib/spring/client/run.rb', line 19

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

#stop_server ⇒ Object 



83
84
85
86
87
 
# File 'lib/spring/client/run.rb', line 83

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

#verify_server_version ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/spring/client/run.rb', line 89

def verify_server_version
  server_version = server.gets.chomp
  if server_version != env.version
    $stderr.puts <<-ERROR
There is a version mismatch between the spring client and the server.
You should restart the server and make sure to use the same version.

CLIENT: #{env.version}, SERVER: #{server_version}
ERROR
    exit 1
  end
end

#warm_run ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/spring/client/run.rb', line 35

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