feat: adding zod validations

[utsabc]

What are the changes introduced in this PR?

This PR introduces zod validations for processor and router test cases. Adding type definitions for the test cases and validations for tests. This eliminates incorrect tests and helps in keeping server <> transformer contract safe

What is the related Linear task?

Resolves INT-1443

Please explain the objectives of your changes below

The objective of the change is to enable devs write tests more confidently with type support system helping them.

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

---

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
  • Enhanced handling of batch requests with improved data processing.
  • Introduced new data structures and validations for processor and router transformations.
• Enhancements
  • Added new fields and optional properties to transformation output and request/response types for better flexibility and error handling.
• Tests
  • Expanded integration test capabilities with new test data structures and improved readability.
  • Introduced comprehensive test data for various scenarios including Klaviyo, MP, and The Trade Desk integrations.
  • Added validation and metadata generation utilities to improve test accuracy and coverage.

[coderabbitai]

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 overall changes focus on enhancing data processing and validation for destinations and processors within a codebase, specifically targeting improvements in handling batch requests, refining data types, and ensuring robust error handling. Additionally, the updates introduce more structured and comprehensive testing data for destinations like Klaviyo, MP, and The Trade Desk, aiming to improve test coverage and reliability. These changes collectively aim to streamline data transformation processes and improve the maintainability and readability of the code and tests.

Changes

File(s)	Summary
.../destination/postTransformation.ts	Updated logic for handling batchedRequest with improved array processing and userId conversion.
src/types/index.ts src/types/zodTypes.ts	Enhanced type definitions and schemas, including optional fields and refined error handling.
.../klaviyo/processor/ecomTestData.ts .../groupTestData.ts .../identifyTestData.ts .../screenTestData.ts .../trackTestData.ts .../validationTestData.ts	Refined test data structure with explicit typing, added metadata, and updated properties for better test readability.
.../klaviyo/router/data.ts .../destinations/mp/router/data.ts	Refactored data structures for enhanced readability and maintainability in routing data.
.../destinations/mp/common.ts .../destinations/the_trade_desk/common.ts	Updated destination configurations with additional properties for improved clarity and consistency.
test/integrations/testTypes.ts test/integrations/testUtils.ts	Introduced new types and utility functions for test data processing, including schema validations and payload generation.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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.

[utsabc]

@coderabbitai review

[koladilip]

repeated

[coderabbitai]

Review Status

Actionable comments generated: 10

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between bd6af6b and 2ac1654.

Files selected for processing (15)

• src/services/destination/postTransformation.ts (1 hunks)
• src/types/index.ts (3 hunks)
• src/types/zodTypes.ts (2 hunks)
• test/integrations/destinations/klaviyo/processor/ecomTestData.ts (8 hunks)
• test/integrations/destinations/klaviyo/processor/groupTestData.ts (6 hunks)
• test/integrations/destinations/klaviyo/processor/identifyTestData.ts (21 hunks)
• test/integrations/destinations/klaviyo/processor/screenTestData.ts (3 hunks)
• test/integrations/destinations/klaviyo/processor/trackTestData.ts (10 hunks)
• test/integrations/destinations/klaviyo/processor/validationTestData.ts (4 hunks)
• test/integrations/destinations/klaviyo/router/data.ts (6 hunks)
• test/integrations/destinations/mp/common.ts (2 hunks)
• test/integrations/destinations/mp/router/data.ts (10 hunks)
• test/integrations/destinations/the_trade_desk/common.ts (2 hunks)
• test/integrations/testTypes.ts (2 hunks)
• test/integrations/testUtils.ts (12 hunks)

Additional comments: 21

test/integrations/destinations/mp/common.ts (1)

• 1-10: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-24]

LGTM!

test/integrations/testTypes.ts (1)

• 57-102: LGTM!

test/integrations/destinations/klaviyo/processor/validationTestData.ts (1)

• 1-26: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-77]

LGTM!

test/integrations/destinations/the_trade_desk/common.ts (1)

• 1-15: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-31]

LGTM!

test/integrations/destinations/klaviyo/processor/screenTestData.ts (1)

• 1-30: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-110]

LGTM!

test/integrations/destinations/klaviyo/processor/groupTestData.ts (1)

• 1-27: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-153]

LGTM!

src/types/index.ts (1)

• 162-178: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-174]

LGTM!

src/types/zodTypes.ts (1)

• 5-107: LGTM!

src/services/destination/postTransformation.ts (1)

• 78-84: LGTM!

test/integrations/destinations/klaviyo/processor/trackTestData.ts (1)

• 1-29: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-334]

LGTM!

test/integrations/destinations/klaviyo/processor/ecomTestData.ts (3)

• 1-1: The import of generateMetadata aligns with the PR's objective to enhance test case reliability through metadata generation.
• 5-20: The explicit type definition for destination using Destination and the addition of Enabled and WorkspaceID fields improve type safety and clarity.
• 77-83: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [42-357]

The addition of metadata to test data objects with calls to generateMetadata is consistent with the PR's goal to support more accurate and reliable testing through enhanced metadata generation.

test/integrations/destinations/klaviyo/router/data.ts (2)

• 23-179: Refactoring message data into the routerRequest object enhances code readability and maintainability by centralizing request data.
• 324-336: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [181-364]

The integration of routerRequest into the test data and the use of generateMetadata for generating metadata are consistent with the PR's objectives to improve test case reliability and accuracy.

test/integrations/destinations/klaviyo/processor/identifyTestData.ts (2)

• 11-26: The explicit type definition for destination using Destination and the addition of Enabled and WorkspaceID fields improve type safety and clarity.
• 304-314: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [98-579]

The modifications to identifyData to include explicit type annotations, the use of overrideDestination for specific configurations, and the addition of metadata with calls to generateMetadata align with the PR's goal to enhance test case reliability through type support and metadata generation.

test/integrations/testUtils.ts (4)

• 9-20: The addition of imports for Zod schemas and types such as Destination and Metadata supports the PR's objectives of enhancing test case reliability through type definitions and validations.
• 95-95: The overrideDestination function signature correctly uses the Destination type, ensuring type safety.
• 478-489: The addition of Zod validation for RouterTransformationResponseListSchema and ProcessorTransformationResponseListSchema in validateTestWithZOD aligns with the PR's goal to ensure test cases adhere to expected structures through schema validations.
• 516-524: The introduction of the generateMetadata helper function supports the generation of metadata for test cases, further aligning with the PR's objectives.

[devops-github-rudderstack]

Test report for this run is available at: https://test-integrations-dev.s3.amazonaws.com/integrations-test-reports/rudder-transformer/3066/test-report.html

[sonarcloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
96.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[codecov]

Codecov Report

Attention: 11 lines in your changes are missing coverage. Please review.

Comparison is base (7ce0a66) 87.13% compared to head (bca634f) 87.27%.
Report is 33 commits behind head on fix.network-handlers.

Files	Patch %	Lines
...destinations/the_trade_desk/transformConversion.js	93.47%	3 Missing ⚠️
src/v0/destinations/marketo_bulk_upload/util.js	86.95%	3 Missing ⚠️
src/types/zodTypes.ts	92.00%	2 Missing ⚠️
src/v0/destinations/hs/util.js	98.11%	1 Missing ⚠️
src/v0/destinations/rakuten/networkHandler.js	97.29%	1 Missing ⚠️
...c/v0/destinations/the_trade_desk/networkHandler.js	87.50%	1 Missing ⚠️

Additional details and impacted files

@@                   Coverage Diff                    @@
##           fix.network-handlers    #3066      +/-   ##
========================================================
+ Coverage                 87.13%   87.27%   +0.14%     
========================================================
  Files                       531      538       +7     
  Lines                     28860    29322     +462     
  Branches                   6865     6978     +113     
========================================================
+ Hits                      25148    25592     +444     
- Misses                     3369     3387      +18     
  Partials                    343      343              

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