move opennext setup to be universal and add commands

Author: james-elicx

packages/cloudflare/src/cli/args.ts

@@ -2,71 +2,58 @@ import { mkdirSync, type Stats, statSync } from "node:fs";
 import { resolve } from "node:path";
 import { parseArgs } from "node:util";
 
-import type { CacheBindingMode } from "./build/utils/index.js";
-import { isCacheBindingMode } from "./build/utils/index.js";
+import type { CacheBindingTarget } from "./build/utils/index.js";
+import { isCacheBindingTarget } from "./build/utils/index.js";
 
-export function getArgs(): {
-  skipNextBuild: boolean;
-  skipWranglerConfigCheck: boolean;
-  outputDir?: string;
-  minify: boolean;
-  populateCache?: { mode: CacheBindingMode; onlyPopulateWithoutBuilding: boolean };
-} {
-  const { skipBuild, skipWranglerConfigCheck, output, noMinify, populateCache, onlyPopulateCache } =
-    parseArgs({
-      options: {
-        skipBuild: {
-          type: "boolean",
-          short: "s",
-          default: false,
-        },
-        output: {
-          type: "string",
-          short: "o",
-        },
-        noMinify: {
-          type: "boolean",
-          default: false,
-        },
-        skipWranglerConfigCheck: {
-          type: "boolean",
-          default: false,
-        },
-        populateCache: {
-          type: "string",
-        },
-        onlyPopulateCache: {
-          type: "boolean",
-          default: false,
-        },
-      },
-      allowPositionals: false,
-    }).values;
+export type Arguments = (
+  | {
+      command: "build";
+      skipNextBuild: boolean;
+      skipWranglerConfigCheck: boolean;
+      minify: boolean;
+    }
+  | { command: "preview" | "deploy" }
+  | { command: "populateCache"; target: CacheBindingTarget }
+) & { outputDir?: string };
 
-  const outputDir = output ? resolve(output) : undefined;
+export function getArgs(): Arguments {
+  const { positionals, values } = parseArgs({
+    options: {
+      skipBuild: { type: "boolean", short: "s", default: false },
+      output: { type: "string", short: "o" },
+      noMinify: { type: "boolean", default: false },
+      skipWranglerConfigCheck: { type: "boolean", default: false },
+    },
+    allowPositionals: true,
+  });
 
-  if (outputDir) {
-    assertDirArg(outputDir, "output", true);
-  }
+  const outputDir = values.output ? resolve(values.output) : undefined;
+  if (outputDir) assertDirArg(outputDir, "output", true);
 
-  if (
-    (populateCache !== undefined || onlyPopulateCache) &&
-    (!populateCache?.length || !isCacheBindingMode(populateCache))
-  ) {
-    throw new Error(`Error: missing mode for populate cache flag, expected 'local' | 'remote'`);
+  switch (positionals[0]) {
+    case "build":
+      return {
+        command: "build",
+        outputDir,
+        skipNextBuild:
+          values.skipBuild || ["1", "true", "yes"].includes(String(process.env.SKIP_NEXT_APP_BUILD)),
+        skipWranglerConfigCheck:
+          values.skipWranglerConfigCheck ||
+          ["1", "true", "yes"].includes(String(process.env.SKIP_WRANGLER_CONFIG_CHECK)),
+        minify: !values.noMinify,
+      };
+    case "preview":
+      return { command: "preview", outputDir };
+    case "deploy":
+      return { command: "preview", outputDir };
+    case "populateCache":
+      if (!isCacheBindingTarget(positionals[1])) {
+        throw new Error(`Error: invalid target for populating the cache, expected 'local' | 'remote'`);
+      }
+      return { command: "populateCache", outputDir, target: positionals[1] };
+    default:
+      throw new Error("Error: invalid command, expected 'build' | 'preview' | 'deploy' | 'populateCache'");
   }
-
-  return {
-    outputDir,
-    skipNextBuild: skipBuild || ["1", "true", "yes"].includes(String(process.env.SKIP_NEXT_APP_BUILD)),
-    skipWranglerConfigCheck:
-      skipWranglerConfigCheck ||
-      ["1", "true", "yes"].includes(String(process.env.SKIP_WRANGLER_CONFIG_CHECK)),
-    minify: !noMinify,
-    populateCache: populateCache
-      ? { mode: populateCache, onlyPopulateWithoutBuilding: !!onlyPopulateCache }
-      : undefined,
-  };
 }
 
 function assertDirArg(path: string, argName?: string, make?: boolean) {

packages/cloudflare/src/cli/build/build.ts

@@ -1,55 +1,36 @@
-import { createRequire } from "node:module";
-import { dirname } from "node:path";
-
 import { buildNextjsApp, setStandaloneBuildMode } from "@opennextjs/aws/build/buildNextApp.js";
 import { compileCache } from "@opennextjs/aws/build/compileCache.js";
-import { compileOpenNextConfig } from "@opennextjs/aws/build/compileConfig.js";
 import { createCacheAssets, createStaticAssets } from "@opennextjs/aws/build/createAssets.js";
 import { createMiddleware } from "@opennextjs/aws/build/createMiddleware.js";
 import * as buildHelper from "@opennextjs/aws/build/helper.js";
-import { printHeader, showWarningOnWindows } from "@opennextjs/aws/build/utils.js";
+import { BuildOptions } from "@opennextjs/aws/build/helper.js";
+import { printHeader } from "@opennextjs/aws/build/utils.js";
 import logger from "@opennextjs/aws/logger.js";
+import { OpenNextConfig } from "@opennextjs/aws/types/open-next.js";
 
 import type { ProjectOptions } from "../project-options.js";
 import { bundleServer } from "./bundle-server.js";
 import { compileCacheAssetsManifestSqlFile } from "./open-next/compile-cache-assets-manifest.js";
 import { compileEnvFiles } from "./open-next/compile-env-files.js";
 import { copyCacheAssets } from "./open-next/copyCacheAssets.js";
 import { createServerBundle } from "./open-next/createServerBundle.js";
-import {
-  createOpenNextConfigIfNotExistent,
-  createWranglerConfigIfNotExistent,
-  ensureCloudflareConfig,
-  populateCache,
-} from "./utils/index.js";
+import { createWranglerConfigIfNotExistent } from "./utils/index.js";
 import { getVersion } from "./utils/version.js";
 
 /**
  * Builds the application in a format that can be passed to workerd
  *
  * It saves the output in a `.worker-next` directory
  *
+ * @param options The OpenNext options
+ * @param config The OpenNext config
  * @param projectOpts The options for the project
  */
-export async function build(projectOpts: ProjectOptions): Promise<void> {
-  printHeader("Cloudflare build");
-
-  showWarningOnWindows();
-
-  const baseDir = projectOpts.sourceDir;
-  const require = createRequire(import.meta.url);
-  const openNextDistDir = dirname(require.resolve("@opennextjs/aws/index.js"));
-
-  await createOpenNextConfigIfNotExistent(projectOpts);
-
-  const { config, buildDir } = await compileOpenNextConfig(baseDir);
-
-  ensureCloudflareConfig(config);
-
-  // Initialize options
-  const options = buildHelper.normalizeOptions(config, openNextDistDir, buildDir);
-  logger.setLevel(options.debug ? "debug" : "info");
-
+export async function build(
+  options: BuildOptions,
+  config: OpenNextConfig,
+  projectOpts: ProjectOptions
+): Promise<void> {
   // Do not minify the code so that we can apply string replacement patch.
   // Note that wrangler will still minify the bundle.
   options.minify = false;
@@ -63,11 +44,6 @@ export async function build(projectOpts: ProjectOptions): Promise<void> {
   logger.info(`@opennextjs/cloudflare version: ${cloudflare}`);
   logger.info(`@opennextjs/aws version: ${aws}`);
 
-  if (projectOpts.populateCache?.onlyPopulateWithoutBuilding) {
-    populateCache(options, config, projectOpts.populateCache.mode);
-    return;
-  }
-
   if (projectOpts.skipNextBuild) {
     logger.warn("Skipping Next.js build");
   } else {
@@ -109,10 +85,6 @@ export async function build(projectOpts: ProjectOptions): Promise<void> {
     await createWranglerConfigIfNotExistent(projectOpts);
   }
 
-  if (projectOpts.populateCache) {
-    populateCache(options, config, projectOpts.populateCache.mode);
-  }
-
   logger.info("OpenNext build complete.");
 }
 

packages/cloudflare/src/cli/build/utils/create-config-files.ts

@@ -92,10 +92,10 @@ export async function getLatestCompatDate(): Promise<string | undefined> {
  *
  * If the user refuses an error is thrown (since the file is mandatory).
  *
- * @param projectOpts The options for the project
+ * @param sourceDir The source directory for the project
  */
-export async function createOpenNextConfigIfNotExistent(projectOpts: ProjectOptions): Promise<void> {
-  const openNextConfigPath = join(projectOpts.sourceDir, "open-next.config.ts");
+export async function createOpenNextConfigIfNotExistent(sourceDir: string): Promise<void> {
+  const openNextConfigPath = join(sourceDir, "open-next.config.ts");
 
   if (!existsSync(openNextConfigPath)) {
     const answer = await askConfirmation(

packages/cloudflare/src/cli/index.ts

@@ -1,18 +1,49 @@
 #!/usr/bin/env node
-import { resolve } from "node:path";
+import { createRequire } from "node:module";
+import path from "node:path";
 
-import { getArgs } from "./args.js";
+import { compileOpenNextConfig } from "@opennextjs/aws/build/compileConfig.js";
+import { normalizeOptions } from "@opennextjs/aws/build/helper.js";
+import { printHeader, showWarningOnWindows } from "@opennextjs/aws/build/utils.js";
+import logger from "@opennextjs/aws/logger.js";
+
+import { Arguments, getArgs } from "./args.js";
 import { build } from "./build/build.js";
+import { createOpenNextConfigIfNotExistent, ensureCloudflareConfig } from "./build/utils/index.js";
+import { deploy } from "./deploy/deploy.js";
+import { populateCache } from "./populate-cache/populate-cache.js";
+import { preview } from "./preview/preview.js";
 
 const nextAppDir = process.cwd();
 
-const { skipNextBuild, skipWranglerConfigCheck, outputDir, minify, populateCache } = getArgs();
+async function runCommand(args: Arguments) {
+  printHeader(`Cloudflare ${args.command}`);
+
+  showWarningOnWindows();
+
+  const baseDir = nextAppDir;
+  const require = createRequire(import.meta.url);
+  const openNextDistDir = path.dirname(require.resolve("@opennextjs/aws/index.js"));
+
+  await createOpenNextConfigIfNotExistent(baseDir);
+  const { config, buildDir } = await compileOpenNextConfig(baseDir);
+
+  ensureCloudflareConfig(config);
+
+  // Initialize options
+  const options = normalizeOptions(config, openNextDistDir, buildDir);
+  logger.setLevel(options.debug ? "debug" : "info");
+
+  switch (args.command) {
+    case "build":
+      return build(options, config, args);
+    case "preview":
+      return preview(options, config);
+    case "deploy":
+      return deploy(options, config);
+    case "populateCache":
+      return populateCache(options, config, { target: args.target });
+  }
+}
 
-await build({
-  sourceDir: nextAppDir,
-  outputDir: resolve(outputDir ?? nextAppDir, ".open-next"),
-  skipNextBuild,
-  skipWranglerConfigCheck,
-  minify,
-  populateCache,
-});
+await runCommand(getArgs());