Merge pull request #952 from korayal/do-not-log-nonprintable-bytestrings

Use `decodeUtf8'` to check whether bytestrings are printable before logging

lib/amazonka-core/src/Amazonka/Data/Log.hs

@@ -17,6 +17,7 @@ import qualified Data.ByteString as BS
 import qualified Data.ByteString.Builder as Build
 import qualified Data.ByteString.Lazy as LBS
 import qualified Data.CaseInsensitive as CI
+import qualified Data.Char as Char
 import qualified Data.List as List
 import qualified Data.Text as Text
 import qualified Data.Text.Encoding as Text
@@ -34,10 +35,14 @@ instance ToLog ByteStringBuilder where
   build = id
 
 instance ToLog ByteStringLazy where
-  build = Build.lazyByteString
+  build lbs = case LText.decodeUtf8' lbs of
+    Right lt | LText.all Char.isPrint lt -> Build.lazyByteString lbs
+    _ -> mconcat ["non-printable lazy ByteString (", build (LBS.length lbs), " bytes)"]
 
 instance ToLog ByteString where
-  build = Build.byteString
+  build bs = case Text.decodeUtf8' bs of
+    Right t | Text.all Char.isPrint t -> Build.byteString bs
+    _ -> mconcat ["non-printable strict ByteString (", build (BS.length bs), " bytes)"]
 
 instance ToLog Int where
   build = Build.intDec

lib/amazonka/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## Unreleased
+
+- `amazonka`: During logging, do not print bytestrings that have unprintable characters
+[\#952](https://github.com/brendanhay/amazonka/pull/952)
+
 ## [2.0.0](https://github.com/brendanhay/amazonka/tree/2.0.0)
 Released: **28 July 2023**, Compare: [2.0.0-rc2](https://github.com/brendanhay/amazonka/compare/2.0.0-rc2...2.0.0)