Allow adding a suffix to sockets for easier multiple-socket debugging #1017

andyjeffries · 2023-09-13T08:56:48Z

Add references of related issues/PRs in the description if available.

No issue raised

If you're updating the readme file, make sure you followed the instruction here.

Done

Description

In one of my projects (actually most, but this one in particular is what I'm working on it for) I use a Procfile with Overmind to launch both a web process and a worker process. However, at the moment I can't tell which socket is for which process.

This PR means that I can use a Procfile in the following format:

web: RUBY_DEBUG_OPEN=true RUBY_DEBUG_SOCK_SUFFIX=myproj-web PORT=3000 bundle exec puma -C config/puma.rb
worker: RUBY_DEBUG_OPEN=true RUBY_DEBUG_SOCK_SUFFIX=myproj-worker bundle exec sidekiq -t 10 -C config/sidekiq.yml

And the output of bundle exec rdbg --util=list-socks (which is used by VS Code for example) will change from:

/var/folders/gf/3z_681416nj3_zxgn2njdybm0000gn/T/ruby-debug-sock-501/ruby-debug-andy-32986
/var/folders/gf/3z_681416nj3_zxgn2njdybm0000gn/T/ruby-debug-sock-501/ruby-debug-andy-32998

to:

/var/folders/gf/3z_681416nj3_zxgn2njdybm0000gn/T/ruby-debug-sock-501/ruby-debug-andy-myproj-web-32986
/var/folders/gf/3z_681416nj3_zxgn2njdybm0000gn/T/ruby-debug-sock-501/ruby-debug-andy-myproj-worker-32998

This makes it much more obvious which socket is for which process. I'm going to raise a PR in the extension's project over there too (to trim out the matching stuff at the start), but this will be vital in making this use case work.

ko1 · 2023-09-25T07:17:25Z

simple question: We can also use "prefix".
Suffix is more preferable? Do you know similar options for other tools?

andyjeffries · 2023-09-25T07:18:50Z

No reason to not have both prefix and suffix. I'll update the PR with that.

andyjeffries · 2023-09-25T07:21:10Z

I don't know of options for any other tools (I only use Ruby and don't know of any other similar facilities for Ruby).

I've added prefix now too though.

andyjeffries · 2023-09-25T07:43:06Z

@ko1 I think this needs your approval again to run. Thanks.

ko1 · 2023-10-02T07:28:28Z

I don't ask to add PREFIX too. I want to know PREFIX or SUFFIX which is preferable. I think both is too much. To determine this kind of decision, checking other tools is good idea in general.

I understand you want to make clear that which UNIX domain socket is what you want to attach. So the main reason is "naming".

Now, debug.gem support to return information about UNIX domain socket with "info" request to debug server: https://github.com/ruby/debug/blob/master/lib/debug/server.rb#L132C11-L132C11
And if vscode-extension can support this information, we can see more rich information for each UNIX domain socket (connections).

But supporting on vscode-extension needs some more time.
So how about to add the "connection name" functionality?

My idea is:

(1) Add RUBY_DEBUG_NAME=<name> or RUBY_DEBUG_SESSION_NAME=<name>
- --name=<name> or --session-name=<name> with command line parameter.
(2) The <name> will be returned by info request.
(3) The <name> will be used as PREFIX (or SUFFIX. we don't need to decide as a spec) on UNIX domain socket.
- <name> needs some translation because <name> can contain unacceptable characters for file systems like /. Or restrict <name> with Ruby's variable names (lower chars, digits and _) for example.
(4) Option: REPL prompt can contain this <name>.

If vscode extension supports (2), we can see richer one.
With (3) we can see the name.
We don't need to specify PREFIX or SUFFIX any more.

andyjeffries · 2023-10-02T08:45:35Z

I'm not clear, if we're doing (2) then why do we need (3)? I can then update the VS Code extension to prefix each line in the picker (based on my existing PR on that project) to list them in the format "name: .../filename". That does seem nicer, so I'll rework this PR to be that.

andyjeffries · 2023-10-02T09:01:24Z

Having just looked at it, there's no way I understand the codebase enough to do this...

If you could give me any tips on a) where to add to the info command and b) how to test this locally without using VS Code as the client, I'd appreciate it (and could then continue).

Failing that, me and my team will just have to run with the forked gem and locally installed VS Code extension as it gets us moving nicely for now...

ko1 · 2023-10-09T08:13:38Z

I'm not clear, if we're doing (2) then why do we need (3)?

We don't need to wait vscode extension update.

ko1 · 2023-10-09T08:15:38Z

If you could give me any tips on a) where to add to the info command and b) how to test this locally without using VS Code as the client, I'd appreciate it (and could then continue).

On this PR, you only need to rename PREFIX/SUFFIX to SESSION_NAME (and maybe prefix will be nice).

andyjeffries · 2023-10-11T14:26:30Z

So just like that?

andyjeffries · 2023-10-16T13:23:24Z

Are you waiting for me to raise a separate PR to implement the changes to the info call, or are you going to do that? Thanks.

eugeneius · 2023-10-17T14:30:26Z

lib/debug/config.rb

+    if !CONFIG[:sock_prefix].nil?
+      filename = "#{CONFIG[:sock_prefix]}-#{filename}"
+    end
+    if !CONFIG[:sock_suffix].nil?
+      filename += "-#{CONFIG[:sock_suffix]}"
+    end


On this PR, you only need to rename PREFIX/SUFFIX to SESSION_NAME (and maybe prefix will be nice).

I think what Koichi meant here was:

Suggested change

if !CONFIG[:sock_prefix].nil?

filename = "#{CONFIG[:sock_prefix]}-#{filename}"

end

if !CONFIG[:sock_suffix].nil?

filename += "-#{CONFIG[:sock_suffix]}"

end

if !CONFIG[:session_name].nil?

filename = "#{CONFIG[:session_name]}-#{filename}"

end

eugeneius · 2023-10-17T14:30:32Z

lib/debug/config.rb

@@ -46,6 +46,8 @@ module DEBUGGER__
    host:           ['RUBY_DEBUG_HOST',         "REMOTE: TCP/IP remote debugging: host", :string, "127.0.0.1"],
    sock_path:      ['RUBY_DEBUG_SOCK_PATH',    "REMOTE: UNIX Domain Socket remote debugging: socket path"],
    sock_dir:       ['RUBY_DEBUG_SOCK_DIR',     "REMOTE: UNIX Domain Socket remote debugging: socket directory"],
+    sock_prefix:    ['RUBY_DEBUG_SOCK_PREFIX',  "REMOTE: UNIX Domain Socket remote debugging: socket prefix"],


Suggested change

sock_prefix: ['RUBY_DEBUG_SOCK_PREFIX', "REMOTE: UNIX Domain Socket remote debugging: socket prefix"],

eugeneius · 2023-10-17T14:32:25Z

README.md

@@ -501,6 +500,8 @@ config set no_color true
  * `RUBY_DEBUG_HOST` (`host`): TCP/IP remote debugging: host (default: 127.0.0.1)
  * `RUBY_DEBUG_SOCK_PATH` (`sock_path`): UNIX Domain Socket remote debugging: socket path
  * `RUBY_DEBUG_SOCK_DIR` (`sock_dir`): UNIX Domain Socket remote debugging: socket directory
+  * `RUBY_DEBUG_SOCK_PREFIX` (`sock_prefix`): UNIX Domain Socket remote debugging: socket prefix
+  * `RUBY_DEBUG_SESSION_NAME` (`session_name`): UNIX Domain Socket remote debugging: session name


https://github.com/ruby/debug/blob/master/CONTRIBUTING.md#to-update-readme

This project generates README.md from the template misc/README.md.erb

So do not directly update README.md. Instead, you should update the template's source and run

$ rake

to reflect the changes on README.md.

I'd also suggest dropping all the unrelated formatting changes (removing $, extra newlines, etc).

andyjeffries · 2023-11-07T16:19:25Z

I've got to be honest @eugeneius and @ko1 , I really don't understand what I'm doing here then. I've removed the changes from README.md (I believe they're now pulled in by README.md.erb), and removed the suffix/prefix stuff, so we just have a new "session name" setting, but is that really it?!

All this PR does is add a single line to a new config option?

Feels like that could have been done as part of the PR (whoever is doing it, I don't mind doing it - if someone can point me roughly where to start looking) to add it to the info command.

eugeneius · 2023-11-07T21:30:01Z

I was trying to suggest removing the changes related to sock_prefix/sock_suffix, and adding the session_name setting to the socket filename as a prefix when present. You can also keep the documentation changes in the README, but you have to apply them to misc/README.md.erb and then run rake to regenerate README.md, rather than edit it directly.

ko1 · 2023-11-14T09:10:52Z

Thank you @andyjeffries and @eugeneius to discuss. I make another PR to merge this feature.
Please check the PR if it is enough for your purpose.
And sorry @andyjeffries I couldn't guide your contribution well.

andyjeffries force-pushed the master branch from 76fb156 to c555245 Compare September 25, 2023 07:23

andyjeffries mentioned this pull request Sep 25, 2023

Any way to easily name the socket files? #1016

Closed

eugeneius reviewed Oct 17, 2023

View reviewed changes

andyjeffries added 3 commits November 7, 2023 16:15

Allow adding a suffix to sockets for easier multiple-socket debugging

e521005

Add socket filename prefix as well as suffix

c0f5880

Change socket prefix/suffix to session name

a751ab3

andyjeffries force-pushed the master branch from a6570c6 to a751ab3 Compare November 7, 2023 16:15

andyjeffries added 2 commits November 7, 2023 16:16

Revert README.md to upstream master version

defd41d

Remove unnecessary change in config.rb

10b30c9

ko1 mentioned this pull request Nov 14, 2023

session_name config #1036

Merged

ko1 closed this Nov 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow adding a suffix to sockets for easier multiple-socket debugging #1017

Allow adding a suffix to sockets for easier multiple-socket debugging #1017

andyjeffries commented Sep 13, 2023

ko1 commented Sep 25, 2023

andyjeffries commented Sep 25, 2023

andyjeffries commented Sep 25, 2023

andyjeffries commented Sep 25, 2023

ko1 commented Oct 2, 2023

andyjeffries commented Oct 2, 2023

andyjeffries commented Oct 2, 2023

ko1 commented Oct 9, 2023

ko1 commented Oct 9, 2023

andyjeffries commented Oct 11, 2023

andyjeffries commented Oct 16, 2023

eugeneius Oct 17, 2023

eugeneius Oct 17, 2023

eugeneius Oct 17, 2023

andyjeffries commented Nov 7, 2023

eugeneius commented Nov 7, 2023

ko1 commented Nov 14, 2023

Allow adding a suffix to sockets for easier multiple-socket debugging #1017

Allow adding a suffix to sockets for easier multiple-socket debugging #1017

Conversation

andyjeffries commented Sep 13, 2023

Description

ko1 commented Sep 25, 2023

andyjeffries commented Sep 25, 2023

andyjeffries commented Sep 25, 2023

andyjeffries commented Sep 25, 2023

ko1 commented Oct 2, 2023

andyjeffries commented Oct 2, 2023

andyjeffries commented Oct 2, 2023

ko1 commented Oct 9, 2023

ko1 commented Oct 9, 2023

andyjeffries commented Oct 11, 2023

andyjeffries commented Oct 16, 2023

eugeneius Oct 17, 2023

Choose a reason for hiding this comment

eugeneius Oct 17, 2023

Choose a reason for hiding this comment

eugeneius Oct 17, 2023

Choose a reason for hiding this comment

andyjeffries commented Nov 7, 2023

eugeneius commented Nov 7, 2023

ko1 commented Nov 14, 2023