adjust error mesages to provide more useful output

johnstcn · johnstcn · commit 572a9380dcc3 · 2025-05-21T10:56:00.000+01:00
diff --git a/src/sshConfig.test.ts b/src/sshConfig.test.ts
@@ -300,10 +300,59 @@ Host afterconfig
       LogLevel: "ERROR",
     }),
   ).rejects.toThrow(
-    `Malformed config: ssh config has 2 dev.coder.com START comments but 1 dev.coder.com END comments. Each START must have a matching END.`,
+    `Malformed config: Unterminated START CODER VSCODE dev.coder.com block: Each START block must have an END block.`,
   )
 })
 
+it("throws an error if there is a mismatched start and end block count (without label)", async () => {
+  // As above, but without a label.
+  const existentSSHConfig = `Host beforeconfig
+  HostName before.config.tld
+  User before
+
+# --- START CODER VSCODE ---
+Host coder-vscode.dev.coder.com--*
+  ConnectTimeout 0
+  LogLevel ERROR
+  ProxyCommand some-command-here
+  StrictHostKeyChecking no
+  UserKnownHostsFile /dev/null
+# missing END CODER VSCODE ---
+
+Host donotdelete
+  HostName dont.delete.me
+  User please
+
+# --- START CODER VSCODE ---
+Host coder-vscode.dev.coder.com--*
+  ConnectTimeout 0
+  LogLevel ERROR
+  ProxyCommand some-command-here
+  StrictHostKeyChecking no
+  UserKnownHostsFile /dev/null
+# --- END CODER VSCODE ---
+
+Host afterconfig
+  HostName after.config.tld
+  User after`
+
+  const sshConfig = new SSHConfig(sshFilePath, mockFileSystem)
+  mockFileSystem.readFile.mockResolvedValueOnce(existentSSHConfig)
+  await sshConfig.load()
+
+  // When we try to update the config, it should throw an error.
+  await expect(
+    sshConfig.update("", {
+      Host: "coder-vscode.dev.coder.com--*",
+      ProxyCommand: "some-command-here",
+      ConnectTimeout: "0",
+      StrictHostKeyChecking: "no",
+      UserKnownHostsFile: "/dev/null",
+      LogLevel: "ERROR",
+    }),
+  ).rejects.toThrow(`Malformed config: Unterminated START CODER VSCODE block: Each START block must have an END block.`)
+})
+
 it("throws an error if there are more than one sections with the same label", async () => {
   const existentSSHConfig = `Host beforeconfig
   HostName before.config.tld
@@ -349,7 +398,9 @@ Host afterconfig
       UserKnownHostsFile: "/dev/null",
       LogLevel: "ERROR",
     }),
-  ).rejects.toThrow(`Malformed config: ssh config has 2 dev.coder.com sections, please remove all but one.`)
+  ).rejects.toThrow(
+    `Malformed config: ssh config has 2 START CODER VSCODE dev.coder.com sections, please remove all but one.`,
+  )
 })
 
 it("correctly handles interspersed blocks with and without label", async () => {
diff --git a/src/sshConfig.ts b/src/sshConfig.ts
@@ -138,12 +138,12 @@ export class SSHConfig {
 
     if (startBlockCount !== endBlockCount) {
       throw new SSHConfigBadFormat(
-        `Malformed config: ssh config has ${startBlockCount} ${label} START comments but ${endBlockCount} ${label} END comments. Each START must have a matching END.`,
+        `Malformed config: Unterminated START CODER VSCODE ${label ? label + " " : ""}block: Each START block must have an END block.`,
       )
     }
     if (startBlockCount > 1 || endBlockCount > 1) {
       throw new SSHConfigBadFormat(
-        `Malformed config: ssh config has ${startBlockCount} ${label} sections, please remove all but one.`,
+        `Malformed config: ssh config has ${startBlockCount} START CODER VSCODE ${label ? label + " " : ""}sections, please remove all but one.`,
       )
     }
 

Original file line number	Diff line number	Diff line change
`@@ -138,12 +138,12 @@ export class SSHConfig {`
`138`	`138`
`139`	`139`	`if (startBlockCount !== endBlockCount) {`
`140`	`140`	`throw new SSHConfigBadFormat(`
`141`		- `Malformed config: ssh config has ${startBlockCount} ${label} START comments but ${endBlockCount} ${label} END comments. Each START must have a matching END.`,
	`141`	+ `Malformed config: Unterminated START CODER VSCODE ${label ? label + " " : ""}block: Each START block must have an END block.`,
`142`	`142`	`)`
`143`	`143`	`}`
`144`	`144`	`if (startBlockCount > 1 \|\| endBlockCount > 1) {`
`145`	`145`	`throw new SSHConfigBadFormat(`
`146`		- `Malformed config: ssh config has ${startBlockCount} ${label} sections, please remove all but one.`,
	`146`	+ `Malformed config: ssh config has ${startBlockCount} START CODER VSCODE ${label ? label + " " : ""}sections, please remove all but one.`,
`147`	`147`	`)`
`148`	`148`	`}`
`149`	`149`