[Fix #3834] Extend cider-repls to filter out REPLs that don't support needed operations #3840

wilbrt · 2025-09-06T10:06:54Z

Extend cider-repls to take an additional ops-to-support parameter, which is used to filter out the REPLs that do not support the given operations.

Change cider-map-repls to allow the which-parameter to be a list, that has the type of the wanted REPL as the first element and the rest as names of operations that need to be supported for the function to work. These operations are then passed to cider-repls as the ops-to-support.

Change cider-ns-refresh and cider-toggle-trace-ns to use the new list parameter for cider-map-repls. This fixes #3834.

Before submitting the PR make sure the following things have been done (and denote this
by checking the relevant checkboxes):

The commits are consistent with our contribution guidelines
You've added tests (if possible) to cover your change(s)
All tests are passing (eldev test)
All code passes the linter (eldev lint) which is based on elisp-lint and includes
- byte-compilation, checkdoc, check-declare, packaging metadata, indentation, and trailing whitespace checks.
You've updated the changelog (if adding/changing user-visible functionality)
You've updated the user manual (if adding/changing user-visible functionality)

Thanks!

If you're just starting out to hack on CIDER you might find this section of its
manual extremely useful.

bbatsov · 2025-09-09T05:34:29Z

Hmm, seems to me something's wrong with cider-map-repls, as I see it's invoked with :clj in this context which should be enough if things were working properly. (basically it filters out the non-Clojure connections)

wilbrt · 2025-09-09T07:22:38Z

There doesn't seem to be anything wrong with cider-map-repls. It's just that the lines
(cider-ensure-op-supported "refresh") (cider-ensure-op-supported "cider.clj-reload/reload") (cider-ns-refresh--save-modified-buffers) throw when the current buffers cider-current-repl does not give a Clojure repl.

I thought about extending the cider-ensure-op-supported-function to take an optional parameter for the repl type we want to use but figured it would change existing functionality too much for this kind of change.

vemv · 2025-09-26T07:17:01Z

It's just that the lines
(cider-ensure-op-supported "refresh") (cider-ensure-op-supported "cider.clj-reload/reload") (cider-ns-refresh--save-modified-buffers) throw when the current buffers cider-current-repl does not give a Clojure repl.

Well, it seems to me that we should solve that root cause then.

Would moving the cider-ensure-op-supported calls inside the existing cider-map-repls loop work?

...If it didn't , maybe we could try adding a parameter so that the connection being looped over is relayed.

vemv · 2025-09-26T07:26:24Z

Thinking about it, a nice API addition for cider-map-repls would not only include the language, but also the expected capabilities:

- (cider-map-repls :clj (lambda (...
+ (cider-map-repls '(:clj "refresh" "cider.clj-reload/reload") (lambda (...

That would-be variant would loop over the clj connections that had those specific capabilities, without throwing an error in non-matching connections.

wilbrt · 2025-09-26T14:47:29Z

Thinking about it, a nice API addition for cider-map-repls would not only include the language, but also the expected capabilities:
- (cider-map-repls :clj (lambda (...
+ (cider-map-repls '(:clj "refresh" "cider.clj-reload/reload") (lambda (...
That would-be variant would loop over the clj connections that had those specific capabilities, without throwing an error in non-matching connections.

I think this solution would be optimal, I'll try implementing it!

wilbrt · 2025-09-26T20:14:15Z

Thinking about it, a nice API addition for cider-map-repls would not only include the language, but also the expected capabilities:
- (cider-map-repls :clj (lambda (...
+ (cider-map-repls '(:clj "refresh" "cider.clj-reload/reload") (lambda (...
That would-be variant would loop over the clj connections that had those specific capabilities, without throwing an error in non-matching connections.

The latest commit presents a proposal for the kind of API mentioned in your comment. Though I was not sure what to do about the (cider-ns-refresh--save-modified-buffers) call as it does not fit the "inject operation name"-schema.

vemv · 2025-09-27T14:08:00Z

cider-connection.el

                     (t 'ensure)))
           (repls (cider-repls type ensure)))
-      (mapcar function repls))))
+      (mapcar (lambda (repl)


This throws an error for non-matching connections, which seems undesirable.

My suggestion was that the ops-to-support act as a 'filter', selecting the acceptable repls that we'll iterate over.

Taking a look at the function body, it seems to me that the cleanest approach would be to:

also introduce a ops-to-support parameter to the cider-repls function

relay that parameter from here

This way, we still have the flexibility to be 'strict' (error-throwing) or not, by reusing the existing ensure logic.

I hope I understood the idea correctly 😅 . It seems that at least the cider-toggle-trace-ns uses the cider-map-repls with cider-ensure-op-supported inside the lambda, do you think that that should be changed to be inline with the new API as part of this, as part of another task or not at all?

vemv

It seems that at least the cider-toggle-trace-ns uses the cider-map-repls with cider-ensure-op-supported inside the lambda, do you think that that should be changed to be inline with the new API as part of this, as part of another task or not at all?

Seems okay to include as part of this PR, provided that you try it out

vemv · 2025-09-28T16:07:38Z

doc/modules/ROOT/pages/usage/cider_mode.adoc

 | `cider-ns-refresh`
 | kbd:[C-c M-n (M-)r]
-| Reload all modified files on the classpath. If invoked with a prefix argument, reload all files on the classpath. If invoked with a double prefix argument, clear the state of the namespace tracker before reloading.
+| Reload all modified files on the classpath. If invoked with a prefix argument, reload all files on the classpath. If invoked with a double prefix argument, clear the state of the namespace tracker before reloading. Uses a clojure REPL whenever one exists.


This addition seems outdated by now, maybe leaving it as before would be enough

vemv

Fantatic work, thanks!

Just be sure to update the changelog, PR description, and please add tests (especially if there was existing coverage in these areas)

…d ops, use the new format also in cider-toggle-trace-ns

vemv

Thanks again!

vemv · 2025-10-04T14:06:15Z

test/cider-connection-tests.el

                                                                                    :repl-type cider-connection-tests-dummy-function))
            :to-equal "*cider-repl me/myproject:localhost:12345(cider-connection-tests-dummy-function)*")))
+
+(describe "")


Totally missed this 😅

vemv · 2025-10-04T17:41:03Z

Ready from my side, feel free to have one last look @bbatsov

wilbrt force-pushed the 3834-ns-refresh-to-use-clj-repl branch from 90b2135 to 6d723a1 Compare September 6, 2025 10:25

wilbrt force-pushed the 3834-ns-refresh-to-use-clj-repl branch from 6d723a1 to 23b2c17 Compare September 26, 2025 14:32

wilbrt added 2 commits September 26, 2025 18:33

3834 Change cider-ns-refresh to use clj repl

16e1afc

3834 Extend cider-map-repls to allow ensured op list

f65ea20

wilbrt force-pushed the 3834-ns-refresh-to-use-clj-repl branch from 23b2c17 to f65ea20 Compare September 26, 2025 16:14

vemv reviewed Sep 27, 2025

View reviewed changes

vemv reviewed Sep 28, 2025

View reviewed changes

vemv approved these changes Sep 28, 2025

View reviewed changes

3834 Extend cider-repls to filter out REPLs that do not support neede…

b5608dd

…d ops, use the new format also in cider-toggle-trace-ns

wilbrt changed the title ~~[Fix #3834] Change cider-ns-refresh to use Clojure REPL whenever one exists~~ [Fix #3834] Extend cider-repls to filter out REPLs that don't support needed operations Oct 4, 2025

wilbrt force-pushed the 3834-ns-refresh-to-use-clj-repl branch from aea853d to 8a2db0d Compare October 4, 2025 09:22

wilbrt requested a review from vemv October 4, 2025 11:06

vemv approved these changes Oct 4, 2025

View reviewed changes

3834 Update changelog, add test for new argument in cider-repls

b9e244e

wilbrt force-pushed the 3834-ns-refresh-to-use-clj-repl branch from 8a2db0d to b9e244e Compare October 4, 2025 15:54

Uh oh!

[Fix #3834] Extend cider-repls to filter out REPLs that don't support needed operations #3840

Are you sure you want to change the base?

[Fix #3834] Extend cider-repls to filter out REPLs that don't support needed operations #3840

Uh oh!

Conversation

wilbrt commented Sep 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bbatsov commented Sep 9, 2025

Uh oh!

wilbrt commented Sep 9, 2025

Uh oh!

vemv commented Sep 26, 2025

Uh oh!

vemv commented Sep 26, 2025

Uh oh!

wilbrt commented Sep 26, 2025

Uh oh!

wilbrt commented Sep 26, 2025

Uh oh!

vemv Sep 27, 2025

Choose a reason for hiding this comment

Uh oh!

wilbrt Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

vemv left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vemv Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

vemv left a comment

Choose a reason for hiding this comment

Uh oh!

vemv left a comment

Choose a reason for hiding this comment

Uh oh!

vemv Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

wilbrt Oct 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vemv commented Oct 4, 2025

Uh oh!

Uh oh!

wilbrt commented Sep 6, 2025 •

edited

Loading

vemv left a comment •

edited

Loading

wilbrt Oct 4, 2025 •

edited

Loading