Skip to content

feat: add events processing and retry headers #2066

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

Merged
merged 6 commits into from
Mar 2, 2025

Conversation

saikumarrs
Copy link
Member

@saikumarrs saikumarrs commented Feb 28, 2025

PR Description

I've added retry headers and also the missing "sent at" header for all the requests to the data plane.

Retried-After - Time in seconds since the previous attempt to send the event(s)
Retry-Attempt - The retry attempt number
Retried-After-First - Time in seconds since the very first attempt to send the event(s)
Reclaimed - Boolean to indicate if the events were reclaimed from the storage

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-2996/js-sdk-implementation-retry-headers

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

  • Chores
    • Adjusted module size thresholds for key modules to better align with updated performance parameters.
  • Refactor
    • Streamlined event processing by unifying retry metrics and error handling, enhancing the tracking of processing attempts and overall consistency.
    • Improved batch processing capabilities and item state tracking within the analytics framework.

These improvements aim to boost reliability and maintain smoother analytics operations without altering end-user functionality.

@saikumarrs saikumarrs self-assigned this Feb 28, 2025
Copy link
Contributor

coderabbitai bot commented Feb 28, 2025

📝 Walkthrough

Walkthrough

This PR makes several updates across the analytics-js-plugins package. Size limits in configuration files have been increased slightly for several CDN and NPM entries. Test cases and source files have been refactored to consolidate multiple retry and timing parameters into a single object (of type QueueProcessCallbackInfo), streamlining function signatures. Additionally, new properties (such as firstAttemptedAt, lastAttemptedAt, reclaimed, and id) have been added to types and data structures to improve tracking of queue items and their state during processing.

Changes

File(s) Change Summary
packages/analytics-js-plugins/.size-limit.mjs
packages/analytics-js/.size-limit.mjs
Updated size limits (e.g. 'Plugins - Legacy - CDN' from 14 KiB to 14.1 KiB; 'Core' entries from 47.6/39 KiB to 48/39.2/39.2 KiB)
packages/analytics-js-plugins/__tests__/deviceModeTransformation/index.test.ts
packages/analytics-js-plugins/__tests__/utilities/retryQueue/RetryQueue.test.ts
packages/analytics-js-plugins/__tests__/xhrQueue/index.test.ts
packages/analytics-js-plugins/__tests__/xhrQueue/utilities.test.ts
Refactored tests to pass a single object instead of multiple parameters to functions like processQueueCb and logErrorOnFailure. Added new properties for timestamps and reclamation status in queue items.
packages/analytics-js-plugins/src/deviceModeTransformation/index.ts
packages/analytics-js-plugins/src/types/plugins.ts
packages/analytics-js-plugins/src/utilities/retryQueue/RetryQueue.ts
packages/analytics-js-plugins/src/utilities/retryQueue/types.ts
packages/analytics-js-plugins/src/xhrQueue/index.ts
packages/analytics-js-plugins/src/xhrQueue/utilities.ts
Updated function signatures and imports to use the unified QueueProcessCallbackInfo. Added new properties (e.g. firstAttemptedAt, lastAttemptedAt, reclaimed, id) and renamed variables (e.g. batchItems to batchEntries) to enhance retry, batch processing, and error logging logic.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Client/Test
    participant Queue as Queue System
    participant Processor as processQueueCb
    participant Logger as logErrorOnFailure

    Caller->>Queue: Enqueue processing request
    Queue->>Queue: Consolidate retry/timing info into QueueProcessCallbackInfo
    Queue->>Processor: Call processQueueCb({retryAttemptNumber, maxRetryAttempts, willBeRetried, timeSinceFirstAttempt, timeSinceLastAttempt, reclaimed})
    Processor-->>Queue: Return processing result
    alt Processing failure
        Queue->>Logger: logErrorOnFailure({retryAttemptNumber, maxRetryAttempts, willBeRetried, timeSinceFirstAttempt, timeSinceLastAttempt, reclaimed})
    end
Loading

Suggested reviewers

  • ChryssaAliferi
  • ItsSudip
  • sanpj2292

📜 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 2821d81 and f5904e4.

📒 Files selected for processing (1)
  • packages/analytics-js/.size-limit.mjs (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/analytics-js/.size-limit.mjs
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Security and code quality checks
  • GitHub Check: Bundle size checks
  • GitHub Check: Unit Tests and Lint

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.
  • @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 Feb 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.49%. Comparing base (d4c79a3) to head (f5904e4).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2066      +/-   ##
===========================================
+ Coverage    61.42%   61.49%   +0.07%     
===========================================
  Files          478      478              
  Lines        16407    16433      +26     
  Branches      3231     3237       +6     
===========================================
+ Hits         10078    10106      +28     
+ Misses        5140     5138       -2     
  Partials      1189     1189              

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

coderabbitai[bot]
coderabbitai bot previously approved these changes Feb 28, 2025
Copy link

github-actions bot commented Feb 28, 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 14.06 KB (+2.91% ▲) 14.1 KB
Plugins - Modern - CDN 5.64 KB 5.64 KB (0%) 6 KB
Common - No bundling 17.93 KB 18.01 KB (+0.42% ▲) 18.4 KB
Load Snippet 765 B 765 B (0%) 1 KB
Core (v1.1) - NPM (ESM) 30.13 KB 30.13 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 30.32 KB 30.32 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 30.16 KB 30.16 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.6 KB 29.6 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (CJS) 29.85 KB 29.85 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (UMD) 29.71 KB 29.71 KB (0%) 30.5 KB
Core (v1.1) - Legacy - CDN 32.03 KB 32.03 KB (0%) 32.5 KB
Core (v1.1) - Modern - CDN 30.01 KB 30.01 KB (0%) 32 KB
Service Worker - Legacy - NPM (ESM) 30.54 KB 30.54 KB (0%) 31 KB
Service Worker - Legacy - NPM (CJS) 30.85 KB 30.85 KB (0%) 31 KB
Service Worker - Legacy - NPM (UMD) 30.69 KB 30.69 KB (0%) 31 KB
Service Worker - Modern - NPM (ESM) 25.73 KB 25.73 KB (0%) 26 KB
Service Worker - Modern - NPM (CJS) 26 KB 26 KB (0%) 26.5 KB
Service Worker - Modern - NPM (UMD) 25.75 KB 25.75 KB (0%) 26 KB
Core - Legacy - NPM (ESM) 47.38 KB 47.72 KB (+0.74% ▲) 48 KB
Core - Legacy - NPM (CJS) 47.66 KB 47.97 KB (+0.67% ▲) 48 KB
Core - Legacy - NPM (UMD) 47.46 KB 47.8 KB (+0.7% ▲) 48 KB
Core - Legacy - CDN 47.54 KB 47.84 KB (+0.62% ▲) 48 KB
Core - Modern - NPM (ESM) 26.85 KB 26.85 KB (0%) 27 KB
Core - Modern - NPM (CJS) 27.11 KB 27.11 KB (0%) 27.2 KB
Core - Modern - NPM (UMD) 26.9 KB 26.9 KB (0%) 27 KB
Core - Modern - CDN 27.17 KB 27.17 KB (0%) 27.5 KB
Core (Bundled) - Legacy - NPM (ESM) 47.38 KB 47.72 KB (+0.74% ▲) 48 KB
Core (Bundled) - Legacy - NPM (CJS) 47.62 KB 47.97 KB (+0.74% ▲) 48 KB
Core (Bundled) - Legacy - NPM (UMD) 47.46 KB 47.8 KB (+0.7% ▲) 48 KB
Core (Bundled) - Modern - NPM (ESM) 38.61 KB 38.87 KB (+0.67% ▲) 39 KB
Core (Bundled) - Modern - NPM (CJS) 38.86 KB 39.11 KB (+0.66% ▲) 39.2 KB
Core (Bundled) - Modern - NPM (UMD) 38.64 KB 38.86 KB (+0.58% ▲) 39 KB
Core (Content Script) - Legacy - NPM (ESM) 47.41 KB 47.67 KB (+0.55% ▲) 48 KB
Core (Content Script) - Legacy - NPM (CJS) 47.59 KB 47.93 KB (+0.72% ▲) 48 KB
Core (Content Script) - Legacy - NPM (UMD) 47.41 KB 47.7 KB (+0.62% ▲) 48 KB
Core (Content Script) - Modern - NPM (ESM) 38.51 KB 38.85 KB (+0.91% ▲) 39 KB
Core (Content Script) - Modern - NPM (CJS) 38.75 KB 39.12 KB (+0.94% ▲) 39.2 KB
Core (Content Script) - Modern - NPM (UMD) 38.52 KB 38.84 KB (+0.81% ▲) 39 KB
All Integrations - Legacy - CDN 95.1 KB 95.1 KB (0%) 95.3 KB
All Integrations - Modern - CDN 90.67 KB 90.67 KB (0%) 91 KB

coderabbitai[bot]
coderabbitai bot previously approved these changes Feb 28, 2025
coderabbitai[bot]
coderabbitai bot previously approved these changes Feb 28, 2025
@saikumarrs saikumarrs marked this pull request as ready for review February 28, 2025 11:20
@saikumarrs saikumarrs requested a review from a team as a code owner February 28, 2025 11:20
Copy link

Copy link

@ChryssaAliferi ChryssaAliferi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing and long awaited! 🙌

@saikumarrs saikumarrs merged commit 3113030 into develop Mar 2, 2025
10 checks passed
@saikumarrs saikumarrs deleted the feat.add-event-processing-headers-sdk-2996 branch March 2, 2025 12:13
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.

3 participants