rudder-transformer feat: bluecore email subscription event

What are the changes introduced in this PR?

In this pr, we will introduce new subscription event specs for Bluecore. A notion doc https://www.notion.so/rudderstacks/Subscribing-and-Unsubscribing-in-RudderStack-1edf2b415dd080fc91b3cd053d536c23?d=1f8f2b415dd0807fa9a1001c0682b03c#1edf2b415dd080c48581e6ab24f2e083

Supported Link: https://help.bluecore.com/en/articles/6786828-events-api#h_2eb9c99eaa

What is the related Linear task?

Resolves INT-3602

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 generic utility introduced or modified. Please explain the changes.

N/A

Any technical or performance related pointers to consider with the change?

N/A

@coderabbitai review

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?
[ ] Is the PR limited to 10 file changes?
[ ] Is the PR limited to one linear task?
[ ] Are relevant unit and component test-cases added in new readability format?

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.

May 07 '25 08:05 maheshkutty

Summary by CodeRabbit

New Features
- Introduced dedicated handling for subscription events, allowing for separate processing and payload construction based on user consent.
Bug Fixes
- Improved validation for email and subscription consent fields in event payloads.
Tests
- Added comprehensive tests to ensure correct behavior of subscription event payload construction and error handling.

Walkthrough

The changes introduce dedicated support for subscription events in the Bluecore destination, including configuration, utility functions for validation and payload construction, workflow modifications to handle subscription events separately, and tests to verify these functionalities.

Changes

File(s)	Change Summary
`src/cdk/v2/destinations/bluecore/config.js`	Added `SUBSCRIPTION_EVENT` category with name and type; introduced `SUBSCRIPTION_EVENT_EXCLUSION_LIST` and exported it.
`src/cdk/v2/destinations/bluecore/utils.js`	Added `isSubscriptionEvent`, `validateEmail`, `constructSubscriptionEventPayload`; refactored validation functions to handle subscription events distinctly; updated `mapCustomProperties` and `constructProperties`.
`src/cdk/v2/destinations/bluecore/procWorkflow.yaml`	Created a new step `handleSubscriptionEvent` with specific condition; modified `handleTrackEvent` to exclude subscription events, enabling separate processing flows.
`src/cdk/v2/destinations/bluecore/utils.test.js`	Added tests for `constructSubscriptionEventPayload`, covering various valid and invalid scenarios for subscription events.

Sequence Diagram(s)

sequenceDiagram
    participant Source as Message Source
    participant Utils as Bluecore Utils
    participant Workflow as Bluecore Workflow

    Source->>Workflow: Receive Track Event (message)
    alt Subscription Event
        Workflow->>Utils: isSubscriptionEvent(event)
        Utils-->>Workflow: true
        Workflow->>Utils: constructSubscriptionEventPayload(message)
        Utils-->>Workflow: subscription event payload
        Workflow->>Workflow: Validate and set payload context
    else Non-Subscription Event
        Workflow->>Utils: isSubscriptionEvent(event)
        Utils-->>Workflow: false
        Workflow->>Utils: constructCommonPayload(message)
        Utils-->>Workflow: common event payload
        Workflow->>Workflow: Validate and set payload context
    end

Suggestions for Improvement

Consider adopting a strategy pattern or modular handler approach to manage different event types, reducing branching complexity.
Expand testing to cover edge cases, especially around consent property variations and invalid data scenarios.
Add inline documentation and usage examples for the new subscription event utilities to aid onboarding and future maintenance.
Review and optimize workflow step conditions for better reuse and clarity, minimizing duplicated logic between subscription and non-subscription handlers.

Suggested Reviewers

sivashanmukh
ItsSudip

✨ Finishing Touches

[ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@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.

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.

May 07 '25 08:05 coderabbitai[bot]

Allure Test reports for this run are available at:

Allure Report: View Report

May 07 '25 08:05 devops-github-rudderstack

Codecov Report

Attention: Patch coverage is 95.83333% with 1 line in your changes missing coverage. Please review.

Project coverage is 91.12%. Comparing base (4a18dc9) to head (2847fd9). Report is 14 commits behind head on develop.

Files with missing lines	Patch %	Lines
src/cdk/v2/destinations/bluecore/utils.js	95.65%	1 Missing :warning:

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #4304      +/-   ##
===========================================
+ Coverage    91.10%   91.12%   +0.01%     
===========================================
  Files          636      636              
  Lines        33378    33404      +26     
  Branches      7888     7896       +8     
===========================================
+ Hits         30410    30439      +29     
+ Misses        2729     2696      -33     
- Partials       239      269      +30

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

:snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
:package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.