overhaul tests

test/apps/basics/__test__.ts

@@ -0,0 +1,270 @@
+import * as path from 'path';
+import * as assert from 'assert';
+import * as puppeteer from 'puppeteer';
+import * as http from 'http';
+import { build } from '../../../api';
+import { AppRunner } from '../AppRunner';
+import { wait } from '../../utils';
+
+declare let deleted: { id: number };
+declare let el: any;
+
+describe('basics', function() {
+	this.timeout(10000);
+
+	let runner: AppRunner;
+	let page: puppeteer.Page;
+	let base: string;
+
+	// helpers
+	let start: () => Promise<void>;
+	let prefetchRoutes: () => Promise<void>;
+	let prefetch: (href: string) => Promise<void>;
+	let goto: (href: string) => Promise<void>;
+
+	// hooks
+	before(() => {
+		return new Promise((fulfil, reject) => {
+			// TODO this is brittle. Make it unnecessary
+			process.chdir(__dirname);
+			process.env.NODE_ENV = 'production';
+
+			// TODO this API isn't great. Rethink it
+			const emitter = build({
+				bundler: 'rollup'
+			}, {
+				src: path.join(__dirname, 'src'),
+				routes: path.join(__dirname, 'src/routes'),
+				dest: path.join(__dirname, '__sapper__/build')
+			});
+
+			emitter.on('error', reject);
+
+			emitter.on('done', async () => {
+				try {
+					runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
+					({ base, page, start, prefetchRoutes, prefetch, goto } = await runner.start());
+
+					fulfil();
+				} catch (err) {
+					reject(err);
+				}
+			});
+		});
+	});
+
+	after(() => runner.end());
+
+	const title = () => page.$eval('h1', node => node.textContent);
+
+	it('serves /', async () => {
+		await page.goto(base);
+
+		assert.equal(
+			await title(),
+			'Great success!'
+		);
+	});
+
+	it('serves /?', async () => {
+		await page.goto(`${base}?`);
+
+		assert.equal(
+			await title(),
+			'Great success!'
+		);
+	});
+
+	it('serves static route', async () => {
+		await page.goto(`${base}/a`);
+
+		assert.equal(
+			await title(),
+			'a'
+		);
+	});
+
+	it('serves static route from dir/index.html file', async () => {
+		await page.goto(`${base}/b`);
+
+		assert.equal(
+			await title(),
+			'b'
+		);
+	});
+
+	it('serves dynamic route', async () => {
+		await page.goto(`${base}/test-slug`);
+
+		assert.equal(
+			await title(),
+			'TEST-SLUG'
+		);
+	});
+
+	it('navigates to a new page without reloading', async () => {
+		await page.goto(base);
+		await start();
+		await prefetchRoutes();
+
+		const requests: string[] = await runner.capture(async () => {
+			await page.click('a[href="a"]');
+		});
+
+		assert.deepEqual(requests, []);
+
+		assert.equal(
+			await title(),
+			'a'
+		);
+	});
+
+	it('navigates programmatically', async () => {
+		await page.goto(`${base}/a`);
+		await start();
+
+		await goto('b');
+
+		assert.equal(
+			await title(),
+			'b'
+		);
+	});
+
+	it('prefetches programmatically', async () => {
+		await page.goto(`${base}/a`);
+		await start();
+
+		const requests = await runner.capture(() => prefetch('b'));
+
+		assert.equal(requests.length, 2);
+		assert.equal(requests[1], `${base}/b.json`);
+	});
+
+
+	// TODO equivalent test for a webpack app
+	it('sets Content-Type, Link...modulepreload, and Cache-Control headers', () => {
+		return new Promise((fulfil, reject) => {
+			const req = http.get(base, res => {
+				try {
+					const { headers } = res;
+
+					assert.equal(
+						headers['content-type'],
+						'text/html'
+					);
+
+					assert.equal(
+						headers['cache-control'],
+						'max-age=600'
+					);
+
+					// TODO preload more than just the entry point
+					const regex = /<\/client\/client\.\w+\.js>;rel="modulepreload"/;
+					const link = <string>headers['link'];
+
+					assert.ok(regex.test(link), link);
+
+					fulfil();
+				} catch (err) {
+					reject(err);
+				}
+			});
+
+			req.on('error', reject);
+		});
+	});
+
+	it('calls a delete handler', async () => {
+		await page.goto(`${base}/delete-test`);
+		await start();
+
+		await page.click('.del');
+		await page.waitForFunction(() => deleted);
+
+		assert.equal(await page.evaluate(() => deleted.id), 42);
+	});
+
+	it('hydrates initial route', async () => {
+		await page.goto(base);
+
+		await page.evaluate(() => {
+			el = document.querySelector('.hydrate-test');
+		});
+
+		await start();
+
+		assert.ok(await page.evaluate(() => {
+			return document.querySelector('.hydrate-test') === el;
+		}));
+	});
+
+	it('does not attempt client-side navigation to server routes', async () => {
+		await page.goto(base);
+		await start();
+		await prefetchRoutes();
+
+		await page.click(`[href="ambiguous/ok.json"]`);
+		await wait(50);
+
+		assert.equal(
+			await page.evaluate(() => document.body.textContent),
+			'ok'
+		);
+	});
+
+	it('allows reserved words as route names', async () => {
+		await page.goto(`${base}/const`);
+		await start();
+
+		assert.equal(
+			await title(),
+			'reserved words are okay as routes'
+		);
+	});
+
+	it('accepts value-less query string parameter on server', async () => {
+		await page.goto(`${base}/echo-query?message`);
+
+		assert.equal(
+			await title(),
+			'message: ""'
+		);
+	});
+
+	it('accepts value-less query string parameter on client', async () => {
+		await page.goto(base);
+		await start();
+		await prefetchRoutes();
+
+		await page.click('a[href="echo-query?message"]')
+
+		assert.equal(
+			await title(),
+			'message: ""'
+		);
+	});
+
+	// skipped because Nightmare doesn't seem to focus the <a> correctly
+	it('resets the active element after navigation', async () => {
+		await page.goto(base);
+		await start();
+		await prefetchRoutes();
+
+		await page.click('[href="a"]');
+		await wait(50);
+
+		assert.equal(
+			await page.evaluate(() => document.activeElement.nodeName),
+			'BODY'
+		);
+	});
+
+	it('replaces %sapper.xxx% tags safely', async () => {
+		await page.goto(`${base}/unsafe-replacement`);
+		await start();
+
+		const html = await page.evaluate(() => document.body.innerHTML);
+		assert.equal(html.indexOf('%sapper'), -1);
+	});
+});

test/apps/basics/rollup.config.js

@@ -0,0 +1,64 @@
+import resolve from 'rollup-plugin-node-resolve';
+import replace from 'rollup-plugin-replace';
+import svelte from 'rollup-plugin-svelte';
+
+const mode = process.env.NODE_ENV;
+const dev = mode === 'development';
+
+const config = require('../../../config/rollup.js');
+
+export default {
+	client: {
+		input: config.client.input(),
+		output: config.client.output(),
+		plugins: [
+			replace({
+				'process.browser': true,
+				'process.env.NODE_ENV': JSON.stringify(mode)
+			}),
+			svelte({
+				dev,
+				hydratable: true,
+				emitCss: true
+			}),
+			resolve()
+		],
+
+		// temporary, pending Rollup 1.0
+		experimentalCodeSplitting: true
+	},
+
+	server: {
+		input: config.server.input(),
+		output: config.server.output(),
+		plugins: [
+			replace({
+				'process.browser': false,
+				'process.env.NODE_ENV': JSON.stringify(mode)
+			}),
+			svelte({
+				generate: 'ssr',
+				dev
+			}),
+			resolve({
+				preferBuiltins: true
+			})
+		],
+		external: ['sirv', 'polka'],
+
+		// temporary, pending Rollup 1.0
+		experimentalCodeSplitting: true
+	},
+
+	serviceworker: {
+		input: config.serviceworker.input(),
+		output: config.serviceworker.output(),
+		plugins: [
+			resolve(),
+			replace({
+				'process.browser': true,
+				'process.env.NODE_ENV': JSON.stringify(mode)
+			})
+		]
+	}
+};

test/apps/basics/src/client.js

@@ -0,0 +1,9 @@
+import * as sapper from '../__sapper__/client.js';
+
+window.start = () => sapper.start({
+	target: document.querySelector('#sapper')
+});
+
+window.prefetchRoutes = () => sapper.prefetchRoutes();
+window.prefetch = href => sapper.prefetch(href);
+window.goto = href => sapper.goto(href);

test/apps/basics/src/routes/[slug].html

@@ -0,0 +1 @@
+<h1>{params.slug.toUpperCase()}</h1>

test/apps/basics/src/routes/_error.html

@@ -0,0 +1,3 @@
+<h1>{status}</h1>
+
+<p>{error.message}</p>

test/apps/basics/src/routes/a.html

@@ -0,0 +1 @@
+<h1>a</h1>

test/apps/basics/src/routes/ambiguous/[slug].json.js

@@ -0,0 +1,3 @@
+export function get(req, res) {
+	res.end(req.params.slug);
+}

test/apps/basics/src/routes/b/index.html

@@ -0,0 +1,11 @@
+<h1>{letter}</h1>
+
+<script>
+	export default {
+		preload() {
+			return this.fetch('b.json').then(r => r.json()).then(letter => {
+				return { letter };
+			});
+		}
+	};
+</script>

test/apps/basics/src/routes/b/index.json.js

@@ -0,0 +1,3 @@
+export function get(req, res) {
+	res.end(JSON.stringify('b'));
+}

test/apps/basics/src/routes/const.html

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

test/apps/basics/src/routes/delete-test/[id].json.js

@@ -0,0 +1,9 @@
+export function del(req, res) {
+	res.writeHead(200, {
+		'Content-Type': 'application/json'
+	});
+
+	res.end(JSON.stringify({
+		id: req.params.id
+	}));
+}

test/apps/basics/src/routes/delete-test/index.html

@@ -0,0 +1,19 @@
+<button class='del' on:click='del()'>delete</button>
+
+<script>
+	export default {
+		oncreate() {
+			window.deleted = null;
+		},
+
+		methods: {
+			del() {
+				fetch(`delete-test/42.json`, { method: 'DELETE' })
+					.then(r => r.json())
+					.then(data => {
+						window.deleted = data;
+					});
+			}
+		}
+	};
+</script>

test/apps/basics/src/routes/echo-query/index.html

@@ -0,0 +1,9 @@
+<h1>message: "{message}"</h1>
+
+<script>
+	export default {
+		preload({ query }) {
+			return query;
+		}
+	};
+</script>

test/apps/basics/src/routes/index.html

@@ -0,0 +1,7 @@
+<h1>Great success!</h1>
+
+<a href="a">a</a>
+<a href="ambiguous/ok.json">ok</a>
+<a href="echo-query?message">ok</a>
+
+<div class='hydrate-test'></div>

test/apps/basics/src/routes/unsafe-replacement.html

@@ -0,0 +1,9 @@
+$&
+
+<script>
+	export default {
+		preload() {
+			return '$&';
+		}
+	};
+</script>

test/apps/basics/src/server.js

@@ -0,0 +1,8 @@
+import polka from 'polka';
+import * as sapper from '../__sapper__/server.js';
+
+const { PORT } = process.env;
+
+polka()
+	.use(sapper.middleware())
+	.listen(PORT);

test/apps/basics/src/service-worker.js

@@ -0,0 +1,82 @@
+import { timestamp, files, shell, routes } from '../__sapper__/service-worker.js';
+
+const ASSETS = `cache${timestamp}`;
+
+// `shell` is an array of all the files generated by webpack,
+// `files` is an array of everything in the `static` directory
+const to_cache = shell.concat(ASSETS);
+const cached = new Set(to_cache);
+
+self.addEventListener('install', event => {
+	event.waitUntil(
+		caches
+			.open(ASSETS)
+			.then(cache => cache.addAll(to_cache))
+			.then(() => {
+				self.skipWaiting();
+			})
+	);
+});
+
+self.addEventListener('activate', event => {
+	event.waitUntil(
+		caches.keys().then(async keys => {
+			// delete old caches
+			for (const key of keys) {
+				if (key !== ASSETS) await caches.delete(key);
+			}
+
+			self.clients.claim();
+		})
+	);
+});
+
+self.addEventListener('fetch', event => {
+	if (event.request.method !== 'GET') return;
+
+	const url = new URL(event.request.url);
+
+	// don't try to handle e.g. data: URIs
+	if (!url.protocol.startsWith('http')) return;
+
+	// ignore dev server requests
+	if (url.hostname === self.location.hostname && url.port !== self.location.port) return;
+
+	// always serve assets and webpack-generated files from cache
+	if (url.host === self.location.host && cached.has(url.pathname)) {
+		event.respondWith(caches.match(event.request));
+		return;
+	}
+
+	// for pages, you might want to serve a shell `index.html` file,
+	// which Sapper has generated for you. It's not right for every
+	// app, but if it's right for yours then uncomment this section
+	/*
+	if (url.origin === self.origin && routes.find(route => route.pattern.test(url.pathname))) {
+		event.respondWith(caches.match('/index.html'));
+		return;
+	}
+	*/
+
+	if (event.request.cache === 'only-if-cached') return;
+
+	// for everything else, try the network first, falling back to
+	// cache if the user is offline. (If the pages never change, you
+	// might prefer a cache-first approach to a network-first one.)
+	event.respondWith(
+		caches
+			.open(`offline${timestamp}`)
+			.then(async cache => {
+				try {
+					const response = await fetch(event.request);
+					cache.put(event.request, response.clone());
+					return response;
+				} catch(err) {
+					const response = await cache.match(event.request);
+					if (response) return response;
+
+					throw err;
+				}
+			})
+	);
+});

test/apps/basics/src/template.html

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+<head>
+	<meta charset='utf-8'>
+
+	%sapper.base%
+	%sapper.styles%
+	%sapper.head%
+</head>
+<body>
+	<div id='sapper'>%sapper.html%</div>
+	%sapper.scripts%
+</body>
+</html>