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: batch entry retry #1918

Merged
merged 2 commits into from
Nov 12, 2024

Conversation

saikumarrs
Copy link
Member

@saikumarrs saikumarrs commented Nov 12, 2024

PR Description

This PR fixes, #1917.

When a batch request fails and is retryable, as part of the requeue action, the entry which is an array of individual events is added to the "batch" queue in the batching mode.

The batch queue should only contain single event items and when it is time to dispatch a batch, we generate a queue item out of all those events.

Since an array of events is added to the batch queue, it fails at the next processing step.

I've updated the RetryQueue module to mark the entries explicitly as batch and single. This way, only single event items are added to the batch queue preventing this issue and successful retries of those entries.

Moreover, while reclaiming stale queues that may not contain this item-type parameter, we temporarily determine it based on the contents of the item.
This will not be needed in the long run.

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-2606/fix-retry-of-batched-requests

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.

@saikumarrs saikumarrs self-assigned this Nov 12, 2024
@saikumarrs saikumarrs requested a review from a team as a code owner November 12, 2024 06:03
Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (2)
  • main
  • develop

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.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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 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 Nov 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (hotfix/revert-sanitization@890fb7b). Learn more about missing BASE report.

Additional details and impacted files
@@                      Coverage Diff                      @@
##             hotfix/revert-sanitization    #1918   +/-   ##
=============================================================
  Coverage                              ?   57.52%           
=============================================================
  Files                                 ?      485           
  Lines                                 ?    16505           
  Branches                              ?     3310           
=============================================================
  Hits                                  ?     9494           
  Misses                                ?     5742           
  Partials                              ?     1269           

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

Copy link

github-actions bot commented Nov 12, 2024

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Plugins Module Federation Mapping - Legacy - CDN 332 B 332 B (0%) 512 B
Plugins - Legacy - CDN 15.62 KB 15.71 KB (+0.57% ▲) 16 KB
Plugins Module Federation Mapping - Modern - CDN 331 B 331 B (0%) 512 B
Plugins - Modern - CDN 7.2 KB 7.2 KB (0%) 7.5 KB
Common - No bundling 16.27 KB 16.27 KB (0%) 16.5 KB
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.53 KB 1.53 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
Load Snippet 778 B 778 B (0%) 1 KB
Core (v1.1) - NPM (ESM) 30.32 KB 30.32 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 30.52 KB 30.52 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 30.36 KB 30.36 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.88 KB 29.88 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (CJS) 30.08 KB 30.08 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (UMD) 29.92 KB 29.92 KB (0%) 30 KB
Core - Legacy - CDN 48.44 KB 48.5 KB (+0.14% ▲) 49 KB
Core - Modern - CDN 24.78 KB 24.78 KB (0%) 25 KB
Core - Legacy - NPM (ESM) 48.3 KB 48.4 KB (+0.21% ▲) 48.5 KB
Core - Legacy - NPM (CJS) 48.52 KB 48.6 KB (+0.18% ▲) 49 KB
Core - Legacy - NPM (UMD) 48.29 KB 48.36 KB (+0.15% ▲) 48.5 KB
Core - Modern - NPM (ESM) 24.53 KB 24.53 KB (0%) 25 KB
Core - Modern - NPM (CJS) 24.72 KB 24.72 KB (0%) 25 KB
Core - Modern - NPM (UMD) 24.53 KB 24.53 KB (0%) 25 KB
Core (Bundled) - Legacy - NPM (ESM) 48.3 KB 48.4 KB (+0.21% ▲) 48.5 KB
Core (Bundled) - Legacy - NPM (CJS) 48.5 KB 48.63 KB (+0.27% ▲) 49 KB
Core (Bundled) - Legacy - NPM (UMD) 48.29 KB 48.36 KB (+0.15% ▲) 48.5 KB
Core (Bundled) - Modern - NPM (ESM) 39.41 KB 39.48 KB (+0.2% ▲) 40 KB
Core (Bundled) - Modern - NPM (CJS) 39.65 KB 39.75 KB (+0.27% ▲) 40 KB
Core (Bundled) - Modern - NPM (UMD) 39.39 KB 39.47 KB (+0.19% ▲) 40 KB
Core (Content Script) - Legacy - NPM (ESM) 47.73 KB 47.81 KB (+0.16% ▲) 48 KB
Core (Content Script) - Legacy - NPM (CJS) 47.98 KB 48.06 KB (+0.16% ▲) 48.5 KB
Core (Content Script) - Legacy - NPM (UMD) 47.7 KB 47.75 KB (+0.11% ▲) 48 KB
Core (Content Script) - Modern - NPM (ESM) 38.82 KB 38.91 KB (+0.25% ▲) 39.5 KB
Core (Content Script) - Modern - NPM (CJS) 39.11 KB 39.24 KB (+0.35% ▲) 40 KB
Core (Content Script) - Modern - NPM (UMD) 38.89 KB 38.93 KB (+0.11% ▲) 39 KB
Service Worker - Legacy - NPM (ESM) 30.59 KB 30.59 KB (0%) 31 KB
Service Worker - Legacy - NPM (CJS) 30.86 KB 30.86 KB (0%) 31 KB
Service Worker - Legacy - NPM (UMD) 30.64 KB 30.64 KB (0%) 31 KB
Service Worker - Modern - NPM (ESM) 25.74 KB 25.74 KB (0%) 26 KB
Service Worker - Modern - NPM (CJS) 26 KB 26 KB (0%) 26.5 KB
Service Worker - Modern - NPM (UMD) 25.77 KB 25.77 KB (0%) 26 KB
All Integrations - Legacy - CDN 94.83 KB 94.83 KB (0%) 95.3 KB
All Integrations - Modern - CDN 89.92 KB 89.92 KB (0%) 91 KB

Copy link

sonarcloud bot commented Nov 12, 2024

@saikumarrs saikumarrs merged commit ff346b8 into hotfix/revert-sanitization Nov 12, 2024
10 checks passed
@saikumarrs saikumarrs deleted the fix.batch-retry-logic-sdk-2606 branch November 12, 2024 07:03
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.

2 participants