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(queue-bundle): wait for bundle to be saved to respond #265

Merged
merged 2 commits into from
Jan 9, 2025

Conversation

karlprieb
Copy link
Collaborator

No description provided.

@karlprieb karlprieb requested a review from djwhitt January 9, 2025 21:42
Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.23%. Comparing base (4126ab4) to head (2f5486a).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #265   +/-   ##
========================================
  Coverage    71.23%   71.23%           
========================================
  Files           35       35           
  Lines         9060     9060           
  Branches       536      536           
========================================
  Hits          6454     6454           
  Misses        2602     2602           
  Partials         4        4           

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

Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

error @permaweb/aoconnect@0.0.57: The engine "yarn" is incompatible with this module. Expected version "please-use-npm". Got "1.22.22"
error Found incompatible module.

📝 Walkthrough

Walkthrough

This pull request introduces enhancements to error handling and data processing across multiple files. In scripts/import-data/utils.ts, the fetchWithRetry function now includes additional error handling for 503 status codes, and the getFilesInRange function improves file filtering and sorting logic. The src/routes/ar-io.ts file modifies the bundle queuing route to use a new queueBundle method with improved error handling. In src/system.ts, the queueBundle function is updated to return a structured response with more detailed status information.

Changes

File Change Summary
scripts/import-data/utils.ts - Enhanced fetchWithRetry to handle 503 status codes with more detailed error logging
- Improved getFilesInRange with more robust file matching and numerical sorting
src/routes/ar-io.ts - Removed events module import
- Added imports for NormalizedDataItem and PartialJsonTransaction
- Updated /ar-io/admin/queue-bundle route to use system.queueBundle with error handling
src/system.ts - Modified queueBundle function to return QueueBundleResponse
- Added explicit return states: 'skipped', 'queued', 'error'
- Removed previous event listener for bundle queuing

Sequence Diagram

sequenceDiagram
    participant Route as AR-IO Admin Route
    participant System as System Module
    participant Queue as Bundle Queue

    Route->>System: queueBundle(bundleData)
    alt Bundle is valid
        System->>Queue: Add bundle
        System-->>Route: Return { status: 'queued' }
    else Bundle is null
        System-->>Route: Return { status: 'skipped' }
    else Queuing fails
        System-->>Route: Return { status: 'error', error: message }
    end
Loading

Possibly related PRs

Suggested reviewers

  • djwhitt

📜 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 82f5eac and 2f5486a.

📒 Files selected for processing (3)
  • scripts/import-data/utils.ts (2 hunks)
  • src/routes/ar-io.ts (2 hunks)
  • src/system.ts (2 hunks)
🔇 Additional comments (5)
scripts/import-data/utils.ts (2)

37-40: LGTM! Enhanced error handling for 503 Service Unavailable responses.

The addition of 503 status code handling improves the robustness of the fetchWithRetry function by gracefully handling service unavailability scenarios.


91-98: LGTM! Improved file filtering and sorting logic.

The changes enhance the robustness and functionality of getFilesInRange:

  1. Early return for non-matching files
  2. Numerical sorting of files based on their names
src/routes/ar-io.ts (1)

218-227: LGTM! Improved error handling in queue-bundle route.

The changes enhance the robustness of the /ar-io/admin/queue-bundle route:

  1. Direct call to queueBundle with proper type casting
  2. Proper error handling with 503 status code response
src/system.ts (2)

482-485: LGTM! Well-defined response type.

The QueueBundleResponse type clearly defines the possible states of the bundle queuing operation.


486-490: LGTM! Enhanced function signature and error handling.

The changes improve the queueBundle function by:

  1. Adding proper return type annotation
  2. Providing explicit return values for all scenarios (skipped, queued, error)
  3. Maintaining consistent error handling

Also applies to: 498-498, 537-537, 543-544

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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.

@djwhitt djwhitt merged commit e62667b into develop Jan 9, 2025
6 checks passed
@djwhitt djwhitt deleted the queue-bundle-response branch January 9, 2025 21:45
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