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

fix: prevent conflict between Netlify Identity and edge function rendering #12052

5 changes: 5 additions & 0 deletions .changeset/witty-teachers-film.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sveltejs/adapter-netlify': patch
---

fix: avoid unnecessary Netlify edge function invocations for static files, which resolves a conflict between Netlify Edge Functions and Netlify Identity
64 changes: 41 additions & 23 deletions packages/adapter-netlify/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,19 @@ import toml from '@iarna/toml';
*/

/**
* TODO(serhalp) Replace this custom type with an import from `@netlify/edge-functions`,
* once that type is fixed to include `excludedPath` and `function`.
Comment on lines +17 to +18
Copy link
Contributor Author

Choose a reason for hiding this comment

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

FYI I'm working on this as well. I should have a follow-up PR soon.

Copy link
Member

Choose a reason for hiding this comment

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

I see that @netlify/edge-functions does contain excludedPattern now but not function - so it looks like we can't use that still.

Copy link
Member

Choose a reason for hiding this comment

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

Looking at https://www.npmjs.com/package/@netlify/edge-functions?activeTab=code the ManifestFunction type contains the correct definition if we want to use those types.

* @typedef {{
* functions: Array<
* | {
* function: string;
* path: string;
* excludedPath?: string | string[];
* }
* | {
* function: string;
* pattern: string;
* excludedPattern?: string | string[];
* }
* >;
* version: 1;
Expand Down Expand Up @@ -122,23 +126,6 @@ async function generate_edge_functions({ builder }) {

builder.mkdirp('.netlify/edge-functions');

// Don't match the static directory
const pattern = '^/.*$';

// Go doesn't support lookarounds, so we can't do this
// const pattern = appDir ? `^/(?!${escapeStringRegexp(appDir)}).*$` : '^/.*$';

/** @type {HandlerManifest} */
const edge_manifest = {
functions: [
{
function: 'render',
pattern
}
],
version: 1
};

builder.log.minor('Generating Edge Function...');
const relativePath = posix.relative(tmp, builder.getServerDirectory());

Expand All @@ -153,12 +140,43 @@ async function generate_edge_functions({ builder }) {
relativePath
});

writeFileSync(
`${tmp}/manifest.js`,
`export const manifest = ${manifest};\n\nexport const prerendered = new Set(${JSON.stringify(
builder.prerendered.paths
)});\n`
);
writeFileSync(`${tmp}/manifest.js`, `export const manifest = ${manifest};\n`);

/** @type {{ assets: Set<string> }} */
const { assets } = (await import(`${tmp}/manifest.js`)).manifest;

const path = '/*';
Copy link
Member

Choose a reason for hiding this comment

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

Wonder if we should add the base path to this:

const path = `${builder.config.kit.paths.base}/*`;

// We only need to specify paths without the trailing slash because
// Netlify will handle the optional trailing slash for us
const excludedPath = [
// Contains static files
`/${builder.getAppPath()}/*`,
...builder.prerendered.paths,
...Array.from(assets).flatMap((asset) => {
Copy link
Member

Choose a reason for hiding this comment

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

the previous logic also checked within manifest._.server_assets, this one does not - oversight or on purpose?

Copy link
Member

@eltigerchino eltigerchino Jan 16, 2025

Choose a reason for hiding this comment

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

We could add manifest._.server_assets too but they're currently already included by the immutable assets exclusion /${builder.getAppPath()}/* because we copy the server assets over and make them public along with the client assets during the build process. I'm not sure if that will change in the future.

copy(
`${out}/server/${kit.appDir}/immutable/assets`,
`${out}/client/${kit.appDir}/immutable/assets`
);

if (asset.endsWith('/index.html')) {
const dir = asset.replace(/\/index\.html$/, '');
return [
`${builder.config.kit.paths.base}/${asset}`,
`${builder.config.kit.paths.base}/${dir}`
];
}
return `${builder.config.kit.paths.base}/${asset}`;
}),
// Should not be served by SvelteKit at all
'/.netlify/*'
];

/** @type {HandlerManifest} */
const edge_manifest = {
functions: [
{
function: 'render',
path,
excludedPath
}
],
version: 1
};

await esbuild.build({
entryPoints: [`${tmp}/entry.js`],
Expand Down
39 changes: 1 addition & 38 deletions packages/adapter-netlify/src/edge.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import { Server } from '0SERVER';
import { manifest, prerendered } from 'MANIFEST';
import { manifest } from 'MANIFEST';

const server = new Server(manifest);
const prefix = `/${manifest.appPath}/`;

const initialized = server.init({
// @ts-ignore
Expand All @@ -15,12 +14,6 @@ const initialized = server.init({
* @returns { Promise<Response> }
*/
export default async function handler(request, context) {
if (is_static_file(request)) {
// Static files can skip the handler
// TODO can we serve _app/immutable files with an immutable cache header?
return;
}

await initialized;
return server.respond(request, {
platform: { context },
Expand All @@ -29,33 +22,3 @@ export default async function handler(request, context) {
}
});
}

/**
* @param {Request} request
*/
function is_static_file(request) {
const url = new URL(request.url);

// Assets in the app dir
if (url.pathname.startsWith(prefix)) {
return true;
}

// prerendered pages and index.html files
const pathname = url.pathname.replace(/\/$/, '');
let file = pathname.substring(1);

try {
file = decodeURIComponent(file);
} catch {
// ignore
}

return (
manifest.assets.has(file) ||
manifest.assets.has(file + '/index.html') ||
file in manifest._.server_assets ||
file + '/index.html' in manifest._.server_assets ||
prerendered.has(pathname || '/')
);
}
Loading