Confusing error message when the query server is out of memory

Open
#542 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
tooling

Research direction

No file, test, or entry point is named. Start by locating the query-server out-of-memory handling and the code that displays the existing "Internal Error" dialog; done means OOME is detected and users receive the proposed restart-and-rerun guidance.

Written by the indexing model from the issue text.

Description

bug Complexity: Medium VSCode

The user is not properly notified when the query server runs out of memory. A popup message appears with "Internal Error" on it. There are logs in the query server that state an OOME occurred, but the majority of users will not know where to find that information.

Proposed solution:

  1. Detect when the query server runs out of memory
  2. Open an error message dialog with the following text "The query server has run out of memory and will be restarted. Please run your query again." (Or something like that.)

It would be even better if we could give instructions on how to add more memory to the query server, but I don't think that's possible.

Dominant language
TypeScript
Stars
539
Forks
240
Avg merge
2d 6h
Merged PRs (30d)
29

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/vscode-codeql

All issues in github/vscode-codeql

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.