totole/sapper
1
0
Fork 0
mirror of https://github.com/kevin-DL/sapper.git synced 2026-01-20 14:25:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

generate pages and server routes separately

Browse Source
This commit is contained in:
Rich Harris
2018-07-04 10:53:41 -04:00
parent d01a407137
commit 008b607c01
2 changed files with 152 additions and 162 deletions
Download Patch File Download Diff File Expand all files Collapse all files

170
src/core/create_routes.ts
View File

@@ -3,8 +3,16 @@ import glob from 'glob';
import { locations } from '../config'; import { locations } from '../config';
import { Route } from '../interfaces'; import { Route } from '../interfaces';
export default function create_routes({ files } = { files: glob.sync('**/*.*', { cwd: locations.routes(), dot: true, nodir: true }) }) { export default function create_routes({
const routes: Route[] = files files
} = {
files: glob.sync('**/*.*', {
cwd: locations.routes(),
dot: true,
nodir: true
})
}) {
const all_routes = files
.filter((file: string) => !/(^|\/|\\)(_(?!error\.html)|\.(?!well-known))/.test(file)) .filter((file: string) => !/(^|\/|\\)(_(?!error\.html)|\.(?!well-known))/.test(file))
.map((file: string) => { .map((file: string) => {
if (/]\[/.test(file)) { if (/]\[/.test(file)) {
@@ -22,82 +30,14 @@ export default function create_routes({ files } = { files: glob.sync('**/*.*', {
if (parts.length > 0) parts[parts.length - 1] += part.slice(5); if (parts.length > 0) parts[parts.length - 1] += part.slice(5);
} }
return {
files: [file],
base,
parts
};
})
.filter(Boolean)
.filter((a, index, array) => {
const found = array.slice(index + 1).find(b => a.base === b.base);
if (found) found.files.push(...a.files);
return !found;
})
.sort((a, b) => {
if (a.parts[0] === '_error') return -1;
if (b.parts[0] === '_error') return 1;
const max = Math.max(a.parts.length, b.parts.length);
for (let i = 0; i < max; i += 1) {
const a_part = a.parts[i];
const b_part = b.parts[i];
if (!a_part) return -1;
if (!b_part) return 1;
const a_sub_parts = get_sub_parts(a_part);
const b_sub_parts = get_sub_parts(b_part);
const max = Math.max(a_sub_parts.length, b_sub_parts.length);
for (let i = 0; i < max; i += 1) {
const a_sub_part = a_sub_parts[i];
const b_sub_part = b_sub_parts[i];
if (!a_sub_part) return 1; // b is more specific, so goes first
if (!b_sub_part) return -1;
if (a_sub_part.dynamic !== b_sub_part.dynamic) {
return a_sub_part.dynamic ? 1 : -1;
}
if (!a_sub_part.dynamic && a_sub_part.content !== b_sub_part.content) {
return (
(b_sub_part.content.length - a_sub_part.content.length) ||
(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;
}
}
}
}
throw new Error(`The ${a.base} and ${b.base} routes clash`);
})
.map(({ files, base, parts }) => {
const id = ( const id = (
parts.join('_').replace(/[[\]]/g, '$').replace(/^\d/, '_$&').replace(/[^a-zA-Z0-9_$]/g, '_') parts.join('_').replace(/[[\]]/g, '$').replace(/^\d/, '_$&').replace(/[^a-zA-Z0-9_$]/g, '_')
) || '_'; ) || '_';
const params: string[] = []; const params: string[] = [];
const match_patterns: object = {}; const match_patterns: Record<string, string> = {};
const param_pattern = /\[([^\(\]]+)(?:\((.+?)\))?\]/g; const param_pattern = /\[([^\(\]]+)(?:\((.+?)\))?\]/g;
let match; let match;
while (match = param_pattern.exec(base)) { while (match = param_pattern.exec(base)) {
params.push(match[1]); params.push(match[1]);
@@ -152,20 +92,9 @@ export default function create_routes({ files } = { files: glob.sync('**/*.*', {
return { return {
id, id,
handlers: files.map(file => ({ base,
type: path.extname(file) === '.html' ? 'page' : 'route', type: file.endsWith('.html') ? 'page' : 'route',
file file,
})).sort((a, b) => {
if (a.type === 'page' && b.type === 'route') {
return 1;
}
if (a.type === 'route' && b.type === 'page') {
return -1;
}
return 0;
}),
pattern, pattern,
test, test,
exec, exec,
@@ -174,7 +103,72 @@ export default function create_routes({ files } = { files: glob.sync('**/*.*', {
}; };
}); });
return routes; const pages = all_routes
.filter(r => r.type === 'page')
.sort(comparator);
const server_routes = all_routes
.filter(r => r.type === 'route')
.sort(comparator);
return { pages, server_routes };
}
function comparator(a, b) {
if (a.parts[0] === '_error') return -1;
if (b.parts[0] === '_error') return 1;
const max = Math.max(a.parts.length, b.parts.length);
for (let i = 0; i < max; i += 1) {
const a_part = a.parts[i];
const b_part = b.parts[i];
if (!a_part) return -1;
if (!b_part) return 1;
const a_sub_parts = get_sub_parts(a_part);
const b_sub_parts = get_sub_parts(b_part);
const max = Math.max(a_sub_parts.length, b_sub_parts.length);
for (let i = 0; i < max; i += 1) {
const a_sub_part = a_sub_parts[i];
const b_sub_part = b_sub_parts[i];
if (!a_sub_part) return 1; // b is more specific, so goes first
if (!b_sub_part) return -1;
if (a_sub_part.dynamic !== b_sub_part.dynamic) {
return a_sub_part.dynamic ? 1 : -1;
}
if (!a_sub_part.dynamic && a_sub_part.content !== b_sub_part.content) {
return (
(b_sub_part.content.length - a_sub_part.content.length) ||
(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;
}
}
}
}
throw new Error(`The ${a.base} and ${b.base} routes clash`);
} }
function get_sub_parts(part: string) { function get_sub_parts(part: string) {

144
test/unit/create_routes.test.js
View File

@@ -1,31 +1,9 @@
const assert = require('assert'); const assert = require('assert');
const { create_routes } = require('../../dist/core.ts.js'); const { create_routes } = require('../../dist/core.ts.js');
describe('create_routes', () => { describe.only('create_routes', () => {
it('sorts handlers correctly', () => {
const routes = create_routes({
files: ['foo.html', 'foo.js']
});
assert.deepEqual(
routes.map(r => r.handlers),
[
[
{
type: 'route',
file: 'foo.js'
},
{
type: 'page',
file: 'foo.html'
}
]
]
)
});
it('encodes characters not allowed in path', () => { it('encodes characters not allowed in path', () => {
const routes = create_routes({ const { server_routes } = create_routes({
files: [ files: [
'"', '"',
'#', '#',
@@ -34,7 +12,7 @@ describe('create_routes', () => {
}); });
assert.deepEqual( assert.deepEqual(
routes.map(r => r.pattern), server_routes.map(r => r.pattern),
[ [
/^\/%22\/?$/, /^\/%22\/?$/,
/^\/%23\/?$/, /^\/%23\/?$/,
@@ -44,22 +22,22 @@ describe('create_routes', () => {
}); });
it('sorts routes correctly', () => { it('sorts routes correctly', () => {
const routes = create_routes({ const { pages, server_routes } = create_routes({
files: [ files: [
'index.html', 'index.html',
'about.html', 'about.html',
'post/f[xx].html', 'post/f[xx].html',
'[wildcard].html', '[wildcard].html',
'post/foo.html', 'post/foo.html',
'post/[id].html', 'post/[id].html',
'post/bar.html', 'post/bar.html',
'post/[id].json.js', 'post/[id].json.js',
'post/[id([0-9-a-z]{3,})].html', 'post/[id([0-9-a-z]{3,})].html',
] ]
}); });
assert.deepEqual( assert.deepEqual(
routes.map(r => r.handlers[0].file), pages.map(r => r.file),
[ [
'index.html', 'index.html',
'about.html', 'about.html',
@@ -67,15 +45,21 @@ describe('create_routes', () => {
'post/foo.html', 'post/foo.html',
'post/f[xx].html', 'post/f[xx].html',
'post/[id([0-9-a-z]{3,})].html', // RegExp is more specific 'post/[id([0-9-a-z]{3,})].html', // RegExp is more specific
'post/[id].json.js',
'post/[id].html', 'post/[id].html',
'[wildcard].html' '[wildcard].html'
] ]
); );
assert.deepEqual(
server_routes.map(r => r.file),
[
'post/[id].json.js'
]
);
}); });
it('distinguishes and sorts regexp routes correctly', () => { it('distinguishes and sorts regexp routes correctly', () => {
const routes = create_routes({ const { pages } = create_routes({
files: [ files: [
'[slug].html', '[slug].html',
'[slug([a-z]{2})].html', '[slug([a-z]{2})].html',
@@ -84,7 +68,7 @@ describe('create_routes', () => {
}); });
assert.deepEqual( assert.deepEqual(
routes.map(r => r.handlers[0].file), pages.map(r => r.file),
[ [
'[slug([0-9-a-z]{3,})].html', '[slug([0-9-a-z]{3,})].html',
'[slug([a-z]{2})].html', '[slug([a-z]{2})].html',
@@ -94,7 +78,7 @@ describe('create_routes', () => {
}); });
it('prefers index page to nested route', () => { it('prefers index page to nested route', () => {
let routes = create_routes({ let { pages, server_routes } = create_routes({
files: [ files: [
'api/examples/[slug].js', 'api/examples/[slug].js',
'api/examples/index.js', 'api/examples/index.js',
@@ -110,14 +94,20 @@ describe('create_routes', () => {
}); });
assert.deepEqual( assert.deepEqual(
routes.map(r => r.handlers[0].file), pages.map(r => r.file),
[ [
'_error.html', '_error.html',
'index.html', 'index.html',
'guide/index.html', 'guide/index.html',
'blog/index.html', 'blog/index.html',
'blog/[slug].html'
]
);
assert.deepEqual(
server_routes.map(r => r.file),
[
'blog/rss.xml.js', 'blog/rss.xml.js',
'blog/[slug].html',
'api/examples/index.js', 'api/examples/index.js',
'api/examples/[slug].js', 'api/examples/[slug].js',
'api/gists/index.js', 'api/gists/index.js',
@@ -125,7 +115,7 @@ describe('create_routes', () => {
] ]
); );
routes = create_routes({ ({ pages, server_routes } = create_routes({
files: [ files: [
'_error.html', '_error.html',
'api/blog/[slug].js', 'api/blog/[slug].js',
@@ -141,20 +131,26 @@ describe('create_routes', () => {
'index.html', 'index.html',
'repl/index.html' 'repl/index.html'
] ]
}); }));
assert.deepEqual( assert.deepEqual(
routes.map(r => r.handlers[0].file), pages.map(r => r.file),
[ [
'_error.html', '_error.html',
'index.html', 'index.html',
'guide/index.html', 'guide/index.html',
'blog/index.html', 'blog/index.html',
'blog/rss.xml.js',
'blog/[slug].html', 'blog/[slug].html',
'repl/index.html'
]
);
assert.deepEqual(
server_routes.map(r => r.file),
[
'blog/rss.xml.js',
'gist/create.js', 'gist/create.js',
'gist/[id].js', 'gist/[id].js',
'repl/index.html',
'api/guide/index.js', 'api/guide/index.js',
'api/guide/contents.js', 'api/guide/contents.js',
'api/blog/index.js', 'api/blog/index.js',
@@ -163,16 +159,16 @@ describe('create_routes', () => {
); );
// RegExp routes // RegExp routes
routes = create_routes({ ({ pages } = create_routes({
files: [ files: [
'blog/[slug].html', 'blog/[slug].html',
'blog/index.html', 'blog/index.html',
'blog/[slug([^0-9]+)].html', 'blog/[slug([^0-9]+)].html',
] ]
}); }));
assert.deepEqual( assert.deepEqual(
routes.map(r => r.handlers[0].file), pages.map(r => r.file),
[ [
'blog/index.html', 'blog/index.html',
'blog/[slug([^0-9]+)].html', 'blog/[slug([^0-9]+)].html',
@@ -182,16 +178,16 @@ describe('create_routes', () => {
}); });
it('generates params', () => { it('generates params', () => {
const routes = create_routes({ const { pages } = create_routes({
files: ['index.html', 'about.html', '[wildcard].html', 'post/[id].html'] files: ['index.html', 'about.html', '[wildcard].html', 'post/[id].html']
}); });
let file; let file;
let params; let params;
for (let i = 0; i < routes.length; i += 1) { for (let i = 0; i < pages.length; i += 1) {
const route = routes[i]; const route = pages[i];
if (params = route.exec('/post/123')) { if (params = route.exec('/post/123')) {
file = route.handlers[0].file; file = route.file;
break; break;
} }
} }
@@ -203,12 +199,12 @@ describe('create_routes', () => {
}); });
it('ignores files and directories with leading underscores', () => { it('ignores files and directories with leading underscores', () => {
const routes = create_routes({ const { pages } = create_routes({
files: ['index.html', '_foo.html', 'a/_b/c/d.html', 'e/f/g/h.html', 'i/_j.html'] files: ['index.html', '_foo.html', 'a/_b/c/d.html', 'e/f/g/h.html', 'i/_j.html']
}); });
assert.deepEqual( assert.deepEqual(
routes.map(r => r.handlers[0].file), pages.map(r => r.file),
[ [
'index.html', 'index.html',
'e/f/g/h.html' 'e/f/g/h.html'
@@ -217,13 +213,13 @@ describe('create_routes', () => {
}); });
it('ignores files and directories with leading dots except .well-known', () => { it('ignores files and directories with leading dots except .well-known', () => {
const routes = create_routes({ const { server_routes } = create_routes({
files: ['.well-known', '.unknown'] files: ['.well-known/dnt-policy.txt.js', '.unknown/foo.txt.js']
}); });
assert.deepEqual( assert.deepEqual(
routes.map(r => r.handlers[0].file), server_routes.map(r => r.file),
['.well-known'] ['.well-known/dnt-policy.txt.js']
); );
}); });
@@ -236,12 +232,12 @@ describe('create_routes', () => {
}); });
assert.deepEqual( assert.deepEqual(
a.map(r => r.handlers[0].file), a.pages.map(r => r.file),
['foo/[bar].html', '[baz]/qux.html'] ['foo/[bar].html', '[baz]/qux.html']
); );
assert.deepEqual( assert.deepEqual(
b.map(r => r.handlers[0].file), b.pages.map(r => r.file),
['foo/[bar].html', '[baz]/qux.html'] ['foo/[bar].html', '[baz]/qux.html']
); );
}); });
@@ -262,46 +258,46 @@ describe('create_routes', () => {
it('matches nested routes', () => { it('matches nested routes', () => {
const route = create_routes({ const page = create_routes({
files: ['settings/[submenu].html'] files: ['settings/[submenu].html']
})[0]; }).pages[0];
assert.deepEqual(route.exec('/settings/foo'), { assert.deepEqual(page.exec('/settings/foo'), {
submenu: 'foo' submenu: 'foo'
}); });
assert.deepEqual(route.exec('/settings'), { assert.deepEqual(page.exec('/settings'), {
submenu: null submenu: null
}); });
}); });
it('prefers index routes to nested routes', () => { it('prefers index routes to nested routes', () => {
const routes = create_routes({ const { pages } = create_routes({
files: ['settings/[submenu].html', 'settings.html'] files: ['settings/[submenu].html', 'settings.html']
}); });
assert.deepEqual( assert.deepEqual(
routes.map(r => r.handlers[0].file), pages.map(r => r.file),
['settings.html', 'settings/[submenu].html'] ['settings.html', 'settings/[submenu].html']
); );
}); });
it('matches deeply nested routes', () => { it('matches deeply nested routes', () => {
const route = create_routes({ const page = create_routes({
files: ['settings/[a]/[b]/index.html'] files: ['settings/[a]/[b]/index.html']
})[0]; }).pages[0];
assert.deepEqual(route.exec('/settings/foo/bar'), { assert.deepEqual(page.exec('/settings/foo/bar'), {
a: 'foo', a: 'foo',
b: 'bar' b: 'bar'
}); });
assert.deepEqual(route.exec('/settings/foo'), { assert.deepEqual(page.exec('/settings/foo'), {
a: 'foo', a: 'foo',
b: null b: null
}); });
assert.deepEqual(route.exec('/settings'), { assert.deepEqual(page.exec('/settings'), {
a: null, a: null,
b: null b: null
}); });
@@ -310,7 +306,7 @@ describe('create_routes', () => {
it('matches a dynamic part within a part', () => { it('matches a dynamic part within a part', () => {
const route = create_routes({ const route = create_routes({
files: ['things/[slug].json.js'] files: ['things/[slug].json.js']
})[0]; }).server_routes[0];
assert.deepEqual(route.exec('/things/foo.json'), { assert.deepEqual(route.exec('/things/foo.json'), {
slug: 'foo' slug: 'foo'
@@ -320,7 +316,7 @@ describe('create_routes', () => {
it('matches multiple dynamic parts within a part', () => { it('matches multiple dynamic parts within a part', () => {
const route = create_routes({ const route = create_routes({
files: ['things/[id]_[slug].json.js'] files: ['things/[id]_[slug].json.js']
})[0]; }).server_routes[0];
assert.deepEqual(route.exec('/things/someid_someslug.json'), { assert.deepEqual(route.exec('/things/someid_someslug.json'), {
id: 'someid', id: 'someid',
@@ -363,7 +359,7 @@ describe('create_routes', () => {
it('treats foo/index.json.js the same as foo.json.js', () => { it('treats foo/index.json.js the same as foo.json.js', () => {
const route = create_routes({ const route = create_routes({
files: ['foo/index.json.js'] files: ['foo/index.json.js']
})[0]; }).server_routes[0];
assert.ok(route.test('/foo.json')); assert.ok(route.test('/foo.json'));
}); });