From 14e0101a99d4b668c6681d1c2fe9f9c8a5b6a10b Mon Sep 17 00:00:00 2001 From: Adrien Date: Thu, 26 May 2022 14:53:02 -0700 Subject: [PATCH 1/6] allow symlinked assets prettier skip test on windows Revert "skip test on windows" This reverts commit f8e55e6245d53a03603218bc087c280bd1c3e20e. skip test completely --- .changeset/violet-walls-jam.md | 5 +++++ packages/kit/src/core/dev/plugin.js | 2 +- .../kit/test/apps/basics/src/routes/assets/symlink.svelte | 7 +++++++ packages/kit/test/apps/basics/src/symlinked/asset.css | 7 +++++++ packages/kit/test/apps/basics/static/symlinked | 1 + packages/kit/test/apps/basics/test/test.js | 6 ++++++ 6 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 .changeset/violet-walls-jam.md create mode 100644 packages/kit/test/apps/basics/src/routes/assets/symlink.svelte create mode 100644 packages/kit/test/apps/basics/src/symlinked/asset.css create mode 120000 packages/kit/test/apps/basics/static/symlinked diff --git a/.changeset/violet-walls-jam.md b/.changeset/violet-walls-jam.md new file mode 100644 index 000000000000..192d57d73b61 --- /dev/null +++ b/.changeset/violet-walls-jam.md @@ -0,0 +1,5 @@ +--- +'@sveltejs/kit': patch +--- + +allow symlinked static assets in dev diff --git a/packages/kit/src/core/dev/plugin.js b/packages/kit/src/core/dev/plugin.js index 514871e38ccc..75bcbbe6ade3 100644 --- a/packages/kit/src/core/dev/plugin.js +++ b/packages/kit/src/core/dev/plugin.js @@ -203,7 +203,7 @@ export async function create_plugin(config) { const file = config.kit.files.assets + pathname; if (fs.existsSync(file) && !fs.statSync(file).isDirectory()) { - const has_correct_case = fs.realpathSync.native(file) === path.resolve(file); + const has_correct_case = fs.realpathSync.native(file).endsWith(pathname); if (has_correct_case) { req.url = encodeURI(pathname); // don't need query/hash diff --git a/packages/kit/test/apps/basics/src/routes/assets/symlink.svelte b/packages/kit/test/apps/basics/src/routes/assets/symlink.svelte new file mode 100644 index 000000000000..aa8bf42335ca --- /dev/null +++ b/packages/kit/test/apps/basics/src/routes/assets/symlink.svelte @@ -0,0 +1,7 @@ + + + + +

are symlinked assets served?

+

blue = ok

+ diff --git a/packages/kit/test/apps/basics/src/symlinked/asset.css b/packages/kit/test/apps/basics/src/symlinked/asset.css new file mode 100644 index 000000000000..10ed260de7a1 --- /dev/null +++ b/packages/kit/test/apps/basics/src/symlinked/asset.css @@ -0,0 +1,7 @@ +#symlinktest { + font-size: x-large; + color: blue; +} +#symlinktest::before { + content: 'YES! '; +} diff --git a/packages/kit/test/apps/basics/static/symlinked b/packages/kit/test/apps/basics/static/symlinked new file mode 120000 index 000000000000..44afaa86bc4d --- /dev/null +++ b/packages/kit/test/apps/basics/static/symlinked @@ -0,0 +1 @@ +../src/symlinked \ No newline at end of file diff --git a/packages/kit/test/apps/basics/test/test.js b/packages/kit/test/apps/basics/test/test.js index 7671ef0b829a..65c357af082c 100644 --- a/packages/kit/test/apps/basics/test/test.js +++ b/packages/kit/test/apps/basics/test/test.js @@ -2583,6 +2583,12 @@ test.describe.parallel('Static files', () => { const response = await request.get('/static.JSON'); expect(response.status()).toBe(404); }); + + // FIXME: disable on windows only + test.skip('Serves symlinked asset', async ({ request }) => { + const response = await request.get('/symlinked/asset.css'); + expect(response.status()).toBe(200); + }); }); test.describe.parallel('Matchers', () => { From fd875b3d7c7791a6e71ab79aed5c8e4626bca9e7 Mon Sep 17 00:00:00 2001 From: Adrien Date: Thu, 26 May 2022 17:32:21 -0700 Subject: [PATCH 2/6] fix windows path --- packages/kit/src/core/dev/plugin.js | 4 +++- packages/kit/test/apps/basics/test/test.js | 3 +-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/packages/kit/src/core/dev/plugin.js b/packages/kit/src/core/dev/plugin.js index 75bcbbe6ade3..d28634a558ec 100644 --- a/packages/kit/src/core/dev/plugin.js +++ b/packages/kit/src/core/dev/plugin.js @@ -203,7 +203,9 @@ export async function create_plugin(config) { const file = config.kit.files.assets + pathname; if (fs.existsSync(file) && !fs.statSync(file).isDirectory()) { - const has_correct_case = fs.realpathSync.native(file).endsWith(pathname); + const has_correct_case = fs.realpathSync + .native(file) + .endsWith(path.normalize(pathname)); if (has_correct_case) { req.url = encodeURI(pathname); // don't need query/hash diff --git a/packages/kit/test/apps/basics/test/test.js b/packages/kit/test/apps/basics/test/test.js index 65c357af082c..c9d2fb80c87e 100644 --- a/packages/kit/test/apps/basics/test/test.js +++ b/packages/kit/test/apps/basics/test/test.js @@ -2584,8 +2584,7 @@ test.describe.parallel('Static files', () => { expect(response.status()).toBe(404); }); - // FIXME: disable on windows only - test.skip('Serves symlinked asset', async ({ request }) => { + test('Serves symlinked asset', async ({ request }) => { const response = await request.get('/symlinked/asset.css'); expect(response.status()).toBe(200); }); From ce1c6df8c07035b0a5d1341328c34994d72b8b4f Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Mon, 30 May 2022 16:14:04 -0400 Subject: [PATCH 3/6] fix --- packages/kit/src/core/dev/plugin.js | 6 +++--- .../kit/test/apps/basics/src/routes/assets/symlink.svelte | 7 ------- packages/kit/test/apps/basics/src/symlinked/asset.css | 7 ------- packages/kit/test/apps/basics/static/symlink-from | 1 + packages/kit/test/apps/basics/static/symlink-to/hello.txt | 1 + packages/kit/test/apps/basics/static/symlinked | 1 - packages/kit/test/apps/basics/test/test.js | 3 ++- 7 files changed, 7 insertions(+), 19 deletions(-) delete mode 100644 packages/kit/test/apps/basics/src/routes/assets/symlink.svelte delete mode 100644 packages/kit/test/apps/basics/src/symlinked/asset.css create mode 120000 packages/kit/test/apps/basics/static/symlink-from create mode 100644 packages/kit/test/apps/basics/static/symlink-to/hello.txt delete mode 120000 packages/kit/test/apps/basics/static/symlinked diff --git a/packages/kit/src/core/dev/plugin.js b/packages/kit/src/core/dev/plugin.js index d28634a558ec..0e0e6aea6198 100644 --- a/packages/kit/src/core/dev/plugin.js +++ b/packages/kit/src/core/dev/plugin.js @@ -203,9 +203,9 @@ export async function create_plugin(config) { const file = config.kit.files.assets + pathname; if (fs.existsSync(file) && !fs.statSync(file).isDirectory()) { - const has_correct_case = fs.realpathSync - .native(file) - .endsWith(path.normalize(pathname)); + const has_correct_case = fs + .readdirSync(path.dirname(file)) + .includes(path.basename(file)); if (has_correct_case) { req.url = encodeURI(pathname); // don't need query/hash diff --git a/packages/kit/test/apps/basics/src/routes/assets/symlink.svelte b/packages/kit/test/apps/basics/src/routes/assets/symlink.svelte deleted file mode 100644 index aa8bf42335ca..000000000000 --- a/packages/kit/test/apps/basics/src/routes/assets/symlink.svelte +++ /dev/null @@ -1,7 +0,0 @@ - - - - -

are symlinked assets served?

-

blue = ok

- diff --git a/packages/kit/test/apps/basics/src/symlinked/asset.css b/packages/kit/test/apps/basics/src/symlinked/asset.css deleted file mode 100644 index 10ed260de7a1..000000000000 --- a/packages/kit/test/apps/basics/src/symlinked/asset.css +++ /dev/null @@ -1,7 +0,0 @@ -#symlinktest { - font-size: x-large; - color: blue; -} -#symlinktest::before { - content: 'YES! '; -} diff --git a/packages/kit/test/apps/basics/static/symlink-from b/packages/kit/test/apps/basics/static/symlink-from new file mode 120000 index 000000000000..7fcec67beeea --- /dev/null +++ b/packages/kit/test/apps/basics/static/symlink-from @@ -0,0 +1 @@ +symlink-to \ No newline at end of file diff --git a/packages/kit/test/apps/basics/static/symlink-to/hello.txt b/packages/kit/test/apps/basics/static/symlink-to/hello.txt new file mode 100644 index 000000000000..b6fc4c620b67 --- /dev/null +++ b/packages/kit/test/apps/basics/static/symlink-to/hello.txt @@ -0,0 +1 @@ +hello \ No newline at end of file diff --git a/packages/kit/test/apps/basics/static/symlinked b/packages/kit/test/apps/basics/static/symlinked deleted file mode 120000 index 44afaa86bc4d..000000000000 --- a/packages/kit/test/apps/basics/static/symlinked +++ /dev/null @@ -1 +0,0 @@ -../src/symlinked \ No newline at end of file diff --git a/packages/kit/test/apps/basics/test/test.js b/packages/kit/test/apps/basics/test/test.js index c9d2fb80c87e..d5c7de9372c6 100644 --- a/packages/kit/test/apps/basics/test/test.js +++ b/packages/kit/test/apps/basics/test/test.js @@ -2585,8 +2585,9 @@ test.describe.parallel('Static files', () => { }); test('Serves symlinked asset', async ({ request }) => { - const response = await request.get('/symlinked/asset.css'); + const response = await request.get('/symlink-from/hello.txt'); expect(response.status()).toBe(200); + expect(await response.text()).toBe('hello'); }); }); From 2a48e74c43953af8aa6be9f5f58e05b3af60b1a6 Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Mon, 30 May 2022 16:29:37 -0400 Subject: [PATCH 4/6] i guess we need to recurse --- packages/kit/src/core/dev/plugin.js | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/packages/kit/src/core/dev/plugin.js b/packages/kit/src/core/dev/plugin.js index 0e0e6aea6198..68753ca6a164 100644 --- a/packages/kit/src/core/dev/plugin.js +++ b/packages/kit/src/core/dev/plugin.js @@ -203,11 +203,7 @@ export async function create_plugin(config) { const file = config.kit.files.assets + pathname; if (fs.existsSync(file) && !fs.statSync(file).isDirectory()) { - const has_correct_case = fs - .readdirSync(path.dirname(file)) - .includes(path.basename(file)); - - if (has_correct_case) { + if (has_correct_case(file, config.kit.files.assets)) { req.url = encodeURI(pathname); // don't need query/hash asset_server(req, res); return; @@ -439,3 +435,20 @@ async function find_deps(vite, node, deps) { await Promise.all(branches); } + +/** + * @param {string} file + * @param {string} assets + * @returns {boolean} + */ +function has_correct_case(file, assets) { + if (file === assets) return true; + + const parent = path.dirname(file); + + if (fs.readdirSync(parent).includes(path.basename(file))) { + return has_correct_case(parent, assets); + } + + return false; +} \ No newline at end of file From b3246bb8929744dbfe5aeede75fda18d2c8970ad Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Mon, 30 May 2022 16:35:34 -0400 Subject: [PATCH 5/6] note to self --- packages/kit/src/core/dev/plugin.js | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/kit/src/core/dev/plugin.js b/packages/kit/src/core/dev/plugin.js index 5c8dfa445d5e..1a16922ecf6b 100644 --- a/packages/kit/src/core/dev/plugin.js +++ b/packages/kit/src/core/dev/plugin.js @@ -500,6 +500,10 @@ async function find_deps(vite, node, deps) { } /** + * Determine if a file is being requested with the correct case, + * to ensure consistent behaviour between dev and prod and across + * operating systems. Note that we can't use realpath here, + * because we don't want to follow symlinks * @param {string} file * @param {string} assets * @returns {boolean} From 90a0204c8c5f4ce1ca17244a11196b9aad1ac7a9 Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Mon, 30 May 2022 16:36:24 -0400 Subject: [PATCH 6/6] fix some stuff --- packages/kit/src/core/dev/plugin.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/kit/src/core/dev/plugin.js b/packages/kit/src/core/dev/plugin.js index 1a16922ecf6b..94bc8bd4f631 100644 --- a/packages/kit/src/core/dev/plugin.js +++ b/packages/kit/src/core/dev/plugin.js @@ -259,7 +259,7 @@ export const sveltekit = function (svelte_config) { const file = svelte_config.kit.files.assets + pathname; if (fs.existsSync(file) && !fs.statSync(file).isDirectory()) { - if (has_correct_case(file, config.kit.files.assets)) { + if (has_correct_case(file, svelte_config.kit.files.assets)) { req.url = encodeURI(pathname); // don't need query/hash asset_server(req, res); return; @@ -520,7 +520,7 @@ function has_correct_case(file, assets) { return false; } -/* +/** * @param {import('types').ValidatedConfig} svelte_config * @return {import('vite').Plugin[]} */