feat: automatic debugging support #2699

stuartwdouglas · 2024-09-16T22:05:32Z

Automatically start go/java processes with remote debugging enabled, and automatically create profiles for both Intellij and VSCode.

internal/localdebug/local_ide_debug.go

alecthomas · 2024-09-17T08:12:03Z

internal/localdebug/local_ide_debug.go

+	return ""
+}
+
+type DebugInfo struct {


Prefer to place types at the top of the file to make it easier to read down the file.

alecthomas · 2024-09-17T08:16:42Z

internal/localdebug/local_ide_debug.go

+}
+
+// findIdeaFolder recurses up the directory tree to find a .idea folder.
+func findIdeaFolder(startPath string) string {


Duplicate code to that in the VSCode one, parameterise on the relative path you're looking for.

alecthomas · 2024-09-17T08:17:13Z

internal/localdebug/local_ide_debug.go

+// findLaunchJSON recurses up the directory tree to find a .vscode folder
+// If it can't find one it creates one next to project.toml
+// It then returns the path to the launch.json file
+func findLaunchJSON(startPath string) string {


Let's change this to terminate at the project root rather than the root directory, so we don't randomly start writing into an unrelated VSCode directory. Same with the IDEA stuff.

alecthomas · 2024-09-17T08:17:38Z

internal/localdebug/local_ide_debug.go

+				continue
+			}
+			entry := map[string]interface{}{
+				"name":       name,


alecthomas · 2024-09-17T08:17:50Z

internal/localdebug/local_ide_debug.go

+				configurations[pos].(map[string]interface{})["port"] = v.Port //nolint:forcetypeassert
+				continue
+			}
+			entry := map[string]interface{}{


s/interface{}/any/g

alecthomas · 2024-09-17T08:21:43Z

Nice! This is an awesome QoL change.

stuartwdouglas · 2024-09-17T20:29:16Z

I have made a few changes:

IDE support is now passed around in the context
No cleanup, instead the debug port from existing profiles is re-used. This should give a better experience if there is a delay between start and the IDE loading the profile

stuartwdouglas · 2024-09-17T22:37:06Z

This should be good to go now

alecthomas

LGTM but I do find it not great that it always creates a .vscode directory. I feel like it would be better to read either config. Also it seems possible these could get desynced anyway...eg. if you start ftl dev, there's no IDEA config, it writes the ports for VSCode, then you start GoLand. At this point GoLand won't have the correct ports and they won't get updated?

I also think it would be a good idea to have this IDE-specific logic behind an interface of some sort, to make it simpler to add new ones.

eg.

type IDE interface {
  // Used returns true if this IDE is in use in the project.
  Used() bool
  UpdatePorts(ports map[string]*DebugInfo) error
  // ExistingPorts reads the existing ports mapped for this IDE.
  ExistingPorts() (map[string]*DebugInfo, error)
}

alecthomas · 2024-09-17T22:41:51Z

internal/localdebug/local_ide_debug.go

+	return ret
+}
+
+func (r *IDEIntegration) IntoContext(ctx context.Context) context.Context {


Do we need to pass this through the context? Usually that's only reserved for things that are used all over the place, like loggers.

internal/localdebug/local_ide_debug.go

stuartwdouglas · 2024-09-18T00:21:52Z

LGTM but I do find it not great that it always creates a .vscode directory. I feel like it would be better to read either config. Also it seems possible these could get desynced anyway...eg. if you start ftl dev, there's no IDEA config, it writes the ports for VSCode, then you start GoLand. At this point GoLand won't have the correct ports and they won't get updated?

It would get updated when the first runner starts. This would also only apply if it is the first time you opened the project with GoLand.

In terms of always writing .vscode directories I don't think it is a big deal, e.g. we currently have both in FTL. We could potentially improve it later based on feedback.

I also think it would be a good idea to have this IDE-specific logic behind an interface of some sort, to make it simpler to add new ones.

I agree, but I think we should just get this in an test it out and then refine it from there.

This was referenced Sep 16, 2024

Dashboard #728

Open

JVM Runtime Roadmap #2439

Open

stuartwdouglas force-pushed the stuartwdouglas/auto-debugging branch 4 times, most recently from 3bae0bb to b02bb00 Compare September 17, 2024 05:18

stuartwdouglas added the skip-proto-breaking PRs with this label will skip the breaking proto check label Sep 17, 2024

stuartwdouglas force-pushed the stuartwdouglas/auto-debugging branch 5 times, most recently from d34711f to 1fdb3ea Compare September 17, 2024 06:50

stuartwdouglas marked this pull request as ready for review September 17, 2024 07:53

stuartwdouglas requested review from alecthomas and a team as code owners September 17, 2024 07:53

stuartwdouglas requested review from safeer and removed request for a team September 17, 2024 07:53

stuartwdouglas force-pushed the stuartwdouglas/auto-debugging branch from 1fdb3ea to a132e26 Compare September 17, 2024 07:54

stuartwdouglas removed the skip-proto-breaking PRs with this label will skip the breaking proto check label Sep 17, 2024

alecthomas requested changes Sep 17, 2024

View reviewed changes

stuartwdouglas force-pushed the stuartwdouglas/auto-debugging branch 4 times, most recently from a4a5f59 to 1337366 Compare September 17, 2024 20:03

stuartwdouglas force-pushed the stuartwdouglas/auto-debugging branch 4 times, most recently from 1a57c23 to a66b26c Compare September 17, 2024 22:28

alecthomas approved these changes Sep 17, 2024

View reviewed changes

stuartwdouglas force-pushed the stuartwdouglas/auto-debugging branch from a66b26c to 903048d Compare September 18, 2024 00:18

stuartwdouglas force-pushed the stuartwdouglas/auto-debugging branch 4 times, most recently from 8e61508 to ff43ab0 Compare September 18, 2024 02:22

stuartwdouglas added 4 commits September 18, 2024 14:39

tmp: initial support for automatic debug configuration

34427f3

tmp: initial go support

ce1e834

feat: VSCode support

cf01bdf

change to use context

c15b4c2

stuartwdouglas force-pushed the stuartwdouglas/auto-debugging branch from ff43ab0 to a65c99a Compare September 18, 2024 05:45

don't re-use debug ports

0cb7728

stuartwdouglas force-pushed the stuartwdouglas/auto-debugging branch from a65c99a to 0cb7728 Compare September 18, 2024 22:09

stuartwdouglas merged commit 8184741 into main Sep 19, 2024
91 checks passed

stuartwdouglas deleted the stuartwdouglas/auto-debugging branch September 19, 2024 02:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: automatic debugging support #2699

feat: automatic debugging support #2699

stuartwdouglas commented Sep 16, 2024

alecthomas Sep 17, 2024

alecthomas Sep 17, 2024

alecthomas Sep 17, 2024

alecthomas Sep 17, 2024

alecthomas Sep 17, 2024

alecthomas commented Sep 17, 2024

stuartwdouglas commented Sep 17, 2024

stuartwdouglas commented Sep 17, 2024

alecthomas left a comment •

edited

Loading

alecthomas Sep 17, 2024

stuartwdouglas commented Sep 18, 2024

feat: automatic debugging support #2699

feat: automatic debugging support #2699

Conversation

stuartwdouglas commented Sep 16, 2024

alecthomas Sep 17, 2024

Choose a reason for hiding this comment

alecthomas Sep 17, 2024

Choose a reason for hiding this comment

alecthomas Sep 17, 2024

Choose a reason for hiding this comment

alecthomas Sep 17, 2024

Choose a reason for hiding this comment

alecthomas Sep 17, 2024

Choose a reason for hiding this comment

alecthomas commented Sep 17, 2024

stuartwdouglas commented Sep 17, 2024

stuartwdouglas commented Sep 17, 2024

alecthomas left a comment • edited Loading

Choose a reason for hiding this comment

alecthomas Sep 17, 2024

Choose a reason for hiding this comment

stuartwdouglas commented Sep 18, 2024

alecthomas left a comment •

edited

Loading