refactor: use new Graph in ViewGraph (#155)

~Depends on #154~

This PR refactors `ViewGraph` to use the `Graph` ADT internally

Author: MegaRedHand

src/graphics/renderables/device_info.ts

@@ -23,10 +23,13 @@ export class DeviceInfo extends StyledInfo {
   }
 
   private addCommonInfoFields() {
-    const { id, connections, mac } = this.device;
+    const { id, mac } = this.device;
+    const connections = this.device.viewgraph
+      .getConnections(id)
+      .map((edge) => edge.otherEnd(id));
     super.addField("ID", id.toString());
     super.addField("MacAddress", mac.toString());
-    super.addListField("Connected Devices", Array.from(connections.values()));
+    super.addListField("Connected Devices", connections);
   }
 
   private addCommonButtons() {

src/programs/echo_sender.ts

@@ -11,7 +11,8 @@ import { EthernetFrame } from "../packets/ethernet";
 
 function adjacentDevices(viewgraph: ViewGraph, srcId: DeviceId) {
   const adjacentDevices = viewgraph
-    .getAdjacentDeviceIds(srcId)
+    .getDeviceIds()
+    .filter((id) => id !== srcId)
     .map((id) => ({ value: id.toString(), text: `Device ${id}` }));
 
   return adjacentDevices;
@@ -63,7 +64,6 @@ export class SingleEcho extends ProgramBase {
     const path = this.viewgraph.getPathBetween(this.srcId, this.dstId);
     let dstMac = dstDevice.mac;
     if (!path) return;
-    console.log(path);
     for (const id of path.slice(1)) {
       const device = this.viewgraph.getDevice(id);
       // if there’s a router in the middle, first send frame to router mac

src/types/devices/device.ts

@@ -52,7 +52,6 @@ export abstract class Device extends Container {
   readonly id: DeviceId;
   readonly viewgraph: ViewGraph;
   ctx: GlobalContext;
-  connections = new Set<DeviceId>();
 
   mac: MacAddress;
   arpTable: Map<IpAddress, MacAddress> = new Map<IpAddress, MacAddress>();
@@ -132,25 +131,13 @@ export abstract class Device extends Container {
     this.addChild(idText); // Add the ID text as a child of the device
   }
 
-  getConnections(): DeviceId[] {
-    return Array.from(this.connections.values());
-  }
-
   /// Returns the data needed to create the device
   getCreateDevice(): CreateDevice {
     const node = this.viewgraph.getDataGraph().getDevice(this.id);
     const connections = this.viewgraph.getDataGraph().getConnections(this.id);
     return { id: this.id, node, connections };
   }
 
-  addConnection(adjacentId: DeviceId) {
-    this.connections.add(adjacentId);
-  }
-
-  removeConnection(id: DeviceId) {
-    this.connections.delete(id);
-  }
-
   delete(): void {
     this.viewgraph.removeDevice(this.id);
     console.log(`Device ${this.id} deleted`);
@@ -172,16 +159,11 @@ export abstract class Device extends Container {
     this.parent.on("pointerup", onPointerUp);
   }
 
+  // TODO: why is this even here??
   connectTo(adjacentId: DeviceId): boolean {
     // Connects both devices with an edge.
-    // console.log("Entered connectTo");
-
     const edgeId = this.viewgraph.addEdge(this.id, adjacentId);
     if (edgeId) {
-      const adjacentDevice = this.viewgraph.getDevice(adjacentId);
-      this.addConnection(adjacentId);
-      adjacentDevice.addConnection(this.id);
-
       // Register move
       const move = new AddEdgeMove(this.viewgraph.getLayer(), {
         n1: this.id,
@@ -277,7 +259,6 @@ export abstract class Device extends Container {
 
   destroy() {
     // Clear connections
-    this.connections.clear();
     deselectElement();
     super.destroy();
   }

src/types/devices/router.ts

@@ -94,6 +94,10 @@ export class Router extends NetworkDevice {
     }
     // a router changed forward datagram to destination, have to change current destination mac
     const dstDevice = this.viewgraph.getDeviceByIP(datagram.destinationAddress);
+    if (!dstDevice) {
+      console.error("Destination device not found");
+      return null;
+    }
     const path = this.viewgraph.getPathBetween(this.id, dstDevice.id);
     let dstMac = dstDevice.mac;
     if (!path) return null;

src/types/devices/switch.ts

@@ -50,6 +50,10 @@ export class Switch extends Device {
       const dstDevice = this.viewgraph.getDeviceByIP(
         datagram.destinationAddress,
       );
+      if (!dstDevice) {
+        console.error("Destination device not found");
+        return null;
+      }
       const path = this.viewgraph.getPathBetween(this.id, dstDevice.id);
       return Promise.resolve(path.length > 1 ? path[1] : null);
     }

src/types/edge.ts

@@ -20,11 +20,6 @@ export class Edge extends Graphics {
   viewgraph: ViewGraph;
   rightbar: RightBar;
 
-  static generateConnectionKey(connectedNodes: EdgeEdges): string {
-    const { n1, n2 } = connectedNodes;
-    return [n1, n2].sort().join(",");
-  }
-
   constructor(
     connectedNodes: EdgeEdges,
     device1: Device,
@@ -101,7 +96,6 @@ export class Edge extends Graphics {
   // Method to show the Edge information
   showInfo() {
     const info = new StyledInfo("Edge Information");
-    info.addField("Edge ID", Edge.generateConnectionKey(this.connectedNodes));
     info.addField(
       "Connected Devices",
       `${this.connectedNodes.n1} <=> ${this.connectedNodes.n2}`,
@@ -149,9 +143,9 @@ export class Edge extends Graphics {
   // Method to delete the edge
   delete() {
     // Remove the edge from the viewgraph and datagraph
-    const id = Edge.generateConnectionKey(this.connectedNodes);
-    this.viewgraph.removeEdge(id);
-    console.log(`Edge ${id} deleted.`);
+    const { n1, n2 } = this.connectedNodes;
+    this.viewgraph.removeEdge(n1, n2);
+    console.log(`Edge ${n1},${n2} deleted.`);
     this.destroy();
   }
 

src/types/graphs/datagraph.ts

@@ -151,7 +151,7 @@ export class DataGraph {
     const graphData: GraphData = [];
 
     // Serialize nodes
-    for (const [id, info] of this.deviceGraph.getVertices()) {
+    for (const [id, info] of this.deviceGraph.getAllVertices()) {
       const graphNode: GraphDataNode = {
         ...info,
         id,
@@ -256,7 +256,7 @@ export class DataGraph {
 
   // Get all devices in the graph
   getDevices(): IterableIterator<[DeviceId, GraphNode]> {
-    return this.deviceGraph.getVertices();
+    return this.deviceGraph.getAllVertices();
   }
 
   // Get the number of devices in the graph
@@ -302,7 +302,7 @@ export class DataGraph {
 
   regenerateAllRoutingTables() {
     console.log("Regenerating all routing tables");
-    for (const [id] of this.deviceGraph.getVertices()) {
+    for (const [id] of this.deviceGraph.getAllVertices()) {
       this.regenerateRoutingTable(id);
     }
   }

src/types/graphs/graph.ts

@@ -27,14 +27,21 @@ export class Graph<Vertex, Edge> {
     return this.edges.get(id)?.get(otherId);
   }
 
+  /**
+   * Returns the edges connected to a given vertex.
+   */
+  getEdges(id: VertexId): IterableIterator<[VertexId, Edge]> | undefined {
+    return this.edges.get(id)?.entries();
+  }
+
   getNeighbors(id: VertexId): VertexId[] | undefined {
     if (!this.hasVertex(id)) {
       return undefined;
     }
     return Array.from(this.edges.get(id).keys());
   }
 
-  getVertices(): IterableIterator<[VertexId, Vertex]> {
+  getAllVertices(): IterableIterator<[VertexId, Vertex]> {
     return this.vertices.entries();
   }
 
@@ -46,7 +53,7 @@ export class Graph<Vertex, Edge> {
    * Returns an iterator over all edges in the graph.
    * @returns an iterator over all edges in the graph, with no duplicates.
    */
-  getEdges(): IterableIterator<[VertexId, VertexId, Edge]> {
+  getAllEdges(): IterableIterator<[VertexId, VertexId, Edge]> {
     return edgeIterator(this.edges);
   }
 
@@ -84,6 +91,11 @@ export class Graph<Vertex, Edge> {
     this.edges.get(id).delete(otherId);
     this.edges.get(otherId).delete(id);
   }
+
+  clear() {
+    this.vertices.clear();
+    this.edges.clear();
+  }
 }
 
 function* edgeIterator<Edge>(