feat: posthog person profile option #1747
Conversation
shrouti1507
requested review from
lvrach,
cisse21,
debanjan97,
am6010,
ssbeefeater,
AchuthaSourabhC,
ruchiramoitra,
ItsSudip,
sandeepdsvs,
krishna2020 and
1abhishekpandey
as code owners
WalkthroughThe changes involve modifications to two configuration files related to the PostHog destination settings. In Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## release/v1.95.1 #1747 +/- ##
=================================================
Coverage 100.00% 100.00%
=================================================
Files 2 2
Lines 53 53
Branches 7 7
=================================================
Hits 53 53 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
src/configurations/destinations/posthog/db-config.json (1)
75-75: LGTM: Addition of "personProfile" to web configurationThe addition of "personProfile" to the
webarray withindestConfigis appropriate and consistent with its inclusion in theincludeKeysarray. This change ensures that the person profile option is available for web configurations of the PostHog destination.For consistency, consider adding the "personProfile" option to other relevant platform configurations (e.g., android, ios) if applicable. If it's intentionally only for web, please add a comment explaining this decision.
src/configurations/destinations/posthog/ui-config.json (1)
45-52: LGTM! Consider a minor improvement to the footer note.The new checkbox field for capturing identified events is well-structured and consistent with other fields in the configuration. Its placement in the "Native SDK" section is appropriate, and the default value of
falseensures backward compatibility.Consider slightly rewording the footer note for clarity:
- "footerNote": "If this is disabled, PostHog only captures identified events for users where person profiles have already been created" + "footerNote": "If disabled, PostHog will only capture identified events for users with existing person profiles."This minor change improves readability and maintains consistency with the style of other footer notes in the file.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- src/configurations/destinations/posthog/db-config.json (2 hunks)
- src/configurations/destinations/posthog/ui-config.json (1 hunks)
🧰 Additional context used
🔇 Additional comments (3)
src/configurations/destinations/posthog/db-config.json (2)
Line range hint
1-138: Overall assessment: Changes look goodThe additions of the "personProfile" key to both the
includeKeysarray and thewebconfiguration indestConfigare consistent and align with the PR objectives. These changes effectively introduce the PostHog person profile option as intended.To ensure the changes are complete, let's verify if any related files need updates:
#!/bin/bash # Description: Check for potential related files that might need updates # Test: Search for files that mention "posthog" and "profile" in the configurations directory fd -t f . src/configurations | xargs rg -l --ignore-case 'posthog.*profile'This will help identify any other files that might need similar updates for consistency.
17-17: LGTM: Addition of "personProfile" to includeKeysThe addition of "personProfile" to the
includeKeysarray is appropriate and aligns with the PR objective of introducing a PostHog person profile option. The placement maintains the alphabetical order of the array.Let's verify if this new key is consistently used throughout the file:
✅ Verification successful
Verification Complete: Consistent Usage of "personProfile" Confirmed
All occurrences of "personProfile" in
db-config.jsonare consistent with the recent changes. No issues found.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the consistent use of "personProfile" key in the file # Test: Search for all occurrences of "personProfile" rg --json '"personProfile"' src/configurations/destinations/posthog/db-config.json | jq -r '.data.lines.text'Length of output: 132
Script:
#!/bin/bash # Description: Accurately search for all occurrences of "personProfile" in db-config.json rg --json '"personProfile"' src/configurations/destinations/posthog/db-config.json | jq -r '.data.lines.text'Length of output: 174
src/configurations/destinations/posthog/ui-config.json (1)
Line range hint
1-359: Summary: New PostHog person profile option successfully implementedThe changes in this file successfully implement the new PostHog person profile option as described in the PR objectives. The addition of the "Capture identified events for all events" checkbox in the "Native SDK" section provides users with more control over event capturing based on person profiles.
Key points:
- The change is minimal and focused, adding only one new field.
- It doesn't introduce breaking changes or modify existing behaviors.
- The new option is disabled by default, ensuring backward compatibility.
- The implementation is consistent with the existing structure and style of the configuration file.
These changes effectively fulfill the requirements of the "feat: posthog person profile option" PR without introducing any apparent issues or inconsistencies.
shrouti1507
requested review from
RanjeetMishra,
saikumarrs and
a team
as code owners
|
Closing this PR as other changes are also coming from dev. We need to do a hotfix |
What are the changes introduced in this PR?
Write a brief explainer on your code changes.
What is the related Linear task?
Resolves INT-2721
Please explain the objectives of your changes below
Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here
Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?
N/A
Any new dependencies introduced with this change?
N/A
Any new checks got introduced or modified in test suites. Please explain the changes.
N/A
Developer checklist
My code follows the style guidelines of this project
No breaking changes are being introduced.
All related docs linked with the PR?
All changes manually tested?
Any documentation changes needed with this change?
I have executed schemaGenerator tests and updated schema if needed
Are sensitive fields marked as secret in definition config?
My test cases and placeholders use only masked/sample values for sensitive fields
Is the PR limited to 10 file changes & one task?
Reviewer checklist
Is the type of change in the PR title appropriate as per the changes?
Verified that there are no credentials or confidential data exposed with the changes.
Summary by CodeRabbit
New Features
Documentation