From eb6b48dded5e543272e26bf6ec0a1b4071ef6614 Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Thu, 12 Jun 2025 17:25:31 -1000
Subject: [PATCH] fix:cli: don't raise an error if output is truncated in a
 pipe [#2405]

This broke in 1.43.

Now we ignore any IOException whose message contains "broken pipe".
Hopefully this matches pre-1.43 behaviour and doesn't hide real errors.
---
 hledger-lib/Hledger/Utils/IO.hs | 21 ++++++++++++++++++---
 hledger/test/cli/pipe.test      |  4 ++++
 2 files changed, 22 insertions(+), 3 deletions(-)
 create mode 100644 hledger/test/cli/pipe.test

diff --git a/hledger-lib/Hledger/Utils/IO.hs b/hledger-lib/Hledger/Utils/IO.hs
index edaf1779a..52e82510d 100644
--- a/hledger-lib/Hledger/Utils/IO.hs
+++ b/hledger-lib/Hledger/Utils/IO.hs
@@ -9,6 +9,7 @@ terminals, pager output, ANSI colour/styles, etc.
 {-# LANGUAGE OverloadedStrings   #-}
 {-# LANGUAGE PackageImports      #-}
 {-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE MultiWayIf #-}
 
 module Hledger.Utils.IO (
 
@@ -148,7 +149,7 @@ import           System.Console.ANSI (Color(..),ColorIntensity(..), ConsoleLayer
 import           System.Console.Terminal.Size (Window (Window), size)
 import           System.Directory (getHomeDirectory, getModificationTime, findExecutable)
 import           System.Environment (getArgs, lookupEnv, setEnv, getProgName)
-import           System.Exit (exitFailure)
+import           System.Exit (exitFailure, exitSuccess)
 import           System.FilePath (isRelative, (</>))
 import "Glob"    System.FilePath.Glob (glob)
 import           System.Info (os)
@@ -291,13 +292,27 @@ exitWithErrorMessage msg = printError msg >> exitFailure
 --
 exitOnError :: IO () -> IO ()
 exitOnError = flip catches
-  [-- Handler (\(e::SomeException) -> error' $ pshow e),  -- debug
+  [
+   -- Handler (\(e::SomeException) -> error' $ pshow e),  -- debug
    Handler (\(e::UnicodeException) -> exitUnicode e)
-  ,Handler (\(e::IOException) -> if isUnicodeError e then exitUnicode e else exitOther e)
+  ,Handler (\(e::IOException) -> if
+    | isUnicodeError e    -> exitUnicode e
+    | isBrokenPipeError e -> exitSuccess
+    | otherwise           -> exitOther e)
   ,Handler (\(e::ErrorCall) -> exitOther e)
   ]
 
   where
+    -- After adding the above handler, truncating program output eg by piping into head
+    -- showed "hledger: Error: <stdout>: commitBuffer: resource vanished ( Broken pipe )".
+    -- As far as I know, this is an IOException and the best we can do is check for that wording
+    -- and treat those as non-errors. (Will this mask any real errors ? XXX)
+    isBrokenPipeError :: Exception e => e -> Bool
+    isBrokenPipeError ex =
+      let msg = map toLower (show ex) in any (`isInfixOf` msg) [
+          "broken pipe"
+        ]
+
     -- Many decoding failures do not produce a UnicodeException, unfortunately.
     -- So this fragile hack detects them from the error message.
     -- But there are many variant wordings and they probably change over time.
diff --git a/hledger/test/cli/pipe.test b/hledger/test/cli/pipe.test
new file mode 100644
index 000000000..c34c77495
--- /dev/null
+++ b/hledger/test/cli/pipe.test
@@ -0,0 +1,4 @@
+# Tests related to using hledger in piped commands.
+# ** 1. Truncating output (including largeish output) in a pipe doesn't cause an error. (#2405)
+$ hledger -f bcexample.hledger print | head
+> /Opening Balance for checking account/