Improve efficiency of cancelling in progress TaskEvent records in v3 and v4

[ericallam]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: b52c071

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The changes introduce a new bulk cancellation method, cancelEvents, to the EventRepository class, allowing multiple partial events to be cancelled in a single operation. The logic for querying incomplete events is optimized to reduce redundant checks and includes a limit on the number of events fetched. The findMany method in TaskEventStore now supports an optional limit parameter to restrict query results. Code in other modules that previously cancelled events individually has been refactored to use the new bulk cancellation method, and additional debug logging for cancelled event counts is added. No exported API signatures are removed or renamed.

---

📜 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 b74c000 and b52c071.

📒 Files selected for processing (4)

• apps/webapp/app/v3/eventRepository.server.ts (2 hunks)
• apps/webapp/app/v3/runEngineHandlers.server.ts (1 hunks)
• apps/webapp/app/v3/services/cancelTaskRunV1.server.ts (1 hunks)
• apps/webapp/app/v3/taskEventStore.server.ts (3 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

apps/webapp/app/v3/runEngineHandlers.server.ts (2)

packages/core/src/v3/errors.ts (1)

• createJsonErrorObject (222-249)

apps/webapp/app/v3/eventRepository.server.ts (1)

• eventRepository (1319-1319)

apps/webapp/app/v3/eventRepository.server.ts (3)

packages/core/src/v3/index.ts (1)

• omit (48-48)

apps/webapp/app/utils/taskEvent.ts (1)

• calculateDurationFromStart (408-412)

internal-packages/tracing/src/index.ts (1)

• Attributes (7-7)

⏰ Context from checks skipped due to timeout of 90000ms (25)

• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (10, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (9, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 10)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 10)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 10)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
• GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
• GitHub Check: typecheck / typecheck
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (8)

apps/webapp/app/v3/runEngineHandlers.server.ts (1)

312-314: Excellent performance improvement with bulk cancellation!

The refactor from individual cancelEvent calls to a single cancelEvents call significantly improves efficiency by reducing database operations from N to 1. The error object creation using createJsonErrorObject is handled correctly and the error message is properly passed to the bulk operation.

apps/webapp/app/v3/services/cancelTaskRunV1.server.ts (2)

98-98: Good addition of observability metrics.

Adding eventCount to the debug logging provides valuable insight into the cancellation process, making it easier to monitor and debug bulk cancellation operations.

---

101-101: Excellent refactor to bulk cancellation.

The replacement of individual cancelEvent calls with a single cancelEvents call significantly improves performance by reducing database operations. The parameters are correctly passed: events array, cancellation timestamp, and reason.

apps/webapp/app/v3/taskEventStore.server.ts (2)

80-80: Good addition of query limiting capability.

Adding the optional limit parameter maintains backward compatibility while enabling query result size control for performance optimization.

---

114-114: Correct implementation of query limiting.

The limit parameter is properly applied as the take argument to both partitioned and non-partitioned Prisma queries, ensuring consistent behavior across different table configurations.

Also applies to: 125-125

apps/webapp/app/v3/eventRepository.server.ts (3)

329-364: Excellent implementation of bulk cancellation method.

The new cancelEvents method provides significant performance improvements by:

1. Pre-filtering: Only processes partial events, avoiding unnecessary work
2. Bulk insertion: Uses insertMany instead of individual inserts
3. Consistent structure: Maintains the same event structure as the individual cancelEvent method
4. Proper duration calculation: Correctly calculates duration using calculateDurationFromStart

The implementation correctly handles all the event properties including links, events array with cancellation details, and proper status/error flags.

---

439-462: Excellent optimization of incomplete events filtering.

The refactored filtering logic provides significant performance improvements:

1. Single-pass categorization: Replaces multiple array operations with a single loop
2. Set-based lookup: Uses Set<string> for O(1) span ID lookups instead of O(n) array searches
3. Clearer logic: Separates complete and incomplete event identification
4. Early termination: Returns early when no incomplete events are found

The logic correctly identifies:

• Complete events: !isPartial && !isCancelled
• Incomplete events: isPartial && !isCancelled
• Properly excludes cancelled events from consideration

---

436-436: Good addition of query result limiting.

The 500-event limit prevents potential performance issues with large result sets while being generous enough for typical use cases. This aligns well with the bulk operations optimization strategy.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.