Compare commits

..

18 Commits

Author SHA1 Message Date
Rich Harris
d01a407137 -> v0.14.1 2018-07-02 10:24:54 -04:00
Rich Harris
c0c717d9ec Merge pull request #283 from elcobvg/feature/route-regexp
Feature: use regexp in routes
2018-07-02 10:23:30 -04:00
Elco Brouwer von Gonzenbach
4f011bfc37 Convert whitespace to tabs. Add some unit tests for create routes 2018-07-02 11:52:17 +07:00
Elco Brouwer von Gonzenbach
6c4ab32cf0 Sync update to sapper 0.14.0 2018-06-29 06:57:01 +07:00
Rich Harris
09b4dc1b9a -> v0.14.0 2018-06-28 13:35:21 -04:00
Rich Harris
bdd5a54527 Merge pull request #301 from sveltejs/gh-297
treat foo/index.json.js as foo.json.js
2018-06-28 13:27:57 -04:00
Rich Harris
b7bb4db8c1 treat foo/index.json.js as foo.json.js - fixes #297 2018-06-28 13:20:41 -04:00
Rich Harris
5b5f33d3cf error on 4xx.html and 5xx.html 2018-06-28 12:57:59 -04:00
Rich Harris
9611656b76 Merge pull request #300 from sveltejs/gh-293
[WIP] simplify rendering of error pages
2018-06-28 12:52:41 -04:00
Rich Harris
e9a71774d5 Merge pull request #299 from sveltejs/gh-270
return a Promise from goto
2018-06-28 12:18:32 -04:00
Rich Harris
2205b8aec5 oops 2018-06-28 12:03:27 -04:00
Rich Harris
5c4e4d5d36 only navigate if route is found - fixes #279 2018-06-28 11:45:38 -04:00
Rich Harris
e87247493f replace 4xx.html and 5xx.html with _error.html 2018-06-28 11:38:21 -04:00
Rich Harris
0aeb63a05b simplify rendering of error pages 2018-06-27 18:35:41 -04:00
Rich Harris
57eeb5659a return a Promise from goto - fixes #270 2018-06-27 17:32:20 -04:00
Elco Brouwer von Gonzenbach
0e2c2ca101 Correct errors in param pattern and matching patterns 2018-06-13 10:00:39 +07:00
Elco Brouwer von Gonzenbach
8015be8069 Correct spacing 2018-06-12 09:15:54 +07:00
Elco Brouwer von Gonzenbach
e39ad59589 Add regexp option to routes 2018-06-12 09:11:54 +07:00
13 changed files with 219 additions and 131 deletions

View File

@@ -1,5 +1,17 @@
# sapper changelog
## 0.14.1
* Route parameters can be qualified with regex characters ([#283](https://github.com/sveltejs/sapper/pull/283))
## 0.14.0
* `4xx.html` and `5xx.html` are replaced with `_error.html` ([#209](https://github.com/sveltejs/sapper/issues/209))
* Treat `foo/index.json.js` and `foo.json.js` as equivalents ([#297](https://github.com/sveltejs/sapper/issues/297))
* Return a promise from `goto` ([#270](https://github.com/sveltejs/sapper/issues/270))
* Use store when rendering error pages ([#293](https://github.com/sveltejs/sapper/issues/293))
* Prevent console errors when visiting an error page ([#279](https://github.com/sveltejs/sapper/issues/279))
## 0.13.6
* Fix `baseUrl` synthesis ([#296](https://github.com/sveltejs/sapper/issues/296))

View File

@@ -1,6 +1,6 @@
{
"name": "sapper",
"version": "0.13.6",
"version": "0.14.1",
"description": "Military-grade apps, engineered by Svelte",
"main": "dist/middleware.ts.js",
"bin": {

View File

@@ -52,8 +52,8 @@ function generate_client(routes: Route[], path_to_routes: string, dev_port?: num
const file = posixify(`${path_to_routes}/${page.file}`);
if (route.id === '_4xx' || route.id === '_5xx') {
return `{ error: '${route.id.slice(1)}', load: () => import(/* webpackChunkName: "${route.id}" */ '${file}') }`;
if (route.id === '_error') {
return `{ error: true, load: () => import(/* webpackChunkName: "${route.id}" */ '${file}') }`;
}
const params = route.params.length === 0
@@ -107,8 +107,8 @@ function generate_server(routes: Route[], path_to_routes: string) {
`{ type: '${type}', module: ${route.id}${index} }`)
.join(', ');
if (route.id === '_4xx' || route.id === '_5xx') {
return `{ error: '${route.id.slice(1)}', handlers: [${handlers}] }`;
if (route.id === '_error') {
return `{ error: true, handlers: [${handlers}] }`;
}
const params = route.params.length === 0

View File

@@ -5,17 +5,22 @@ import { Route } from '../interfaces';
export default function create_routes({ files } = { files: glob.sync('**/*.*', { cwd: locations.routes(), dot: true, nodir: true }) }) {
const routes: Route[] = files
.filter((file: string) => !/(^|\/|\\)_/.test(file))
.filter((file: string) => !/(^|\/|\\)(_(?!error\.html)|\.(?!well-known))/.test(file))
.map((file: string) => {
if (/(^|\/|\\)(_|\.(?!well-known))/.test(file)) return;
if (/]\[/.test(file)) {
throw new Error(`Invalid route ${file} — parameters must be separated`);
}
if (file === '4xx.html' || file === '5xx.html') {
throw new Error('As of Sapper 0.14, 4xx.html and 5xx.html should be replaced with _error.html');
}
const base = file.replace(/\.[^/.]+$/, '');
const parts = base.split('/'); // glob output is always posix-style
if (parts[parts.length - 1] === 'index') parts.pop();
if (/^index(\..+)?/.test(parts[parts.length - 1])) {
const part = parts.pop();
if (parts.length > 0) parts[parts.length - 1] += part.slice(5);
}
return {
files: [file],
@@ -30,8 +35,8 @@ export default function create_routes({ files } = { files: glob.sync('**/*.*', {
return !found;
})
.sort((a, b) => {
if (a.parts[0] === '4xx' || a.parts[0] === '5xx') return -1;
if (b.parts[0] === '4xx' || b.parts[0] === '5xx') return 1;
if (a.parts[0] === '_error') return -1;
if (b.parts[0] === '_error') return 1;
const max = Math.max(a.parts.length, b.parts.length);
@@ -63,6 +68,23 @@ export default function create_routes({ files } = { files: glob.sync('**/*.*', {
(a_sub_part.content < b_sub_part.content ? -1 : 1)
);
}
// If both parts dynamic, check for regexp patterns
if (a_sub_part.dynamic && b_sub_part.dynamic) {
const regexp_pattern = /\((.*?)\)/;
const a_match = regexp_pattern.exec(a_sub_part.content);
const b_match = regexp_pattern.exec(b_sub_part.content);
if (!a_match && b_match) {
return 1; // No regexp, so less specific than b
}
if (!b_match && a_match) {
return -1;
}
if (a_match && b_match && a_match[1] !== b_match[1]) {
return b_match[1].length - a_match[1].length;
}
}
}
}
@@ -74,10 +96,18 @@ export default function create_routes({ files } = { files: glob.sync('**/*.*', {
) || '_';
const params: string[] = [];
const param_pattern = /\[([^\]]+)\]/g;
const match_patterns: object = {};
const param_pattern = /\[([^\(\]]+)(?:\((.+?)\))?\]/g;
let match;
while (match = param_pattern.exec(base)) {
params.push(match[1]);
if (typeof match[2] !== 'undefined') {
if (/[\(\)\?\:]/.exec(match[2])) {
throw new Error('Sapper does not allow (, ), ? or : in RegExp routes yet');
}
// Make a map of the regexp patterns
match_patterns[match[1]] = `(${match[2]}?)`;
}
}
// TODO can we do all this with sub-parts? or does
@@ -90,7 +120,13 @@ export default function create_routes({ files } = { files: glob.sync('**/*.*', {
const dynamic = ~part.indexOf('[');
if (dynamic) {
const matcher = part.replace(param_pattern, `([^\/]+?)`);
// Get keys from part and replace with stored match patterns
const keys = part.replace(/\(.*?\)/, '').split(/[\[\]]/).filter((x, i) => { if (i % 2) return x });
let matcher = part;
keys.forEach(k => {
const key_pattern = new RegExp('\\[' + k + '(?:\\((.+?)\\))?\\]');
matcher = matcher.replace(key_pattern, match_patterns[k] || `([^/]+?)`);
})
pattern_string = nested ? `(?:\\/${matcher}${pattern_string})?` : `\\/${matcher}${pattern_string}`;
} else {
nested = false;
@@ -142,7 +178,7 @@ export default function create_routes({ files } = { files: glob.sync('**/*.*', {
}
function get_sub_parts(part: string) {
return part.split(/[\[\]]/)
return part.split(/\[(.+)\]/)
.map((content, i) => {
if (!content) return null;
return {

View File

@@ -162,8 +162,12 @@ function get_route_handler(App: Component, routes: RouteObject[], store_getter:
? () => fs.readFileSync(`${locations.app()}/template.html`, 'utf-8')
: (str => () => str)(fs.readFileSync(`${locations.dest()}/template.html`, 'utf-8'));
function handle_route(route: RouteObject, req: Req, res: ServerResponse) {
req.params = route.params(route.pattern.exec(req.path));
const error_route = routes.find((route: RouteObject) => route.error);
function handle_route(route: RouteObject, req: Req, res: ServerResponse, status = 200, error: Error | string = null) {
req.params = error
? {}
: route.params(route.pattern.exec(req.path));
const handlers = route.handlers[Symbol.iterator]();
@@ -174,7 +178,14 @@ function get_route_handler(App: Component, routes: RouteObject[], store_getter:
const { value: handler, done } = handlers.next();
if (done) {
handle_error(req, res, 404, 'Not found');
if (route.error) {
// there was an error rendering the error page!
res.statusCode = status;
res.end(error instanceof Error ? error.message : error);
} else {
handle_route(error_route, req, res, 404, 'Not found');
}
return;
}
@@ -186,7 +197,7 @@ function get_route_handler(App: Component, routes: RouteObject[], store_getter:
// preload main.js and current route
// TODO detect other stuff we can preload? images, CSS, fonts?
const link = []
.concat(chunks.main, chunks[route.id])
.concat(chunks.main, chunks[route.id] || chunks._error) // TODO this is gross
.filter(file => !file.match(/\.map$/))
.map(file => `<${req.baseUrl}/client/${file}>;rel="preload";as="script"`)
.join(', ');
@@ -196,8 +207,13 @@ function get_route_handler(App: Component, routes: RouteObject[], store_getter:
const store = store_getter ? store_getter(req) : null;
const props = { params: req.params, query: req.query, path: req.path };
if (route.error) {
props.error = error instanceof Error ? error : { message: error };
props.status = status;
}
let redirect: { statusCode: number, location: string };
let error: { statusCode: number, message: Error | string };
let preload_error: { statusCode: number, message: Error | string };
Promise.resolve(
mod.preload ? mod.preload.call({
@@ -205,7 +221,7 @@ function get_route_handler(App: Component, routes: RouteObject[], store_getter:
redirect = { statusCode, location };
},
error: (statusCode: number, message: Error | string) => {
error = { statusCode, message };
preload_error = { statusCode, message };
},
fetch: (url: string, opts?: any) => {
const parsed = new URL(url, `http://127.0.0.1:${process.env.PORT}${req.baseUrl ? req.baseUrl + '/' :''}`);
@@ -245,7 +261,7 @@ function get_route_handler(App: Component, routes: RouteObject[], store_getter:
store
}, req) : {}
).catch(err => {
error = { statusCode: 500, message: err };
preload_error = { statusCode: 500, message: err };
}).then(preloaded => {
if (redirect) {
res.statusCode = redirect.statusCode;
@@ -255,8 +271,8 @@ function get_route_handler(App: Component, routes: RouteObject[], store_getter:
return;
}
if (error) {
handle_error(req, res, error.statusCode, error.message);
if (preload_error) {
handle_route(error_route, req, res, preload_error.statusCode, preload_error.message);
return;
}
@@ -294,6 +310,7 @@ function get_route_handler(App: Component, routes: RouteObject[], store_getter:
.replace('%sapper.head%', `<noscript id='sapper-head-start'></noscript>${head}<noscript id='sapper-head-end'></noscript>`)
.replace('%sapper.styles%', (css && css.code ? `<style>${css.code}</style>` : ''));
res.statusCode = status;
res.end(page);
if (process.send) {
@@ -370,84 +387,25 @@ function get_route_handler(App: Component, routes: RouteObject[], store_getter:
}
}
} catch (error) {
handle_error(req, res, 500, error);
if (route.error) {
// there was an error rendering the error page!
res.statusCode = status;
res.end(error instanceof Error ? error.message : error);
} else {
handle_route(error_route, req, res, 500, error || 'Internal server error');
}
}
}
next();
}
const not_found_route = routes.find((route: RouteObject) => route.error === '4xx');
const error_route = routes.find((route: RouteObject) => route.error === '5xx');
function handle_error(req: Req, res: ServerResponse, statusCode: number, message: Error | string) {
res.statusCode = statusCode;
res.setHeader('Content-Type', 'text/html');
const error = message instanceof Error ? message : new Error(message);
const not_found = statusCode >= 400 && statusCode < 500;
const route = not_found
? not_found_route
: error_route;
function render_page({ head, css, html }) {
const page = template()
.replace('%sapper.base%', `<base href="${req.baseUrl}/">`)
.replace('%sapper.scripts%', `<script>__SAPPER__={baseUrl: "${req.baseUrl}"}</script><script src='${req.baseUrl}/client/${get_chunks().main}'></script>`)
.replace('%sapper.html%', html)
.replace('%sapper.head%', `<noscript id='sapper-head-start'></noscript>${head}<noscript id='sapper-head-end'></noscript>`)
.replace('%sapper.styles%', (css && css.code ? `<style>${css.code}</style>` : ''));
res.end(page);
}
function handle_notfound() {
const title: string = not_found
? 'Not found'
: `Internal server error: ${error.message}`;
render_page({ head: '', css: null, html: title });
}
if (route) {
const handlers = route.handlers[Symbol.iterator]();
function next() {
const { value: handler, done } = handlers.next();
if (done) {
handle_notfound();
} else if (handler.type === 'page') {
render_page(handler.module.render({
status: statusCode,
error
}, {
store: store_getter && store_getter(req)
}));
} else {
const handle_method = mod[method_export];
if (handle_method) {
handle_method(req, res, next);
} else {
next();
}
}
}
next();
} else {
handle_notfound();
}
}
return function find_route(req: Req, res: ServerResponse) {
for (const route of routes) {
if (!route.error && route.pattern.test(req.path)) return handle_route(route, req, res);
}
handle_error(req, res, 404, 'Not found');
handle_route(error_route, req, res, 404, 'Not found');
};
}

View File

@@ -8,7 +8,7 @@ export let component: Component;
let target: Node;
let store: Store;
let routes: Route[];
let errors: { '4xx': Route, '5xx': Route };
let error_route: Route;
const history = typeof window !== 'undefined' ? window.history : {
pushState: (state: any, title: string, href: string) => {},
@@ -117,11 +117,7 @@ function prepare_route(Page: ComponentConstructor, props: RouteData) {
error = { statusCode: 500, message: err };
}).then(preloaded => {
if (error) {
const route = error.statusCode >= 400 && error.statusCode < 500
? errors['4xx']
: errors['5xx'];
return route.load().then(({ default: Page }: { default: ComponentConstructor }) => {
return error_route.load().then(({ default: Page }: { default: ComponentConstructor }) => {
const err = error.message instanceof Error ? error.message : new Error(error.message);
Object.assign(props, { status: error.statusCode, error: err });
return { Page, props, redirect: null };
@@ -133,7 +129,7 @@ function prepare_route(Page: ComponentConstructor, props: RouteData) {
});
}
function navigate(target: Target, id: number) {
function navigate(target: Target, id: number): Promise<any> {
if (id) {
// popstate or initial navigation
cid = id;
@@ -212,7 +208,11 @@ function handle_popstate(event: PopStateEvent) {
if (event.state) {
const url = new URL(window.location.href);
const target = select_route(url);
navigate(target, event.state.id);
if (target) {
navigate(target, event.state.id);
} else {
window.location.href = window.location.href;
}
} else {
// hashchange
cid = ++uid;
@@ -262,10 +262,7 @@ export function init(opts: { App: ComponentConstructor, target: Node, routes: Ro
App = opts.App;
target = opts.target;
routes = opts.routes.filter(r => !r.error);
errors = {
'4xx': opts.routes.find(r => r.error === '4xx'),
'5xx': opts.routes.find(r => r.error === '5xx')
};
error_route = opts.routes.find(r => r.error);
if (opts && opts.store) {
store = opts.store(manifest.store);
@@ -293,19 +290,23 @@ export function init(opts: { App: ComponentConstructor, target: Node, routes: Ro
history.replaceState({ id: uid }, '', href);
const target = select_route(new URL(window.location.href));
return navigate(target, uid);
if (target) return navigate(target, uid);
});
}
export function goto(href: string, opts = { replaceState: false }) {
const target = select_route(new URL(href, document.baseURI));
let promise;
if (target) {
navigate(target, null);
promise = navigate(target, null);
if (history) history[opts.replaceState ? 'replaceState' : 'pushState']({ id: cid }, '', href);
} else {
window.location.href = href;
promise = new Promise(f => {}); // never resolves
}
return promise;
}
export function prefetchRoutes(pathnames: string[]) {

View File

@@ -17,7 +17,7 @@ export interface Component {
export type Route = {
pattern: RegExp;
load: () => Promise<{ default: ComponentConstructor }>;
error?: string;
error?: boolean;
params?: (match: RegExpExecArray) => Record<string, string>;
ignore?: boolean;
};

View File

@@ -1,6 +0,0 @@
<svelte:head>
<title>Internal server error</title>
</svelte:head>
<h1>Internal server error</h1>
<p>{error.message}</p>

View File

@@ -2,5 +2,5 @@
<title>{status}</title>
</svelte:head>
<h1>Not found</h1>
<h1>{status}</h1>
<p>{error.message}</p>

View File

@@ -6,15 +6,21 @@
<p>This is the 'about' page. There's not much here.</p>
<button class='goto' on:click='goto("blog/what-is-sapper")'>What is Sapper?</button>
<button class='prefetch' on:click='prefetch("blog/why-the-name")'>Why the name?</button>
<script>
import { goto, prefetch } from '../../../runtime.js';
export default {
oncreate() {
window.goto = goto;
},
ondestroy() {
window.goto = null;
},
methods: {
goto,
prefetch
}
};

View File

@@ -1,4 +1,4 @@
import posts from './blog/_posts.js';
import posts from './_posts.js';
const contents = JSON.stringify(posts.map(post => {
return {

View File

@@ -281,9 +281,7 @@ function run({ mode, basepath = '' }) {
return nightmare
.goto(`${base}/about`)
.init()
.click('.goto')
.wait(url => window.location.pathname === url, `${basepath}/blog/what-is-sapper`)
.wait(100)
.evaluate(() => window.goto('blog/what-is-sapper'))
.title()
.then(title => {
assert.equal(title, 'What is Sapper?');
@@ -441,7 +439,7 @@ function run({ mode, basepath = '' }) {
})
.then(() => nightmare.page.title())
.then(title => {
assert.equal(title, 'Not found')
assert.equal(title, '404')
});
});
@@ -456,7 +454,7 @@ function run({ mode, basepath = '' }) {
})
.then(() => nightmare.page.title())
.then(title => {
assert.equal(title, 'Not found');
assert.equal(title, '404');
});
});
@@ -468,7 +466,7 @@ function run({ mode, basepath = '' }) {
})
.then(() => nightmare.page.title())
.then(title => {
assert.equal(title, 'Internal server error')
assert.equal(title, '500')
});
});
@@ -483,7 +481,7 @@ function run({ mode, basepath = '' }) {
})
.then(() => nightmare.page.title())
.then(title => {
assert.equal(title, 'Internal server error');
assert.equal(title, '500');
});
});

View File

@@ -45,7 +45,17 @@ describe('create_routes', () => {
it('sorts routes correctly', () => {
const routes = create_routes({
files: ['index.html', 'about.html', 'post/f[xx].html', '[wildcard].html', 'post/foo.html', 'post/[id].html', 'post/bar.html', 'post/[id].json.js']
files: [
'index.html',
'about.html',
'post/f[xx].html',
'[wildcard].html',
'post/foo.html',
'post/[id].html',
'post/bar.html',
'post/[id].json.js',
'post/[id([0-9-a-z]{3,})].html',
]
});
assert.deepEqual(
@@ -56,6 +66,7 @@ describe('create_routes', () => {
'post/bar.html',
'post/foo.html',
'post/f[xx].html',
'post/[id([0-9-a-z]{3,})].html', // RegExp is more specific
'post/[id].json.js',
'post/[id].html',
'[wildcard].html'
@@ -63,6 +74,25 @@ describe('create_routes', () => {
);
});
it('distinguishes and sorts regexp routes correctly', () => {
const routes = create_routes({
files: [
'[slug].html',
'[slug([a-z]{2})].html',
'[slug([0-9-a-z]{3,})].html',
]
});
assert.deepEqual(
routes.map(r => r.handlers[0].file),
[
'[slug([0-9-a-z]{3,})].html',
'[slug([a-z]{2})].html',
'[slug].html',
]
);
});
it('prefers index page to nested route', () => {
let routes = create_routes({
files: [
@@ -71,8 +101,7 @@ describe('create_routes', () => {
'blog/[slug].html',
'api/gists/[id].js',
'api/gists/index.js',
'4xx.html',
'5xx.html',
'_error.html',
'blog/index.html',
'blog/rss.xml.js',
'guide/index.html',
@@ -83,8 +112,7 @@ describe('create_routes', () => {
assert.deepEqual(
routes.map(r => r.handlers[0].file),
[
'4xx.html',
'5xx.html',
'_error.html',
'index.html',
'guide/index.html',
'blog/index.html',
@@ -99,8 +127,7 @@ describe('create_routes', () => {
routes = create_routes({
files: [
'4xx.html',
'5xx.html',
'_error.html',
'api/blog/[slug].js',
'api/blog/index.js',
'api/guide/contents.js',
@@ -119,8 +146,7 @@ describe('create_routes', () => {
assert.deepEqual(
routes.map(r => r.handlers[0].file),
[
'4xx.html',
'5xx.html',
'_error.html',
'index.html',
'guide/index.html',
'blog/index.html',
@@ -135,6 +161,24 @@ describe('create_routes', () => {
'api/blog/[slug].js',
]
);
// RegExp routes
routes = create_routes({
files: [
'blog/[slug].html',
'blog/index.html',
'blog/[slug([^0-9]+)].html',
]
});
assert.deepEqual(
routes.map(r => r.handlers[0].file),
[
'blog/index.html',
'blog/[slug([^0-9]+)].html',
'blog/[slug].html',
]
);
});
it('generates params', () => {
@@ -208,8 +252,15 @@ describe('create_routes', () => {
files: ['[foo].html', '[bar]/index.html']
});
}, /The \[foo\] and \[bar\]\/index routes clash/);
assert.throws(() => {
create_routes({
files: ['[foo([0-9-a-z]+)].html', '[bar([0-9-a-z]+)]/index.html']
});
}, /The \[foo\(\[0-9-a-z\]\+\)\] and \[bar\(\[0-9-a-z\]\+\)\]\/index routes clash/);
});
it('matches nested routes', () => {
const route = create_routes({
files: ['settings/[submenu].html']
@@ -284,4 +335,36 @@ describe('create_routes', () => {
});
}, /Invalid route \[foo\]\[bar\]\.js — parameters must be separated/);
});
it('errors when trying to use reserved characters in route regexp', () => {
assert.throws(() => {
create_routes({
files: ['[lang([a-z]{2}(?:-[a-z]{2,4})?)]']
});
}, /Sapper does not allow \(, \), \? or \: in RegExp routes yet/);
});
it('errors on 4xx.html', () => {
assert.throws(() => {
create_routes({
files: ['4xx.html']
});
}, /As of Sapper 0.14, 4xx.html and 5xx.html should be replaced with _error.html/);
});
it('errors on 5xx.html', () => {
assert.throws(() => {
create_routes({
files: ['5xx.html']
});
}, /As of Sapper 0.14, 4xx.html and 5xx.html should be replaced with _error.html/);
});
it('treats foo/index.json.js the same as foo.json.js', () => {
const route = create_routes({
files: ['foo/index.json.js']
})[0];
assert.ok(route.test('/foo.json'));
});
});