WIP errors and cancelling

Author: jamesdbrock

packages.dhall

@@ -99,9 +99,7 @@ in  upstream
 -------------------------------
 -}
 let upstream =
-      https://github.com/purescript/package-sets/releases/download/psc-0.15.2-20220621/packages.dhall
-        sha256:78caab14e4d8ff3886a057f0380c2d4a2500e2ee7ab5c1d32a0f9ce5c71eedd8
+      https://github.com/purescript/package-sets/releases/download/psc-0.15.4-20221102/packages.dhall
+        sha256:8628e413718876ce26983db1d0ce9d9e1588129117fa3bb8ed9f618db6914127
 
 in  upstream
-
-	with node-streams-aff = /home/jbrock/work/me/purescript-node-streams-aff/spago.dhall as Location

spago.dhall

@@ -34,11 +34,13 @@ to generate this file without the comments in this block.
   , "options"
   , "partial"
   , "prelude"
+  , "record"
   , "st"
   , "strings"
   , "transformers"
   , "tuples"
   , "unsafe-coerce"
+  , "web-fetch"
   ]
 , packages = ./packages.dhall
 , sources = [ "src/**/*.purs", "test/**/*.purs" ]

src/Node/HTTP2.purs

@@ -1,5 +1,8 @@
 -- | Bindings to the [*Node.js* HTTP/2](https://nodejs.org/docs/latest/api/http2.html) API.
 -- |
+-- | Requires *Node.js v14.17.0* (for
+-- | [`AbortController`](https://nodejs.org/docs/latest/api/globals.html#class-abortcontroller))
+-- |
 -- | The __Node.HTTP2.Client__ and __Node.HTTP2.Server__ modules provide a
 -- | low-level `Effect` callback API.
 -- |
@@ -13,11 +16,9 @@ module Node.HTTP2
   , headerString
   , headerArray
   , headerStatus
-  , OptionsObject
+  , Options
   , toOptions
   , Flags
-  , toStringUTF8
-  , fromStringUTF8
   )
   where
 
@@ -27,19 +28,26 @@ import Control.Monad.Except (runExcept)
 import Data.Either (hush)
 import Data.Maybe (Maybe)
 import Data.Traversable (traverse)
-import Effect.Class (class MonadEffect, liftEffect)
 import Foreign (Foreign, readArray, readInt, readString, unsafeToForeign)
 import Foreign.Index (readProp)
-import Foreign.Object (Object, keys)
-import Node.Buffer (Buffer)
-import Node.Buffer as Buffer
-import Node.Encoding as Encoding
+import Foreign.Object (Object, keys, union)
 import Unsafe.Coerce (unsafeCoerce)
 
 -- | HTTP headers object. Construct with the `toHeaders` function.
 -- |
 -- | https://nodejs.org/docs/latest/api/http2.html#headers-object
-foreign import data Headers :: Type
+-- |
+-- | The `Monoid` instance allows us to merge `Headers`. The headers in the
+-- | first, left-side `Headers` will override the second `Headers`.
+newtype Headers = Headers Foreign
+
+instance Semigroup Headers where
+  append l r = unsafeCoerce $ union (unsafeCoerce l) (unsafeCoerce r)
+
+instance Monoid Headers where
+  mempty = unsafeCoerce {}
+
+
 
 -- | https://nodejs.org/docs/latest/api/http2.html#headers-object
 -- |
@@ -63,7 +71,7 @@ foreign import data Headers :: Type
 -- |   }
 -- | ```
 toHeaders :: forall r. Record r -> Headers
-toHeaders = unsafeCoerce
+toHeaders = Headers <<< unsafeToForeign
 
 -- | Get all of the keys from a `Headers`.
 -- |
@@ -94,19 +102,21 @@ headerStatus h = hush $ runExcept do
 -- | https://httpwg.org/specs/rfc7540.html#FrameHeader
 type Flags = Int
 
--- | A type alias for `Foreign` which represents an `Object` with option properties.
+-- | A type which represents an `Object` with option properties.
 -- |
 -- | The “no options” literal is `toOptions {}`.
-type OptionsObject = Foreign
+-- |
+-- | The `Monoid` instance allows us to merge `Options`s. The options
+-- | in the first, left-side `Options` will override the
+-- | second `Options`.
+newtype Options = Options Foreign
 
--- | Use this function to construct an `OptionsObject`.
-toOptions :: forall r. Record r -> OptionsObject
-toOptions = unsafeToForeign
+instance Semigroup Options where
+  append l r = unsafeCoerce $ union (unsafeCoerce l) (unsafeCoerce r)
 
--- | Concatenate an `Array` of UTF-8 encoded `Buffer`s into a `String`.
-toStringUTF8 :: forall m. MonadEffect m => Array Buffer -> m String
-toStringUTF8 bs = liftEffect $ Buffer.toString Encoding.UTF8 =<< Buffer.concat bs
+instance Monoid Options where
+  mempty = toOptions {}
 
--- | Encode a `String` as an `Array` containing one UTF-8 encoded `Buffer`.
-fromStringUTF8 :: forall m. MonadEffect m => String -> m (Array Buffer)
-fromStringUTF8 s = liftEffect $ map pure $ Buffer.fromString s Encoding.UTF8
+-- | Use this function to construct an `Options`.
+toOptions :: forall r. Record r -> Options
+toOptions = Options <<< unsafeToForeign

src/Node/HTTP2/Client.Aff.purs

@@ -44,19 +44,22 @@ import Prelude
 
 import Data.Either (Either(..))
 import Effect.Aff (Aff, effectCanceler, makeAff, nonCanceler)
-import Node.HTTP2 (Headers, OptionsObject)
+import Effect.Exception (catchException)
+import Node.HTTP2 (Headers, Options, toOptions)
 import Node.HTTP2.Client (ClientHttp2Session, ClientHttp2Stream)
 import Node.HTTP2.Client (ClientHttp2Session, ClientHttp2Stream, toDuplex) as ReClient
 import Node.HTTP2.Client as Client
 import Node.URL (URL)
+import Web.Fetch.AbortController as Web.Fetch.AbortController
 
 -- | Connect a client `Http2Session`.
 -- |
 -- | See [`http2.connect(authority[, options][, listener])`](https://nodejs.org/docs/latest/api/http2.html#http2connectauthority-options-listener)
-connect :: OptionsObject -> URL -> Aff ClientHttp2Session
-connect optionsobject url = makeAff \complete -> do
-  void $ Client.connect url optionsobject
-    (\session _ -> complete (Right session))
+connect :: Options -> URL -> Aff ClientHttp2Session
+connect options url = makeAff \complete -> do
+  catchException (complete <<< Left) do
+    void $ Client.connect url options
+      (\session _ -> complete (Right session))
   pure nonCanceler
 
 -- | Gracefully closes the `Http2Session`, allowing any existing streams
@@ -66,7 +69,8 @@ connect optionsobject url = makeAff \complete -> do
 -- | See [`http2session.close([callback])`](https://nodejs.org/docs/latest/api/http2.html#http2sessionclosecallback)
 close :: ClientHttp2Session -> Aff Unit
 close session = makeAff \complete -> do
-  Client.close session (complete (Right unit))
+  catchException (complete <<< Left) do
+    Client.close session (complete (Right unit))
   pure nonCanceler
 
 -- | Send request headers to the connected server.
@@ -83,22 +87,26 @@ close session = makeAff \complete -> do
 -- | `waitResponse`
 -- | and
 -- | [`Node.Stream.Aff.readAll`](https://pursuit.purescript.org/packages/purescript-node-streams-aff/docs/Node.Stream.Aff#v:readAll).
-request :: ClientHttp2Session -> OptionsObject -> Headers -> Aff ClientHttp2Stream
-request session optionsobject headers = makeAff \complete -> do
-  -- how do we get errors out of the request? this is just a guess.
-  onceErrorCancel <- Client.onceErrorSession session \err -> complete (Left err)
-  stream <- Client.request session headers optionsobject
-  onceErrorCancel
-  complete (Right stream)
-  pure $ effectCanceler do
-    -- TODO signal <AbortSignal> An AbortSignal that may be used to abort an ongoing request.
-    onceErrorCancel
+request :: ClientHttp2Session -> Options -> Headers -> Aff ClientHttp2Stream
+request session options headers = makeAff \complete -> do
+    -- how do we get errors out of the request?
+    -- by catching exceptions? this is just a guess.
+    -- or maybe like this?
+    --
+    --     onceErrorCancel <- Client.onceErrorSession session \err -> complete (Left err)
+    --
+    abortcontroller <- Web.Fetch.AbortController.new
+    let abortsignal = Web.Fetch.AbortController.signal abortcontroller
+    stream <- catchException (pure <<< Left) do
+      Right <$> Client.request session headers (toOptions {"signal":abortsignal} <> options)
+    complete stream
+    pure $ effectCanceler do
+      Web.Fetch.AbortController.abort abortcontroller
 
 -- | Wait to receive response headers from the server.
 waitResponse :: ClientHttp2Stream -> Aff Headers
 waitResponse stream = makeAff \complete -> do
   onceResponseCancel <- Client.onceResponse stream \headers _ -> do
-    -- TODO error?
     complete (Right headers)
   pure $ effectCanceler do
     onceResponseCancel
@@ -118,10 +126,12 @@ waitPush
 waitPush session = makeAff \complete -> do
   onceStreamCancel <- Client.onceStream session \streamPushed headersRequest _ -> do
     _oncePushCancel <- Client.oncePush streamPushed \headersResponse _ ->
-      complete (Right { headersRequest, headersResponse, streamPushed})
+      complete (Right {headersRequest, headersResponse, streamPushed})
     pure unit
   pure $ effectCanceler do
-    -- TODO _oncePushCancel
+    -- I'm not sure how to _oncePushCancel.
+    -- I guess we don't need to _oncePushCancel because we won't really be
+    -- waiting on oncePush?
     onceStreamCancel
 
 -- | Wait for an additional block of headers to be received from a stream,

src/Node/HTTP2/Client.purs

@@ -58,7 +58,7 @@ import Prelude
 import Effect (Effect)
 import Effect.Exception (Error)
 import Node.Buffer (Buffer)
-import Node.HTTP2 (Flags, Headers, OptionsObject)
+import Node.HTTP2 (Flags, Headers, Options)
 import Node.HTTP2.Internal as Internal
 import Node.Net.Socket (Socket)
 import Node.Stream (Duplex)
@@ -71,15 +71,15 @@ import Unsafe.Coerce (unsafeCoerce)
 foreign import data ClientHttp2Session :: Type
 
 -- | https://nodejs.org/docs/latest/api/http2.html#http2connectauthority-options-listener
-foreign import connect :: URL -> OptionsObject -> (ClientHttp2Session -> Socket -> Effect Unit) -> Effect ClientHttp2Session
+foreign import connect :: URL -> Options -> (ClientHttp2Session -> Socket -> Effect Unit) -> Effect ClientHttp2Session
 
 -- | A client-side `Http2Stream`.
 -- |
 -- | See [__Class: ClientHttp2Stream__](https://nodejs.org/docs/latest/api/http2.html#class-clienthttp2stream)
 foreign import data ClientHttp2Stream :: Type
 
 -- |https://nodejs.org/docs/latest/api/http2.html#clienthttp2sessionrequestheaders-options
-foreign import request :: ClientHttp2Session -> Headers -> OptionsObject -> Effect ClientHttp2Stream
+foreign import request :: ClientHttp2Session -> Headers -> Options -> Effect ClientHttp2Stream
 
 -- | https://nodejs.org/docs/latest/api/http2.html#destruction
 foreign import destroy :: ClientHttp2Stream -> Effect Unit
@@ -122,7 +122,7 @@ foreign import oncePush :: ClientHttp2Stream -> (Headers -> Flags -> Effect Unit
 -- -- | https://nodejs.org/docs/latest/api/http2.html#http2streamrespondheaders-options
 -- -- |
 -- -- | https://www.rfc-editor.org/rfc/rfc7540#section-8.2.2
--- respond :: ClientHttp2Stream -> Headers -> OptionsObject -> Effect Unit
+-- respond :: ClientHttp2Stream -> Headers -> Options -> Effect Unit
 -- respond = unsafeCoerce Internal.respond
 
 -- | https://nodejs.org/docs/latest/api/http2.html#event-trailers

src/Node/HTTP2/Internal.purs

@@ -9,7 +9,7 @@ import Effect (Effect)
 import Effect.Exception (Error)
 import Foreign (Foreign)
 import Node.Buffer (Buffer)
-import Node.HTTP2 (Flags, Headers, OptionsObject)
+import Node.HTTP2 (Flags, Headers, Options)
 import Node.HTTP2.Constants (NGHTTP2)
 
 -- | Private type which can be coerced into `ClientHttp2Session`
@@ -76,7 +76,7 @@ foreign import data Http2Stream :: Type
 foreign import onceClose :: Http2Stream -> (NGHTTP2 -> Effect Unit) -> Effect (Effect Unit)
 
 -- | https://nodejs.org/docs/latest/api/http2.html#http2streamrespondheaders-options
-foreign import respond :: Http2Stream -> Headers -> OptionsObject -> Effect Unit
+foreign import respond :: Http2Stream -> Headers -> Options -> Effect Unit
 
 -- | https://nodejs.org/docs/latest/api/http2.html#event-wanttrailers
 foreign import onceWantTrailers :: Http2Stream -> Effect Unit -> Effect (Effect Unit)

src/Node/HTTP2/Server.Aff.purs

@@ -47,7 +47,7 @@ import Data.Nullable (toMaybe)
 import Effect.Aff (Aff, Error, effectCanceler, launchAff_, makeAff, nonCanceler)
 import Effect.Class (liftEffect)
 import Effect.Exception (catchException)
-import Node.HTTP2 (Headers, OptionsObject)
+import Node.HTTP2 (Headers, Options)
 import Node.HTTP2.Server (Http2SecureServer, Http2Server, ServerHttp2Stream)
 import Node.HTTP2.Server (Http2Server, Http2SecureServer, ServerHttp2Stream, toDuplex) as ReServer
 import Node.HTTP2.Server as Server
@@ -57,10 +57,10 @@ import Node.HTTP2.Server as Server
 -- |
 -- | Waits until the listening socket is open and then returns the `Http2Server`.
 -- |
--- | The first `OptionsObject` is the `createServer` options.
+-- | The first `Options` is the `createServer` options.
 -- | See [`http2.createServer([options][, onRequestHandler])`](https://nodejs.org/docs/latest/api/http2.html#http2createserveroptions-onrequesthandler)
 -- |
--- | The second `OptionsObject` is the `listen` options.
+-- | The second `Options` is the `listen` options.
 -- | See [`server.listen(options[, callback])`](https://nodejs.org/docs/latest/api/net.html#serverlistenoptions-callback)
 -- |
 -- | For each new client connection and request, the handler function will
@@ -69,8 +69,8 @@ import Node.HTTP2.Server as Server
 -- | For errors raised by the listening socket, there is an error handling
 -- | function which will also be invoked by `forkAff`.
 listen
-  :: OptionsObject
-  -> OptionsObject
+  :: Options
+  -> Options
   -> (Http2Server -> Error -> Aff Unit)
   -> (Http2Server -> Headers -> ServerHttp2Stream -> Aff Unit)
   -> Aff Http2Server
@@ -97,8 +97,8 @@ listen optionsserver optionslisten errorhandler handler = makeAff \complete -> d
 -- |
 -- | Secure version of `listen`.
 listenSecure
-  :: OptionsObject
-  -> OptionsObject
+  :: Options
+  -> Options
   -> (Http2SecureServer -> Error -> Aff Unit)
   -> (Http2SecureServer -> Headers -> ServerHttp2Stream -> Aff Unit)
   -> Aff Http2SecureServer
@@ -129,7 +129,7 @@ listenSecure optionsserver optionslisten errorhandler handler = makeAff \complet
 -- |
 -- | See
 -- | [`http2stream.respond([headers[, options]])`](https://nodejs.org/docs/latest/api/http2.html#http2streamrespondheaders-options)
-respond :: ServerHttp2Stream -> OptionsObject -> Headers -> Aff Unit
+respond :: ServerHttp2Stream -> Options -> Headers -> Aff Unit
 respond stream options headers = makeAff \complete -> do
   catchException (complete <<< Left) do
     Server.respond stream headers options
@@ -164,9 +164,9 @@ closeSecure server = makeAff \complete -> do
 -- | See [`http2stream.pushStream(headers[, options], callback)`](https://nodejs.org/docs/latest/api/http2.html#http2streampushstreamheaders-options-callback)
 -- |
 -- | > Calling `http2stream.pushStream()` from within a pushed stream is not permitted and will throw an error.
-pushStream :: ServerHttp2Stream -> OptionsObject -> Headers -> Aff ServerHttp2Stream
-pushStream stream optionsobject headersRequest = makeAff \complete -> do
-  Server.pushStream stream headersRequest optionsobject \nerr pushedstream _ -> do
+pushStream :: ServerHttp2Stream -> Options -> Headers -> Aff ServerHttp2Stream
+pushStream stream options headersRequest = makeAff \complete -> do
+  Server.pushStream stream headersRequest options \nerr pushedstream _ -> do
     case toMaybe nerr of
       Just err -> complete (Left err)
       Nothing -> complete (Right pushedstream)

src/Node/HTTP2/Server.purs

@@ -61,7 +61,7 @@ import Prelude
 import Data.Nullable (Nullable)
 import Effect (Effect)
 import Effect.Exception (Error)
-import Node.HTTP2 (Flags, Headers, OptionsObject)
+import Node.HTTP2 (Flags, Headers, Options)
 import Node.HTTP2.Internal as Internal
 import Node.Stream (Duplex)
 import Unsafe.Coerce (unsafeCoerce)
@@ -72,10 +72,10 @@ import Unsafe.Coerce (unsafeCoerce)
 foreign import data Http2Server :: Type
 
 -- | https://nodejs.org/docs/latest/api/http2.html#http2createserveroptions-onrequesthandler
-foreign import createServer :: OptionsObject -> Effect Http2Server
+foreign import createServer :: Options -> Effect Http2Server
 
 -- | https://nodejs.org/docs/latest/api/net.html#serverlistenoptions-callback
-foreign import listen :: Http2Server -> OptionsObject -> Effect Unit -> Effect Unit
+foreign import listen :: Http2Server -> Options -> Effect Unit -> Effect Unit
 
 -- | https://nodejs.org/docs/latest/api/http2.html#serverclosecallback
 closeServer :: Http2Server -> Effect Unit -> Effect Unit
@@ -89,10 +89,10 @@ foreign import data Http2SecureServer :: Type
 -- | https://nodejs.org/docs/latest/api/http2.html#http2createsecureserveroptions-onrequesthandler
 -- |
 -- | Required options: `key :: String`, `cert :: String`.
-foreign import createSecureServer :: OptionsObject -> Effect Http2SecureServer
+foreign import createSecureServer :: Options -> Effect Http2SecureServer
 
 -- | https://nodejs.org/docs/latest/api/net.html#serverlistenoptions-callback
-listenSecure :: Http2SecureServer -> OptionsObject -> Effect Unit -> Effect Unit
+listenSecure :: Http2SecureServer -> Options -> Effect Unit -> Effect Unit
 listenSecure = unsafeCoerce listen
 
 -- | https://nodejs.org/docs/latest/api/http2.html#serverclosecallback
@@ -150,7 +150,7 @@ onStreamSecure :: Http2SecureServer -> (ServerHttp2Stream -> Headers -> Flags ->
 onStreamSecure = unsafeCoerce Internal.onStream
 
 -- | https://nodejs.org/docs/latest/api/http2.html#http2streamrespondheaders-options
-respond :: ServerHttp2Stream -> Headers -> OptionsObject -> Effect Unit
+respond :: ServerHttp2Stream -> Headers -> Options -> Effect Unit
 respond = unsafeCoerce Internal.respond
 
 -- | https://nodejs.org/docs/latest/api/http2.html#event-session_1
@@ -167,7 +167,7 @@ foreign import data ServerHttp2Stream :: Type
 -- | > Calling `http2stream.pushStream()` from within a pushed stream is not permitted and will throw an error.
 -- |
 -- | https://www.rfc-editor.org/rfc/rfc7540#section-8.2.1
-foreign import pushStream :: ServerHttp2Stream -> Headers -> OptionsObject -> (Nullable Error -> ServerHttp2Stream -> Headers -> Effect Unit) -> Effect Unit
+foreign import pushStream :: ServerHttp2Stream -> Headers -> Options -> (Nullable Error -> ServerHttp2Stream -> Headers -> Effect Unit) -> Effect Unit
 
 -- | https://nodejs.org/docs/latest/api/http2.html#http2streampushallowed
 foreign import pushAllowed :: ServerHttp2Stream -> Effect Boolean