Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(v2): precompile ETA templates #3238

Merged
merged 2 commits into from
Aug 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,25 @@

import * as eta from 'eta';
import redirectPageTemplate from './templates/redirectPage.template.html';
import {memoize} from 'lodash';

type CreateRedirectPageOptions = {
toUrl: string;
};

const getCompiledRedirectPageTemplate = memoize(() => {
return eta.compile(redirectPageTemplate.trim());
});

function renderRedirectPageTemplate(data: object) {
const compiled = getCompiledRedirectPageTemplate();
return compiled(data, eta.defaultConfig);
}

export default function createRedirectPageContent({
toUrl,
}: CreateRedirectPageOptions) {
return eta.render(redirectPageTemplate.trim(), {
return renderRedirectPageTemplate({
toUrl: encodeURI(toUrl),
});
}
13 changes: 12 additions & 1 deletion packages/docusaurus-theme-search-algolia/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ const eta = require('eta');
const {normalizeUrl} = require('@docusaurus/utils');
const openSearchTemplate = require('./templates/opensearch');
const {validateThemeConfig} = require('./validateThemeConfig');
const {memoize} = require('lodash');

const getCompiledOpenSearchTemplate = memoize(() => {
return eta.compile(openSearchTemplate.trim());
});

function renderOpenSearchTemplate(data) {
const compiled = getCompiledOpenSearchTemplate();
return compiled(data, eta.defaultConfig);
}

const OPEN_SEARCH_FILENAME = 'opensearch.xml';

Expand Down Expand Up @@ -44,13 +54,14 @@ function theme(context) {
try {
fs.writeFileSync(
path.join(outDir, OPEN_SEARCH_FILENAME),
eta.render(openSearchTemplate.trim(), {
renderOpenSearchTemplate({
title,
url,
favicon: normalizeUrl([url, favicon]),
}),
);
} catch (err) {
console.error(err);
throw new Error(`Generating OpenSearch file failed: ${err}`);
}
},
Expand Down
47 changes: 27 additions & 20 deletions packages/docusaurus/src/client/serverEntry.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ import {
} from './LinksCollector';
import ssrTemplate from './templates/ssr.html.template';

// eslint-disable-next-line no-restricted-imports
import {memoize} from 'lodash';

const getCompiledSSRTemplate = memoize(() => {
return eta.compile(ssrTemplate.trim(), {
rmWhitespace: true,
});
});

function renderSSRTemplate(data) {
const compiled = getCompiledSSRTemplate();
return compiled(data, eta.defaultConfig);
}

// Renderer for static-site-generator-webpack-plugin (async rendering via promises).
export default async function render(locals) {
const {
Expand Down Expand Up @@ -76,26 +90,19 @@ export default async function render(locals) {
const stylesheets = (bundles.css || []).map((b) => b.file);
const scripts = (bundles.js || []).map((b) => b.file);

const renderedHtml = eta.render(
ssrTemplate.trim(),
{
appHtml,
baseUrl,
htmlAttributes: htmlAttributes || '',
bodyAttributes: bodyAttributes || '',
headTags,
preBodyTags,
postBodyTags,
metaAttributes,
scripts,
stylesheets,
version: packageJson.version,
},
{
name: 'ssr-template',
rmWhitespace: true,
},
);
const renderedHtml = renderSSRTemplate({
appHtml,
baseUrl,
htmlAttributes: htmlAttributes || '',
bodyAttributes: bodyAttributes || '',
headTags,
preBodyTags,
postBodyTags,
metaAttributes,
scripts,
stylesheets,
version: packageJson.version,
});

// Minify html with https://github.com/DanielRuf/html-minifier-terser
return minify(renderedHtml, {
Expand Down