Fix KillSignal arg; add fromKillSignal (#51)

* Add fromKillSignal

* Fix kill signal arg

Author: JordanMartinez

CHANGELOG.md

@@ -12,7 +12,17 @@ Bugfixes:
 
 Other improvements:
 
-## [v10.1.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v10.1.0) - 2023-07-25
+## [v11.0.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v11.0.0) - 2023-07-25
+
+Breaking changes:
+- Update the signal arg from `String` to `KillSignal` (#51 by @JordanMartinez)
+
+  - `Exit`'s `BySignal` constructor's arg
+  - `exitH`/`closeH`'s signal arg
+  - `spawnSync`'s `SpawnResult`'s `signal` field
+
+New features:
+- Added `fromKillSignal` (#51 by @JordanMartinez)
 
 Other improvements:
 - Fix regression: add `ref`/`unref` APIs that were dropped in `v10.0.0` (#50 by @JordanMartinez)

src/Node/ChildProcess/Types.js

@@ -0,0 +1,6 @@
+export const fromKillSignalImpl = (left, right, sig) => {
+  const ty = typeof sig;
+  if (ty === "number") return right(sig | 0);
+  if (ty === "string") return left(sig);
+  throw new Error("Impossible. Got kill signal that was neither int nor string: " + sig);
+};

src/Node/ChildProcess/Types.purs

@@ -1,7 +1,31 @@
-module Node.ChildProcess.Types where
+module Node.ChildProcess.Types
+  ( UnsafeChildProcess
+  , Handle
+  , StdIO
+  , pipe
+  , ignore
+  , overlapped
+  , ipc
+  , inherit
+  , shareStream
+  , fileDescriptor
+  , fileDescriptor'
+  , defaultStdIO
+  , KillSignal
+  , intSignal
+  , stringSignal
+  , fromKillSignal
+  , Shell
+  , enableShell
+  , customShell
+  , StringOrBuffer
+  , Exit(..)
+  ) where
 
 import Prelude
 
+import Data.Either (Either(..), either)
+import Data.Function.Uncurried (Fn3, runFn3)
 import Data.Nullable (Nullable, null)
 import Node.FS (FileDescriptor)
 import Node.Stream (Stream)
@@ -54,6 +78,11 @@ intSignal = unsafeCoerce
 stringSignal :: String -> KillSignal
 stringSignal = unsafeCoerce
 
+fromKillSignal :: KillSignal -> Either Int String
+fromKillSignal sig = runFn3 fromKillSignalImpl Left Right sig
+
+foreign import fromKillSignalImpl :: Fn3 (forall l r. l -> Either l r) (forall l r. r -> Either l r) (KillSignal) (Either Int String)
+
 foreign import data Shell :: Type
 
 enableShell :: Shell
@@ -70,8 +99,8 @@ foreign import data StringOrBuffer :: Type
 -- | due to a signal.
 data Exit
   = Normally Int
-  | BySignal String
+  | BySignal KillSignal
 
 instance showExit :: Show Exit where
   show (Normally x) = "Normally " <> show x
-  show (BySignal sig) = "BySignal " <> show sig
+  show (BySignal sig) = "BySignal " <> (either show show $ fromKillSignal sig)

src/Node/UnsafeChildProcess/Safe.purs

@@ -36,7 +36,7 @@ import Data.Posix.Signal as Signal
 import Effect (Effect)
 import Effect.Uncurried (EffectFn1, EffectFn2, mkEffectFn1, mkEffectFn2, runEffectFn1, runEffectFn2)
 import Foreign (Foreign)
-import Node.ChildProcess.Types (Exit(..), Handle, StdIO, UnsafeChildProcess, ipc, pipe)
+import Node.ChildProcess.Types (Exit(..), Handle, KillSignal, StdIO, UnsafeChildProcess, ipc, pipe)
 import Node.Errors.SystemError (SystemError)
 import Node.EventEmitter (EventEmitter, EventHandle(..))
 import Node.EventEmitter.UtilTypes (EventHandle0, EventHandle1)
@@ -46,25 +46,25 @@ import Unsafe.Coerce (unsafeCoerce)
 toEventEmitter :: UnsafeChildProcess -> EventEmitter
 toEventEmitter = unsafeCoerce
 
-closeH :: EventHandle UnsafeChildProcess (Exit -> Effect Unit) (EffectFn2 (Nullable Int) (Nullable String) Unit)
+closeH :: EventHandle UnsafeChildProcess (Exit -> Effect Unit) (EffectFn2 (Nullable Int) (Nullable KillSignal) Unit)
 closeH = EventHandle "close" \cb -> mkEffectFn2 \code signal ->
   case toMaybe code, toMaybe signal of
     Just c, _ -> cb $ Normally c
     _, Just s -> cb $ BySignal s
-    _, _ -> unsafeCrashWith $ "Impossible. 'close' event did not get an exit code or kill signal: " <> show code <> "; " <> show signal
+    _, _ -> unsafeCrashWith $ "Impossible. 'close' event did not get an exit code or kill signal: " <> show code <> "; " <> (unsafeCoerce signal)
 
 disconnectH :: EventHandle0 UnsafeChildProcess
 disconnectH = EventHandle "disconnect" identity
 
 errorH :: EventHandle1 UnsafeChildProcess SystemError
 errorH = EventHandle "error" mkEffectFn1
 
-exitH :: EventHandle UnsafeChildProcess (Exit -> Effect Unit) (EffectFn2 (Nullable Int) (Nullable String) Unit)
+exitH :: EventHandle UnsafeChildProcess (Exit -> Effect Unit) (EffectFn2 (Nullable Int) (Nullable KillSignal) Unit)
 exitH = EventHandle "exitH" \cb -> mkEffectFn2 \code signal ->
   case toMaybe code, toMaybe signal of
     Just c, _ -> cb $ Normally c
     _, Just s -> cb $ BySignal s
-    _, _ -> unsafeCrashWith $ "Impossible. 'exit' event did not get an exit code or kill signal: " <> show code <> "; " <> show signal
+    _, _ -> unsafeCrashWith $ "Impossible. 'exit' event did not get an exit code or kill signal: " <> show code <> "; " <> (unsafeCoerce signal)
 
 messageH :: EventHandle UnsafeChildProcess (Foreign -> Maybe Handle -> Effect Unit) (EffectFn2 Foreign (Nullable Handle) Unit)
 messageH = EventHandle "message" \cb -> mkEffectFn2 \a b -> cb a $ toMaybe b

src/Node/UnsafeChildProcess/Unsafe.purs

@@ -290,7 +290,7 @@ type JsSpawnSyncResult =
   , stdout :: StringOrBuffer
   , stderr :: StringOrBuffer
   , status :: Nullable Int
-  , signal :: Nullable String
+  , signal :: Nullable KillSignal
   , error :: Nullable SystemError
   }
 

test/Main.purs

@@ -2,14 +2,15 @@ module Test.Main where
 
 import Prelude
 
+import Data.Either (hush)
 import Data.Maybe (Maybe(..))
 import Data.Posix.Signal (Signal(..))
 import Data.Posix.Signal as Signal
 import Effect (Effect)
 import Effect.Console (log)
 import Node.Buffer as Buffer
 import Node.ChildProcess (errorH, exec', execSync', exitH, kill, spawn, stdout)
-import Node.ChildProcess.Types (Exit(..))
+import Node.ChildProcess.Types (Exit(..), fromKillSignal)
 import Node.Encoding (Encoding(..))
 import Node.Encoding as NE
 import Node.Errors.SystemError (code)
@@ -40,7 +41,7 @@ main = do
     _ <- kill ls
     ls # on_ exitH \exit ->
       case exit of
-        BySignal s | Just SIGTERM <- Signal.fromString s ->
+        BySignal s | Just SIGTERM <- Signal.fromString =<< (hush $ fromKillSignal s) ->
           log "All good!"
         _ -> do
           log ("Bad exit: expected `BySignal SIGTERM`, got: " <> show exit)