@codesys/mcp-toolkit 1.0.7 → 1.0.8

package/dist/codesys_interop.js

@@ -43,7 +43,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeCodesysScript = executeCodesysScript;
-const child_process_1 = require("child_process");
+const child_process_1 = require("child_process"); // Use spawn directly
 const promises_1 = require("fs/promises");
 const path = __importStar(require("path"));
 const os = __importStar(require("os"));
@@ -52,6 +52,7 @@ const SCRIPT_SUCCESS_MARKER = 'SCRIPT_SUCCESS';
 const SCRIPT_ERROR_MARKER = 'SCRIPT_ERROR';
 /**
  * Executes a CODESYS Python script using the command line interface.
+ * Uses spawn for better handling of paths with spaces.
  *
  * @param scriptContent The Python script code to execute.
  * @param codesysExePath The full path to the CODESYS.exe executable.
@@ -69,60 +70,95 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
         }
         // Create a temporary file for the script
         const tempDir = os.tmpdir();
-        const tempFileName = `codesys_script_${Date.now()}_${Math.random().toString(36).substring(7)}.py`;
+        // Ensure temp file name is safe for command line (though spawn handles args better)
+        const tempFileName = `codesys_script_${Date.now()}_${Math.random().toString(36).substring(2, 9)}.py`;
         const tempFilePath = path.join(tempDir, tempFileName);
         let output = '';
         let success = false;
+        let exitCode = null;
         try {
             // Normalize line endings to LF (\n)
             const normalizedScriptContent = scriptContent.replace(/\r\n/g, '\n');
             // Write the script content to the temporary file using latin1 encoding
-            yield (0, promises_1.writeFile)(tempFilePath, normalizedScriptContent, 'latin1'); // Explicitly use latin1
-            process.stderr.write(`Temporary script written to: ${tempFilePath} with latin1 encoding and LF line endings\n`); // Use process.stderr
-            // Add --additionalfolder argument
-            const additionalFolderPath = "C:\\Program Files\\CODESYS 3.5.21.0\\CODESYS\\AdditionalFolders\\Default"; // Assuming Default instance
-            // Fix: Use shell:true but ensure proper quoting for paths with spaces
-            const commandWithArgs = `"${codesysExePath}" --profile="${codesysProfileName}" --noUI --runscript="${tempFilePath}"`;
-            process.stderr.write(`Executing: ${commandWithArgs}\n`); // Log the command
-            // CONFIRMED WORKING APPROACH: Use simple exec() with complete quoting
-            // This approach is tested and works with the CODESYS executable
-            const execResult = yield new Promise((resolve) => {
-                process.stderr.write(`EXECUTING COMMAND: ${commandWithArgs}\n`);
-                // Execute command using exec which handles Windows command paths better
-                const childProcess = (0, child_process_1.exec)(commandWithArgs, { timeout: 30000 }, (error, stdout, stderr) => {
+            yield (0, promises_1.writeFile)(tempFilePath, normalizedScriptContent, 'latin1');
+            process.stderr.write(`Temporary script written to: ${tempFilePath} with latin1 encoding and LF line endings\n`);
+            // --- Use spawn ---
+            const command = codesysExePath; // The executable itself
+            const args = [
+                `--profile=${codesysProfileName}`, // Format expected by CODESYS.exe
+                '--noUI',
+                `--runscript=${tempFilePath}` // Format expected by CODESYS.exe
+                // If CODESYS requires quotes *around* the profile/script path *value*, adjust like:
+                // `--profile="${codesysProfileName}"`,
+                // `--runscript="${tempFilePath}"`,
+                // But usually, spawn handles the argument separation correctly without needing inner quotes unless the *program itself* requires them.
+                // Test without inner quotes first.
+            ];
+            process.stderr.write(`Spawning: ${command} with args: ${JSON.stringify(args)}\n`);
+            const spawnResult = yield new Promise((resolve, reject) => {
+                let stdoutData = '';
+                let stderrData = '';
+                // Spawn the process. Detached:false is default. Timeout via AbortController recommended for spawn.
+                const controller = new AbortController();
+                const timeoutSignal = controller.signal;
+                const timeoutDuration = 30000; // 30 seconds
+                const childProcess = (0, child_process_1.spawn)(command, args, {
+                    windowsHide: true, // Hides the console window on Windows
+                    signal: timeoutSignal // Use AbortSignal for timeout
+                });
+                const timeoutId = setTimeout(() => {
+                    process.stderr.write(`TIMEOUT: CODESYS process timed out after ${timeoutDuration / 1000} seconds\n`);
+                    controller.abort(); // Abort the process via the signal
+                }, timeoutDuration);
+                childProcess.stdout.on('data', (data) => {
+                    const chunk = data.toString();
+                    stdoutData += chunk;
+                    process.stderr.write(`CODESYS stdout chunk: ${chunk.length > 100 ? chunk.substring(0, 100) + '...' : chunk}\n`);
+                });
+                childProcess.stderr.on('data', (data) => {
+                    const chunk = data.toString();
+                    stderrData += chunk;
+                    process.stderr.write(`CODESYS stderr chunk: ${chunk}\n`); // Log stderr more verbosely
+                });
+                childProcess.on('error', (error) => {
                     var _a;
-                    let combinedOutput = "";
-                    if (stdout)
-                        combinedOutput += stdout;
-                    if (stderr)
-                        combinedOutput += stderr;
-                    // Log results for debugging
-                    if (stdout)
-                        process.stderr.write(`CODESYS stdout: ${stdout.length > 100 ? stdout.substring(0, 100) + '...' : stdout}\n`);
-                    if (stderr)
-                        process.stderr.write(`CODESYS stderr: ${stderr}\n`);
-                    if (error) {
-                        process.stderr.write(`CODESYS exec error: ${error.message}\n`);
-                        resolve({ code: (_a = error.code) !== null && _a !== void 0 ? _a : 1, output: combinedOutput });
-                    }
-                    else {
-                        resolve({ code: 0, output: combinedOutput });
-                    }
+                    clearTimeout(timeoutId); // Clear timeout on explicit error
+                    // This usually means the process couldn't be spawned (e.g., EACCES, ENOENT)
+                    process.stderr.write(`CODESYS spawn error: ${error.message}\n`);
+                    // Don't reject here, resolve with error info like exec did
+                    resolve({ code: (_a = error.errno) !== null && _a !== void 0 ? _a : 1, output: stdoutData + stderrData + `\nSpawn Error: ${error.message}` });
                 });
-                // Safety cleanup for timeout case
-                childProcess.on('timeout', () => {
-                    process.stderr.write(`TIMEOUT: CODESYS process timed out after 30 seconds\n`);
-                    childProcess.kill();
-                    resolve({ code: 0, output: output + "\nTIMEOUT: CODESYS process timed out" });
+                childProcess.on('close', (code) => {
+                    clearTimeout(timeoutId); // Clear timeout on successful close
+                    process.stderr.write(`CODESYS process closed with code: ${code}\n`);
+                    const combinedOutput = stdoutData + stderrData;
+                    resolve({ code: code, output: combinedOutput });
                 });
+                // Handle the timeout signal specifically
+                timeoutSignal.addEventListener('abort', () => {
+                    process.stderr.write('Abort signal received, killing process if still running.\n');
+                    if (!childProcess.killed) {
+                        childProcess.kill('SIGTERM'); // Attempt graceful kill first
+                        // Optionally force kill after a short delay if SIGTERM doesn't work
+                        setTimeout(() => {
+                            if (!childProcess.killed) {
+                                process.stderr.write('SIGTERM ineffective, sending SIGKILL.\n');
+                                childProcess.kill('SIGKILL');
+                            }
+                        }, 2000); // 2 second grace period
+                    }
+                    // Resolve with timeout information. The 'close' event might still fire later with a specific code.
+                    // We already logged the timeout, let the 'close' handler report the final code.
+                    // If 'close' doesn't fire after kill, it might indicate a deeper issue.
+                    // We could resolve here with a timeout indicator, but letting 'close' handle it is cleaner if it works.
+                    // If 'close' never fires after abort/kill, the promise might hang. Let's add a failsafe resolve in the listener.
+                    // Revised: Resolve directly on abort to ensure promise completion.
+                    resolve({ code: null, output: stdoutData + stderrData + "\nTIMEOUT: CODESYS process aborted due to timeout." });
+                }, { once: true }); // Ensure listener is called only once
             });
-            // Add exec results to our output and get the exit code
-            output += execResult.output;
-            const exitCode = execResult.code;
-            process.stderr.write(`CODESYS process exited with code: ${exitCode}\n`); // Use process.stderr
+            output = spawnResult.output;
+            exitCode = spawnResult.code; // Can be null if process killed before exit code retrieved
             // Determine success based on exit code and output markers
-            // Note: CODESYS scripting might return exit code 0 even if the script had logical errors.
-            // Relying on specific output markers is more robust.
             if (output.includes(SCRIPT_SUCCESS_MARKER)) {
                 success = true;
             }
@@ -130,48 +166,50 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
                 success = false;
             }
             else {
-                // If no markers found, fall back to exit code (less reliable)
-                success = exitCode === 0;
-                if (!success) {
-                    // Append the specific CODESYS error if available and no other marker found
+                // Fallback logic (handle null exit code)
+                if (exitCode === 0) {
+                    console.warn("Warning: CODESYS script finished with exit code 0 but no SCRIPT_SUCCESS marker found.");
+                    success = !output.includes(SCRIPT_ERROR_MARKER); // Assume success if exit code 0 and no error marker
+                }
+                else {
+                    success = false;
+                    const exitMsg = exitCode !== null ? `exit code ${exitCode}` : 'signal or unknown reason';
                     if (!output.includes(SCRIPT_ERROR_MARKER)) {
-                        output += `\nSCRIPT_ERROR: Process exited with non-zero code ${exitCode}. Check CODESYS stderr output above for details.`;
+                        output += `\nSCRIPT_ERROR: Process exited with ${exitMsg}. Check CODESYS stderr output above for details.`;
                     }
                     else {
-                        output += `\nSCRIPT_ERROR: Process exited with non-zero code ${exitCode}.`;
+                        output += `\nSCRIPT_ERROR: Process exited with ${exitMsg}.`;
                     }
-                }
-                else {
-                    // If exit code is 0 but no success marker, treat as potential issue or simple script
-                    console.error("Warning: CODESYS script finished with exit code 0 but no SCRIPT_SUCCESS marker found."); // Log warning to stderr
-                    // Optionally, you could treat this as success or failure depending on requirements
-                    // For now, let's assume success if exit code is 0 and no error marker.
-                    if (!output.includes(SCRIPT_ERROR_MARKER)) {
-                        success = true;
+                    // Add timeout message specifically if that was the cause
+                    if (output.includes("TIMEOUT: CODESYS process aborted")) {
+                        // Message already added by the abort handler
+                    }
+                    else if (exitCode === null && !output.includes("Spawn Error:")) {
+                        // If exit code is null but not due to spawn error or handled timeout, add generic killed message
+                        output += `\nProcess may have been killed externally or timed out without proper exit code reporting.`;
                     }
                 }
             }
         }
         catch (error) {
-            process.stderr.write(`Error executing CODESYS script: ${error}\n`); // Use process.stderr
-            output += `\nSCRIPT_ERROR: Failed to execute script process. ${error.message}`;
+            process.stderr.write(`Error executing CODESYS script: ${error}\n`);
+            output += `\nSCRIPT_ERROR: Failed to set up script execution process. ${error.message}`;
             success = false;
         }
         finally {
             // Clean up the temporary file
             try {
                 yield (0, promises_1.unlink)(tempFilePath);
-                process.stderr.write(`Temporary script deleted: ${tempFilePath}\n`); // Use process.stderr
+                process.stderr.write(`Temporary script deleted: ${tempFilePath}\n`);
             }
             catch (cleanupError) {
-                process.stderr.write(`Failed to delete temporary script file ${tempFilePath}: ${cleanupError}\n`); // Use process.stderr
-                // Don't overwrite the original error if cleanup fails
-                if (success) { // Only add cleanup error if the main process didn't already fail
+                process.stderr.write(`Failed to delete temporary script file ${tempFilePath}: ${cleanupError}\n`);
+                if (success) {
                     output += `\nWARNING: Failed to delete temporary script file ${tempFilePath}. ${cleanupError.message}`;
                 }
             }
         }
-        process.stderr.write(`Final script output received:\n---\n${output}\n---\n`); // Use process.stderr
-        return { success, output }; // Revert return object
+        process.stderr.write(`Final script output received (Success: ${success}):\n---\n${output}\n---\n`);
+        return { success, output };
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codesys/mcp-toolkit",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "main": "dist/server.js",
   "bin": "./dist/bin.js",
   "scripts": {