Skip to content

feat(SymbolProvider): отмена запроса workspace/symbol через CancelChecker#4094

Merged
nixel2007 merged 1 commit into
developfrom
claude/workspacesymbol-cancel
Jun 13, 2026
Merged

feat(SymbolProvider): отмена запроса workspace/symbol через CancelChecker#4094
nixel2007 merged 1 commit into
developfrom
claude/workspacesymbol-cancel

Conversation

@nixel2007

@nixel2007 nixel2007 commented Jun 13, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Проблема

Клиент LSP шлёт workspace/symbol на каждое нажатие клавиши, но сервер выполнял каждый запрос целиком: ранее BSLWorkspaceService.symbol использовал CompletableFuture.supplyAsync, у которого нет механизма отмены. Устаревшие запросы продолжали обходить все документы рабочей области, нагружая сервер впустую.

Решение

  • BSLWorkspaceService.symbol переведён с CompletableFuture.supplyAsync на CompletableFutures.computeAsync, который передаёт CancelChecker в задачу.
  • SymbolProvider.getSymbols теперь принимает CancelChecker и проверяет отмену на границе каждого документа через .peek(documentContext -> cancelChecker.checkCanceled()). При отмене обход прерывается CancellationException.
  • Перегрузка getSymbols(WorkspaceSymbolParams) без checker-а убрана; все вызовы (в т.ч. в тестах) переведены на новую сигнатуру.

Сопоставление имён остаётся прежним (regex с откатом на литерал при невалидном выражении) — это PR только про отмену.

Тесты

  • getSymbolsCancelledCheckerInterruptsSearch — отменённый checker прерывает обход CancellationException.
  • getSymbolsNonCancelledCheckerReturnsFullResult — не-отменённый checker не влияет на результат.
  • Существующие тесты SymbolProviderTest, SymbolProviderOScriptConstructorTest, SymbolProviderScriptVariantTest переведены на новую сигнатуру.

./gradlew test --tests "*SymbolProviderTest" — BUILD SUCCESSFUL.

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

  • Improvements

    • Symbol search now supports request cancellation, enabling users to interrupt long-running workspace searches mid-operation for better responsiveness during document traversal.

  • Tests

    • Added comprehensive test coverage for cancellation behavior in symbol search operations.

@nixel2007 @claude
feat(SymbolProvider): отмена запроса workspace/symbol через CancelChe…
a6c6a57 
…cker

BSLWorkspaceService.symbol переведён с CompletableFuture.supplyAsync на
CompletableFutures.computeAsync с CancelChecker, что позволяет прерывать
устаревшие запросы (клиент шлёт новый запрос на каждое нажатие клавиши).
Метод SymbolProvider.getSymbols теперь принимает CancelChecker и проверяет
отмену на границе каждого документа через peek; перегрузка без checker-а
убрана, все вызовы переведены на новую сигнатуру.

Co-Authored-By: Claude Fable 5 <[email protected]>
@coderabbitai

coderabbitai Bot commented Jun 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: cce15884-c5e5-49e8-8d3e-882b556c6c62

📥 Commits

Reviewing files that changed from the base of the PR and between 5aea4a0 and a6c6a57.

📒 Files selected for processing (5)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/BSLWorkspaceService.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/providers/SymbolProvider.java
  • src/test/java/com/github/_1c_syntax/bsl/languageserver/providers/SymbolProviderOScriptConstructorTest.java
  • src/test/java/com/github/_1c_syntax/bsl/languageserver/providers/SymbolProviderScriptVariantTest.java
  • src/test/java/com/github/_1c_syntax/bsl/languageserver/providers/SymbolProviderTest.java
📝 Walkthrough

Walkthrough

The PR adds cancellation support to the workspace symbol search API. SymbolProvider.getSymbols() now accepts a CancelChecker parameter and checks for cancellation at document boundaries during traversal. BSLWorkspaceService.symbol() handler delegates to CompletableFutures.computeAsync to integrate cancellation tokens. All tests are updated to provide a CancelChecker, with new tests verifying cancellation exception propagation and non-cancelled search behavior.

Changes

Workspace Symbol Search Cancellation Support

Layer / File(s) Summary
SymbolProvider cancellation API
src/main/java/com/github/_1c_syntax/bsl/languageserver/providers/SymbolProvider.java		 getSymbols() method signature updated to accept CancelChecker parameter. Javadoc documents cancellation at document boundaries. Implementation adds stream peek that calls cancelChecker.checkCanceled() to interrupt traversal mid-walk.
BSLWorkspaceService symbol handler integration
src/main/java/com/github/_1c_syntax/bsl/languageserver/BSLWorkspaceService.java		 LSP handler imports CompletableFutures and updates symbol() to use computeAsync(executor, cancelChecker -> ...) instead of supplyAsync, delegating to symbolProvider.getSymbols(params, cancelChecker).
Test updates and cancellation behavior verification
src/test/java/com/github/_1c_syntax/bsl/languageserver/providers/SymbolProviderTest.java, SymbolProviderOScriptConstructorTest.java, SymbolProviderScriptVariantTest.java		 All test files updated to pass CancelChecker when calling getSymbols(). SymbolProviderTest introduces NO_CANCEL constant and new test cases verifying CancellationException propagation and non-cancelled search results.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A canceller now guards the symbol search,
Peeking through documents, ready to lurch,
When tokens are cancelled mid-query stride,
The checker stops short—no symbols can hide!
Async and tested, the handler's delight,
Our rabbit approves! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 8.33% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: adding request cancellation support to workspace/symbol search via CancelChecker.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/workspacesymbol-cancel

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@nixel2007 nixel2007 mentioned this pull request Jun 13, 2026
Closed
@nixel2007
nixel2007 merged commit 01a0cba into develop Jun 13, 2026
18 checks passed
@nixel2007
nixel2007 deleted the claude/workspacesymbol-cancel branch June 13, 2026 10:11
This was referenced Jun 13, 2026
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@nixel2007