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: ninetailed: modify page support #1677

Merged
merged 1 commit into from
Apr 1, 2024

Conversation

anantjain45823
Copy link
Contributor

@anantjain45823 anantjain45823 commented Mar 28, 2024

PR Description

Modifying page support for ninetailed.
It is recommended to use ninetailed page calls directly and not via RS to avoid delays and hence a toggle is provided in the Rudderstack Destination Configuration UI on the same note.

Linear task (optional)

Linear task link
Resolves INT-1887

Cross Browser Tests

Please confirm you have tested for the following browsers:

  • Chrome
  • Firefox
  • IE11

Sanity Suite

  • All sanity suite test cases pass locally

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

Summary by CodeRabbit

  • New Features
    • Introduced a toggle for sending page events in the Ninetailed integration, allowing for more flexible analytics configurations.
  • Tests
    • Updated test cases to cover the new toggle functionality for page events in Ninetailed.

Copy link
Contributor

coderabbitai bot commented Mar 28, 2024

Walkthrough

The updates focus on enhancing the Ninetailed integration by introducing an option to toggle sending page events. This feature allows for more granular control over event tracking, which is reflected in both the test adjustments and the core implementation within the Ninetailed class.

Changes

File Path Change Summary
.../__tests__/integrations/Ninetailed/browser.test.js Updated tests for Ninetailed to cover new sendPageEvents configuration.
.../src/integrations/Ninetailed/browser.js Added sendPageEvents handling in Ninetailed based on config.sendPageInDevice.

🐇✨
Changes in the code, oh so bright,
Toggling events from day to night.
In the land of code, where rabbits hop,
We tweak and test, and never stop.
🌟📄 With each commit, our story weaves,
Through lines of code, our magic breathes.
🐾💻

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

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: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5fc8674 and 01a8626.
Files selected for processing (2)
  • packages/analytics-js-integrations/tests/integrations/Ninetailed/browser.test.js (2 hunks)
  • packages/analytics-js-integrations/src/integrations/Ninetailed/browser.js (2 hunks)
Additional comments (4)
packages/analytics-js-integrations/src/integrations/Ninetailed/browser.js (2)
  • 17-17: The addition of sendPageEvents property based on config.sendPageInDevice is correctly implemented.

Ensure that config.sendPageInDevice is validated upstream to avoid potential issues.

  • 55-63: The conditional handling of page events based on sendPageEvents is implemented correctly. This change aligns with the PR's objective to reduce delays in page event processing.

Consider adding a comment explaining the rationale behind this conditional logic for future maintainability.

packages/analytics-js-integrations/__tests__/integrations/Ninetailed/browser.test.js (2)
  • 49-49: The updated instantiation of Ninetailed with sendPageInDevice: true correctly reflects the new functionality for testing purposes.
  • 82-90: The test case for toggling off the sending of page events is correctly implemented and verifies the intended behavior.

Consider adding more descriptive comments to explain the purpose of this test for future maintainability.

Copy link

codecov bot commented Mar 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.91%. Comparing base (5fc8674) to head (01a8626).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1677   +/-   ##
========================================
  Coverage    53.90%   53.91%           
========================================
  Files          461      461           
  Lines        15611    15613    +2     
  Branches      3098     3110   +12     
========================================
+ Hits          8415     8417    +2     
+ Misses        5899     5861   -38     
- Partials      1297     1335   +38     

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

Copy link

sonarcloud bot commented Mar 28, 2024

Copy link

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Common Code - No bundling 15.81 KB 15.81 KB (0%) 16.5 KB
Remote Module Federation Mapping - CDN 330 B 330 B (0%) 512 B
Remote Module Federated Plugins - CDN 5.71 KB 5.71 KB (0%) 6 KB
Core ESM - NPM 7.64 KB 7.64 KB (0%) 8 KB
Core CJS - NPM 22.45 KB 22.45 KB (0%) 23 KB
Core - NPM 22.55 KB 22.55 KB (0%) 23 KB
Core Legacy - CDN 42.99 KB 42.99 KB (0%) 44 KB
Core - CDN 22.71 KB 22.71 KB (0%) 23 KB
Core (legacy build) - CDN - v1.1 31.55 KB 31.55 KB (0%) 32 KB
Core - NPM - v1.1 31.53 KB 31.53 KB (0%) 32 KB
Service Worker Module 22.64 KB 22.64 KB (0%) 24 KB
All Integrations (legacy build) - CDN 98.57 KB 98.47 KB (-0.11% ▼) 105 KB

@anantjain45823 anantjain45823 merged commit e45ef06 into develop Apr 1, 2024
10 checks passed
@anantjain45823 anantjain45823 deleted the fix.ninetailed_modify_page_support branch April 1, 2024 11:34
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

3 participants