feat: add more next edit endpoints to protocol

[jpoly1219]

Description

Closes CON-3444.

Adds more endpoint for next edit and updates protocol.

AI Code Review

• Team members only: AI review runs automatically when PR is opened or marked ready for review
• Team members can also trigger a review by commenting @continue-review

Checklist

• I've read the contributing guide
• The relevant docs, if any, have been updated or created
• The relevant tests, if any, have been updated or created

Screen recording or screenshot

[ When applicable, please include a short screen recording or screenshot - this makes it much easier for us as contributors to review and understand your changes. See this PR as a good example. ]

Tests

[ What tests were added or updated to ensure the changes work as expected? ]

---

Summary by cubic

Added new Next Edit endpoints to the protocol, allowing more control over edit chains and queue processing.

• New Features
• Added handlers for starting, deleting, and checking the status of edit chains.
• Added queue endpoints for processing, clearing, aborting, and retrieving processed edits.
• Updated protocol definitions and passthrough lists to support these endpoints.

[github-actions]

Code Review Summary

✅ Strengths

• Architecture: The implementation follows a well-structured pattern with proper separation of concerns between the PrefetchQueue, NextEditProvider, and protocol layers
• Singleton Pattern: Good use of singleton pattern for both PrefetchQueue and NextEditProvider, ensuring single instances throughout the application
• Error Handling: Comprehensive error handling with try-catch blocks and proper abort signal management
• Logging: Extensive console logging for debugging purposes throughout the new functionality

⚠️ Issues Found

High

• Excessive Console Logging: The code contains numerous console.log statements that should not be in production code. These will clutter logs and potentially impact performance.

Medium

• Missing Type Safety: The processOne method in PrefetchQueue accepts ctx: any, which bypasses TypeScript's type checking. This should use proper typing from the AutocompleteInput interface.

• State Management Concerns: The PrefetchQueue maintains both unprocessedQueue and processedQueue arrays but doesn't have clear lifecycle management or memory limits. This could lead to memory issues with large queues.

• Missing Error Recovery: While there's error handling in the process loop, there's no mechanism to retry failed items or notify the caller about failures.

Low

• Inconsistent Property Access: In NextEditPrefetchQueue, the usingFullFileDiff property is initialized but never properly set through the unused initialize method.

• Commented Code: There are several blocks of commented-out code that should be removed if no longer needed (e.g., in NextEditProvider.ts lines 577-578).

• Magic Numbers: The default prefetch limit of 3 is hardcoded without explanation of why this value was chosen.

💡 Suggestions

• Add Proper TypeScript Types: Define a proper interface for the ctx parameter in processOne to ensure type safety:

  interface ProcessContext extends Omit<AutocompleteInput, 'pos' | 'filepath'> {
    // additional fields if needed
  }

• Implement Queue Size Limits: Add maximum queue size limits to prevent unbounded memory growth:

  private readonly MAX_QUEUE_SIZE = 100;
  
  enqueueUnprocessed(location: RangeInFile): void {
    if (this.unprocessedQueue.length >= this.MAX_QUEUE_SIZE) {
      this.unprocessedQueue.shift(); // Remove oldest
    }
    this.unprocessedQueue.push(location);
  }

• Add Metrics/Monitoring: Consider adding proper metrics instead of console.logs for production monitoring:

  private metrics = {
    processed: 0,
    failed: 0,
    aborted: 0
  };

• Implement Proper Initialization: Either use the initialize method or remove it:

  constructor(prefetchLimit: number = 3, usingFullFileDiff: boolean = true) {
    this.prefetchLimit = prefetchLimit;
    this.usingFullFileDiff = usingFullFileDiff;
    this.abortController = new AbortController();
  }

• Add Unit Tests: No tests are included for the new PrefetchQueue functionality. Consider adding tests for queue operations, abort behavior, and edge cases.

🚀 Overall Assessment

REQUEST_CHANGES

The implementation adds valuable prefetching functionality to the NextEdit feature, but requires cleanup before merging. The main concerns are:

1. Remove all console.log statements or replace with proper logging
2. Fix the type safety issue with the any type in processOne
3. Consider adding memory management for the queues
4. Add proper initialization or remove the unused method

The architecture is sound and the feature appears well-integrated with the existing codebase, but these issues should be addressed to maintain code quality and prevent potential production issues.

[sestinj]

🎉 This PR is included in version 1.5.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[sestinj]

🎉 This PR is included in version 1.7.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀