Sanitize script command logs (#8165)

webdriverio · Mar 29, 2022 · 3841213 · 3841213
1 parent 1897b94
commit 3841213
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/packages/wdio-utils/src/utils.ts b/packages/wdio-utils/src/utils.ts
@@ -5,6 +5,7 @@ import type { Services, Clients } from '@wdio/types'
 
 const SCREENSHOT_REPLACEMENT = '"<Screenshot[base64]>"'
 const SCRIPT_PLACEHOLDER = '"<Script[base64]>"'
+const REGEX_SCRIPT_NAME = /return \(function (\w+)/
 
 /**
  * overwrite native element commands with user defined
@@ -97,6 +98,9 @@ export function transformCommandLogResult (result: { file?: string, script?: str
         return SCREENSHOT_REPLACEMENT
     } else if (typeof result.script === 'string' && isBase64(result.script)) {
         return SCRIPT_PLACEHOLDER
+    } else if (typeof result.script === 'string' && result.script.match(REGEX_SCRIPT_NAME)) {
+        const newScript = result.script.match(REGEX_SCRIPT_NAME)![1]
+        return { ...result, script: `${newScript}(...) [${Buffer.byteLength(result.script, 'utf-8')} bytes]` }
     }
 
     return result

diff --git a/packages/wdio-utils/tests/utils.test.ts b/packages/wdio-utils/tests/utils.test.ts
@@ -46,6 +46,10 @@ describe('utils', () => {
         expect(transformCommandLogResult({ script: 'foo' })).toEqual({ script: 'foo' })
         expect(transformCommandLogResult({ script: (Buffer.from('some script payload')).toString('base64') }))
             .toBe('"<Script[base64]>"')
+
+        expect(transformCommandLogResult({ script: 'return foobar' })).toEqual({ script: 'return foobar' })
+        expect(transformCommandLogResult({ script: 'return (function isElementDisplayed(element) {\n...' }))
+            .toEqual({ script: 'isElementDisplayed(...) [50 bytes]' })
     })
 
     describe('overwriteElementCommands', () => {