Clarify SSH IPC error presentation

Julius Marminge committed 4 months ago

Commit 477a96f1 parent 19550842 files · +20 −5Browse files

Unified · Split

2 files

 } from "@t3tools/contracts";
 import {
   SshCommandSpawnError,
+  SshCommandTimeoutError,
   SshHttpBridgeError,
   SshPasswordPromptError,
 } from "@t3tools/ssh/errors";
   DesktopSshEnvironmentRequestError,
   ensureSshEnvironment,
   fetchSshEnvironmentDescriptor,
-  toDesktopSshOperationPresentationError,
+  toDesktopSshIpcPresentationError,
 } from "./sshEnvironment.ts";
 import * as DesktopSshEnvironment from "../../ssh/DesktopSshEnvironment.ts";
 import * as DesktopSshPasswordPrompts from "../../ssh/DesktopSshPasswordPrompts.ts";
       cause,
     });
-    const presentation = toDesktopSshOperationPresentationError(structured);
+    const presentation = toDesktopSshIpcPresentationError(structured);
     assert.equal(structured.message, "Failed to spawn SSH command for devbox.");
     assert.equal(presentation.message, cause.message);
     assert.strictEqual(presentation.cause, structured);
   });
+  it("passes structural SSH errors without process causes through the IPC boundary", () => {
+    const structured = new SshCommandTimeoutError({
+      command: "ssh",
+      argumentCount: 0,
+      target: "devbox",
+      timeoutMs: 30_000,
+    });
+    assert.strictEqual(toDesktopSshIpcPresentationError(structured), structured);
+  });
   it.effect("fetches and decodes the remote environment descriptor", () => {
     const requestUrls: string[] = [];
     const layer = makeHttpClientLayer((request) =>

   ]),
 );
-export function toDesktopSshOperationPresentationError(
+// Electron only forwards the message from a rejected ipcRenderer.invoke promise. Keep the typed,
+// structural SSH error intact as the cause for main-process diagnostics while preserving the
+// actionable process message that the renderer historically presented to the user.
+export function toDesktopSshIpcPresentationError(
   error: DesktopSshEnvironment.DesktopSshEnvironmentOperationError,
 ): DesktopSshEnvironment.DesktopSshEnvironmentOperationError | Error {
   if (isSshCausePresentationError(error) && error.cause instanceof Error) {
               )
             : Effect.fail(error),
       }),
-      Effect.mapError(toDesktopSshOperationPresentationError),
+      Effect.mapError(toDesktopSshIpcPresentationError),
     );
   }),
 });
     const sshEnvironment = yield* DesktopSshEnvironment.DesktopSshEnvironment;
     yield* sshEnvironment
       .disconnectEnvironment(target)
-      .pipe(Effect.mapError(toDesktopSshOperationPresentationError));
+      .pipe(Effect.mapError(toDesktopSshIpcPresentationError));
   }),
 });