feat(posthog): Add session recording support by riley-wv · Pull Request #632 · capawesome-team/capacitor-plugins

riley-wv · 2025-10-05T12:15:49Z

• Add session recording functionality
• Add session recording start/stop methods
• Add configuration options for enableSessionReplay, sessionReplayOptions
• Implement native Android support using PostHog Android SDK
• Implement native iOS support using PostHog iOS SDK
• Add Web platform support with automatic configuration checks
• Update documentation with new API methods and configuration options
• Maintain backward compatibility with existing implementations

Pull request checklist

Please check if your PR fulfills the following requirements:

The changes have been tested successfully.
A changeset has been created (npm run changeset).
I have read and followed the pull request guidelines.

Closes: #630

…lugin Implemented comprehensive session replay and error tracking capabilities across iOS, Android, and Web platforms for the PostHog Capacitor plugin. **Key Changes:** - Added `captureException()` method to capture and track errors with optional properties - Added `startSessionRecording()` and `stopSessionRecording()` methods with configurable sampling and linked flag options - Updated TypeScript definitions with new interfaces: `CaptureExceptionOptions` and `StartSessionRecordingOptions` - Extended Capacitor configuration interface with session replay and error tracking options - Implemented platform-specific option classes for iOS (Swift) and Android (Java) - Updated configuration handling to automatically enable features based on plugin config - Enhanced web implementation using posthog-js session recording and exception capture APIs - Added iOS implementation using PostHog iOS SDK methods - Added Android implementation using PostHog Android SDK methods **Configuration Options Added:** - `enableSessionReplay`: Auto-enable session recording on app start - `sessionReplaySampling`: Set sampling rate (0.0 to 1.0, default 1.0) - `sessionReplayLinkedFlag`: Enable linked flags for session recording - `enableErrorTracking`: Auto-enable error tracking These changes provide a unified, cross-platform API for session replay and error tracking while maintaining backward compatibility.

…rror-tracking

robingenz

Thank you! Just a few small changes needed.

Commit includes: - Revert changes to root package.json and posthog package.json - Sort definitions correctly - Update version in definitions - Remove undefined type - Remove capacitor config from web package

riley-wv · 2025-10-07T04:49:07Z

@robingenz all request changes have been made

riley-wv · 2025-10-07T06:25:05Z

Okay thats all been reverted

robingenz · 2025-10-08T19:02:02Z

@riley-wv Please fix the Android and iOS builds so that i can merge your PR.

…rror-tracking

robingenz · 2025-10-14T09:23:37Z

@riley-wv The workflow is still failing.

riley-wv · 2025-10-14T09:24:41Z

Saw this @robingenz. I have been busy, but will make sure to push a fix for this ASAP

wahibimoh · 2025-10-20T15:12:30Z

@riley-wv many thanks for making this contribution, I cannot wait to start using it.

…rror-tracking

This commit includes the following: - Remove error tracking from iOS (unsupported) - Fix session replays for android and iOS

riley-wv · 2025-10-21T02:51:29Z

@robingenz, I have gone ahead and tested everything end to end and it is all compiling as expected now. I apologise for before. It seems I had tried to implement methods that did not exist.

Few notes on this now:

Error tracking could only be implemented on Android
I had to upgrade the PostHog android version to 3.24.0 to support error tracking

robingenz · 2025-10-21T03:05:57Z

I had to upgrade the PostHog android version to 3.24.0 to support error tracking

@riley-wv This is considered a major change. Therefore, I need to wait to merge this PR until the next major update is released, which will be with the release of Capacitor 8.

riley-wv · 2025-10-21T03:09:25Z

Okay @robingenz. I completely understand. I can rollback my error tracking changes and just implement session replay if that will make it a minor a change?

I was under the impression because no breaking changes were made, it would be considered a minor change

robingenz · 2025-10-21T03:13:13Z

@riley-wv Yes, if you revert that change, we can merge it. But it would still be nice to have this feature. So I would appreciate it if you could just move the error tracking changes into another PR.

pkg-pr-new · 2025-10-21T03:18:13Z

Open in StackBlitz

@capawesome/capacitor-age-signals

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-age-signals@632

@capawesome-team/capacitor-android-battery-optimization

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome-team/capacitor-android-battery-optimization@632

@capawesome/capacitor-android-dark-mode-support

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-android-dark-mode-support@632

@capawesome/capacitor-android-edge-to-edge-support

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-android-edge-to-edge-support@632

@capawesome-team/capacitor-android-foreground-service

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome-team/capacitor-android-foreground-service@632

@capawesome/capacitor-app-review

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-app-review@632

@capawesome/capacitor-app-shortcuts

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-app-shortcuts@632

@capawesome/capacitor-app-update

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-app-update@632

@capawesome/capacitor-asset-manager

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-asset-manager@632

@capawesome/capacitor-background-task

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-background-task@632

@capawesome/capacitor-badge

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-badge@632

@capawesome/capacitor-cloudinary

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-cloudinary@632

@capawesome-team/capacitor-datetime-picker

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome-team/capacitor-datetime-picker@632

@capawesome-team/capacitor-file-opener

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome-team/capacitor-file-opener@632

@capawesome/capacitor-file-picker

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-file-picker@632

@capawesome/capacitor-libsql

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-libsql@632

@capawesome/capacitor-live-update

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-live-update@632

@capawesome/capacitor-managed-configurations

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-managed-configurations@632

@capawesome/capacitor-photo-editor

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-photo-editor@632

@capawesome/capacitor-posthog

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-posthog@632

@capawesome/capacitor-realtimekit

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-realtimekit@632

@capawesome/capacitor-screen-orientation

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-screen-orientation@632

@capawesome/capacitor-screenshot

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-screenshot@632

@capawesome/capacitor-torch

npm i https://pkg.pr.new/capawesome-team/capacitor-plugins/@capawesome/capacitor-torch@632

commit: 9426608

riley-wv · 2025-10-21T03:18:53Z

Okay @robingenz. I will do that now

riley-wv · 2025-10-21T03:31:46Z

@robingenz that is removed now and will update the existing issue and open a new one for error tracking. Could you please assign the new issue to me once its created so I can open a PR?

riley-wv · 2025-10-21T04:04:03Z

@robingenz error tracking has been moved.

Open issue - #645

Open PR - #646

riley-wv · 2025-10-21T05:17:27Z

Sorry @robingenz, I have gone ahead and fixed all of those issues now

riley-wv · 2025-10-22T21:24:20Z

That's all done @robingenz

robingenz

Thank you!

robingenz · 2025-10-24T03:59:35Z

@riley-wv Please fix the lint error.

robingenz · 2025-11-04T13:27:51Z

@riley-wv Did you already had a chance to take a look at the linting issue?

byoung96 · 2025-11-10T15:22:07Z

@robingenz My team is looking to get session recording into our Capacitor app. I'd be happy to fix the lint issue that we can get this merged.

riley-wv · 2025-11-12T12:36:25Z

Should all pass now @robingenz. My apologies for missing these notifications prior. I was at an offsite last week. This will now all pass

robingenz

Great work, thank you!

gcarpi · 2025-11-17T18:35:24Z

Hi everyone, the record in PostHog isn’t displaying correctly. Do you know what might be causing this?

robingenz · 2025-11-17T19:09:50Z

@riley-wv Any idea?

byoung96 · 2025-11-17T19:25:19Z

I'd mention that I was only able to get this working when screenshotMode is enabled.

gcarpi · 2025-11-17T19:35:04Z

I'd mention that I was only able to get this working when screenshotMode is enabled.

Thanks, but still the same for me.

My configuration:

    Posthog: {
      apiKey: 'MY_API_KEY_HERE',
      host: 'https://us.i.posthog.com',
      enableSessionReplay: true,
      sessionReplayConfig: {
        screenshotMode: true
      }
    }

byoung96 · 2025-11-17T19:37:18Z

@gcarpi interesting... below is my full config

{
    apiKey: import.meta.env.VITE_PUBLIC_POSTHOG_KEY,
    host: import.meta.env.VITE_PUBLIC_POSTHOG_HOST,
    enableSessionReplay: true,
    sessionReplayConfig: {
        screenshotMode: true,
        maskAllTextInputs: false,
        maskAllImages: false,
        maskAllSandboxedViews: false
    }
}

gcarpi · 2025-11-17T21:15:37Z

@byoung96 Not working yet for me =/

Where do you put this config? On capacitor.config.ts?

byoung96 · 2025-11-17T21:24:33Z

@gcarpi I actually forked this branch, because it was taking some time to get merged, and added a setup function to the plugin that allows me to initialize PostHog before I mount my react app.

Don't remember if I did anything so I'm not sure why yours isn't working..

TheRealDarkCoder · 2025-11-19T12:51:26Z

Hi everyone, the record in PostHog isn’t displaying correctly. Do you know what might be causing this?

Having the exact same issue, android 16.

Posthog: {
      apiKey: "...",
      host: "https://us.i.posthog.com",
      enableSessionReplay: true,
      sessionReplayConfig: {
        screenshotMode: true,
        maskAllTextInputs: false,
        maskAllImages: false,
        maskAllSandboxedViews: false,
      },
    },

Should we create an issue?

robingenz · 2025-11-19T12:53:26Z

@riley-wv Could you take another look at it? Maybe we should add some more information on how to configure/test it.

riley-wv added 4 commits October 3, 2025 12:26

Merge branch 'capawesome-team:main' into feat/session-recording-and-e…

612534d

…rror-tracking

Add changeset to branch

44f7870

Simplify changeset and change to minor change

8c1a8ba

robingenz requested changes Oct 7, 2025

View reviewed changes

Request Changes

7c2215f

Commit includes: - Revert changes to root package.json and posthog package.json - Sort definitions correctly - Update version in definitions - Remove undefined type - Remove capacitor config from web package

Sort alphabetically for SetupOptions

08bd397

robingenz requested changes Oct 7, 2025

View reviewed changes

Comment thread package-lock.json

Revert package-lock

7f91bda

Merge branch 'capawesome-team:main' into feat/session-recording-and-e…

8faf7b8

…rror-tracking

riley-wv added 2 commits October 21, 2025 10:28

Merge branch 'capawesome-team:main' into feat/session-recording-and-e…

97f1322

…rror-tracking

Fix Session Replays & Error tracking

5e13cce

This commit includes the following: - Remove error tracking from iOS (unsupported) - Fix session replays for android and iOS

riley-wv requested a review from robingenz October 21, 2025 02:18

Fix android compile failure

9bb9f32

Fix linting issues

ab5daac

Updates to web types and definitions

646d083

riley-wv changed the title ~~feat(posthog): Add session recording and error tracking support~~ feat(posthog): Add session recording support Oct 21, 2025

feat(rm-error-tracking): Remove error tracking to make minor bump

f6648f9

robingenz requested changes Oct 21, 2025

View reviewed changes

Fix commented out setup and remove remain error capture code

bd9cf9e

riley-wv added 2 commits October 21, 2025 15:18

revert package-lock and update changeset

0fd941c

Resolve type issues for PostHogConfig

ee65c88

robingenz requested changes Oct 22, 2025

View reviewed changes

Comment thread packages/posthog/android/build.gradle

Comment thread packages/posthog/src/definitions.ts Outdated

Comment thread packages/posthog/src/definitions.ts Outdated

remove error tracking types and add jvm target

9e0c3b0

Fix Kotlin Options

fcdde49

robingenz previously approved these changes Oct 24, 2025

View reviewed changes

Fix linting errors

9426608

riley-wv dismissed robingenz’s stale review via 9426608 November 12, 2025 12:35

robingenz approved these changes Nov 12, 2025

View reviewed changes

robingenz merged commit 419231d into capawesome-team:main Nov 12, 2025
6 checks passed

github-actions Bot mentioned this pull request Nov 12, 2025

chore(release): publish #660

Merged

Uh oh!

Conversation

riley-wv commented Oct 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request checklist

Uh oh!

robingenz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

riley-wv commented Oct 7, 2025

Uh oh!

Uh oh!

riley-wv commented Oct 7, 2025

Uh oh!

robingenz commented Oct 8, 2025

Uh oh!

robingenz commented Oct 14, 2025

Uh oh!

riley-wv commented Oct 14, 2025

Uh oh!

wahibimoh commented Oct 20, 2025

Uh oh!

riley-wv commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

robingenz commented Oct 21, 2025

Uh oh!

riley-wv commented Oct 21, 2025

Uh oh!

robingenz commented Oct 21, 2025

Uh oh!

pkg-pr-new Bot commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

riley-wv commented Oct 21, 2025

Uh oh!

riley-wv commented Oct 21, 2025

Uh oh!

riley-wv commented Oct 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

riley-wv commented Oct 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

riley-wv commented Oct 22, 2025

Uh oh!

robingenz left a comment

Choose a reason for hiding this comment

Uh oh!

robingenz commented Oct 24, 2025

Uh oh!

robingenz commented Nov 4, 2025

Uh oh!

byoung96 commented Nov 10, 2025

Uh oh!

riley-wv commented Nov 12, 2025

Uh oh!

robingenz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gcarpi commented Nov 17, 2025

Uh oh!

robingenz commented Nov 17, 2025

Uh oh!

byoung96 commented Nov 17, 2025

Uh oh!

riley-wv commented Oct 5, 2025 •

edited

Loading

riley-wv commented Oct 21, 2025 •

edited

Loading

pkg-pr-new Bot commented Oct 21, 2025 •

edited

Loading