Improve projects support

Author: jesseduffield

config/config.yml

@@ -1,4 +1,3 @@
-version: '3'
 services:
   lazydocker:
     build:

docker-compose.yml

@@ -29,6 +29,7 @@ var (
 	configFlag    = false
 	debuggingFlag = false
 	composeFiles  []string
+	projectName   string
 )
 
 func main() {
@@ -51,6 +52,7 @@ func main() {
 	flaggy.Bool(&configFlag, "c", "config", "Print the current default config")
 	flaggy.Bool(&debuggingFlag, "d", "debug", "a boolean")
 	flaggy.StringSlice(&composeFiles, "f", "file", "Specify alternate compose files")
+	flaggy.String(&projectName, "p", "project", "Specify a docker compose project name")
 	flaggy.SetVersion(info)
 
 	flaggy.Parse()
@@ -71,7 +73,7 @@ func main() {
 		log.Fatal(err.Error())
 	}
 
-	appConfig, err := config.NewAppConfig("lazydocker", version, commit, date, buildSource, debuggingFlag, composeFiles, projectDir)
+	appConfig, err := config.NewAppConfig("lazydocker", version, commit, date, buildSource, debuggingFlag, composeFiles, projectDir, projectName)
 	if err != nil {
 		log.Fatal(err.Error())
 	}

main.go

@@ -33,7 +33,7 @@ func Generate() {
 }
 
 func generateAtDir(dir string) {
-	mConfig, err := config.NewAppConfig("lazydocker", "", "", "", "", true, nil, "")
+	mConfig, err := config.NewAppConfig("lazydocker", "", "", "", "", true, nil, "", "")
 	if err != nil {
 		panic(err)
 	}

pkg/cheatsheet/generate.go

@@ -9,6 +9,8 @@ import (
 	ogLog "log"
 	"os"
 	"os/exec"
+	"path"
+	"sort"
 	"strings"
 	"sync"
 	"time"
@@ -39,9 +41,11 @@ type DockerCommand struct {
 	Config                 *config.AppConfig
 	Client                 *client.Client
 	InDockerComposeProject bool
-	ErrorChan              chan error
-	ContainerMutex         deadlock.Mutex
-	ServiceMutex           deadlock.Mutex
+	// LocalProjectName is the compose project name for the directory where lazydocker was launched.
+	LocalProjectName string
+	ErrorChan        chan error
+	ContainerMutex   deadlock.Mutex
+	ServiceMutex     deadlock.Mutex
 
 	Closers []io.Closer
 }
@@ -61,12 +65,22 @@ type CommandObject struct {
 	Image         *Image
 	Volume        *Volume
 	Network       *Network
+	Project       *Project
 }
 
 // NewCommandObject takes a command object and returns a default command object with the passed command object merged in
 func (c *DockerCommand) NewCommandObject(obj CommandObject) CommandObject {
 	defaultObj := CommandObject{DockerCompose: c.Config.UserConfig.CommandTemplates.DockerCompose}
 	_ = mergo.Merge(&defaultObj, obj)
+
+	// When operating on a specific project, include -p flag so that
+	// docker compose targets the correct project.
+	if obj.Service != nil && obj.Service.ProjectName != "" {
+		defaultObj.DockerCompose = fmt.Sprintf("%s -p %s", defaultObj.DockerCompose, obj.Service.ProjectName)
+	} else if obj.Project != nil && obj.Project.Name != "" {
+		defaultObj.DockerCompose = fmt.Sprintf("%s -p %s", defaultObj.DockerCompose, obj.Project.Name)
+	}
+
 	return defaultObj
 }
 
@@ -193,7 +207,7 @@ func (c *DockerCommand) CreateClientStatMonitor(container *Container) {
 	container.MonitoringStats = false
 }
 
-func (c *DockerCommand) RefreshContainersAndServices(currentServices []*Service, currentContainers []*Container) ([]*Container, []*Service, error) {
+func (c *DockerCommand) RefreshContainersAndServices(currentContainers []*Container) ([]*Container, []*Service, error) {
 	c.ServiceMutex.Lock()
 	defer c.ServiceMutex.Unlock()
 
@@ -202,27 +216,133 @@ func (c *DockerCommand) RefreshContainersAndServices(currentServices []*Service,
 		return nil, nil, err
 	}
 
-	var services []*Service
-	// we only need to get these services once because they won't change in the runtime of the program
-	if currentServices != nil {
-		services = currentServices
-	} else {
-		services, err = c.GetServices()
-		if err != nil {
-			return nil, nil, err
+	// Derive services from container labels (covers all projects)
+	services := c.GetServicesFromContainers(containers)
+
+	var composeServices []*Service
+	if c.InDockerComposeProject {
+		composeServices, _ = c.GetServices()
+	}
+
+	// Determine the local project name before merging services, since
+	// mergeServices needs it. We match compose service names against container
+	// labels to handle cases where the project name differs from the directory
+	// name (e.g. a `name:` directive in the compose file).
+	if c.LocalProjectName == "" && c.InDockerComposeProject && composeServices != nil {
+		for _, ctr := range containers {
+			if ctr.ProjectName == "" || ctr.ServiceName == "" {
+				continue
+			}
+			for _, svc := range composeServices {
+				if ctr.ServiceName == svc.Name {
+					c.LocalProjectName = ctr.ProjectName
+					break
+				}
+			}
+			if c.LocalProjectName != "" {
+				break
+			}
+		}
+		// Fall back to directory name
+		if c.LocalProjectName == "" && c.Config.ProjectDir != "" {
+			c.LocalProjectName = path.Base(c.Config.ProjectDir)
 		}
 	}
 
+	// Merge compose services (which include stopped services) with
+	// container-derived services from all projects
+	if composeServices != nil {
+		services = c.mergeServices(services, composeServices)
+	}
+
 	c.assignContainersToServices(containers, services)
 
 	return containers, services, nil
 }
 
+// GetServicesFromContainers derives services from container labels for all projects
+func (c *DockerCommand) GetServicesFromContainers(containers []*Container) []*Service {
+	// Use project+service as key to avoid duplicates
+	type serviceKey struct {
+		project string
+		service string
+	}
+	seen := make(map[serviceKey]bool)
+	var services []*Service
+
+	for _, ctr := range containers {
+		if ctr.ServiceName == "" || ctr.OneOff {
+			continue
+		}
+		key := serviceKey{project: ctr.ProjectName, service: ctr.ServiceName}
+		if seen[key] {
+			continue
+		}
+		seen[key] = true
+		services = append(services, &Service{
+			Name:          ctr.ServiceName,
+			ID:            ctr.ServiceName,
+			ProjectName:   ctr.ProjectName,
+			OSCommand:     c.OSCommand,
+			Log:           c.Log,
+			DockerCommand: c,
+		})
+	}
+
+	return services
+}
+
+// mergeServices merges compose services (which may lack ProjectName) with
+// container-derived services. Compose services take priority because they
+// include services without running containers.
+func (c *DockerCommand) mergeServices(containerServices []*Service, composeServices []*Service) []*Service {
+	// Set project name on compose services
+	for _, svc := range composeServices {
+		if svc.ProjectName == "" {
+			svc.ProjectName = c.LocalProjectName
+		}
+	}
+
+	// Build a set of compose service names for the local project
+	composeServiceNames := make(map[string]bool)
+	for _, svc := range composeServices {
+		composeServiceNames[svc.Name] = true
+	}
+
+	// Start with compose services, then add container-derived services
+	// that aren't already covered by compose (i.e. from other projects)
+	result := make([]*Service, 0, len(composeServices)+len(containerServices))
+	result = append(result, composeServices...)
+
+	for _, svc := range containerServices {
+		if svc.ProjectName == c.LocalProjectName && composeServiceNames[svc.Name] {
+			continue // already covered by compose service
+		}
+		result = append(result, svc)
+	}
+
+	return result
+}
+
+// GetProjectNames returns all unique project names from containers
+func (c *DockerCommand) GetProjectNames(containers []*Container) []string {
+	seen := make(map[string]bool)
+	var names []string
+	for _, ctr := range containers {
+		if ctr.ProjectName != "" && !seen[ctr.ProjectName] {
+			seen[ctr.ProjectName] = true
+			names = append(names, ctr.ProjectName)
+		}
+	}
+	sort.Strings(names)
+	return names
+}
+
 func (c *DockerCommand) assignContainersToServices(containers []*Container, services []*Service) {
 L:
 	for _, service := range services {
 		for _, ctr := range containers {
-			if !ctr.OneOff && ctr.ServiceName == service.Name {
+			if !ctr.OneOff && ctr.ServiceName == service.Name && ctr.ProjectName == service.ProjectName {
 				service.Container = ctr
 				continue L
 			}
@@ -312,6 +432,7 @@ func (c *DockerCommand) GetServices() ([]*Service, error) {
 		services[i] = &Service{
 			Name:          str,
 			ID:            str,
+			ProjectName:   c.LocalProjectName,
 			OSCommand:     c.OSCommand,
 			Log:           c.Log,
 			DockerCommand: c,
@@ -351,11 +472,11 @@ func (c *DockerCommand) SetContainerDetails(containers []*Container) {
 }
 
 // ViewAllLogs attaches to a subprocess viewing all the logs from docker-compose
-func (c *DockerCommand) ViewAllLogs() (*exec.Cmd, error) {
+func (c *DockerCommand) ViewAllLogs(project *Project) (*exec.Cmd, error) {
 	cmd := c.OSCommand.ExecutableFromString(
 		utils.ApplyTemplate(
 			c.OSCommand.Config.UserConfig.CommandTemplates.ViewAllLogs,
-			c.NewCommandObject(CommandObject{}),
+			c.NewCommandObject(CommandObject{Project: project}),
 		),
 	)
 
@@ -366,10 +487,15 @@ func (c *DockerCommand) ViewAllLogs() (*exec.Cmd, error) {
 
 // DockerComposeConfig returns the result of 'docker-compose config'
 func (c *DockerCommand) DockerComposeConfig() string {
+	return c.DockerComposeConfigForProject(nil)
+}
+
+// DockerComposeConfigForProject returns the result of 'docker-compose config' for a specific project
+func (c *DockerCommand) DockerComposeConfigForProject(project *Project) string {
 	output, err := c.OSCommand.RunCommandWithOutput(
 		utils.ApplyTemplate(
 			c.OSCommand.Config.UserConfig.CommandTemplates.DockerComposeConfig,
-			c.NewCommandObject(CommandObject{}),
+			c.NewCommandObject(CommandObject{Project: project}),
 		),
 	)
 	if err != nil {

pkg/commands/docker.go

@@ -13,6 +13,7 @@ import (
 type Service struct {
 	Name          string
 	ID            string
+	ProjectName   string
 	OSCommand     *OSCommand
 	Log           *logrus.Entry
 	Container     *Container

pkg/commands/service.go

@@ -488,10 +488,11 @@ type AppConfig struct {
 	UserConfig  *UserConfig
 	ConfigDir   string
 	ProjectDir  string
+	ProjectName string
 }
 
 // NewAppConfig makes a new app config
-func NewAppConfig(name, version, commit, date string, buildSource string, debuggingFlag bool, composeFiles []string, projectDir string) (*AppConfig, error) {
+func NewAppConfig(name, version, commit, date string, buildSource string, debuggingFlag bool, composeFiles []string, projectDir string, projectName string) (*AppConfig, error) {
 	configDir, err := findOrCreateConfigDir(name)
 	if err != nil {
 		return nil, err
@@ -517,6 +518,7 @@ func NewAppConfig(name, version, commit, date string, buildSource string, debugg
 		UserConfig:  userConfig,
 		ConfigDir:   configDir,
 		ProjectDir:  projectDir,
+		ProjectName: projectName,
 	}
 
 	return appConfig, nil

pkg/config/app_config.go

@@ -9,7 +9,7 @@ import (
 
 func TestDockerComposeCommandNoFiles(t *testing.T) {
 	composeFiles := []string{}
-	conf, err := NewAppConfig("name", "version", "commit", "date", "buildSource", false, composeFiles, "projectDir")
+	conf, err := NewAppConfig("name", "version", "commit", "date", "buildSource", false, composeFiles, "projectDir", "")
 	if err != nil {
 		t.Fatalf("Unexpected error: %s", err)
 	}
@@ -23,7 +23,7 @@ func TestDockerComposeCommandNoFiles(t *testing.T) {
 
 func TestDockerComposeCommandSingleFile(t *testing.T) {
 	composeFiles := []string{"one.yml"}
-	conf, err := NewAppConfig("name", "version", "commit", "date", "buildSource", false, composeFiles, "projectDir")
+	conf, err := NewAppConfig("name", "version", "commit", "date", "buildSource", false, composeFiles, "projectDir", "")
 	if err != nil {
 		t.Fatalf("Unexpected error: %s", err)
 	}
@@ -37,7 +37,7 @@ func TestDockerComposeCommandSingleFile(t *testing.T) {
 
 func TestDockerComposeCommandMultipleFiles(t *testing.T) {
 	composeFiles := []string{"one.yml", "two.yml", "three.yml"}
-	conf, err := NewAppConfig("name", "version", "commit", "date", "buildSource", false, composeFiles, "projectDir")
+	conf, err := NewAppConfig("name", "version", "commit", "date", "buildSource", false, composeFiles, "projectDir", "")
 	if err != nil {
 		t.Fatalf("Unexpected error: %s", err)
 	}
@@ -52,7 +52,7 @@ func TestDockerComposeCommandMultipleFiles(t *testing.T) {
 func TestWritingToConfigFile(t *testing.T) {
 	// init the AppConfig
 	emptyComposeFiles := []string{}
-	conf, err := NewAppConfig("name", "version", "commit", "date", "buildSource", false, emptyComposeFiles, "projectDir")
+	conf, err := NewAppConfig("name", "version", "commit", "date", "buildSource", false, emptyComposeFiles, "projectDir", "")
 	if err != nil {
 		t.Fatalf("Unexpected error: %s", err)
 	}

pkg/config/app_config_test.go

@@ -175,11 +175,21 @@ func (gui *Gui) sidePanelChildren(width int, height int) []*boxlayout.Box {
 			return defaultBox
 		}
 
-		return append([]*boxlayout.Box{
-			{
+		// The project panel is compact (Size: 3) when not focused, but expands
+		// when focused to show the list of projects.
+		projectBox := &boxlayout.Box{
+			Window: sideWindowNames[0],
+			Size:   3,
+		}
+		if currentWindow == sideWindowNames[0] {
+			projectBox = &boxlayout.Box{
 				Window: sideWindowNames[0],
-				Size:   3,
-			},
+				Weight: 2,
+			}
+		}
+
+		return append([]*boxlayout.Box{
+			projectBox,
 		}, lo.Map(sideWindowNames[1:], func(window string, _ int) *boxlayout.Box {
 			return accordionBox(&boxlayout.Box{Window: window, Weight: 1})
 		})...)