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: data plane events buffer on load option flag #1997

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

saikumarrs
Copy link
Member

@saikumarrs saikumarrs commented Jan 9, 2025

PR Description

Please include a summary of the change along with the relevant motivation and context.

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-2862/buffer-data-plane-events-until-ready

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

  • Refactor
    • Improved internal code organization for analytics and event repository management.
    • Streamlined methods for handling event queue and destination settings.
    • Encapsulated logic for managing data plane events and active destinations.

@saikumarrs saikumarrs self-assigned this Jan 9, 2025
Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

📝 Walkthrough

Walkthrough

The pull request introduces refactoring in two key analytics-related classes: Analytics and EventRepository. In the Analytics class, a new private method setActiveDestinations is added to encapsulate the logic for setting active destinations, replacing inline code. Similarly, in the EventRepository class, a new private method startDpEventsQueue is introduced to manage the data plane events queue initialization, consolidating and simplifying the event buffering and queue start conditions.

Changes

File Change Summary
packages/analytics-js/src/components/core/Analytics.ts Added private setActiveDestinations() method to centralize logic for setting active destinations
packages/analytics-js/src/components/eventRepository/EventRepository.ts Added private startDpEventsQueue() method to manage data plane events queue initialization and buffering logic

Possibly related PRs

Suggested reviewers

  • ItsSudip
  • krishna2020

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a9d55e and 04c5fa8.

📒 Files selected for processing (2)
  • packages/analytics-js/src/components/core/Analytics.ts (2 hunks)
  • packages/analytics-js/src/components/eventRepository/EventRepository.ts (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/analytics-js/src/components/core/Analytics.ts
  • packages/analytics-js/src/components/eventRepository/EventRepository.ts
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Security and code quality checks
  • GitHub Check: Unit Tests and Lint
  • GitHub Check: Bundle size checks
  • GitHub Check: Analyze (javascript-typescript)

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>, please review it.
    • Generate unit testing code 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 testing code 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 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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

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.

Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.37%. Comparing base (2a01152) to head (04c5fa8).
Report is 34 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1997      +/-   ##
===========================================
+ Coverage    61.36%   61.37%   +0.01%     
===========================================
  Files          478      478              
  Lines        16393    16398       +5     
  Branches      3239     3242       +3     
===========================================
+ Hits         10060    10065       +5     
- Misses        5100     5127      +27     
+ Partials      1233     1206      -27     

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

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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/analytics-js/src/components/eventRepository/EventRepository.ts (1)

125-130: Consider a more descriptive variable name.

The variable shouldBufferDpEvents could be more descriptive to better reflect its specific purpose.

-    const shouldBufferDpEvents = bufferEventsUntilReady && hybridDestExist;
+    const shouldBufferForHybridDestinations = bufferEventsUntilReady && hybridDestExist;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b6b668 and 7a9d55e.

📒 Files selected for processing (2)
  • packages/analytics-js/src/components/core/Analytics.ts (2 hunks)
  • packages/analytics-js/src/components/eventRepository/EventRepository.ts (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Security and code quality checks
  • GitHub Check: Unit Tests and Lint
  • GitHub Check: Bundle size checks
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (5)
packages/analytics-js/src/components/eventRepository/EventRepository.ts (3)

119-121: LGTM! Appropriate condition for starting data plane events queue.

The condition correctly initiates the data plane events queue when pre-consent buffering is not required.


Line range hint 124-152: LGTM! Well-structured queue management implementation.

The method effectively consolidates the data plane events queue management logic with appropriate buffering conditions and safety timeout mechanism.


156-164: LGTM! Consistent use of centralized queue management.

The resume method correctly uses the new startDpEventsQueue method while maintaining existing queue clearing logic.

packages/analytics-js/src/components/core/Analytics.ts (2)

294-296: LGTM! Good extraction of active destinations setup.

The code organization is improved by moving the active destinations setup to a dedicated method.


304-312: LGTM! Well-encapsulated active destinations setup.

The new method effectively encapsulates the plugin invocation logic for setting active destinations, promoting code reuse and maintainability.

Copy link

github-actions bot commented Jan 9, 2025

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Cookies Utils - Legacy - NPM (ESM) 1.54 KB 1.54 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (CJS) 1.75 KB 1.75 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (UMD) 1.54 KB 1.54 KB (0%) 2 KB
Cookies Utils - Modern - NPM (ESM) 1.17 KB 1.17 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (CJS) 1.4 KB 1.4 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (UMD) 1.16 KB 1.16 KB (0%) 1.5 KB
Plugins Module Federation Mapping - Legacy - CDN 332 B 332 B (0%) 512 B
Plugins Module Federation Mapping - Modern - CDN 331 B 331 B (0%) 512 B
Plugins - Legacy - CDN 13.66 KB 13.66 KB (0%) 14 KB
Plugins - Modern - CDN 5.64 KB 5.64 KB (0%) 6 KB
Common - No bundling 17.8 KB 17.8 KB (0%) 18.4 KB
Load Snippet 762 B 762 B (0%) 1 KB
Core (v1.1) - NPM (ESM) 30.37 KB 30.37 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 30.55 KB 30.55 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 30.44 KB 30.44 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.93 KB 29.93 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (CJS) 30.15 KB 30.15 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (UMD) 29.97 KB 29.97 KB (0%) 30 KB
Core (v1.1) - Legacy - CDN 32.3 KB 32.3 KB (0%) 32.5 KB
Core (v1.1) - Modern - CDN 30.34 KB 30.34 KB (0%) 32 KB
Service Worker - Legacy - NPM (ESM) 30.57 KB 30.57 KB (0%) 31 KB
Service Worker - Legacy - NPM (CJS) 30.82 KB 30.82 KB (0%) 31 KB
Service Worker - Legacy - NPM (UMD) 30.61 KB 30.61 KB (0%) 31 KB
Service Worker - Modern - NPM (ESM) 25.71 KB 25.71 KB (0%) 26 KB
Service Worker - Modern - NPM (CJS) 25.99 KB 25.99 KB (0%) 26.5 KB
Service Worker - Modern - NPM (UMD) 25.74 KB 25.74 KB (0%) 26 KB
Core - Legacy - NPM (ESM) 47.29 KB 47.31 KB (+0.07% ▲) 48 KB
Core - Legacy - NPM (CJS) 47.49 KB 47.52 KB (+0.06% ▲) 48 KB
Core - Legacy - NPM (UMD) 47.28 KB 47.32 KB (+0.1% ▲) 48 KB
Core - Legacy - CDN 47.42 KB 47.37 KB (-0.11% ▼) 47.5 KB
Core - Modern - NPM (ESM) 26.79 KB 26.81 KB (+0.09% ▲) 27 KB
Core - Modern - NPM (CJS) 27.01 KB 27.03 KB (+0.09% ▲) 27.1 KB
Core - Modern - NPM (UMD) 26.79 KB 26.83 KB (+0.14% ▲) 27 KB
Core - Modern - CDN 27.06 KB 27.06 KB (+0.01% ▲) 27.5 KB
Core (Bundled) - Legacy - NPM (ESM) 47.29 KB 47.31 KB (+0.07% ▲) 48 KB
Core (Bundled) - Legacy - NPM (CJS) 47.51 KB 47.54 KB (+0.06% ▲) 48 KB
Core (Bundled) - Legacy - NPM (UMD) 47.28 KB 47.32 KB (+0.1% ▲) 48 KB
Core (Bundled) - Modern - NPM (ESM) 38.52 KB 38.5 KB (-0.06% ▼) 39 KB
Core (Bundled) - Modern - NPM (CJS) 38.75 KB 38.74 KB (-0.01% ▼) 39 KB
Core (Bundled) - Modern - NPM (UMD) 38.52 KB 38.49 KB (-0.1% ▼) 39 KB
Core (Content Script) - Legacy - NPM (ESM) 47.2 KB 47.26 KB (+0.12% ▲) 48 KB
Core (Content Script) - Legacy - NPM (CJS) 47.43 KB 47.45 KB (+0.05% ▲) 48 KB
Core (Content Script) - Legacy - NPM (UMD) 47.22 KB 47.25 KB (+0.08% ▲) 48 KB
Core (Content Script) - Modern - NPM (ESM) 38.45 KB 38.48 KB (+0.09% ▲) 39 KB
Core (Content Script) - Modern - NPM (CJS) 38.73 KB 38.72 KB (-0.02% ▼) 39 KB
Core (Content Script) - Modern - NPM (UMD) 38.46 KB 38.51 KB (+0.14% ▲) 39 KB
All Integrations - Legacy - CDN 94.93 KB 94.93 KB (0%) 95.3 KB
All Integrations - Modern - CDN 90.38 KB 90.38 KB (0%) 91 KB

Copy link

Hello! This PR has been open for 20 days without any activity. Therefore, it's considered as stale and is scheduled to be closed in 10 days. If you're still working on this, please remove the 'Stale' label or add a comment to keep it open. Thanks for your contribution!

Copy link

Hello! This PR has been open for 20 days without any activity. Therefore, it's considered as stale and is scheduled to be closed in 10 days. If you're still working on this, please remove the 'Stale' label or add a comment to keep it open. Thanks for your contribution!

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.

1 participant