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: onboard new destination ninetailed #3106

Merged
merged 12 commits into from Feb 29, 2024
Merged

Conversation

anantjain45823
Copy link
Contributor

@anantjain45823 anantjain45823 commented Feb 19, 2024

What are the changes introduced in this PR?

Onboard new destination ninetailed.

Write a brief explainer on your code changes.
This destination supports identify, track, and page calls.
Also it supports batching with max batch size as 200

What is the related Linear task?

Resolves INT-295

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?

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
    • Introduced configuration settings for the Ninetailed destination, including event batch processing and mapping configurations.
  • Tests
    • Added comprehensive test scenarios for Ninetailed destination integration, covering tracking, page views, user identification, and validation failures.

Copy link
Contributor

coderabbitai bot commented Feb 19, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Walkthrough

The recent update introduces comprehensive configuration settings and utility functions for managing event data in the Ninetailed destination within a CDK. It enhances event batching, payload construction, and endpoint communication. Integration tests cover various scenarios including validation, tracking, page views, and user identification, ensuring robustness and reliability of the integration. This update streamlines the process of sending events to Ninetailed's platform, improving efficiency and effectiveness of data handling.

Changes

File Path Change Summary
src/cdk/v2/destinations/ninetailed/config.js Introduces configuration settings for event categories and batch processing, including endpoint.
src/cdk/v2/destinations/ninetailed/utils.js Adds functions for payload construction and retrieving batch endpoint.
test/integrations/destinations/ninetailed/... Introduces integration tests for ninetailed destination, covering config, data structures, and scenarios for tracking, page events, identify calls, and validation.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@devops-github-rudderstack
Copy link
Contributor

Copy link

codecov bot commented Feb 19, 2024

Codecov Report

Attention: Patch coverage is 95.74468% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 84.89%. Comparing base (9afcd7b) to head (3e8790a).
Report is 17 commits behind head on develop.

Files Patch % Lines
src/cdk/v2/destinations/ninetailed/utils.js 95.23% 2 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3106      +/-   ##
===========================================
+ Coverage    84.59%   84.89%   +0.30%     
===========================================
  Files          493      496       +3     
  Lines        27308    27333      +25     
  Branches      6576     6560      -16     
===========================================
+ Hits         23101    23205     +104     
+ Misses        3754     3704      -50     
+ Partials       453      424      -29     

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

@saikumarrs
Copy link
Member

@coderabbitai review

Copy link
Contributor

@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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 6b44fe4 and b18ec6e.
Files ignored due to path filters (8)
  • src/cdk/v2/destinations/ninetailed/data/contextMapping.json is excluded by: !**/*.json
  • src/cdk/v2/destinations/ninetailed/data/generalPayloadMapping.json is excluded by: !**/*.json
  • src/cdk/v2/destinations/ninetailed/data/identifyMapping.json is excluded by: !**/*.json
  • src/cdk/v2/destinations/ninetailed/data/pageMapping.json is excluded by: !**/*.json
  • src/cdk/v2/destinations/ninetailed/data/trackMapping.json is excluded by: !**/*.json
  • src/cdk/v2/destinations/ninetailed/procWorkflow.yaml is excluded by: !**/*.yaml
  • src/cdk/v2/destinations/ninetailed/rtWorkflow.yaml is excluded by: !**/*.yaml
  • src/features.json is excluded by: !**/*.json
Files selected for processing (11)
  • src/cdk/v2/destinations/ninetailed/config.js (1 hunks)
  • src/cdk/v2/destinations/ninetailed/utils.js (1 hunks)
  • test/integrations/destinations/ninetailed/processor/commonConfig.ts (1 hunks)
  • test/integrations/destinations/ninetailed/processor/data.ts (1 hunks)
  • test/integrations/destinations/ninetailed/processor/identify.ts (1 hunks)
  • test/integrations/destinations/ninetailed/processor/page.ts (1 hunks)
  • test/integrations/destinations/ninetailed/processor/track.ts (1 hunks)
  • test/integrations/destinations/ninetailed/processor/validation.ts (1 hunks)
  • test/integrations/destinations/ninetailed/router/basicProperties.ts (1 hunks)
  • test/integrations/destinations/ninetailed/router/commonConfig.ts (1 hunks)
  • test/integrations/destinations/ninetailed/router/data.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • test/integrations/destinations/ninetailed/processor/commonConfig.ts
Additional comments: 9
test/integrations/destinations/ninetailed/processor/data.ts (1)
  • 1-5: The changes in data.ts for importing modules and aggregating test data into the data array are correctly implemented.
src/cdk/v2/destinations/ninetailed/config.js (1)
  • 1-29: The configuration settings in config.js, including the MAX_BATCH_SIZE and batchEndpoint, are correctly implemented and align with the PR objectives.
test/integrations/destinations/ninetailed/router/commonConfig.ts (1)
  • 1-38: The common configurations in commonConfig.ts, including input/output structures and destination configuration, are correctly implemented and provide a solid foundation for testing.
test/integrations/destinations/ninetailed/router/basicProperties.ts (1)
  • 1-33: The event properties and traits defined in basicProperties.ts are correctly implemented and relevant to the Ninetailed destination.
src/cdk/v2/destinations/ninetailed/utils.js (1)
  • 1-38: The utility functions in utils.js, including payload construction and endpoint determination, are correctly implemented and follow best practices.
test/integrations/destinations/ninetailed/processor/page.ts (1)
  • 1-108: The test scenarios for page events in page.ts are well-defined and provide comprehensive coverage, aligning with the Ninetailed destination's requirements.
test/integrations/destinations/ninetailed/processor/identify.ts (1)
  • 1-164: The test scenarios for identify calls in identify.ts are comprehensive, covering both success and failure cases, and align with the Ninetailed destination's requirements.
test/integrations/destinations/ninetailed/processor/validation.ts (1)
  • 1-180: The test scenarios for validation failures in validation.ts are comprehensive and well-defined, covering essential validation requirements and aligning with best practices for testing.
test/integrations/destinations/ninetailed/processor/track.ts (1)
  • 1-203: The test scenarios for track calls in track.ts are comprehensive, covering both success and failure cases, and align with the Ninetailed destination's requirements.

test/integrations/destinations/ninetailed/router/data.ts Outdated Show resolved Hide resolved
@anantjain45823 anantjain45823 force-pushed the feat.newDestNinetailed branch 2 times, most recently from e741e31 to aa735f4 Compare February 26, 2024 08:11
Copy link

sonarcloud bot commented Feb 28, 2024

@anantjain45823 anantjain45823 merged commit 0e2588e into develop Feb 29, 2024
15 checks passed
@anantjain45823 anantjain45823 deleted the feat.newDestNinetailed branch February 29, 2024 04:55
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.

None yet

6 participants