re-writing tests

Author: jamesdbrock

CHANGELOG.md

@@ -8,6 +8,10 @@ Breaking changes:
 
 New features:
 
+- New module `HTTP2`. Solves #44. (#45 by @jamesdbrock)
+- Use __spec__ for tests. Upgraded `ci.yml`. Solves #35. (#45 by @jamesdbrock)
+- New function `HTTP.onRequest`. Solves #46. (#45 by @jamesdbrock)
+
 Bugfixes:
 
 Other improvements:
@@ -32,7 +36,7 @@ New features:
 Other improvements:
   - Migrated CI to GitHub Actions, updated installation instructions to use Spago, and migrated from `jshint` to `eslint` (#30)
   - Added a changelog and pull request template (#34)
-  
+
 ## [v5.0.2](https://github.com/purescript-node/purescript-node-http/releases/tag/v5.0.2) - 2019-07-24
 
 - Relaxed upper bounds on `node-buffer`

spago.dhall

@@ -15,6 +15,7 @@
   , "newtype"
   , "node-buffer"
   , "node-net"
+  , "node-process"
   , "node-streams"
   , "node-streams-aff"
   , "node-url"

src/Node/HTTP.js

@@ -64,6 +64,16 @@ export function onUpgrade(server) {
   };
 }
 
+export function onRequest(server) {
+  return function (cb) {
+    return function () {
+      server.on("request", function (req, res) {
+        return cb(req)(res)();
+      });
+    };
+  };
+}
+
 export function setHeader(res) {
   return function (key) {
     return function (value) {

src/Node/HTTP.purs

@@ -12,6 +12,7 @@ module Node.HTTP
   , listenSocket
   , onConnect
   , onUpgrade
+  , onRequest
 
   , httpVersion
   , requestHeaders
@@ -77,6 +78,9 @@ foreign import onConnect :: Server -> (Request -> Socket -> Buffer -> Effect Uni
 -- | Listen to `upgrade` events on the server
 foreign import onUpgrade :: Server -> (Request -> Socket -> Buffer -> Effect Unit) -> Effect Unit
 
+-- | Listen to `request` events on the server
+foreign import onRequest :: Server -> (Request -> Response -> Effect Unit) -> Effect Unit
+
 -- | Get the request HTTP version
 httpVersion :: Request -> String
 httpVersion = _.httpVersion <<< unsafeCoerce

test/HTTP2.purs

@@ -4,24 +4,26 @@ import Prelude
 
 import Control.Monad.ST.Class (liftST)
 import Control.Monad.ST.Ref as ST.Ref
+import Data.Either (Either(..))
 import Data.Foldable (for_)
 import Data.Maybe (Maybe(..), fromMaybe)
 import Effect (Effect)
 import Effect.Console as Console
-import Effect.Exception (throwException)
+import Effect.Exception (Error, throwException)
 import Node.Encoding as Node.Encoding
 import Node.HTTP2 (headerKeys, headerString, sensitiveHeaders, toHeaders, toOptions)
 import Node.HTTP2.Client as HTTP2.Client
 import Node.HTTP2.Server as HTTP2.Server
 import Node.Stream as Node.Stream
 import Node.URL as URL
+import Test.MockCert (cert, key)
 import Unsafe.Coerce (unsafeCoerce)
 
-basic_serverSecure :: Effect Unit
-basic_serverSecure = do
+basic_serverSecure :: (Either Error Unit -> Effect Unit) -> Effect Unit
+basic_serverSecure complete = do
 
   server <- HTTP2.Server.createSecureServer
-    (toOptions { key: mockKey, cert: mockCert })
+    (toOptions { key: key, cert: cert })
 
   void $ HTTP2.Server.onceStreamSecure server \stream _ _ -> do
     HTTP2.Server.respond stream
@@ -41,7 +43,9 @@ basic_serverSecure = do
             Node.Stream.end (HTTP2.Server.toDuplex stream)
               $ case _ of
                   Just err -> throwException err
-                  Nothing -> HTTP2.Server.closeServerSecure server (pure unit)
+                  Nothing -> do
+                    HTTP2.Server.closeServerSecure server (pure unit)
+                    complete (Right unit)
 
   HTTP2.Server.listenSecure server
     (toOptions { port: 8443 })
@@ -52,7 +56,7 @@ basic_client = do
 
   clientsession <- HTTP2.Client.connect
     (URL.parse "https://localhost:8443")
-    (toOptions { ca: mockCert })
+    (toOptions { ca: cert })
     (\_ _ -> pure unit)
 
   clientstream <- HTTP2.Client.request clientsession
@@ -88,63 +92,3 @@ headers_sensitive = do
           { "cookie": "some-cookie"
           , "other-sensitive-header": "very secret data"
           }
-
--- https://letsencrypt.org/docs/certificates-for-localhost/#making-and-trusting-your-own-certificates
---
--- Generate localhost.crt and localhost.key with 10 year expiration:
---
---     openssl req -x509 -out localhost.crt -keyout localhost.key -newkey rsa:2048 -nodes -sha256 -days 3650 -subj '/CN=localhost' -extensions EXT -config <( printf "[dn]\nCN=localhost\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:localhost\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")
---
-
-mockCert :: String
-mockCert =
-  """-----BEGIN CERTIFICATE-----
-MIIDDzCCAfegAwIBAgIUUyn89RHpZC9irOiqJpcBqFRw2HgwDQYJKoZIhvcNAQEL
-BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTIyMTExODAyMTkyN1oXDTMyMTEx
-NTAyMTkyN1owFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF
-AAOCAQ8AMIIBCgKCAQEA0REkgizCB39n47Z3JXcW+GPPym4MXBb9HAHBJbH1+m/R
-0EkdunDyXr8cKveABgq3/kazWjXlGwNXUklKYCydcnmtNVBub4s1wXAsegRaPMmo
-RzisW7FWaqcLcBMAuwrub2NTVsX0HtO5qZiEKNx6AAbWFizFmMQ9K/9VprT1OLWy
-vtIOlR/YK+PKruNWeNpvhx91zmwb69lgrqUcwMHguLWgoz0JJgzh7cerexbT+eKC
-CuA9Ub8ctQD8SIl3eF7OzsvmQHSr+yABo3TJj7UZLh0B3j1uB8RLQvenVilc4YPz
-MK/R6Jf8RjRssGommbUqVaXRjJfYQ2As2tkzRS90cwIDAQABo1kwVzAUBgNVHREE
-DTALgglsb2NhbGhvc3QwCwYDVR0PBAQDAgeAMBMGA1UdJQQMMAoGCCsGAQUFBwMB
-MB0GA1UdDgQWBBS5+ngK++/FbHQ4Uf8qMZDK6tSNlDANBgkqhkiG9w0BAQsFAAOC
-AQEAj5nTUka4P/hWkV+Wa9Rp/ijqv2ah2ukU1u73QyprG2/gHmFpYvNFJ7lG9O9r
-Wuvsz4g4moX9kgt/9GnpUbZBUE7zPau74P06lFcXhKAhiZcpsS+CZbMIsbfilWS0
-SBbs8OTLvexOqPP4pTvlc67zPkuB3tjOnHhPar8VSAiBp2s0l6UF2vWZ69Xj3ice
-DadE6thrH41GN/OSROKWL6dEueNTuQaU1Rx9Nxh8hvKiDJZ7l8oiHGYERoGwJJro
-tWBqRvX/C4TpnS+ckhOyqrHUXN66lVaact9GaBd7n6oCKzDY/GtENCLJnNKte5VI
-SATt1Hpnw3S/zwX9imqABqneAA==
------END CERTIFICATE-----"""
-
-mockKey :: String
-mockKey =
-  """-----BEGIN PRIVATE KEY-----
-MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDRESSCLMIHf2fj
-tncldxb4Y8/KbgxcFv0cAcElsfX6b9HQSR26cPJevxwq94AGCrf+RrNaNeUbA1dS
-SUpgLJ1yea01UG5vizXBcCx6BFo8yahHOKxbsVZqpwtwEwC7Cu5vY1NWxfQe07mp
-mIQo3HoABtYWLMWYxD0r/1WmtPU4tbK+0g6VH9gr48qu41Z42m+HH3XObBvr2WCu
-pRzAweC4taCjPQkmDOHtx6t7FtP54oIK4D1Rvxy1APxIiXd4Xs7Oy+ZAdKv7IAGj
-dMmPtRkuHQHePW4HxEtC96dWKVzhg/Mwr9Hol/xGNGywaiaZtSpVpdGMl9hDYCza
-2TNFL3RzAgMBAAECggEAJggqTgv6WAbTTVdaIVSitxjhKgAO+4mrDbc7/bF7/8zr
-rCpA4DO/w4CcjSxs+6xjgDw4UEbRoLJg5jUy9H/pPHPqEHLLRDtc0g2n6aJ1D+3X
-UO18XUnLYKd2qzKpxVzdtyGofXaRTDJT6gg2soA5KVwVAf+vCnVYc3KFkEgG/AOt
-jhvbxK+xA4CGjGPYxASO5K3IVJxb419hi8dizgtdJaotysvfspth5WOOoiBtVhuB
-6ORZt9DbN1AK9U3nV76NsjHeQWcMsDqt8w/KRkok4X9rkQ86pylZcDUyoqkf+aYB
-09FgDiw2iSj9k6kkR0y1o/sRsCN7PoRmJgEhrRWPcQKBgQDlflzyoaVUCIAZQAMo
-O3vJE/AEOnvB+eHmqGSi6nGHUxJavxm8dxJRqY2fzA/VeVvp19Nxs1Eh8pskHav4
-n+syRtGzkKIE0x9/KThhgzbqZl+NT5afHMhUHvmepMf8J+71giMC2v2yQC0aFVi7
-3frv3YNuBbC69FWkeYOjq/MJZwKBgQDpNs6nYmtR3bLBWKoLSOTLGV8Bhhhzt+tu
-nm6LVA464ib039m5BoWne890InxgaDNHfuL++n473JFXuwQMBBY3YLD3OPa5uW4a
-gt+oYUJKh+qGio395GnZ0W/Sf5GBpdPJ+pTMqGqlo/NWSPuwCdMd5T6RfvnEJzzv
-0/jZCAJ5FQKBgCE2yaMADBp+ZHPDFPHksgSnEwy5niGz1aL5ah8+CRJJzpU9pS7m
-mMsi2/Ftqjj+KHROnTaOekaMgzGV7ca89mA/aagwXZKPL7bKs3NBd1gzWs7r3uPG
-WaP7G6t/M8ZlzSrRG9oU8bSznxNwVXhTJzdB+vyYbDySkjaMs6WjhDgvAoGBAJj0
-mE8R7r9Pv1it9UDXey91oWkXcNwciW4QvQHmjDq0bsZ2No7ypyA0xNgvchGs5c0D
-fI+s7LQIMs8uWjYjTArgAND0bGVdJ8h9g4Ek4NyPDhNVtlEJyR7SDRwrDNzSTPiQ
-v50G7INc51D1JxXLK8rUutekRt4Ouhm1leWKKk0NAoGBALvc9wF7XcgGHZa1RRk9
-jH0vOkrn632Epzml1mXg0//2mw+7iQP3q5KtRruaIk6ifLSHznzqAkowhKFH+iCH
-wnecLhsl5FnL0JAipIxBHdX0iTttJf4UR/2wTo3RalGjEcMjMCUrSdkhBjRH4Gdc
-fBuXFtwhIuiggNR7UlHxbYpq
------END PRIVATE KEY-----"""

test/HTTP2Aff.purs

@@ -17,6 +17,7 @@ import Node.HTTP2.Client.Aff as Client.Aff
 import Node.HTTP2.Server.Aff as Server.Aff
 import Node.Stream.Aff (end, fromStringUTF8, readAll, toStringUTF8, write)
 import Node.URL as URL
+import Test.MockCert (cert, key)
 
 push1 :: Aff Unit
 push1 = parSequence_
@@ -30,7 +31,7 @@ push1_serverSecure = do
   either (\err -> throwError err *> pure unit) pure =<< attempt do
     -- 1. Start the server, wait for a connection.
     server <- Server.Aff.createSecureServer
-      (toOptions { key: mockKey, cert: mockCert })
+      (toOptions { key: key, cert: cert })
     void $ Server.Aff.listenSecure server
       (toOptions { port: 8444 })
       \_headers stream -> do
@@ -62,7 +63,7 @@ push1_client = do
 
   -- 1. Begin the session, open a connection.
   session <- Client.Aff.connect
-    (toOptions { ca: mockCert })
+    (toOptions { ca: cert })
     (URL.parse "https://localhost:8444")
 
   -- 2. Send a request.
@@ -101,7 +102,7 @@ headers_serverSecure = do
 
   -- 1. Start the server, wait for a connection.
   server <- Server.Aff.createSecureServer
-    (toOptions { key: mockKey, cert: mockCert })
+    (toOptions { key: key, cert: cert })
   Server.Aff.listenSecure server
     (toOptions { port: 8444 })
     \headers stream -> do
@@ -140,7 +141,7 @@ headers_client = do
 
   -- 1. Begin the session, open a connection.
   session <- Client.Aff.connect
-    (toOptions { ca: mockCert })
+    (toOptions { ca: cert })
     (URL.parse "https://localhost:8444")
 
   -- 2. Send a request.
@@ -181,56 +182,3 @@ headersShow headers = String.joinWith ", " $ headerKeys headers <#> \key ->
           <|>
             (String.joinWith " " <$> headerArray headers key)
     )
-
-mockCert :: String
-mockCert =
-  """-----BEGIN CERTIFICATE-----
-MIIDDzCCAfegAwIBAgIUUyn89RHpZC9irOiqJpcBqFRw2HgwDQYJKoZIhvcNAQEL
-BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTIyMTExODAyMTkyN1oXDTMyMTEx
-NTAyMTkyN1owFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF
-AAOCAQ8AMIIBCgKCAQEA0REkgizCB39n47Z3JXcW+GPPym4MXBb9HAHBJbH1+m/R
-0EkdunDyXr8cKveABgq3/kazWjXlGwNXUklKYCydcnmtNVBub4s1wXAsegRaPMmo
-RzisW7FWaqcLcBMAuwrub2NTVsX0HtO5qZiEKNx6AAbWFizFmMQ9K/9VprT1OLWy
-vtIOlR/YK+PKruNWeNpvhx91zmwb69lgrqUcwMHguLWgoz0JJgzh7cerexbT+eKC
-CuA9Ub8ctQD8SIl3eF7OzsvmQHSr+yABo3TJj7UZLh0B3j1uB8RLQvenVilc4YPz
-MK/R6Jf8RjRssGommbUqVaXRjJfYQ2As2tkzRS90cwIDAQABo1kwVzAUBgNVHREE
-DTALgglsb2NhbGhvc3QwCwYDVR0PBAQDAgeAMBMGA1UdJQQMMAoGCCsGAQUFBwMB
-MB0GA1UdDgQWBBS5+ngK++/FbHQ4Uf8qMZDK6tSNlDANBgkqhkiG9w0BAQsFAAOC
-AQEAj5nTUka4P/hWkV+Wa9Rp/ijqv2ah2ukU1u73QyprG2/gHmFpYvNFJ7lG9O9r
-Wuvsz4g4moX9kgt/9GnpUbZBUE7zPau74P06lFcXhKAhiZcpsS+CZbMIsbfilWS0
-SBbs8OTLvexOqPP4pTvlc67zPkuB3tjOnHhPar8VSAiBp2s0l6UF2vWZ69Xj3ice
-DadE6thrH41GN/OSROKWL6dEueNTuQaU1Rx9Nxh8hvKiDJZ7l8oiHGYERoGwJJro
-tWBqRvX/C4TpnS+ckhOyqrHUXN66lVaact9GaBd7n6oCKzDY/GtENCLJnNKte5VI
-SATt1Hpnw3S/zwX9imqABqneAA==
------END CERTIFICATE-----"""
-
-mockKey :: String
-mockKey =
-  """-----BEGIN PRIVATE KEY-----
-MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDRESSCLMIHf2fj
-tncldxb4Y8/KbgxcFv0cAcElsfX6b9HQSR26cPJevxwq94AGCrf+RrNaNeUbA1dS
-SUpgLJ1yea01UG5vizXBcCx6BFo8yahHOKxbsVZqpwtwEwC7Cu5vY1NWxfQe07mp
-mIQo3HoABtYWLMWYxD0r/1WmtPU4tbK+0g6VH9gr48qu41Z42m+HH3XObBvr2WCu
-pRzAweC4taCjPQkmDOHtx6t7FtP54oIK4D1Rvxy1APxIiXd4Xs7Oy+ZAdKv7IAGj
-dMmPtRkuHQHePW4HxEtC96dWKVzhg/Mwr9Hol/xGNGywaiaZtSpVpdGMl9hDYCza
-2TNFL3RzAgMBAAECggEAJggqTgv6WAbTTVdaIVSitxjhKgAO+4mrDbc7/bF7/8zr
-rCpA4DO/w4CcjSxs+6xjgDw4UEbRoLJg5jUy9H/pPHPqEHLLRDtc0g2n6aJ1D+3X
-UO18XUnLYKd2qzKpxVzdtyGofXaRTDJT6gg2soA5KVwVAf+vCnVYc3KFkEgG/AOt
-jhvbxK+xA4CGjGPYxASO5K3IVJxb419hi8dizgtdJaotysvfspth5WOOoiBtVhuB
-6ORZt9DbN1AK9U3nV76NsjHeQWcMsDqt8w/KRkok4X9rkQ86pylZcDUyoqkf+aYB
-09FgDiw2iSj9k6kkR0y1o/sRsCN7PoRmJgEhrRWPcQKBgQDlflzyoaVUCIAZQAMo
-O3vJE/AEOnvB+eHmqGSi6nGHUxJavxm8dxJRqY2fzA/VeVvp19Nxs1Eh8pskHav4
-n+syRtGzkKIE0x9/KThhgzbqZl+NT5afHMhUHvmepMf8J+71giMC2v2yQC0aFVi7
-3frv3YNuBbC69FWkeYOjq/MJZwKBgQDpNs6nYmtR3bLBWKoLSOTLGV8Bhhhzt+tu
-nm6LVA464ib039m5BoWne890InxgaDNHfuL++n473JFXuwQMBBY3YLD3OPa5uW4a
-gt+oYUJKh+qGio395GnZ0W/Sf5GBpdPJ+pTMqGqlo/NWSPuwCdMd5T6RfvnEJzzv
-0/jZCAJ5FQKBgCE2yaMADBp+ZHPDFPHksgSnEwy5niGz1aL5ah8+CRJJzpU9pS7m
-mMsi2/Ftqjj+KHROnTaOekaMgzGV7ca89mA/aagwXZKPL7bKs3NBd1gzWs7r3uPG
-WaP7G6t/M8ZlzSrRG9oU8bSznxNwVXhTJzdB+vyYbDySkjaMs6WjhDgvAoGBAJj0
-mE8R7r9Pv1it9UDXey91oWkXcNwciW4QvQHmjDq0bsZ2No7ypyA0xNgvchGs5c0D
-fI+s7LQIMs8uWjYjTArgAND0bGVdJ8h9g4Ek4NyPDhNVtlEJyR7SDRwrDNzSTPiQ
-v50G7INc51D1JxXLK8rUutekRt4Ouhm1leWKKk0NAoGBALvc9wF7XcgGHZa1RRk9
-jH0vOkrn632Epzml1mXg0//2mw+7iQP3q5KtRruaIk6ifLSHznzqAkowhKFH+iCH
-wnecLhsl5FnL0JAipIxBHdX0iTttJf4UR/2wTo3RalGjEcMjMCUrSdkhBjRH4Gdc
-fBuXFtwhIuiggNR7UlHxbYpq
------END PRIVATE KEY-----"""