Skip to content

Commit

Permalink
Ensure that waitForProcess is never called multiple times (fixes fp…
Browse files Browse the repository at this point in the history
  • Loading branch information
sol committed May 11, 2023
1 parent 971f04a commit f495e21
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 23 deletions.
5 changes: 5 additions & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# ChangeLog for typed-process

## 0.2.12.0

* Ensure that `waitForProcess` is never called multiple times
[#69](https://github.com/fpco/typed-process/pull/69)

## 0.2.11.0

* Expose more from `System.Process.Typed.Internal`
Expand Down
2 changes: 1 addition & 1 deletion package.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: typed-process
version: 0.2.11.0
version: 0.2.12.0
synopsis: Run external processes, with strong typing of streams
description: Please see the tutorial at <https://github.com/fpco/typed-process#readme>
category: System
Expand Down
35 changes: 13 additions & 22 deletions src/System/Process/Typed.hs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{-# LANGUAGE CPP #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE RecordWildCards #-}
Expand Down Expand Up @@ -135,8 +136,9 @@ import qualified System.Process as P
import System.IO (hClose)
import System.IO.Error (isPermissionError)
import Control.Concurrent (threadDelay)
import Control.Concurrent.Async (asyncWithUnmask, cancel, waitCatch)
import Control.Concurrent.STM (newEmptyTMVarIO, atomically, putTMVar, TMVar, readTMVar, tryReadTMVar, STM, tryPutTMVar, throwSTM, catchSTM)
import Control.Concurrent.Async (asyncWithUnmask)
import qualified Control.Concurrent.Async as Async
import Control.Concurrent.STM (newEmptyTMVarIO, atomically, putTMVar, TMVar, readTMVar, tryReadTMVar, STM, throwSTM, catchSTM)
import System.Exit (ExitCode (ExitSuccess, ExitFailure))
import System.Process.Typed.Internal
import qualified Data.ByteString.Lazy as L
Expand Down Expand Up @@ -239,23 +241,12 @@ startProcess pConfig'@ProcessConfig {..} = liftIO $ do
atomically $ putTMVar pExitCode ec
return ec

let waitForProcess = Async.wait waitingThread :: IO ExitCode

let pCleanup = pCleanup1 `finally` do
-- First: stop calling waitForProcess, so that we can
-- avoid race conditions where the process is removed from
-- the system process table while we're trying to
-- terminate it.
cancel waitingThread

-- Now check if the process had already exited
eec <- waitCatch waitingThread

case eec of
-- Process already exited, nothing to do
Right _ec -> return ()

-- Process didn't exit yet, let's terminate it and
-- then call waitForProcess ourselves
Left _ -> do
_ :: ExitCode <- Async.poll waitingThread >>= \ case
Just r -> either throwIO return r
Nothing -> do
eres <- try $ P.terminateProcess pHandle
ec <-
case eres of
Expand All @@ -272,11 +263,11 @@ startProcess pConfig'@ProcessConfig {..} = liftIO $ do
-- Recommendation: always use the multi-threaded
-- runtime!
| isPermissionError e && not multiThreadedRuntime && isWindows ->
P.waitForProcess pHandle
waitForProcess
| otherwise -> throwIO e
Right () -> P.waitForProcess pHandle
success <- atomically $ tryPutTMVar pExitCode ec
evaluate $ assert success ()
Right () -> waitForProcess
return ec
return ()

return Process {..}
where
Expand Down
11 changes: 11 additions & 0 deletions test/System/Process/TypedSpec.hs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ module System.Process.TypedSpec (spec) where
import System.Process.Typed
import System.Process.Typed.Internal
import System.IO
import Control.Exception
import Control.Concurrent (threadDelay)
import Control.Concurrent.Async (Concurrently (..))
import Control.Concurrent.STM (atomically)
import Test.Hspec
Expand Down Expand Up @@ -170,3 +172,12 @@ spec = do
it "empty param are showed" $
let expected = "Raw command: podman exec --detach-keys \"\" ctx bash\n"
in show (proc "podman" ["exec", "--detach-keys", "", "ctx", "bash"]) `shouldBe` expected

describe "stopProcess" $ do
it "never calls waitForProcess multiple times (fix for #69)" $ do
-- https://github.com/fpco/typed-process/issues/69
let config = setStdout createPipe (proc "echo" ["foo"])
withProcessWait config $ \p -> do
_ <- S.hGetContents (getStdout p)
throwIO DivideByZero
`shouldThrow` (== DivideByZero)

0 comments on commit f495e21

Please sign in to comment.