Execute and debug `.enso` files with `bin/enso` in VSCode #8923

JaroslavTulach · 2024-02-01T06:55:01Z

Pull Request Description

Let's untie the VSCode Enso extension from sbt commands. Let's open any Enso file in the editor and then use F5 or Ctrl-F5 to execute it. Let the user choose which bin/enso script to use for execution completely skipping the need for sbt.

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

The documentation has been updated in d87ba6e
Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
All code follows the
Java,
style guides.
All code has been tested:
- Support debugging (not only execution)
- When in IGV run with --dump-graphs - done in 2fb11ac
- Let @ola-lis publish new version of the extension

JaroslavTulach · 2024-02-01T06:57:54Z

tools/enso4igv/src/main/java/org/enso/tools/enso4igv/EnsoActionProvider.java

+        if (lkp.lookup(EnsoDataObject.class) != null) {
+            return true;
+        } else {
+            var fo = lkp.lookup(FileObject.class);


I'd be simpler to do just lookup(EnsoDataObject.class) != null, but that doesn't work currently. I needs apache/netbeans#7011 (comment) fix first which is going to be part of NetBeans 21 only. E.g. we need to keep this lookup(FileObject.class).getLookup().lookup(EnsoDataObject.class)) workaround.

JaroslavTulach · 2024-02-01T07:59:46Z

To witness what has been done so far follow these instructions: Get NetBeans sources at

commit 1c19e60bc6b995e5c0228eca4785ec4ad7a26171 (origin/master, origin/HEAD, master)
Merge: f84f06453f a0968f906f
Author: Dusan Balek <dusan.balek@oracle.com>
Date:   Fri Jan 26 10:24:06 2024 +0100

at least that's a commit known to work. Follow instructions in VSCode extension BUILD. E.g.

netbeans$ ant build
netbeans$ cd java/java.lsp.server
java.lsp.server$ ant build-vscode-ext

In parallel follow Enso instructions to build VSIX file

$ENSO_REPO_ROOT/tools/enso4igv$ mvn clean package nbm:cluster -Pvsix
...
[INFO]Created NetBeans module cluster(s) at /home/devel/NetBeansProjects/enso/enso/tools/enso4igv/target/netbeans_clusters
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
...

and then execute everything as:

netbeans/java/java.lsp.server/vscode$  npm run nbcode -- --jdkhome ~/bin/graalvm -J-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000 -J-Dnetbeans.extra.dirs=$ENSO_REPO_ROOT/tools/enso4igv/target/netbeans_clusters/extra

Listening for transport dt_socket at address: 8000

once the JVM based LSP is started also launch VSCode with:

netbeans/java/java.lsp.server/vscode$ code --extensionDevelopmentPath=`pwd`

then you'll be able to open .enso file and invoke it with Ctrl+F5 (choose debug with Java+ if asked):

After locating and pasting the enso executable there (for example $ENSO_REPO_ROOT/./built-distribution/enso-engine-0.0.0-dev-linux-amd64/enso-0.0.0-dev/bin/enso) the .enso file gets executed and output is printed in the area below editor:

Or (rather than building the extension yourself), download the .vsix file from here and install enso4vscode-1.31.129.vsix manually!

JaroslavTulach · 2024-02-01T08:48:19Z

tools/enso4igv/pom.xml

    </dependencies>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <netbeans.version>RELEASE113</netbeans.version>
+        <netbeans.version>RELEASE140</netbeans.version>


While working on this code base, I am trying to make sure the code works as:

VSCode extension

NetBeans module

IGV module

The biggest challenge is support for IGV as it is not being updated to run on latest NetBeans version too frequently.

However for this PR I need DialogDisplayer.notifyFuture (thank you, @sdedic) which is only available since NetBeans 14 - e.g. we have to upgrade.

With oracle/graal#8290 the Enso IGV Plugin version 1.31.129 can be installed into IGV:

Once the .nbm file is installed into IGV, one can press Shift-F6 inside of a .enso file and get the same behavior as in the VSCode extension:

radeusgd · 2024-02-01T10:04:45Z

Let the user choose which bin/enso script to use for execution

It sounds like it could make sense to also allow to choose to run using the launcher. Not necessarily in this PR, but I think it would be a neat improvement.

radeusgd

This looks very cool!

JaroslavTulach · 2024-02-02T05:21:05Z

tools/enso4igv/src/main/java/org/enso/tools/enso4igv/EnsoActionProvider.java

+        private final ExplicitProcessParameters params;
+        private final Future<String> computeAddress;
+
+        DebugAndLaunch(FileObject script, ProcessBuilder builder, ExplicitProcessParameters params) {


I've got debugging working. Execute VSCode with empty directories:

$ code --extensions-dir /tmp/ext --user-data-dir /tmp/usr

install the .vsix 1.31.138 extension and open some .enso file

Right now the debugging seems to work when there is no workspace opened - opening root of Enso repository as workspace prevents the debugging to work. Still investigating how to fix that.

jdunkerley

This is great - nice to have a more official way than my quick solution :)

…Exec

JaroslavTulach · 2024-02-09T05:24:06Z

If you open root of Enso repository as VSCode folder, then choose preconfigured Launch Enso File debug configuration before debugging a .enso file:

The rest of the workflow remains the same.

JaroslavTulach · 2024-02-09T16:51:21Z

I have done manual testing VSCode extension enso4vscode-1.33.29.vsix and I think it works. @ola-lis, can you please upload the .vsix file to the VSCode marketplace?

JaroslavTulach · 2024-02-09T17:53:25Z

Let the user choose which bin/enso script to use for execution

It sounds like it could make sense to also allow to choose to run using the launcher. Not necessarily in this PR, but I think it would be a neat improvement.

I am not using launcher myself, but it should be fairly trivial to update the extension to work with it. The code should be somewhere here, if you want to enhance it to also work with the launcher.

JaroslavTulach · 2024-02-12T13:04:43Z

Extension version 1.33.29 is available at Microsoft marketplace. Thank you, @ola-lis!

Turns out that #8923 isn't enough to support debugging of `Vector_Spec.enso` when root of Enso repository is opened as a folder/workspace. To allow debugging of `Vector_Spec.enso` two changes are needed. One is provided in this PR, the other one will be integrated as apache/netbeans#7105

JaroslavTulach added 4 commits January 31, 2024 05:32

run.single action provider for .enso files

2f37be5

Properly hint the remembered executable location

e7c97c5

Connect Enso with debugger

0f5fb3d

Make sure some jdk/bin directory is appended to the PATH

5a44505

JaroslavTulach requested review from hubertp, 4e6, radeusgd, AdRiley, jdunkerley, Akirathan and GregoryTravis February 1, 2024 06:55

JaroslavTulach self-assigned this Feb 1, 2024

JaroslavTulach commented Feb 1, 2024

View reviewed changes

radeusgd approved these changes Feb 1, 2024

View reviewed changes

GregoryTravis approved these changes Feb 1, 2024

View reviewed changes

enso-bot bot mentioned this pull request Feb 2, 2024

Use single cache file per library #8639

Closed

JaroslavTulach changed the title ~~Execute .enso files with bin/enso in VSCode~~ Execute and debug .enso files with bin/enso in VSCode Feb 2, 2024

JaroslavTulach commented Feb 2, 2024

View reviewed changes

Need access to com.sun.jdi.connect package

642124e

JaroslavTulach requested a review from mwu-tow as a code owner February 2, 2024 05:36

jdunkerley approved these changes Feb 7, 2024

View reviewed changes

JaroslavTulach added 6 commits February 8, 2024 21:10

Special action to debug .enso files

16518d6

Merge remote-tracking branch 'origin/develop' into wip/jtulach/VSCode…

1bbc0a3

…Exec

Moving Launch Enso File to the top

d3ad80f

When in IGV and GraalVM dump the compilations automatically

2fb11ac

Lower the minor version number by 150

5bce5b5

Merge remote-tracking branch 'origin/develop' into wip/jtulach/VSCode…

96a67c0

…Exec

Expanding documentation on launching .enso file

d87ba6e

mwu-tow approved these changes Feb 9, 2024

View reviewed changes

4e6 approved these changes Feb 9, 2024

View reviewed changes

JaroslavTulach added the CI: Clean build required CI runners will be cleaned before and after this PR is built. label Feb 9, 2024

JaroslavTulach added CI: Keep up to date Automatically update this PR to the latest develop. CI: Ready to merge This PR is eligible for automatic merge labels Feb 12, 2024

Merge branch 'develop' into wip/jtulach/VSCodeExec

a46d055

mergify bot merged commit ca9125f into develop Feb 12, 2024
26 of 27 checks passed

mergify bot deleted the wip/jtulach/VSCodeExec branch February 12, 2024 06:38

JaroslavTulach mentioned this pull request Feb 13, 2024

Support also COMMAND_RUN and COMMAND_DEBUG actions #9041

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Execute and debug `.enso` files with `bin/enso` in VSCode #8923

Execute and debug `.enso` files with `bin/enso` in VSCode #8923

JaroslavTulach commented Feb 1, 2024 •

edited

Loading

JaroslavTulach Feb 1, 2024

JaroslavTulach commented Feb 1, 2024 •

edited

Loading

JaroslavTulach Feb 1, 2024 •

edited

Loading

JaroslavTulach Feb 1, 2024 •

edited

Loading

JaroslavTulach Feb 1, 2024 •

edited

Loading

radeusgd commented Feb 1, 2024

radeusgd left a comment

JaroslavTulach Feb 2, 2024 •

edited

Loading

jdunkerley left a comment

JaroslavTulach commented Feb 9, 2024

JaroslavTulach commented Feb 9, 2024

JaroslavTulach commented Feb 9, 2024

JaroslavTulach commented Feb 12, 2024

Execute and debug .enso files with bin/enso in VSCode #8923

Execute and debug .enso files with bin/enso in VSCode #8923

Conversation

JaroslavTulach commented Feb 1, 2024 • edited Loading

Pull Request Description

Checklist

JaroslavTulach Feb 1, 2024

Choose a reason for hiding this comment

JaroslavTulach commented Feb 1, 2024 • edited Loading

JaroslavTulach Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

JaroslavTulach Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

JaroslavTulach Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

radeusgd commented Feb 1, 2024

radeusgd left a comment

Choose a reason for hiding this comment

JaroslavTulach Feb 2, 2024 • edited Loading

Choose a reason for hiding this comment

jdunkerley left a comment

Choose a reason for hiding this comment

JaroslavTulach commented Feb 9, 2024

JaroslavTulach commented Feb 9, 2024

JaroslavTulach commented Feb 9, 2024

JaroslavTulach commented Feb 12, 2024

Execute and debug `.enso` files with `bin/enso` in VSCode #8923

Execute and debug `.enso` files with `bin/enso` in VSCode #8923

JaroslavTulach commented Feb 1, 2024 •

edited

Loading

JaroslavTulach commented Feb 1, 2024 •

edited

Loading

JaroslavTulach Feb 1, 2024 •

edited

Loading

JaroslavTulach Feb 1, 2024 •

edited

Loading

JaroslavTulach Feb 1, 2024 •

edited

Loading

JaroslavTulach Feb 2, 2024 •

edited

Loading