Skip to content

wait for killfunc completion when shutting down current app #670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 19, 2025
Merged

wait for killfunc completion when shutting down current app #670

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
048f3bc
wait for killfunc completion when shutting down current app
istyf Nov 1, 2024
2de6780
Add more key points log.
Jan 19, 2025
69f1d3d
add comments and remove unused variable
Jan 19, 2025
2980523
fix ci lint
Jan 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 92 additions & 56 deletions runner/engine.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"path/filepath"
"strings"
"sync"
"sync/atomic"
"time"

"github.com/gohugoio/hugo/watcher/filenotify"
Expand All @@ -22,16 +23,15 @@ type Engine struct {
watcher filenotify.FileWatcher
debugMode bool
runArgs []string
running bool
running atomic.Bool

eventCh chan string
watcherStopCh chan bool
buildRunCh chan bool
buildRunStopCh chan bool
binStopCh chan bool
binStopCh chan<- chan int
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add coment for binStopCh

exitCh chan bool

procKillWg sync.WaitGroup
mu sync.RWMutex
watchers uint
fileChecksums *checksumMap
Expand All @@ -57,7 +57,6 @@ func NewEngineWithConfig(cfg *Config, debugMode bool) (*Engine, error) {
watcherStopCh: make(chan bool, 10),
buildRunCh: make(chan bool, 1),
buildRunStopCh: make(chan bool, 1),
binStopCh: make(chan bool),
exitCh: make(chan bool),
fileChecksums: &checksumMap{m: make(map[string]string)},
watchers: 0,
Expand Down Expand Up @@ -316,7 +315,7 @@ func (e *Engine) start() {
e.mainLog("Proxy server listening on http://localhost%s", e.proxy.server.Addr)
}

e.running = true
e.running.Store(true)
firstRunCh := make(chan bool, 1)
firstRunCh <- true

Expand Down Expand Up @@ -366,10 +365,8 @@ func (e *Engine) start() {
}

// if current app is running, stop it
e.withLock(func() {
close(e.binStopCh)
e.binStopCh = make(chan bool)
})
e.stopBin()

go e.buildRun()
}
}
Expand Down Expand Up @@ -479,43 +476,64 @@ func (e *Engine) runPostCmd() error {
}

func (e *Engine) runBin() error {
killFunc := func(cmd *exec.Cmd, stdout io.ReadCloser, stderr io.ReadCloser, killCh chan struct{}, processExit chan struct{}) {
select {
// listen to binStopCh
// cleanup() will close binStopCh when engine stop
// start() will close binStopCh when file changed
case <-e.binStopCh:
close(killCh)
break

// the process is exited, return
case <-processExit:
return
}
// killFunc returns a chan of chan of int that should be used to shutdown the bin currently being run
// The chan int that is passed in will be used to signal completion of the shutdown
killFunc := func(cmd *exec.Cmd, stdout io.ReadCloser, stderr io.ReadCloser, killCh chan<- struct{}, processExit <-chan struct{}) chan<- chan int {
shutdown := make(chan chan int)
var closer chan int

go func() {
defer func() {
stdout.Close()
stderr.Close()
}()

e.mainDebug("trying to kill pid %d, cmd %+v", cmd.Process.Pid, cmd.Args)
defer func() {
stdout.Close()
stderr.Close()
}()
pid, err := e.killCmd(cmd)
if err != nil {
e.mainDebug("failed to kill PID %d, error: %s", pid, err.Error())
if cmd.ProcessState != nil && !cmd.ProcessState.Exited() {
os.Exit(1)
}
} else {
e.mainDebug("cmd killed, pid: %d", pid)
}
if e.config.Build.StopOnError {
cmdBinPath := cmdPath(e.config.rel(e.config.binPath()))
if _, err = os.Stat(cmdBinPath); os.IsNotExist(err) {
select {
case closer = <-shutdown:
// stopBin has been called from start or cleanup
// defer the signalling of shutdown completion before attempting to kill further down
defer close(closer)
defer close(killCh)
case <-processExit:
// the process is exited, return
e.withLock(func() {
// Avoid deadlocking any racing shutdown request
select {
case c := <-shutdown:
close(c)
default:
}
e.binStopCh = nil
})
return
}
if err = os.Remove(cmdBinPath); err != nil {
e.mainLog("failed to remove %s, error: %s", e.config.rel(e.config.binPath()), err)

e.mainDebug("trying to kill pid %d, cmd %+v", cmd.Process.Pid, cmd.Args)

pid, err := e.killCmd(cmd)
if err != nil {
e.mainDebug("failed to kill PID %d, error: %s", pid, err.Error())
if cmd.ProcessState != nil && !cmd.ProcessState.Exited() {
// Pass a non zero exit code to the closer to delegate the
// decision wether to os.Exit or not
closer <- 1
}
} else {
e.mainDebug("cmd killed, pid: %d", pid)
}
}

if e.config.Build.StopOnError {
cmdBinPath := cmdPath(e.config.rel(e.config.binPath()))
if _, err = os.Stat(cmdBinPath); os.IsNotExist(err) {
return
}
if err = os.Remove(cmdBinPath); err != nil {
e.mainLog("failed to remove %s, error: %s", e.config.rel(e.config.binPath()), err)
}
}
}()

return shutdown
}

e.runnerLog("running...")
Expand All @@ -536,7 +554,6 @@ func (e *Engine) runBin() error {
case <-killCh:
return
default:
e.procKillWg.Add(1)
command := strings.Join(append([]string{e.config.Build.Bin}, e.runArgs...), " ")
cmd, stdout, stderr, _ := e.startCmd(command)
processExit := make(chan struct{})
Expand All @@ -545,10 +562,9 @@ func (e *Engine) runBin() error {
e.proxy.Reload()
}

e.stopBin()
e.withLock(func() {
close(e.binStopCh)
e.binStopCh = make(chan bool)
go killFunc(cmd, stdout, stderr, killCh, processExit)
e.binStopCh = killFunc(cmd, stdout, stderr, killCh, processExit)
})

go func() {
Expand All @@ -562,6 +578,7 @@ func (e *Engine) runBin() error {
}()
state, _ := cmd.Process.Wait()
close(processExit)

switch state.ExitCode() {
case 0:
e.runnerLog("Process Exit with Code 0")
Expand All @@ -570,7 +587,6 @@ func (e *Engine) runBin() error {
default:
e.runnerLog("Process Exit with Code: %v", state.ExitCode())
}
e.procKillWg.Done()

if !e.config.Build.Rerun {
return
Expand All @@ -583,9 +599,35 @@ func (e *Engine) runBin() error {
return nil
}

func (e *Engine) stopBin() {

exitCode := make(chan int)
wasRunning := false

e.withLock(func() {
if e.binStopCh != nil {
wasRunning = true
e.mainDebug("sending shutdown command to killfunc")
e.binStopCh <- exitCode
e.binStopCh = nil
} else {
close(exitCode)
}
})

if ret := <-exitCode; ret != 0 {
os.Exit(ret)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your refactoring is great, I love it.

I would have appreciated if this could be tested.

One solution for this is to define an exiter in the engine.

The exiter could be assigned to os.Exit by default, and overloaded via the tests to return a t.Fatal if the code is not the one expected

What do you think about it?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good i will raise a pr for that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#729

}

if wasRunning {
e.mainDebug("stopBin done")
}
}

func (e *Engine) cleanup() {
e.mainLog("cleaning...")
defer e.mainLog("see you again~")
defer e.mainDebug("exited")

if e.config.Proxy.Enabled {
e.mainDebug("powering down the proxy...")
Expand All @@ -594,11 +636,8 @@ func (e *Engine) cleanup() {
}
}

e.withLock(func() {
close(e.binStopCh)
e.binStopCh = make(chan bool)
})
e.mainDebug("waiting for close watchers..")
e.stopBin()
e.mainDebug("waiting for close watchers..")

e.withLock(func() {
for i := 0; i < int(e.watchers); i++ {
Expand All @@ -621,10 +660,7 @@ func (e *Engine) cleanup() {
}
}

e.mainDebug("waiting for exit...")
e.procKillWg.Wait()
e.running = false
e.mainDebug("exited")
e.running.Store(false)
}

// Stop the air
Expand Down
18 changes: 10 additions & 8 deletions runner/engine_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ func TestCtrlCWhenHaveKillDelay(t *testing.T) {
t.Fatalf("Should not be fail: %s.", err)
}
time.Sleep(time.Second * 3)
assert.False(t, engine.running)
assert.False(t, engine.running.Load())
}

func TestCtrlCWhenREngineIsRunning(t *testing.T) {
Expand Down Expand Up @@ -373,7 +373,7 @@ func TestCtrlCWhenREngineIsRunning(t *testing.T) {
if err != nil {
t.Fatalf("Should not be fail: %s.", err)
}
assert.False(t, engine.running)
assert.False(t, engine.running.Load())
}

func TestCtrlCWithFailedBin(t *testing.T) {
Expand Down Expand Up @@ -451,7 +451,7 @@ func TestFixCloseOfChannelAfterCtrlC(t *testing.T) {
if err := waitingPortConnectionRefused(t, port, time.Second*10); err != nil {
t.Fatalf("Should not be fail: %s.", err)
}
assert.False(t, engine.running)
assert.False(t, engine.running.Load())
}

func TestFixCloseOfChannelAfterTwoFailedBuild(t *testing.T) {
Expand Down Expand Up @@ -494,7 +494,7 @@ func TestFixCloseOfChannelAfterTwoFailedBuild(t *testing.T) {
// ctrl + c
sigs <- syscall.SIGINT
time.Sleep(time.Second * 1)
assert.False(t, engine.running)
assert.False(t, engine.running.Load())
}

// waitingPortReady waits until the port is ready to be used.
Expand Down Expand Up @@ -863,15 +863,17 @@ func Test(t *testing.T) {
}
// check is MacOS
var cmd *exec.Cmd
var toolName string = "sed"

if runtime.GOOS == "darwin" {
cmd = exec.Command("gsed", "-i", "s/\"_test.*go\"//g", ".air.toml")
} else {
cmd = exec.Command("sed", "-i", "s/\"_test.*go\"//g", ".air.toml")
toolName = "gsed"
}

cmd = exec.Command(toolName, "-i", "s/\"_test.*go\"//g", ".air.toml")
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
if err := cmd.Run(); err != nil {
t.Fatal(err)
t.Skipf("unable to run %s, make sure the tool is installed to run this test", toolName)
}

time.Sleep(time.Second * 2)
Expand Down