feat: Added NODE_PATH to support new node-pty plugins. Fixed bug with non-JS plugins being resolved.

Author: kevinwang5658

package.json

@@ -4,14 +4,15 @@
     "codify": "./bin/run.js"
   },
   "dependencies": {
+    "@homebridge/node-pty-prebuilt-multiarch": "^0.12.0-beta.5",
     "@inkjs/ui": "^2",
     "@oclif/core": "^4.0.8",
     "@oclif/plugin-help": "^6.2.4",
     "@oclif/plugin-update": "^4.6.13",
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
     "chalk": "^5.3.0",
-    "codify-schemas": "1.0.53",
+    "codify-schemas": "^1.0.56",
     "debug": "^4.3.4",
     "ink": "^5",
     "ink-form": "^2.0.1",

src/entities/project.ts

@@ -97,6 +97,7 @@ ${JSON.stringify(projectConfigs, null, 2)}`);
     const uninstallProject = new Project(
       this.projectConfig,
       this.resourceConfigs,
+      this.path,
       this.sourceMaps,
     )
 

src/plugins/plugin-process.ts

@@ -1,15 +1,25 @@
-import { IpcMessageV2Schema, IpcMessageV2, MessageCmd, SudoRequestData, SudoRequestDataSchema } from 'codify-schemas';
+import { IpcMessageV2, IpcMessageV2Schema, MessageCmd, SudoRequestData, SudoRequestDataSchema } from 'codify-schemas';
 import { ChildProcess, fork } from 'node:child_process';
 import { createRequire } from 'node:module';
 
 import { Event, ctx } from '../events/context.js';
 import { ajv } from '../utils/ajv.js';
-import { PluginMessage } from './plugin-message.js';
 import { sendIpcMessageForResult } from './message-sender.js';
+import { PluginMessage } from './plugin-message.js';
 
 export const ipcMessageValidator = ajv.compile(IpcMessageV2Schema);
 export const sudoRequestValidator = ajv.compile(SudoRequestDataSchema);
 
+const DEFAULT_NODE_MODULES_DIR = '/usr/local/lib/codify/node_modules/'
+
+// Find the location of the node_modules of the CLI itself. Plugins depend on a shared instance of node-pty to work (using NODE_PATH)
+// ex: /Users/kevinwang/Projects/codify/node_modules/@homebridge/node-pty-prebuilt-multiarch/lib/index.js
+const require = createRequire(import.meta.url);
+const nodeModulesDir = require.resolve('@homebridge/node-pty-prebuilt-multiarch')
+  ?.split('@homebridge/node-pty-prebuilt-multiarch')
+  ?.at(0)
+  ?? DEFAULT_NODE_MODULES_DIR;
+
 export function returnMessageCmd(cmd: string) {
   return `${cmd}_Response`;
 }
@@ -32,7 +42,7 @@ export class PluginProcess {
       [],
       {
         detached: secureMode,
-        env: { ...process.env, DEBUG_COLORS: '1', FORCE_COLOR: '1' },
+        env: { ...process.env, DEBUG_COLORS: '1', FORCE_COLOR: '1', NODE_PATH: nodeModulesDir },
         silent: true,
         ...(isTypescript && { execArgv: ['--import', 'tsx'] }),
       },
@@ -57,7 +67,7 @@ export class PluginProcess {
   private static handleSudoRequests(process: ChildProcess, pluginName: string) {
     // Listen for incoming sudo incoming sudo requests
     process.on('message', (message) => {
-      if (!ipcMessageValidator(message)) {
+      if (!PluginProcess.isIpcMessage(message)) {
         throw new Error(`Invalid message from plugin. ${JSON.stringify(message, null, 2)}`);
       }
 
@@ -89,7 +99,6 @@ export class PluginProcess {
   // Tsx is only installed for dev builds. Only allow typescript plugins for testing.
   private static isTsxInstalled(): boolean {
     try {
-      const require = createRequire(import.meta.url);
       require.resolve('tsx');
     } catch {
       return false;
@@ -102,5 +111,9 @@ export class PluginProcess {
     const message = PluginMessage.create(cmd, data);
     return sendIpcMessageForResult(message, this.process);
   }
+  
+  private static isIpcMessage(message: unknown): message is IpcMessageV2 {
+    return ipcMessageValidator(message);
+  } 
 }
 

src/plugins/resolver.ts

@@ -45,7 +45,9 @@ export class PluginResolver {
       return [];
     }
 
-    return files.filter((f) => !exclude.includes(getPluginName(f)))
+    return files
+      .filter((f) => f.endsWith('.js'))
+      .filter((f) => !exclude.includes(getPluginName(f)))
       .map((f) => {
         const name = getPluginName(f);
         const p = path.join(PLUGIN_CACHE_DIR, f);

tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "module": "NodeNext",
-    "moduleResolution": "Node16",
+    "moduleResolution": "NodeNext",
     "esModuleInterop": true,
     "resolveJsonModule": true,
     "jsx": "react",