Prepl警告将保留在缓冲区中，直到客户端显式刷新

Question

在Prepl会话中，Clojure警告将保留，并且不会在没有客户端显式刷新的情况下发送到客户端。

以下是一个使用netcat的示例Prepl会话（以;;开头的行表示来自Prepl服务器的响应）

$ clojure -X clojure.core.server/start-server :name prepl :port 5555 :accept clojure.core.server/io-prepl :server-daemon false &
$ nc localhost 5555

(set! *warn-on-reflection* true)
;; {:tag :ret, :val "true", :ns "user", :ms 2, :form "(set! *warn-on-reflection* true)"}

(.toString (identity "foo"))
;; {:tag :ret, :val "\"foo\"", :ns "user", :ms 4, :form "(.toString (identity \"foo\"))"}
(binding [*out* *err*] (flush))
;; {:tag :err, :val "Reflection warning, NO_SOURCE_PATH:2:1 - reference to field toString can't be resolved.\n"}
;; {:tag :ret, :val "nil", :ns "user", :ms 4, :form "(binding [*out* *err*] (flush))"}

(defn identity [x] x)
;; {:tag :ret, :val "#'user/identity", :ns "user", :ms 3, :form "(defn identity [x] x)"}
(binding [*out* *err*] (flush))
;; {:tag :err, :val "WARNING: identity already refers to: #'clojure.core/identity in namespace: user, being replaced by: #'user/identity\n"}
;; {:tag :ret, :val "nil", :ns "user", :ms 2, :form "(binding [*out* *err*] (flush))"}

这好像是由Prepl的*err* PrintWriter没有被设置为自动刷新，以及大多数Clojure警告没有被显式刷新的导致的。

这是一个应该解决的问题吗？还是这是一个预期的行为，客户端有责任及时刷新错误流？

Answer 1

这里有一个补丁。我没有其他方式来贡献这个。

From 52fe3111bf0f8f769121bdc2c383a3f11aac695f Mon Sep 17 00:00:00 2001
From: Ray McDermott <[email protected]>
Date: Tue, 26 Apr 2022 21:52:21 +0200
Subject: [PATCH] Fix for #CLJ-2645

---
 src/clj/clojure/core/server.clj |  4 ++--
 src/clj/clojure/core_print.clj  | 41 ++++++++++++++++++---------------
 2 files changed, 24 insertions(+), 21 deletions(-)

diff --git a/src/clj/clojure/core/server.clj b/src/clj/clojure/core/server.clj
index 3cda4d1f74..c774cab3b5 100644
--- a/src/clj/clojure/core/server.clj
+++ b/src/clj/clojure/core/server.clj
@@ -220,8 +220,8 @@
     (m/with-bindings
       (in-ns 'user)
       (binding [*in* (or stdin in-reader)
-                *out* (PrintWriter-on #(out-fn {:tag :out :val %1}) nil)
-                *err* (PrintWriter-on #(out-fn {:tag :err :val %1}) nil)]
+                *out* (PrintWriter-on #(out-fn {:tag :out :val %1}) nil true)
+                *err* (PrintWriter-on #(out-fn {:tag :err :val %1}) nil true)]
         (try
           (add-tap tapfn)
           (loop []
diff --git a/src/clj/clojure/core_print.clj b/src/clj/clojure/core_print.clj
index 18c5101c1d..4f10b780a1 100644
--- a/src/clj/clojure/core_print.clj
+++ b/src/clj/clojure/core_print.clj
@@ -559,23 +559,26 @@
 (defn ^java.io.PrintWriter PrintWriter-on
   "implements java.io.PrintWriter given flush-fn, which will be called
   when .flush() is called, with a string built up since the last call to .flush().
-  if not nil, close-fn will be called with no arguments when .close is called"
+  if not nil, close-fn will be called with no arguments when .close is called.
+  autoflush? determines if the PrintWriter will autoflush, false by default."
   {:added "1.10"}
-  [flush-fn close-fn]
-  (let [sb (StringBuilder.)]
-    (-> (proxy [Writer] []
-          (flush []
-                 (when (pos? (.length sb))
-                   (flush-fn (.toString sb)))
-                 (.setLength sb 0))
-          (close []
-                 (.flush ^Writer this)
-                 (when close-fn (close-fn))
-                 nil)
-          (write [str-cbuf off len]
-                 (when (pos? len)
-                   (if (instance? String str-cbuf)
-                     (.append sb ^String str-cbuf ^int off ^int len)
-                     (.append sb ^chars str-cbuf ^int off ^int len)))))
-        java.io.BufferedWriter.
-        java.io.PrintWriter.)))
+  ([flush-fn close-fn]
+   (PrintWriter-on flush-fn close-fn false))
+  ([flush-fn close-fn autoflush?]
+   (let [sb (StringBuilder.)]
+     (-> (proxy [Writer] []
+           (flush []
+             (when (pos? (.length sb))
+               (flush-fn (.toString sb)))
+             (.setLength sb 0))
+           (close []
+             (.flush ^Writer this)
+             (when close-fn (close-fn))
+             nil)
+           (write [str-cbuf off len]
+             (when (pos? len)
+               (if (instance? String str-cbuf)
+                 (.append sb ^String str-cbuf ^int off ^int len)
+                 (.append sb ^chars str-cbuf ^int off ^int len)))))
+         java.io.BufferedWriter.
+         (java.io.PrintWriter. ^boolean autoflush?)))))

Comments

已添加到JIRA问题中

---

我们已将此问题添加到1.12候选人列表中，并在第一时间进行跟进。感谢您的贡献！

---

感谢您的鼓励：）

Answer 2

这个问题似乎已经在JIRA上以 CLJ-2645 的形式提交。

Answer 3

我们最近在 Clojurian Slack 上讨论了这个问题，@alex 提醒在这里跟进。

客户端进行刷新的问题在于消息会显示顺序不当。

刷新的需求未在文档中记录 —— 尽管它可以。

然而，在这种情况下，对于维护在相同ns中的预置客户端io-prepl，io-prepl或其客户端无法强制刷新，因此错误消息会丢失。

prepl的文档字符串说明将正好有一个:ret。

我假设一旦接收到:ret标签，执行就完成了。我不确定预置客户端程序还应该如何理解执行的完成。

代码表明这个消息被期望是最后一个，但是我知道它可能会改变。无论如何，如果它不是那个消息，则需要某种完成信号。

Slack用户@flowthing提出了一个类似你展示的方案的prepl修复。

(when-not (= :repl/quit ret)
  (set! *3 *2)

被替换为

(when-not (= :repl/quit ret)
  (binding [*out* *err*] (flush)) ; this is the only difference to the original
  (set! *3 *2)

这是一个简单的修复，确保所有prepl客户端都能够及时且按正确顺序（即:ret之前）收到错误。

如果没有这个核心修复，我不得不分叉prepl和io-prepl，因为没有其他明显的方式可以从外部代码解决这个问题。

Answer 4

这里的基本问题是*err*没有被控制地刷新。

为了完整性，Slack用户@flowthing还提出了一种可能性，即在PrintWriter-on中添加一个选项，或另一个PrintWriter包装器，以使底层的Writer自动刷新。

这也会起作用，因为prepl将out和err绑定到PrintWriter-on。

客户端必须传递一个outfn给prepl，而由io-prepl传递的函数将*flush-on-newline*绑定到true，这得到了prn（在每一个值上调用）的尊重。

因此，对prn的调用将始终确保out被刷新。

对于*err*，一个类似prn的机制，会观察*flush-on-newline*，也可以提供解决方案所需的部分。

Comments

通过与这两种选项进行比较和一些测试后，我将通过一个新得参号码将自动刷新选项添加到`PrinteWriter-on`，感觉像是一个更干净得解决方案。

我不希望还要分叉核心函数，所以我现在会坚持使用`binding`伪造技术。

如果得到一些鼓励，我将很高兴提供补丁。

---

Go Ray Go! 你能行！:)

---

没想到是这个。好的！

---

补丁已完成。我以前签过CCA，但没有JIRA账户