@jsenv/server 14.1.15 → 15.0.0

package/README.md

@@ -6,7 +6,6 @@
 import { startServer } from "@jsenv/server"
 
 await startServer({
-  protocol: "http",
   port: 8080,
   services: [
     {
@@ -73,9 +72,10 @@ import { readFileSync } from "node:fs"
 import { startServer } from "@jsenv/server"
 
 await startServer({
-  protocol: "https",
-  certificate: readFileSync(new URL("./server.crt", import.meta.url), "utf8"),
-  privateKey: readFileSync(new URL("./server.key", import.meta.url), "utf8"),
+  https: {
+    certificate: readFileSync(new URL("./server.crt", import.meta.url), "utf8"),
+    privateKey: readFileSync(new URL("./server.key", import.meta.url), "utf8"),
+  },
   allowHttpRequestOnHttps: true,
   services: [
     {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/server",
-  "version": "14.1.15",
+  "version": "15.0.0",
   "description": "Write your Node.js server using pure functions",
   "license": "MIT",
   "author": {
@@ -35,10 +35,10 @@
   },
   "dependencies": {
     "@jsenv/abort": "4.2.4",
-    "@jsenv/log": "3.3.3",
-    "@jsenv/url-meta": "7.0.2",
+    "@jsenv/log": "3.3.4",
+    "@jsenv/url-meta": "7.1.0",
     "@jsenv/utils": "2.0.1",
-    "ws": "8.12.0"
+    "ws": "8.13.0"
   },
   "devDependencies": {
     "@jsenv/fetch": "../fetch/",

package/src/start_server.js

@@ -1,5 +1,4 @@
 import { isIP } from "node:net"
-import http from "node:http"
 import cluster from "node:cluster"
 import { createDetailedMessage, createLogger } from "@jsenv/log"
 import {
@@ -50,7 +49,7 @@ export const startServer = async ({
   startLog = true,
   serverName = "server",
 
-  protocol = "http",
+  https = false,
   http2 = false,
   http1Allowed = true,
   redirectHttpToHttps,
@@ -60,8 +59,6 @@ export const startServer = async ({
   hostname = "localhost",
   port = 0, // assign a random available port
   portHint,
-  privateKey,
-  certificate,
 
   // when inside a worker, we should not try to stop server on SIGINT
   // otherwise it can create an EPIPE error while primary process tries
@@ -94,50 +91,60 @@ export const startServer = async ({
   // after this delay the underlying stream is destroyed, attempting to read it would throw
   // if used the stream stays opened, it's only if the stream is not read at all that it gets destroyed
   requestBodyLifetime = 60_000 * 2, // 2s
+  ...rest
 } = {}) => {
-  const logger = createLogger({ logLevel })
-
-  if (protocol !== "http" && protocol !== "https") {
-    throw new Error(`protocol must be http or https, got ${protocol}`)
-  }
-  if (protocol === "https") {
-    if (!certificate) {
-      throw new Error(`missing certificate for https server`)
+  // param validations
+  {
+    const unexpectedParamNames = Object.keys(rest)
+    if (unexpectedParamNames.length > 0) {
+      throw new TypeError(
+        `${unexpectedParamNames.join(",")}: there is no such param`,
+      )
     }
-    if (!privateKey) {
-      throw new Error(`missing privateKey for https server`)
+    if (https) {
+      if (typeof https !== "object") {
+        throw new TypeError(`https must be an object, got ${https}`)
+      }
+      const { certificate, privateKey } = https
+      if (!certificate || !privateKey) {
+        throw new TypeError(
+          `https must be an object with { certificate, privateKey }`,
+        )
+      }
+    }
+    if (http2 && !https) {
+      throw new Error(`http2 needs https`)
     }
   }
-  if (http2 && protocol !== "https") {
-    throw new Error(`http2 needs "https" but protocol is "${protocol}"`)
-  }
-
-  if (
-    redirectHttpToHttps === undefined &&
-    protocol === "https" &&
-    !allowHttpRequestOnHttps
-  ) {
-    redirectHttpToHttps = true
-  }
-  if (redirectHttpToHttps && protocol === "http") {
-    logger.warn(`redirectHttpToHttps ignored because protocol is http`)
-    redirectHttpToHttps = false
-  }
-  if (allowHttpRequestOnHttps && redirectHttpToHttps) {
-    logger.warn(
-      `redirectHttpToHttps ignored because allowHttpRequestOnHttps is enabled`,
-    )
-    redirectHttpToHttps = false
-  }
+  const logger = createLogger({ logLevel })
+  // param warnings and normalization
+  {
+    if (
+      redirectHttpToHttps === undefined &&
+      https &&
+      !allowHttpRequestOnHttps
+    ) {
+      redirectHttpToHttps = true
+    }
+    if (redirectHttpToHttps && !https) {
+      logger.warn(`redirectHttpToHttps ignored because protocol is http`)
+      redirectHttpToHttps = false
+    }
+    if (allowHttpRequestOnHttps && redirectHttpToHttps) {
+      logger.warn(
+        `redirectHttpToHttps ignored because allowHttpRequestOnHttps is enabled`,
+      )
+      redirectHttpToHttps = false
+    }
 
-  if (allowHttpRequestOnHttps && protocol === "http") {
-    logger.warn(`allowHttpRequestOnHttps ignored because protocol is http`)
-    allowHttpRequestOnHttps = false
+    if (allowHttpRequestOnHttps && !https) {
+      logger.warn(`allowHttpRequestOnHttps ignored because protocol is http`)
+      allowHttpRequestOnHttps = false
+    }
   }
 
   const server = {}
   const serviceController = createServiceController(services)
-
   const processTeardownEvents = {
     SIGHUP: stopOnExit,
     SIGTERM: stopOnExit,
@@ -164,11 +171,9 @@ export const startServer = async ({
     })
     startServerOperation.throwIfAborted()
     nodeServer = await createNodeServer({
-      protocol,
+      https,
       redirectHttpToHttps,
       allowHttpRequestOnHttps,
-      certificate,
-      privateKey,
       http2,
       http1Allowed,
     })
@@ -180,6 +185,7 @@ export const startServer = async ({
     }
 
     const createOrigin = (hostname) => {
+      const protocol = https ? "https" : "http"
       if (isIP(hostname) === 6) {
         return `${protocol}://[${hostname}]`
       }
@@ -940,10 +946,9 @@ export const startServer = async ({
       const websocketClients = new Set()
       const { WebSocketServer } = await import("ws")
       let websocketServer = new WebSocketServer({ noServer: true })
-      const websocketOrigin =
-        protocol === "https"
-          ? `wss://${hostname}:${port}`
-          : `ws://${hostname}:${port}`
+      const websocketOrigin = https
+        ? `wss://${hostname}:${port}`
+        : `ws://${hostname}:${port}`
       server.websocketOrigin = websocketOrigin
       const upgradeCallback = (nodeRequest, socket, head) => {
         websocketServer.handleUpgrade(
@@ -1020,32 +1025,30 @@ export const startServer = async ({
 }
 
 const createNodeServer = async ({
-  protocol,
+  https,
   redirectHttpToHttps,
   allowHttpRequestOnHttps,
-  certificate,
-  privateKey,
   http2,
   http1Allowed,
 }) => {
-  if (protocol === "http") {
-    return http.createServer()
-  }
-
-  if (redirectHttpToHttps || allowHttpRequestOnHttps) {
-    return createPolyglotServer({
-      certificate,
-      privateKey,
-      http2,
-      http1Allowed,
+  if (https) {
+    const { certificate, privateKey } = https
+    if (redirectHttpToHttps || allowHttpRequestOnHttps) {
+      return createPolyglotServer({
+        certificate,
+        privateKey,
+        http2,
+        http1Allowed,
+      })
+    }
+    const { createServer } = await import("node:https")
+    return createServer({
+      cert: certificate,
+      key: privateKey,
     })
   }
-
-  const { createServer } = await import("node:https")
-  return createServer({
-    cert: certificate,
-    key: privateKey,
-  })
+  const { createServer } = await import("node:http")
+  return createServer()
 }
 
 const testCanPushStream = (http2Stream) => {