@jsenv/server 13.0.0 → 13.1.0

package/README.md

@@ -24,34 +24,7 @@ await startServer({
 })
 ```
 
-# Example
-
-_Code starting a server and using [node-fetch](https://github.com/node-fetch/node-fetch) to send a request on that server:_
-
-```js
-import fetch from "node-fetch"
-import { startServer } from "@jsenv/server"
-
-const server = await startServer({
-  services: [
-    {
-      handleRequest: () => {
-        return {
-          status: 200,
-          headers: {
-            "content-type": "text/plain",
-          },
-          body: "Hello world",
-        }
-      },
-    },
-  ],
-})
-
-const response = await fetch(server.origin)
-const responseBodyAsText = await response.text()
-console.log(responseBodyAsText) // "Hello world"
-```
+# Examples
 
 _Code starting a server with 2 request handlers:_
 
@@ -73,7 +46,7 @@ const server = await startServer({
         if (request.ressource === "/") {
           return { status: 200 }
         }
-        return null // means "I don't handle that request"
+        return null
       },
     },
     {
@@ -101,8 +74,8 @@ import { startServer } from "@jsenv/server"
 
 await startServer({
   protocol: "https",
-  certificate: readFileSyncAsString("./server.crt"),
-  privateKey: readFileSyncAsString("./server.key"),
+  certificate: readFileSync(new URL("./server.crt", import.meta.url), "utf8"),
+  privateKey: readFileSync(new URL("./server.key", import.meta.url), "utf8"),
   allowHttpRequestOnHttps: true,
   services: [
     {
@@ -120,11 +93,6 @@ await startServer({
     },
   ],
 })
-
-function readFileSyncAsString(relativeUrl) {
-  const fileUrl = new URL(relativeUrl, import.meta.url)
-  return String(readFileSync(fileUrl))
-}
 ```
 
 _Code starting a server for static files:_
@@ -137,9 +105,7 @@ await startServer({
     {
       handleRequest: async (request) => {
         const fileUrl = new URL(request.ressource.slice(1), import.meta.url)
-        const response = await fetchFileSystem(fileUrl, {
-          ...request,
-        })
+        const response = await fetchFileSystem(fileUrl, request)
         return response
       },
     },
@@ -149,16 +115,17 @@ await startServer({
 
 # Documentation
 
-- [Handling requests](./docs/handling_requests/handling_requests.md)
-- [Handling errors](./docs/handling_errors/handling_errors.md)
-- [Server timing](./docs/server_timing/server_timing.md)
-- [CORS](./docs/cors/cors.md)
-- [https](./docs/https/https.md)
-- [Serving files](./docs/serving_files/serving_files.md)
-- [Content negotiation](./docs/content_negotiation/content_negotiation.md)
-- [Server Sent Events](./docs/sse/sse.md)
-- [Cluster](./docs/cluster/cluster.md)
-- [Http2 push](./docs/http2_push/http2_push.md)
+- [Handling requests](./docs/handling_requests.md)
+- [Handling errors](./docs/handling_errors.md)
+- [Server timing](./docs/server_timing.md)
+- [CORS](./docs/cors.md)
+- [https](./docs/https.md)
+- [Serving files](./docs/serving_files.md)
+- [Content negotiation](./docs/content_negotiation.md)
+- [Websocket](./docs/websocket.md)
+- [Server Sent Events](./docs/server_sent_events.md)
+- [Cluster](./docs/cluster.md)
+- [Http2 push](./docs/http2_push.md)
 
 # Installation
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/server",
-  "version": "13.0.0",
+  "version": "13.1.0",
   "description": "Write your Node.js server using pure functions",
   "license": "MIT",
   "author": {
@@ -37,7 +37,8 @@
     "@jsenv/abort": "4.2.3",
     "@jsenv/log": "3.1.0",
     "@jsenv/url-meta": "7.0.0",
-    "@jsenv/utils": "2.0.1"
+    "@jsenv/utils": "2.0.1",
+    "ws": "8.8.1"
   },
   "devDependencies": {
     "@jsenv/fetch": "../fetch/",

package/src/internal/request_factory.js

@@ -6,7 +6,9 @@ export const fromNodeRequest = (nodeRequest, { serverOrigin, signal }) => {
   const body = nodeStreamToObservable(nodeRequest)
 
   let requestOrigin
-  if (nodeRequest.authority) {
+  if (nodeRequest.upgrade) {
+    requestOrigin = serverOrigin
+  } else if (nodeRequest.authority) {
     requestOrigin = nodeRequest.connection.encrypted
       ? `https://${nodeRequest.authority}`
       : `http://${nodeRequest.authority}`

package/src/internal/server-polyglot.js

@@ -62,6 +62,7 @@ export const createPolyglotServer = async ({
 
 // The async part is just to lazyly import "http2" or "https"
 // so that these module are parsed only if used.
+// https://nodejs.org/api/tls.html#tlscreatesecurecontextoptions
 const createSecureServer = async ({
   certificate,
   privateKey,

package/src/main.js

@@ -4,7 +4,7 @@
  * Ideally this file should be kept simple to help discovering codebase progressively.
  */
 
-export { startServer } from "./server.js"
+export { startServer } from "./start_server.js"
 export { setupRoutes } from "./service_composition/routing.js"
 export { readRequestBody } from "./readRequestBody.js"
 export { fetchFileSystem } from "./fetch_filesystem.js"

package/src/service_controller.js

@@ -4,6 +4,7 @@ const HOOK_NAMES = [
   "serverListening",
   "redirectRequest",
   "handleRequest",
+  "handleWebsocket",
   "handleError",
   "onResponsePush",
   "injectResponseHeaders",