-
-
Notifications
You must be signed in to change notification settings - Fork 647
/
Copy pathnrepl-client.el
1503 lines (1347 loc) · 64.6 KB
/
nrepl-client.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; nrepl-client.el --- Client for Clojure nREPL -*- lexical-binding: t -*-
;; Copyright © 2012-2025 Tim King, Phil Hagelberg, Bozhidar Batsov
;; Copyright © 2013-2025 Bozhidar Batsov, Artur Malabarba and CIDER contributors
;;
;; Author: Tim King <kingtim@gmail.com>
;; Phil Hagelberg <technomancy@gmail.com>
;; Bozhidar Batsov <bozhidar@batsov.dev>
;; Artur Malabarba <bruce.connor.am@gmail.com>
;; Hugo Duncan <hugo@hugoduncan.org>
;; Steve Purcell <steve@sanityinc.com>
;; Reid McKenzie <me@arrdem.com>
;;
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;
;; This file is not part of GNU Emacs.
;;
;;; Commentary:
;;
;; Provides an Emacs Lisp client to connect to Clojure nREPL servers.
;;
;; A connection is an abstract idea of the communication between Emacs (client)
;; and nREPL server. On the Emacs side connections are represented by two
;; running processes. The two processes are the server process and client
;; process (the connection to the server). Each of these is represented by its
;; own process buffer, filter and sentinel.
;;
;; The nREPL communication process can be broadly represented as follows:
;;
;; 1) The server process is started as an Emacs subprocess (usually by
;; `cider-jack-in', which in turn fires up an nREPL server). Note that
;; if a connection was established using `cider-connect' there won't be
;; a server process.
;;
;; 2) The server's process filter (`nrepl-server-filter') detects the
;; connection port from the first plain text response from the server and
;; starts a communication process (socket connection) as another Emacs
;; subprocess. This is the nREPL client process (`nrepl-client-filter').
;; All requests and responses handling happens through this client
;; connection.
;;
;; 3) Requests are sent by `nrepl-send-request' and
;; `nrepl-send-sync-request'. A request is simply a list containing a
;; requested operation name and the parameters required by the
;; operation. Each request has an associated callback that is called once
;; the response for the request has arrived. Besides the above functions
;; there are specialized request senders for each type of common
;; operations. Examples are `nrepl-request:eval', `nrepl-request:clone',
;; `nrepl-sync-request:describe'.
;;
;; 4) Responses from the server are decoded in `nrepl-client-filter' and are
;; physically represented by alists whose structure depends on the type of
;; the response. After having been decoded, the data from the response is
;; passed over to the callback that was registered by the original
;; request.
;;
;; Please see the comments in dedicated sections of this file for more detailed
;; description.
;;; Code:
(require 'seq)
(require 'subr-x)
(require 'cl-lib)
(require 'nrepl-dict)
(require 'queue)
(require 'sesman)
(require 'tramp)
(require 'cider-util)
;;; Custom
(defgroup nrepl nil
"Interaction with the Clojure nREPL Server."
:prefix "nrepl-"
:group 'applications)
(defcustom nrepl-connected-hook nil
"List of functions to call when connecting to the nREPL server."
:type 'hook)
(defcustom nrepl-disconnected-hook nil
"List of functions to call when disconnected from the nREPL server."
:type 'hook)
(defcustom nrepl-force-ssh-for-remote-hosts nil
"If non-nil, do not attempt a direct connection for remote hosts."
:type 'boolean)
(defcustom nrepl-use-ssh-fallback-for-remote-hosts nil
"If non-nil, Use ssh as a fallback to connect to remote hosts.
It will attempt to connect via ssh to remote hosts when unable to connect
directly."
:type 'boolean)
(defcustom nrepl-sync-request-timeout 10
"The number of seconds to wait for a sync response.
Setting this to nil disables the timeout functionality."
:type 'integer)
(defcustom nrepl-hide-special-buffers nil
"Control the display of some special buffers in buffer switching commands.
When true some special buffers like the server buffer will be hidden."
:type 'boolean)
;;; Buffer Local Declarations
;; These variables are used to track the state of nREPL connections
(defvar-local nrepl-connection-buffer nil)
(defvar-local nrepl-server-buffer nil)
(defvar-local nrepl-messages-buffer nil)
(defvar-local nrepl-endpoint nil)
(defvar-local nrepl-project-dir nil)
(defvar-local nrepl-is-server nil)
(defvar-local nrepl-server-command nil)
(defvar-local nrepl-tunnel-buffer nil)
(defvar-local nrepl-session nil
"Current nREPL session id.")
(defvar-local nrepl-tooling-session nil
"Current nREPL tooling session id.
To be used for tooling calls (i.e. completion, eldoc, etc)")
(defvar-local nrepl-request-counter 0
"Continuation serial number counter.")
(defvar-local nrepl-pending-requests nil)
(defvar-local nrepl-completed-requests nil)
(defvar-local nrepl-last-sync-response nil
"Result of the last sync request.")
(defvar-local nrepl-last-sync-request-timestamp nil
"The time when the last sync request was initiated.")
(defvar-local nrepl-ops nil
"Available nREPL server ops (from describe).")
(defvar-local nrepl-versions nil
"Version information received from the describe op.")
(defvar-local nrepl-aux nil
"Auxiliary information received from the describe op.")
;;; nREPL Buffer Names
(defconst nrepl-message-buffer-name-template "*nrepl-messages %s(%r:%S)*")
(defconst nrepl-error-buffer-name "*nrepl-error*")
(defconst nrepl-repl-buffer-name-template "*cider-repl %s(%r:%S)*")
(defconst nrepl-server-buffer-name-template "*nrepl-server %s*")
(defconst nrepl-tunnel-buffer-name-template "*nrepl-tunnel %s*")
(declare-function cider-format-connection-params "cider-connection")
(defun nrepl-make-buffer-name (template params &optional dup-ok)
"Generate a buffer name using TEMPLATE and PARAMS.
TEMPLATE and PARAMS are as in `cider-format-connection-params'. If
optional DUP-OK is non-nil, the returned buffer is not \"uniquified\" by a
call to `generate-new-buffer-name'."
(let ((name (cider-format-connection-params template params)))
(if dup-ok
name
(generate-new-buffer-name name))))
(defun nrepl--make-hidden-name (buffer-name)
"Apply a prefix to BUFFER-NAME that will hide the buffer."
(concat (if nrepl-hide-special-buffers " " "") buffer-name))
(defun nrepl-repl-buffer-name (params &optional dup-ok)
"Return the name of the repl buffer.
PARAMS and DUP-OK are as in `nrepl-make-buffer-name'."
(nrepl-make-buffer-name nrepl-repl-buffer-name-template params dup-ok))
(defun nrepl-server-buffer-name (params)
"Return the name of the server buffer.
PARAMS is as in `nrepl-make-buffer-name'."
(nrepl-make-buffer-name (nrepl--make-hidden-name nrepl-server-buffer-name-template)
params))
(defun nrepl-tunnel-buffer-name (params)
"Return the name of the tunnel buffer.
PARAMS is as in `nrepl-make-buffer-name'."
(nrepl-make-buffer-name (nrepl--make-hidden-name nrepl-tunnel-buffer-name-template)
params))
(defun nrepl-messages-buffer-name (params)
"Return the name for the message buffer given connection PARAMS."
(nrepl-make-buffer-name nrepl-message-buffer-name-template params))
;;; Utilities
(defun nrepl-op-supported-p (op connection)
"Return t iff the given operation OP is supported by the nREPL CONNECTION."
(when (buffer-live-p connection)
(with-current-buffer connection
(and nrepl-ops (nrepl-dict-get nrepl-ops op)))))
(defun nrepl-aux-info (key connection)
"Return KEY's aux info, as returned via the :describe op for CONNECTION."
(with-current-buffer connection
(and nrepl-aux (nrepl-dict-get nrepl-aux key))))
(defun nrepl-local-host-p (host)
"Return t if HOST is local."
(string-match-p tramp-local-host-regexp host))
(defun nrepl-extract-port (dir)
"Read port from applicable repl-port file in directory DIR."
(condition-case nil
(or (nrepl--port-from-file (expand-file-name "repl-port" dir))
(nrepl--port-from-file (expand-file-name ".nrepl-port" dir))
(nrepl--port-from-file (expand-file-name "target/repl-port" dir))
(nrepl--port-from-file (expand-file-name ".shadow-cljs/nrepl.port" dir)))
;; This operation can hit permission errors, particularly on macOS:
(error nil)))
(defun nrepl-extract-ports (dir)
"Read ports from applicable repl-port files in directory DIR."
(condition-case nil
(delq nil
(list (nrepl--port-from-file (expand-file-name "repl-port" dir))
(nrepl--port-from-file (expand-file-name ".nrepl-port" dir))
(nrepl--port-from-file (expand-file-name "target/repl-port" dir))
(nrepl--port-from-file (expand-file-name ".shadow-cljs/nrepl.port" dir))))
;; This operation can hit permission errors, particularly on macOS:
(error nil)))
(make-obsolete 'nrepl-extract-port 'nrepl-extract-ports "1.5.0")
(defun nrepl--port-string-to-number (s)
"Converts `S' from string to number when suitable."
(when (string-match "^\\([0-9]+\\)" s)
(string-to-number (match-string 0 s))))
(defun nrepl--port-from-file (file)
"Attempts to read port from a file named by FILE.
Discards it if it can be determined that the port is not active."
(when (file-exists-p file)
(when-let* ((port-string (with-temp-buffer
(insert-file-contents file)
(buffer-string)))
;; extract the number, most of all for not passing garbage to `lsof' (which might even be a security risk):
(port-number (nrepl--port-string-to-number port-string)))
(if (eq system-type 'windows-nt)
port-string
(when (not (equal ""
(shell-command-to-string (format "lsof -i:%s" port-number))))
port-string)))))
(defun nrepl--ssh-file-name-matches-host-p (file-name host)
"Return t, if FILE-NAME is a tramp-file-name on HOST via ssh."
(when (tramp-tramp-file-p file-name)
(with-parsed-tramp-file-name file-name v
(and (member v-method '("ssh" "sshx"))
(member host (list v-host (concat v-host "#" v-port)))))))
;;; Bencode
(cl-defstruct (nrepl-response-queue
(:include queue)
(:constructor nil)
(:constructor nrepl-response-queue (&optional stub)))
stub)
(put 'nrepl-response-queue 'function-documentation
"Create queue object used by nREPL to store decoded server responses.
The STUB slot stores a stack of nested, incompletely parsed objects.")
(defun nrepl--bdecode-list (&optional stack)
"Decode a bencode list or dict starting at point.
STACK is as in `nrepl--bdecode-1'."
;; skip leading l or d
(forward-char 1)
(let* ((istack (nrepl--bdecode-1 stack))
(pos0 (point))
(info (car istack)))
(while (null info)
(setq istack (nrepl--bdecode-1 (cdr istack))
pos0 (point)
info (car istack)))
(cond ((eq info :e)
(cons nil (cdr istack)))
((eq info :stub)
(goto-char pos0)
istack)
(t istack))))
(defun nrepl--bdecode-1 (&optional stack)
"Decode one elementary bencode object starting at point.
Bencoded object is either list, dict, integer or string. See
http://en.wikipedia.org/wiki/Bencode#Encoding_algorithm for the encoding
rules.
STACK is a list of so far decoded components of the current message. Car
of STACK is the innermost incompletely decoded object. The algorithm pops
this list when inner object was completely decoded or grows it by one when
new list or dict was encountered.
The returned value is of the form (INFO . STACK) where INFO is
:stub, nil, :end or :eob and STACK is either an incomplete parsing state as
above (INFO is :stub, nil or :eob) or a list of one component representing
the completely decoded message (INFO is :end). INFO is nil when an
elementary non-root object was successfully decoded. INFO is :end when this
object is a root list or dict."
(cond
;; list
((eq (char-after) ?l)
(nrepl--bdecode-list (cons () stack)))
;; dict
((eq (char-after) ?d)
(nrepl--bdecode-list (cons '(dict) stack)))
;; end of a list or a dict
((eq (char-after) ?e)
(forward-char 1)
(cons (if (cdr stack) :e :end)
(nrepl--push (nrepl--nreverse (car stack))
(cdr stack))))
;; string
((looking-at "\\([0-9]+\\):")
(let ((pos0 (point))
(beg (goto-char (match-end 0)))
(end (byte-to-position (+ (position-bytes (point))
(string-to-number (match-string 1))))))
(if (null end)
(progn (goto-char pos0)
(cons :stub stack))
(goto-char end)
;; normalise any platform-specific newlines
(let* ((original (buffer-substring-no-properties beg end))
(result (replace-regexp-in-string "\r\n\\|\n\r\\|\r" "\n" original)))
(cons nil (nrepl--push result stack))))))
;; integer
((looking-at "i\\(-?[0-9]+\\)e")
(goto-char (match-end 0))
(cons nil (nrepl--push (string-to-number (match-string 1))
stack)))
;; should happen in tests only as eobp is checked in nrepl-bdecode.
((eobp)
(cons :eob stack))
;; truncation in the middle of an integer or in 123: string prefix
((looking-at-p "[0-9i]")
(cons :stub stack))
;; else, throw a quiet error
(t
(message "Invalid bencode message detected. See the %s buffer for details."
nrepl-error-buffer-name)
(nrepl-log-error
(format "Decoder error at position %d (`%s'):"
(point) (buffer-substring (point) (min (+ (point) 10) (point-max)))))
(nrepl-log-error (buffer-string))
(ding)
;; Ensure loop break and clean queues' states in nrepl-bdecode:
(goto-char (point-max))
(cons :end nil))))
(defun nrepl--bdecode-message (&optional stack)
"Decode one full message starting at point.
STACK is as in `nrepl--bdecode-1'. Return a cons (INFO . STACK)."
(let* ((istack (nrepl--bdecode-1 stack))
(info (car istack))
(stack (cdr istack)))
(while (or (null info)
(eq info :e))
(setq istack (nrepl--bdecode-1 stack)
info (car istack)
stack (cdr istack)))
istack))
(defun nrepl--ensure-fundamental-mode ()
"Enable `fundamental-mode' if it is not enabled already."
(when (not (eq 'fundamental-mode major-mode))
(fundamental-mode)))
(defun nrepl-bdecode (string-q &optional response-q)
"Decode STRING-Q and place the results into RESPONSE-Q.
STRING-Q is either a queue of strings or a string. RESPONSE-Q is a queue of
server requests (nREPL dicts). STRING-Q and RESPONSE-Q are modified by side
effects.
Return a cons (STRING-Q . RESPONSE-Q) where STRING-Q is the original queue
containing the remainder of the input strings which could not be
decoded. RESPONSE-Q is the original queue with successfully decoded messages
enqueued and with slot STUB containing a nested stack of an incompletely
decoded message or nil if the strings were completely decoded."
(with-current-buffer (get-buffer-create " *nrepl-decoding*")
;; Don't needlessly call `fundamental-mode', to prevent needlessly firing
;; hooks. This fixes an issue with evil-mode where the cursor loses its
;; correct color.
(nrepl--ensure-fundamental-mode)
(erase-buffer)
(if (queue-p string-q)
(while (queue-head string-q)
(insert (queue-dequeue string-q)))
(insert string-q)
(setq string-q (queue-create)))
(goto-char 1)
(unless response-q
(setq response-q (nrepl-response-queue)))
(let ((istack (nrepl--bdecode-message
(nrepl-response-queue-stub response-q))))
(while (and (eq (car istack) :end)
(not (eobp)))
(queue-enqueue response-q (cadr istack))
(setq istack (nrepl--bdecode-message)))
(unless (eobp)
(queue-enqueue string-q (buffer-substring (point) (point-max))))
(if (not (eq (car istack) :end))
(setf (nrepl-response-queue-stub response-q) (cdr istack))
(queue-enqueue response-q (cadr istack))
(setf (nrepl-response-queue-stub response-q) nil))
(erase-buffer)
(cons string-q response-q))))
(defun nrepl-bencode (object)
"Encode OBJECT with bencode.
Integers, lists and nrepl-dicts are treated according to bencode
specification. Everything else is encoded as string."
(cond
((integerp object) (format "i%de" object))
((nrepl-dict-p object) (format "d%se" (mapconcat #'nrepl-bencode (cdr object) "")))
((listp object) (format "l%se" (mapconcat #'nrepl-bencode object "")))
(t (format "%s:%s" (string-bytes object) object))))
;;; Client: Process Filter
(defvar nrepl-response-handler-functions nil
"List of functions to call on each nREPL message.
Each of these functions should be a function with one argument, which will
be called by `nrepl-client-filter' on every response received. The current
buffer will be connection (REPL) buffer of the process. These functions
should take a single argument, a dict representing the message. See
`nrepl--dispatch-response' for an example.
These functions are called before the message's own callbacks, so that they
can affect the behavior of the callbacks. Errors signaled by these
functions are demoted to messages, so that they don't prevent the
callbacks from running.")
(defun nrepl-client-filter (proc string)
"Decode message(s) from PROC contained in STRING and dispatch them."
(let ((string-q (process-get proc :string-q)))
(queue-enqueue string-q string)
;; Start decoding only if the last letter is 'e'
(when (eq ?e (aref string (1- (length string))))
(let ((response-q (process-get proc :response-q)))
(nrepl-bdecode string-q response-q)
(while (queue-head response-q)
(with-current-buffer (process-buffer proc)
(let ((response (queue-dequeue response-q)))
(with-demoted-errors "Error in one of the `nrepl-response-handler-functions': %s"
(run-hook-with-args 'nrepl-response-handler-functions response))
(nrepl--dispatch-response response))))))))
(defun nrepl--dispatch-response (response)
"Dispatch the RESPONSE to associated callback.
First we check the callbacks of pending requests. If no callback was found,
we check the completed requests, since responses could be received even for
older requests with \"done\" status."
(nrepl-dbind-response response (id)
(nrepl-log-message response 'response)
(let ((callback (or (gethash id nrepl-pending-requests)
(gethash id nrepl-completed-requests))))
(if callback
(funcall callback response)
(error "[nREPL] No response handler with id %s found for %s" id (buffer-name))))))
(defun nrepl-client-sentinel (process message)
"Handle sentinel events from PROCESS.
Notify MESSAGE and if the process is closed run `nrepl-disconnected-hook'
and kill the process buffer."
(if (string-match "deleted\\b" message)
(message "[nREPL] Connection closed")
(message "[nREPL] Connection closed unexpectedly (%s)"
(substring message 0 -1)))
(when (equal (process-status process) 'closed)
(when-let* ((client-buffer (process-buffer process)))
(sesman-remove-object 'CIDER nil client-buffer
(not (process-get process :keep-server))
'no-error)
(nrepl--clear-client-sessions client-buffer)
(with-current-buffer client-buffer
(goto-char (point-max))
(insert-before-markers
(propertize
(format "\n*** Closed on %s ***\n" (replace-regexp-in-string " +"
" "
(current-time-string)))
'face 'cider-repl-stderr-face))
(run-hooks 'nrepl-disconnected-hook)
(let ((server-buffer nrepl-server-buffer))
(when (and (buffer-live-p server-buffer)
(not (process-get process :keep-server)))
(setq nrepl-server-buffer nil)
(nrepl--maybe-kill-server-buffer server-buffer)))))))
;;; Network
(defun nrepl--unix-connect (socket-file &optional no-error)
"If SOCKET-FILE is given, try to `make-network-process'.
If NO-ERROR is non-nil, show messages instead of throwing an error."
(if (not socket-file)
(unless no-error
(error "[nREPL] Socket file not provided"))
(message "[nREPL] Establishing unix socket connection to %s ..." socket-file)
(condition-case nil
(prog1 (list :proc (make-network-process :name "nrepl-connection" :buffer nil
:family 'local :service socket-file)
:host "local-unix-domain-socket"
:port socket-file
:socket-file socket-file)
(message "[nREPL] Unix socket connection to %s established" socket-file))
(error (let ((msg (format "[nREPL] Unix socket connection to %s failed" socket-file)))
(if no-error
(message msg)
(error msg))
nil)))))
(defun nrepl-connect (host port)
"Connect to the nREPL server identified by HOST and PORT.
For local hosts use a direct connection. For remote hosts, if
`nrepl-force-ssh-for-remote-hosts' is nil, attempt a direct connection
first. If `nrepl-force-ssh-for-remote-hosts' is non-nil or the direct
connection failed (and `nrepl-use-ssh-fallback-for-remote-hosts' is
non-nil), try to start a SSH tunneled connection. Return a plist of the
form (:proc PROC :host \"HOST\" :port PORT) that might contain additional
key-values depending on the connection type."
(let ((localp (if host
(nrepl-local-host-p host)
(not (file-remote-p default-directory)))))
(if localp
(nrepl--direct-connect (or host "localhost") port)
;; we're dealing with a remote host
(if (and host (not nrepl-force-ssh-for-remote-hosts))
(or (nrepl--direct-connect host port 'no-error)
;; direct connection failed
;; fallback to ssh tunneling if enabled
(and nrepl-use-ssh-fallback-for-remote-hosts
(message "[nREPL] Falling back to SSH tunneled connection ...")
(nrepl--ssh-tunnel-connect host port))
;; fallback is either not enabled or it failed as well
(if (and (null nrepl-use-ssh-fallback-for-remote-hosts)
(not localp))
(error "[nREPL] Direct connection to %s:%s failed; try setting `nrepl-use-ssh-fallback-for-remote-hosts' to t"
host port)
(error "[nREPL] Cannot connect to %s:%s" host port)))
;; `nrepl-force-ssh-for-remote-hosts' is non-nil
(nrepl--ssh-tunnel-connect host port)))))
(defun nrepl--direct-connect (host port &optional no-error)
"If HOST and PORT are given, try to `open-network-stream'.
If NO-ERROR is non-nil, show messages instead of throwing an error."
(if (not (and host port))
(unless no-error
(unless host
(error "[nREPL] Host not provided"))
(unless port
(error "[nREPL] Port not provided")))
(message "[nREPL] Establishing direct connection to %s:%s ..." host port)
(condition-case nil
(prog1 (list :proc (open-network-stream "nrepl-connection" nil host port)
:host host :port port)
(message "[nREPL] Direct connection to %s:%s established" host port))
(error (let ((msg (format "[nREPL] Direct connection to %s:%s failed" host port)))
(if no-error
(message msg)
(error msg))
nil)))))
(defun nrepl--ssh-tunnel-connect (host port)
"Connect to a remote machine identified by HOST and PORT through SSH tunnel."
(message "[nREPL] Establishing SSH tunneled connection to %s:%s ..." host port)
(let* ((file-name (or (buffer-file-name) nrepl-project-dir))
(remote-dir (cond
;; If current buffer is a TRAMP buffer and its host is
;; the same as HOST, reuse its connection parameters for
;; SSH tunnel.
((nrepl--ssh-file-name-matches-host-p file-name host) file-name)
;; Otherwise, if HOST was provided, use it for connection.
(host (format "/ssh:%s:" host))
;; Use default directory as fallback.
(t default-directory)))
(ssh (or (executable-find "ssh")
(error "[nREPL] Cannot locate 'ssh' executable")))
(cmd (nrepl--ssh-tunnel-command ssh remote-dir port))
(tunnel-buf (nrepl-tunnel-buffer-name
`((:host ,host) (:port ,port))))
(tunnel (start-process-shell-command "nrepl-tunnel" tunnel-buf cmd)))
(process-put tunnel :waiting-for-port t)
(set-process-filter tunnel (nrepl--ssh-tunnel-filter port))
(while (and (process-live-p tunnel)
(process-get tunnel :waiting-for-port))
(accept-process-output nil 0.005))
(if (not (process-live-p tunnel))
(error "[nREPL] SSH port forwarding failed. Check the '%s' buffer" tunnel-buf)
(message "[nREPL] SSH port forwarding established to localhost:%s" port)
(let ((endpoint (nrepl--direct-connect "localhost" port)))
(thread-first
endpoint
(plist-put :tunnel tunnel)
(plist-put :remote-host host))))))
(defun nrepl--ssh-tunnel-command (ssh dir port)
"Command string to open SSH tunnel to the host associated with DIR's PORT."
(with-parsed-tramp-file-name dir v
;; this abuses the -v option for ssh to get output when the port
;; forwarding is set up, which is used to synchronise on, so that
;; the port forwarding is up when we try to connect.
(format-spec
"%s -v -N -L %p:localhost:%p %u'%h' %n"
`((?s . ,ssh)
(?p . ,port)
(?h . ,v-host)
(?u . ,(if v-user (format "-l '%s' " v-user) ""))
(?n . ,(if v-port (format "-p '%s' " v-port) ""))))))
(autoload 'comint-watch-for-password-prompt "comint" "(autoload).")
(defun nrepl--ssh-tunnel-filter (port)
"Return a process filter that waits for PORT to appear in process output."
(let ((port-string (format "LOCALHOST:%s" port)))
(lambda (proc string)
(when (string-match-p port-string string)
(process-put proc :waiting-for-port nil))
(when (and (process-live-p proc)
(buffer-live-p (process-buffer proc)))
(with-current-buffer (process-buffer proc)
(let ((moving (= (point) (process-mark proc))))
(save-excursion
(goto-char (process-mark proc))
(insert string)
(set-marker (process-mark proc) (point))
(comint-watch-for-password-prompt string))
(if moving (goto-char (process-mark proc)))))))))
;;; Client: Process Handling
(defun nrepl--kill-process (proc)
"Attempt to kill PROC tree.
On MS-Windows, using the standard API is highly likely to leave the child
processes still running in the background as orphans. As a workaround, an
attempt is made to delegate the task to the `taskkill` program, which comes
with windows since at least Windows XP, and fallback to the Emacs API if it
can't be found.
It is expected that the `(process-status PROC)` return value after PROC is
killed is `exit` when `taskkill` is used and `signal` otherwise."
(cond
((and (eq system-type 'windows-nt)
(process-live-p proc)
(executable-find "taskkill"))
;; try to use `taskkill` if available
(with-temp-buffer
(call-process-shell-command (format "taskkill /PID %s /T /F" (process-id proc))
nil (buffer-name) )
;; useful for debugging.
;;(message ":PROCESS-KILL-OUPUT %s" (buffer-string))
))
((memq system-type '(cygwin windows-nt))
;; fallback, this is considered to work better than `kill-process` on
;; MS-Windows.
(interrupt-process proc))
(t (kill-process proc))))
(defun nrepl-kill-server-buffer (server-buf)
"Kill SERVER-BUF and its process."
(when (buffer-live-p server-buf)
(let ((proc (get-buffer-process server-buf)))
(when (process-live-p proc)
(set-process-query-on-exit-flag proc nil)
(nrepl--kill-process proc))
(kill-buffer server-buf))))
(defun nrepl--maybe-kill-server-buffer (server-buf)
"Kill SERVER-BUF and its process.
Do not kill the server if there is a REPL connected to that server."
(when (buffer-live-p server-buf)
(with-current-buffer server-buf
;; Don't kill if there is at least one REPL connected to it.
(when (not (seq-find (lambda (b)
(eq (buffer-local-value 'nrepl-server-buffer b)
server-buf))
(buffer-list)))
(nrepl-kill-server-buffer server-buf)))))
(defun nrepl-start-client-process (&optional host port server-proc buffer-builder socket-file)
"Create new client process identified by either HOST and PORT or SOCKET-FILE.
If SOCKET-FILE is non-nil, it takes precedence. In remote buffers, HOST
and PORT are taken from the current tramp connection. SERVER-PROC must be
a running nREPL server process within Emacs. BUFFER-BUILDER is a function
of one argument (endpoint returned by `nrepl-connect') which returns a
client buffer. Return the newly created client process."
(let* ((endpoint (if socket-file
(nrepl--unix-connect (expand-file-name socket-file))
(nrepl-connect host port)))
(client-proc (plist-get endpoint :proc))
(builder (or buffer-builder (error "`buffer-builder' must be provided")))
(client-buf (funcall builder endpoint)))
(set-process-buffer client-proc client-buf)
(set-process-filter client-proc #'nrepl-client-filter)
(set-process-sentinel client-proc #'nrepl-client-sentinel)
(set-process-coding-system client-proc 'utf-8-unix 'utf-8-unix)
(process-put client-proc :string-q (queue-create))
(process-put client-proc :response-q (nrepl-response-queue))
(with-current-buffer client-buf
(when-let* ((server-buf (and server-proc (process-buffer server-proc))))
(setq nrepl-project-dir (buffer-local-value 'nrepl-project-dir server-buf)
nrepl-server-buffer server-buf))
(setq nrepl-endpoint endpoint
nrepl-tunnel-buffer (when-let* ((tunnel (plist-get endpoint :tunnel)))
(process-buffer tunnel))
nrepl-pending-requests (make-hash-table :test 'equal)
nrepl-completed-requests (make-hash-table :test 'equal)))
(with-current-buffer client-buf
(nrepl--init-client-sessions client-proc)
(nrepl--init-capabilities client-buf)
(run-hooks 'nrepl-connected-hook))
client-proc))
(defun nrepl--init-client-sessions (client)
"Initialize CLIENT connection nREPL sessions.
We create two client nREPL sessions per connection - a main session and a
tooling session. The main session is general purpose and is used for pretty
much every request that needs a session. The tooling session is used only
for functionality that's implemented in terms of the \"eval\" op, so that
eval requests for functionality like pretty-printing won't clobber the
values of *1, *2, etc."
(let* ((client-conn (process-buffer client))
(response-main (nrepl-sync-request:clone client-conn))
(response-tooling (nrepl-sync-request:clone client-conn t))) ; t for tooling
(nrepl-dbind-response response-main (new-session err)
(if new-session
(with-current-buffer client-conn
(setq nrepl-session new-session))
(error "Could not create new session (%s)" err)))
(nrepl-dbind-response response-tooling (new-session err)
(if new-session
(with-current-buffer client-conn
(setq nrepl-tooling-session new-session))
(error "Could not create new tooling session (%s)" err)))))
(defun nrepl--init-capabilities (conn-buffer)
"Store locally in CONN-BUFFER the capabilities of nREPL server."
(let ((description (nrepl-sync-request:describe conn-buffer)))
(nrepl-dbind-response description (ops versions aux)
(with-current-buffer conn-buffer
(setq nrepl-ops ops)
(setq nrepl-versions versions)
(setq nrepl-aux aux)))))
(defun nrepl--clear-client-sessions (conn-buffer)
"Clear information about nREPL sessions in CONN-BUFFER.
CONN-BUFFER refers to a (presumably) dead connection,
which we can eventually reuse."
(with-current-buffer conn-buffer
(setq nrepl-session nil)
(setq nrepl-tooling-session nil)))
;;; Client: Response Handling
;; After being decoded, responses (aka, messages from the server) are dispatched
;; to handlers. Handlers are constructed with `nrepl-make-response-handler'.
(defvar nrepl-err-handler nil
"Evaluation error handler.")
(defun nrepl--mark-id-completed (id)
"Move ID from `nrepl-pending-requests' to `nrepl-completed-requests'.
It is safe to call this function multiple times on the same ID."
;; FIXME: This should go away eventually when we get rid of
;; pending-request hash table
(when-let* ((handler (gethash id nrepl-pending-requests)))
(puthash id handler nrepl-completed-requests)
(remhash id nrepl-pending-requests)))
(declare-function cider-repl--emit-interactive-output "cider-repl")
(defun nrepl-notify (msg type)
"Handle \"notification\" server request.
MSG is a string to be displayed. TYPE is the type of the message. All
notifications are currently displayed with `message' function and emitted
to the REPL."
(let* ((face (pcase type
((or "message" `nil) 'font-lock-builtin-face)
("warning" 'warning)
("error" 'error)))
(msg (if face
(propertize msg 'face face)
(format "%s: %s" (upcase type) msg))))
(cider-repl--emit-interactive-output msg (or face 'font-lock-builtin-face))
(message msg)))
(defvar cider-buffer-ns)
(defvar cider-print-quota)
(defvar cider-special-mode-truncate-lines)
(declare-function cider-need-input "cider-client")
(declare-function cider-set-buffer-ns "cider-mode")
(defun nrepl-make-response-handler (buffer value-handler stdout-handler
stderr-handler done-handler
&optional eval-error-handler
content-type-handler
truncated-handler)
"Make a response handler for connection BUFFER.
A handler is a function that takes one argument - response received from
the server process. The response is an alist that contains at least `id'
and `session' keys. Other standard response keys are `value', `out', `err',
and `status'.
The presence of a particular key determines the type of the response. For
example, if `value' key is present, the response is of type `value', if
`out' key is present the response is `stdout' etc.
Depending on the type, the handler dispatches the appropriate value to one
of the supplied handlers: VALUE-HANDLER, STDOUT-HANDLER, STDERR-HANDLER,
DONE-HANDLER, EVAL-ERROR-HANDLER, CONTENT-TYPE-HANDLER, and
TRUNCATED-HANDLER.
Handlers are functions of the buffer and the value they handle, except for
the optional CONTENT-TYPE-HANDLER which should be a function of the buffer,
content, the content-type to be handled as a list `(type attrs)'.
If the optional EVAL-ERROR-HANDLER is nil, the default `nrepl-err-handler'
is used. If any of the other supplied handlers are nil nothing happens for
the corresponding type of response."
(lambda (response)
(nrepl-dbind-response response (content-type content-transfer-encoding body
value ns out err status id)
(when (buffer-live-p buffer)
(with-current-buffer buffer
(when (and ns (not (cider-clojure-major-mode-p)))
(cider-set-buffer-ns ns))))
(cond ((and content-type content-type-handler)
(funcall content-type-handler buffer
(if (string= content-transfer-encoding "base64")
(base64-decode-string body)
body)
content-type))
(value
(when value-handler
(funcall value-handler buffer value)))
(out
(when stdout-handler
(funcall stdout-handler buffer out)))
(err
(when stderr-handler
(funcall stderr-handler buffer err)))
(status
(when (and truncated-handler (member "nrepl.middleware.print/truncated" status))
(let ((warning (format "\n... output truncated to %sB ..."
(file-size-human-readable cider-print-quota))))
(funcall truncated-handler buffer warning)))
(when (member "notification" status)
(nrepl-dbind-response response (msg type)
(nrepl-notify msg type)))
(when (member "interrupted" status)
(message "Evaluation interrupted."))
(when (member "eval-error" status)
(funcall (or eval-error-handler nrepl-err-handler) buffer))
(when (member "namespace-not-found" status)
(message "Namespace `%s' not found." ns))
(when (member "need-input" status)
(cider-need-input buffer))
(when (member "done" status)
(nrepl--mark-id-completed id)
(when done-handler
(funcall done-handler buffer))))))))
;;; Client: Request Core API
;; Requests are messages from an nREPL client (like CIDER) to an nREPL server.
;; Requests can be asynchronous (sent with `nrepl-send-request') or
;; synchronous (send with `nrepl-send-sync-request'). The request is a pair list
;; of operation name and operation parameters. The core operations are described
;; at https://github.com/nrepl/nrepl/blob/master/doc/ops.md. CIDER adds
;; many more operations through nREPL middleware. See
;; https://github.com/clojure-emacs/cider-nrepl#supplied-nrepl-middleware for
;; the up-to-date list.
(defun nrepl-next-request-id (connection)
"Return the next request id for CONNECTION."
(with-current-buffer connection
(number-to-string (cl-incf nrepl-request-counter))))
(defun nrepl-send-request (request callback connection &optional tooling)
"Send REQUEST and register response handler CALLBACK using CONNECTION.
REQUEST is a pair list of the form (\"op\" \"operation\" \"par1-name\"
\"par1\" ... ). See the code of `nrepl-request:clone',
`nrepl-request:stdin', etc. This expects that the REQUEST does not have a
session already in it. This code will add it as appropriate to prevent
connection/session drift.
Return the ID of the sent message.
Optional argument TOOLING Set to t if desiring the tooling session rather than
the standard session."
(with-current-buffer connection
(when-let* ((session (if tooling nrepl-tooling-session nrepl-session)))
(setq request (append request `("session" ,session))))
(let* ((id (nrepl-next-request-id connection))
(request (cons 'dict (lax-plist-put request "id" id)))
(message (nrepl-bencode request)))
(nrepl-log-message request 'request)
(puthash id callback nrepl-pending-requests)
(process-send-string nil message)
id)))
(defvar nrepl-ongoing-sync-request nil
"Dynamically bound to t while a sync request is ongoing.")
(declare-function cider-repl-emit-interactive-stderr "cider-repl")
(declare-function cider--render-stacktrace-causes "cider-eval")
(defun nrepl-send-sync-request (request connection &optional abort-on-input
tooling callback)
"Send REQUEST to the nREPL server synchronously using CONNECTION.
Hold till final \"done\" message has arrived and join all response messages
of the same \"op\" that came along.
If ABORT-ON-INPUT is non-nil, the function will return nil at the first
sign of user input, so as not to hang the interface.
If TOOLING, use the tooling session rather than the standard session.
If CALLBACK is non-nil, it will additionally be called on all received
messages. This shouldn't be used this for any control logic — use the
asynchronous `nrepl-send-request' directly for that. CALLBACK here should
be used to react to some intermediate events in an otherwise synchronous
command and e.g. notify the user about them."
(let* ((time0 (current-time))
(response (cons 'dict nil))
(nrepl-ongoing-sync-request t)
(cb (lambda (resp)
;; If caller has provided `callback', call it on the response.
(when callback
(funcall callback resp))
(nrepl--merge response resp)))
status)
(nrepl-send-request request cb connection tooling)
(while (and (not (member "done" status))
(not (and abort-on-input
(input-pending-p))))
(setq status (nrepl-dict-get response "status"))
;; If we get a need-input message then the repl probably isn't going
;; anywhere, and we'll just timeout. So we forward it to the user.
(if (member "need-input" status)
(progn (cider-need-input (current-buffer))
;; If the user took a few seconds to respond, we might
;; unnecessarily timeout, so let's reset the timer.
(setq time0 (current-time)))
;; break out in case we don't receive a response for a while
(when (and nrepl-sync-request-timeout
(time-less-p
nrepl-sync-request-timeout
(time-subtract nil time0)))
(error "Sync nREPL request timed out %s after %s secs" request nrepl-sync-request-timeout)))
;; Clean up the response, otherwise we might repeatedly ask for input.
(nrepl-dict-put response "status" (remove "need-input" status))
(accept-process-output nil 0.01))
;; If we couldn't finish, return nil.
(when (member "done" status)
(nrepl-dbind-response response (ex err eval-error pp-stacktrace id)
(when (and ex err)
(cond (eval-error (funcall nrepl-err-handler))
(pp-stacktrace (cider--render-stacktrace-causes
pp-stacktrace (remove "done" status))))) ;; send the error type
(when id
(with-current-buffer connection
(nrepl--mark-id-completed id)))
response))))
(defun nrepl-request:stdin (input callback connection)
"Send a :stdin request with INPUT using CONNECTION.
Register CALLBACK as the response handler."
(nrepl-send-request `("op" "stdin"
"stdin" ,input)
callback
connection))
(defun nrepl-request:interrupt (pending-request-id callback connection)
"Send an :interrupt request for PENDING-REQUEST-ID.
The request is dispatched using CONNECTION.
Register CALLBACK as the response handler."
(nrepl-send-request `("op" "interrupt"
"interrupt-id" ,pending-request-id)
callback
connection))