@takodotid/circuit 0.42.0 → 0.43.0

package/src/platforms/routeros/plan.ts

@@ -83,6 +83,11 @@ export class RouterOsPlan {
     /** Menus where an entry that keeps its name but changes what it is known by is changed with a `set`, so what points at it by name, such as an address on a VLAN interface, stays attached. In every other menu it is removed and added again. */
     private static readonly CHANGED_IN_PLACE = new Set(["/interface vlan"]);
 
+    /**
+     * Properties a running entry takes only when it restarts. A BGP session given a new `routing-table` stops announcing at once and keeps its routes in the old table until it restarts (TRAPS.md), so the plan disables the connection, changes it and enables it again: one restart, written in the plan.
+     */
+    private static readonly RESTART_ON: Record<string, string[]> = { "/routing bgp connection": ["routing-table"] };
+
     /** The variable holding the old rules of an ordered menu while the new ones are added. Removed when the rewrite ends. */
     private static readonly OLD_RULES = "frameworkOldRules";
 
@@ -314,8 +319,19 @@ export class RouterOsPlan {
             const update = this.changes(entry, current, `${menu} ${entryKey}`);
             if (!Object.keys(update).length) continue;
 
+            const selector = RouterOsPlan.find(menu, RouterOsExport.identity(current));
+            const restartsOn = (RouterOsPlan.RESTART_ON[menu] ?? []).filter((property) => property in update);
+            if (restartsOn.length) {
+                changeStep.show.push(
+                    `~ ${entryKey} ${RouterOsPlan.describe(update)}, restarting the session: it takes a new ${restartsOn.join(" and ")} only when it restarts`
+                );
+                changeStep.send.push(RouterOsPlan.line(menu, "set", selector, [], { disabled: "yes", ...update }));
+                changeStep.send.push(RouterOsPlan.line(menu, "set", selector, [], { disabled: "no" }));
+                continue;
+            }
+
             changeStep.show.push(`~ ${entryKey} ${RouterOsPlan.describe(update)}`);
-            changeStep.send.push(RouterOsPlan.line(menu, "set", RouterOsPlan.find(menu, RouterOsExport.identity(current)), [], update));
+            changeStep.send.push(RouterOsPlan.line(menu, "set", selector, [], update));
         }
 
         const removed = existingEntries.filter((entry) => !kept.has(key(entry)));

package/src/platforms/routeros/render.ts

@@ -1,6 +1,7 @@
 // The neutral model as a RouterOS 7 export, written in the form `/export` prints so the two compare line for line.
 
 import { X509Certificate } from "node:crypto";
+import { Utils } from "../../core/utils";
 import { Address } from "../../core/address";
 import { Secrets } from "../../core/secrets";
 import type {
@@ -1147,7 +1148,7 @@ export class RouterOsRender {
                 distance: route.distance,
                 "dst-address": route.prefix,
                 gateway,
-                "routing-table": route.vrf ?? route.table,
+                "routing-table": route.vrf ?? Utils.otherTable(route.table),
             });
         }
     }
@@ -1292,7 +1293,7 @@ export class RouterOsRender {
                 "output.network": originates ? RouterOsRender.NETWORKS[family] : undefined,
                 "remote.address": `${neighbor.address}/${addressFamily === "ipv4" ? 32 : 128}`,
                 "remote.as": settings.remote_as,
-                "routing-table": settings.table,
+                "routing-table": Utils.otherTable(settings.table),
                 "tcp-md5-key": settings.password && Secrets.marker(settings.password),
                 "use-bfd": settings.bfd ? "yes" : undefined,
             });

package/src/schema/routing.ts

@@ -16,8 +16,8 @@ export type StaticRoute<I extends string, F extends string, T extends string = n
     distance?: number;
     /** The VRF the route is in. The main table when absent. */
     vrf?: F;
-    /** The table the route is in, one of `routing.tables`. The main table when absent. A route has a `vrf` or a `table`, not both. */
-    table?: T;
+    /** The table the route is in: `main`, or one of `routing.tables`. The main table when absent; write `main` to say so. A route has a `vrf` or a `table`, not both. */
+    table?: T | "main";
     /** Why the route exists. */
     description?: string;
 };
@@ -57,8 +57,8 @@ export type NeighborSettings<P extends string, T extends string = never> = {
     passive?: boolean;
     /** Detect a dead link in under a second with BFD. */
     bfd?: boolean;
-    /** The table the routes learned are installed in, one of `routing.tables`. The main table when absent. What is announced still comes from `networks` and the main table. */
-    table?: T;
+    /** The table the routes learned are installed in: `main`, or one of `routing.tables`. The main table when absent; write `main` to say so. On RouterOS the session also announces from that table, so each prefix of `networks` it announces needs a route in the table too, and a running session takes a new table only when it restarts. */
+    table?: T | "main";
 };
 
 /** One BGP session. Settings it does not set come from its group. */