Use revamped enrich-classpath plugin #3364

vemv · 2023-07-05T11:09:21Z

Bump enrich-classpath
Introduce clojure.sh script for Clojure CLI usage
Use a reworked middleware for Leiningen integration
- Its new functioning is described in v2 plugin enrich-classpath#23
- It works. On REPL startup, users will see this on the banner:

;;  Startup: java -cp /Users/vemv/how-to-ns/how-to-ns/test:/Users/vemv/how-to-ns/how-to-ns/src:/Users/vemv/how-to-ns/how-to-ns/dev-resources:/Users/vemv/how-to-ns/how-to-ns/resources:/Users/vemv/how-to-ns/how-to-ns/target/classes:/Users/vemv/.m2/repository/org/clojure/core.specs.alpha/0.1.24/core.specs.alpha-0.1.24.jar:/Users/vemv/.m2/repository/org/clojure/spec.alpha/0.1.143/spec.alpha-0.1.143.jar:/Users/vemv/.m2/repository/clojure-complete/clojure-complete/0.2.5/clojure-complete-0.2.5.jar:/Users/vemv/.m2/repository/com/googlecode/java-diff-utils/diffutils/1.2.1/diffutils-1.2.1.jar:/Users/vemv/.m2/repository/org/clojure/test.check/0.10.0-alpha3/test.check-0.10.0-alpha3.jar:/Users/vemv/.m2/repository/org/clojure/clojure/1.9.0/clojure-1.9.0.jar:/Users/vemv/.m2/repository/refactor-nrepl/refactor-nrepl/3.7.0/refactor-nrepl-3.7.0.jar:/Users/vemv/.m2/repository/nrepl/nrepl/1.0.0/nrepl-1.0.0.jar:/Users/vemv/.m2/repository/cider/cider-nrepl/0.31.0/cider-nrepl-0.31.0.jar:/Users/vemv/.mx.cider/enrich-classpath/1601/2516905847/1773208541.jar:/Users/vemv/.mx.cider/unzipped-jdk-sources/1601:/Library/Java/JavaVirtualMachines/adoptopenjdk-16.jdk/Contents/Home/lib/src.zip -XX:-OmitStackTraceInFastThrow -XX:+TieredCompilation -XX:TieredStopAtLevel=1 -Dclojure.compile.path=/Users/vemv/how-to-ns/how-to-ns/target/classes clojure.main -m nrepl.cmdline --middleware "[refactor-nrepl.middleware/wrap-refactor refactor-nrepl.middleware/wrap-refactor cider.nrepl/wrap-apropos cider.nrepl/wrap-classpath cider.nrepl/wrap-clojuredocs cider.nrepl/wrap-complete cider.nrepl/wrap-content-type cider.nrepl/wrap-debug cider.nrepl/wrap-enlighten cider.nrepl/wrap-format cider.nrepl/wrap-info cider.nrepl/wrap-inspect cider.nrepl/wrap-macroexpand cider.nrepl/wrap-ns cider.nrepl/wrap-out cider.nrepl/wrap-slurp cider.nrepl/wrap-profile cider.nrepl/wrap-refresh cider.nrepl/wrap-resource cider.nrepl/wrap-spec cider.nrepl/wrap-stacktrace cider.nrepl/wrap-test cider.nrepl/wrap-trace cider.nrepl/wrap-tracker cider.nrepl/wrap-undef cider.nrepl/wrap-version cider.nrepl/wrap-xref refactor-nrepl.middleware/wrap-refactor cider.nrepl/wrap-apropos cider.nrepl/wrap-classpath cider.nrepl/wrap-clojuredocs cider.nrepl/wrap-complete cider.nrepl/wrap-content-type cider.nrepl/wrap-debug cider.nrepl/wrap-enlighten cider.nrepl/wrap-format cider.nrepl/wrap-info cider.nrepl/wrap-inspect cider.nrepl/wrap-macroexpand cider.nrepl/wrap-ns cider.nrepl/wrap-out cider.nrepl/wrap-slurp cider.nrepl/wrap-profile cider.nrepl/wrap-refresh cider.nrepl/wrap-resource cider.nrepl/wrap-spec cider.nrepl/wrap-stacktrace cider.nrepl/wrap-test cider.nrepl/wrap-trace cider.nrepl/wrap-tracker cider.nrepl/wrap-undef cider.nrepl/wrap-version cider.nrepl/wrap-xref refactor-nrepl.middleware/wrap-refactor cider.nrepl/wrap-apropos cider.nrepl/wrap-classpath cider.nrepl/wrap-clojuredocs cider.nrepl/wrap-complete cider.nrepl/wrap-content-type cider.nrepl/wrap-debug cider.nrepl/wrap-enlighten cider.nrepl/wrap-format cider.nrepl/wrap-info cider.nrepl/wrap-inspect cider.nrepl/wrap-macroexpand cider.nrepl/wrap-ns cider.nrepl/wrap-out cider.nrepl/wrap-slurp cider.nrepl/wrap-profile cider.nrepl/wrap-refresh cider.nrepl/wrap-resource cider.nrepl/wrap-spec cider.nrepl/wrap-stacktrace cider.nrepl/wrap-test cider.nrepl/wrap-trace cider.nrepl/wrap-tracker cider.nrepl/wrap-undef cider.nrepl/wrap-version cider.nrepl/wrap-xref]"

The /Users/vemv/.mx.cider/enrich-classpath/1601/2516905847/1773208541.jar:/Users/vemv/.mx.cider/unzipped-jdk-sources/1601:/Library/Java/JavaVirtualMachines/adoptopenjdk-16.jdk/Contents/Home/lib/src.zip part indicates what Enrich is adding.

Because those artifacts are appended at the tail of the classpath (as guaranteed by using a bespoke java command, as opposed to delegating classpath construction to Lein), they won't give problems.

Under this code path, Lein users now run just one JVM!

cider.el

bbatsov · 2023-07-05T13:32:18Z

Might be good to also mention some of things you've written in the description of the PR in the docs.

vemv · 2023-07-05T15:07:12Z

Ready. I've kept QAing this and adding resilience.

Doc got some updates but I'm also leaving a bit minimalistic.

A follow-up PR will add Clojure CLI compat - that work is done already.

vemv · 2023-07-06T12:00:22Z

Moving this to draft again because I'll want to also QA this for figwheel repls.

(I had for shadow-cljs repls only, as far as cljs is concerned)

Otherwise the PR is reviewable.

bbatsov · 2023-07-06T12:03:28Z

doc/modules/ROOT/pages/config/basic_config.adoc

+
+For Lein users, it has the additional benefit of running a single JVM, instead of the two JVMs that Lein programs typically involve.
+
+`enrich-classpath` is still in beta and defaults to being disabled.


You might want to slap a NOTE: before this.

bbatsov · 2023-07-06T12:03:38Z

doc/modules/ROOT/pages/config/basic_config.adoc

+
+You can enable it by setting the `cider-enrich-classpath` defcustom to `t`.
+
+With it enable, `cider-jack-in` will activate enrich-classpath, given the following conditions:


bbatsov · 2023-07-06T12:04:51Z

doc/modules/ROOT/pages/config/basic_config.adoc

+
+* You are on macOS/Linux
+* You are on Leiningen
+* You are launching a vanilla JVM repl (and not a cljs, or clj+cljs one)


Can you launch a mixed REPL? In general I find the 3rd bullet point a bit confusing

bbatsov · 2023-07-11T03:50:15Z

.circleci/config.yml

@@ -22,7 +22,7 @@ commands:
          name: Install Emacs latest
          command: |
            echo "HOMEBREW_NO_AUTO_UPDATE=1" >> $BASH_ENV
-            brew install homebrew/cask/emacs
+            brew install homebrew/cask/emacs || brew install homebrew/cask/emacs || brew install homebrew/cask/emacs


Why do we need to retry this? I haven't noticed it failing often.

vemv · 2023-08-12T18:07:28Z

cider.el

@@ -855,7 +855,7 @@ middleware and dependencies."
            (cider-jack-in-normalized-lein-plugins)
            (if cider-enrich-classpath
                (append cider-jack-in-lein-middlewares
-                        '("cider.enrich-classpath/middleware"))
+                        '("cider.enrich-classpath.plugin-v2/middleware"))


Note to self: avoid this when the intended repl type is not 'clj.

Not that it's problematic, but seems a sensible way to start.

vemv

(Mostly a note to self)

For Lein users, it would be important to evaluate the Lein :init code.

Perhaps CIDER can make this happen, e.g. we determine the final :init value (after applying profiles, plugins, etc), persist it or store it in memory, and then we evaluate CIDER-side it as the first thing that happens after a successful (and enriched, i.e. no fallback was applied) connection.

edit: maybe it simply can be a clojure.main arg here https://github.com/clojure-emacs/enrich-classpath/blob/585f80f12b610b2438492e7523582796c5c1ee03/lein-plugin/src/cider/enrich_classpath/plugin_v2.clj#L90

vemv · 2023-08-14T21:18:37Z

@bbatsov: this is starting to look great, however I plan to merge it after the 1.8.0 release to contain risks.

This way, users can choose to use 1.8.0 or master.

vemv

I've been refining the Clojure CLI integration (both in https://github.com/clojure-emacs/enrich-classpath itself and the clojure.sh wrapper script, now included in the PR).

I'm more confident about it now and have successfully tried with CIDER in large projects.

vemv · 2023-08-19T06:13:30Z

cider.el

+  (lambda ()
+    (when (symbol-file 'cider-jack-in-command)
+      (concat (file-name-directory (symbol-file 'cider-jack-in-command))
+              "clojure.sh")))


I intend to ship the clojure.sh wrapper into the artifact to be unzipped into ~/.emacs.d/elpa/cider[...]

symbol-file would help me find that.

SGTY? @bbatsov

Bundled with what - CIDER or enrich?

Ah, I see it's bundled with CIDER. I'm not sure what symbol-file does, but there's package-user-dir or something like this that specifies the path to ELPA, so it seems you can use it instead.

I just want to mention that package-user-dir seems to only be used by package.el. So if you are using something like straigth.el to manage your Emacs packages (like I do), my CIDER files won't be in the directory contained in package-user-dir. E.g., package-user-dir in my case contains "~/.emacs.d/elpa", but my packages are at ~/.emacs.d/straight-emacs-29/straight/build/ (for Emacs 29.1; I keep a separate package directory per Emacs version).

(symbol-file 'cider-jack-in-command) on the other hand gives me "/home/iarenaza/.emacs.d/straight-emacs-29/straight/build/cider/cider.elc" which seems about right 😄

Agree with @iarenaza to not use package-user-dir (personally I use borg as package manager).

I think using locate-library is pretty common and I saw it a few times where the packages needs to find the sources for compiling a native module like vterm or jinx.

For cider this would be something like:
(file-name-directory (locate-library "cider.el" t))

My bad, I keep forgetting not everyone is using ELPA. :-) I agree that locate-library is probably the best approach (mostly because it's obvious what you're trying to do with it).

bbatsov · 2023-08-23T04:58:48Z

Seems the windows integration tests are failing all the time now. Perhaps there's some real problem with them?

bbatsov · 2023-08-23T05:07:47Z

cider.el

+              "clojure.sh")))
+  "The location of enrich-classpath's clojure.sh wrapper script."
+  :package-version '(cider . "1.8.0")
+  :type 'function)


Seems weird that something that looks like a filename should be a function IMO.

bbatsov · 2023-08-23T05:10:48Z

cider.el

-    ('clojure-cli (cider--resolve-command cider-clojure-cli-command))
+    ('clojure-cli (if (and cider-enrich-classpath
+                           (not (eq system-type 'windows-nt))
+                           (executable-find (funcall cider-enrich-classpath-clojure-cli-script)))


Here it also looks that this is a function. Perhaps you can just have a function that just expands properly whatever is in the defcustom (e.g. tries to find whatever was specified by the user and falls back to clojure.sh)?

I tentatively left this as a simple defun, and with a clearer name. Users would rarely have the need to point elsewhere for the script.

One can always edit the script inline, create a symlink, etc.

clojure.sh

vemv · 2023-08-23T11:33:47Z

Seems the windows integration tests are failing all the time now. Perhaps there's some real problem with them?

Probably not. In Circle they're passing as usual, while GHA's jobs have been more flaky.

Maybe their Win servers were having a slow day.

Its new functioning is described in clojure-emacs/enrich-classpath#23

bbatsov · 2023-08-26T18:46:04Z

Looks OK to me in the current state. I guess we'll squash this down to 1 commit, right?

vemv · 2023-08-26T19:01:12Z

Thanks!

I'm fixing something in enrich itself, will squash afterwards.

Introduced in clojure-emacs/cider#3364 Already in master: https://github.com/clojure-emacs/cider/blob/master/clojure.sh

vemv · 2023-08-27T08:18:54Z

clojure.sh will be melpa-distributed after melpa/melpa#8706 is in

vemv · 2023-08-28T20:32:16Z

clojure.sh will be melpa-distributed after melpa/melpa#8706 is in

It now is in. clojure.sh works when distributed by melpa and located CIDER-side.

@iarenaza, @dakra, given that you had the generosity to review, you might also want to give it a spin?

Doc lives at https://docs.cider.mx/cider/config/basic_config.html#use-enrich-classpath

Cheers - V

iarenaza · 2023-08-29T15:44:02Z

Am I right in assuming that I need master for that to work? (just to make sure, as I'm running CIDER 1.7.0 right now).

bbatsov · 2023-08-29T16:34:58Z

@iarenaza Yeah, you need to be on master.

vemv · 2023-08-29T16:41:31Z

Be advised, I already got quite some feedback, nothing critical, but enough for not bothering more people (yet).

Either way, CIDER 1.7.0 -> 1.8.0 has lots of reliability improvements (changelog), so feedback for all those other areas would be most useful.

Introduced in clojure-emacs/cider#3364 Already in master: https://github.com/clojure-emacs/cider/blob/master/clojure.sh

vemv commented Jul 5, 2023

View reviewed changes

cider.el Outdated Show resolved Hide resolved

vemv marked this pull request as ready for review July 5, 2023 15:05

vemv requested a review from bbatsov July 5, 2023 15:05

vemv marked this pull request as draft July 6, 2023 11:59

bbatsov reviewed Jul 6, 2023

View reviewed changes

bbatsov reviewed Jul 11, 2023

View reviewed changes

vemv mentioned this pull request Aug 3, 2023

When using cider-connect with localhost nrepls running, those ports are not shown among the available ones #3390

Closed

vemv commented Aug 12, 2023

View reviewed changes

vemv force-pushed the enrich-plugin-v2 branch from cf959e4 to 080f70e Compare August 12, 2023 18:24

vemv commented Aug 12, 2023

View reviewed changes

vemv force-pushed the enrich-plugin-v2 branch from 3f23ae5 to 8073ed2 Compare August 19, 2023 06:08

vemv commented Aug 19, 2023

View reviewed changes

vemv force-pushed the enrich-plugin-v2 branch from b24890c to c3c29c7 Compare August 22, 2023 23:19

vemv marked this pull request as ready for review August 22, 2023 23:43

bbatsov reviewed Aug 23, 2023

View reviewed changes

clojure.sh Show resolved Hide resolved

vemv added 5 commits August 25, 2023 16:53

Use revamped enrich-classpath plugin

f957cb8

Its new functioning is described in clojure-emacs/enrich-classpath#23

Typo

f7af8e5

Extract cider--expand-command-with-enrich-classpath

c93aa71

Update tests

03ac94b

Linter

376da5c

vemv added 5 commits August 25, 2023 16:53

Prefer locate-library

9478984

Refactor to cider--get-enrich-classpath-clojure-cli-script

1df13bf

Comment clojure.sh

38fd242

Add bash prefix

2ac806d

Use Enrich 1.15.0

7ba5d80

vemv force-pushed the enrich-plugin-v2 branch from 3b165ba to 7ba5d80 Compare August 25, 2023 21:42

vemv added 2 commits August 26, 2023 23:14

Use Enrich 1.15.3

649daf9

Document another constraint

e2aaa8c

vemv force-pushed the enrich-plugin-v2 branch from a689b14 to e2aaa8c Compare August 26, 2023 21:27

vemv added 2 commits August 26, 2023 23:28

Typo

9bd550f

Tweak doc

17114a7

vemv merged commit d823bd1 into master Aug 26, 2023
26 checks passed

vemv deleted the enrich-plugin-v2 branch August 26, 2023 21:40

vemv added a commit to vemv/melpa that referenced this pull request Aug 27, 2023

Add "clojure.sh" to cider package :files

17ddc3e

Introduced in clojure-emacs/cider#3364 Already in master: https://github.com/clojure-emacs/cider/blob/master/clojure.sh

vemv mentioned this pull request Aug 27, 2023

Add "clojure.sh" to cider package :files melpa/melpa#8706

Merged

6 tasks

github-actions bot pushed a commit to akirak/melpa that referenced this pull request Sep 24, 2023

Add "clojure.sh" to cider package :files

1a0d023

Introduced in clojure-emacs/cider#3364 Already in master: https://github.com/clojure-emacs/cider/blob/master/clojure.sh

akirak pushed a commit to akirak/melpa that referenced this pull request Sep 24, 2023

Add "clojure.sh" to cider package :files

903df40

Introduced in clojure-emacs/cider#3364 Already in master: https://github.com/clojure-emacs/cider/blob/master/clojure.sh

github-actions bot pushed a commit to akirak/melpa that referenced this pull request Nov 2, 2023

Add "clojure.sh" to cider package :files

0ed34ff

Introduced in clojure-emacs/cider#3364 Already in master: https://github.com/clojure-emacs/cider/blob/master/clojure.sh

github-actions bot pushed a commit to akirak/melpa that referenced this pull request Nov 2, 2023

Add "clojure.sh" to cider package :files

15e1076

Introduced in clojure-emacs/cider#3364 Already in master: https://github.com/clojure-emacs/cider/blob/master/clojure.sh

github-actions bot pushed a commit to akirak/melpa that referenced this pull request Nov 2, 2023

Add "clojure.sh" to cider package :files

856275c

Introduced in clojure-emacs/cider#3364 Already in master: https://github.com/clojure-emacs/cider/blob/master/clojure.sh

github-actions bot pushed a commit to akirak/melpa that referenced this pull request Nov 2, 2023

Add "clojure.sh" to cider package :files

6f24bdb

Introduced in clojure-emacs/cider#3364 Already in master: https://github.com/clojure-emacs/cider/blob/master/clojure.sh

github-actions bot pushed a commit to akirak/melpa that referenced this pull request Nov 2, 2023

Add "clojure.sh" to cider package :files

c3bd4b2

Introduced in clojure-emacs/cider#3364 Already in master: https://github.com/clojure-emacs/cider/blob/master/clojure.sh

github-actions bot pushed a commit to akirak/melpa that referenced this pull request Nov 2, 2023

Add "clojure.sh" to cider package :files

b6837ad

Introduced in clojure-emacs/cider#3364 Already in master: https://github.com/clojure-emacs/cider/blob/master/clojure.sh

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use revamped enrich-classpath plugin #3364

Use revamped enrich-classpath plugin #3364

vemv commented Jul 5, 2023 •

edited

Loading

bbatsov commented Jul 5, 2023

vemv commented Jul 5, 2023

vemv commented Jul 6, 2023

bbatsov Jul 6, 2023

bbatsov Jul 6, 2023

bbatsov Jul 6, 2023

bbatsov Jul 11, 2023

vemv Aug 12, 2023

vemv left a comment •

edited

Loading

vemv commented Aug 14, 2023

vemv left a comment

vemv Aug 19, 2023

bbatsov Aug 23, 2023

bbatsov Aug 23, 2023

iarenaza Aug 23, 2023 •

edited

Loading

dakra Aug 23, 2023

bbatsov Aug 23, 2023

bbatsov commented Aug 23, 2023

bbatsov Aug 23, 2023

bbatsov Aug 23, 2023

vemv Aug 23, 2023

vemv commented Aug 23, 2023

bbatsov commented Aug 26, 2023

vemv commented Aug 26, 2023

vemv commented Aug 27, 2023

vemv commented Aug 28, 2023

iarenaza commented Aug 29, 2023

bbatsov commented Aug 29, 2023

vemv commented Aug 29, 2023


		For Lein users, it has the additional benefit of running a single JVM, instead of the two JVMs that Lein programs typically involve.

		`enrich-classpath` is still in beta and defaults to being disabled.


		You can enable it by setting the `cider-enrich-classpath` defcustom to `t`.

		With it enable, `cider-jack-in` will activate enrich-classpath, given the following conditions:

Use revamped enrich-classpath plugin #3364

Use revamped enrich-classpath plugin #3364

Conversation

vemv commented Jul 5, 2023 • edited Loading

bbatsov commented Jul 5, 2023

vemv commented Jul 5, 2023

vemv commented Jul 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vemv left a comment • edited Loading

Choose a reason for hiding this comment

vemv commented Aug 14, 2023

vemv left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iarenaza Aug 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bbatsov commented Aug 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vemv commented Aug 23, 2023

bbatsov commented Aug 26, 2023

vemv commented Aug 26, 2023

vemv commented Aug 27, 2023

vemv commented Aug 28, 2023

iarenaza commented Aug 29, 2023

bbatsov commented Aug 29, 2023

vemv commented Aug 29, 2023

vemv commented Jul 5, 2023 •

edited

Loading

vemv left a comment •

edited

Loading

iarenaza Aug 23, 2023 •

edited

Loading