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

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 未设置自动刷新，以及大多数 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 询问在这里跟进。

客户端进行刷新时的问题在于消息将无序出现。

清除的要求没有文档化 - 尽管可以。

然而，对于在相同命名空间中维护的io-prepl客户端，即prepl客户端，io-prepl或其客户端无法强制执行清除，因此错误信息丢失。

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

我假设一旦接收到一个:ret标签，执行就完成了。我不确定还有其他方式让预pl客户端程序理解执行的完成。

代码暗示这将是最后一条消息，但我理解它会改变。无论如何，如果这并非如此的话，仍需要一些完成信号。

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自动清除。

这将也同样有效，因为预pl将out和err绑定到`PrintWriter-on`。

客户端必须向`prepl`传递一个`outfn`，而由`io-prepl`传递的函数将`*flush-on-newline*`绑定到true，该绑定被`prn`（在每次传递值时调用）尊重。

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

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

Comments

比较了这两种选项并进行了一些测试后，通过新的arity向`PrinteWriter-on`添加自动刷新选项是一种更干净、更有效的解决方案。

不过，我不想也分叉核心函数，所以我目前会继续使用`binding`技巧。

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

---

Go Ray Go! You can do this! :)

---

没想到会这样。好！

---

补丁已完成。我曾在那天签署过CCA，但没有JIRA账户