move malformed block check earlier

coder · bcpeinhardt · May 23, 2025 · May 20, 2025 · May 21, 2025 · May 21, 2025
commit bcebbd4771de09cf742eeaf3c9c645d28a9c0ab2
diff --git a/src/sshConfig.test.ts b/src/sshConfig.test.ts
@@ -249,6 +249,44 @@ Host coder-vscode.dev.coder.com--*
   })
 })
 
+it("throws an error if there is a missing end block", async () => {
+  // The below config is missing an end block.
+  // This is a malformed config and should throw an error.
+  const existentSSHConfig = `Host beforeconfig
+  HostName before.config.tld
+  User before
+
+# --- START CODER VSCODE dev.coder.com ---
+Host coder-vscode.dev.coder.com--*
+  ConnectTimeout 0
+  LogLevel ERROR
+  ProxyCommand some-command-here
+  StrictHostKeyChecking no
+  UserKnownHostsFile /dev/null
+
+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("dev.coder.com", {
+      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 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", async () => {
   // The below config contains two start blocks and one end block.
   // This is a malformed config and should throw an error.

diff --git a/src/sshConfig.ts b/src/sshConfig.ts
@@ -126,27 +126,28 @@ export class SSHConfig {
     const raw = this.getRaw()
     const startBlock = this.startBlockComment(label)
     const endBlock = this.endBlockComment(label)
+
     const startBlockCount = countSubstring(startBlock, raw)
     const endBlockCount = countSubstring(endBlock, raw)
-    const startBlockIndex = raw.indexOf(startBlock)
-    const endBlockIndex = raw.indexOf(endBlock)
-    const hasBlock = startBlockIndex > -1 && endBlockIndex > -1
-
-    if (!hasBlock) {
-      return
-    }
-
     if (startBlockCount !== endBlockCount) {
       throw new SSHConfigBadFormat(
         `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} START CODER VSCODE ${label ? label + " " : ""}sections, please remove all but one.`,
       )
     }
 
+    const startBlockIndex = raw.indexOf(startBlock)
+    const endBlockIndex = raw.indexOf(endBlock)
+    const hasBlock = startBlockIndex > -1 && endBlockIndex > -1
+    if (!hasBlock) {
+      return
+    }
+
     if (startBlockIndex === -1) {
       throw new SSHConfigBadFormat("Start block not found")
     }