@platformatic/next 3.68.0 → 4.0.0-new-config.1

package/config.d.ts

@@ -66,7 +66,7 @@ export interface PlatformaticNextJsConfig {
     hostname?: string;
     port?: number | string;
     /**
-     * Configures how entrypoint server worker ports are assigned. When set to shared, all workers listen on the same port. When set to perWorkerIncrement, each worker will use its own port, starting from port (worker 0).
+     * Configures how the port is assigned when the application runs multiple workers. When set to shared (the default), all workers listen on the same port (which requires SO_REUSEPORT support). When set to perWorkerIncrement, each worker listens on its own port, starting from port (worker 0) and incrementing by one for each additional worker.
      */
     portAssignment?: "shared" | "perWorkerIncrement";
     /**
@@ -224,46 +224,6 @@ export interface PlatformaticNextJsConfig {
       };
       [k: string]: unknown;
     };
-    server?: {
-      hostname?: string;
-      port?: number | string;
-      /**
-       * Configures how entrypoint server worker ports are assigned. When set to shared, all workers listen on the same port. When set to perWorkerIncrement, each worker will use its own port, starting from port (worker 0).
-       */
-      portAssignment?: "shared" | "perWorkerIncrement";
-      /**
-       * The maximum length of the queue of pending connections
-       */
-      backlog?: number;
-      http2?: boolean;
-      https?: {
-        allowHTTP1?: boolean;
-        key:
-          | string
-          | {
-              path?: string;
-            }
-          | (
-              | string
-              | {
-                  path?: string;
-                }
-            )[];
-        cert:
-          | string
-          | {
-              path?: string;
-            }
-          | (
-              | string
-              | {
-                  path?: string;
-                }
-            )[];
-        requestCert?: boolean;
-        rejectUnauthorized?: boolean;
-      };
-    };
     reuseTcpPorts?: boolean;
     startTimeout?: number;
     restartOnError?: boolean | number;

package/index.js

@@ -109,3 +109,5 @@ export * from './lib/config.js'
 export * as errors from './lib/errors.js'
 export * from './lib/image-optimizer.js'
 export { packageJson, schema, schemaComponents, version } from './lib/schema.js'
+
+export * from './lib/factory.js'

package/lib/capability.js

@@ -75,13 +75,8 @@ export class NextCapability extends BaseCapability {
     }
   }
 
-  async start ({ listen }) {
-    // Make this idempotent
-    if (this.url) {
-      return this.url
-    }
-
-    await super._start({ listen })
+  async _start () {
+    await super._start()
 
     this.on('config', config => {
       this.#configModified = true
@@ -89,9 +84,9 @@ export class NextCapability extends BaseCapability {
     })
 
     if (this.isProduction) {
-      await this.#startProduction(listen)
+      await this.#startProduction()
     } else {
-      await this.#startDevelopment(listen)
+      await this.#startDevelopment()
     }
 
     await this._collectMetrics()
@@ -109,8 +104,8 @@ export class NextCapability extends BaseCapability {
     }
   }
 
-  async stop () {
-    await super.stop()
+  async _stop () {
+    await super._stop()
 
     if (this.subprocess) {
       return this.stopCommand()
@@ -211,7 +206,11 @@ export class NextCapability extends BaseCapability {
       return this.startWithCommand(command, loaderUrl, this.#getChildManagerScripts())
     }
 
-    const { hostname, port } = this.serverConfig ?? {}
+    if (typeof this.serverConfig?.port === 'undefined') {
+      return
+    }
+
+    const { hostname, port } = this.serverConfig
     const serverOptions = {
       host: hostname || '127.0.0.1',
       port: port || 0
@@ -324,6 +323,10 @@ export class NextCapability extends BaseCapability {
       return this.startWithCommand(command, loaderUrl, childManagerScripts)
     }
 
+    if (typeof this.serverConfig?.port === 'undefined') {
+      return
+    }
+
     this.childManager = this.#createChildManager(
       loaderUrl,
       await this.getChildManagerContext(this.#basePath),
@@ -344,7 +347,7 @@ export class NextCapability extends BaseCapability {
       await this.childManager.inject()
       const { nextStart } = await importFile(resolvePath(this.#next, './dist/cli/next-start.js'))
 
-      const { hostname, port, backlog } = this.serverConfig ?? {}
+      const { hostname, port } = this.serverConfig ?? {}
       const serverOptions = {
         hostname: hostname || '127.0.0.1',
         port: port || 0
@@ -352,15 +355,11 @@ export class NextCapability extends BaseCapability {
 
       await this.childManager.register()
 
-      const serverPromise = createServerListener(
-        (this.isEntrypoint ? serverOptions?.port : undefined) ?? true,
-        (this.isEntrypoint ? serverOptions?.hostname : undefined) ?? true,
-        typeof backlog === 'number' ? { backlog } : {}
-      )
+      const serverPromise = createServerListener()
 
       if (this.#nextVersion.major === 14 && this.#nextVersion.minor < 2) {
         await nextStart({
-          '--hostname': serverOptions.host,
+          '--hostname': serverOptions.hostname,
           '--port': serverOptions.port,
           _: [this.root]
         })
@@ -403,17 +402,13 @@ export class NextCapability extends BaseCapability {
       await this.childManager.inject()
       await this.childManager.register()
 
-      const { hostname, port, backlog } = this.serverConfig ?? {}
+      const { hostname, port } = this.serverConfig ?? {}
       const serverOptions = {
         hostname: hostname || '127.0.0.1',
         port: port || 0
       }
 
-      const serverPromise = createServerListener(
-        (this.isEntrypoint ? serverOptions?.port : undefined) ?? true,
-        (this.isEntrypoint ? serverOptions?.hostname : undefined) ?? true,
-        typeof backlog === 'number' ? { backlog } : {}
-      )
+      const serverPromise = createServerListener()
 
       let keepAliveTimeout = parseInt(process.env.KEEP_ALIVE_TIMEOUT, 10)
       if (Number.isNaN(keepAliveTimeout) || !Number.isFinite(keepAliveTimeout) || keepAliveTimeout < 0) {

package/lib/factory.js

@@ -0,0 +1,7 @@
+import { defineCapabilityFactory } from '@platformatic/basic'
+import { schema, version } from './schema.js'
+
+export const next = defineCapabilityFactory('@platformatic/next', schema, {
+  version,
+  flatten: ['next']
+})

package/lib/image-optimizer.js

@@ -1,8 +1,8 @@
 import {
   BaseCapability,
   buildListenOptions,
-  errors as basicErrors,
   createServerListener,
+  errors as basicErrors,
   getServerUrl,
   importFile,
   resolvePackageViaCJS
@@ -72,37 +72,10 @@ export class NextImageOptimizerCapability extends BaseCapability {
     this.#queue = await this.#createQueue(imageOptimizerConfig)
   }
 
-  async start ({ listen }) {
-    // Make this idempotent
-    if (this.url) {
-      return this.url
-    }
-
+  async _start () {
     const config = this.config
     this.#basePath = config.application?.basePath ? cleanBasePath(config.application?.basePath) : ''
-    await super._start({ listen })
-
-    if (this.#app && listen) {
-      const serverOptions = this.serverConfig
-      const listenOptions = buildListenOptions(serverOptions)
-
-      if (typeof serverOptions?.backlog === 'number') {
-        createServerListener(false, false, { backlog: serverOptions.backlog })
-        listenOptions.backlog = serverOptions.backlog
-      }
-
-      this.#server = await new Promise((resolve, reject) => {
-        return this.#app
-          .listen(listenOptions, function () {
-            resolve(this)
-          })
-          .on('error', reject)
-      })
-
-      this.url = getServerUrl(this.#server)
-
-      return this.url
-    }
+    await super._start()
 
     const { ImageOptimizerCache } = await importFile(resolvePath(this.#next, './dist/server/image-optimizer.js'))
     this.#validateParams = ImageOptimizerCache.validateParams.bind(ImageOptimizerCache)
@@ -118,10 +91,32 @@ export class NextImageOptimizerCapability extends BaseCapability {
     this.#app = createServer(this.#handleRequest.bind(this))
     this.#dispatcher = this.#app.listeners('request')[0]
     await this.#queue.start()
+
+    if (typeof this.serverConfig?.port === 'undefined') {
+      return
+    }
+
+    const serverOptions = this.serverConfig
+    const listenOptions = buildListenOptions(serverOptions)
+    const serverPromise = createServerListener()
+
+    const [server] = await Promise.all([
+      new Promise((resolve, reject) => {
+        return this.#app
+          .listen(listenOptions, function () {
+            resolve(this)
+          })
+          .on('error', reject)
+      }),
+      serverPromise
+    ])
+    this.#server = server
+
+    this.url = getServerUrl(this.#server)
   }
 
-  async stop () {
-    await super.stop()
+  async _stop () {
+    await super._stop()
     await this.#queue?.stop()
 
     const events = getEvents()

package/lib/schema.js

@@ -1,11 +1,14 @@
-import { schemaComponents as basicSchemaComponents } from '@platformatic/basic'
-import { schemaComponents as utilsSchemaComponents } from '@platformatic/foundation'
+import { schemaComponents as basicSchemaComponents } from '@platformatic/basic/lib/schema.js'
+import { schemaComponents as utilsSchemaComponents } from '@platformatic/foundation/lib/schema.js'
 import { readFileSync } from 'node:fs'
 import { resolve } from 'node:path'
 
 export const packageJson = JSON.parse(readFileSync(resolve(import.meta.dirname, '../package.json'), 'utf8'))
 export const version = packageJson.version
 
+// The port is checked before any startup path is selected, so no port means no start.
+export const servesWithoutPort = { development: false, production: false }
+
 export const cache = {
   type: 'object',
   properties: {

package/package.json

@@ -1,9 +1,15 @@
 {
   "name": "@platformatic/next",
-  "version": "3.68.0",
+  "version": "4.0.0-new-config.1",
   "description": "Platformatic Next.js Capability",
   "main": "index.js",
   "type": "module",
+  "exports": {
+    ".": "./index.js",
+    "./schema": "./schema.js",
+    "./package.json": "./package.json",
+    "./*": "./*"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/platformatic/platformatic.git"
@@ -25,9 +31,9 @@
     "light-my-request": "^6.0.0",
     "msgpackr": "^1.11.2",
     "semver": "^7.6.3",
-    "@platformatic/basic": "3.68.0",
-    "@platformatic/foundation": "3.68.0",
-    "@platformatic/globals": "3.68.0"
+    "@platformatic/basic": "4.0.0-new-config.1",
+    "@platformatic/foundation": "4.0.0-new-config.1",
+    "@platformatic/globals": "4.0.0-new-config.1"
   },
   "devDependencies": {
     "@fastify/reply-from": "^12.0.0",
@@ -44,8 +50,8 @@
     "next": "^16.1.0",
     "typescript": "~6.0.3",
     "ws": "^8.18.0",
-    "@platformatic/gateway": "3.68.0",
-    "@platformatic/service": "3.68.0"
+    "@platformatic/service": "4.0.0-new-config.1",
+    "@platformatic/gateway": "4.0.0-new-config.1"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.js

@@ -0,0 +1,7 @@
+// The light /schema subpath, part of the v4 capability contract. It carries the schema and the
+// package-level metadata main-side preparation needs, and imports nothing that would pull the
+// capability's implementation in with it — boot resolves this rather than the package entry.
+//
+// Light is a statement about import cost, never about safety: this executes in the main process
+// with full privileges, like any capability code.
+export * from './lib/schema.js'

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/next/3.68.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/next/4.0.0-new-config.1.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Next.js Config",
   "type": "object",
@@ -202,7 +202,7 @@
             "shared",
             "perWorkerIncrement"
           ],
-          "description": "Configures how entrypoint server worker ports are assigned. When set to shared, all workers listen on the same port. When set to perWorkerIncrement, each worker will use its own port, starting from port (worker 0)."
+          "description": "Configures how the port is assigned when the application runs multiple workers. When set to shared (the default), all workers listen on the same port (which requires SO_REUSEPORT support). When set to perWorkerIncrement, each worker listens on its own port, starting from port (worker 0) and incrementing by one for each additional worker."
         },
         "backlog": {
           "type": "integer",
@@ -536,7 +536,14 @@
                 "resolvePath": true
               },
               "config": {
-                "type": "string"
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "object"
+                  }
+                ]
               },
               "url": {
                 "type": "string"
@@ -545,12 +552,6 @@
                 "type": "string",
                 "default": "main"
               },
-              "useHttp": {
-                "type": "boolean"
-              },
-              "websocket": {
-                "type": "boolean"
-              },
               "reuseTcpPorts": {
                 "type": "boolean",
                 "default": true
@@ -1164,133 +1165,6 @@
           "default": {},
           "additionalProperties": true
         },
-        "server": {
-          "type": "object",
-          "properties": {
-            "hostname": {
-              "type": "string"
-            },
-            "port": {
-              "anyOf": [
-                {
-                  "type": "integer"
-                },
-                {
-                  "type": "string"
-                }
-              ]
-            },
-            "portAssignment": {
-              "type": "string",
-              "enum": [
-                "shared",
-                "perWorkerIncrement"
-              ],
-              "description": "Configures how entrypoint server worker ports are assigned. When set to shared, all workers listen on the same port. When set to perWorkerIncrement, each worker will use its own port, starting from port (worker 0)."
-            },
-            "backlog": {
-              "type": "integer",
-              "description": "The maximum length of the queue of pending connections"
-            },
-            "http2": {
-              "type": "boolean"
-            },
-            "https": {
-              "type": "object",
-              "properties": {
-                "allowHTTP1": {
-                  "type": "boolean"
-                },
-                "key": {
-                  "anyOf": [
-                    {
-                      "type": "string"
-                    },
-                    {
-                      "type": "object",
-                      "properties": {
-                        "path": {
-                          "type": "string",
-                          "resolvePath": true
-                        }
-                      },
-                      "additionalProperties": false
-                    },
-                    {
-                      "type": "array",
-                      "items": {
-                        "anyOf": [
-                          {
-                            "type": "string"
-                          },
-                          {
-                            "type": "object",
-                            "properties": {
-                              "path": {
-                                "type": "string",
-                                "resolvePath": true
-                              }
-                            },
-                            "additionalProperties": false
-                          }
-                        ]
-                      }
-                    }
-                  ]
-                },
-                "cert": {
-                  "anyOf": [
-                    {
-                      "type": "string"
-                    },
-                    {
-                      "type": "object",
-                      "properties": {
-                        "path": {
-                          "type": "string",
-                          "resolvePath": true
-                        }
-                      },
-                      "additionalProperties": false
-                    },
-                    {
-                      "type": "array",
-                      "items": {
-                        "anyOf": [
-                          {
-                            "type": "string"
-                          },
-                          {
-                            "type": "object",
-                            "properties": {
-                              "path": {
-                                "type": "string",
-                                "resolvePath": true
-                              }
-                            },
-                            "additionalProperties": false
-                          }
-                        ]
-                      }
-                    }
-                  ]
-                },
-                "requestCert": {
-                  "type": "boolean"
-                },
-                "rejectUnauthorized": {
-                  "type": "boolean"
-                }
-              },
-              "additionalProperties": false,
-              "required": [
-                "key",
-                "cert"
-              ]
-            }
-          },
-          "additionalProperties": false
-        },
         "reuseTcpPorts": {
           "type": "boolean",
           "default": true