Quiet bin/dev shutdown on interrupt

Author: justin808

react_on_rails/lib/generators/react_on_rails/rsc_setup.rb

@@ -167,7 +167,7 @@ def add_rsc_to_procfile
             ⚠️  Procfile.dev not found. Skipping RSC bundle watcher addition.
 
             You'll need to add the RSC bundle watcher to your process manager manually:
-              rsc-bundle: RSC_BUNDLE_ONLY=yes bin/shakapacker --watch
+              rsc-bundle: RSC_BUNDLE_ONLY=yes bin/shakapacker-watch --watch
           MSG
           return
         end
@@ -182,7 +182,7 @@ def add_rsc_to_procfile
         rsc_watcher_line = <<~PROCFILE
 
           # React on Rails Pro - RSC bundle watcher
-          rsc-bundle: RSC_BUNDLE_ONLY=yes bin/shakapacker --watch
+          rsc-bundle: RSC_BUNDLE_ONLY=yes bin/shakapacker-watch --watch
         PROCFILE
 
         append_to_file("Procfile.dev", rsc_watcher_line)

react_on_rails/lib/generators/react_on_rails/templates/base/base/Procfile.dev

@@ -6,4 +6,4 @@
 #   SHAKAPACKER_DEV_SERVER_PORT=3036
 rails: bundle exec rails s -p ${PORT:-3000}
 dev-server: bin/shakapacker-dev-server
-server-bundle: SERVER_BUNDLE_ONLY=yes bin/shakapacker --watch
+server-bundle: SERVER_BUNDLE_ONLY=yes bin/shakapacker-watch --watch

react_on_rails/lib/generators/react_on_rails/templates/base/base/Procfile.dev-static-assets

@@ -1,2 +1,2 @@
 web: bin/rails server -p ${PORT:-3000}
-js: bin/shakapacker --watch
+js: bin/shakapacker-watch --watch

react_on_rails/lib/generators/react_on_rails/templates/base/base/bin/shakapacker-watch

@@ -0,0 +1,27 @@
+#!/usr/bin/env sh
+set -eu
+
+child_pid=""
+
+cleanup() {
+  if [ -n "${child_pid}" ] && kill -0 "$child_pid" 2>/dev/null; then
+    kill -TERM "$child_pid" 2>/dev/null || true
+    wait "$child_pid" 2>/dev/null || true
+  fi
+
+  exit 0
+}
+
+trap cleanup INT TERM
+
+bin/shakapacker "$@" &
+child_pid=$!
+
+if wait "$child_pid"; then
+  status=0
+else
+  status=$?
+fi
+
+child_pid=""
+exit "$status"

react_on_rails/lib/react_on_rails/dev/process_manager.rb

@@ -105,6 +105,9 @@ def run_process_if_available(process, args)
 
           # Process not available in either context
           nil
+        rescue Interrupt
+          # Ctrl-C during overmind/foreman shutdown should exit quietly.
+          true
         end
 
         # Run a process outside of bundler context

react_on_rails/spec/dummy/Procfile.dev

@@ -2,7 +2,7 @@
 # You can run these commands in separate shells
 rails: bundle exec rails s -p 3000
 dev-server: bin/shakapacker-dev-server
-server-bundle: SERVER_BUNDLE_ONLY=true bin/shakapacker --watch
+server-bundle: SERVER_BUNDLE_ONLY=true bin/shakapacker-watch --watch
 
 # Bundle ReScript .res files
 rescript: pnpm build:rescript:dev

react_on_rails/spec/dummy/Procfile.dev-static-assets

@@ -1,2 +1,2 @@
 web: bin/rails server -p 3000
-js: bin/shakapacker --watch
+js: bin/shakapacker-watch --watch

react_on_rails/spec/dummy/Procfile.dev.no.turbolinks

@@ -1,4 +1,4 @@
 # Same as Procfile.dev, but disable turbolinks.
 rails: DISABLE_TURBOLINKS=TRUE bin/rails s -p 3000
 # Build client and server assets, watching for changes.
-webpack: sh -c 'rm -rf public/webpack/development/*' || true && bin/shakapacker --watch
+webpack: sh -c 'rm -rf public/webpack/development/*' || true && bin/shakapacker-watch --watch

react_on_rails/spec/react_on_rails/dev/process_manager_spec.rb

@@ -7,7 +7,7 @@
   describe ".installed?" do
     it "returns true when process is available in current context" do
       expect(Timeout).to receive(:timeout).with(described_class::VERSION_CHECK_TIMEOUT).and_yield
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with("overmind", "--version", out: File::NULL, err: File::NULL).and_return(true)
       expect(described_class).to be_installed("overmind")
     end
@@ -19,20 +19,20 @@
 
     it "returns false when all version flags fail" do
       expect(Timeout).to receive(:timeout).with(described_class::VERSION_CHECK_TIMEOUT).exactly(3).times.and_yield
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with("failing_process", "--version", out: File::NULL, err: File::NULL).and_return(false)
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with("failing_process", "-v", out: File::NULL, err: File::NULL).and_return(false)
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with("failing_process", "-V", out: File::NULL, err: File::NULL).and_return(false)
       expect(described_class.installed?("failing_process")).to be false
     end
 
     it "returns true when second version flag succeeds" do
       expect(Timeout).to receive(:timeout).with(described_class::VERSION_CHECK_TIMEOUT).twice.and_yield
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with("foreman", "--version", out: File::NULL, err: File::NULL).and_return(false)
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with("foreman", "-v", out: File::NULL, err: File::NULL).and_return(true)
       expect(described_class.installed?("foreman")).to be true
     end
@@ -51,15 +51,15 @@
 
     it "exits with error when Procfile does not exist" do
       allow(File).to receive(:exist?).with("Procfile.dev").and_return(false)
-      expect_any_instance_of(Kernel).to receive(:exit).with(1)
+      expect(described_class).to receive(:exit).with(1)
       described_class.ensure_procfile("Procfile.dev")
     end
   end
 
   describe ".run_with_process_manager" do
     before do
       allow(ReactOnRails::Dev::FileManager).to receive(:cleanup_stale_files)
-      allow_any_instance_of(Kernel).to receive(:system).and_return(true)
+      allow(described_class).to receive(:system).and_return(true)
       allow(File).to receive(:readable?).and_return(true)
     end
 
@@ -85,7 +85,7 @@
       expect(described_class).to receive(:run_process_if_available)
         .with("foreman", ["start", "-f", "Procfile.dev"]).and_return(nil)
       expect(described_class).not_to receive(:show_process_manager_installation_help)
-      expect_any_instance_of(Kernel).to receive(:exit).with(1).and_raise(SystemExit)
+      expect(described_class).to receive(:exit).with(1).and_raise(SystemExit)
 
       expect { described_class.run_with_process_manager("Procfile.dev") }.to raise_error(SystemExit)
     end
@@ -96,7 +96,7 @@
       expect(described_class).to receive(:run_process_if_available)
         .with("foreman", ["start", "-f", "Procfile.dev"]).and_return(true)
       expect(described_class).not_to receive(:show_process_manager_installation_help)
-      expect_any_instance_of(Kernel).not_to receive(:exit)
+      expect(described_class).not_to receive(:exit)
 
       described_class.run_with_process_manager("Procfile.dev")
     end
@@ -107,7 +107,7 @@
       expect(described_class).to receive(:run_process_if_available)
         .with("foreman", ["start", "-f", "Procfile.dev"]).and_return(false)
       expect(described_class).not_to receive(:show_process_manager_installation_help)
-      expect_any_instance_of(Kernel).to receive(:exit).with(1).and_raise(SystemExit)
+      expect(described_class).to receive(:exit).with(1).and_raise(SystemExit)
 
       expect { described_class.run_with_process_manager("Procfile.dev") }.to raise_error(SystemExit)
     end
@@ -118,7 +118,7 @@
       expect(described_class).to receive(:run_process_if_available)
         .with("foreman", ["start", "-f", "Procfile.dev"]).and_return(false)
       expect(described_class).not_to receive(:show_process_manager_installation_help)
-      expect_any_instance_of(Kernel).to receive(:exit).with(1).and_raise(SystemExit)
+      expect(described_class).to receive(:exit).with(1).and_raise(SystemExit)
 
       expect { described_class.run_with_process_manager("Procfile.dev") }.to raise_error(SystemExit)
     end
@@ -129,7 +129,7 @@
       expect(described_class).to receive(:run_process_if_available)
         .with("foreman", ["start", "-f", "Procfile.dev"]).and_return(nil)
       expect(described_class).to receive(:show_process_manager_installation_help)
-      expect_any_instance_of(Kernel).to receive(:exit).with(1)
+      expect(described_class).to receive(:exit).with(1)
 
       described_class.run_with_process_manager("Procfile.dev")
     end
@@ -145,7 +145,15 @@
   describe ".run_process_if_available" do
     it "returns true and runs process when available in current context" do
       allow(described_class).to receive(:installed?).with("foreman").and_return(true)
-      expect_any_instance_of(Kernel).to receive(:system).with("foreman", "start", "-f", "Procfile.dev").and_return(true)
+      expect(described_class).to receive(:system).with("foreman", "start", "-f", "Procfile.dev").and_return(true)
+
+      result = described_class.send(:run_process_if_available, "foreman", ["start", "-f", "Procfile.dev"])
+      expect(result).to be true
+    end
+
+    it "returns true when interrupted while waiting on the process manager" do
+      allow(described_class).to receive(:installed?).with("foreman").and_return(true)
+      expect(described_class).to receive(:system).with("foreman", "start", "-f", "Procfile.dev").and_raise(Interrupt)
 
       result = described_class.send(:run_process_if_available, "foreman", ["start", "-f", "Procfile.dev"])
       expect(result).to be true
@@ -173,7 +181,7 @@
   describe ".run_process_outside_bundle" do
     it "uses with_unbundled_context when Bundler is available" do
       expect(described_class).to receive(:with_unbundled_context).and_yield
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with(a_kind_of(Hash), "foreman", "start", "-f", "Procfile.dev")
 
       described_class.send(:run_process_outside_bundle, "foreman", ["start", "-f", "Procfile.dev"])
@@ -185,7 +193,7 @@
       allow(ENV).to receive(:[]).with("SHAKAPACKER_DEV_SERVER_PORT").and_return("3036")
 
       expect(described_class).to receive(:with_unbundled_context).and_yield
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with({ "PORT" => "3001", "SHAKAPACKER_DEV_SERVER_PORT" => "3036" }, "foreman", "start", "-f", "Procfile.dev")
 
       described_class.send(:run_process_outside_bundle, "foreman", ["start", "-f", "Procfile.dev"])
@@ -197,15 +205,15 @@
       allow(ENV).to receive(:[]).with("SHAKAPACKER_DEV_SERVER_PORT").and_return(nil)
 
       expect(described_class).to receive(:with_unbundled_context).and_yield
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with({ "PORT" => "3001" }, "foreman", "start", "-f", "Procfile.dev")
 
       described_class.send(:run_process_outside_bundle, "foreman", ["start", "-f", "Procfile.dev"])
     end
 
     it "falls back to direct system call when Bundler is not available" do
       hide_const("Bundler")
-      expect_any_instance_of(Kernel).to receive(:system).with("foreman", "start", "-f", "Procfile.dev")
+      expect(described_class).to receive(:system).with("foreman", "start", "-f", "Procfile.dev")
 
       described_class.send(:run_process_outside_bundle, "foreman", ["start", "-f", "Procfile.dev"])
     end
@@ -215,7 +223,7 @@
     it "checks process availability outside bundle context with version flags" do
       expect(described_class).to receive(:with_unbundled_context).and_yield
       expect(Timeout).to receive(:timeout).with(described_class::VERSION_CHECK_TIMEOUT).and_yield
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with("foreman", "--version", out: File::NULL, err: File::NULL).and_return(true)
 
       expect(described_class.send(:process_available_in_system?, "foreman")).to be true
@@ -230,9 +238,9 @@
     it "tries multiple version flags before failing" do
       expect(described_class).to receive(:with_unbundled_context).and_yield
       expect(Timeout).to receive(:timeout).with(described_class::VERSION_CHECK_TIMEOUT).twice.and_yield
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with("foreman", "--version", out: File::NULL, err: File::NULL).and_return(false)
-      expect_any_instance_of(Kernel).to receive(:system)
+      expect(described_class).to receive(:system)
         .with("foreman", "-v", out: File::NULL, err: File::NULL).and_return(true)
 
       expect(described_class.send(:process_available_in_system?, "foreman")).to be true

react_on_rails/spec/react_on_rails/generators/install_generator_spec.rb

@@ -36,6 +36,21 @@ def simulate_managed_stock_webpack_files(options = {})
       end
     end
 
+    it "creates the shakapacker watch wrapper and uses it in Procfiles" do
+      assert_file "bin/shakapacker-watch" do |content|
+        expect(content).to include('bin/shakapacker "$@" &')
+        expect(content).to include("trap cleanup INT TERM")
+      end
+
+      assert_file "Procfile.dev" do |content|
+        expect(content).to include("server-bundle: SERVER_BUNDLE_ONLY=yes bin/shakapacker-watch --watch")
+      end
+
+      assert_file "Procfile.dev-static-assets" do |content|
+        expect(content).to include("js: bin/shakapacker-watch --watch")
+      end
+    end
+
     it "installs appropriate transpiler dependencies based on Shakapacker version" do
       assert_file "package.json" do |content|
         package_json = JSON.parse(content)
@@ -1415,6 +1430,7 @@ class ActiveSupport::TestCase
       assert_file "Procfile.dev" do |content|
         expect(content).to include("RSC_BUNDLE_ONLY=yes")
         expect(content).to include("rsc-bundle:")
+        expect(content).to include("bin/shakapacker-watch --watch")
       end
     end