Class: ReactOnRails::Dev::ServerManager

Inherits:
Object
  • Object
show all
Defined in:
lib/react_on_rails/dev/server_manager.rb

Constant Summary collapse

HELP_FLAGS = 
["-h", "--help"].freeze
TEST_WATCH_MODES = 
%w[auto full client-only].freeze
FLAGS_WITH_VALUES =

Flags that take a value as the next argument (not using = syntax)

%w[--route --rails-env --test-watch-mode].freeze

Class Method Summary collapse

Class Method Details

.cleanup_socket_files ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 118

def cleanup_socket_files
  files = [".overmind.sock", "tmp/sockets/overmind.sock", "tmp/pids/server.pid"]
  killed_any = false

  files.each do |file|
    next unless File.exist?(file)

    puts "   🧹 Removing #{file}"
    File.delete(file)
    killed_any = true
  rescue StandardError
    nil
  end

  killed_any
end

.development_processes ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 47

def development_processes
  {
    "rails" => "Rails server",
    "node.*react[-_]on[-_]rails" => "React on Rails Node processes",
    "overmind" => "Overmind process manager",
    "foreman" => "Foreman process manager",
    "ruby.*puma" => "Puma server",
    "webpack-dev-server" => "Webpack dev server",
    "bin/shakapacker-dev-server" => "Shakapacker dev server"
  }
end

.find_port_pids(port) ⇒ Object 



110
111
112
113
114
115
116
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 110

def find_port_pids(port)
  stdout, _status = Open3.capture2("lsof", "-ti", ":#{port}", err: File::NULL)
  stdout.split("\n").map(&:to_i).reject { |pid| pid == Process.pid }
rescue StandardError
  # lsof command not found or other error (permission denied, etc.)
  []
end

.find_process_pids(pattern) ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 74

def find_process_pids(pattern)
  stdout, _status = Open3.capture2("pgrep", "-f", pattern, err: File::NULL)
  stdout.split("\n").map(&:to_i).reject { |pid| pid == Process.pid }
rescue Errno::ENOENT
  # pgrep command not found
  []
end

.kill_port_processes(ports) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 95

def kill_port_processes(ports)
  killed_any = false

  ports.each do |port|
    pids = find_port_pids(port)
    next unless pids.any?

    puts "   ☠️  Killing process on port #{port} (PIDs: #{pids.join(', ')})"
    terminate_processes(pids)
    killed_any = true
  end

  killed_any
end

.kill_processes ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 38

def kill_processes
  puts "🔪 Killing all development processes..."
  puts ""

  killed_any = kill_running_processes || kill_port_processes([3000, 3001]) || cleanup_socket_files

  print_kill_summary(killed_any)
end

.kill_running_processes ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 59

def kill_running_processes
  killed_any = false

  development_processes.each do |pattern, description|
    pids = find_process_pids(pattern)
    next unless pids.any?

    puts "   ☠️  Killing #{description} (PIDs: #{pids.join(', ')})"
    terminate_processes(pids)
    killed_any = true
  end

  killed_any
end

.print_kill_summary(killed_any) ⇒ Object 



135
136
137
138
139
140
141
142
143
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 135

def print_kill_summary(killed_any)
  if killed_any
    puts ""
    puts "✅ All processes terminated and sockets cleaned"
    puts "💡 You can now run 'bin/dev' for a clean start"
  else
    puts "   ℹ️  No development processes found running"
  end
end

.run_from_command_line(args = ARGV) ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength



163
164
165
166
167
168
169
170
171
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
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 163

def run_from_command_line(args = ARGV)
  require "optparse"

  # Get the command early to check for help/kill before running hooks
  # We need to do this before OptionParser processes flags like -h/--help
  # Skip arguments that are values for flags (e.g., "hello_world" after "--route")
  command = extract_command_from_args(args)

  # Check if help flags are present in args (before OptionParser processes them)
  help_requested = args.any? { |arg| HELP_FLAGS.include?(arg) }

  options = { route: nil, rails_env: nil, verbose: false, skip_database_check: false, test_watch_mode: "auto" }

  OptionParser.new do |opts|
    opts.banner = "Usage: dev [command] [options]"

    opts.on("--route ROUTE", "Specify the route to display in URLs (default: root)") do |route|
      options[:route] = route
    end

    opts.on("--rails-env ENV", "Override RAILS_ENV for assets:precompile step only (prod mode only)") do |env|
      options[:rails_env] = env
    end

    opts.on("-v", "--verbose", "Enable verbose output for pack generation") do
      options[:verbose] = true
    end

    opts.on("--skip-database-check", "Skip database connectivity check (saves ~1-2s startup time)") do
      options[:skip_database_check] = true
    end

    opts.on("--test-watch-mode MODE",
            "For `bin/dev test-watch`: auto (default), full, or client-only") do |mode|
      options[:test_watch_mode] = mode
    end

    opts.on("-h", "--help", "Prints this help") do
      show_help
      exit
    end
  end.parse!(args)

  # Run precompile hook once before starting any mode (except kill/help)
  # Then set environment variable to prevent duplicate execution in spawned processes.
  # Note: We always set SHAKAPACKER_SKIP_PRECOMPILE_HOOK=true (even when no hook is configured)
  # to provide a consistent signal that bin/dev is managing the precompile lifecycle.
  # This allows custom scripts to detect bin/dev's presence and adjust behavior accordingly.
  unless %w[kill help].include?(command) || help_requested
    run_precompile_hook_if_present
    ENV["SHAKAPACKER_SKIP_PRECOMPILE_HOOK"] = "true"
  end

  # Main execution
  case command
  when "production-assets", "prod"
    start(:production_like, nil, verbose: options[:verbose], route: options[:route],
                                 rails_env: options[:rails_env],
                                 skip_database_check: options[:skip_database_check])
  when "static"
    start(:static, "Procfile.dev-static-assets", verbose: options[:verbose], route: options[:route],
                                                 skip_database_check: options[:skip_database_check])
  when "kill"
    kill_processes
  when "help"
    show_help
  when "test-watch"
    run_test_watch(test_watch_mode: options[:test_watch_mode])
  when "hmr", nil
    start(:development, "Procfile.dev", verbose: options[:verbose], route: options[:route],
                                        skip_database_check: options[:skip_database_check])
  else
    puts "Unknown argument: #{command}"
    puts "Run 'dev help' for usage information"
    exit 1
  end
end

.show_help ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 145

def show_help
  puts help_usage
  puts ""
  puts help_commands
  puts ""
  puts help_options
  puts ""
  puts help_customization
  puts ""
  puts help_mode_details
  puts ""
  puts help_troubleshooting
end

.start(mode = :development, procfile = nil, verbose: false, route: nil, rails_env: nil, skip_database_check: false) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 19

def start(mode = :development, procfile = nil, verbose: false, route: nil, rails_env: nil,
          skip_database_check: false)
  case mode
  when :production_like
    run_production_like(_verbose: verbose, route: route, rails_env: rails_env,
                        skip_database_check: skip_database_check)
  when :static
    procfile ||= "Procfile.dev-static-assets"
    run_static_development(procfile, verbose: verbose, route: route,
                                     skip_database_check: skip_database_check)
  when :development, :hmr
    procfile ||= "Procfile.dev"
    run_development(procfile, verbose: verbose, route: route,
                              skip_database_check: skip_database_check)
  else
    raise ArgumentError, "Unknown mode: #{mode}"
  end
end

.terminate_processes(pids) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/react_on_rails/dev/server_manager.rb', line 82

def terminate_processes(pids)
  pids.each do |pid|
    Process.kill("TERM", pid)
  rescue Errno::ESRCH, ArgumentError, RangeError
    # Process already stopped, or invalid signal/PID - silently skip
    nil
  rescue Errno::EPERM
    # Permission denied - warn the user
    puts "   ⚠️  Process #{pid} - permission denied (process owned by another user)"
    nil
  end
end