Improve internal API

This commit is contained in:
Rich Harris
2018-10-08 19:21:15 -04:00
committed by GitHub
parent 5e59855a15
commit 52f40f9e63
46 changed files with 696 additions and 1091 deletions

View File

@@ -1,4 +1,3 @@
import * as path from 'path';
import * as assert from 'assert';
import * as puppeteer from 'puppeteer';
import * as http from 'http';
@@ -23,34 +22,11 @@ describe('basics', function() {
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';
before(async () => {
await build({ cwd: __dirname });
// 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);
}
});
});
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page, start, prefetchRoutes, prefetch, goto } = await runner.start());
});
after(() => runner.end());

View File

@@ -1,4 +1,3 @@
import * as path from 'path';
import * as assert from 'assert';
import * as puppeteer from 'puppeteer';
import { build } from '../../../api';
@@ -17,34 +16,11 @@ describe('credentials', function() {
let prefetchRoutes: () => Promise<void>;
// hooks
before(() => {
return new Promise((fulfil, reject) => {
// TODO this is brittle. Make it unnecessary
process.chdir(__dirname);
process.env.NODE_ENV = 'production';
before(async () => {
await build({ cwd: __dirname });
// 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 } = await runner.start());
fulfil();
} catch (err) {
reject(err);
}
});
});
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page, start, prefetchRoutes } = await runner.start());
});
after(() => runner.end());

View File

@@ -1,4 +1,3 @@
import * as path from 'path';
import * as assert from 'assert';
import * as puppeteer from 'puppeteer';
import { build } from '../../../api';
@@ -17,34 +16,11 @@ describe('encoding', function() {
let prefetchRoutes: () => Promise<void>;
// hooks
before(() => {
return new Promise((fulfil, reject) => {
// TODO this is brittle. Make it unnecessary
process.chdir(__dirname);
process.env.NODE_ENV = 'production';
before(async () => {
await build({ cwd: __dirname });
// 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 } = await runner.start());
fulfil();
} catch (err) {
reject(err);
}
});
});
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page, start, prefetchRoutes } = await runner.start());
});
after(() => runner.end());

View File

@@ -1,4 +1,3 @@
import * as path from 'path';
import * as assert from 'assert';
import * as puppeteer from 'puppeteer';
import { build } from '../../../api';
@@ -17,34 +16,11 @@ describe('errors', function() {
let prefetchRoutes: () => Promise<void>;
// hooks
before(() => {
return new Promise((fulfil, reject) => {
// TODO this is brittle. Make it unnecessary
process.chdir(__dirname);
process.env.NODE_ENV = 'production';
before(async () => {
await build({ cwd: __dirname });
// 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 } = await runner.start());
fulfil();
} catch (err) {
reject(err);
}
});
});
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page, start, prefetchRoutes } = await runner.start());
});
after(() => runner.end());

View File

@@ -1,70 +0,0 @@
import * as path from 'path';
import * as assert from 'assert';
import { walk } from '../../utils';
import * as api from '../../../api';
describe('export', function() {
this.timeout(10000);
// 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 builder = api.build({
bundler: 'rollup'
}, {
src: path.join(__dirname, 'src'),
routes: path.join(__dirname, 'src/routes'),
dest: path.join(__dirname, '__sapper__/build')
});
builder.on('error', reject);
builder.on('done', () => {
// TODO it'd be nice if build and export returned promises.
// not sure how best to combine promise and event emitter
const exporter = api.exporter({
build: '__sapper__/build',
dest: '__sapper__/export',
static: 'static',
basepath: '',
timeout: 5000
});
exporter.on('error', (err: Error) => {
console.error(err);
reject(err);
});
exporter.on('done', () => fulfil());
});
});
});
it('crawls a site', () => {
const files = walk('__sapper__/export');
const client_assets = files.filter(file => file.startsWith('client/'));
const non_client_assets = files.filter(file => !file.startsWith('client/')).sort();
assert.ok(client_assets.length > 0);
assert.deepEqual(non_client_assets, [
'blog.json',
'blog/bar.json',
'blog/bar/index.html',
'blog/baz.json',
'blog/baz/index.html',
'blog/foo.json',
'blog/foo/index.html',
'blog/index.html',
'global.css',
'index.html',
'service-worker.js'
]);
});
// TODO test timeout, basepath
});

38
test/apps/export/test.ts Normal file
View File

@@ -0,0 +1,38 @@
import * as assert from 'assert';
import { walk } from '../../utils';
import * as api from '../../../api';
describe('export', function() {
this.timeout(10000);
// hooks
before(async () => {
await api.build({ cwd: __dirname });
await api.export({ cwd: __dirname });
});
it('crawls a site', () => {
const files = walk(`${__dirname}/__sapper__/export`);
const client_assets = files.filter(file => file.startsWith('client/'));
const non_client_assets = files.filter(file => !file.startsWith('client/')).sort();
assert.ok(client_assets.length > 0);
assert.deepEqual(non_client_assets, [
'blog.json',
'blog/bar.json',
'blog/bar/index.html',
'blog/baz.json',
'blog/baz/index.html',
'blog/foo.json',
'blog/foo/index.html',
'blog/index.html',
'global.css',
'index.html',
'service-worker.js'
]);
});
// TODO test timeout, basepath
});

View File

@@ -1,4 +1,3 @@
import * as path from 'path';
import * as assert from 'assert';
import * as puppeteer from 'puppeteer';
import { build } from '../../../api';
@@ -12,34 +11,11 @@ describe('ignore', function() {
let base: string;
// hooks
before(() => {
return new Promise((fulfil, reject) => {
// TODO this is brittle. Make it unnecessary
process.chdir(__dirname);
process.env.NODE_ENV = 'production';
before(async () => {
await build({ cwd: __dirname });
// 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 } = await runner.start());
fulfil();
} catch (err) {
reject(err);
}
});
});
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page } = await runner.start());
});
after(() => runner.end());

View File

@@ -1,4 +1,3 @@
import * as path from 'path';
import * as assert from 'assert';
import * as puppeteer from 'puppeteer';
import { build } from '../../../api';
@@ -16,34 +15,11 @@ describe('layout', function() {
let start: () => Promise<void>;
// hooks
before(() => {
return new Promise((fulfil, reject) => {
// TODO this is brittle. Make it unnecessary
process.chdir(__dirname);
process.env.NODE_ENV = 'production';
before(async () => {
await build({ cwd: __dirname });
// 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 } = await runner.start());
fulfil();
} catch (err) {
reject(err);
}
});
});
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page, start } = await runner.start());
});
after(() => runner.end());

View File

@@ -19,34 +19,11 @@ describe('preloading', function() {
let prefetchRoutes: () => Promise<void>;
// hooks
before(() => {
return new Promise((fulfil, reject) => {
// TODO this is brittle. Make it unnecessary
process.chdir(__dirname);
process.env.NODE_ENV = 'production';
before(async () => {
await build({ cwd: __dirname });
// 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 } = await runner.start());
fulfil();
} catch (err) {
reject(err);
}
});
});
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page, start, prefetchRoutes } = await runner.start());
});
after(() => runner.end());

View File

@@ -1,4 +1,3 @@
import * as path from 'path';
import * as assert from 'assert';
import * as puppeteer from 'puppeteer';
import { build } from '../../../api';
@@ -17,34 +16,11 @@ describe('redirects', function() {
let prefetchRoutes: () => Promise<void>;
// hooks
before(() => {
return new Promise((fulfil, reject) => {
// TODO this is brittle. Make it unnecessary
process.chdir(__dirname);
process.env.NODE_ENV = 'production';
before(async () => {
await build({ cwd: __dirname });
// 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 } = await runner.start());
fulfil();
} catch (err) {
reject(err);
}
});
});
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page, start, prefetchRoutes } = await runner.start());
});
after(() => runner.end());

View File

@@ -1,5 +1,4 @@
import * as assert from 'assert';
import * as path from 'path';
import * as puppeteer from 'puppeteer';
import { build } from '../../../api';
import { AppRunner } from '../AppRunner';
@@ -17,34 +16,11 @@ describe('scroll', function() {
let prefetchRoutes: () => Promise<void>;
// hooks
before(() => {
return new Promise((fulfil, reject) => {
// TODO this is brittle. Make it unnecessary
process.chdir(__dirname);
process.env.NODE_ENV = 'production';
before(async () => {
await build({ cwd: __dirname });
// 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 } = await runner.start());
fulfil();
} catch (err) {
reject(err);
}
});
});
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page, start, prefetchRoutes } = await runner.start());
});
after(() => runner.end());

View File

@@ -1,60 +0,0 @@
import * as path from 'path';
import * as assert from 'assert';
import * as puppeteer from 'puppeteer';
import { build } from '../../../api';
import { AppRunner } from '../AppRunner';
describe('store', function() {
this.timeout(10000);
let runner: AppRunner;
let page: puppeteer.Page;
let base: string;
// helpers
let start: () => 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 } = await runner.start());
fulfil();
} catch (err) {
reject(err);
}
});
});
});
after(() => runner.end());
const title = () => page.$eval('h1', node => node.textContent);
it('renders store props', async () => {
await page.goto(`${base}/store`);
assert.equal(await title(), 'hello world');
await start();
assert.equal(await title(), 'hello world');
});
});

36
test/apps/store/test.ts Normal file
View File

@@ -0,0 +1,36 @@
import * as assert from 'assert';
import * as puppeteer from 'puppeteer';
import { build } from '../../../api';
import { AppRunner } from '../AppRunner';
describe('store', function() {
this.timeout(10000);
let runner: AppRunner;
let page: puppeteer.Page;
let base: string;
// helpers
let start: () => Promise<void>;
// hooks
before(async () => {
await build({ cwd: __dirname });
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page, start } = await runner.start());
});
after(() => runner.end());
const title = () => page.$eval('h1', node => node.textContent);
it('renders store props', async () => {
await page.goto(`${base}/store`);
assert.equal(await title(), 'hello world');
await start();
assert.equal(await title(), 'hello world');
});
});

View File

@@ -1,4 +1,3 @@
import * as path from 'path';
import * as assert from 'assert';
import * as puppeteer from 'puppeteer';
import * as api from '../../../api';
@@ -13,50 +12,16 @@ describe('with-basepath', function() {
let base: string;
// hooks
before(() => {
return new Promise((fulfil, reject) => {
// TODO this is brittle. Make it unnecessary
process.chdir(__dirname);
process.env.NODE_ENV = 'production';
before(async () => {
await api.build({ cwd: __dirname });
// TODO this API isn't great. Rethink it
const builder = api.build({
bundler: 'rollup'
}, {
src: path.join(__dirname, 'src'),
routes: path.join(__dirname, 'src/routes'),
dest: path.join(__dirname, '__sapper__/build')
});
builder.on('error', reject);
builder.on('done', () => {
// TODO it'd be nice if build and export returned promises.
// not sure how best to combine promise and event emitter
const exporter = api.exporter({
build: '__sapper__/build',
dest: '__sapper__/export',
static: 'static',
basepath: 'custom-basepath',
timeout: 5000
});
exporter.on('error', (err: Error) => {
console.error(err);
reject(err);
});
exporter.on('done', async () => {
try {
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page } = await runner.start());
fulfil();
} catch (err) {
reject(err);
}
});
});
await api.export({
cwd: __dirname,
basepath: 'custom-basepath'
});
runner = new AppRunner(__dirname, '__sapper__/build/server/server.js');
({ base, page } = await runner.start());
});
after(() => runner.end());
@@ -81,7 +46,7 @@ describe('with-basepath', function() {
});
it('crawls an exported site with basepath', () => {
const files = walk('__sapper__/export');
const files = walk(`${__dirname}/__sapper__/export`);
const client_assets = files.filter(file => file.startsWith('custom-basepath/client/'));
const non_client_assets = files.filter(file => !file.startsWith('custom-basepath/client/')).sort();