fix: cleanup $HOME/.symfony5/tmp temporary directories

tucksaun · tucksaun · commit a2f79dfdbec8 · 2025-02-08T20:39:35.000+01:00
diff --git a/commands/local_server_start.go b/commands/local_server_start.go
@@ -417,6 +417,10 @@ var localServerStartCmd = &console.Command{
 				return err
 			}
 			terminal.Eprintln("")
+			// wait for the PHP Server to be done cleaning up
+			if p.PHPServer != nil {
+				<-p.PHPServer.StoppedChan
+			}
 			ui.Success("Stopped all processes successfully")
 		}
 		return nil
diff --git a/local/php/executor.go b/local/php/executor.go
@@ -163,7 +163,11 @@ func (e *Executor) DetectScriptDir() (string, error) {
 	return e.scriptDir, nil
 }
 
-// Config determines the right version of PHP depending on the configuration (+ its configuration)
+// Config determines the right version of PHP depending on the configuration
+// (+ its configuration). It also creates some symlinks to ease the integration
+// with underlying tools that could try to run PHP. This is the responsability
+// of the caller to clean those temporary files. One can call
+// CleanupTemporaryDirectories to do so.
 func (e *Executor) Config(loadDotEnv bool) error {
 	// reset environment
 	e.environ = make([]string, 0)
@@ -220,8 +224,10 @@ func (e *Executor) Config(loadDotEnv bool) error {
 	// prepending the PHP directory in the PATH does not work well if the PHP binary is not named "php" (like php7.3 for instance)
 	// in that case, we create a temp directory with a symlink
 	// we also link php-config for pecl to pick up the right one (it is always looks for something called php-config)
-	phpDir := filepath.Join(cliDir, "tmp", xid.New().String(), "bin")
-	e.tempDir = phpDir
+	if e.tempDir == "" {
+		e.tempDir = filepath.Join(cliDir, "tmp", xid.New().String())
+	}
+	phpDir := filepath.Join(e.tempDir, "bin")
 	if err := os.MkdirAll(phpDir, 0755); err != nil {
 		return err
 	}
@@ -284,6 +290,15 @@ func (e *Executor) Config(loadDotEnv bool) error {
 	return err
 }
 
+func (e *Executor) CleanupTemporaryDirectories() {
+	if e.iniDir != "" {
+		os.RemoveAll(e.iniDir)
+	}
+	if e.tempDir != "" {
+		os.RemoveAll(e.tempDir)
+	}
+}
+
 // Find composer depending on the configuration
 func (e *Executor) findComposer(extraBin string) (string, error) {
 	if scriptDir, err := e.DetectScriptDir(); err == nil {
@@ -312,14 +327,7 @@ func (e *Executor) Execute(loadDotEnv bool) int {
 		fmt.Fprintln(os.Stderr, err)
 		return 1
 	}
-	defer func() {
-		if e.iniDir != "" {
-			os.RemoveAll(e.iniDir)
-		}
-		if e.tempDir != "" {
-			os.RemoveAll(e.tempDir)
-		}
-	}()
+	defer e.CleanupTemporaryDirectories()
 	cmd := execCommand(e.Args[0], e.Args[1:]...)
 	environ := append(os.Environ(), e.environ...)
 	gpathname := "PATH"
diff --git a/local/php/php_server.go b/local/php/php_server.go
@@ -48,6 +48,7 @@ import (
 type Server struct {
 	Version      *phpstore.Version
 	logger       zerolog.Logger
+	StoppedChan  chan bool
 	appVersion   string
 	homeDir      string
 	projectDir   string
@@ -79,6 +80,7 @@ func NewServer(homeDir, projectDir, documentRoot, passthru, appVersion string, l
 		projectDir:   projectDir,
 		documentRoot: documentRoot,
 		passthru:     passthru,
+		StoppedChan:  make(chan bool, 1),
 	}, nil
 }
 
@@ -195,6 +197,8 @@ func (p *Server) Start(ctx context.Context, pidFile *pid.PidFile) (*pid.PidFile,
 			for _, path := range pathsToRemove {
 				os.RemoveAll(path)
 			}
+			e.CleanupTemporaryDirectories()
+			p.StoppedChan <- true
 		}()
 
 		return errors.Wrap(errors.WithStack(runner.Run()), "PHP server exited unexpectedly")

Original file line number	Diff line number	Diff line change
`@@ -417,6 +417,10 @@ var localServerStartCmd = &console.Command{`
`417`	`417`	`return err`
`418`	`418`	`}`
`419`	`419`	`terminal.Eprintln("")`
	`420`	`+ // wait for the PHP Server to be done cleaning up`
	`421`	`+ if p.PHPServer != nil {`
	`422`	`+ <-p.PHPServer.StoppedChan`
	`423`	`+ }`
`420`	`424`	`ui.Success("Stopped all processes successfully")`
`421`	`425`	`}`
`422`	`426`	`return nil`