fix: support groups key for capture events#174
Merged
Conversation
Prompt To Fix All With AIFix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
test/PostHogTest.php:460-502
**Prefer a parameterised test over two separate methods**
The two new methods (`testCaptureCopiesGroupsKeyToDollarGroupsProperty` and `testCaptureKeepsDollarGroupsCompatibility`) cover the same logical scenario — capture with a groups key ends up in `properties['$groups']` — and differ only in which input key is used (`groups` vs `$groups`). Per the project's stated preference for parameterised tests, these should be collapsed into a single `@dataProvider`-driven method. Separate methods make it harder to add coverage for additional variants (e.g. both keys supplied simultaneously) without more copy-paste.
Reviews (1): Last reviewed commit: "fix: support groups key for capture even..." | Re-trigger Greptile |
# Conflicts: # test/PostHogTest.php
ioannisj
approved these changes
Jun 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
💡 Motivation and Context
Fixes #71.
capture()documents and examples have allowed passing group context with thegroupskey, but PostHog ingestion associates events with groups via the$groupsevent property. This PR preserves backwards compatibility by promoting an explicitly suppliedgroupskey to$groupsbefore enqueueing the capture event, while keeping existing$groupsbehavior unchanged.💚 How did you test it?
./vendor/bin/phpunit --no-coverage test/PostHogTest.php --filter '/testCaptureCopiesGroupsKeyToDollarGroupsProperty|testCaptureKeepsDollarGroupsCompatibility/'./vendor/bin/phpunit --no-coveragecomposer api:check./vendor/bin/phpcs --standard=phpcs.xml --warning-severity=0 lib/Client.php test/PostHogTest.phpgit diff --check📝 Checklist
If releasing new changes
pnpm changesetto generate a changeset file🤖 Agent context
Autonomy: Human-driven (agent-assisted)
This PR was implemented with the pi coding agent. We investigated the PostHog ingestion path and confirmed that event grouping is read from
properties.$groups; top-levelgroupsis not consumed by backend event ingestion. The chosen fix keeps the existing publicgroupscapture input working by promoting it to$groups, without changing feature flaggroupsbehavior or removing existing$groupscompatibility.