Multi-instance Process Compose (#873)

## Summary
This PR allows users to run process-compose for multiple devbox projects
at the same time, without any collisions or undesirable behavior. This
does _not_ provide any isolation between services in different projects,
but it does let a user effectively manage them on a per project basis

## How it works

When starting process-compose in a devbox project, we create a UUID for
the project, and then store the port + PID of the process-compose
instance in a global `process-compose.json` file, with the UUID as the
key.

When making client requests to process-compose, a devbox project looks
up the UUID for the project in the .devbox directory, gets the right
port, and then makes the request. This ensures each project is
communicating with the correct process-compose instance to start and
stop services.

Devbox also uses the same lookup to get the PID of a project's
process-compose instance, so it can stop the right instance.

## Questions: 
* Should the project UUID be permanent or set somewhere else? Is there a
better way to identify a project that won't be affected by the user
moving it?

## Future features: 
* Let users specify their own process-compose port in `devbox services
up`
* ~Add `devbox services stop --all`, which stops all running
process-compose files and resets the global config. This could help with
situations where a developer accidentally leaves their projects
running.~

## How was it tested?

Ran Example Tests to check backward compatibility, tested by running
postgres + jekyll simultaneously, starting and stopping them

Author: Lagoja

devbox.go

@@ -47,7 +47,7 @@ type Devbox interface {
 	ShellPlan() (*plansdk.ShellPlan, error)
 	StartProcessManager(ctx context.Context, requestedServices []string, background bool, processComposeFileOrDir string) error
 	StartServices(ctx context.Context, services ...string) error
-	StopServices(ctx context.Context, services ...string) error
+	StopServices(ctx context.Context, allProjects bool, services ...string) error
 	ListServices(ctx context.Context) error
 }
 

internal/boxcli/services.go

@@ -19,6 +19,11 @@ type serviceUpFlags struct {
 	processComposeFile string
 }
 
+type serviceStopFlags struct {
+	configFlags
+	allProjects bool
+}
+
 func (flags *serviceUpFlags) register(cmd *cobra.Command) {
 	flags.configFlags.register(cmd)
 	cmd.Flags().StringVar(
@@ -32,9 +37,16 @@ func (flags *serviceUpFlags) register(cmd *cobra.Command) {
 		&flags.background, "background", "b", false, "Run service in background")
 }
 
+func (flags *serviceStopFlags) register(cmd *cobra.Command) {
+	flags.configFlags.register(cmd)
+	cmd.Flags().BoolVar(
+		&flags.allProjects, "all-projects", false, "Stop all running services across all your projects.\nThis flag cannot be used simultaneously with the [services] argument")
+}
+
 func servicesCmd() *cobra.Command {
 	flags := servicesCmdFlags{}
 	serviceUpFlags := serviceUpFlags{}
+	serviceStopFlags := serviceStopFlags{}
 	servicesCommand := &cobra.Command{
 		Use:   "services",
 		Short: "Interact with devbox services",
@@ -59,9 +71,10 @@ func servicesCmd() *cobra.Command {
 
 	stopCommand := &cobra.Command{
 		Use:   "stop [service]...",
-		Short: "Stop service. If no service is specified, stops all services",
+		Short: "Stop one or more services in the current project. If no service is specified, stops all services in the current project.",
+		Long:  `Stop one or more services in the current project. If no service is specified, stops all services in the current project. \nIf the --all-projects flag is specified, stops all running services across all your projects. This flag cannot be used with [service] arguments.`,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			return stopServices(cmd, args, flags)
+			return stopServices(cmd, args, serviceStopFlags)
 		},
 	}
 
@@ -83,6 +96,7 @@ func servicesCmd() *cobra.Command {
 
 	flags.config.register(servicesCommand)
 	serviceUpFlags.register(upCommand)
+	serviceStopFlags.register(stopCommand)
 	servicesCommand.AddCommand(lsCommand)
 	servicesCommand.AddCommand(upCommand)
 	servicesCommand.AddCommand(restartCommand)
@@ -110,12 +124,15 @@ func startServices(cmd *cobra.Command, services []string, flags servicesCmdFlags
 	return box.StartServices(cmd.Context(), services...)
 }
 
-func stopServices(cmd *cobra.Command, services []string, flags servicesCmdFlags) error {
-	box, err := devbox.Open(flags.config.path, cmd.ErrOrStderr())
+func stopServices(cmd *cobra.Command, services []string, flags serviceStopFlags) error {
+	box, err := devbox.Open(flags.configFlags.path, cmd.ErrOrStderr())
 	if err != nil {
 		return errors.WithStack(err)
 	}
-	return box.StopServices(cmd.Context(), services...)
+	if len(services) > 0 && flags.allProjects {
+		return errors.New("cannot use both services and --all-projects arguments simultaneously")
+	}
+	return box.StopServices(cmd.Context(), flags.allProjects, services...)
 }
 
 func restartServices(

internal/impl/devbox.go

@@ -449,7 +449,7 @@ func (d *Devbox) StartServices(ctx context.Context, serviceNames ...string) erro
 		return d.RunScript("devbox", append([]string{"services", "start"}, serviceNames...))
 	}
 
-	if !services.ProcessManagerIsRunning() {
+	if !services.ProcessManagerIsRunning(d.projectDir) {
 		fmt.Fprintln(d.writer, "Process-compose is not running. Starting it now...")
 		fmt.Fprintln(d.writer, "\nNOTE: We recommend using `devbox services up` to start process-compose and your services")
 		return d.StartProcessManager(ctx, serviceNames, true, "")
@@ -473,25 +473,34 @@ func (d *Devbox) StartServices(ctx context.Context, serviceNames ...string) erro
 	for _, s := range serviceNames {
 		err := services.StartServices(ctx, d.writer, s, d.projectDir)
 		if err != nil {
-			fmt.Printf("Error starting service %s: %s", s, err)
+			fmt.Fprintf(d.writer, "Error starting service %s: %s", s, err)
 		} else {
-			fmt.Printf("Service %s started successfully", s)
+			fmt.Fprintf(d.writer, "Service %s started successfully", s)
 		}
 	}
 	return nil
 }
 
-func (d *Devbox) StopServices(ctx context.Context, serviceNames ...string) error {
+func (d *Devbox) StopServices(ctx context.Context, allProjects bool, serviceNames ...string) error {
 	if !IsDevboxShellEnabled() {
-		return d.RunScript("devbox", append([]string{"services", "stop"}, serviceNames...))
+		args := []string{"services", "stop"}
+		args = append(args, serviceNames...)
+		if allProjects {
+			args = append(args, "--all-projects")
+		}
+		return d.RunScript("devbox", args)
 	}
 
-	if !services.ProcessManagerIsRunning() {
+	if allProjects {
+		return services.StopAllProcessManagers(ctx, d.writer)
+	}
+
+	if !services.ProcessManagerIsRunning(d.projectDir) {
 		return usererr.New("Process manager is not running. Run `devbox services up` to start it.")
 	}
 
 	if len(serviceNames) == 0 {
-		return services.StopProcessManager(ctx, d.writer)
+		return services.StopProcessManager(ctx, d.projectDir, d.writer)
 	}
 
 	svcSet, err := d.Services()
@@ -526,7 +535,7 @@ func (d *Devbox) ListServices(ctx context.Context) error {
 		return nil
 	}
 
-	if !services.ProcessManagerIsRunning() {
+	if !services.ProcessManagerIsRunning(d.projectDir) {
 		fmt.Fprintln(d.writer, "No services currently running. Run `devbox services up` to start them:")
 		fmt.Fprintln(d.writer, "")
 		for _, s := range svcSet {
@@ -554,7 +563,7 @@ func (d *Devbox) RestartServices(ctx context.Context, serviceNames ...string) er
 		return d.RunScript("devbox", append([]string{"services", "restart"}, serviceNames...))
 	}
 
-	if !services.ProcessManagerIsRunning() {
+	if !services.ProcessManagerIsRunning(d.projectDir) {
 		fmt.Fprintln(d.writer, "Process-compose is not running. Starting it now...")
 		fmt.Fprintln(d.writer, "\nTip: We recommend using `devbox services up` to start process-compose and your services")
 		return d.StartProcessManager(ctx, serviceNames, true, "")
@@ -596,7 +605,11 @@ func (d *Devbox) StartProcessManager(
 		return usererr.New("No services found in your project")
 	}
 
-	// processCompose := services.LookupProcessCompose(d.projectDir, processComposeFileOrDir)
+	for _, s := range requestedServices {
+		if _, ok := svcs[s]; !ok {
+			return usererr.New(fmt.Sprintf("Service %s not found in your project", s))
+		}
+	}
 
 	processComposePath, err := utilityLookPath("process-compose")
 	if err != nil {
@@ -626,7 +639,15 @@ func (d *Devbox) StartProcessManager(
 
 	// Start the process manager
 
-	return services.StartProcessManager(ctx, requestedServices, svcs, d.projectDir, processComposePath, processComposeFileOrDir, background)
+	return services.StartProcessManager(
+		ctx,
+		d.writer,
+		requestedServices,
+		svcs,
+		d.projectDir,
+		processComposePath, processComposeFileOrDir,
+		background,
+	)
 }
 
 // computeNixEnv computes the set of environment variables that define a Devbox

internal/services/client.go

@@ -13,7 +13,7 @@ import (
 
 type processStates = types.ProcessStates
 
-type ProcessSummary struct {
+type Process struct {
 	Name     string
 	Status   string
 	ExitCode int
@@ -23,7 +23,7 @@ func StartServices(ctx context.Context, w io.Writer, serviceName string, project
 	path := fmt.Sprintf("/process/start/%s", serviceName)
 	method := "POST"
 
-	body, status, err := clientRequest(path, method)
+	body, status, err := clientRequest(path, method, projectDir)
 	if err != nil {
 		return err
 	}
@@ -42,7 +42,7 @@ func StopServices(ctx context.Context, serviceName string, projectDir string, w
 	path := fmt.Sprintf("/process/stop/%s", serviceName)
 	method := "PATCH"
 
-	body, status, err := clientRequest(path, method)
+	body, status, err := clientRequest(path, method, projectDir)
 	if err != nil {
 		return err
 	}
@@ -60,7 +60,7 @@ func RestartServices(ctx context.Context, serviceName string, projectDir string,
 	path := fmt.Sprintf("/process/restart/%s", serviceName)
 	method := "POST"
 
-	body, status, err := clientRequest(path, method)
+	body, status, err := clientRequest(path, method, projectDir)
 	if err != nil {
 		return err
 	}
@@ -74,12 +74,12 @@ func RestartServices(ctx context.Context, serviceName string, projectDir string,
 	}
 }
 
-func ListServices(ctx context.Context, projectDir string, w io.Writer) ([]ProcessSummary, error) {
+func ListServices(ctx context.Context, projectDir string, w io.Writer) ([]Process, error) {
 	path := "/processes"
 	method := "GET"
-	results := []ProcessSummary{}
+	results := []Process{}
 
-	body, status, err := clientRequest(path, method)
+	body, status, err := clientRequest(path, method, projectDir)
 	if err != nil {
 		return results, err
 	}
@@ -92,7 +92,7 @@ func ListServices(ctx context.Context, projectDir string, w io.Writer) ([]Proces
 			return results, err
 		}
 		for _, process := range processes.States {
-			results = append(results, ProcessSummary{
+			results = append(results, Process{
 				Name:     process.Name,
 				Status:   process.Status,
 				ExitCode: process.ExitCode,
@@ -105,9 +105,14 @@ func ListServices(ctx context.Context, projectDir string, w io.Writer) ([]Proces
 	}
 }
 
-func clientRequest(path string, method string) (string, int, error) {
-	port := "8280"
-	req, err := http.NewRequest(method, fmt.Sprintf("http://localhost:%s%s", port, path), nil)
+func clientRequest(path string, method string, projectDir string) (string, int, error) {
+	port, err := GetProcessManagerPort(projectDir)
+	if err != nil {
+		err := fmt.Errorf("unable to connect to process-compose server: %s", err.Error())
+		return "", 0, err
+	}
+
+	req, err := http.NewRequest(method, fmt.Sprintf("http://localhost:%d%s", port, path), nil)
 	if err != nil {
 		return "", 0, err
 	}