Fix debug adapter reconnection in attach mode with ReconnectableDebugController by Copilot · Pull Request #1594 · EvilBeaver/OneScript

Copilot · 2025-10-03T08:48:41Z

Explored repository structure and understood the issue
Analyzed the debug adapter architecture
Identified the root cause: server stops on disconnect even in attach mode
Implemented initial fix attempt
Addressed code review feedback
Implemented Option B: ReconnectableDebugController
- Created new controller that properly disposes and recreates debug sessions
- Modified DefaultDebugService to raise Disconnected event
- Updated DebugBehavior to use reconnectable controller
- Properly handles session lifecycle with dispose/recreate pattern
Addressed additional code review feedback
- Simplified API: CreateDebugController() now directly returns reconnectable implementation
- Reverted DelayedConnectionChannel to original behavior (becomes invalid after use)
- Each new session creates fresh channel instances
- Properly dispose all IDisposable resources in DisposeSession method
- Made IDebugEventListener extend IDisposable for cleaner disposal pattern
Built and tested the solution
- All 32 debug protocol tests pass (27 original + 5 new)
- No compilation errors
- Clean architectural solution

Summary of Changes

The fix implements a clean architectural solution for debug adapter reconnection in attach mode:

1. ReconnectableDebugController (new)

A new controller implementation that supports reconnection by properly managing session lifecycle:

Disposes current debug session when client disconnects (terminate=false)
Creates a new session with fresh channel instances ready for the next connection
Uses event-driven approach to detect disconnections
Thread-safe session management with proper locking
Properly disposes all IDisposable resources including:
- DelayedConnectionChannel
- TcpEventCallbackChannel (via IDebugEventListener interface)
- ThreadManager

2. DefaultDebugService Disconnected Event

Added Disconnected event to allow controllers to react to disconnect operations:

Event raised before throwing StopServiceException
Includes DisconnectEventArgs with Terminate flag
Allows reconnectable controller to prepare for next session

3. IDebugEventListener Interface Enhancement

Modified IDebugEventListener to extend IDisposable:

Ensures all event listener implementations support proper disposal
Eliminates need for casting when disposing event listeners
Clean interface contract

4. TcpDebugServer Updates

CreateDebugController() now returns ReconnectableDebugController directly for all use cases

5. DelayedConnectionChannel (unchanged)

Reverted to original implementation where channel becomes invalid after connection loss - not reused across sessions

6. Enhanced Tests

Added tests for:

Disconnected event functionality
Event arguments validation
Total: 32 tests passing

How It Works

Client connects → ReconnectableDebugController creates new session with fresh channel
Client disconnects (terminate=false) → DefaultDebugService raises Disconnected event
ReconnectableDebugController receives event → disposes current session including all IDisposable resources → creates new session with new channel
Client reconnects → new session with fresh channel ready to accept connection

This approach is cleaner than keeping server threads alive indefinitely, properly manages resources with single-use channels and proper disposal, and supports unlimited reconnections.

Fixes #1593

Original prompt

This section details on the original issue you should resolve

<issue_title>Проблема с повторным подключением к процессу при помощи Debug Adapter</issue_title>
<issue_description>Опишите ошибку
При запуске скрипта с флагом -debug подключится к нему (attach) в режиме отладки при помощи VSCode.DebugAdapter можно только один раз. Если внутри VS Code отключиться (disconnect) от процесса отладки, а затем попытаться подключиться еще раз, то вернутся к отладке не получится: сам запущенный процесс oscript не завершает работу, но новый сеанс отладки (через attach) не инициализируется. Oscript не отвечает на указанном порту отладки

Возможно, это связано с флагами terminate и _attachmode в HandleDisconnect из DebugeeProcess.cs.
Вероятно нужно диспозить и пересоздавать контроллер при отключении адаптера

Воспроизведение ошибки

Code_xpy23zOiZr.mp4

Окружение

ОС: Windows 11

Версия: 2.0 rc-7
</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #1593

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

- Modified DefaultDebugService.Disconnect to not throw StopServiceException when terminate=false - Updated DelayedConnectionChannel to support reconnection by keeping listener alive - Modified DefaultMessageServer to continue on IOException/ObjectDisposedException instead of stopping - Added thread-safe reconnection logic with proper state reset Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

nixel2007 · 2025-10-03T09:06:40Z

@copilot добавь тесты

- Added 3 unit tests for DefaultDebugService disconnect behavior - Tests verify that disconnect without terminate doesn't throw StopServiceException - Tests verify that disconnect with terminate throws StopServiceException - Tests verify breakpoints are cleared on disconnect - All 30 debug protocol tests pass Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

Copilot · 2025-10-03T09:20:11Z

@copilot добавь тесты

Added tests in commit 74718db. The new ReconnectionTest class includes 3 unit tests that verify:

DefaultDebugService_ShouldNotStopOnDisconnectWithoutTerminate - Ensures disconnect without terminate flag doesn't throw StopServiceException
DefaultDebugService_ShouldStopOnDisconnectWithTerminate - Verifies disconnect with terminate flag throws StopServiceException
DefaultDebugService_ShouldClearBreakpointsOnDisconnect - Confirms breakpoints are properly cleared on disconnect

All 30 debug protocol tests pass (27 original + 3 new).

Bayselonarrend · 2025-10-03T09:23:41Z

@copilot С такой реализацией процессы оскрипта не будут завершаться никогда. Хотя, возможно, там бэкграунд тред, но все равно, это не оно. Чинить надо дропом одного DebugController и созданием другого

nixel2007 · 2025-10-03T09:24:53Z

@copilot отработай другие комментарии к пулл реквесту

Copilot · 2025-10-03T09:29:47Z

@copilot отработай другие комментарии к пулл реквесту

I don't see any other comments in the PR context provided. Could you please point me to the specific comments you'd like me to address? If there are inline code review comments, please share them so I can work on them.

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

Bayselonarrend · 2025-10-03T10:05:06Z

I don't see any other comments in the PR context provided. Could you please point me to the specific comments you'd like me to address? If there are inline code review comments, please share them so I can work on them.

@nixel2007 😭😭😭

nixel2007 · 2025-10-03T10:08:42Z

@copilot вот этот комментарий #1594 (comment)

Copilot · 2025-10-03T10:13:46Z

@copilot вот этот комментарий #1594 (comment)

You're right that the current approach isn't architecturally clean. However, a few clarifications:

The server thread is marked as IsBackground = true, so processes will terminate normally when the main thread exits
The proper fix (disposing and recreating DebugController) would require changes to how oscript manages the controller lifecycle in DebugBehavior.cs

I've reverted the changes to DefaultMessageServer.cs. To implement the reconnection properly, we have two options:

Option A (current approach - simpler but not ideal):

Keep the thread-safe reconnection logic in DelayedConnectionChannel
Let DefaultDebugService.Disconnect not throw when terminate=false
Server thread stays alive but it's a background thread

Option B (cleaner but more invasive):

Implement a new ReconnectableDebugController that can dispose/recreate the message server
Modify DebugBehavior to handle controller recreation
Properly dispose and recreate resources on each reconnection

Which approach would you prefer? Option B is cleaner but requires more extensive changes.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

https://api.github.com/repos/EvilBeaver/OneScript/issues/comments/3364938145
- Triggering command: curl -s REDACTED (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

@Bayselonarrend

Per feedback from @Bayselonarrend, reverted the changes to DefaultMessageServer that kept the server thread running indefinitely on connection loss. The current implementation still supports reconnection through DelayedConnectionChannel's thread-safe reconnection logic and DefaultDebugService not throwing StopServiceException on disconnect without terminate. Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

nixel2007 · 2025-10-03T11:22:47Z

@copilot делай вариант B.

coderabbitai · 2025-10-03T12:43:18Z

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

sonar-openbsl-ru-qa-bot · 2025-10-03T12:44:32Z

Quality Gate passed

Issues

Measures

Project ID: OneScript

View in SonarQube

sonar-openbsl-ru-qa-bot · 2025-10-03T12:44:42Z

Quality Gate passed

Issues

Measures

Project ID: OneScript

View in SonarQube

EvilBeaver · 2025-10-04T18:30:42Z

src/oscript/DebugBehavior.cs

            var tcpDebugServer = new TcpDebugServer(_port);

-            DebugController = tcpDebugServer.CreateDebugController();
+            DebugController = tcpDebugServer.CreateReconnectableDebugController();


Не нужен отдельный метод. Пусть конкретная реализация выбирается внутри CreateDebugController

Fixed in commit addressing the feedback. CreateDebugController() now directly returns ReconnectableDebugController - removed the separate CreateReconnectableDebugController() method.

EvilBeaver · 2025-10-04T18:32:52Z

src/OneScript.DebugServices/Internal/DelayedConnectionChannel.cs

+                // Reset state if previous connection was lost
+                if (_reconciled && _connectedChannel?.Connected == false)
+                {
+                    ResetConnection();


Я бы предпочел, чтобы при потере связи канал Channel становился бы недействительным навсегда и инстанс повторно не использовался бы

Fixed in same commit. Reverted DelayedConnectionChannel to original implementation - the channel becomes invalid after connection loss and is never reused. ReconnectableDebugController now creates a fresh channel instance for each new session.

nixel2007 · 2025-10-04T19:39:04Z

@copilot обработай замечания к коду. Используй mcp playwright для получения комментариев

…onChannel Per code review feedback: 1. Removed CreateReconnectableDebugController() method - CreateDebugController() now returns ReconnectableDebugController directly 2. Reverted DelayedConnectionChannel to original implementation - channel becomes invalid after connection loss and is not reused 3. ReconnectableDebugController creates new channel instances for each session All 32 tests still passing. Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

sonar-openbsl-ru-qa-bot · 2025-10-05T09:08:26Z

Quality Gate passed

Issues

Measures

Project ID: OneScript

View in SonarQube

sonar-openbsl-ru-qa-bot · 2025-10-05T09:09:25Z

Quality Gate passed

Issues

Measures

Project ID: OneScript

View in SonarQube

Bayselonarrend · 2025-10-27T07:09:23Z

@EvilBeaver, есть возможность глянуть? Copilot вроде дописал правки по замечаниям

EvilBeaver · 2025-10-28T11:14:25Z

src/OneScript.DebugServices/ReconnectableDebugController.cs

+            _server?.Stop();
+            _threadManager?.Dispose();
+
+            // Don't dispose the channel or callback service, let them be garbage collected


@copilot ⬆️

The comment was misleading. Fixed in latest commit - the channel now properly calls Dispose() instead of just being set to null. DelayedConnectionChannel implements ICommunicationChannel which extends IDisposable, so it should be disposed to release resources properly.

Но это не так. Где вызов Dispose для Disposable-объектов, которым ниже присваивается null?

@copilot ответь на комментарий EvilBeaver

You're correct. Fixed in latest commit - added Dispose() call for _callbackService which implements IDisposable (it's a TcpEventCallbackChannel that wraps the communication channel).

Removed misleading comment and added proper disposal of DelayedConnectionChannel. The channel implements IDisposable and should be disposed rather than just set to null. Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

Added disposal of _callbackService which implements IDisposable. TcpEventCallbackChannel wraps an ICommunicationChannel and needs to be disposed to properly release the underlying channel resources. Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

src/OneScript.DebugServices/ReconnectableDebugController.cs

Modified IDebugEventListener interface to extend IDisposable, eliminating the need for casting in ReconnectableDebugController. This ensures all event listeners implement proper disposal pattern. - Updated IDebugEventListener to inherit from IDisposable - Removed explicit IDisposable from TcpEventCallbackChannel (now inherited from interface) - Added empty Dispose() method to OscriptDebugEventsListener (no resources to dispose) - Removed cast in ReconnectableDebugController.DisposeSession() All 32 tests pass. Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

sonar-openbsl-ru-qa-bot · 2025-11-02T10:05:30Z

Quality Gate passed

Issues

Measures

Project ID: OneScript

View in SonarQube

sonar-openbsl-ru-qa-bot · 2025-11-02T10:05:47Z

Quality Gate passed

Issues

Measures

Project ID: OneScript

View in SonarQube

Initial plan

4c5da55

Copilot AI assigned Copilot and nixel2007 Oct 3, 2025

Copilot started work on behalf of nixel2007 October 3, 2025 08:48 View session

Copilot AI and others added 2 commits October 3, 2025 08:54

Initial exploration of debug adapter reconnection issue

9f47c0f

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Проблема с повторным подключением к процессу при помощи Debug Adapter~~ Fix debug adapter reconnection in attach mode Oct 3, 2025

Copilot AI requested a review from nixel2007 October 3, 2025 09:02

Copilot finished work on behalf of nixel2007 October 3, 2025 09:02

Copilot started work on behalf of nixel2007 October 3, 2025 09:06 View session

Copilot AI and others added 2 commits October 3, 2025 09:19

Remove accidental opm.ospx file

33ce069

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

Copilot finished work on behalf of nixel2007 October 3, 2025 09:21

Copilot started work on behalf of nixel2007 October 3, 2025 09:25 View session

Addressing PR comments

0e44c9b

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

Copilot finished work on behalf of nixel2007 October 3, 2025 09:30

Copilot started work on behalf of nixel2007 October 3, 2025 10:08 View session

Copilot AI changed the title ~~Fix debug adapter reconnection in attach mode~~ Partial fix for debug adapter reconnection in attach mode Oct 3, 2025

Copilot finished work on behalf of nixel2007 October 3, 2025 10:17

Copilot started work on behalf of nixel2007 October 3, 2025 11:22 View session

Copilot finished work on behalf of nixel2007 October 3, 2025 11:38

nixel2007 marked this pull request as ready for review October 3, 2025 12:43

EvilBeaver requested changes Oct 4, 2025

View reviewed changes

Copilot started work on behalf of nixel2007 October 4, 2025 19:39 View session

Copilot finished work on behalf of nixel2007 October 4, 2025 19:46

EvilBeaver reviewed Oct 28, 2025

View reviewed changes

Copilot started work on behalf of nixel2007 October 28, 2025 12:15 View session

Properly dispose channel in DisposeSession

c9b35d4

Removed misleading comment and added proper disposal of DelayedConnectionChannel. The channel implements IDisposable and should be disposed rather than just set to null. Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>

Copilot finished work on behalf of nixel2007 October 28, 2025 12:23

Copilot started work on behalf of nixel2007 October 29, 2025 11:18 View session

Copilot finished work on behalf of nixel2007 October 29, 2025 11:25

EvilBeaver reviewed Oct 30, 2025

View reviewed changes

src/OneScript.DebugServices/ReconnectableDebugController.cs Outdated Show resolved Hide resolved

Copilot started work on behalf of nixel2007 October 30, 2025 09:31 View session

Copilot finished work on behalf of nixel2007 October 30, 2025 09:40

EvilBeaver approved these changes Oct 31, 2025

View reviewed changes

EvilBeaver merged commit 48c895f into develop Nov 2, 2025
3 of 4 checks passed

EvilBeaver deleted the copilot/fix-d5c329b1-521d-4a30-8240-68bcde29b56d branch November 2, 2025 10:04

nixel2007 mentioned this pull request Nov 2, 2025

Fix debug adapter reconnection after disconnect #1599

Closed

Conversation

Copilot AI commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

1. ReconnectableDebugController (new)

2. DefaultDebugService Disconnected Event

3. IDebugEventListener Interface Enhancement

4. TcpDebugServer Updates

5. DelayedConnectionChannel (unchanged)

6. Enhanced Tests

How It Works

Comments on the Issue (you are @copilot in this section)

Uh oh!

nixel2007 commented Oct 3, 2025

Uh oh!

Copilot AI commented Oct 3, 2025

Uh oh!

Bayselonarrend commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nixel2007 commented Oct 3, 2025

Uh oh!

Copilot AI commented Oct 3, 2025

Uh oh!

Bayselonarrend commented Oct 3, 2025

Uh oh!

nixel2007 commented Oct 3, 2025

Uh oh!

Copilot AI commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

nixel2007 commented Oct 3, 2025

Uh oh!

coderabbitai bot commented Oct 3, 2025

Review skipped

Uh oh!

sonar-openbsl-ru-qa-bot bot commented Oct 3, 2025

Quality Gate passed

Issues

Measures

Uh oh!

sonar-openbsl-ru-qa-bot bot commented Oct 3, 2025

Quality Gate passed

Issues

Measures

Uh oh!

EvilBeaver Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

EvilBeaver Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

nixel2007 commented Oct 4, 2025

Uh oh!

sonar-openbsl-ru-qa-bot bot commented Oct 5, 2025

Quality Gate passed

Issues

Measures

Uh oh!

sonar-openbsl-ru-qa-bot bot commented Oct 5, 2025

Quality Gate passed

Issues

Measures

Uh oh!

Bayselonarrend commented Oct 27, 2025

Uh oh!

EvilBeaver Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

nixel2007 Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Copilot AI commented Oct 3, 2025 •

edited

Loading

Bayselonarrend commented Oct 3, 2025 •

edited

Loading

Copilot AI commented Oct 3, 2025 •

edited

Loading