From 9e34e91d7df6192e31c6e37fc45e1fdf0376f546 Mon Sep 17 00:00:00 2001
From: Gavin Nishizawa <gavin@terrastruct.com>
Date: Mon, 13 Nov 2023 18:36:39 -0800
Subject: [PATCH] fix panic with unrouted edge to grid cell container

---
 d2layouts/d2layouts.go | 44 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 43 insertions(+), 1 deletion(-)

diff --git a/d2layouts/d2layouts.go b/d2layouts/d2layouts.go
index 7a05f2533..ca258f00c 100644
--- a/d2layouts/d2layouts.go
+++ b/d2layouts/d2layouts.go
@@ -111,7 +111,49 @@ func LayoutNested(ctx context.Context, g *d2graph.Graph, graphInfo GraphInfo, co
 			}
 
 			InjectNested(g.Root, nestedGraph, false)
-			g.Edges = append(g.Edges, externalEdges...)
+			for _, e := range externalEdges {
+				if e.Src.AbsID() == id || e.Dst.AbsID() == id {
+					// We need to keep this edge extracted to route after grid layout.
+					// When we extracted curr(grid cell container) externalEdges=[A, C] and nestedGraph.Edges=[B]
+					// With includeSelf=true
+					// ┌grid(g.Root)───────────────────┐    ┌grid(g.Root)───────────────────┐
+					// │ ┌────┐      ┌curr───────────┐ │    │ ┌────┐                        │
+					// │ │    │      │  ┌──┐    ┌──┐ │ │    │ │    │                        │
+					// │ │    ├──A──►│  │  ├─B─►│  │ │ │ => │ │    │                        │
+					// │ │    ├──────┼C─┼──┼───►│  │ │ │    │ │    │                        │
+					// │ │    │      │  └──┘    └──┘ │ │    │ │    │                        │
+					// │ └────┘      └───────────────┘ │    │ └────┘                        │
+					// └───────────────────────────────┘    └───────────────────────────────┘
+					//
+					// If we add back all external edges, when we extract curr with includeSelf=false,
+					// externalEdges would be [C], nestedGraph.Edges=[B], and graph.Edges=[A].
+					// This would incorrectly leave A in the graph and it wouldn't be routed after grid layout
+					// With includeSelf=false
+					// ┌grid(g.Root)───────────────────┐    ┌grid(g.Root)───────────────────┐
+					// │ ┌────┐      ┌curr───────────┐ │    │ ┌────┐      ┌curr───────────┐ │
+					// │ │    │      │  ┌──┐    ┌──┐ │ │    │ │    │      │               │ │
+					// │ │    ├──A──►│  │  ├─B─►│  │ │ │ => │ │    ├──A──►│               │ │
+					// │ │    ├──────┼C─┼──┼───►│  │ │ │    │ │    │      │               │ │
+					// │ │    │      │  └──┘    └──┘ │ │    │ │    │      │               │ │
+					// │ └────┘      └───────────────┘ │    │ └────┘      └───────────────┘ │
+					// └───────────────────────────────┘    └───────────────────────────────┘
+					//
+					// Therefore we only add [B, C] since they will be correctly extracted with includeSelf=false
+					// as externalEdges=[C] and nestedGraph.Edges=[B].
+					// With includeSelf=false
+					// ┌grid(g.Root)───────────────────┐    ┌grid(g.Root)───────────────────┐
+					// │ ┌────┐      ┌curr───────────┐ │    │ ┌────┐      ┌curr───────────┐ │
+					// │ │    │      │  ┌──┐    ┌──┐ │ │    │ │    │      │               │ │
+					// │ │    │      │  │  ├─B─►│  │ │ │ => │ │    │      │               │ │
+					// │ │    ├──────┼C─┼──┼───►│  │ │ │    │ │    │      │               │ │
+					// │ │    │      │  └──┘    └──┘ │ │    │ │    │      │               │ │
+					// │ └────┘      └───────────────┘ │    │ └────┘      └───────────────┘ │
+					// └───────────────────────────────┘    └───────────────────────────────┘
+					extractedEdges = append(extractedEdges, e)
+				} else {
+					g.Edges = append(g.Edges, e)
+				}
+			}
 			restoreOrder()
 
 			// need to update curr *Object incase layout changed it