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.

Sign up for GitHub

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

Fix cannot write default config file b/c folder not created #364

Merged
merged 2 commits into from
Feb 16, 2024
Merged

Fix cannot write default config file b/c folder not created #364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c2d8cf
Fix cannot write default config file b/c folder not created
fwang Feb 16, 2024
5a1201f
Removed copyTracedFiles debug log
fwang Feb 16, 2024
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
121 changes: 62 additions & 59 deletions packages/open-next/src/build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,35 +29,27 @@ import { OpenNextConfig } from "./types/open-next.js";

const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
let options: BuildOptions;
let config: OpenNextConfig;

export type PublicFiles = {
files: string[];
};

export async function build(openNextConfigPath?: string) {
const outputTmpPath = path.join(process.cwd(), ".open-next", ".build");
showWindowsWarning();

if (os.platform() === "win32") {
logger.error(
"OpenNext is not properly supported on Windows. On windows you should use WSL. It might works or it might fail in unpredictable way at runtime",
);
// Wait 10s here so that the user see this message
await new Promise((resolve) => setTimeout(resolve, 10000));
}

// Compile open-next.config.ts
createOpenNextConfigBundle(outputTmpPath, openNextConfigPath);

const config = await import(outputTmpPath + "/open-next.config.mjs");
const opts = config.default as OpenNextConfig;
validateConfig(opts);
// Load open-next.config.ts
const tempDir = initTempDir();
const configPath = compileOpenNextConfig(tempDir, openNextConfigPath);
config = (await import(configPath)).default as OpenNextConfig;
validateConfig(config);

const { root: monorepoRoot, packager } = findMonorepoRoot(
path.join(process.cwd(), opts.appPath || "."),
path.join(process.cwd(), config.appPath || "."),
);

// Initialize options
options = normalizeOptions(opts, monorepoRoot);
options = normalizeOptions(config, monorepoRoot);
logger.setLevel(options.debug ? "debug" : "info");

// Pre-build validation
Expand All @@ -75,57 +67,70 @@ export async function build(openNextConfigPath?: string) {
initOutputDir();

// Compile cache.ts
compileCache(options);
compileCache();

// Compile middleware
await createMiddleware(opts);
await createMiddleware();

createStaticAssets();
if (!options.dangerous?.disableIncrementalCache) {
await createCacheAssets(monorepoRoot, options.dangerous?.disableTagCache);
}
await createServerBundle(opts, options);
await createCacheAssets(monorepoRoot);
await createServerBundle(config, options);
await createRevalidationBundle();
createImageOptimizationBundle();
await createWarmerBundle();
await generateOutput(options.appBuildOutputPath, opts);
await generateOutput(options.appBuildOutputPath, config);
}

function createOpenNextConfigBundle(
tempDir: string,
openNextConfigPath?: string,
) {
//Check if open-next.config.ts exists
const pathToOpenNextConfig = path.join(
function showWindowsWarning() {
if (os.platform() !== "win32") return;

logger.warn("OpenNext is not fully compatible with Windows.");
logger.warn(
"For optimal performance, it is recommended to use Windows Subsystem for Linux (WSL).",
);
logger.warn(
"While OpenNext may function on Windows, it could encounter unpredictable failures during runtime.",
);
}

function initTempDir() {
const dir = path.join(process.cwd(), ".open-next");
const tempDir = path.join(dir, ".build");
fs.rmSync(dir, { recursive: true, force: true });
fs.mkdirSync(tempDir, { recursive: true });
return tempDir;
}

function compileOpenNextConfig(tempDir: string, openNextConfigPath?: string) {
const sourcePath = path.join(
process.cwd(),
openNextConfigPath ?? "open-next.config.ts",
);
if (!fs.existsSync(pathToOpenNextConfig)) {
const outputPath = path.join(tempDir, "open-next.config.mjs");

//Check if open-next.config.ts exists
if (!fs.existsSync(sourcePath)) {
//Create a simple open-next.config.mjs file
logger.warn(
"You don't have an open-next.config.ts file. Using default configuration.",
);
logger.debug("Cannot find open-next.config.ts. Using default config.");
fs.writeFileSync(
path.join(tempDir, "open-next.config.mjs"),
`var config = {
default: {
},
};
var open_next_config_default = config;
export {
open_next_config_default as default
};
`,
outputPath,
[
"var config = { default: { } };",
"var open_next_config_default = config;",
"export { open_next_config_default as default };",
].join("\n"),
);
} else {
buildSync({
entryPoints: [pathToOpenNextConfig],
outfile: path.join(tempDir, "open-next.config.mjs"),
entryPoints: [sourcePath],
outfile: outputPath,
bundle: true,
format: "esm",
target: ["node18"],
});
}

return outputPath;
}

function checkRunningInsideNextjsApp() {
Expand Down Expand Up @@ -176,7 +181,7 @@ function setStandaloneBuildMode(monorepoRoot: string) {
function buildNextjsApp(packager: "npm" | "yarn" | "pnpm" | "bun") {
const { nextPackageJsonPath } = options;
const command =
options.buildCommand ??
config.buildCommand ??
(["bun", "npm"].includes(packager)
? `${packager} run build`
: `${packager} build`);
Expand Down Expand Up @@ -430,10 +435,9 @@ function createStaticAssets() {
}
}

async function createCacheAssets(
monorepoRoot: string,
disableDynamoDBCache = false,
) {
async function createCacheAssets(monorepoRoot: string) {
if (config.dangerous?.disableIncrementalCache) return;

logger.info(`Bundling cache assets...`);

const { appBuildOutputPath, outputDir } = options;
Expand Down Expand Up @@ -527,7 +531,7 @@ async function createCacheAssets(
fs.writeFileSync(cacheFilePath, JSON.stringify(cacheFileContent));
});

if (!disableDynamoDBCache) {
if (!config.dangerous?.disableTagCache) {
// Generate dynamodb data
// We need to traverse the cache to find every .meta file
const metaFiles: {
Expand Down Expand Up @@ -635,9 +639,8 @@ async function createCacheAssets(
/* Server Helper Functions */
/***************************/

function compileCache(options: BuildOptions) {
function compileCache() {
const outfile = path.join(options.outputDir, ".build", "cache.cjs");
const dangerousOptions = options.dangerous;
esbuildSync(
{
external: ["next", "styled-jsx", "react", "@aws-sdk/*"],
Expand All @@ -648,10 +651,10 @@ function compileCache(options: BuildOptions) {
banner: {
js: [
`globalThis.disableIncrementalCache = ${
dangerousOptions?.disableIncrementalCache ?? false
config.dangerous?.disableIncrementalCache ?? false
};`,
`globalThis.disableDynamoDBCache = ${
dangerousOptions?.disableTagCache ?? false
config.dangerous?.disableTagCache ?? false
};`,
].join(""),
},
Expand All @@ -661,10 +664,10 @@ function compileCache(options: BuildOptions) {
return outfile;
}

async function createMiddleware(config: OpenNextConfig) {
async function createMiddleware() {
console.info(`Bundling middleware function...`);

const { appBuildOutputPath, outputDir, externalMiddleware } = options;
const { appBuildOutputPath, outputDir } = options;

// Get middleware manifest
const middlewareManifest = JSON.parse(
Expand All @@ -688,7 +691,7 @@ async function createMiddleware(config: OpenNextConfig) {
appBuildOutputPath,
};

if (externalMiddleware) {
if (config.middleware?.external) {
outputPath = path.join(outputDir, "middleware");
fs.mkdirSync(outputPath, { recursive: true });

Expand Down
5 changes: 3 additions & 2 deletions packages/open-next/src/build/copyTracedFiles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
} from "fs";
import path from "path";
import { NextConfig, PrerenderManifest } from "types/next-types";
import logger from "../logger";

export async function copyTracedFiles(
buildOutputPath: string,
Expand All @@ -19,7 +20,7 @@ export async function copyTracedFiles(
routes: string[],
bundledNextServer: boolean,
) {
console.time("copyTracedFiles");
const tsStart = Date.now();
const dotNextDir = path.join(buildOutputPath, ".next");
const standaloneDir = path.join(dotNextDir, "standalone");
const standaloneNextDir = path.join(standaloneDir, packagePath, ".next");
Expand Down Expand Up @@ -232,5 +233,5 @@ export async function copyTracedFiles(
});
}

console.timeEnd("copyTracedFiles");
logger.debug("copyTracedFiles:", Date.now() - tsStart, "ms");
}
23 changes: 12 additions & 11 deletions packages/open-next/src/build/createServerBundle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,21 @@ const require = topLevelCreateRequire(import.meta.url);
const __dirname = url.fileURLToPath(new URL(".", import.meta.url));

export async function createServerBundle(
options: OpenNextConfig,
buildRuntimeOptions: BuildOptions,
config: OpenNextConfig,
options: BuildOptions,
) {
const foundRoutes = new Set<string>();
// Get all functions to build
const defaultFn = options.default;
const functions = Object.entries(options.functions ?? {});
const defaultFn = config.default;
const functions = Object.entries(config.functions ?? {});

const promises = functions.map(async ([name, fnOptions]) => {
const routes = fnOptions.routes;
routes.forEach((route) => foundRoutes.add(route));
if (fnOptions.runtime === "edge") {
await generateEdgeBundle(name, buildRuntimeOptions, fnOptions);
await generateEdgeBundle(name, options, fnOptions);
} else {
await generateBundle(name, buildRuntimeOptions, fnOptions);
await generateBundle(name, config, options, fnOptions);
}
});

Expand All @@ -54,13 +54,13 @@ export async function createServerBundle(

const remainingRoutes = new Set<string>();

const { monorepoRoot, appBuildOutputPath } = buildRuntimeOptions;
const { monorepoRoot, appBuildOutputPath } = options;

const packagePath = path.relative(monorepoRoot, appBuildOutputPath);

// Find remaining routes
const serverPath = path.join(
buildRuntimeOptions.appBuildOutputPath,
appBuildOutputPath,
".next",
"standalone",
packagePath,
Expand Down Expand Up @@ -105,7 +105,7 @@ export async function createServerBundle(
}

// Generate default function
await generateBundle("default", buildRuntimeOptions, {
await generateBundle("default", config, options, {
...defaultFn,
routes: Array.from(remainingRoutes),
patterns: ["*"],
Expand All @@ -114,6 +114,7 @@ export async function createServerBundle(

async function generateBundle(
name: string,
config: OpenNextConfig,
options: BuildOptions,
fnOptions: SplittedFunctionOptions,
) {
Expand Down Expand Up @@ -149,7 +150,7 @@ async function generateBundle(

// // Copy middleware
if (
!options.externalMiddleware &&
!config.middleware?.external &&
existsSync(path.join(outputDir, ".build", "middleware.mjs"))
) {
fs.copyFileSync(
Expand Down Expand Up @@ -187,7 +188,7 @@ async function generateBundle(
const isBefore13413 = compareSemver(options.nextVersion, "13.4.13") <= 0;
const isAfter141 = compareSemver(options.nextVersion, "14.0.4") >= 0;

const disableRouting = isBefore13413 || options.externalMiddleware;
const disableRouting = isBefore13413 || config.middleware?.external;
const plugins = [
openNextReplacementPlugin({
name: `requestHandlerOverride ${name}`,
Expand Down
Loading