chore: algolia component tests

[aashishmalik]

What are the changes introduced in this PR?

algolia component tests

What is the related Linear task?

Resolves INT-XXX

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
  • Enhanced error handling for ALGOLIA response transformations, including a new case for HTTP status code 422.
• Tests
  • Added comprehensive test scenarios for Algolia data delivery integration, covering both Proxy v0 and Proxy v1 APIs.
  • Introduced constants and aggregated datasets for testing different API versions and error handling scenarios.
  • Implemented predefined network calls to Algolia's Insights API for tracking product interaction events, with tests for successful and error responses.

[coderabbitai]

Walkthrough

The recent updates focus on enhancing error handling and testing for the Algolia integration within a specific module. Modifications include refining error responses based on HTTP status codes and adding a new case for status code 422. Additionally, a comprehensive set of new test files introduces scenarios for both Proxy v0 and v1 APIs, covering valid, invalid, and various error cases. This ensures robustness in Algolia data delivery and error management.

Changes

File(s)	Summary
src/v1/.../networkHandler.js	Updated to refine error handling logic for ALGOLIA responses, including a new case for HTTP status 422.
test/integrations/.../business.ts, test/integrations/.../constant.ts, test/integrations/.../data.ts	Introduced to define test scenarios, constants, and aggregated datasets for Algolia data delivery across Proxy v0 and v1 APIs.
test/integrations/.../other.ts	New file for testing various error responses from Algolia, covering scenarios like Service Unavailable, Internal Server Error, and more.
test/integrations/.../network.ts	Defines network calls to Algolia's Insights API for tracking product interactions, including error handling and successful event tracking.

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.
  • 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 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 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]

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.70%. Comparing base (a0ca61b) to head (62ccafe).
Report is 22 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3183      +/-   ##
===========================================
+ Coverage    84.86%   87.70%   +2.83%     
===========================================
  Files          497      548      +51     
  Lines        27412    29561    +2149     
  Branches      6597     7045     +448     
===========================================
+ Hits         23262    25925    +2663     
+ Misses        3694     3328     -366     
+ Partials       456      308     -148     

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

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[utsabc]

@coderabbitai review

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f51e6b9 and 62ccafe.

Files selected for processing (6)

• src/v1/destinations/algolia/networkHandler.js (2 hunks)
• test/integrations/destinations/algolia/dataDelivery/business.ts (1 hunks)
• test/integrations/destinations/algolia/dataDelivery/constant.ts (1 hunks)
• test/integrations/destinations/algolia/dataDelivery/data.ts (1 hunks)
• test/integrations/destinations/algolia/dataDelivery/other.ts (1 hunks)
• test/integrations/destinations/algolia/network.ts (1 hunks)

Additional comments: 10

test/integrations/destinations/algolia/dataDelivery/data.ts (3)

• 1-2: The import statements are correctly structured and relevant to the test scenarios.
• 4-9: The structure and content of the data array, which combines test scenarios from different sources, are correctly implemented and appropriate for aggregating test scenarios.
• 4-9: The export statement for the data array is correctly implemented, facilitating its use in other test files or suites.

src/v1/destinations/algolia/networkHandler.js (3)

• 47-60: The addition of a specific case for HTTP status code 422 with the use of TransformerProxyError is consistent with good error handling practices. Ensure that the error message and status code are informative and appropriate for the error condition.
• 1-4: The utility imports in this file are relevant and correctly implemented, supporting the functionality of the networkHandler.
• 44-72: > 📝 NOTE

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

The structure and logic of the response handler function are well-implemented, with appropriate handling of successful and error responses, including the new case for status code 422.

test/integrations/destinations/algolia/dataDelivery/constant.ts (1)

• 1-118: The constants defined in this file, including metadata for proxy requests and common request properties, are well-structured and relevant to the Algolia data delivery tests. The use of descriptive names enhances readability and maintainability.

test/integrations/destinations/algolia/network.ts (1)

• 1-117: The networkCallsData array is well-structured and provides a comprehensive set of scenarios for testing network interactions with Algolia's Insights API, including both valid and invalid event types and various HTTP response scenarios. The use of descriptive names and clear structure enhances readability and maintainability.

test/integrations/destinations/algolia/dataDelivery/business.ts (1)

• 1-330: The test scenarios defined for both Proxy v0 and Proxy v1 APIs are well-structured and comprehensive, covering a wide range of cases including valid and invalid events, and different response scenarios from Algolia. The use of helper functions for constructing request bodies and clear descriptions of scenarios enhances readability and maintainability.

test/integrations/destinations/algolia/dataDelivery/other.ts (1)

• 1-523: The additional test scenarios defined for both Proxy v0 and Proxy v1 APIs are well-structured and focus on error handling and edge cases, including service unavailable, internal server error, gateway timeout, and null responses. The clear descriptions of scenarios and thorough approach ensure comprehensive testing of the Algolia integration under various error conditions.