Spurious warning: "Unmatched cancel notification"
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript, vscode
- Domain
- developer-experience, tooling
Research direction
Start by locating the vscode-jsonrpc dependency and the cancellation-handling entry point; reproduce the issue by starting a query, cancelling it, and reading the CodeQL Query Server log. Review the upgrade-related changes, then verify that cancellation no longer emits the unmatched-warning line while the query server remains functional.
Written by the indexing model from the issue text.
Description
TL;DR: vscode-jsonrpc should be upgraded.
Describe the bug
Spurious warnings can appear in the "CodeQL Query Server" log when a query is cancelled. I just got the following message when I cancelled during query compilation, and we have a report of the same message during evaluation in an internal issue:
Mar 01, 2022 9:18:52 AM org.eclipse.lsp4j.jsonrpc.RemoteEndpoint handleCancellation
WARNING: Unmatched cancel notification for request id 8
There are sometimes bugs with cancellation in the CodeQL engine itself, and these spurious error messages can make it harder to pinpoint the problem, as evidenced in the internal issue.
@alexet wrote this on the internal issue:
Just for reference from previous investigations
WARNING: Unmatched cancel notification for request id 64is a known benign bug in the old version of
vscode-jsonrpcthat we use where it forgets to listen to cancellation after completing a request. Upgradingvscode-jsonrpcshould in theory fix it, but it came with quite a few other changes that made the upgrade non-trivial. The message means that we are still trying to cancel the compilation step but it is done.
Version
CLI 2.8.1, extension 1.5.9 for VSCode 1.64.2. I'm on Linux, and the other bug report came from a Mac user.
To reproduce
Look at the "CodeQL Query Server" log output. Start a query and cancel it.
Expected behavior
I don't expect to see the line with WARNING. I'm not sure whether I expect to see the line with handleCancellation; it's probably fine.
- Dominant language
- TypeScript
- Stars
- 539
- Forks
- 240
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 29
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/vscode-codeql
-
bug VSCode
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/vscode-codeql#4471 · 1 comment ·
-
bug enhancement VSCode
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/vscode-codeql#592 · 2 comments ·
-
enhancement VSCode
Difficulty 3/5 1-2 days Newbie friendliness 55/100
github/vscode-codeql#4432 · 1 comment ·
-
bug VSCode
Difficulty 3/5 1-2 days Newbie friendliness 52/100
github/vscode-codeql#4356 ·
-
bug VSCode
Difficulty 3/5 1-2 days Newbie friendliness 64/100
github/vscode-codeql#4339 · 1 comment ·
All issues in github/vscode-codeql
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
safetrustcr/dApp-SafeTrust#426 ·
-
area:workflow bug ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
fil-donadoni/tolaria#4409 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Fission-AI/OpenSpec#1960 ·
-
Add dependabot Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
corsairdev/corsair#1764 ·