-> v0.15.7

pass response object to store getter

.travis.yml

@@ -18,4 +18,4 @@ addons:
 install:
   - export DISPLAY=':99.0'
   - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
-  - npm install
+  - npm ci || npm i

CHANGELOG.md

@@ -1,5 +1,20 @@
 # sapper changelog
 
+## 0.15.7
+
+* Strip leading slash from redirects ([#291](https://github.com/sveltejs/sapper/issues/291))
+* Pass `(req, res)` to store getter ([#344](https://github.com/sveltejs/sapper/issues/344))
+
+## 0.15.6
+
+* Fix exporting with custom basepath ([#342](https://github.com/sveltejs/sapper/pull/342))
+
+## 0.15.5
+
+* Faster `export` with more explanatory output ([#335](https://github.com/sveltejs/sapper/pull/335))
+* Only blur `activeElement` if it exists ([#332](https://github.com/sveltejs/sapper/issues/332))
+* Don't emit `client_info.json` or `server_info.json` ([#318](https://github.com/sveltejs/sapper/issues/318))
+
 ## 0.15.4
 
 * Add `ignore` option ([#326](https://github.com/sveltejs/sapper/pull/326))

appveyor.yml

@@ -14,7 +14,7 @@ environment:
 
 install:
   - ps: Install-Product node $env:nodejs_version
-  - npm install
+  - npm ci
 
 test_script:
   - node --version && npm --version

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sapper",
-  "version": "0.15.4",
+  "version": "0.15.7",
   "description": "Military-grade apps, engineered by Svelte",
   "main": "dist/middleware.ts.js",
   "bin": {
@@ -28,7 +28,7 @@
     "html-minifier": "^3.5.16",
     "mkdirp": "^0.5.1",
     "node-fetch": "^2.1.1",
-    "port-authority": "^1.0.2",
+    "port-authority": "^1.0.5",
     "pretty-bytes": "^5.0.0",
     "pretty-ms": "^3.1.0",
     "require-relative": "^0.8.7",

src/api/build.ts

@@ -4,8 +4,7 @@ import mkdirp from 'mkdirp';
 import rimraf from 'rimraf';
 import { EventEmitter } from 'events';
 import { minify_html } from './utils/minify_html';
-import { create_compilers, create_main_manifests, create_routes, create_serviceworker_manifest } from '../core'
-import { locations } from '../config';
+import { create_compilers, create_main_manifests, create_routes, create_serviceworker_manifest } from '../core';
 import * as events from './interfaces';
 
 export function build(opts: {}) {
@@ -62,7 +61,6 @@ async function execute(emitter: EventEmitter, {
 	});
 
 	const client_info = client_stats.toJson();
-	fs.writeFileSync(path.join(dest, 'client_info.json'), JSON.stringify(client_info));
 	fs.writeFileSync(path.join(dest, 'client_assets.json'), JSON.stringify(client_info.assetsByChunkName));
 
 	const server_stats = await compile(server);

src/api/dev.ts

@@ -9,6 +9,7 @@ import format_messages from 'webpack-format-messages';
 import { locations } from '../config';
 import { EventEmitter } from 'events';
 import { create_routes, create_main_manifests, create_compilers, create_serviceworker_manifest } from '../core';
+import Deferred from './utils/Deferred';
 import * as events from './interfaces';
 
 export function dev(opts) {
@@ -168,8 +169,6 @@ class Watcher extends EventEmitter {
 			},
 
 			result: info => {
-				fs.writeFileSync(path.join(dest, 'server_info.json'), JSON.stringify(info, null, '  '));
-
 				this.deferreds.client.promise.then(() => {
 					const restart = () => {
 						log = '';
@@ -252,7 +251,6 @@ class Watcher extends EventEmitter {
 			},
 
 			result: info => {
-				fs.writeFileSync(path.join(dest, 'client_info.json'), JSON.stringify(info));
 				fs.writeFileSync(path.join(dest, 'client_assets.json'), JSON.stringify(info.assetsByChunkName, null, '  '));
 				this.deferreds.client.fulfil();
 
@@ -401,19 +399,6 @@ function mungeWebpackError(message: string, duplicate: boolean) {
 	};
 }
 
-class Deferred {
-	promise: Promise<any>;
-	fulfil: (value?: any) => void;
-	reject: (error: Error) => void;
-
-	constructor() {
-		this.promise = new Promise((fulfil, reject) => {
-			this.fulfil = fulfil;
-			this.reject = reject;
-		});
-	}
-}
-
 const INTERVAL = 10000;
 
 class DevServer {

src/api/export.ts

@@ -7,7 +7,7 @@ import fetch from 'node-fetch';
 import * as ports from 'port-authority';
 import { EventEmitter } from 'events';
 import { minify_html } from './utils/minify_html';
-import { locations } from '../config';
+import Deferred from './utils/Deferred';
 import * as events from './interfaces';
 
 export function exporter(opts: {}) {
@@ -51,6 +51,11 @@ async function execute(emitter: EventEmitter, {
 	const port = await ports.find(3000);
 
 	const origin = `http://localhost:${port}`;
+	const root = new URL(basepath || '', origin);
+
+	emitter.emit('info', {
+		message: `Crawling ${root.href}`
+	});
 
 	const proc = child_process.fork(path.resolve(`${build}/server.js`), [], {
 		cwd: process.cwd(),
@@ -64,11 +69,23 @@ async function execute(emitter: EventEmitter, {
 
 	const seen = new Set();
 	const saved = new Set();
+	const deferreds = new Map();
+
+	function get_deferred(pathname: string) {
+		pathname = pathname.replace(root.pathname, '');
+
+		if (!deferreds.has(pathname)) {
+			deferreds.set(pathname, new Deferred());
+		}
+
+		return deferreds.get(pathname);
+	}
 
 	proc.on('message', message => {
 		if (!message.__sapper__ || message.event !== 'file') return;
 
-		let file = new URL(message.url, origin).pathname.slice(1);
+		const pathname = new URL(message.url, origin).pathname;
+		let file = pathname.slice(1);
 		let { body } = message;
 
 		if (saved.has(file)) return;
@@ -83,24 +100,26 @@ async function execute(emitter: EventEmitter, {
 
 		emitter.emit('file', <events.FileEvent>{
 			file,
-			size: body.length
+			size: body.length,
+			status: message.status
 		});
 
 		sander.writeFileSync(export_dir, file, body);
+
+		get_deferred(pathname).fulfil();
 	});
 
 	async function handle(url: URL) {
+		const pathname = (url.pathname.replace(root.pathname, '') || '/');
+
+		if (seen.has(pathname)) return;
+		seen.add(pathname);
+
+		const deferred = get_deferred(pathname);
+
 		const r = await fetch(url.href);
 		const range = ~~(r.status / 100);
 
-		if (range >= 4) {
-			emitter.emit('failure', <events.FailureEvent>{
-				status: r.status,
-				pathname: url.pathname
-			});
-			return;
-		}
-
 		if (range === 2) {
 			if (r.headers.get('Content-Type') === 'text/html') {
 				const body = await r.text();
@@ -111,19 +130,20 @@ async function execute(emitter: EventEmitter, {
 
 				$('a[href]').each((i: number, $a) => {
 					const url = new URL($a.attribs.href, base.href);
-
-					if (url.origin === origin && !seen.has(url.pathname)) {
-						seen.add(url.pathname);
-						urls.push(url);
-					}
+					if (url.origin === origin) urls.push(url);
 				});
 
 				await Promise.all(urls.map(handle));
 			}
 		}
+
+		await deferred.promise;
 	}
 
 	return ports.wait(port)
-		.then(() => handle(new URL(`/${basepath}`, origin))) // TODO all static routes
+		.then(() => {
+			// TODO all static routes
+			return handle(root);
+		})
 		.then(() => proc.kill());
 }

src/api/utils/Deferred.ts

@@ -0,0 +1,12 @@
+export default class Deferred {
+	promise: Promise<any>;
+	fulfil: (value?: any) => void;
+	reject: (error: Error) => void;
+
+	constructor() {
+		this.promise = new Promise((fulfil, reject) => {
+			this.fulfil = fulfil;
+			this.reject = reject;
+		});
+	}
+}

src/cli.ts

@@ -1,11 +1,8 @@
 import * as fs from 'fs';
 import * as path from 'path';
-import * as child_process from 'child_process';
 import sade from 'sade';
 import * as colors from 'ansi-colors';
 import prettyMs from 'pretty-ms';
-// import upgrade from './cli/upgrade';
-import * as ports from 'port-authority';
 import * as pkg from '../package.json';
 
 const prog = sade('sapper').version(pkg.version);
@@ -65,19 +62,22 @@ prog.command('start [dir]')
 
 prog.command('export [dest]')
 	.describe('Export your app as static files (if possible)')
+	.option('--build', '(Re)build app before exporting', true)
+	.option('--build-dir', 'Specify a custom temporary build directory', '.sapper/prod')
 	.option('--basepath', 'Specify a base path')
-	.action(async (dest = 'export', opts: { basepath?: string }) => {
-		console.log(`> Building...`);
-
+	.action(async (dest = 'export', opts: { build: boolean, 'build-dir': string, basepath?: string }) => {
 		process.env.NODE_ENV = 'production';
-		process.env.SAPPER_DEST = '.sapper/.export';
+		process.env.SAPPER_DEST = opts['build-dir'];
 
 		const start = Date.now();
 
 		try {
-			const { build } = await import('./cli/build');
-			await build();
-			console.error(`\n> Built in ${elapsed(start)}. Crawling site...`);
+			if (opts.build) {
+				console.log(`> Building...`);
+				const { build } = await import('./cli/build');
+				await build();
+				console.error(`\n> Built in ${elapsed(start)}`);
+			}
 
 			const { exporter } = await import('./cli/export');
 			await exporter(dest, opts);

src/cli/export.ts

@@ -3,6 +3,11 @@ import * as colors from 'ansi-colors';
 import prettyBytes from 'pretty-bytes';
 import { locations } from '../config';
 
+function left_pad(str: string, len: number) {
+	while (str.length < len) str = ` ${str}`;
+	return str;
+}
+
 export function exporter(export_dir: string, { basepath = '' }) {
 	return new Promise((fulfil, reject) => {
 		try {
@@ -13,11 +18,19 @@ export function exporter(export_dir: string, { basepath = '' }) {
 			});
 
 			emitter.on('file', event => {
-				console.log(`${colors.bold.cyan(event.file)} ${colors.gray(`(${prettyBytes(event.size)})`)}`);
+				const pb = prettyBytes(event.size);
+				const size_color = event.size > 150000 ? colors.bold.red : event.size > 50000 ? colors.bold.yellow : colors.bold.gray;
+				const size_label = size_color(left_pad(prettyBytes(event.size), 10));
+
+				const file_label = event.status === 200
+					? event.file
+					: colors.bold[event.status >= 400 ? 'red' : 'yellow'](`(${event.status}) ${event.file}`);
+
+				console.log(`${size_label}   ${file_label}`);
 			});
 
-			emitter.on('failure', event => {
-				console.log(`${colors.red(`> Received ${event.status} response when fetching ${event.pathname}`)}`);
+			emitter.on('info', event => {
+				console.log(colors.bold.cyan(`> ${event.message}`));
 			});
 
 			emitter.on('error', event => {

src/config.ts

@@ -6,5 +6,5 @@ export const locations = {
 	base:   () => path.resolve(process.env.SAPPER_BASE || ''),
 	app:    () => path.resolve(process.env.SAPPER_BASE || '', process.env.SAPPER_APP    || 'app'),
 	routes: () => path.resolve(process.env.SAPPER_BASE || '', process.env.SAPPER_ROUTES || 'routes'),
-	dest:   () => path.resolve(process.env.SAPPER_BASE || '', process.env.SAPPER_DEST   || '.sapper')
+	dest:   () => path.resolve(process.env.SAPPER_BASE || '', process.env.SAPPER_DEST   || `.sapper/${dev() ? 'dev' : 'prod'}`)
 };

src/middleware.ts

@@ -83,7 +83,7 @@ function toIgnore(uri: string, val: any) {
 
 export default function middleware(opts: {
 	manifest: Manifest,
-	store: (req: Req) => Store,
+	store: (req: Req, res: ServerResponse) => Store,
 	ignore?: any,
 	routes?: any // legacy
 }) {
@@ -276,7 +276,10 @@ function get_server_route_handler(routes: ServerRoute[]) {
 	};
 }
 
-function get_page_handler(manifest: Manifest, store_getter: (req: Req) => Store) {
+function get_page_handler(
+	manifest: Manifest,
+	store_getter: (req: Req, res: ServerResponse) => Store
+) {
 	const output = locations.dest();
 
 	const get_chunks = dev()
@@ -326,7 +329,7 @@ function get_page_handler(manifest: Manifest, store_getter: (req: Req) => Store)
 
 		res.setHeader('Link', link);
 
-		const store = store_getter ? store_getter(req) : null;
+		const store = store_getter ? store_getter(req, res) : null;
 
 		let redirect: { statusCode: number, location: string };
 		let preload_error: { statusCode: number, message: Error | string };
@@ -336,6 +339,7 @@ function get_page_handler(manifest: Manifest, store_getter: (req: Req) => Store)
 				if (redirect && (redirect.statusCode !== statusCode || redirect.location !== location)) {
 					throw new Error(`Conflicting redirects`);
 				}
+				location = location.replace(/^\//g, ''); // leading slash (only)
 				redirect = { statusCode, location };
 			},
 			error: (statusCode: number, message: Error | string) => {
@@ -402,10 +406,24 @@ function get_page_handler(manifest: Manifest, store_getter: (req: Req) => Store)
 			return []; // appease TypeScript
 		}).then(preloaded => {
 			if (redirect) {
+				const location = `${req.baseUrl}/${redirect.location}`;
+
 				res.statusCode = redirect.statusCode;
-				res.setHeader('Location', `${req.baseUrl}/${redirect.location}`);
+				res.setHeader('Location', location);
 				res.end();
 
+				if (process.send) {
+					process.send({
+						__sapper__: true,
+						event: 'file',
+						url: req.url,
+						method: req.method,
+						status: redirect.statusCode,
+						type: 'text/html',
+						body: `<script>window.location.href = "${location}"</script>`
+					});
+				}
+
 				return;
 			}
 
@@ -498,7 +516,7 @@ function get_page_handler(manifest: Manifest, store_getter: (req: Req) => Store)
 					event: 'file',
 					url: req.url,
 					method: req.method,
-					status: 200,
+					status,
 					type: 'text/html',
 					body
 				});
@@ -568,4 +586,4 @@ function escape_html(html: string) {
 	};
 
 	return html.replace(/["'&<>]/g, c => `&${chars[c]};`);
-}
+}

src/runtime/index.ts

@@ -298,7 +298,7 @@ async function navigate(target: Target, id: number): Promise<any> {
 		await goto(redirect.location, { replaceState: true });
 	} else {
 		render(data, nullable_depth, scroll_history[id], token);
-		document.activeElement.blur();
+		if (document.activeElement) document.activeElement.blur();
 	}
 }
 

test/app/app/server.js

@@ -85,11 +85,18 @@ const middlewares = [
 		next();
 	},
 
+	// set up some values for the store
+	(req, res, next) => {
+		req.hello = 'hello';
+		res.locals = { name: 'world' };
+		next();
+	},
+
 	sapper({
 		manifest,
-		store: () => {
+		store: (req, res) => {
 			return new Store({
-				title: 'Stored title'
+				title: `${req.hello} ${res.locals.name}`
 			});
 		},
 		ignore: [

test/app/routes/index.html

@@ -8,6 +8,7 @@
 <a href='about'>about</a>
 <a href='slow-preload'>slow preload</a>
 <a href='redirect-from'>redirect</a>
+<a href='redirect-root'>redirect (root)</a>
 <a href='blog/nope'>broken link</a>
 <a href='blog/throw-an-error'>error link</a>
 <a href='credentials?creds=include'>credentials</a>

test/app/routes/redirect-root.html

@@ -0,0 +1,7 @@
+<script>
+	export default {
+		preload() {
+			this.redirect(301, '/');
+		}
+	};
+</script>

test/common/test.js

@@ -59,9 +59,19 @@ describe('sapper', function() {
 		basepath: '/custom-basepath'
 	});
 
-	describe('export', () => {
+	testExport({});
+
+	testExport({ basepath: '/custom-basepath' });
+});
+
+function testExport({ basepath = '' }) {
+	describe(basepath ? `export --basepath ${basepath}` : 'export', () => {
 		before(() => {
-			return exec(`node ${cli} export`);
+			if (basepath) {
+				process.env.BASEPATH = basepath;
+			}
+
+			return exec(`node ${cli} export ${basepath ? `--basepath ${basepath}` : ''}`);
 		});
 
 		it('export all pages', () => {
@@ -96,7 +106,10 @@ describe('sapper', function() {
 				'service-worker.js',
 				'svelte-logo-192.png',
 				'svelte-logo-512.png',
-			];
+			].map(file => {
+				return basepath ? `${basepath.replace(/^[\/\\]/, '')}/${file}` : file;
+			});
+
 			// Client scripts that should show up in the extraction directory.
 			const expectedClientRegexes = [
 				/client\/[^/]+\/main(\.\d+)?\.js/,
@@ -126,7 +139,7 @@ describe('sapper', function() {
 			});
 		});
 	});
-});
+}
 
 function run({ mode, basepath = '' }) {
 	describe(`mode=${mode}`, function () {
@@ -423,6 +436,33 @@ function run({ mode, basepath = '' }) {
 					});
 			});
 
+			it('redirects on server (root)', () => {
+				return nightmare.goto(`${base}/redirect-root`)
+					.path()
+					.then(path => {
+						assert.equal(path, `${basepath}/`);
+					})
+					.then(() => nightmare.page.title())
+					.then(title => {
+						assert.equal(title, 'Great success!');
+					});
+			});
+
+			it('redirects in client (root)', () => {
+				return nightmare.goto(base)
+					.wait('[href="redirect-root"]')
+					.click('[href="redirect-root"]')
+					.wait(200)
+					.path()
+					.then(path => {
+						assert.equal(path, `${basepath}/`);
+					})
+					.then(() => nightmare.page.title())
+					.then(title => {
+						assert.equal(title, 'Great success!');
+					});
+			});
+
 			it('handles 4xx error on server', () => {
 				return nightmare.goto(`${base}/blog/nope`)
 					.path()
@@ -568,11 +608,11 @@ function run({ mode, basepath = '' }) {
 				return nightmare.goto(`${base}/store`)
 					.page.title()
 					.then(title => {
-						assert.equal(title, 'Stored title');
+						assert.equal(title, 'hello world');
 						return nightmare.init().page.title();
 					})
 					.then(title => {
-						assert.equal(title, 'Stored title');
+						assert.equal(title, 'hello world');
 					});
 			});