预建警告剩余缓冲，直到客户端显式刷新

Question

在预建会话中，Clojure 警告会保持缓冲，除非客户端明确刷新，否则不会发送到客户端。

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

$ 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))"}

这似乎是由于预建的 *err* PrintWriter 未启用 auto flushing 以及大多数 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 希望在这里跟进。

客户端执行刷新的问题在于消息将出现顺序混乱。

刷新的需求没有文档记录——尽管可以添加。

但是，在同一个ns中维护的 io-prepl ，这是 prepl 客户端的情况下， io-prepl 或其客户端无法执行刷新操作，因此错误消息丢失。

prepl 的文档字符串表示将恰好有一个 :ret 。

我假设在接收到一个 :ret 标记后执行就完成了。我不确定预脚本客户端程序应该如何理解执行的完成。

代码暗示这应该是最后一条消息，但我理解这可能会改变。无论如何，如果不是这一条，则需要某种完成信号。

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 之前）收到错误信息。

在没有这个修复的情况下，我不得不分叉 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。

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

Comments

在比较了两种选项并进行了一些测试后，通过新的arity添加到 `PrinteWriter-on` 的自刷新选项效果很好，感觉是一个更干净的解决方案。

但我不想也分叉核心函数，所以现在我会坚持使用 `binding` 黑客技术。

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

---

加油，Ray！你可以做到！ :)

---

没有预料到这一点。好的！

---

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