chore: make password capture more explicit (#1345)

PostHog · Aug 9, 2024 · 44478bc · 44478bc
1 parent f5a0d12
commit 44478bc
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 4 deletions.
diff --git a/src/__tests__/extensions/replay/sessionrecording.test.ts b/src/__tests__/extensions/replay/sessionrecording.test.ts
@@ -22,6 +22,7 @@ import {
     PostHogConfig,
     Property,
     SessionIdChangedCallback,
+    SessionRecordingOptions,
 } from '../../../types'
 import { uuidv7 } from '../../../uuidv7'
 import {
@@ -663,6 +664,24 @@ describe('SessionRecording', () => {
             })
         })
 
+        describe('capturing passwords', () => {
+            it.each([
+                ['no masking options', {} as SessionRecordingOptions, true],
+                ['empty masking options', { maskInputOptions: {} } as SessionRecordingOptions, true],
+                ['password not set', { maskInputOptions: { input: true } } as SessionRecordingOptions, true],
+                ['password set to true', { maskInputOptions: { password: true } } as SessionRecordingOptions, true],
+                ['password set to false', { maskInputOptions: { password: false } } as SessionRecordingOptions, false],
+            ])('%s', (_name: string, session_recording: SessionRecordingOptions, expected: boolean) => {
+                posthog.config.session_recording = session_recording
+                sessionRecording.startIfEnabledOrStop()
+                expect(assignableWindow.rrweb.record).toHaveBeenCalledWith(
+                    expect.objectContaining({
+                        maskInputOptions: expect.objectContaining({ password: expected }),
+                    })
+                )
+            })
+        })
+
         it('records events emitted before and after starting recording', () => {
             sessionRecording.startIfEnabledOrStop()
             expect(loadScriptMock).toHaveBeenCalled()

diff --git a/src/extensions/replay/sessionrecording.ts b/src/extensions/replay/sessionrecording.ts
@@ -601,9 +601,14 @@ export class SessionRecording {
         const userSessionRecordingOptions = this.instance.config.session_recording
         for (const [key, value] of Object.entries(userSessionRecordingOptions || {})) {
             if (key in sessionRecordingOptions) {
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore
-                sessionRecordingOptions[key] = value
+                if (key === 'maskInputOptions') {
+                    // ensure password is set if not included
+                    sessionRecordingOptions.maskInputOptions = { password: true, ...value }
+                } else {
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore
+                    sessionRecordingOptions[key] = value
+                }
             }
         }
 

diff --git a/src/posthog-core.ts b/src/posthog-core.ts
@@ -1713,7 +1713,7 @@ export class PostHog {
      *         blockSelector: null,
      *         ignoreClass: 'ph-ignore-input',
      *         maskAllInputs: true,
-     *         maskInputOptions: {},
+     *         maskInputOptions: {password: true},
      *         maskInputFn: null,
      *         slimDOMOptions: {},
      *         collectFonts: false,