Class: Spring::Server

Inherits:
Object
  • Object
show all
Defined in:
lib/spring/server.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(env = Env.new) ⇒ Server

Returns a new instance of Server.



32
33
34
35
36
37
 
# File 'lib/spring/server.rb', line 32

def initialize(env = Env.new)
  @env          = env
  @applications = Hash.new { |h, k| h[k] = ApplicationManager.new(self, k) }
  @pidfile      = env.pidfile_path.open('a')
  @mutex        = Mutex.new
end

Instance Attribute Details

#env ⇒ Object (readonly)

Returns the value of attribute env.



30
31
32
 
# File 'lib/spring/server.rb', line 30

def env
  @env
end

Class Method Details

.boot ⇒ Object 



26
27
28
 
# File 'lib/spring/server.rb', line 26

def self.boot
  new.boot
end

Instance Method Details

#application_starting ⇒ Object 



152
153
154
 
# File 'lib/spring/server.rb', line 152

def application_starting
  @mutex.synchronize { exit if env.bundle_mtime != @bundle_mtime }
end

#boot ⇒ Object 



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

def boot
  Spring.verify_environment

  write_pidfile
  set_pgid
  ignore_signals
  set_exit_hook
  set_process_title
  watch_bundle
  start_server
end

#ignore_signals ⇒ Object

Ignore SIGINT and SIGQUIT otherwise the user typing ^C or ^\ on the command line will kill the server/application.



103
104
105
 
# File 'lib/spring/server.rb', line 103

def ignore_signals
  IGNORE_SIGNALS.each { |sig| trap(sig,  "IGNORE") }
end

#log(message) ⇒ Object 



39
40
41
 
# File 'lib/spring/server.rb', line 39

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

#rails_env_for(args, default_rails_env) ⇒ Object 



84
85
86
87
88
89
90
91
92
 
# File 'lib/spring/server.rb', line 84

def rails_env_for(args, default_rails_env)
  command = Spring.command(args.first)

  if command.respond_to?(:env)
    env = command.env(args.drop(1))
  end

  env || default_rails_env
end

#redirect_output ⇒ Object

We need to redirect STDOUT and STDERR, otherwise the server will keep the original FDs open which would break piping. (e.g. ‘spring rake -T | grep db` would hang forever because the server would keep the stdout FD open.)



138
139
140
 
# File 'lib/spring/server.rb', line 138

def redirect_output
  [STDOUT, STDERR].each { |stream| stream.reopen(env.log_file) }
end

#serve(client) ⇒ Object 



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

def serve(client)
  log "accepted client"
  client.puts env.version

  app_client = client.recv_io
  command    = JSON.load(client.read(client.gets.to_i))

  args, default_rails_env = command.values_at('args', 'default_rails_env')

  if Spring.command?(args.first)
    log "running command #{args.first}"
    client.puts
    client.puts @applications[rails_env_for(args, default_rails_env)].run(app_client)
  else
    log "command not found #{args.first}"
    client.close
  end
rescue SocketError => e
  raise e unless client.eof?
ensure
  redirect_output
end

#set_exit_hook ⇒ Object 



107
108
109
110
111
112
 
# File 'lib/spring/server.rb', line 107

def set_exit_hook
  server_pid = Process.pid

  # We don't want this hook to run in any forks of the current process
  at_exit { shutdown if Process.pid == server_pid }
end

#set_pgid ⇒ Object

Boot the server into the process group of the current session. This will cause it to be automatically killed once the session ends (i.e. when the user closes their terminal).



97
98
99
 
# File 'lib/spring/server.rb', line 97

def set_pgid
  Process.setpgid(0, SID.pgid)
end

#set_process_title ⇒ Object 



142
143
144
145
146
 
# File 'lib/spring/server.rb', line 142

def set_process_title
  ProcessTitleUpdater.run { |distance|
    "spring server | #{env.app_name} | started #{distance} ago"
  }
end

#shutdown ⇒ Object 



114
115
116
117
118
119
120
121
122
 
# File 'lib/spring/server.rb', line 114

def shutdown
  @applications.values.each(&:stop)

  [env.socket_path, env.pidfile_path].each do |path|
    if path.exist?
      path.unlink rescue nil
    end
  end
end

#start_server ⇒ Object 



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

def start_server
  server = UNIXServer.open(env.socket_name)
  log "started on #{env.socket_name}"
  loop { serve server.accept }
end

#watch_bundle ⇒ Object 



148
149
150
 
# File 'lib/spring/server.rb', line 148

def watch_bundle
  @bundle_mtime = env.bundle_mtime
end

#write_pidfile ⇒ Object 



124
125
126
127
128
129
130
131
132
 
# File 'lib/spring/server.rb', line 124

def write_pidfile
  if @pidfile.flock(File::LOCK_EX | File::LOCK_NB)
    @pidfile.truncate(0)
    @pidfile.write("#{Process.pid}\n")
    @pidfile.fsync
  else
    exit 1
  end
end