Skip to content

Add an asset resolver override #917

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

Merged
merged 6 commits into from
Jul 1, 2025
Merged

Add an asset resolver override #917

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
848d6aa
Add an asset resolver override
vicb Jun 26, 2025
62a2bac
fixup! take 2
vicb Jun 30, 2025
d08f104
fixup! add missing external rewrite check
vicb Jun 30, 2025
4e00790
fixup! minor updates
vicb Jun 30, 2025
3632827
fixup! only check for assets after beforeFiles
vicb Jul 1, 2025
1dfa027
fixup! minor updates
vicb Jul 1, 2025
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/late-dodos-attack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@opennextjs/aws": minor
---

Add an asset resolver
22 changes: 10 additions & 12 deletions packages/open-next/src/adapters/middleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type { OpenNextHandlerOptions } from "types/overrides";
import { debug, error } from "../adapters/logger";
import { createGenericHandler } from "../core/createGenericHandler";
import {
resolveAssetResolver,
resolveIncrementalCache,
resolveOriginResolver,
resolveProxyRequest,
Expand All @@ -29,25 +30,22 @@ const defaultHandler = async (
internalEvent: InternalEvent,
options?: OpenNextHandlerOptions,
): Promise<InternalResult | MiddlewareResult> => {
const originResolver = await resolveOriginResolver(
globalThis.openNextConfig.middleware?.originResolver,
);
const config = globalThis.openNextConfig.middleware;
const originResolver = await resolveOriginResolver(config?.originResolver);

const externalRequestProxy = await resolveProxyRequest(
globalThis.openNextConfig.middleware?.override?.proxyExternalRequest,
config?.override?.proxyExternalRequest,
);

const assetResolver = await resolveAssetResolver(config?.assetResolver);

//#override includeCacheInMiddleware
globalThis.tagCache = await resolveTagCache(
globalThis.openNextConfig.middleware?.override?.tagCache,
);
globalThis.tagCache = await resolveTagCache(config?.override?.tagCache);

globalThis.queue = await resolveQueue(
globalThis.openNextConfig.middleware?.override?.queue,
);
globalThis.queue = await resolveQueue(config?.override?.queue);

globalThis.incrementalCache = await resolveIncrementalCache(
globalThis.openNextConfig.middleware?.override?.incrementalCache,
config?.override?.incrementalCache,
);
//#endOverride

Expand All @@ -61,7 +59,7 @@ const defaultHandler = async (
requestId,
},
async () => {
const result = await routingHandler(internalEvent);
const result = await routingHandler(internalEvent, { assetResolver });
if ("internalEvent" in result) {
debug("Middleware intercepted event", internalEvent);
if (!result.isExternalRewrite) {
Expand Down
7 changes: 7 additions & 0 deletions packages/open-next/src/core/createMainHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { debug } from "../adapters/logger";
import { generateUniqueId } from "../adapters/util";
import { openNextHandler } from "./requestHandler";
import {
resolveAssetResolver,
resolveCdnInvalidation,
resolveConverter,
resolveIncrementalCache,
Expand Down Expand Up @@ -38,6 +39,12 @@ export async function createMainHandler() {

globalThis.tagCache = await resolveTagCache(thisFunction.override?.tagCache);

if (config.middleware?.external !== true) {
globalThis.assetResolver = await resolveAssetResolver(
globalThis.openNextConfig.middleware?.assetResolver,
);
}

globalThis.proxyExternalRequest = await resolveProxyRequest(
thisFunction.override?.proxyExternalRequest,
);
Expand Down
4 changes: 3 additions & 1 deletion packages/open-next/src/core/requestHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,9 @@ export async function openNextHandler(
};

//#override withRouting
routingResult = await routingHandler(internalEvent);
routingResult = await routingHandler(internalEvent, {
assetResolver: globalThis.assetResolver,
});
//#endOverride

const headers =
Expand Down
14 changes: 14 additions & 0 deletions packages/open-next/src/core/resolve.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,20 @@ export async function resolveOriginResolver(
return m_1.default;
}

/**
* @returns
* @__PURE__
*/
export async function resolveAssetResolver(
assetResolver: RemoveUndefined<OpenNextConfig["middleware"]>["assetResolver"],
) {
if (typeof assetResolver === "function") {
return assetResolver();
}
const m_1 = await import("../overrides/assetResolver/dummy.js");
return m_1.default;
}

/**
* @__PURE__
*/
Expand Down
5 changes: 5 additions & 0 deletions packages/open-next/src/core/routing/matcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,11 @@ export function getNextConfigHeaders(
return requestHeaders;
}

/**
* TODO: This method currently only check for the first match.
* It should check for all matches for `beforeFiles` and `afterFiles` rewrite
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it for all or only for beforeFiles ? The docs talks about beforeFiles only for that.
We need to look at how this is done in Next, but yeah definitely needs to be fixed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is a few lines appart but

Good to know: rewrites in beforeFiles do not check the filesystem/dynamic routes immediately after matching a source, they continue until all beforeFiles have been checked.

and

afterFiles rewrites are checked/applied, if one of these rewrites is matched we check dynamic routes/static files after each match

* See https://nextjs.org/docs/app/api-reference/config/next-config-js/rewrites
*/
export function handleRewrites<T extends RewriteDefinition>(
event: InternalEvent,
rewrites: T[],
Expand Down
Loading