Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(cloudflare): improve wrangler merge #3065

Merged
merged 2 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 47 additions & 35 deletions src/presets/cloudflare/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -185,44 +185,77 @@ export async function writeWranglerConfig(nitro: Nitro, isPages: boolean) {
// Default configs
const defaults: WranglerConfig = {};

// Config overrides
const overrides: WranglerConfig = {};

// Compatibility date
defaults.compatibility_date =
nitro.options.compatibilityDate.cloudflare ||
nitro.options.compatibilityDate.default;

// Node.js compatibility
defaults.compatibility_flags = ["nodejs_compat", "no_nodejs_compat_v2"];

if (isPages) {
// Pages
defaults.pages_build_output_dir = relative(
dirname(wranglerConfigPath),
overrides.pages_build_output_dir = relative(
wranglerConfigDir,
nitro.options.output.publicDir
);
} else {
// Modules
defaults.main = relative(
overrides.main = relative(
wranglerConfigDir,
join(nitro.options.output.serverDir, "index.mjs")
);
defaults.assets = {
overrides.assets = {
binding: "ASSETS",
directory: relative(
dirname(wranglerConfigPath),
nitro.options.output.publicDir
),
directory: relative(wranglerConfigDir, nitro.options.output.publicDir),
};
}

// Read user config
const userConfig = await resolveWranglerConfig(nitro.options.rootDir);

// Nitro context config (from frameworks and modules)
const ctxConfig = nitro.options.cloudflare?.wrangler || {};

// Validate and warn about overrides
for (const key in overrides) {
if (key in userConfig || key in ctxConfig) {
nitro.logger.warn(
`[nitro] [cloudflare] Wrangler config \`${key}\`${key in ctxConfig ? "set by config or modules" : ""} is overridden and will be ignored.`
);
}
}

// (first argument takes precedence)
const wranglerConfig = mergeWranglerConfigs(
const wranglerConfig = defu(
overrides,
ctxConfig,
userConfig,
nitro.options.cloudflare?.wrangler,
defaults
);
) as WranglerConfig;

// Compatibility flags
// prettier-ignore
const compatFlags = new Set(wranglerConfig.compatibility_flags || [])
if (
compatFlags.has("nodejs_compat_v2") &&
compatFlags.has("no_nodejs_compat_v2")
) {
nitro.logger.warn(
"[nitro] [cloudflare] Wrangler config `compatibility_flags` contains both `nodejs_compat_v2` and `no_nodejs_compat_v2`. Ignoring `nodejs_compat_v2`."
);
compatFlags.delete("nodejs_compat_v2");
}
if (compatFlags.has("nodejs_compat_v2")) {
nitro.logger.warn(
"[nitro] [cloudflare] Wrangler config `compatibility_flags` contains `nodejs_compat_v2`, which is currently incompatible with nitro, please remove it or USE AT YOUR OWN RISK!"
);
} else {
// Add default compatibility flags
compatFlags.add("nodejs_compat");
compatFlags.add("no_nodejs_compat_v2");
}
wranglerConfig.compatibility_flags = [...compatFlags];

// Write wrangler.json
await writeFile(
Expand Down Expand Up @@ -264,24 +297,3 @@ async function resolveWranglerConfig(dir: string): Promise<WranglerConfig> {
}
return {};
}

/**
* Merge wrangler configs (first argument takes precedence)
*/
function mergeWranglerConfigs(
...configs: (WranglerConfig | undefined)[]
): WranglerConfig {
// Merge configs
const merged = defu({}, ...configs) as WranglerConfig;

// Normalize compatibility flags
if (merged.compatibility_flags) {
let flags = [...new Set(merged.compatibility_flags || [])];
if (flags.includes("no_nodejs_compat_v2")) {
flags = flags.filter((flag) => flag !== "nodejs_compat_v2");
}
merged.compatibility_flags = flags;
}

return merged;
}
3 changes: 0 additions & 3 deletions test/fixture/wrangler.toml

This file was deleted.