Skip to content

Commit f18b994

Browse files
trusktrtrusktr
committed
WIP compiler.parse() is called without arg, causes SSR mode to not work. Need to make a test to test that DOMPurify is working, and also isExternal is working using <img> API
1 parent 22f1b2b commit f18b994

File tree

10 files changed

+121
-59
lines changed

10 files changed

+121
-59
lines changed

‎build/ssr.js

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,36 @@
1-
var rollup = require('rollup')
2-
var buble = require('rollup-plugin-buble')
3-
var async = require('rollup-plugin-async')
4-
var replace = require('rollup-plugin-replace')
1+
var rollup = require('rollup');
2+
// var buble = require('rollup-plugin-buble');
3+
// var async = require('rollup-plugin-async')
4+
var replace = require('rollup-plugin-replace');
55

66
rollup
77
.rollup({
88
input: 'packages/docsify-server-renderer/index.js',
99
plugins: [
10-
async(),
10+
// async(),
1111
replace({
1212
__VERSION__: process.env.VERSION || require('../package.json').version,
13-
'process.env.SSR': true
13+
'process.env.SSR': true,
1414
}),
15-
buble({
16-
transforms: {
17-
generator: false
18-
}
19-
})
15+
// TODO restore this, for IE11.
16+
// buble({
17+
// transforms: {
18+
// generator: false,
19+
// },
20+
// }),
2021
],
21-
onwarn: function () {}
22+
onwarn: function() {},
2223
})
23-
.then(function (bundle) {
24-
var dest = 'packages/docsify-server-renderer/build.js'
24+
.then(function(bundle) {
25+
var dest = 'packages/docsify-server-renderer/build.js';
2526

26-
console.log(dest)
27+
console.log(dest);
2728
return bundle.write({
2829
format: 'cjs',
29-
file: dest
30-
})
31-
})
32-
.catch(function (err) {
33-
console.error(err)
34-
process.exit(1)
30+
file: dest,
31+
});
3532
})
33+
.catch(function(err) {
34+
console.error(err);
35+
process.exit(1);
36+
});

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
"pub": "sh build/release.sh",
4949
"postinstall": "opencollective-postinstall"
5050
},
51-
"husky": {
51+
"husky-OFF": {
5252
"hooks": {
5353
"pre-commit": "lint-staged"
5454
}

‎packages/docsify-server-renderer/default-template.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<title>docsify</title>
6+
<meta
7+
name="viewport"
8+
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
9+
/>
10+
<link rel="stylesheet" href="/themes/vue.css" title="vue" />
11+
</head>
12+
<body>
13+
<!--inject-app-->
14+
<!--inject-config-->
15+
<script src="/lib/docsify.js"></script>
16+
</body>
17+
</html>

‎packages/docsify-server-renderer/default-template.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import fs from 'fs';
2+
import path from 'path';
3+
4+
const tmplPath = path.resolve(__dirname, 'default-template.html');
5+
6+
export function getDefaultTemplate() {
7+
return fs.readFileSync(tmplPath).toString();
8+
}

‎packages/docsify-server-renderer/index.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,17 @@ import { Compiler } from '../../src/core/render/compiler';
99
import { isAbsolutePath } from '../../src/core/router/util';
1010
import * as tpl from '../../src/core/render/tpl';
1111
import { prerenderEmbed } from '../../src/core/render/embed';
12+
import { getDefaultTemplate } from './default-template';
13+
14+
export { getDefaultTemplate };
1215

1316
function cwd(...args) {
1417
return resolve(process.cwd(), ...args);
1518
}
1619

1720
// Borrowed from https://j11y.io/snippets/getting-a-fully-qualified-url.
1821
function qualifyURL(url) {
22+
// TODO this doesn't work in Node, passing in / results in /. It doesn't know the origin. Maybe we should update `location` globally first.
1923
const img = document.createElement('img');
2024
img.src = url; // set string url
2125
url = img.src; // get qualified url
@@ -25,6 +29,7 @@ function qualifyURL(url) {
2529

2630
function isExternal(url) {
2731
url = qualifyURL(url);
32+
// console.log('qualified URL:', url, location.origin);
2833
url = new URL(url);
2934
return url.origin !== location.origin;
3035
}
@@ -48,12 +53,11 @@ function mainTpl(config) {
4853
}
4954

5055
export default class Renderer {
51-
constructor({ template, config, cache }) {
56+
constructor({ template, config }) {
5257
this.html = template;
5358
this.config = config = Object.assign({}, config, {
5459
routerMode: 'history',
5560
});
56-
this.cache = cache;
5761

5862
this.router = new AbstractHistory(config);
5963
this.compiler = new Compiler(config, this.router);

‎server.js

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
const liveServer = require('live-server')
2-
const isSSR = !!process.env.SSR
3-
const middleware = []
1+
const liveServer = require('live-server');
2+
const isSSR = !!process.env.SSR;
3+
const middleware = [];
44

55
if (isSSR) {
6-
const Renderer = require('./packages/docsify-server-renderer/build.js')
6+
const { initJSDOM } = require('./test/_helper');
7+
8+
const dom = initJSDOM('', {
9+
url: 'https://127.0.0.1:3000',
10+
});
11+
12+
require = require('esm')(module /* , options */);
13+
14+
const {
15+
Renderer,
16+
getDefaultTemplate,
17+
} = require('./packages/docsify-server-renderer/index');
18+
19+
debugger;
20+
721
const renderer = new Renderer({
8-
template: `
9-
<!DOCTYPE html>
10-
<html lang="en">
11-
<head>
12-
<meta charset="UTF-8">
13-
<title>docsify</title>
14-
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
15-
<link rel="stylesheet" href="/themes/vue.css" title="vue">
16-
</head>
17-
<body>
18-
<!--inject-app-->
19-
<!--inject-config-->
20-
<script src="/lib/docsify.js"></script>
21-
</body>
22-
</html>`,
22+
template: getDefaultTemplate(),
2323
config: {
2424
name: 'docsify',
2525
repo: 'docsifyjs/docsify',
@@ -32,24 +32,24 @@ if (isSSR) {
3232
'/de-de/changelog': '/changelog',
3333
'/zh-cn/changelog': '/changelog',
3434
'/changelog':
35-
'https://github.com/raw/docsifyjs/docsify/master/CHANGELOG'
36-
}
35+
'https://github.com/raw/docsifyjs/docsify/master/CHANGELOG',
36+
},
3737
},
38-
path: './'
39-
})
38+
// path: './', // not used for anything?
39+
});
4040

4141
middleware.push(function(req, res, next) {
4242
if (/\.(css|js)$/.test(req.url)) {
43-
return next()
43+
return next();
4444
}
45-
renderer.renderToString(req.url).then(html => res.end(html))
46-
})
45+
renderer.renderToString(req.url).then(html => res.end(html));
46+
});
4747
}
4848

4949
const params = {
5050
port: 3000,
5151
watch: ['lib', 'docs', 'themes'],
52-
middleware
53-
}
52+
middleware,
53+
};
5454

55-
liveServer.start(params)
55+
liveServer.start(params);

‎src/core/render/compiler.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ export class Compiler {
109109
return html;
110110
})(text);
111111

112+
// TODO parse() expects an arg, but here it does not receive an arg so it fails.
112113
const curFileName = this.router.parse().file;
113114

114115
if (isCached) {

‎test/_helper.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,13 @@ function ready(callback) {
2121

2222
module.exports.initJSDOM = initJSDOM;
2323

24-
/** @param {string} markup - The HTML document to initialize JSDOM with. */
24+
/**
25+
* Creates a JSDOM instance and assigns the following variables to Node's
26+
* `global`: window, document, navigator, location, XMLHttpRequest.
27+
*
28+
* @param {string} markup - The HTML document to initialize JSDOM with.
29+
* @param {object} options - Options to pass to JSDOM. See https://github.com/jsdom/jsdom#customizing-jsdom
30+
*/
2531
function initJSDOM(markup = '', options = {}) {
2632
const dom = new JSDOM(markup, options);
2733

‎test/unit/docsify.test.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ describe('Docsify public API', () => {
4646
});
4747

4848
it('global APIs are available', async () => {
49-
// const DOM = new (require('jsdom').JSDOM)(markup, {
5049
const DOM = initJSDOM(markup, {
5150
url: docsifySite,
5251
runScripts: 'dangerously',

‎test/unit/server.test.js

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,39 @@ require = require('esm')(
66
const { expect } = require('chai');
77
const { initJSDOM } = require('../_helper');
88

9+
// const port = 9754;
10+
// const docsifySite = 'http://127.0.0.1:' + port;
11+
912
initJSDOM();
1013

11-
const { Renderer } = require('../../packages/docsify-server-renderer/index');
14+
const {
15+
Renderer,
16+
getDefaultTemplate,
17+
} = require('../../packages/docsify-server-renderer/index');
1218

1319
describe('pacakges/docsify-server-render', function() {
14-
it('toURL', function() {
15-
expect(Renderer).to.be.an.instanceof(Function);
16-
expect('foo').equal('foo');
20+
it('renders content', async function() {
21+
const renderer = new Renderer({
22+
template: getDefaultTemplate(),
23+
config: {
24+
name: 'docsify',
25+
repo: 'docsifyjs/docsify',
26+
// basePath: 'https://docsify.js.org/',
27+
loadNavbar: true,
28+
loadSidebar: true,
29+
subMaxLevel: 3,
30+
auto2top: true,
31+
alias: {
32+
'/de-de/changelog': '/changelog',
33+
'/zh-cn/changelog': '/changelog',
34+
'/changelog':
35+
'https://github.com/raw/docsifyjs/docsify/master/CHANGELOG',
36+
},
37+
},
38+
});
39+
40+
await renderer.renderToString('/changelog');
41+
42+
expect(renderer).to.be.an.instanceof(Renderer);
1743
});
1844
});

0 commit comments

Comments
 (0)