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

Jump to bottom

Set Vite's publicDir and correctly serve public assets earlier in pipeline #5686

Merged
merged 6 commits into from
Jul 25, 2022
Merged

Set Vite's publicDir and correctly serve public assets earlier in pipeline #5686

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0d5a32d
Set Vite's publicDir and correctly serve public assets earlier in pip…
benmccann Jul 23, 2022
9c3e891
format
benmccann Jul 23, 2022
bd383d3
get tests passing
benmccann Jul 23, 2022
3373ac4
format
benmccann Jul 23, 2022
30691d2
update test app to prevent regressions
benmccann Jul 25, 2022
9cee0ab
remove incomplete request checks
benmccann Jul 25, 2022
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
6 changes: 6 additions & 0 deletions .changeset/light-vans-suffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@sveltejs/adapter-node': patch
'@sveltejs/kit': patch
---

Set Vite's publicDir and correctly serve public assets earlier in pipeline
1 change: 0 additions & 1 deletion packages/adapter-node/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ export default function (opts = {}) {
if (precompress) {
builder.log.minor('Compressing assets');
await compress(`${out}/client`);
await compress(`${out}/static`);
await compress(`${out}/prerendered`);
}
}
Expand Down
5 changes: 1 addition & 4 deletions packages/kit/src/core/adapt/builder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,7 @@ export function create_builder({ config, build_data, prerendered, log }) {
},

writeClient(dest) {
return [
...copy(`${config.kit.outDir}/output/client`, dest),
...copy(config.kit.files.assets, dest)
];
return [...copy(`${config.kit.outDir}/output/client`, dest)];
},

writePrerendered(dest, { fallback } = {}) {
Expand Down
8 changes: 1 addition & 7 deletions packages/kit/src/core/adapt/builder.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,7 @@ test('copy files', () => {
builder.writeClient(dest);

assert.equal(
[
...glob('**', {
cwd: /** @type {import('types').ValidatedConfig} */ (mocked).kit.files.assets,
dot: true
}),
...glob('**', { cwd: `${outDir}/output/client`, dot: true })
],
glob('**', { cwd: `${outDir}/output/client`, dot: true }),
glob('**', { cwd: dest, dot: true })
);

Expand Down
7 changes: 2 additions & 5 deletions packages/kit/src/core/prerender/prerender.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { existsSync, readFileSync, writeFileSync } from 'fs';
import { readFileSync, writeFileSync } from 'fs';
import { dirname, join } from 'path';
import { pathToFileURL, URL } from 'url';
import { mkdirp, posixify, walk } from '../../utils/filesystem.js';
Expand Down Expand Up @@ -158,10 +158,7 @@ export async function prerender({ config, client_out_dir, manifest_path, log })
return file;
}

const files = new Set([
...walk(client_out_dir).map(posixify),
...(existsSync(config.files.assets) ? walk(config.files.assets).map(posixify) : []) // TODO remove this if we use Vite publicDir option
]);
const files = new Set(walk(client_out_dir).map(posixify));
const seen = new Set();
const written = new Set();

Expand Down
4 changes: 1 addition & 3 deletions packages/kit/src/vite/build/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,7 @@ export const get_default_config = function ({ config, input, ssr, outDir }) {
__SVELTEKIT_APP_VERSION_POLL_INTERVAL__: JSON.stringify(config.kit.version.pollInterval),
__SVELTEKIT_DEV__: 'false'
},
// prevent Vite copying the contents of `config.kit.files.assets`,
// if it happens to be 'public' instead of 'static'
publicDir: false,
publicDir: ssr ? false : config.kit.files.assets,
resolve: {
alias: get_aliases(config.kit)
},
Expand Down
59 changes: 40 additions & 19 deletions packages/kit/src/vite/dev/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,13 +180,44 @@ export async function dev(vite, vite_config, svelte_config) {
extensions: []
});

vite.middlewares.use(async (req, res, next) => {
try {
if (!req.url || !req.method) throw new Error('Incomplete request');
Copy link
Member

Choose a reason for hiding this comment

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

is this actually a thing that can happen? if i remove this line and get rid of the try-catch, TypeScript doesn't complain

Copy link
Member Author

Choose a reason for hiding this comment

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

No, I don't think we need to worry about it. I had copied it from the main middleware. I've removed it in both places. The try/catch on the otherhand can't be removed

Copy link
Member

Choose a reason for hiding this comment

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

Are you sure? I don't see any code there that's in danger of throwing

Copy link
Member Author

Choose a reason for hiding this comment

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

If you try to remove it there's a test that fails with the error below showing where it can throw. It must bring down the whole server because all subsequent tests then fail.

[WebServer] file:///home/bmccann/src/kit/packages/kit/src/vite/dev/index.js:188
			const decoded = decodeURI(new URL(base + req.url).pathname);
			                ^

URIError: URI malformed
    at decodeURI (<anonymous>)
    at packages/kit/src/vite/dev/index.js:188:20
    at call (node_modules/.pnpm/vite@3.0.0/node_modules/vite/dist/node/chunks/dep-561c5231.js:45966:7)
    at next (node_modules/.pnpm/vite@3.0.0/node_modules/vite/dist/node/chunks/dep-561c5231.js:45910:5)
    at Function.handle (node_modules/.pnpm/vite@3.0.0/node_modules/vite/dist/node/chunks/dep-561c5231.js:45913:3)
    at Server.app (node_modules/.pnpm/vite@3.0.0/node_modules/vite/dist/node/chunks/dep-561c5231.js:45778:37)
    at Server.emit (node:events:527:28)
    at parserOnIncoming (node:_http_server:956:12)
    at HTTPParser.parserOnHeadersComplete (node:_http_common:128:17)

Copy link
Member

Choose a reason for hiding this comment

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

ah, gotcha. fair enough


const base = `${vite.config.server.https ? 'https' : 'http'}://${
req.headers[':authority'] || req.headers.host
}`;

const decoded = decodeURI(new URL(base + req.url).pathname);

if (decoded.startsWith(assets)) {
const pathname = decoded.slice(assets.length);
const file = svelte_config.kit.files.assets + pathname;

if (fs.existsSync(file) && !fs.statSync(file).isDirectory()) {
if (has_correct_case(file, svelte_config.kit.files.assets)) {
req.url = encodeURI(pathname); // don't need query/hash
asset_server(req, res);
return;
}
}
}

next();
} catch (e) {
const error = coalesce_to_error(e);
res.statusCode = 500;
res.end(fix_stack_trace(error));
}
});

return () => {
const serve_static_middleware = vite.middlewares.stack.find(
(middleware) =>
/** @type {function} */ (middleware.handle).name === 'viteServeStaticMiddleware'
);

remove_html_middlewares(vite.middlewares);
remove_static_middlewares(vite.middlewares);

vite.middlewares.use(async (req, res) => {
try {
Expand All @@ -197,20 +228,6 @@ export async function dev(vite, vite_config, svelte_config) {
}`;

const decoded = decodeURI(new URL(base + req.url).pathname);

if (decoded.startsWith(assets)) {
const pathname = decoded.slice(assets.length);
const file = svelte_config.kit.files.assets + pathname;

if (fs.existsSync(file) && !fs.statSync(file).isDirectory()) {
if (has_correct_case(file, svelte_config.kit.files.assets)) {
req.url = encodeURI(pathname); // don't need query/hash
asset_server(req, res);
return;
}
}
}

const file = posixify(path.resolve(decoded.slice(1)));
const is_file = fs.existsSync(file) && !fs.statSync(file).isDirectory();
const allowed =
Expand Down Expand Up @@ -389,11 +406,15 @@ function not_found(res, message = 'Not found') {
/**
* @param {import('connect').Server} server
*/
function remove_html_middlewares(server) {
const html_middlewares = ['viteServeStaticMiddleware'];
function remove_static_middlewares(server) {
// We don't use viteServePublicMiddleware because of the following issues:
// https://github.com/vitejs/vite/issues/9260
// https://github.com/vitejs/vite/issues/9236
// https://github.com/vitejs/vite/issues/9234
const static_middlewares = ['viteServePublicMiddleware', 'viteServeStaticMiddleware'];
for (let i = server.stack.length - 1; i > 0; i--) {
// @ts-expect-error using internals until https://github.com/vitejs/vite/pull/4640 is merged
if (html_middlewares.includes(server.stack[i].handle.name)) {
// @ts-expect-error using internals
if (static_middlewares.includes(server.stack[i].handle.name)) {
server.stack.splice(i, 1);
}
}
Expand Down
1 change: 1 addition & 0 deletions packages/kit/src/vite/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ function kit() {
__SVELTEKIT_DEV__: 'true',
__SVELTEKIT_APP_VERSION_POLL_INTERVAL__: '0'
},
publicDir: svelte_config.kit.files.assets,
resolve: {
alias: get_aliases(svelte_config.kit)
},
Expand Down
7 changes: 2 additions & 5 deletions packages/kit/src/vite/preview/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,13 @@ export async function preview(vite, config, protocol) {
const server = new Server(manifest);

return () => {
// files in `static`
vite.middlewares.use(scoped(assets, mutable(config.kit.files.assets)));

// immutable generated client assets
// generated client assets and the contents of `static`
vite.middlewares.use(
scoped(
assets,
sirv(join(config.kit.outDir, 'output/client'), {
setHeaders: (res, pathname) => {
// only apply to build directory, not e.g. version.json
// only apply to immutable directory, not e.g. version.json
if (pathname.startsWith(`/${config.kit.appDir}/immutable`)) {
res.setHeader('cache-control', 'public,max-age=31536000,immutable');
}
Expand Down
3 changes: 3 additions & 0 deletions packages/kit/test/apps/basics/src/app.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="icon" type="image/png" href="%sveltekit.assets%/favicon.png" />
<meta name="transform-page" content="__REPLACEME__" />
<!-- included to ensure Vite tranform middleware isn't run on static scripts
https://github.com/sveltejs/kit/issues/5672 -->
<script src="%sveltekit.assets%/empty.js"></script>
%sveltekit.head%
</head>
<body>
Expand Down
Empty file added packages/kit/test/apps/basics/static/empty.js
View file
Open in desktop
Empty file.