{"algorithm":"diff","about":["A dependency upgrade changes more of the module graph than the one line in go.mod: modules come and go, and versions move under the ones that stay. gograph.Diff compares two graphs and returns a GraphDiff with the vertices and edges added, removed and changed, and whether the graph became weighted or acyclic.","It matches vertices by label and edges by the labels of their two ends, so the two graphs can be built in any order. A vertex changes when its weight does, and an edge when its weight or its edge label does. A removed vertex takes its edges with it, and RemovedEdges lists those edges too, so the diff is complete on its own. In an undirected graph, each edge is listed once. Two graphs where one is directed and the other isn't return ErrIncompatibleGraphs.","GraphDiff.String prints one change per line, which is what a command line tool or a CI job would show, and the GraphDiff encodes as JSON. Apply makes the changes to a copy of the first graph, so Diff of that copy and the second graph is empty. WithWeightTolerance treats weights that differ by a little as equal. Diff takes O(V+E) for the vertices and edges of both graphs."],"template":{"id":"office-network","name":"Office network","description":"Switches and rooms in a four-team office, wired through a core switch.","family":"undirected","directed":false,"weighted":false,"acyclic":false,"vertices":[{"id":"Core","x":512,"y":320},{"id":"Sales","x":320,"y":192},{"id":"Support","x":704,"y":192},{"id":"Ops","x":704,"y":448},{"id":"Dev","x":320,"y":448},{"id":"Uplink","x":512,"y":64},{"id":"Sales 1","x":128,"y":128},{"id":"Lab","x":160,"y":320},{"id":"Dev 1","x":128,"y":528},{"id":"Dev 2","x":512,"y":576},{"id":"Support 1","x":896,"y":112},{"id":"Shared","x":912,"y":304},{"id":"Ops 1","x":896,"y":544}],"edges":[{"from":"Core","to":"Sales"},{"from":"Core","to":"Support"},{"from":"Core","to":"Ops"},{"from":"Core","to":"Dev"},{"from":"Sales","to":"Uplink"},{"from":"Sales","to":"Sales 1"},{"from":"Sales","to":"Lab"},{"from":"Support","to":"Uplink"},{"from":"Support","to":"Support 1"},{"from":"Support","to":"Shared"},{"from":"Ops","to":"Shared"},{"from":"Ops","to":"Ops 1"},{"from":"Dev","to":"Lab"},{"from":"Dev","to":"Dev 1"},{"from":"Dev","to":"Dev 2"},{"from":"Lab","to":"Dev 1"}],"details":{"vertices":13,"edges":16,"directed":false,"weighted":false,"acyclic":false,"negativeWeights":false,"density":0.20512820512820512,"degree":{"min":1,"avg":2.4615384615384617,"max":4},"selfLoops":0,"components":1}},"problem":"Core and Support go down for maintenance. Which links go down with them?","params":{"old":"office-network","new":"office-outage"},"result":{"kind":"diff","lines":["- vertex Core","- vertex Support","- edge Core -\u003e Sales","- edge Core -\u003e Support","- edge Core -\u003e Ops","- edge Core -\u003e Dev","- edge Support -\u003e Uplink","- edge Support -\u003e Support 1","- edge Support -\u003e Shared"]},"answer":"The diff has 2 vertices removed and 7 edges removed. Apply on the old graph gives a graph whose Diff with the new one is empty.","legend":{"vertex":[{"id":"idle","label":"In both graphs","color":"#64748B","shape":"hollow"},{"id":"absent","label":"Only in the new graph, not added yet","color":"#475569","shape":"hollow"},{"id":"removed","label":"Removed","color":"#D55E00","shape":"dashed-square"},{"id":"added","label":"Added","color":"#009E73","shape":"filled"},{"id":"changed","label":"Weight changed","color":"#E69F00","shape":"ring"}],"edge":[{"id":"idle","label":"In both graphs","color":"#475569","shape":"line"},{"id":"absent","label":"Only in the new graph, not added yet","color":"#475569","shape":"dashed"},{"id":"removed","label":"Removed","color":"#D55E00","shape":"dashed"},{"id":"added","label":"Added","color":"#009E73","shape":"thick"},{"id":"changed","label":"Weight or label changed","color":"#E69F00","shape":"thick"}],"panels":[{"id":"diff","title":"GraphDiff.String","kind":"list"},{"id":"numbers","title":"Applied so far","kind":"numbers"}]},"steps":[{"say":"Diff matches the vertices of the two graphs by label and their edges by the labels of their ends, and finds 9 differences. The graph shows the old one. What only the new graph has is faint until a step adds it. The steps make the changes in the order Apply does: removals, then additions, then changes.","ops":[{"panel":"diff","list":[{"key":"- vertex Core"},{"key":"- vertex Support"},{"key":"- edge Core -> Sales"},{"key":"- edge Core -> Support"},{"key":"- edge Core -> Ops"},{"key":"- edge Core -> Dev"},{"key":"- edge Support -> Uplink"},{"key":"- edge Support -> Support 1"},{"key":"- edge Support -> Shared"}]},{"panel":"numbers","set":{"Vertices added":"0"}},{"panel":"numbers","set":{"Vertices removed":"0"}},{"panel":"numbers","set":{"Vertices changed":"0"}},{"panel":"numbers","set":{"Edges added":"0"}},{"panel":"numbers","set":{"Edges removed":"0"}},{"panel":"numbers","set":{"Edges changed":"0"}}]},{"say":"Remove the edge between Core and Sales, since Core goes too.","ops":[{"panel":"diff","list":[{"key":"- vertex Core"},{"key":"- vertex Support"},{"key":"- edge Core -> Sales","note":"applied"},{"key":"- edge Core -> Support"},{"key":"- edge Core -> Ops"},{"key":"- edge Core -> Dev"},{"key":"- edge Support -> Uplink"},{"key":"- edge Support -> Support 1"},{"key":"- edge Support -> Shared"}]},{"e":["Core","Sales"],"state":"removed"},{"panel":"numbers","set":{"Vertices added":"0"}},{"panel":"numbers","set":{"Vertices removed":"0"}},{"panel":"numbers","set":{"Vertices changed":"0"}},{"panel":"numbers","set":{"Edges added":"0"}},{"panel":"numbers","set":{"Edges removed":"1"}},{"panel":"numbers","set":{"Edges changed":"0"}}]},{"say":"Remove the edge between Core and Support, since Core and Support go too.","ops":[{"panel":"diff","list":[{"key":"- vertex Core"},{"key":"- vertex Support"},{"key":"- edge Core -> Sales","note":"applied"},{"key":"- edge Core -> Support","note":"applied"},{"key":"- edge Core -> Ops"},{"key":"- edge Core -> Dev"},{"key":"- edge Support -> Uplink"},{"key":"- edge Support -> Support 1"},{"key":"- edge Support -> Shared"}]},{"e":["Core","Support"],"state":"removed"},{"panel":"numbers","set":{"Vertices added":"0"}},{"panel":"numbers","set":{"Vertices removed":"0"}},{"panel":"numbers","set":{"Vertices changed":"0"}},{"panel":"numbers","set":{"Edges added":"0"}},{"panel":"numbers","set":{"Edges removed":"2"}},{"panel":"numbers","set":{"Edges changed":"0"}}]},{"say":"Remove the edge between Core and Ops, since Core goes too.","ops":[{"panel":"diff","list":[{"key":"- vertex Core"},{"key":"- vertex Support"},{"key":"- edge Core -> Sales","note":"applied"},{"key":"- edge Core -> Support","note":"applied"},{"key":"- edge Core -> Ops","note":"applied"},{"key":"- edge Core -> Dev"},{"key":"- edge Support -> Uplink"},{"key":"- edge Support -> Support 1"},{"key":"- edge Support -> Shared"}]},{"e":["Core","Ops"],"state":"removed"},{"panel":"numbers","set":{"Vertices added":"0"}},{"panel":"numbers","set":{"Vertices removed":"0"}},{"panel":"numbers","set":{"Vertices changed":"0"}},{"panel":"numbers","set":{"Edges added":"0"}},{"panel":"numbers","set":{"Edges removed":"3"}},{"panel":"numbers","set":{"Edges changed":"0"}}]},{"say":"Remove the edge between Core and Dev, since Core goes too.","ops":[{"panel":"diff","list":[{"key":"- vertex Core"},{"key":"- vertex Support"},{"key":"- edge Core -> Sales","note":"applied"},{"key":"- edge Core -> Support","note":"applied"},{"key":"- edge Core -> Ops","note":"applied"},{"key":"- edge Core -> Dev","note":"applied"},{"key":"- edge Support -> Uplink"},{"key":"- edge Support -> Support 1"},{"key":"- edge Support -> Shared"}]},{"e":["Core","Dev"],"state":"removed"},{"panel":"numbers","set":{"Vertices added":"0"}},{"panel":"numbers","set":{"Vertices removed":"0"}},{"panel":"numbers","set":{"Vertices changed":"0"}},{"panel":"numbers","set":{"Edges added":"0"}},{"panel":"numbers","set":{"Edges removed":"4"}},{"panel":"numbers","set":{"Edges changed":"0"}}]},{"say":"Remove the edge between Support and Uplink, since Support goes too.","ops":[{"panel":"diff","list":[{"key":"- vertex Core"},{"key":"- vertex Support"},{"key":"- edge Core -> Sales","note":"applied"},{"key":"- edge Core -> Support","note":"applied"},{"key":"- edge Core -> Ops","note":"applied"},{"key":"- edge Core -> Dev","note":"applied"},{"key":"- edge Support -> Uplink","note":"applied"},{"key":"- edge Support -> Support 1"},{"key":"- edge Support -> Shared"}]},{"e":["Support","Uplink"],"state":"removed"},{"panel":"numbers","set":{"Vertices added":"0"}},{"panel":"numbers","set":{"Vertices removed":"0"}},{"panel":"numbers","set":{"Vertices changed":"0"}},{"panel":"numbers","set":{"Edges added":"0"}},{"panel":"numbers","set":{"Edges removed":"5"}},{"panel":"numbers","set":{"Edges changed":"0"}}]},{"say":"Remove the edge between Support and Support 1, since Support goes too.","ops":[{"panel":"diff","list":[{"key":"- vertex Core"},{"key":"- vertex Support"},{"key":"- edge Core -> Sales","note":"applied"},{"key":"- edge Core -> Support","note":"applied"},{"key":"- edge Core -> Ops","note":"applied"},{"key":"- edge Core -> Dev","note":"applied"},{"key":"- edge Support -> Uplink","note":"applied"},{"key":"- edge Support -> Support 1","note":"applied"},{"key":"- edge Support -> Shared"}]},{"e":["Support","Support 1"],"state":"removed"},{"panel":"numbers","set":{"Vertices added":"0"}},{"panel":"numbers","set":{"Vertices removed":"0"}},{"panel":"numbers","set":{"Vertices changed":"0"}},{"panel":"numbers","set":{"Edges added":"0"}},{"panel":"numbers","set":{"Edges removed":"6"}},{"panel":"numbers","set":{"Edges changed":"0"}}]},{"say":"Remove the edge between Support and Shared, since Support goes too.","ops":[{"panel":"diff","list":[{"key":"- vertex Core"},{"key":"- vertex Support"},{"key":"- edge Core -> Sales","note":"applied"},{"key":"- edge Core -> Support","note":"applied"},{"key":"- edge Core -> Ops","note":"applied"},{"key":"- edge Core -> Dev","note":"applied"},{"key":"- edge Support -> Uplink","note":"applied"},{"key":"- edge Support -> Support 1","note":"applied"},{"key":"- edge Support -> Shared","note":"applied"}]},{"e":["Support","Shared"],"state":"removed"},{"panel":"numbers","set":{"Vertices added":"0"}},{"panel":"numbers","set":{"Vertices removed":"0"}},{"panel":"numbers","set":{"Vertices changed":"0"}},{"panel":"numbers","set":{"Edges added":"0"}},{"panel":"numbers","set":{"Edges removed":"7"}},{"panel":"numbers","set":{"Edges changed":"0"}}]},{"say":"Remove the vertex Core. Its edges went in the steps before, since RemovedEdges lists the edges of a removed vertex too.","ops":[{"panel":"diff","list":[{"key":"- vertex Core","note":"applied"},{"key":"- vertex Support"},{"key":"- edge Core -> Sales","note":"applied"},{"key":"- edge Core -> Support","note":"applied"},{"key":"- edge Core -> Ops","note":"applied"},{"key":"- edge Core -> Dev","note":"applied"},{"key":"- edge Support -> Uplink","note":"applied"},{"key":"- edge Support -> Support 1","note":"applied"},{"key":"- edge Support -> Shared","note":"applied"}]},{"v":"Core","state":"removed"},{"panel":"numbers","set":{"Vertices added":"0"}},{"panel":"numbers","set":{"Vertices removed":"1"}},{"panel":"numbers","set":{"Vertices changed":"0"}},{"panel":"numbers","set":{"Edges added":"0"}},{"panel":"numbers","set":{"Edges removed":"7"}},{"panel":"numbers","set":{"Edges changed":"0"}}]},{"say":"Remove the vertex Support. Its edges went in the steps before, since RemovedEdges lists the edges of a removed vertex too.","ops":[{"panel":"diff","list":[{"key":"- vertex Core","note":"applied"},{"key":"- vertex Support","note":"applied"},{"key":"- edge Core -> Sales","note":"applied"},{"key":"- edge Core -> Support","note":"applied"},{"key":"- edge Core -> Ops","note":"applied"},{"key":"- edge Core -> Dev","note":"applied"},{"key":"- edge Support -> Uplink","note":"applied"},{"key":"- edge Support -> Support 1","note":"applied"},{"key":"- edge Support -> Shared","note":"applied"}]},{"v":"Support","state":"removed"},{"panel":"numbers","set":{"Vertices added":"0"}},{"panel":"numbers","set":{"Vertices removed":"2"}},{"panel":"numbers","set":{"Vertices changed":"0"}},{"panel":"numbers","set":{"Edges added":"0"}},{"panel":"numbers","set":{"Edges removed":"7"}},{"panel":"numbers","set":{"Edges changed":"0"}}]},{"say":"Done. The old graph with these 9 changes is the new one: Apply makes the same changes to a copy of the old graph, and Diff of that copy and the new graph is empty."}],"traceNote":"","verification":"The steps come from a step-by-step copy of Diff. Its result is checked against gograph's on every start, and Apply on the old graph gives a graph whose Diff with the new one is empty.","snippet":"d, err := gograph.Diff(before, after)\nif err != nil {\n\treturn err // gograph.ErrIncompatibleGraphs\n}\nfmt.Println(d) // + vertex, - edge, ~ edge ... weight 5 -> 7\n\nupgraded, err := d.Apply(before)\nif err != nil {\n\treturn err\n}\nagain, err := gograph.Diff(upgraded, after)\nif err != nil {\n\treturn err\n}\nfmt.Println(again.IsEmpty()) // true"}
