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

fix: add standard events to reddit #1873

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

Conversation

aanshi07
Copy link
Contributor

@aanshi07 aanshi07 commented Jan 22, 2025

What are the changes introduced in this PR?

Added standard event to Reddit

What is the related Linear task?

Resolves INT-3093

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 support for mapping "Sign up" event to "SignUp" in Reddit destination configuration
    • Added support for mapping "test" event to "Lead" in Reddit destination configuration
    • Introduced new "SignUp" and "Lead" events for mapping in Reddit event tracking
  • Tests

    • Added new test cases for event mapping validation with valid configurations

Copy link

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request introduces enhancements to the Reddit destination configuration by adding new event mapping options for the "SignUp" and "Lead" events. These modifications allow users to map additional RudderStack events to corresponding Reddit events. The changes are implemented in the UI configuration file and the validation test data, ensuring the new mapping options are supported and validated without altering existing configurations.

Changes

File Change Summary
src/configurations/destinations/reddit/ui-config.json Added new "SignUp" and "Lead" options to the "Reddit Event" mapping field.
test/data/validation/destinations/reddit.json Added new test configurations for mappings from "Sign up" to "SignUp," "test" to "Lead," and "test" to "PageVisit."

Poem

🐰 A rabbit's tale of mapping bright,
New events in Reddit take their flight!
"SignUp" and "Lead" now find their way,
In the world of tracking, they joyfully play!
With each new mapping, our dreams take form,
Hopping through data, a joyful norm! 🌟


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b6dacc3 and 5bdfbb2.

📒 Files selected for processing (2)
  • src/configurations/destinations/reddit/ui-config.json (1 hunks)
  • test/data/validation/destinations/reddit.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/configurations/destinations/reddit/ui-config.json
  • test/data/validation/destinations/reddit.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (java-kotlin)

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 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (41be203) to head (5bdfbb2).

Additional details and impacted files
@@            Coverage Diff            @@
##           develop     #1873   +/-   ##
=========================================
  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.

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/reddit.json (1)

291-303: LGTM! Consider adding negative test cases.

The test case properly validates the new SignUp event mapping with correct configuration structure.

Consider adding negative test cases to validate:

  1. Invalid event mapping (e.g., incorrect "to" value)
  2. Case sensitivity handling (e.g., "signup" vs "SignUp")
 {
   "config": {
     "accountId": "d2bnpxxxxxzq1p89hXXXXx2hf5q1k3v",
     "hashData": true,
     "eventsMapping": [
       {
         "from": "Sign up",
         "to": "SignUp"
       }
     ]
   },
   "result": true
 },
+{
+  "config": {
+    "accountId": "d2bnpxxxxxzq1p89hXXXXx2hf5q1k3v",
+    "hashData": true,
+    "eventsMapping": [
+      {
+        "from": "Sign up",
+        "to": "signup"
+      }
+    ]
+  },
+  "result": false,
+  "err": ["Invalid Reddit event name"]
+}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 41be203 and f9cd03a.

📒 Files selected for processing (2)
  • src/configurations/destinations/reddit/ui-config.json (1 hunks)
  • test/data/validation/destinations/reddit.json (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (java-kotlin)
🔇 Additional comments (1)
src/configurations/destinations/reddit/ui-config.json (1)

135-138: LGTM! Verify standard event name.

The addition of the "SignUp" event mapping option follows the existing pattern and structure correctly.

Let's verify this is a standard Reddit event name:

✅ Verification successful

"SignUp" appears to be a valid standard event name

The event follows the same naming convention and structure as other standard Reddit events like ViewContent, Search, AddToCart, etc., and represents a common conversion action type.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for documentation or references to Reddit's standard events
# to verify "SignUp" is an official event name

curl -s "https://advertising.reddithelp.com/en/categories/measuring-optimizing/installing-reddit-pixel" | grep -i "signup"

Length of output: 120


Script:

#!/bin/bash
# Search for Reddit event configurations and documentation
echo "=== Searching for Reddit event configurations ==="
rg -i "signup" --type json src/configurations/destinations/reddit/

echo -e "\n=== Searching for Reddit documentation files ==="
fd -e md -e txt -e json . src/configurations/destinations/reddit/ -x grep -i "signup" {} \;

echo -e "\n=== Checking for similar event patterns ==="
rg '"value":\s*"[^"]*"' src/configurations/destinations/reddit/ui-config.json

Length of output: 1283

@aanshi07 aanshi07 changed the title chore: add standard events to reddit fix: add standard events to reddit Jan 23, 2025
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.

3 participants