Skip to content

chore: make dev overrides work in monorepo #857

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

Merged
merged 8 commits into from
May 8, 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
5 changes: 5 additions & 0 deletions .changeset/weak-swans-grin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@opennextjs/aws": patch
---

fix: make dev overrides work in monorepo
7 changes: 4 additions & 3 deletions packages/open-next/src/overrides/incrementalCache/fs-dev.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import type { IncrementalCache } from "types/overrides.js";

import fs from "node:fs/promises";
import path from "node:path";

import type { IncrementalCache } from "types/overrides.js";
import { getMonorepoRelativePath } from "utils/normalize-path";

const buildId = process.env.NEXT_BUILD_ID;
const basePath = path.resolve(process.cwd(), `../../cache/${buildId}`);
const basePath = path.join(getMonorepoRelativePath(), `cache/${buildId}`);

const getCacheKey = (key: string) => {
return path.join(basePath, `${key}.cache`);
Expand Down
11 changes: 7 additions & 4 deletions packages/open-next/src/overrides/tagCache/fs-dev.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import type { TagCache } from "types/overrides";

import fs from "node:fs";
import path from "node:path";

// TODO: fix this for monorepo
const tagFile = "../../dynamodb-provider/dynamodb-cache.json";
import type { TagCache } from "types/overrides";
import { getMonorepoRelativePath } from "utils/normalize-path";

const tagFile = path.join(
getMonorepoRelativePath(),
"dynamodb-provider/dynamodb-cache.json",
);
const tagContent = fs.readFileSync(tagFile, "utf-8");

let tags = JSON.parse(tagContent) as {
Expand Down
10 changes: 8 additions & 2 deletions packages/open-next/src/overrides/wrappers/express-dev.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
import path from "node:path";
import express from "express";

import type { StreamCreator } from "types/open-next.js";
import type { WrapperHandler } from "types/overrides.js";
import { getMonorepoRelativePath } from "utils/normalize-path";

const wrapper: WrapperHandler = async (handler, converter) => {
const app = express();
// To serve static assets
app.use(express.static("../../assets"));
app.use(express.static(path.join(getMonorepoRelativePath(), "assets")));

const imageHandlerPath = path.join(
getMonorepoRelativePath(),
"image-optimization-function/index.mjs",
);

const imageHandlerPath = "../../image-optimization-function/index.mjs";
const imageHandler = await import(imageHandlerPath).then((m) => m.handler);

app.all("/_next/image", async (req, res) => {
Expand Down
6 changes: 6 additions & 0 deletions packages/open-next/src/types/global.ts
Original file line number Diff line number Diff line change
Expand Up @@ -220,4 +220,10 @@ declare global {
var __next_route_preloader: (
stage: "waitUntil" | "start" | "warmerEvent" | "onDemand",
) => Promise<void>;

/**
* This is the relative package path of the monorepo. It will be an empty string "" in normal repos.
* ex. `packages/web`
*/
var monorepoPackagePath: string;
}
13 changes: 13 additions & 0 deletions packages/open-next/src/utils/normalize-path.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
import path from "node:path";

export function normalizePath(path: string) {
return path.replace(/\\/g, "/");
}

export function getMonorepoRelativePath(relativePath = "../.."): string {
return path.join(
globalThis.monorepoPackagePath
.split("/")
.filter(Boolean)
.map(() => "..")
.join("/"),
relativePath,
);
}
Loading