@takodotid/circuit 0.28.0 → 0.28.1

package/dist/cli/index.js

@@ -324,8 +324,10 @@ async function openOnJump(console2, jump) {
     return {
       channel: asTerminal(channel),
       close: () => {
-        channel.end();
-        client.end();
+        quiet(channel, 1000).then(() => {
+          channel.end();
+          client.end();
+        });
       }
     };
   } catch (error) {
@@ -355,8 +357,10 @@ async function openHere(console2) {
   return {
     channel: asTerminal(asChannel),
     close: () => {
-      channel.end();
-      setTimeout(() => child.kill(), 2000).unref();
+      quiet(asChannel, 1000).then(() => {
+        channel.end();
+        setTimeout(() => child.kill(), 2000).unref();
+      });
     }
   };
 }
@@ -428,6 +432,7 @@ async function consoleLogin(channel, dialect, user, password) {
     return `${dialect.logout}
 `;
   };
+  await quiet(channel, 1000);
   let state = (await expect(channel, `
 `, states)).index;
   for (let step = 0;state !== 0; step++) {
@@ -435,6 +440,7 @@ async function consoleLogin(channel, dialect, user, password) {
       throw new Error("the console never reached a login prompt");
     state = (await expect(channel, toward(state), states)).index;
   }
+  await quiet(channel, 1000);
   const name = dialect.user ? dialect.user(user) : user;
   if ((await expect(channel, `${name}
 `, [dialect.password, dialect.login, dialect.prompt])).index !== 0) {
@@ -4566,7 +4572,7 @@ async function edit(channel, line, timeout = 60000) {
   return output.replace(/\r/g, "");
 }
 var JUNOS_CONSOLE = {
-  login: /login: $/,
+  login: /(?:^|\n)login: $/,
   password: /Password:\s*$/,
   prompt: /[>%] $/,
   logout: "exit",
@@ -4613,7 +4619,7 @@ async function named(channel, line) {
   return [...names].map((name) => `delete ${[...words.slice(0, at), name, ...words.slice(at + 1)].join(" ")}`);
 }
 var REFUSED2 = /^terminal:\d+:\(\d+\) (?!warning)|^error: /m;
-async function configure2(channel, plan, guard) {
+async function configure2(channel, plan, guard, paced = false) {
   const sent = plan.steps.flatMap((step) => step.send);
   const entered = await run(channel, "configure exclusive");
   if (!/Entering configuration mode/.test(entered) || /^error: /m.test(entered)) {
@@ -4639,9 +4645,13 @@ async function configure2(channel, plan, guard) {
   channel.write(`load set terminal
 `);
   await readUntil(channel, (text) => text.includes("[Type ^D at a new line to end input]"), 20000, 300);
-  for (const line of ordered)
-    channel.write(`${substitute(line)}
+  for (const line of ordered) {
+    const statement = substitute(line);
+    channel.write(`${statement}
 `);
+    if (paced)
+      await readUntil(channel, (text) => text.replace(/\r/g, "").includes(statement.slice(-24)), 20000, 50);
+  }
   const loaded = await edit(channel, "\x04", 300000);
   const refused = loaded.split(`
 `).filter((line) => REFUSED2.test(line));
@@ -4706,7 +4716,7 @@ async function apply2(device, _network, plan, options) {
           await relogin();
           await run(channel, "configure exclusive");
         }
-      });
+      }, true);
     });
     return;
   }

package/dist/types/adapters/devices/junos/index.d.ts

@@ -32,7 +32,7 @@ export type Guard = {
  *
  * Deletions go before the statements that are set, so a path deleted and set again in one plan ends up set.
  */
-export declare function configure(channel: ClientChannel, plan: Plan, guard?: Guard): Promise<void>;
+export declare function configure(channel: ClientChannel, plan: Plan, guard?: Guard, paced?: boolean): Promise<void>;
 export declare function apply(device: Device, _network: readonly Device[], plan: Plan, options: ApplyOptions): Promise<void>;
 export declare function unsupported(device: Device): string[];
 /** The plan that replaces a prefix list's entries with what a registry returned. */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@takodotid/circuit",
-    "version": "0.28.0",
+    "version": "0.28.1",
     "description": "Declarative, vendor-neutral network configuration: describe each device in TypeScript, and Circuit makes the device match. Alpha.",
     "keywords": [
         "network",

package/src/adapters/devices/fortios/TRAPS.md

@@ -39,3 +39,4 @@ Behaviour that looks like something else. Each one has been hit on a FortiGate 3
 - `execute backup config flash <comment>` keeps a revision on the device, and `execute restore config flash <id>` restores one.
 - The ports are `port1` to `port4` at 40G and `port5` to `port32` at 10G, then `mgmt1` and `mgmt2`. The factory dedicates both management ports to management and gives them addresses `192.168.1.99` and `192.168.2.99`.
 - On the serial console a line ends at a carriage return. A session left open stays logged in, and one left inside `config` stays there, so the next login must first leave and log out. The console takes 9600 bits per second: reading the sections Circuit manages takes about two minutes.
+- A data port can stay `netdev status: down`, with `rx_carrier: 0` in `diagnose hardware deviceinfo nic`, while the far end reads link-ok and frames reach the port's switch chip. Fixing the speed does not change it, in a LAG or out of one; a reboot does. `link_status: Up` there says nothing: a port with no cable shows it too.

package/src/adapters/devices/junos/TRAPS.md

@@ -29,3 +29,6 @@ Behaviour that looks like something else. Each one has been hit on a QFX5100-48S
 - IPv4 routes over an IPv6 session need a local IPv4 address under the family: `Local IPv4 address must be configured`.
 - A DHCP server and a DHCP relay cannot share an interface: `Interface irb.10 already configured`.
 - A port's MTU counts the Ethernet header. `mtu 9018` carries 9000-byte packets with a VLAN tag, and a VLAN interface's 9000 then commits without a warning.
+- The serial console has no flow control. Statements pasted into `load set terminal` at once overrun it: some arrive garbled, the load reports syntax errors, and the `^D` that ends it can be lost, leaving the console in the load. Circuit sends each statement after the echo of the one before.
+- After a login the console prints `Last login: ...`, which ends in `login: ` like the login prompt; only a `login: ` on a line of its own is the prompt.
+- A factory-default switch runs Auto Image Upgrade, which prints on the console every few seconds until `delete chassis auto-image-upgrade` is committed.

package/src/adapters/devices/junos/index.ts

@@ -360,7 +360,8 @@ async function edit(channel: ClientChannel, line: string, timeout = 60_000): Pro
 
 /** How the console asks for a login. Root lands in a shell, `%`, every other user in the CLI, `>`; a session left in configuration mode, `#`, leaves it first. Not yet proved on a device. */
 export const JUNOS_CONSOLE: ConsoleDialect = {
-    login: /login: $/,
+    // On a line of its own: the banner after a login says `Last login: ...`, and a chunk can end right after it.
+    login: /(?:^|\n)login: $/,
     password: /Password:\s*$/,
     prompt: /[>%] $/,
     logout: "exit",
@@ -434,7 +435,7 @@ export type Guard = { minutes: number; prove: () => Promise<void> };
  *
  * Deletions go before the statements that are set, so a path deleted and set again in one plan ends up set.
  */
-export async function configure(channel: ClientChannel, plan: Plan, guard?: Guard): Promise<void> {
+export async function configure(channel: ClientChannel, plan: Plan, guard?: Guard, paced = false): Promise<void> {
     const sent = plan.steps.flatMap((step) => step.send);
 
     const entered = await run(channel, "configure exclusive");
@@ -460,7 +461,12 @@ export async function configure(channel: ClientChannel, plan: Plan, guard?: Guar
     channel.write("load set terminal\n");
     await readUntil(channel, (text) => text.includes("[Type ^D at a new line to end input]"), 20_000, 300);
 
-    for (const line of ordered) channel.write(`${substitute(line)}\n`);
+    // A serial console has no flow control: statements sent at once overrun it and arrive garbled. There, each waits for the echo of the one before.
+    for (const line of ordered) {
+        const statement = substitute(line);
+        channel.write(`${statement}\n`);
+        if (paced) await readUntil(channel, (text) => text.replace(/\r/g, "").includes(statement.slice(-24)), 20_000, 50);
+    }
 
     const loaded = await edit(channel, "\u0004", 300_000);
     const refused = loaded.split("\n").filter((line) => REFUSED.test(line));
@@ -518,14 +524,19 @@ export async function apply(device: Device, _network: readonly Device[], plan: P
             await checkVersion((command) => run(channel, command), device);
 
             // A fresh login on the console ends the session that holds the candidate, so the proof logs in again and takes the candidate back to confirm the commit.
-            await configure(channel, plan, {
-                minutes: options.rollback,
-                prove: async () => {
-                    await run(channel, "exit configuration-mode");
-                    await relogin();
-                    await run(channel, "configure exclusive");
+            await configure(
+                channel,
+                plan,
+                {
+                    minutes: options.rollback,
+                    prove: async () => {
+                        await run(channel, "exit configuration-mode");
+                        await relogin();
+                        await run(channel, "configure exclusive");
+                    },
                 },
-            });
+                true
+            );
         });
         return;
     }

package/src/transport/console.ts

@@ -144,9 +144,12 @@ async function openOnJump(console: Console, jump: Jump): Promise<ConsoleSession>
 
         return {
             channel: asTerminal(channel),
+            // What was written last, such as a logout, is still on its way to the device; the relay ends once the console goes quiet.
             close: () => {
-                channel.end();
-                client.end();
+                void quiet(channel, 1_000).then(() => {
+                    channel.end();
+                    client.end();
+                });
             },
         };
     } catch (error) {
@@ -186,8 +189,10 @@ async function openHere(console: Console): Promise<ConsoleSession> {
     return {
         channel: asTerminal(asChannel),
         close: () => {
-            channel.end();
-            setTimeout(() => child.kill(), 2_000).unref();
+            void quiet(asChannel, 1_000).then(() => {
+                channel.end();
+                setTimeout(() => child.kill(), 2_000).unref();
+            });
         },
     };
 }
@@ -301,12 +306,18 @@ export async function consoleLogin(channel: Channel, dialect: ConsoleDialect, us
         return `${dialect.logout}\n`;
     };
 
+    // What the last session printed as it left, such as a login prompt after its logout, arrives late; it must not be taken for an answer.
+    await quiet(channel, 1_000);
+
     let state = (await expect(channel, "\n", states)).index;
     for (let step = 0; state !== 0; step++) {
         if (step >= 10) throw new Error("the console never reached a login prompt");
         state = (await expect(channel, toward(state), states)).index;
     }
 
+    // A console can print the login prompt more than once; a name typed while it does is lost.
+    await quiet(channel, 1_000);
+
     const name = dialect.user ? dialect.user(user) : user;
     if ((await expect(channel, `${name}\n`, [dialect.password, dialect.login, dialect.prompt])).index !== 0) {
         throw new Error("the console did not ask for a password");