feat: Added proper spawn. Fixed missing initialize calls for subsequent plugins. Updated sudo to command.

Author: kevinwang5658

src/plugin-process.ts

@@ -1,28 +1,34 @@
 import Ajv from 'ajv';
 import {
-  ApplyRequestData, ImportRequestData, ImportResponseData,
+  ApplyRequestData,
+  CommandRequestData,
+  CommandRequestDataSchema,
+  ImportRequestData,
+  ImportResponseData,
   InitializeResponseData,
   IpcMessageSchema,
   IpcMessageV2,
-  MessageCmd, PlanRequestData, PlanResponseData,
-  SpawnStatus,
-  SudoRequestData,
-  SudoRequestDataSchema, ValidateRequestData, ValidateResponseData
+  MessageCmd,
+  PlanRequestData,
+  PlanResponseData,
+  ValidateRequestData,
+  ValidateResponseData
 } from 'codify-schemas';
 import { nanoid } from 'nanoid';
-import { ChildProcess, SpawnOptions, fork, spawn } from 'node:child_process';
+import { ChildProcess, fork } from 'node:child_process';
+import fs from 'node:fs/promises';
+import * as os from 'node:os';
 import path from 'node:path';
 
+import { spawnSafe } from './spawn.js';
 import { CodifyTestUtils } from './test-utils.js';
-import fs from 'node:fs/promises';
-import * as os from 'node:os';
 
 const ajv = new Ajv.default({
   strict: true
 });
 
 const ipcMessageValidator = ajv.compile(IpcMessageSchema);
-const sudoRequestValidator = ajv.compile(SudoRequestDataSchema);
+const commandRequestValidator = ajv.compile(CommandRequestDataSchema);
 
 export class PluginProcess {
   childProcess: ChildProcess
@@ -108,26 +114,26 @@ 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. ${JSON.stringify(sudoRequestValidator.errors, null, 2)}`);
+        if (!commandRequestValidator(data)) {
+          throw new Error(`Invalid sudo request from plugin. ${JSON.stringify(commandRequestValidator.errors, null, 2)}`);
         }
 
-        const { command, options } = data as unknown as SudoRequestData;
-        const result = await sudoSpawn(command, options);
+        const { command, options } = data as unknown as CommandRequestData;
+        const result = await spawnSafe(command, options);
 
         cp.send(<IpcMessageV2>{
-          cmd: MessageCmd.SUDO_REQUEST + '_Response',
+          cmd: MessageCmd.COMMAND_REQUEST + '_Response',
           data: result,
           requestId,
         })
       }
 
       if (message.cmd === MessageCmd.PRESS_KEY_TO_CONTINUE_REQUEST) {
         const { data, requestId } = message;
-        if (!sudoRequestValidator(data)) {
-          throw new Error(`Invalid sudo request from plugin. ${JSON.stringify(sudoRequestValidator.errors, null, 2)}`);
+        if (!commandRequestValidator(data)) {
+          throw new Error(`Invalid sudo request from plugin. ${JSON.stringify(commandRequestValidator.errors, null, 2)}`);
         }
 
         cp.send(<IpcMessageV2>{
@@ -155,59 +161,3 @@ export class PluginProcess {
   }
 
 }
-
-type CodifySpawnOptions = {
-  cwd?: string;
-  throws?: boolean,
-} & Omit<SpawnOptions, 'detached' | 'shell' | 'stdio'>
-
-/**
- *
- * @param cmd Command to run. Ex: `rm -rf`
- * @param opts Options for spawn
- *
- * @see promiseSpawn
- * @see spawn
- *
- * @returns SpawnResult { status: SUCCESS | ERROR; data: string }
- */
-async function sudoSpawn(
-  cmd: string,
-  opts: CodifySpawnOptions,
-): Promise<{ data: string, status: SpawnStatus }> {
-  return new Promise((resolve) => {
-    const output: string[] = [];
-
-    const _cmd = `sudo ${cmd}`;
-
-    // Source start up shells to emulate a users environment vs. a non-interactive non-login shell script
-    // Ignore all stdin
-    const _process = spawn(`source ~/.zshrc; ${_cmd}`, [], {
-      ...opts,
-      shell: 'zsh',
-      stdio: ['ignore', 'pipe', 'pipe'],
-    });
-
-    const { stderr, stdout } = _process
-    stdout.setEncoding('utf8');
-    stderr.setEncoding('utf8');
-
-    stdout.on('data', (data) => {
-      output.push(data.toString());
-    })
-
-    stderr.on('data', (data) => {
-      output.push(data.toString());
-    })
-
-    stdout.pipe(process.stdout);
-    stderr.pipe(process.stderr);
-
-    _process.on('close', (code) => {
-      resolve({
-        data: output.join(''),
-        status: code === 0 ? SpawnStatus.SUCCESS : SpawnStatus.ERROR,
-      })
-    })
-  })
-}

src/plugin-tester.ts

@@ -91,6 +91,7 @@ export class PluginTester {
     if (!options?.skipImport) {
       const importPlugin = new PluginProcess(pluginPath);
       try {
+        await importPlugin.initialize();
         console.info(chalk.cyan('Testing import...'))
 
         const importResults = [];
@@ -113,6 +114,7 @@ export class PluginTester {
       const modifyPlugin = new PluginProcess(pluginPath);
 
       try {
+        await modifyPlugin.initialize();
         console.info(chalk.cyan('Testing modify...'))
 
         const modifyPlans = [];
@@ -164,6 +166,7 @@ ${JSON.stringify(modifyPlans, null, 2)}`)
     const destroyPlugin = new PluginProcess(pluginPath);
 
     try {
+      await destroyPlugin.initialize();
       console.info(chalk.cyan('Testing destroy...'))
 
       const plans = [];

src/shell.ts

@@ -0,0 +1,45 @@
+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!;
+  }
+}

src/spawn.ts

@@ -0,0 +1,91 @@
+import * as pty from '@homebridge/node-pty-prebuilt-multiarch';
+import { SpawnStatus } from 'codify-schemas';
+import stripAnsi from 'strip-ansi';
+
+import { Shell, ShellUtils } from './shell.js';
+
+export interface SpawnResult {
+  status: SpawnStatus;
+  exitCode: number;
+  data: string;
+}
+
+export interface SpawnOptions {
+  cwd?: string;
+  env?: Record<string, unknown>,
+  interactive?: boolean,
+  requiresRoot?: boolean,
+  stdin?: boolean,
+}
+
+export function spawnSafe(cmd: string, options?: SpawnOptions): Promise<SpawnResult> {
+  if (cmd.toLowerCase().includes('sudo')) {
+    throw new Error('Command must not include sudo')
+  }
+
+  process.stdout.write(`Running command: ${options?.requiresRoot ? 'sudo' : ''} ${cmd}` + (options?.cwd ? `(${options?.cwd})` : ''))
+
+  return new Promise((resolve) => {
+    const output: string[] = [];
+    const historyIgnore = ShellUtils.getShell() === Shell.ZSH ? { HISTORY_IGNORE: '*' } : { HISTIGNORE: '*' };
+
+    // If TERM_PROGRAM=Apple_Terminal is set then ANSI escape characters may be included
+    // in the response.
+    const env = {
+      ...process.env, ...options?.env,
+      TERM_PROGRAM: 'codify',
+      COMMAND_MODE: 'unix2003',
+      COLORTERM: 'truecolor',
+      ...historyIgnore
+    }
+
+    // Initial terminal dimensions
+    const initialCols = process.stdout.columns ?? 80;
+    const initialRows = process.stdout.rows ?? 24;
+
+    const command = options?.requiresRoot ? `sudo ${cmd}` : cmd;
+    const args = options?.interactive ? ['-i', '-c', command] : ['-c', command]
+
+    // Run the command in a pty for interactivity
+    const mPty = pty.spawn(ShellUtils.getDefaultShell(), args, {
+      ...options,
+      cols: initialCols,
+      rows: initialRows,
+      env
+    });
+
+    mPty.onData((data) => {
+      process.stdout.write(data);
+      output.push(data.toString());
+    })
+
+    const resizeListener = () => {
+      const { columns, rows } = process.stdout;
+      mPty.resize(columns, rows);
+    }
+
+    const stdinListener = (data: any) => {
+      // console.log('stdinListener', data);
+      mPty.write(data.toString());
+    }
+
+    // Listen to resize events for the terminal window;
+    process.stdout.on('resize', resizeListener);
+    if (options?.stdin) {
+      process.stdin.on('data', stdinListener)
+    }
+
+    mPty.onExit((result) => {
+      process.stdout.off('resize', resizeListener);
+      if (options?.stdin) {
+        process.stdin.off('data', stdinListener);
+      }
+
+      resolve({
+        status: result.exitCode === 0 ? SpawnStatus.SUCCESS : SpawnStatus.ERROR,
+        exitCode: result.exitCode,
+        data: stripAnsi(output.join('\n').trim()),
+      })
+    })
+  })
+}