Merge pull request #87 from input-output-hk/jdral/withErrors-exception-safe

Make `withErrors` exception safe

Author: jorisdral

fs-sim/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Revision history for fs-sim
 
+## ?.?.?.? -- ????-??-??
+
+### Breaking
+
+* Fix a bug where `withErrors` would not put back the previous `Errors` when an
+  exception is thrown during execution of the function. Though we fixed the bug,
+  it is also a breaking change: the type signature now has an additional
+  constraint.
+
 ## 0.3.1.0 -- 2024-12-10
 
 ### Non-breaking

fs-sim/src/System/FS/Sim/Error.hs

@@ -572,15 +572,12 @@ runSimErrorFS mockFS errors action = do
 
 -- | Execute the next action using the given 'Errors'. After the action is
 -- finished, the previous 'Errors' are restored.
-withErrors :: MonadSTM m => StrictTVar m Errors -> Errors -> m a -> m a
-withErrors errorsVar tempErrors action = do
-    originalErrors <- atomically $ do
-      originalErrors <- readTVar errorsVar
-      writeTVar errorsVar tempErrors
-      return originalErrors
-    res <- action
-    atomically $ writeTVar errorsVar originalErrors
-    return res
+withErrors :: (MonadSTM m, MonadThrow m) => StrictTVar m Errors -> Errors -> m a -> m a
+withErrors errorsVar tempErrors action =
+    bracket
+      (atomically $ swapTVar errorsVar tempErrors)
+      (\originalErrors -> atomically $ swapTVar errorsVar originalErrors)
+      $ \_ -> action
 
 {-------------------------------------------------------------------------------
   Utilities