Add commands for linking tsh on macOS

packages/teleterm/src/mainProcess/fixtures/mocks.ts

@@ -5,55 +5,66 @@ import { createMockFileStorage } from 'teleterm/services/fileStorage/fixtures/mo
 // Importing electron breaks the fixtures if that's done from within storybook.
 import { createConfigService } from 'teleterm/services/config/configService';
 
-const platform = 'darwin';
-
 export class MockMainProcessClient implements MainProcessClient {
+  configService: ReturnType<typeof createConfigService>;
+
+  constructor(private runtimeSettings: Partial<RuntimeSettings> = {}) {
+    this.configService = createConfigService(
+      createMockFileStorage(),
+      this.getRuntimeSettings().platform
+    );
+  }
   getRuntimeSettings(): RuntimeSettings {
-    return {
-      platform,
-      dev: true,
-      userDataDir: '',
-      binDir: '',
-      certsDir: '',
-      kubeConfigsDir: '',
-      defaultShell: '',
-      tshd: {
-        insecure: true,
-        requestedNetworkAddress: '',
-        binaryPath: '',
-        homeDir: '',
-        flags: [],
-      },
-      sharedProcess: {
-        requestedNetworkAddress: '',
-      },
-      tshdEvents: {
-        requestedNetworkAddress: '',
-      },
-      installationId: '123e4567-e89b-12d3-a456-426614174000',
-    };
+    return { ...defaultRuntimeSettings, ...this.runtimeSettings };
   }
 
   getResolvedChildProcessAddresses = () =>
     Promise.resolve({ tsh: '', shared: '' });
 
   openTerminalContextMenu() {}
-
   openClusterContextMenu() {}
-
   openTabContextMenu() {}
 
   showFileSaveDialog() {
     return Promise.resolve({ canceled: false, filePath: '' });
   }
 
-  configService = createConfigService(createMockFileStorage(), platform);
-
   fileStorage = createMockFileStorage();
 
   removeKubeConfig(): Promise<void> {
     return Promise.resolve(undefined);
   }
 
   forceFocusWindow() {}
+
+  async symlinkTshMacOs() {
+    return true;
+  }
+  async removeTshSymlinkMacOs() {
+    return true;
+  }
 }
+
+const defaultRuntimeSettings = {
+  platform: 'darwin' as const,
+  dev: true,
+  userDataDir: '',
+  binDir: '',
+  certsDir: '',
+  kubeConfigsDir: '',
+  defaultShell: '',
+  tshd: {
+    insecure: true,
+    requestedNetworkAddress: '',
+    binaryPath: '',
+    homeDir: '',
+    flags: [],
+  },
+  sharedProcess: {
+    requestedNetworkAddress: '',
+  },
+  tshdEvents: {
+    requestedNetworkAddress: '',
+  },
+  installationId: '123e4567-e89b-12d3-a456-426614174000',
+};

packages/teleterm/src/mainProcess/mainProcess.ts

@@ -1,8 +1,8 @@
-import { ChildProcess, fork, spawn } from 'child_process';
+import { ChildProcess, fork, spawn, exec } from 'child_process';
 import path from 'path';
-
 import fs from 'fs/promises';
 
+import { promisify } from 'util';
 import {
   app,
   dialog,
@@ -203,6 +203,52 @@ export default class MainProcess {
       this.windowsManager.forceFocusWindow();
     });
 
+    // Used in the `tsh install` command on macOS to make the bundled tsh available in PATH.
+    // Returns true if tsh got successfully installed, false if the user closed the osascript
+    // prompt. Throws an error when osascript fails.
+    ipcMain.handle('main-process-symlink-tsh-macos', async () => {
+      const source = this.settings.tshd.binaryPath;
+      const target = '/usr/local/bin/tsh';
+      const prompt =
+        'Teleport Connect wants to create a symlink for tsh in /usr/local/bin.';
+      const command = `osascript -e "do shell script \\"mkdir -p /usr/local/bin && ln -sf '${source}' '${target}'\\" with prompt \\"${prompt}\\" with administrator privileges"`;
+
+      try {
+        await promisify(exec)(command);
+        this.logger.info(`Created the symlink to ${source} under ${target}`);
+        return true;
+      } catch (error) {
+        // Ignore the error if the user canceled the prompt.
+        // https://developer.apple.com/library/archive/documentation/AppleScript/Conceptual/AppleScriptLangGuide/reference/ASLR_error_codes.html#//apple_ref/doc/uid/TP40000983-CH220-SW2
+        if (error instanceof Error && error.message.includes('-128')) {
+          return false;
+        }
+        this.logger.error(error);
+        throw error;
+      }
+    });
+
+    ipcMain.handle('main-process-remove-tsh-symlink-macos', async () => {
+      const target = '/usr/local/bin/tsh';
+      const prompt =
+        'Teleport Connect wants to remove a symlink for tsh from /usr/local/bin.';
+      const command = `osascript -e "do shell script \\"rm '${target}'\\" with prompt \\"${prompt}\\" with administrator privileges"`;
+
+      try {
+        await promisify(exec)(command);
+        this.logger.info(`Removed the symlink under ${target}`);
+        return true;
+      } catch (error) {
+        // Ignore the error if the user canceled the prompt.
+        // https://developer.apple.com/library/archive/documentation/AppleScript/Conceptual/AppleScriptLangGuide/reference/ASLR_error_codes.html#//apple_ref/doc/uid/TP40000983-CH220-SW2
+        if (error instanceof Error && error.message.includes('-128')) {
+          return false;
+        }
+        this.logger.error(error);
+        throw error;
+      }
+    });
+
     subscribeToTerminalContextMenuEvent();
     subscribeToTabContextMenuEvent();
     subscribeToConfigServiceEvents(this.configService);

packages/teleterm/src/mainProcess/mainProcessClient.ts

@@ -31,5 +31,11 @@ export default function createMainProcessClient(): MainProcessClient {
     forceFocusWindow() {
       return ipcRenderer.invoke('main-process-force-focus-window');
     },
+    symlinkTshMacOs() {
+      return ipcRenderer.invoke('main-process-symlink-tsh-macos');
+    },
+    removeTshSymlinkMacOs() {
+      return ipcRenderer.invoke('main-process-remove-tsh-symlink-macos');
+    },
   };
 }

packages/teleterm/src/mainProcess/types.ts

@@ -43,6 +43,16 @@ export type MainProcessClient = {
     isDirectory?: boolean;
   }): Promise<void>;
   forceFocusWindow(): void;
+  /**
+   * The promise returns true if tsh got successfully symlinked, false if the user closed the
+   * osascript prompt. The promise gets rejected if osascript encountered an error.
+   */
+  symlinkTshMacOs(): Promise<boolean>;
+  /**
+   * The promise returns true if the tsh symlink got removed, false if the user closed the osascript
+   * prompt. The promise gets rejected if osascript encountered an error.
+   */
+  removeTshSymlinkMacOs(): Promise<boolean>;
 };
 
 export type ChildProcessAddresses = {