feat: allow skipping the target port wait (#6472)

allow skipping the target port wait
netlify · Mar 26, 2024 · cfa8e2b · cfa8e2b · github-actions · Mar 26, 2024
1 parent cd19d2b
commit cfa8e2b
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 12 deletions.
diff --git a/docs/commands/dev.md b/docs/commands/dev.md
@@ -32,6 +32,7 @@ netlify dev
 - `no-open` (*boolean*) - disables the automatic opening of a browser window
 - `offline` (*boolean*) - disables any features that require network access
 - `port` (*string*) - port of netlify dev
+- `skip-wait-port` (*boolean*) - disables waiting for target port to become available
 - `target-port` (*string*) - port of target app server
 - `debug` (*boolean*) - Print debugging information
 

diff --git a/src/commands/dev/dev.ts b/src/commands/dev/dev.ts
@@ -264,6 +264,7 @@ export const createDevCommand = (program: BaseCommand) => {
         .argParser((value) => Number.parseInt(value))
         .hideHelp(true),
     )
+    .option('--skip-wait-port', 'disables waiting for target port to become available')
     .addOption(new Option('--no-open', 'disables the automatic opening of a browser window'))
     .option('--target-port <port>', 'port of target app server', (value) => Number.parseInt(value))
     .option('--framework <name>', 'framework to use. Defaults to #auto which automatically detects a framework')

diff --git a/src/utils/framework-server.ts b/src/utils/framework-server.ts
@@ -47,21 +47,24 @@ export const startFrameworkServer = async function ({
 
   runCommand(settings.command, { env: settings.env, spinner, cwd })
 
-  let port
+  let port: { open: boolean; ipVersion?: 4 | 6 } | undefined
   try {
-    port = await waitPort({
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      port: settings.frameworkPort!,
-      host: 'localhost',
-      output: 'silent',
-      timeout: FRAMEWORK_PORT_TIMEOUT,
-      ...(settings.pollingStrategies?.includes('HTTP') && { protocol: 'http' }),
-    })
+    if (settings.skipWaitPort) {
+      port = { open: true, ipVersion: 6 }
+    } else {
+      port = await waitPort({
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        port: settings.frameworkPort!,
+        host: 'localhost',
+        output: 'silent',
+        timeout: FRAMEWORK_PORT_TIMEOUT,
+        ...(settings.pollingStrategies?.includes('HTTP') && { protocol: 'http' }),
+      })
 
-    if (!port.open) {
-      throw new Error(`Timed out waiting for port '${settings.frameworkPort}' to be open`)
+      if (!port.open) {
+        throw new Error(`Timed out waiting for port '${settings.frameworkPort}' to be open`)
+      }
     }
-
     // @ts-expect-error TS(2345) FIXME: Argument of type '{ error: boolean; spinner: Ora; ... Remove this comment to see the full error message
     stopSpinner({ error: false, spinner })
   } catch (error_) {

diff --git a/src/utils/run-build.ts b/src/utils/run-build.ts
@@ -98,6 +98,7 @@ export const runNetlifyBuild = async ({
       settings: {
         ...settings,
         ...settingsOverrides,
+        ...(options.skipWaitPort ? { skipWaitPort: true } : {}),
       },
       cwd,
     })

diff --git a/src/utils/types.ts b/src/utils/types.ts
@@ -52,6 +52,7 @@ export type ServerSettings = BaseServerSettings & {
   functionsPort: number
   https?: { key: string; cert: string; keyFilePath: string; certFilePath: string }
   clearPublishDirectory?: boolean
+  skipWaitPort?: boolean
 }
 
 export interface Request extends IncomingMessage {