ipython / ipython/ipykernel

Debugger does not conform to DAP specification

Abierto
#1,303 1 comentario 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Python
Estrellas
734
Forks
412
Merge medio
1 d 5 h
PR fusionados (30 d)
8

Descripción

Per Microsoft's [documentation for the Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/), a DAP client should send the `launch/attach` request _in parallel_ with the various configuration requests, such as `setBreakpoints` and `setExceptionBreakpoints`. Only once those configuration requests have received responses should the client send `configurationDone`, at which time the adapter will return a response to the original `launch/attach` request. This allows the adapter to fully configure itself before the client considers itself attached.

ipykernel does not currently conform to this specification. It includes a [`_handle_init_sequence`](https://github.com/ipython/ipykernel/blob/main/ipykernel/debugger.py#L252) method which manually sends the `configurationDone` request to the adapter rather than use the original one from the client. It does this in response to the original `attach` request, too, well before the client would have sent that message itself.

**This is problematic because:**
1. This method assumes DAP to work synchronously, whereas by definition the initialization sequence is meant to be conducted in parallel
2. The `configurationDone` request may make it to the adapter before the actual configuration requests (`setBreakpoints`...). This may cause issues (which we have actually seen) where the DAP client receives a response to `attach` before the adapter is done configuring. This leads to breakpoints not being set in time and ultimately being missed.

**The root of this problem** is the synchronous handling of DAP requests by ipykernel; the kernel cannot send Request B until Request A receives a response, so this parallel nature of initialization is currently not possible to conform to.

**The solution to this problem** would be to change how ipykernel handles DAP requests. One solution would be to use a queue to which requests are pushed, similar to how responses are handled. We can implement a working solution and submit a PR, if the maintainers are okay with it.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.