New module HTTP2

HTTP2 has with low-level `Effect` bindings and high-level `Aff` bindings.
Add spago.dhall.
Use purescript-spec for tests. Upgraded ci.yml.
New function HTTP.onRequest.

Author: jamesdbrock

.github/workflows/ci.yml

@@ -12,24 +12,30 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: purescript-contrib/setup-purescript@main
+      - name: Set up a PureScript toolchain
+        uses: purescript-contrib/setup-purescript@main
         with:
           purescript: "unstable"
+          purs-tidy: "0.9.0"
 
-      - uses: actions/setup-node@v2
+      - name: Cache PureScript dependencies
+        uses: actions/cache@v2
         with:
-          node-version: "14"
-
+          key: ${{ runner.os }}-spago-${{ hashFiles('**/*.dhall') }}
+          path: |
+            .spago
+            output
       - name: Install dependencies
-        run: |
-          npm install -g bower
-          npm install
-          bower install --production
+        run: spago install
+
 
       - name: Build source
-        run: npm run-script build
+        run: spago build --no-install --purs-args '--censor-lib --strict'
+
 
       - name: Run tests
-        run: |
-          bower install
-          npm run-script test --if-present
+        run: spago test --no-install
+
+      - name: Check formatting
+        run: purs-tidy check src test
+

.gitignore

@@ -6,3 +6,4 @@
 /node_modules/
 /output/
 package-lock.json
+generated-docs/

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`

README.md

@@ -4,7 +4,7 @@
 [![Build status](https://github.com/purescript-node/purescript-node-http/workflows/CI/badge.svg?branch=master)](https://github.com/purescript-node/purescript-node-http/actions?query=workflow%3ACI+branch%3Amaster)
 [![Pursuit](https://pursuit.purescript.org/packages/purescript-node-http/badge)](https://pursuit.purescript.org/packages/purescript-node-http)
 
-A wrapper for Node's HTTP APIs.
+A wrapper for Node’s [HTTP](https://nodejs.org/docs/latest/api/http.html) and [HTTP/2](https://nodejs.org/docs/latest/api/http2.html) APIs.
 
 ## Installation
 

bower.json

@@ -1,33 +1,47 @@
 {
-  "name": "purescript-node-http",
-  "license": "MIT",
-  "ignore": [
-    "**/.*",
-    "node_modules",
-    "bower_components",
-    "output"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/purescript-node/purescript-node-http.git"
-  },
-  "devDependencies": {
-    "purescript-console": "^6.0.0"
-  },
-  "dependencies": {
-    "purescript-arraybuffer-types": "^3.0.2",
-    "purescript-contravariant": "^6.0.0",
-    "purescript-effect": "^4.0.0",
-    "purescript-foreign": "^7.0.0",
-    "purescript-foreign-object": "^4.0.0",
-    "purescript-maybe": "^6.0.0",
-    "purescript-node-buffer": "^8.0.0",
-    "purescript-node-net": "^4.0.0",
-    "purescript-node-streams": "^7.0.0",
-    "purescript-node-url": "^6.0.0",
-    "purescript-nullable": "^6.0.0",
-    "purescript-options": "^7.0.0",
-    "purescript-prelude": "^6.0.0",
-    "purescript-unsafe-coerce": "^6.0.0"
-  }
+    "name": "purescript-node-http",
+    "license": [
+        "MIT"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/purescript-node/purescript-node-http"
+    },
+    "ignore": [
+        "**/.*",
+        "node_modules",
+        "bower_components",
+        "output"
+    ],
+    "dependencies": {
+        "purescript-aff": "^v7.1.0",
+        "purescript-arraybuffer-types": "^v3.0.2",
+        "purescript-console": "^v6.0.0",
+        "purescript-contravariant": "^v6.0.0",
+        "purescript-control": "^v6.0.0",
+        "purescript-effect": "^v4.0.0",
+        "purescript-either": "^v6.1.0",
+        "purescript-exceptions": "^v6.0.0",
+        "purescript-foldable-traversable": "^v6.0.0",
+        "purescript-foreign": "^v7.0.0",
+        "purescript-foreign-object": "^v4.1.0",
+        "purescript-maybe": "^v6.0.0",
+        "purescript-node-buffer": "^v8.0.0",
+        "purescript-node-net": "^v4.0.0",
+        "purescript-node-streams": "^v7.0.0",
+        "purescript-node-streams-aff": "https://github.com/purescript-node/purescript-node-streams-aff.git#v4.0.0",
+        "purescript-node-url": "^v6.0.0",
+        "purescript-nullable": "^v6.0.0",
+        "purescript-options": "^v7.0.0",
+        "purescript-parallel": "^v6.0.0",
+        "purescript-partial": "^v4.0.0",
+        "purescript-prelude": "^v6.0.1",
+        "purescript-spec": "^v7.1.0",
+        "purescript-st": "^v6.2.0",
+        "purescript-strings": "^v6.0.1",
+        "purescript-transformers": "^v6.0.0",
+        "purescript-tuples": "^v7.0.0",
+        "purescript-unsafe-coerce": "^v6.0.0",
+        "purescript-web-fetch": "https://github.com/purescript-web/purescript-web-fetch.git#v3.0.0"
+    }
 }

packages.dhall

@@ -0,0 +1,5 @@
+let upstream =
+      https://github.com/purescript/package-sets/releases/download/psc-0.15.4-20221102/packages.dhall
+        sha256:8628e413718876ce26983db1d0ce9d9e1588129117fa3bb8ed9f618db6914127
+
+in  upstream

spago.dhall

@@ -0,0 +1,39 @@
+{ name = "node-http"
+, dependencies =
+  [ "aff"
+  , "arraybuffer-types"
+  , "console"
+  , "contravariant"
+  , "control"
+  , "effect"
+  , "either"
+  , "exceptions"
+  , "foldable-traversable"
+  , "foreign"
+  , "foreign-object"
+  , "maybe"
+  , "newtype"
+  , "node-buffer"
+  , "node-net"
+  , "node-process"
+  , "node-streams"
+  , "node-streams-aff"
+  , "node-url"
+  , "nullable"
+  , "options"
+  , "parallel"
+  , "partial"
+  , "prelude"
+  , "spec"
+  , "st"
+  , "strings"
+  , "transformers"
+  , "tuples"
+  , "unsafe-coerce"
+  , "web-fetch"
+  ]
+, packages = ./packages.dhall
+, sources = [ "src/**/*.purs", "test/**/*.purs" ]
+, license = "MIT"
+, repository = "https://github.com/purescript-node/purescript-node-http"
+}

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

src/Node/HTTP/Secure.purs

@@ -90,16 +90,17 @@ import Unsafe.Coerce (unsafeCoerce)
 
 -- | Create an HTTPS server, given the SSL options and a function to be executed
 -- | when a request is received.
-foreign import createServerImpl ::
-  Foreign ->
-  (Request -> Response -> Effect Unit) ->
-  Effect Server
+foreign import createServerImpl
+  :: Foreign
+  -> (Request -> Response -> Effect Unit)
+  -> Effect Server
 
 -- | Create an HTTPS server, given the SSL options and a function to be executed
 -- | when a request is received.
-createServer :: Options SSLOptions ->
-                (Request -> Response -> Effect Unit) ->
-                Effect Server
+createServer
+  :: Options SSLOptions
+  -> (Request -> Response -> Effect Unit)
+  -> Effect Server
 createServer = createServerImpl <<< options
 
 -- | The type of HTTPS server options
@@ -120,16 +121,22 @@ rejectUnauthorized = opt "rejectUnauthorized"
 -- | The npnProtocols option can be a String, a Buffer, a Uint8Array, or an
 -- | array of any of those types.
 data NPNProtocols
+
 npnProtocolsString :: String -> NPNProtocols
 npnProtocolsString = unsafeCoerce
+
 npnProtocolsBuffer :: Buffer -> NPNProtocols
 npnProtocolsBuffer = unsafeCoerce
+
 npnProtocolsUint8Array :: Uint8Array -> NPNProtocols
 npnProtocolsUint8Array = unsafeCoerce
+
 npnProtocolsStringArray :: Array String -> NPNProtocols
 npnProtocolsStringArray = unsafeCoerce
+
 npnProtocolsBufferArray :: Array Buffer -> NPNProtocols
 npnProtocolsBufferArray = unsafeCoerce
+
 npnProtocolsUint8ArrayArray :: Array Uint8Array -> NPNProtocols
 npnProtocolsUint8ArrayArray = unsafeCoerce
 
@@ -140,16 +147,22 @@ npnProtocols = opt "NPNProtocols"
 -- | The alpnProtocols option can be a String, a Buffer, a Uint8Array, or an
 -- | array of any of those types.
 data ALPNProtocols
+
 alpnProtocolsString :: String -> ALPNProtocols
 alpnProtocolsString = unsafeCoerce
+
 alpnProtocolsBuffer :: Buffer -> ALPNProtocols
 alpnProtocolsBuffer = unsafeCoerce
+
 alpnProtocolsUint8Array :: Uint8Array -> ALPNProtocols
 alpnProtocolsUint8Array = unsafeCoerce
+
 alpnProtocolsStringArray :: Array String -> ALPNProtocols
 alpnProtocolsStringArray = unsafeCoerce
+
 alpnProtocolsBufferArray :: Array Buffer -> ALPNProtocols
 alpnProtocolsBufferArray = unsafeCoerce
+
 alpnProtocolsUint8ArrayArray :: Array Uint8Array -> ALPNProtocols
 alpnProtocolsUint8ArrayArray = unsafeCoerce
 
@@ -167,8 +180,10 @@ ticketKeys = opt "ticketKeys"
 
 -- | The PFX option can take either a String or a Buffer
 data PFX
+
 pfxString :: String -> PFX
 pfxString = unsafeCoerce
+
 pfxBuffer :: Buffer -> PFX
 pfxBuffer = unsafeCoerce
 
@@ -179,12 +194,16 @@ pfx = opt "pfx"
 -- | The key option can be a String, a Buffer, an array of strings, or an array
 -- | of buffers.
 data Key
+
 keyString :: String -> Key
 keyString = unsafeCoerce
+
 keyBuffer :: Buffer -> Key
 keyBuffer = unsafeCoerce
+
 keyStringArray :: Array String -> Key
 keyStringArray = unsafeCoerce
+
 keyBufferArray :: Array Buffer -> Key
 keyBufferArray = unsafeCoerce
 
@@ -199,12 +218,16 @@ passphrase = opt "passphrase"
 -- | The cert option can be a String, a Buffer, an array of strings, or an array
 -- | of buffers.
 data Cert
+
 certString :: String -> Cert
 certString = unsafeCoerce
+
 certBuffer :: Buffer -> Cert
 certBuffer = unsafeCoerce
+
 certStringArray :: Array String -> Cert
 certStringArray = unsafeCoerce
+
 certBufferArray :: Array Buffer -> Cert
 certBufferArray = unsafeCoerce
 
@@ -215,12 +238,16 @@ cert = opt "cert"
 -- | The CA option can be a String, a Buffer, an array of strings, or an array
 -- | of buffers.
 data CA
+
 caString :: String -> CA
 caString = unsafeCoerce
+
 caBuffer :: Buffer -> CA
 caBuffer = unsafeCoerce
+
 caStringArray :: Array String -> CA
 caStringArray = unsafeCoerce
+
 caBufferArray :: Array Buffer -> CA
 caBufferArray = unsafeCoerce
 
@@ -231,12 +258,16 @@ ca = opt "ca"
 -- | The CRL option can be a String, a Buffer, an array of strings, or an array
 -- | of buffers.
 data CRL
+
 crlString :: String -> CRL
 crlString = unsafeCoerce
+
 crlBuffer :: Buffer -> CRL
 crlBuffer = unsafeCoerce
+
 crlStringArray :: Array String -> CRL
 crlStringArray = unsafeCoerce
+
 crlBufferArray :: Array Buffer -> CRL
 crlBufferArray = unsafeCoerce
 
@@ -258,8 +289,10 @@ ecdhCurve = opt "ecdhCurve"
 
 -- | The DHParam option can take either a String or a Buffer
 data DHParam
+
 dhparamString :: String -> DHParam
 dhparamString = unsafeCoerce
+
 dhparamBuffer :: Buffer -> DHParam
 dhparamBuffer = unsafeCoerce