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.


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

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

Instance Method Details

#boot_serverObject


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

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

  pid = Process.spawn(
    gem_env,
    "ruby",
    "-e", "gem 'spring', '#{Spring::VERSION}'; require 'spring/server'; Spring::Server.boot"
  )

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

#callObject


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

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

#cold_runObject


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

def cold_run
  boot_server
  run
end

#connect_to_application(client) ⇒ Object


110
111
112
113
114
115
116
117
118
119
# File 'lib/spring/client/run.rb', line 110

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_envObject


190
191
192
# File 'lib/spring/client/run.rb', line 190

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

#forward_signal(sig, pid) ⇒ Object


170
171
172
173
174
175
176
177
# File 'lib/spring/client/run.rb', line 170

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


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

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

#gem_envObject


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

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, pid) ⇒ Object


179
180
181
# File 'lib/spring/client/run.rb', line 179

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

#log(message) ⇒ Object


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

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

#queue_signalsObject


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

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

#runObject


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

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


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

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


183
184
185
186
187
188
# File 'lib/spring/client/run.rb', line 183

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

  socket.puts  data.bytesize
  socket.write data
end

#serverObject


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

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

#stop_serverObject


91
92
93
94
95
# File 'lib/spring/client/run.rb', line 91

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

#verify_server_versionObject


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

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_runObject


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

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