cleanup and move around some utils

Author: james-elicx

packages/cloudflare/src/cli/args.ts

@@ -2,8 +2,7 @@ import { mkdirSync, type Stats, statSync } from "node:fs";
 import { resolve } from "node:path";
 import { parseArgs } from "node:util";
 
-import type { CacheBindingTarget } from "./build/utils/index.js";
-import { isCacheBindingTarget } from "./build/utils/index.js";
+import { isWranglerTarget, WranglerTarget } from "./utils/run-wrangler";
 
 export type Arguments = (
   | {
@@ -13,7 +12,7 @@ export type Arguments = (
       minify: boolean;
     }
   | { command: "preview" | "deploy" }
-  | { command: "populateCache"; target: CacheBindingTarget }
+  | { command: "populateCache"; target: WranglerTarget }
 ) & { outputDir?: string };
 
 export function getArgs(): Arguments {
@@ -47,7 +46,7 @@ export function getArgs(): Arguments {
     case "deploy":
       return { command: "preview", outputDir };
     case "populateCache":
-      if (!isCacheBindingTarget(positionals[1])) {
+      if (!isWranglerTarget(positionals[1])) {
         throw new Error(`Error: invalid target for populating the cache, expected 'local' | 'remote'`);
       }
       return { command: "populateCache", outputDir, target: positionals[1] };

packages/cloudflare/src/cli/deploy/deploy.ts

@@ -0,0 +1,4 @@
+import { BuildOptions } from "@opennextjs/aws/build/helper.js";
+import { OpenNextConfig } from "@opennextjs/aws/types/open-next.js";
+
+export async function deploy(options: BuildOptions, config: OpenNextConfig) {}

packages/cloudflare/src/cli/populate-cache/populate-cache.ts

@@ -1,8 +1,7 @@
-import { spawnSync } from "node:child_process";
 import { existsSync } from "node:fs";
 import path from "node:path";
 
-import type { BuildOptions } from "@opennextjs/aws/build/helper.js";
+import { BuildOptions } from "@opennextjs/aws/build/helper.js";
 import logger from "@opennextjs/aws/logger.js";
 import type {
   IncludedIncrementalCache,
@@ -13,7 +12,7 @@ import type {
 import type { IncrementalCache, TagCache } from "@opennextjs/aws/types/overrides.js";
 import { globSync } from "glob";
 
-export type CacheBindingMode = "local" | "remote";
+import { runWrangler, WranglerTarget } from "../utils/run-wrangler.js";
 
 async function resolveCacheName(
   value:
@@ -25,32 +24,6 @@ async function resolveCacheName(
   return typeof value === "function" ? (await value()).name : value;
 }
 
-function runWrangler(
-  opts: BuildOptions,
-  wranglerOpts: { mode: CacheBindingMode; excludeRemoteFlag?: boolean },
-  args: string[]
-) {
-  const result = spawnSync(
-    opts.packager,
-    [
-      "exec",
-      "wrangler",
-      ...args,
-      wranglerOpts.mode === "remote" && !wranglerOpts.excludeRemoteFlag && "--remote",
-      wranglerOpts.mode === "local" && "--local",
-    ].filter((v): v is string => !!v),
-    {
-      shell: true,
-      stdio: ["ignore", "ignore", "inherit"],
-    }
-  );
-
-  if (result.status !== 0) {
-    logger.error("Failed to populate cache");
-    process.exit(1);
-  }
-}
-
 function getCacheAssetPaths(opts: BuildOptions) {
   return globSync(path.join(opts.outputDir, "cache/**/*"), { withFileTypes: true })
     .filter((f) => f.isFile())
@@ -66,10 +39,14 @@ function getCacheAssetPaths(opts: BuildOptions) {
     });
 }
 
-export async function populateCache(opts: BuildOptions, config: OpenNextConfig, mode: CacheBindingMode) {
+export async function populateCache(
+  options: BuildOptions,
+  config: OpenNextConfig,
+  populateCacheOptions: { target: WranglerTarget }
+) {
   const { incrementalCache, tagCache } = config.default.override ?? {};
 
-  if (!existsSync(opts.outputDir)) {
+  if (!existsSync(options.outputDir)) {
     logger.error("Unable to populate cache: Open Next build not found");
     process.exit(1);
   }
@@ -80,15 +57,15 @@ export async function populateCache(opts: BuildOptions, config: OpenNextConfig,
       case "r2-incremental-cache": {
         logger.info("\nPopulating R2 incremental cache...");
 
-        const assets = getCacheAssetPaths(opts);
+        const assets = getCacheAssetPaths(options);
         assets.forEach(({ fsPath, destPath }) => {
           const fullDestPath = path.join(
             "NEXT_CACHE_R2_BUCKET",
             process.env.NEXT_CACHE_R2_PREFIX ?? "incremental-cache",
             destPath
           );
 
-          runWrangler(opts, { mode, excludeRemoteFlag: true }, [
+          runWrangler(options.packager, { ...populateCacheOptions, excludeRemoteFlag: true }, [
             "r2 object put",
             JSON.stringify(fullDestPath),
             `--file ${JSON.stringify(fsPath)}`,
@@ -108,10 +85,10 @@ export async function populateCache(opts: BuildOptions, config: OpenNextConfig,
       case "d1-tag-cache": {
         logger.info("\nPopulating D1 tag cache...");
 
-        runWrangler(opts, { mode }, [
+        runWrangler(options.packager, populateCacheOptions, [
           "d1 execute",
           "NEXT_CACHE_D1",
-          `--file ${JSON.stringify(path.join(opts.outputDir, "cloudflare/cache-assets-manifest.sql"))}`,
+          `--file ${JSON.stringify(path.join(options.outputDir, "cloudflare/cache-assets-manifest.sql"))}`,
         ]);
         logger.info("Successfully populated cache");
         break;
@@ -121,7 +98,3 @@ export async function populateCache(opts: BuildOptions, config: OpenNextConfig,
     }
   }
 }
-
-export function isCacheBindingMode(v: string | undefined): v is CacheBindingMode {
-  return !!v && ["local", "remote"].includes(v);
-}

packages/cloudflare/src/cli/preview/preview.ts

@@ -0,0 +1,4 @@
+import { BuildOptions } from "@opennextjs/aws/build/helper.js";
+import { OpenNextConfig } from "@opennextjs/aws/types/open-next.js";
+
+export async function preview(options: BuildOptions, config: OpenNextConfig) {}

packages/cloudflare/src/cli/project-options.ts

@@ -1,15 +1,8 @@
-import type { CacheBindingMode } from "./build/utils/index.js";
-
 export type ProjectOptions = {
-  // Next app root folder
-  sourceDir: string;
-  // The directory to save the output to (defaults to the app's directory)
-  outputDir: string;
   // Whether the Next.js build should be skipped (i.e. if the `.next` dir is already built)
   skipNextBuild: boolean;
   // Whether the check to see if a wrangler config file exists should be skipped
   skipWranglerConfigCheck: boolean;
   // Whether minification of the worker should be enabled
   minify: boolean;
-  populateCache?: { mode: CacheBindingMode; onlyPopulateWithoutBuilding: boolean };
 };

packages/cloudflare/src/cli/utils/run-wrangler.ts

@@ -0,0 +1,35 @@
+import { spawnSync } from "node:child_process";
+
+import logger from "@opennextjs/aws/logger.js";
+
+export type WranglerTarget = "local" | "remote";
+
+export function runWrangler(
+  pm: string,
+  wranglerOpts: { target: WranglerTarget; excludeRemoteFlag?: boolean },
+  args: string[]
+) {
+  const result = spawnSync(
+    pm,
+    [
+      "exec",
+      "wrangler",
+      ...args,
+      wranglerOpts.target === "remote" && !wranglerOpts.excludeRemoteFlag && "--remote",
+      wranglerOpts.target === "local" && "--local",
+    ].filter((v): v is string => !!v),
+    {
+      shell: true,
+      stdio: ["ignore", "ignore", "inherit"],
+    }
+  );
+
+  if (result.status !== 0) {
+    logger.error("Failed to populate cache");
+    process.exit(1);
+  }
+}
+
+export function isWranglerTarget(v: string | undefined): v is WranglerTarget {
+  return !!v && ["local", "remote"].includes(v);
+}