fix: internal project network with duplicate check, revert for #5305

pkg/ddevapp/app_compose_template.yaml

@@ -251,7 +251,6 @@ networks:
     external: true
   default:
     name: ${COMPOSE_PROJECT_NAME}_default
-    external: true
     {{ if .IsGitpod }}{{/* see https://github.com/ddev/ddev/issues/3766 */}}
     driver_opts:
       com.docker.network.driver.mtu: 1440

pkg/ddevapp/ddevapp.go

@@ -1028,6 +1028,10 @@ func (app *DdevApp) Start() error {
 
 	app.DockerEnv()
 	dockerutil.EnsureDdevNetwork()
+	// "docker-compose up", which is called in this function later, may create
+	// duplicate project networks, we can create this network in advance
+	// see https://github.com/ddev/ddev/pull/5533
+	dockerutil.EnsureProjectNetwork()
 
 	if err = dockerutil.CheckDockerCompose(); err != nil {
 		util.Failed(`Your docker-compose version does not exist or is set to an invalid version.
@@ -2557,11 +2561,6 @@ func (app *DdevApp) Stop(removeData bool, createSnapshot bool) error {
 		}
 	}
 
-	// Remove current project network
-	// Working around duplicate network creation problem
-	// see https://github.com/ddev/ddev/pull/5508
-	dockerutil.RemoveNetworkWithWarningOnError(os.Getenv("COMPOSE_PROJECT_NAME") + "_default")
-
 	return nil
 }
 

pkg/ddevapp/poweroff.go

@@ -54,10 +54,7 @@ func PowerOff() {
 	// Remove global DDEV default network
 	dockerutil.RemoveNetworkWithWarningOnError(dockerutil.NetName)
 
-	// Remove all external networks created with DDEV
-	// This is needed for compatibility if we decide to undo the changes
-	// made for the external project networks
-	// see https://github.com/ddev/ddev/pull/5508
+	// Remove all networks created with DDEV
 	removals, err := dockerutil.FindNetworksWithLabel("com.ddev.platform")
 	if err == nil {
 		for _, network := range removals {

pkg/dockerutil/dockerutils.go

@@ -41,7 +41,7 @@ type ComposeCmdOpts struct {
 }
 
 // EnsureNetwork will ensure the Docker network for DDEV is created.
-func EnsureNetwork(client *docker.Client, name string) error {
+func EnsureNetwork(client *docker.Client, name string, labels map[string]string) error {
 	// Pre-check for network duplicates
 	RemoveNetworkDuplicates(client, name)
 
@@ -50,7 +50,7 @@ func EnsureNetwork(client *docker.Client, name string) error {
 			Name:     name,
 			Driver:   "bridge",
 			Internal: false,
-			Labels:   map[string]string{"com.ddev.platform": "ddev"},
+			Labels:   labels,
 		}
 		_, err := client.CreateNetwork(netOptions)
 		if err != nil {
@@ -61,24 +61,36 @@ func EnsureNetwork(client *docker.Client, name string) error {
 	return nil
 }
 
-// EnsureNetworkWithFatal creates or ensures the provided network exists or
+// EnsureDdevNetwork creates or ensures the DDEV network exists or
 // exits with fatal.
-func EnsureNetworkWithFatal(name string) {
+func EnsureDdevNetwork() {
+	// Ensure we have the fallback global DDEV network
 	client := GetDockerClient()
-	err := EnsureNetwork(client, name)
+	err := EnsureNetwork(client, NetName, map[string]string{"com.ddev.platform": "ddev"})
 	if err != nil {
-		log.Fatalf("Failed to ensure Docker network %s: %v", name, err)
+		log.Fatalf("Failed to ensure Docker network %s: %v", NetName, err)
 	}
 }
 
-// EnsureDdevNetwork creates or ensures the DDEV network exists or
+// EnsureProjectNetwork creates or ensures the project network exists or
 // exits with fatal.
-func EnsureDdevNetwork() {
-	// Ensure we have the fallback global DDEV network
-	EnsureNetworkWithFatal(NetName)
-	// Ensure we have the current project network
-	if os.Getenv("COMPOSE_PROJECT_NAME") != "" {
-		EnsureNetworkWithFatal(os.Getenv("COMPOSE_PROJECT_NAME") + "_default")
+func EnsureProjectNetwork() {
+	if os.Getenv("COMPOSE_PROJECT_NAME") == "" {
+		log.Fatalf("dockerutil.EnsureProjectNetwork() must be called after app.DockerEnv()")
+	}
+	networkName := os.Getenv("COMPOSE_PROJECT_NAME") + "_default"
+	client := GetDockerClient()
+	err := EnsureNetwork(client, networkName, map[string]string{
+		"com.ddev.platform": "ddev",
+		// add docker-compose labels needed for "docker compose up"
+		"com.docker.compose.network": "default",
+		"com.docker.compose.project": os.Getenv("COMPOSE_PROJECT_NAME"),
+		"com.docker.compose.version": func() string {
+			version, _ := GetDockerComposeVersion()
+			return strings.TrimPrefix(version, "v")
+		}()})
+	if err != nil {
+		log.Fatalf("Failed to ensure Docker network %s: %v", networkName, err)
 	}
 }
 
@@ -95,7 +107,8 @@ func NetworkExists(netName string) bool {
 func RemoveNetwork(netName string) error {
 	client := GetDockerClient()
 	networks, _ := client.ListNetworks()
-	var err error
+	// the loop below may not contain such a network
+	var err error = &docker.NoSuchNetwork{ID: netName}
 	// loop through all networks because there may be duplicates
 	// and delete only by ID - it's unique, but the name isn't
 	for _, network := range networks {

pkg/testcommon/testcommon.go

@@ -262,12 +262,8 @@ func ClearDockerEnv() {
 
 // ContainerCheck determines if a given container name exists and matches a given state
 func ContainerCheck(checkName string, checkState string) (bool, error) {
-	// Ensure we have Docker network
-	client := dockerutil.GetDockerClient()
-	err := dockerutil.EnsureNetwork(client, dockerutil.NetName)
-	if err != nil {
-		log.Fatal(err)
-	}
+	// Ensure we have DDEV network
+	dockerutil.EnsureDdevNetwork()
 
 	c, err := dockerutil.FindContainerByName(checkName)
 	if err != nil {