-> v0.20.2

handle value-less query string parameters

CHANGELOG.md

@@ -1,5 +1,31 @@
 # sapper changelog
 
+## 0.20.2
+
+* Add `immutable` cache control header for hashed assets ([#425](https://github.com/sveltejs/sapper/pull/425))
+* Handle value-less query string params ([#426](https://github.com/sveltejs/sapper/issues/426))
+
+## 0.20.1
+
+* Update shimport
+
+## 0.20.0
+
+* Decode `req.params` and `req.query` ([#417](https://github.com/sveltejs/sapper/issues/417))
+* Decode URLs before writing files in `sapper export` ([#414](https://github.com/sveltejs/sapper/pull/414))
+* Generate server sourcemaps for Rollup apps in dev mode ([#418](https://github.com/sveltejs/sapper/pull/418))
+
+## 0.19.3
+
+* Better unicode route handling ([#347](https://github.com/sveltejs/sapper/issues/347))
+
+## 0.19.2
+
+* Ignore editor tmp files ([#220](https://github.com/sveltejs/sapper/issues/220))
+* Ignore clicks an `<a>` element without `href` ([#235](https://github.com/sveltejs/sapper/issues/235))
+* Allow routes that are reserved JavaScript words ([#315](https://github.com/sveltejs/sapper/issues/315))
+* Print out webpack errors ([#403](https://github.com/sveltejs/sapper/issues/403))
+
 ## 0.19.1
 
 * Don't include local origin in export redirects ([#409](https://github.com/sveltejs/sapper/pull/409))

components/default-layout.html

@@ -1 +0,0 @@
-<svelte:component this={child.component} {...child.props}/>

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "sapper",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -6287,9 +6287,9 @@
       }
     },
     "shimport": {
-      "version": "0.0.10",
-      "resolved": "https://registry.npmjs.org/shimport/-/shimport-0.0.10.tgz",
-      "integrity": "sha512-3xPFDLmcLj87sx0OwA60qbloMQUsu6VGF97IG4RqxTf91sGeiaaXOPxM1PoQHbaTm4TOhH8zosokqLAZtuNGnA=="
+      "version": "0.0.11",
+      "resolved": "https://registry.npmjs.org/shimport/-/shimport-0.0.11.tgz",
+      "integrity": "sha512-wRlG/wMuV/czrzJEWBUPjydU/Ve0kTrTH8wHLRjuY6S2BDB+qDDXkTY/WrNc/7t5jnd0LPVO1sRIE7Ga6uXTpw=="
     },
     "signal-exit": {
       "version": "3.0.2",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sapper",
-  "version": "0.19.1",
+  "version": "0.20.2",
   "description": "Military-grade apps, engineered by Svelte",
   "main": "dist/middleware.js",
   "bin": {
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "html-minifier": "^3.5.16",
-    "shimport": "^0.0.10",
+    "shimport": "0.0.11",
     "source-map-support": "^0.5.6",
     "sourcemap-codec": "^1.4.1",
     "string-hash": "^1.1.3",

src/api/export.ts

@@ -85,7 +85,7 @@ async function execute(emitter: EventEmitter, opts: Opts) {
 
 	function save(path: string, status: number, type: string, body: string) {
 		const { pathname } = resolve(origin, path);
-		let file = pathname.slice(1);
+		let file = decodeURIComponent(pathname.slice(1));
 
 		if (saved.has(file)) return;
 		saved.add(file);

src/core/create_compilers/WebpackCompiler.ts

@@ -28,8 +28,7 @@ export class WebpackCompiler {
 				const result = new WebpackResult(stats);
 
 				if (result.errors.length) {
-					// TODO print errors
-					// console.error(stats.toString({ colors: true }));
+					console.error(stats.toString({ colors: true }));
 					reject(new Error(`Encountered errors while building app`));
 				}
 

src/core/create_manifest_data.ts

@@ -2,7 +2,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import { locations } from '../config';
 import { Page, PageComponent, ServerRoute, ManifestData } from '../interfaces';
-import { posixify } from './utils';
+import { posixify, reserved_words } from './utils';
 
 export default function create_manifest_data(cwd = locations.routes()): ManifestData {
 	const components: PageComponent[] = [];
@@ -30,13 +30,16 @@ export default function create_manifest_data(cwd = locations.routes()): Manifest
 				const file = path.relative(cwd, resolved);
 				const is_dir = fs.statSync(resolved).isDirectory();
 
+				const ext = path.extname(basename);
+				if (!is_dir && !/^\.[a-z]+$/i.test(ext)) return null; // filter out tmp files etc
+
 				const segment = is_dir
 					? basename
 					: basename.slice(0, -path.extname(basename).length);
 
 				const parts = get_parts(segment);
 				const is_index = is_dir ? false : basename.startsWith('index.');
-				const is_page = path.extname(basename) === '.html';
+				const is_page = ext === '.html';
 
 				parts.forEach(part => {
 					if (/\]\[/.test(part.content)) {
@@ -57,6 +60,7 @@ export default function create_manifest_data(cwd = locations.routes()): Manifest
 					is_page
 				};
 			})
+			.filter(Boolean)
 			.sort(comparator);
 
 		items.forEach(item => {
@@ -265,7 +269,7 @@ function get_parts(part: string): Part[] {
 }
 
 function get_slug(file: string) {
-	return file
+	let name = file
 		.replace(/[\\\/]index/, '')
 		.replace(/_default([\/\\index])?\.html$/, 'index')
 		.replace(/[\/\\]/g, '_')
@@ -274,6 +278,9 @@ function get_slug(file: string) {
 		.replace(/[^a-zA-Z0-9_$]/g, c => {
 			return c === '.' ? '_' : `$${c.charCodeAt(0)}`
 		});
+
+	if (reserved_words.has(name)) name += '_';
+	return name;
 }
 
 function get_pattern(segments: Part[][], add_trailing_slash: boolean) {

src/core/create_manifests.ts

@@ -63,6 +63,8 @@ function generate_client(
 		import root from '${get_file(path_to_routes, manifest_data.root)}';
 		import error from '${posixify(`${path_to_routes}/_error.html`)}';
 
+		const d = decodeURIComponent;
+
 		${manifest_data.components.map(component => {
 			const annotation = bundler === 'webpack'
 				? `/* webpackChunkName: "${component.name}" */ `
@@ -88,7 +90,7 @@ function generate_client(
 							if (part === null) return 'null';
 
 							if (part.params.length > 0) {
-								const props = part.params.map((param, i) => `${param}: match[${i + 1}]`);
+								const props = part.params.map((param, i) => `${param}: d(match[${i + 1}])`);
 								return `{ component: ${part.component.name}, params: match => ({ ${props.join(', ')} }) }`;
 							}
 
@@ -138,6 +140,8 @@ function generate_server(
 		// This file is generated by Sapper — do not edit it!
 		${imports.join('\n')}
 
+		const d = decodeURIComponent;
+
 		export const manifest = {
 			server_routes: [
 				${manifest_data.server_routes.map(route => `{
@@ -145,7 +149,7 @@ function generate_server(
 					pattern: ${route.pattern},
 					handlers: ${route.name},
 					params: ${route.params.length > 0
-						? `match => ({ ${route.params.map((param, i) => `${param}: match[${i + 1}]`).join(', ')} })`
+						? `match => ({ ${route.params.map((param, i) => `${param}: d(match[${i + 1}])`).join(', ')} })`
 						: `() => ({})`}
 				}`).join(',\n\n\t\t\t\t')}
 			],
@@ -165,7 +169,7 @@ function generate_server(
 							];
 
 							if (part.params.length > 0) {
-								const params = part.params.map((param, i) => `${param}: match[${i + 1}]`);
+								const params = part.params.map((param, i) => `${param}: d(match[${i + 1}])`);
 								props.push(`params: match => ({ ${params.join(', ')} })`);
 							}
 

src/core/utils.ts

@@ -22,4 +22,55 @@ export function fudge_mtime(file: string) {
 		new Date(atime.getTime() - 999999),
 		new Date(mtime.getTime() - 999999)
 	);
-}
+}
+
+export const reserved_words = new Set([
+	'arguments',
+	'await',
+	'break',
+	'case',
+	'catch',
+	'class',
+	'const',
+	'continue',
+	'debugger',
+	'default',
+	'delete',
+	'do',
+	'else',
+	'enum',
+	'eval',
+	'export',
+	'extends',
+	'false',
+	'finally',
+	'for',
+	'function',
+	'if',
+	'implements',
+	'import',
+	'in',
+	'instanceof',
+	'interface',
+	'let',
+	'new',
+	'null',
+	'package',
+	'private',
+	'protected',
+	'public',
+	'return',
+	'static',
+	'super',
+	'switch',
+	'this',
+	'throw',
+	'true',
+	'try',
+	'typeof',
+	'var',
+	'void',
+	'while',
+	'with',
+	'yield',
+]);

src/middleware.ts

@@ -151,7 +151,7 @@ export default function middleware(opts: {
 
 		serve({
 			prefix: '/client/',
-			cache_control: dev() ? 'no-cache' : 'max-age=31536000'
+			cache_control: dev() ? 'no-cache' : 'max-age=31536000, immutable'
 		}),
 
 		get_server_route_handler(manifest.server_routes),
@@ -185,7 +185,8 @@ function serve({ prefix, pathname, cache_control }: {
 			const type = lookup(req.path);
 
 			try {
-				const data = read(req.path.slice(1));
+				const file = decodeURIComponent(req.path.slice(1));
+				const data = read(file);
 
 				res.setHeader('Content-Type', type);
 				res.setHeader('Cache-Control', cache_control);

src/rollup.ts

@@ -30,7 +30,8 @@ export default {
 		output: () => {
 			return {
 				dir: locations.dest(),
-				format: 'cjs'
+				format: 'cjs',
+				sourcemap: dev()
 			};
 		}
 	},

src/runtime/index.ts

@@ -66,8 +66,8 @@ function select_route(url: URL): Target {
 			const query: Record<string, string | true> = {};
 			if (url.search.length > 0) {
 				url.search.slice(1).split('&').forEach(searchParam => {
-					const [, key, value] = /([^=]+)=(.*)/.exec(searchParam);
-					query[key] = value || true;
+					const [, key, value] = /([^=]+)(?:=(.*))?/.exec(searchParam);
+					query[key] = decodeURIComponent((value || '').replace(/\+/g, ' '));
 				});
 			}
 			return { url, path, page, match, query };
@@ -336,6 +336,8 @@ function handle_click(event: MouseEvent) {
 	const a: HTMLAnchorElement | SVGAElement = <HTMLAnchorElement | SVGAElement>findAnchor(<Node>event.target);
 	if (!a) return;
 
+	if (!a.href) return;
+
 	// check if link is inside an svg
 	// in this case, both href and target are always inside an object
 	const svg = typeof a.href === 'object' && a.href.constructor.name === 'SVGAnimatedString';

test/app/app/client.js

@@ -1,4 +1,4 @@
-import { init, prefetchRoutes } from '../../../runtime.js';
+import { init, goto, prefetchRoutes } from '../../../runtime.js';
 import { Store } from 'svelte/store.js';
 import { manifest } from './manifest/client.js';
 
@@ -10,4 +10,5 @@ window.init = () => {
 	});
 };
 
-window.prefetchRoutes = prefetchRoutes;
+window.prefetchRoutes = prefetchRoutes;
+window.goto = goto;

test/app/routes/blog/_posts.js

@@ -106,6 +106,14 @@ const posts = [
 			<p>If you didn't have adult onset diabetes, I wouldn't mind giving you a little sugar. Everybody dance NOW. And the soup of the day is bread. Great, now I'm gonna smell to high heaven like a tuna melt!</p>
 			<p>That's how Tony Wonder lost a nut. She calls it a Mayonegg. Go ahead, touch the Cornballer. There's a new daddy in town. A discipline daddy.</p>
 		`
+	},
+
+	{
+		title: 'Encödïng test',
+		slug: 'encödïng-test',
+		html: `
+			<p>It works</p>
+		`
 	}
 ];
 

test/app/routes/const.html

@@ -0,0 +1 @@
+<h1>reserved words are okay as routes</h1>

test/app/routes/echo/page/[slug].html

@@ -0,0 +1,12 @@
+<h1>{slug} ({message})</h1>
+
+<script>
+	export default {
+		preload({ params, query }) {
+			return {
+				slug: params.slug,
+				message: query.message
+			};
+		}
+	};
+</script>

test/app/routes/echo/server-route/[slug].js

@@ -0,0 +1,15 @@
+export function get(req, res) {
+	res.writeHead(200, {
+		'Content-Type': 'text/html'
+	});
+
+	res.end(`
+		<!doctype html>
+		<html>
+			<head><meta charset="utf-8"></head>
+			<body>
+				<h1>${req.params.slug}</h1>
+			</body>
+		</html>
+	`);
+}

test/app/routes/fünke.html

@@ -1 +1,11 @@
-<h1>I'm afraid I just blue myself</h1>
+<h1>{phrase}</h1>
+
+<script>
+	export default {
+		preload() {
+			return this.fetch('fünke.json').then(r => r.json()).then(phrase => {
+				return { phrase };
+			});
+		}
+	};
+</script>

test/app/routes/fünke.json.js

@@ -0,0 +1,9 @@
+export function get(req, res) {
+	res.writeHead(200, {
+		'Content-Type': 'application/json'
+	});
+
+	res.end(JSON.stringify(
+		"I'm afraid I just blue myself"
+	));
+}

test/app/routes/index.html

@@ -14,6 +14,9 @@
 <a href='blog/throw-an-error'>error link</a>
 <a href='credentials?creds=include'>credentials</a>
 <a rel=prefetch class='{page === "blog"  ? "selected" : ""}' href='blog'>blog</a>
+<a href="const">const</a>
+<a href="echo/page/encöded?message=hëllö+wörld">echo/page/encöded?message=hëllö+wörld</a>
+<a href="echo/page/empty?message">echo/page/empty?message</a>
 
 <div class='hydrate-test'></div>
 

test/common/test.js

@@ -93,6 +93,7 @@ function testExport({ basepath = '' }) {
 				'blog/how-to-use-sapper/index.html',
 				'blog/what-is-sapper/index.html',
 				'blog/why-the-name/index.html',
+				'blog/encödïng-test/index.html',
 
 				'blog.json',
 				'blog/a-very-long-post.json',
@@ -101,6 +102,7 @@ function testExport({ basepath = '' }) {
 				'blog/how-to-use-sapper.json',
 				'blog/what-is-sapper.json',
 				'blog/why-the-name.json',
+				'blog/encödïng-test.json',
 
 				'favicon.png',
 				'global.css',
@@ -743,6 +745,58 @@ function run({ mode, basepath = '' }) {
 						assert.equal(title, 'root preload function ran: true');
 					});
 			});
+
+			it('allows reserved words as route names', () => {
+				return nightmare.goto(`${base}/const`).init()
+					.page.title()
+					.then(title => {
+						assert.equal(title, 'reserved words are okay as routes');
+					});
+			});
+
+			it('encodes req.params and req.query for server-rendered pages', () => {
+				return nightmare.goto(`${base}/echo/page/encöded?message=hëllö+wörld`)
+					.page.title()
+					.then(title => {
+						assert.equal(title, 'encöded (hëllö wörld)');
+					});
+			});
+
+			it('encodes req.params and req.query for client-rendered pages', () => {
+				return nightmare.goto(base).init()
+					.click('a[href="echo/page/encöded?message=hëllö+wörld"]')
+					.wait(100)
+					.page.title()
+					.then(title => {
+						assert.equal(title, 'encöded (hëllö wörld)');
+					});
+			});
+
+			it('accepts value-less query string parameter on server', () => {
+				return nightmare.goto(`${base}/echo/page/empty?message`)
+					.page.title()
+					.then(title => {
+						assert.equal(title, 'empty ()');
+					});
+			});
+
+			it('accepts value-less query string parameter on client', () => {
+				return nightmare.goto(base).init()
+					.click('a[href="echo/page/empty?message"]')
+					.wait(100)
+					.page.title()
+					.then(title => {
+						assert.equal(title, 'empty ()');
+					});
+			});
+
+			it('encodes req.params for server routes', () => {
+				return nightmare.goto(`${base}/echo/server-route/encöded`)
+					.page.title()
+					.then(title => {
+						assert.equal(title, 'encöded');
+					});
+			});
 		});
 
 		describe('headers', () => {

test/unit/create_manifest_data/index.ts

@@ -1,10 +1,10 @@
 import * as path from 'path';
 import * as assert from 'assert';
-import manifest_data from '../../../src/core/create_manifest_data';
+import create_manifest_data from '../../../src/core/create_manifest_data';
 
 describe('manifest_data', () => {
 	it('creates routes', () => {
-		const { components, pages, server_routes } = manifest_data(path.join(__dirname, 'samples/basic'));
+		const { components, pages, server_routes } = create_manifest_data(path.join(__dirname, 'samples/basic'));
 
 		const index = { name: 'index', file: 'index.html' };
 		const about = { name: 'about', file: 'about.html' };
@@ -68,7 +68,7 @@ describe('manifest_data', () => {
 	});
 
 	it('encodes invalid characters', () => {
-		const { components, pages } = manifest_data(path.join(__dirname, 'samples/encoding'));
+		const { components, pages } = create_manifest_data(path.join(__dirname, 'samples/encoding'));
 
 		// had to remove ? and " because windows
 
@@ -90,7 +90,7 @@ describe('manifest_data', () => {
 	});
 
 	it('allows regex qualifiers', () => {
-		const { pages } = manifest_data(path.join(__dirname, 'samples/qualifiers'));
+		const { pages } = create_manifest_data(path.join(__dirname, 'samples/qualifiers'));
 
 		assert.deepEqual(pages.map(p => p.pattern), [
 			/^\/([0-9-a-z]{3,})\/?$/,
@@ -100,7 +100,7 @@ describe('manifest_data', () => {
 	});
 
 	it('sorts routes correctly', () => {
-		const { pages } = manifest_data(path.join(__dirname, 'samples/sorting'));
+		const { pages } = create_manifest_data(path.join(__dirname, 'samples/sorting'));
 
 		assert.deepEqual(pages.map(p => p.parts.map(part => part && part.component.file)), [
 			['index.html'],
@@ -116,7 +116,7 @@ describe('manifest_data', () => {
 	});
 
 	it('ignores files and directories with leading underscores', () => {
-		const { server_routes } = manifest_data(path.join(__dirname, 'samples/hidden-underscore'));
+		const { server_routes } = create_manifest_data(path.join(__dirname, 'samples/hidden-underscore'));
 
 		assert.deepEqual(server_routes.map(r => r.file), [
 			'index.js',
@@ -125,7 +125,7 @@ describe('manifest_data', () => {
 	});
 
 	it('ignores files and directories with leading dots except .well-known', () => {
-		const { server_routes } = manifest_data(path.join(__dirname, 'samples/hidden-dot'));
+		const { server_routes } = create_manifest_data(path.join(__dirname, 'samples/hidden-dot'));
 
 		assert.deepEqual(server_routes.map(r => r.file), [
 			'.well-known/dnt-policy.txt.js'
@@ -134,24 +134,35 @@ describe('manifest_data', () => {
 
 	it('fails on clashes', () => {
 		assert.throws(() => {
-			const { pages } = manifest_data(path.join(__dirname, 'samples/clash-pages'));
+			const { pages } = create_manifest_data(path.join(__dirname, 'samples/clash-pages'));
 		}, /The \[bar\]\/index\.html and \[foo\]\.html pages clash/);
 
 		assert.throws(() => {
-			const { server_routes } = manifest_data(path.join(__dirname, 'samples/clash-routes'));
+			const { server_routes } = create_manifest_data(path.join(__dirname, 'samples/clash-routes'));
 			console.log(server_routes);
 		}, /The \[bar\]\/index\.js and \[foo\]\.js routes clash/);
 	});
 
 	it('fails if dynamic params are not separated', () => {
 		assert.throws(() => {
-			manifest_data(path.join(__dirname, 'samples/invalid-params'));
+			create_manifest_data(path.join(__dirname, 'samples/invalid-params'));
 		}, /Invalid route \[foo\]\[bar\]\.js — parameters must be separated/);
 	});
 
 	it('errors when trying to use reserved characters in route regexp', () => {
 		assert.throws(() => {
-			manifest_data(path.join(__dirname, 'samples/invalid-qualifier'));
+			create_manifest_data(path.join(__dirname, 'samples/invalid-qualifier'));
 		}, /Invalid route \[foo\(\[a-z\]\(\[0-9\]\)\)\].js — cannot use \(, \), \? or \: in route qualifiers/);
 	});
+
+	it('ignores things that look like lockfiles' , () => {
+		const { server_routes } = create_manifest_data(path.join(__dirname, 'samples/lockfiles'));
+
+		assert.deepEqual(server_routes, [{
+			file: 'foo.js',
+			name: 'route_foo',
+			params: [],
+			pattern: /^\/foo$/
+		}]);
+	});
 });