convex/src/cli/lib/localDeployment/utils.ts

Client for the Convex Cloud

import { Context } from "../../../bundler/context.js";
import { logMessage } from "../../../bundler/log.js";
import { detect } from "detect-port";
import crypto from "crypto";
import { chalkStderr } from "chalk";

export async function choosePorts(
  ctx: Context,
  {
    count,
    requestedPorts,
    suggestedPorts,
    startPort,
  }: {
    count: number;
    /** Ports that must mandatorily be used when provided. */
    requestedPorts?: Array<number | null>;
    /** Ports that will be tried preferentially when provided, but are not required. */
    suggestedPorts?: Array<number | null>;
    startPort: number;
  },
): Promise<Array<number>> {
  const ports: Array<number> = [];
  for (let i = 0; i < count; i++) {
    const requestedPort = requestedPorts?.[i];
    if (requestedPort !== null) {
      const port = await detect(requestedPort);
      if (port !== requestedPort) {
        return ctx.crash({
          exitCode: 1,
          errorType: "fatal",
          printedMessage: `Requested port ${requestedPort} is not available`,
        });
      }
      ports.push(port);
    } else {
      const suggestedPort = suggestedPorts?.[ports.length] ?? null;
      if (suggestedPort !== null) {
        const port = await detect(suggestedPort);
        if (port === suggestedPort) {
          ports.push(suggestedPort);
          continue;
        }
      }

      const portToTry =
        ports.length > 0 ? ports[ports.length - 1] + 1 : startPort;
      const port = await detect(portToTry);
      ports.push(port);
    }
  }
  return ports;
}

export async function chooseLocalBackendPorts(
  ctx: Context,
  options?: {
    suggestedPorts?:
      | { cloud?: number | undefined; site?: number | undefined }
      | undefined;
    requestedPorts?:
      | { cloud?: number | undefined; site?: number | undefined }
      | undefined;
  },
): Promise<{ cloudPort: number; sitePort: number }> {
  const { suggestedPorts, requestedPorts } = options ?? {};

  const [cloudPort, sitePort] = await choosePorts(ctx, {
    count: 2,
    startPort: 3210,
    requestedPorts: [
      requestedPorts?.cloud ?? null,
      requestedPorts?.site ?? null,
    ],
    suggestedPorts: [
      suggestedPorts?.cloud ?? null,
      suggestedPorts?.site ?? null,
    ],
  });
  return { cloudPort, sitePort };
}

export async function isOffline(): Promise<boolean> {
  // TODO(ENG-7080) -- implement this for real
  return false;
}

export function printLocalDeploymentWelcomeMessage() {
  logMessage(
    chalkStderr.cyan("You're trying out the beta local deployment feature!"),
  );
  logMessage(
    chalkStderr.cyan(
      "To learn more, read the docs: https://docs.convex.dev/cli/local-deployments",
    ),
  );
}

export function generateInstanceSecret(): string {
  return crypto.randomBytes(32).toString("hex");
}

export const LOCAL_BACKEND_INSTANCE_SECRET =
  "4361726e697461732c206c69746572616c6c79206d65616e696e6720226c6974";