eclipse-theia/theia

debug: add support for 'showUser'

Open

#7,808 opened on May 13, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (18,676 stars) (2,478 forks)batch import
dapdebugenhancementhelp wanted

Description

Feature Description:

The message specification for the debug adapter protocol has a property known as showUser which is used to display notifications to end-users in the event of an error from a request.

At the moment, the framework does not have handling for such a property nor does it display notifications to end-users similarly to vscode. We should similarly add support for showUser and properly handle displaying notifications to end-users in the event of errors.

Additional Information

Contributor guide

Tech stack
typescript
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptdebug adapter protocolTheia debug framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the VSCode implementation at https://github.com/microsoft/vscode/blob/77b5058284a50445674ee3b237ad64793b38965e/src/vs/workbench/contrib/debug/browser/rawDebugSession.ts#L672 L674 to understand how 'showUser' is handled. Then locate the corresponding debug request handling in the Theia framework, likely in packages/debug/src/browser/debug session.ts or similar. Also check the referenced discussion (https://github.com/eclipse theia/theia/discussions/7786) for additional context. Implement a mechanism to display notifications to users when a debug request returns an error with 'showUser' set to true.