Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: added drop traits in track call feature for mixpanel #1882

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

manish339k
Copy link
Contributor

@manish339k manish339k commented Jan 29, 2025

What are the changes introduced in this PR?

Added new toggle button to drop traits from event property in track call.
Screenshot 2025-01-29 at 12 32 35 PM

What is the related Linear task?

Resolves INT-3100

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

    • Added a new configuration option "Drop Traits" for Mixpanel track events
    • Allows users to drop traits from track event properties
    • Configuration can be set via UI with a checkbox in "Track Settings"
  • Bug Fixes

    • Added validation to ensure dropTraitsInTrackEvent is a boolean value

Copy link

coderabbitai bot commented Jan 29, 2025

Walkthrough

This pull request introduces a new configuration option dropTraitsInTrackEvent for the Mixpanel destination, allowing users to control whether traits are dropped in track events. The changes span multiple configuration files, including db-config.json, schema.json, and ui-config.json. A test validation file is also updated to include a test case for the new configuration option, specifically checking type validation.

Changes

File Change Summary
src/configurations/destinations/mp/db-config.json Added dropTraitsInTrackEvent to defaultConfig array
src/configurations/destinations/mp/schema.json Added dropTraitsInTrackEvent property to configSchema as a boolean with default false
src/configurations/destinations/mp/ui-config.json Added "Track Settings" section with a checkbox for "Drop Traits" configuration
test/data/validation/destinations/mp.json Added a test configuration with an invalid dropTraitsInTrackEvent value to validate type checking

Possibly related PRs

Suggested reviewers

  • lvrach
  • am6010
  • ssbeefeater
  • debanjan97
  • cisse21
  • 1abhishekpandey
  • ItsSudip
  • sandeepdsvs
  • koladilip
  • krishna2020
  • shrouti1507

Poem

🐰 A Rabbit's Ode to Trait Dropping 🎩

In Mixpanel's config, a new key takes flight,
Drop traits or keep them, set things just right!
A checkbox so clever, a boolean so neat,
Configuration dancing to a developer's beat!
Traits come, traits go, with just a small click! 🔧


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Jan 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (83cfaa1) to head (1b924bf).

Additional details and impacted files
@@            Coverage Diff            @@
##           develop     #1882   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           53        53           
  Branches         7         7           
=========================================
  Hits            53        53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@manish339k manish339k changed the title feat: added drop traits in track call feature for mixpanel feat: added drop traits in track call feature for mixpanel Jan 29, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
test/data/validation/destinations/mp.json (1)

744-766: Test coverage could be enhanced.

While the current test case correctly validates the type checking for dropTraitsInTrackEvent, consider adding more test cases for better coverage.

Consider adding these additional test cases:

 {
   "config": {
     "token": "dummy-token",
     ...
     "dropTraitsInTrackEvent": "inValid"
   },
   "result": false,
   "err": ["dropTraitsInTrackEvent must be boolean"]
 },
+{
+  "config": {
+    "token": "dummy-token",
+    "dataResidency": "us",
+    "dropTraitsInTrackEvent": true
+  },
+  "result": true
+},
+{
+  "config": {
+    "token": "dummy-token",
+    "dataResidency": "us",
+    "dropTraitsInTrackEvent": false
+  },
+  "result": true
+}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 83cfaa1 and 1b924bf.

📒 Files selected for processing (4)
  • src/configurations/destinations/mp/db-config.json (1 hunks)
  • src/configurations/destinations/mp/schema.json (1 hunks)
  • src/configurations/destinations/mp/ui-config.json (1 hunks)
  • test/data/validation/destinations/mp.json (1 hunks)
🔇 Additional comments (3)
src/configurations/destinations/mp/db-config.json (1)

112-113: LGTM! Configuration key properly added.

The new configuration key dropTraitsInTrackEvent is correctly added to the defaultConfig array, maintaining consistent formatting and logical grouping with other track-related configurations.

src/configurations/destinations/mp/ui-config.json (1)

165-186: LGTM! Well-structured UI configuration.

The new "Track Settings" section is properly implemented with:

  • Clear labeling and description
  • Appropriate checkbox control
  • Correct prerequisite for cloud mode
  • Consistent placement and structure
src/configurations/destinations/mp/schema.json (1)

42-45: LGTM! Schema properly defined.

The dropTraitsInTrackEvent property is correctly defined with appropriate type and default value, consistent with the UI configuration and feature requirements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant