fix: improve script handling in execute commands for better serialization

- Updated the `execute` function in both Electron and Tauri services to use `JSON.stringify` for string scripts, ensuring proper escaping of special characters.
- Enhanced test coverage for the `execute` command to validate handling of various script formats, including strings with quotes, newlines, unicode, and backslashes.
- Adjusted assertions in tests to reflect the new serialization logic, ensuring accurate expectations for script execution.

Author: goosewobbler

packages/electron-service/src/commands/execute.ts

@@ -14,11 +14,13 @@ export async function execute<ReturnValue, InnerArguments extends unknown[]>(
     throw new Error('WDIO browser is not yet initialised');
   }
 
+  const scriptString = typeof script === 'function' ? script.toString() : JSON.stringify(script);
+
   const returnValue = await browser.execute(
     function executeWithinElectron(script: string, ...args) {
       return window.wdioElectron.execute(script, args);
     },
-    `${script}`,
+    scriptString,
     ...args,
   );
 

packages/electron-service/test/commands/execute.spec.ts

@@ -44,7 +44,40 @@ describe('execute Command', () => {
 
   it('should execute a stringified function', async () => {
     await execute(globalThis.browser, '() => 1 + 2 + 3');
-    expect(globalThis.browser.execute).toHaveBeenCalledWith(expect.any(Function), '() => 1 + 2 + 3');
-    expect(globalThis.wdioElectron.execute).toHaveBeenCalledWith('() => 1 + 2 + 3', []);
+    expect(globalThis.browser.execute).toHaveBeenCalledWith(expect.any(Function), JSON.stringify('() => 1 + 2 + 3'));
+    expect(globalThis.wdioElectron.execute).toHaveBeenCalledWith(JSON.stringify('() => 1 + 2 + 3'), []);
+  });
+
+  it('should handle scripts with quotes', async () => {
+    const scriptWithQuotes = '() => "He said \\"hello\\""';
+    await execute(globalThis.browser, scriptWithQuotes);
+    expect(globalThis.browser.execute).toHaveBeenCalledWith(expect.any(Function), JSON.stringify(scriptWithQuotes));
+  });
+
+  it('should handle scripts with newlines', async () => {
+    const scriptWithNewlines = '() => "line1\\nline2"';
+    await execute(globalThis.browser, scriptWithNewlines);
+    expect(globalThis.browser.execute).toHaveBeenCalledWith(expect.any(Function), JSON.stringify(scriptWithNewlines));
+  });
+
+  it('should handle scripts with unicode', async () => {
+    const scriptWithUnicode = '() => "Hello 世界"';
+    await execute(globalThis.browser, scriptWithUnicode);
+    expect(globalThis.browser.execute).toHaveBeenCalledWith(expect.any(Function), JSON.stringify(scriptWithUnicode));
+  });
+
+  it('should handle scripts with backslashes', async () => {
+    const scriptWithBackslashes = '() => "C:\\\\path\\\\file"';
+    await execute(globalThis.browser, scriptWithBackslashes);
+    expect(globalThis.browser.execute).toHaveBeenCalledWith(
+      expect.any(Function),
+      JSON.stringify(scriptWithBackslashes),
+    );
+  });
+
+  it('should handle mixed special characters', async () => {
+    const script = '() => "Test \\n \\t \\u001b and \\\\ backslash"';
+    await execute(globalThis.browser, script);
+    expect(globalThis.browser.execute).toHaveBeenCalledWith(expect.any(Function), JSON.stringify(script));
   });
 });

packages/tauri-plugin/src/commands.rs

@@ -63,7 +63,9 @@ pub(crate) async fn execute<R: Runtime>(
     let script = if !request.args.is_empty() {
         let args_json = serde_json::to_string(&request.args)
             .map_err(|e| crate::Error::SerializationError(format!("Failed to serialize args: {}", e)))?;
-        format!("(function() {{ const __wdio_args = {}; return ({}); }})()", args_json, request.script)
+        let script_json = serde_json::to_string(&request.script)
+            .map_err(|e| crate::Error::SerializationError(format!("Failed to serialize script: {}", e)))?;
+        format!("(function() {{ const __wdio_args = {}; return ({}); }})()", args_json, script_json)
     } else {
         request.script.clone()
     };

packages/tauri-service/src/commands/execute.ts

@@ -66,7 +66,8 @@ export async function execute<ReturnValue, InnerArguments extends unknown[]>(
   }
 
   // Convert function to string - keep parameters intact, plugin will inject tauri as first arg
-  const scriptString = typeof script === 'function' ? script.toString() : script;
+  // For strings, use JSON.stringify to safely escape special characters
+  const scriptString = typeof script === 'function' ? script.toString() : JSON.stringify(script);
 
   // Execute via plugin's execute command with better error handling
   // The plugin will inject the Tauri APIs object as the first argument

packages/tauri-service/src/service.ts

@@ -318,7 +318,9 @@ export default class TauriWorkerService {
       script: string | ((...args: InnerArguments) => ReturnValue),
       ...args: InnerArguments
     ): Promise<ReturnValue> {
-      const scriptString = typeof script === 'function' ? script.toString() : script;
+      // For strings, use JSON.stringify to safely escape special characters
+      // For functions, toString() gives the function source which is already valid JS
+      const scriptString = typeof script === 'function' ? script.toString() : JSON.stringify(script);
 
       if (isEmbedded) {
         // For embedded WebDriver: skip console wrapper as console forwarding
@@ -327,6 +329,8 @@ export default class TauriWorkerService {
       }
 
       // For tauri-driver: use sync execute with console wrapper
+      // Note: scriptString is already properly escaped from above - functions use .toString()
+      // which produces valid JS, strings use JSON.stringify() which also produces valid JS
       const wrappedScript = `
             ${CONSOLE_WRAPPER_SCRIPT}
             return (${scriptString}).apply(null, arguments);

packages/tauri-service/test/commands/execute.spec.ts

@@ -189,7 +189,7 @@ describe('execute', () => {
       expect(secondCall[3]).toBe(2);
     });
 
-    it('should pass strings as-is', async () => {
+    it('should pass strings properly stringified', async () => {
       const mockExecute = vi.fn();
       mockExecute.mockResolvedValueOnce(true);
       mockExecute.mockResolvedValueOnce(JSON.stringify({ __wdio_value__: 'hello' }));
@@ -199,7 +199,7 @@ describe('execute', () => {
       await execute<string, []>(browser, 'return "hello"');
 
       const secondCall = mockExecute.mock.calls[1];
-      expect(secondCall[1]).toBe('return "hello"');
+      expect(secondCall[1]).toBe(JSON.stringify('return "hello"'));
     });
   });