feat: Deprecate sanitize_properties

[rafaeelaudibert]

Changes

We can achieve the exact same outcome we achieve with sanitize_properties by using before_send which is a much more compreheensive function, with better usability and ergonomics.

We can't remove this function without a major, so let's deprecate it and issue a console warning when it's used.

Checklist

• Tests for new code (see advice on the tests we use)
• Accounted for the impact of any changes across different browsers
• Accounted for backwards compatibility of any changes (no breaking changes in posthog-js!)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
posthog-js	✅ Ready (Inspect)	Visit Preview	Dec 27, 2024 3:00pm

[github-actions]

Size Change: +1.41 kB (+0.04%)

Total Size: 3.22 MB

Filename	Size	Change
dist/array.full.es5.js	262 kB	+142 B (+0.05%)
dist/array.full.js	365 kB	+142 B (+0.04%)
dist/array.full.no-external.js	364 kB	+142 B (+0.04%)
dist/array.js	179 kB	+140 B (+0.08%)
dist/array.no-external.js	178 kB	+140 B (+0.08%)
dist/main.js	180 kB	+140 B (+0.08%)
dist/module.full.js	365 kB	+142 B (+0.04%)
dist/module.full.no-external.js	364 kB	+142 B (+0.04%)
dist/module.js	179 kB	+140 B (+0.08%)
dist/module.no-external.js	178 kB	+140 B (+0.08%)

ℹ️ View Unchanged

Filename	Size
dist/all-external-dependencies.js	206 kB
dist/customizations.full.js	12.6 kB
dist/dead-clicks-autocapture.js	14.4 kB
dist/exception-autocapture.js	9.48 kB
dist/external-scripts-loader.js	2.64 kB
dist/recorder-v2.js	115 kB
dist/recorder.js	115 kB
dist/surveys-preview.js	57.6 kB
dist/surveys.js	63.3 kB
dist/tracing-headers.js	1.76 kB
dist/web-vitals.js	10.4 kB

_{compressed-size-action}

[rafaeelaudibert]

Website update to suggest before_send over sanitize_properties: PostHog/posthog.com#10229

[pauldambra]

yep, this is even better since sanitize_properties is called on properties and $set_once but not on $set

[posthog-bot]

This PR hasn't seen activity in a week! Should it be merged, closed, or further worked on? If you want to keep it open, post a comment or remove the stale label – otherwise this will be closed in another week.