feat: Added new spawn code using node-pty. Root and stdin are both supported now

Author: kevinwang5658

package-lock.json

@@ -15,7 +15,7 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
     "chalk": "^5.3.0",
-    "codify-schemas": "^1.0.83",
+    "codify-schemas": "1.0.86-beta5",
     "cors": "^2.8.5",
     "debug": "^4.3.4",
     "detect-indent": "^7.0.1",

package.json

@@ -4,7 +4,7 @@ import fs from 'node:fs/promises';
 
 import { BaseCommand } from '../common/base-command.js';
 import { ImportOrchestrator } from '../orchestrators/import.js';
-import { ShellUtils } from '../utils/shell.js';
+import { Shell, ShellUtils } from '../utils/shell.js';
 
 export default class Import extends BaseCommand {
   static strict = false;
@@ -76,7 +76,7 @@ For more information, visit: https://docs.codifycli.com/commands/import`
 
   private async cleanupZshStarExpansion(args: string[]): Promise<string[]> {
     const combinedArgs = args.join(' ');
-    const zshStarExpansion = (await ShellUtils.isZshShell())
+    const zshStarExpansion = (ShellUtils.getShell() === Shell.ZSH)
       ? (await fs.readdir(process.cwd())).filter((name) => !name.startsWith('.')).join(' ')
       : ''
 

src/commands/import.ts

@@ -1,10 +1,7 @@
-import chalk from 'chalk';
 import fs from 'node:fs/promises';
-import path from 'node:path';
 
 import { BaseCommand } from '../common/base-command.js';
-import { ImportOrchestrator } from '../orchestrators/import.js';
-import { ShellUtils } from '../utils/shell.js';
+import { Shell, ShellUtils } from '../utils/shell.js';
 import { RefreshOrchestrator } from '../orchestrators/refresh.js';
 
 export default class Refresh extends BaseCommand {
@@ -53,7 +50,7 @@ For more information, visit: https://docs.codifycli.com/commands/refresh`
 
   private async cleanupZshStarExpansion(args: string[]): Promise<string[]> {
     const combinedArgs = args.join(' ');
-    const zshStarExpansion = (await ShellUtils.isZshShell())
+    const zshStarExpansion = (ShellUtils.getShell() === Shell.ZSH)
       ? (await fs.readdir(process.cwd())).filter((name) => !name.startsWith('.')).join(' ')
       : ''
 

src/commands/refresh.ts

@@ -1,14 +1,14 @@
 import { Command, Flags } from '@oclif/core';
 import { OutputFlags } from '@oclif/core/interfaces';
 import chalk from 'chalk';
-import { PressKeyToContinueRequestData, SudoRequestData } from 'codify-schemas';
+import { CommandRequestData, PressKeyToContinueRequestData } from 'codify-schemas';
 import createDebug from 'debug';
 
 import { LoginHelper } from '../connect/login-helper.js';
 import { Event, ctx } from '../events/context.js';
 import { LoginOrchestrator } from '../orchestrators/login.js';
 import { Reporter, ReporterFactory, ReporterType } from '../ui/reporters/reporter.js';
-import { SudoUtils } from '../utils/sudo.js';
+import { spawnSafe } from '../utils/spawn.js';
 import { prettyPrintError } from './errors.js';
 
 export abstract class BaseCommand extends Command {
@@ -48,16 +48,37 @@ export abstract class BaseCommand extends Command {
       console.log(chalk.blue('Running Codify in secure mode. Sudo will be prompted every time'));
     }
 
-    ctx.on(Event.SUDO_REQUEST, async (pluginName: string, data: SudoRequestData) => {
+    ctx.on(Event.COMMAND_REQUEST, async (pluginName: string, data: CommandRequestData) => {
       try {
-        const password = (flags.sudoPassword) ?? (await this.reporter.promptSudo(pluginName, data, flags.secure));
+        const password = data.options.requiresRoot
+          ? (flags.sudoPassword) ?? (await this.reporter.promptSudo(pluginName, data, flags.secure))
+          : undefined;
 
-        const result = await SudoUtils.runCommand(data.command, data.options, flags.secure, pluginName, password)
-        ctx.sudoRequestGranted(pluginName, result);
+        // We print that we used sudo everytime even if the user provides it in the beginning
+        if (flags.sudoPassword && data.options.requiresRoot) {
+          console.log(chalk.blue(`Plugin: "${pluginName}" requires root access to run command: "${data.command}"`));
+        }
+
+        if (data.options.stdin) {
+          await this.reporter.hide();
+          console.log(chalk.blue(`Plugin "${pluginName}" is requesting stdin`));
+
+          // Raw mode is needed by stdin applications to function properly
+          process.stdin.setRawMode(true);
+        }
+
+        const result = await spawnSafe(data.command, pluginName, data.options, password)
+        ctx.commandRequestCompleted(pluginName, result);
 
         // This listener is outside of the base-command callstack. We have to manually catch the error.
       } catch (error) {
         this.catch(error as Error);
+      } finally {
+        // Always disable raw mode after
+        if (data.options.stdin) {
+          process.stdin.setRawMode(false);
+          await this.reporter.displayProgress();
+        }
       }
     });
 

src/common/base-command.ts

@@ -1,5 +1,4 @@
-import type { SudoRequestData, SudoRequestResponseData } from 'codify-schemas';
-
+import { CommandRequestData, CommandRequestResponseData } from 'codify-schemas';
 import { EventEmitter } from 'node:events';
 
 export enum Event {
@@ -13,8 +12,8 @@ export enum Event {
   STDOUT = 'stdout',
   SUB_PROCESS_FINISH = 'sub_process_finish',
   SUB_PROCESS_START = 'sub_process_start',
-  SUDO_REQUEST = 'sudo_request',
-  SUDO_REQUEST_GRANTED = 'sudo_request_granted',
+  COMMAND_REQUEST = 'command_request',
+  COMMAND_REQUEST_GRANTED = 'command_request_granted',
   PRESS_KEY_TO_CONTINUE_REQUEST = 'press_key_to_continue_request',
   PRESS_KEY_TO_CONTINUE_COMPLETED = 'press_key_to_continue_completed',
   CODIFY_LOGIN_CREDENTIALS_REQUEST = 'codify_login_credentials_request',
@@ -103,12 +102,12 @@ export const ctx = new class {
     this.emitter.emit(Event.SUB_PROCESS_FINISH, name, additionalName);
   }
 
-  sudoRequested(pluginName: string, data: SudoRequestData) {
-    this.emitter.emit(Event.SUDO_REQUEST, pluginName, data);
+  commandRequested(pluginName: string, data: CommandRequestData) {
+    this.emitter.emit(Event.COMMAND_REQUEST, pluginName, data);
   }
 
-  sudoRequestGranted(pluginName: string, data: SudoRequestResponseData) {
-    this.emitter.emit(Event.SUDO_REQUEST_GRANTED, pluginName, data);
+  commandRequestCompleted(pluginName: string, data: CommandRequestResponseData) {
+    this.emitter.emit(Event.COMMAND_REQUEST_GRANTED, pluginName, data);
   }
 
   pressToContinueRequested(pluginName: string, data: any) {

src/events/context.ts

@@ -29,7 +29,7 @@ export class ConnectOrchestrator {
   }
 
 
-  private static tokenGenerate(bytes = 4): string {
+  private static tokenGenerate(bytes = 16): string {
     return Buffer.from(randomBytes(bytes)).toString('hex')
   }
 }

src/orchestrators/connect.ts

@@ -1,11 +1,12 @@
-import { 
+import {
+  CommandRequestData,
+  CommandRequestDataSchema,
+  CommandRequestResponseData,
   IpcMessageV2,
   IpcMessageV2Schema,
   MessageCmd,
   PressKeyToContinueRequestData,
   PressKeyToContinueRequestDataSchema,
-  SudoRequestData,
-  SudoRequestDataSchema
 } from 'codify-schemas';
 import { ChildProcess, fork } from 'node:child_process';
 import { createRequire } from 'node:module';
@@ -16,7 +17,7 @@ import { sendIpcMessageForResult } from './message-sender.js';
 import { PluginMessage } from './plugin-message.js';
 
 export const ipcMessageValidator = ajv.compile(IpcMessageV2Schema);
-export const sudoRequestValidator = ajv.compile(SudoRequestDataSchema);
+export const commandRequestValidator = ajv.compile(CommandRequestDataSchema);
 export const pressKeyToContinueRequestValidator = ajv.compile(PressKeyToContinueRequestDataSchema);
 
 const DEFAULT_NODE_MODULES_DIR = '/usr/local/lib/codify/node_modules/'
@@ -57,6 +58,7 @@ export class PluginProcess {
       },
     );
 
+    // Note: stdin is not hooked up on purpose for security purposes. Interactive commands + sudo will have to run through the parent process.
     _process.stdout!.on('data', (message) => ctx.pluginStdout(name, message.toString('utf8')));
     _process.stderr!.on('data', (message) => ctx.pluginStderr(name, message.toString('utf8')));
     _process.on('exit', (code) => {
@@ -80,24 +82,24 @@ export class PluginProcess {
         throw new Error(`Invalid message from plugin. ${JSON.stringify(message, null, 2)}`);
       }
 
-      if (message.cmd === MessageCmd.SUDO_REQUEST) {
+      if (message.cmd === MessageCmd.COMMAND_REQUEST) {
         const { data, requestId } = message;
-        if (!sudoRequestValidator(data)) {
-          throw new Error(`Invalid sudo request from plugin ${pluginName}. ${JSON.stringify(sudoRequestValidator.errors, null, 2)}`);
+        if (!commandRequestValidator(data)) {
+          throw new Error(`Invalid command request from plugin ${pluginName}. ${JSON.stringify(commandRequestValidator.errors, null, 2)}`);
         }
 
-        // Send out sudo granted events
-        ctx.once(Event.SUDO_REQUEST_GRANTED, (_pluginName, data) => {
+        // Send out command completed
+        ctx.once(Event.COMMAND_REQUEST_GRANTED, (_pluginName, data) => {
           if (_pluginName === pluginName) {
             process.send({
-              cmd: returnMessageCmd(MessageCmd.SUDO_REQUEST),
+              cmd: returnMessageCmd(MessageCmd.COMMAND_REQUEST),
               requestId,
               data
             })
           }
         })
 
-        return ctx.sudoRequested(pluginName, data as unknown as SudoRequestData);
+        return ctx.commandRequested(pluginName, data as unknown as CommandRequestData);
       }
 
       if (message.cmd === MessageCmd.PRESS_KEY_TO_CONTINUE_REQUEST) {
@@ -106,7 +108,6 @@ export class PluginProcess {
           throw new Error(`Invalid press key to continue request from plugin ${pluginName}. ${JSON.stringify(pressKeyToContinueRequestValidator.errors, null, 2)}`);
         }
 
-        // Send out sudo granted events
         ctx.once(Event.PRESS_KEY_TO_CONTINUE_COMPLETED, (_pluginName) => {
           if (_pluginName === pluginName) {
             process.send({

src/plugins/plugin-process.ts

@@ -3,14 +3,48 @@ import cp from 'node:child_process';
 
 const exec = util.promisify(cp.exec);
 
-export class ShellUtils {
-  static async isZshShell(): Promise<boolean> {
-    try {
-      await exec('echo $ZSH_VERSION');
-      return true;
-    } catch {
-      return false;
+export enum Shell {
+  ZSH = 'zsh',
+  BASH = 'bash',
+  SH = 'sh',
+  KSH = 'ksh',
+  CSH = 'csh',
+  FISH = 'fish',
+}
+
+
+export const ShellUtils = {
+  getShell(): Shell | undefined {
+    const shell = process.env.SHELL || '';
+
+    if (shell.endsWith('bash')) {
+      return Shell.BASH
+    }
+
+    if (shell.endsWith('zsh')) {
+      return Shell.ZSH
+    }
+
+    if (shell.endsWith('sh')) {
+      return Shell.SH
     }
-  }
 
+    if (shell.endsWith('csh')) {
+      return Shell.CSH
+    }
+
+    if (shell.endsWith('ksh')) {
+      return Shell.KSH
+    }
+
+    if (shell.endsWith('fish')) {
+      return Shell.FISH
+    }
+
+    return undefined;
+  },
+
+  getDefaultShell(): string {
+    return process.env.SHELL!;
+  }
 }