Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Always insert preset commands when executing commands from DAP #4

Merged
merged 2 commits into from
Feb 28, 2023

Conversation

andyw8
Copy link

@andyw8 andyw8 commented Feb 24, 2023

This is a workaround for ruby#900

We believe there is a race condition relating to the in_subsession? check here:

debug/lib/debug/session.rb

Lines 2578 to 2587 in d7bf3b2

if ::DEBUGGER__::SESSION.in_subsession?
if cmds
commands = [*cmds[1], *cmds[2]].map{|c| c.split(';;').join("\n")}
::DEBUGGER__::SESSION.add_preset_commands cmds[0], commands, kick: false, continue: false
end
else
loc = caller_locations(up_level, 1).first; ::DEBUGGER__.add_line_breakpoint loc.path, loc.lineno + 1, oneshot: true, command: cmds
end
self
end

By making this change we ensure that evaluate always acts as if in_subsession? is true.

@andyw8 andyw8 force-pushed the andyw8/bypass-session-check branch 2 times, most recently from 8d8618a to ab474d2 Compare February 28, 2023 01:45
@andyw8 andyw8 marked this pull request as ready for review February 28, 2023 01:45
Copy link
Member

@st0012 st0012 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works great 👍

I think this is one of the changes that requires binstub and rdbgPath to be picked up in time. Can we mention that in the description too?

Copy link
Member

@st0012 st0012 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops was meant to approve

lib/debug/server_dap.rb Outdated Show resolved Hide resolved
@andyw8 andyw8 changed the title Bypass sesssion check Bypass session check Feb 28, 2023
@andyw8 andyw8 force-pushed the andyw8/bypass-session-check branch 4 times, most recently from a5c2030 to f57495c Compare February 28, 2023 18:25
@andyw8 andyw8 requested a review from st0012 February 28, 2023 18:28
test/protocol/eval_test.rb Outdated Show resolved Hide resolved
And revert the changes in ProtocolTestCase as they're not needed anymore.
@st0012
Copy link
Member

st0012 commented Feb 28, 2023

@vinistock I think this is a very weird case and we probably need to revisit the implementation later. But for now it's working in our testings and we have a basic test case for it too. So I'll merge this once the build runs green and then test it in Core.

# Workaround for https://github.com/ruby/debug/issues/900
# See https://github.com/Shopify/debug/pull/4 for more details
commands = [dbg_expr.split(';;').join("\n")]
::DEBUGGER__::SESSION.add_preset_commands '#debugger', commands, kick: false, continue: false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some questions for my own learning:

  1. What does add_preset_commands do exactly? Is it running the commands?
  2. What is kick: false?
  3. What is continue: false?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vinistock Thank you so much for the questions! After taking a closer look, I found that we can probably handle the case even cleaner (see #8). Let me know if the explanation in its description makes sense.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the description go over these specific questions?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah sorry it only touches 1) but not the rest.

  1. It stores the commands to the Session's preset_command state, but the execution timing of that command depends on Session#wait_command's execution state:
    • If wait_command has reached @ui.readline, then the added preset command will be picked up when the next wait_command_loop iteration. For example, after Session receives another command. This is the most likely scenario.
    • In rare cases, if the preset command is added at the same time wait_command is called, theoretically it'll be executed right away.
  2. When kick: true, it'll trigger the current thread client's on_init event, which will go back to make the session enter a subsession. However, I don't know its exact purpose.
  3. continue: controls if the debugger should continue the program when all preset commands are finished. For example, debugger(do: "bt") would set continue: true and the program would continue after bt is executed. But debugger(pre: "bt") would set continue: false and the program would remain suspended after bt is executed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for the explanations!

@st0012 st0012 changed the title Bypass session check Always insert preset commands when executing commands from DAP Feb 28, 2023
@st0012 st0012 merged commit 8eea4c9 into issues-workaround Feb 28, 2023
@st0012 st0012 deleted the andyw8/bypass-session-check branch March 6, 2023 08:56
st0012 added a commit that referenced this pull request Mar 29, 2023
st0012 added a commit that referenced this pull request Mar 30, 2023
* DAP: use Object#__send__ to avoid name conflicts

* DAP: allow custom request extension in Session class

* Fix bug that "trace line" does not work after stopping trace once

* Increase timeout in debug_code

* Fix warning about unused variable

* Avoid memberless Struct

Related to Ruby bug 19416.

* Remove redundant raw detach test

The test's subject is the `disconnect` request with `restart: false,
terminateDebuggee: <true|false>` arguments, which has been covered by the
tests in `disconnect_dap_test.rb`. So this test case has become obsolete.

Co-authored-by: Andy Waite <13400+andyw8@users.noreply.github.com>

* Always propagate keyword arguments in WebSocketServer

* Fix `::Process::daemon` patch

As discussed here:
ruby@699a31e#r94469355

* Add test

* Use local variables

* Add test for info consts with an expression

Co-authored-by: Andy Waite <andyw8@users.noreply.github.com>

* Fix typo in README

* ⬆️ Update ci ruby versions

* ⏪ Revert Ruby 2.6

* ✏️ Fix typo

* CDP: Support evaluating expression on non-current frame

* CDP: support reattaching in Chrome DevTools

Close ruby#800

* Improved stability for chrome debugging

- Display the greeting message regardless of the status of invocation of
  chrome.

  This allows coming back to the debugger on a new tab when the window
  process by `UI_CDP.run_new_chrome` is killed.

- Handle `Errno::ESRCH` in `UI_CDP.cleanup_reader`.

  When the process by `UI_CDP.run_new_chrome` is killed, re-killing it
  breaks your debugging session and in turn the "debugee".

* Make `UI_ServerBase#puts` to behave like `STDERR#puts`

`UI_ServerBase#greeting` calls `#puts` with no arguments, this
breaks reconnections to the debugger.

* Handle not existing $FILENAME in `Session#process_protocol_request`

`Session#process_protocol_request` gracefully handles `Errno::ENOENT`
when `eval`-ing `$FILENAME`, and it doens't exist.

* free terminated ThreadClients

fix ruby#899

* DAP: use Mutex when sending response

When debug.gem tries to send response from multiple threads, the socket connection is closed. I confirmed this bug when using custom request from vscode-rdbg

* Make sure to fail when remote debuggee does not exit after scenarios

Because Errno::EPIPE is rescued while sending message to socket, protocol_test_case_test.rb does not pass. protocol_test_case_test.rb had been passed because ReaderThreadError was occurred and the debuggee process was still alive. Here is a scenario. After closing socket, terminated event was sent. However socket was closed, so debuggee process raised Errno::EPIPE and debugggee process was still alive. The test framework detected the status and failed.

Thus I fixed so that the test framework does not kill the debuggee process unexpectedly.

* Alias Session send methods in WebSocketServer 

Methods ``respond``, ``respond_fail`` and ``fire_event`` can be aliased to ``send_response``, ``send_fail_response`` and ``send_event``, respectively.

* Fix timing bug on session_server creation

`@session_server` should be assigned at first.

`@session_server = Thread.current` in the session thread does not
work because the creator thread can access to `@session_server`
before it.

* Fix useless assignments

  Found by running `rubocop --only=Lint/UselessAssignment`

* Remove Tracer#puts as it's not used

* Avoid raising debuggee not finished error if assertions failed

When assertions failed, we should let the AssertionFailedError surface
and not calling flunk so we can get correct failure messages.

* Fix test builder

* DAP: allow custom request extension in ThreadClient class

* DAP: introduce Rdbg Record Inspector

* Revert "DAP: introduce Rdbg Record Inspector"

This reverts commit e29faba.

* relax authority check

to pass on the Windows.
fix ruby/vscode-rdbg#169

* Add test for global variable support in DAP and CDP

* Add test for instance variable ordering in DAP

PR ruby#806 sorts instance variables by name before returning them. This
commit adds a test that verifies this functionality under the DAP
protocol.

* Fix incorrect method name

* dap/cdp_result -> protocol_result

From ThreadClient it retunrs :dap_result or :cdp_result to the SESSION.
This patch renames it to `:protocol_result` and it will be handled
by `process_protocol_result`.

* separate 'test_console' and 'test_test'

* `test_all` should also run `test_test`

* Omit slow tests for healty CI

* add workflow

* DAP: rename the method name of custom request

Follow up for ruby#939

Change the name from "request_..." to "custom_dap_request_" in UI_DAP and ThreadClient for consistency

* DAP: support custom request in session class

UI_DAP -> Session: custom_dap_request_...

Session -> ThreadClient: custom_dap_request_event_...

Add "request_event" prefix to clarify it is a response (not Events in DAP)

* Add test for DAP's command execution through evaluate request

* Enqueue DAP's evaluate command right away

* DAP: echo back the given command

on `, debug_command` form.

* remain breakpoints on reloaded files

Breakpoints should be remained on reloaded files. To make sure
maintaining loaded file names.

fix ruby#870

* Use better approach to signal remote process' exit status

1. `remote_info.failed_process` stores symbol but we only use the value's
   presence to check if the process is force-killed.
2. The force-killed status is directly controlled by `kill_safely` through
    `kill_remote_debuggee`, which is directly called right before we check
    the status with `remote_info.failed_process`.

Combining the two, we can just let `kill_safely` and `kill_remote_debuggee` to
return the force-killed status and not storing it in `remote_info`, which
already contains a bunch of information.

This also eliminates the need to pass `test_info` to `kill_safely`, which
makes related code easier to understand and maintain.

* Remove unused failed_process attribute

* Add "result" as an argument to custom_dap_request_event method

The generated result in ThreadClient is passed as "result". We usually use it when returning responses to VS Code in Session class

* restart all threads on eval

When a thread keeps a lock, and REPL runs a code which needs the
lock, other threads should make a progress to release the lock.

fix ruby#877

* CDP: support remote debugging in different environment

From investigation by @ko1-san, the path to set breakpoints seems to be sent in "url" field when debugging in different environment such as WSL(running debuggee) and Windows(running Chrome DevTools). I supported "url" field in this PR.

* `-v` prints version and do something

Without this patch, `rdbg -v target.rb` prints version and terminates
the process. With this pach, `-v` prints version and starts debugging
for `target.rb`.

If no filename is given, terminates the process.

* v1.7.2

* Revert "Workaround VS Code's breakpoint skipping issue"

This reverts commit 4313d91.

* Revert "Avoid locking all threads on debugger suspension"

This reverts commit 1e0f45c.

* Revert "Always insert preset commands when executing commands from DAP (#4)"

This reverts commit 8eea4c9.

---------

Co-authored-by: Naoto Ono <onoto1998@gmail.com>
Co-authored-by: Takashi Kokubun <takashikkbn@gmail.com>
Co-authored-by: Andy Waite <andyw8@users.noreply.github.com>
Co-authored-by: Jeremy Evans <code@jeremyevans.net>
Co-authored-by: Andy Waite <13400+andyw8@users.noreply.github.com>
Co-authored-by: Mau Magnaguagno <maumagnaguagno@gmail.com>
Co-authored-by: Vinicius Stock <vinicius.stock@shopify.com>
Co-authored-by: yamashush <38120991+yamashush@users.noreply.github.com>
Co-authored-by: Jose D. Gomez R <jose.gomez@suse.com>
Co-authored-by: Koichi Sasada <ko1@atdot.net>
Co-authored-by: Emily Samp <emily.giurleo@shopify.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants