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 未启用 autoFlush，以及大多数 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

此问题似乎已作为CLJ-2645提交到JIRA。

Answer 3

我们最近在Clojurian Slack上讨论了这个问题，@alex在这里请求进一步跟进。

客户端进行flush操作的问题在于消息将出现乱序。

清除要求未在文档中说明 - 虽然可以。

然而，在同一个namespace中维护的io-prepl（一个prepl客户端）的情况下，io-prepl或其客户端无法强制进行清除，因此错误消息丢失。

prepl的文档字符串说明将存在一个确切的:ret。

我假设一旦收到:ret标签，执行就已完成。我不确定一个prepl客户端程序除此之外还有其他理解执行完成的方式。

代码暗示这将是最后一条消息，但我理解它可能会变化。无论如何，如果不是那条消息，则必须有一种完成信号的表示。

Slack用户@flowthing提出了一个类似于你上面的修正方案。

(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之前）。

如果没有在核心实现这个修正，我将不得不(repo分叉)prepl和io-prepl，因为在外部代码中似乎没有其他明显的解决方案。

Answer 4

这里的基本问题在于*err*没有以受控的方式进行清除。

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

由于prepl将out和err绑定到PrintWriter-on上，这也将有效。

客户端必须向prepl传递一个outfn，并且通过io-prepl传递的函数将*flush-on-newline*绑定到true，这会被prn所尊重 - 每个值都会调用。

因此，对prn的调用确保out始终被清除。

对于*err*也存在类似的机制，它观察*flush-on-newline*，也可以提供解决所需的部分。

Comments

比较了两种方案并进行了一些测试后，发现通过新战绩添加到`PrinteWriter-on`的自动清除选项是一种更好的解决方案，感觉更为干净。

但我不想也fork核心函数，所以我目前会继续使用`binding`操作。

如果得到一些鼓励，我会很乐意提供补丁。

---

Go Ray Go! 你可以做到！ :)

---

没有预料到。好吧！

---

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