netlify/dist/utils/framework-server.js

Netlify command line tool

import { rm } from 'node:fs/promises';
import waitPort from 'wait-port';
import { startSpinner, stopSpinner } from '../lib/spinner.js';
import { logAndThrowError, log, NETLIFYDEVERR, NETLIFYDEVLOG, chalk } from './command-helpers.js';
import { runCommand } from './shell.js';
import { startStaticServer } from './static-server.js';
const FRAMEWORK_PORT_TIMEOUT_MS = 10 * 60 * 1000;
const FRAMEWORK_PORT_WARN_TIMEOUT_MS = 5 * 1000;
/**
 * Start a static server if the `useStaticServer` is provided or a framework specific server
 */
export const startFrameworkServer = async function ({ cwd, settings, }) {
    if (settings.useStaticServer) {
        if (settings.command) {
            runCommand(settings.command, { env: settings.env, cwd });
        }
        const { family } = await startStaticServer({ settings });
        return { ipVersion: family === 'IPv6' ? 6 : 4 };
    }
    log('');
    log(`${NETLIFYDEVLOG} Starting ${settings.framework || 'framework'} dev server`);
    const spinner = startSpinner({
        text: `Waiting for ${settings.framework || 'framework'} dev server to be ready on port ${settings.frameworkPort}`,
    });
    if (settings.clearPublishDirectory && settings.dist) {
        await rm(settings.dist, { recursive: true, force: true });
    }
    if (settings.command) {
        runCommand(settings.command, { env: settings.env, spinner, cwd });
    }
    let port;
    try {
        if (settings.skipWaitPort) {
            // default ip version based on node version
            const ipVersion = parseInt(process.versions.node.split('.')[0]) >= 18 ? 6 : 4;
            port = { open: true, ipVersion };
        }
        else {
            const waitPortPromise = waitPort({
                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                port: settings.frameworkPort,
                host: 'localhost',
                output: 'silent',
                timeout: FRAMEWORK_PORT_TIMEOUT_MS,
                ...(settings.pollingStrategies?.includes('HTTP') && { protocol: 'http' }),
            });
            const timerId = setTimeout(() => {
                if (!port?.open) {
                    spinner.update({
                        text: `Still waiting for server on port ${settings.frameworkPort} to be ready. Are you sure this is the correct port${settings.framework ? ` for ${settings.framework}` : ''}? Change this with the ${chalk.yellow('targetPort')} option in your ${chalk.yellow('netlify.toml')}.`,
                    });
                }
            }, FRAMEWORK_PORT_WARN_TIMEOUT_MS);
            port = await waitPortPromise;
            clearTimeout(timerId);
            if (!port.open) {
                throw new Error(`Timed out waiting for port '${settings.frameworkPort}' to be open`);
            }
        }
        spinner.success(`${settings.framework || 'framework'} dev server ready on port ${settings.frameworkPort}`);
    }
    catch (error_) {
        stopSpinner({ error: true, spinner });
        log(NETLIFYDEVERR, `Netlify Dev could not start or connect to localhost:${settings.frameworkPort}.`);
        log(NETLIFYDEVERR, `Please make sure your framework server is running on port ${settings.frameworkPort}`);
        log(NETLIFYDEVERR, `If not, you can configure it using the ${chalk.yellow('targetPort')} option in your ${chalk.yellow('netlify.toml')}.`);
        return logAndThrowError(error_);
    }
    return { ipVersion: port.ipVersion };
};
//# sourceMappingURL=framework-server.js.map