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

perf(v2): significantly reduce bundle size & initial html payload #1898

Merged
merged 4 commits into from
Oct 27, 2019
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
1 change: 1 addition & 0 deletions CHANGELOG-2.x.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Unreleased

- Convert sitemap plugin to TypeScript
- Significantly reduce main bundle size and initial HTML payload on production build. Generated JS files from webpack is also shorter in name.

## 2.0.0-alpha.31

Expand Down
14 changes: 14 additions & 0 deletions packages/docusaurus-utils/src/__tests__/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,20 @@ describe('load utils', () => {
Object.keys(secondAssert).forEach(str => {
expect(genChunkName(str, undefined, 'blog')).toBe(secondAssert[str]);
});

// Only generate short unique id
const thirdAssert = {
a: '0cc175b9',
b: '92eb5ffe',
c: '4a8a08f0',
d: '8277e091',
};
Object.keys(thirdAssert).forEach(str => {
expect(genChunkName(str, undefined, undefined, true)).toBe(
thirdAssert[str],
);
});
expect(genChunkName('d', undefined, undefined, true)).toBe('8277e091');
});

test('idx', () => {
Expand Down
22 changes: 15 additions & 7 deletions packages/docusaurus-utils/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -101,19 +101,27 @@ export function genChunkName(
modulePath: string,
prefix?: string,
preferredName?: string,
shortId?: boolean,
): string {
let chunkName: string | undefined = chunkNameCache.get(modulePath);
if (!chunkName) {
let str = modulePath;
if (preferredName) {
const shortHash = createHash('md5')
if (shortId) {
chunkName = createHash('md5')
.update(modulePath)
.digest('hex')
.substr(0, 3);
str = `${preferredName}${shortHash}`;
.substr(0, 8);
} else {
let str = modulePath;
if (preferredName) {
const shortHash = createHash('md5')
.update(modulePath)
.digest('hex')
.substr(0, 3);
str = `${preferredName}${shortHash}`;
}
const name = str === '/' ? 'index' : docuHash(str);
chunkName = prefix ? `${prefix}---${name}` : name;
}
const name = str === '/' ? 'index' : docuHash(str);
chunkName = prefix ? `${prefix}---${name}` : name;
chunkNameCache.set(modulePath, chunkName);
}
return chunkName;
Expand Down
8 changes: 5 additions & 3 deletions packages/docusaurus/src/client/exports/ComponentCreator.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,11 @@ function ComponentCreator(path) {
}

const chunkRegistry = registry[target] || {};
optsLoader[keys.join('.')] = chunkRegistry.loader;
optsModules.push(chunkRegistry.module);
optsWebpack.push(chunkRegistry.webpack);
/* eslint-disable prefer-destructuring */
optsLoader[keys.join('.')] = chunkRegistry[0];
optsModules.push(chunkRegistry[1]);
optsWebpack.push(chunkRegistry[2]);
/* eslint-enable prefer-destructuring */
}

traverseChunk(chunkNames, []);
Expand Down
9 changes: 4 additions & 5 deletions packages/docusaurus/src/server/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,10 @@ export async function load(siteDir: string): Promise<Props> {
`export default {
${Object.keys(registry)
.map(
key => ` '${key}': {
'loader': ${registry[key].loader},
'module': ${JSON.stringify(registry[key].modulePath)},
'webpack': require.resolveWeak(${JSON.stringify(registry[key].modulePath)}),
},`,
key =>
` '${key}': [${registry[key].loader}, ${JSON.stringify(
registry[key].modulePath,
)}, require.resolveWeak(${JSON.stringify(registry[key].modulePath)})],`,
)
.join('\n')}};\n`,
);
Expand Down
3 changes: 2 additions & 1 deletion packages/docusaurus/src/server/routes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ function getModulePath(target: Module): string {
}

export async function loadRoutes(pluginsRouteConfigs: RouteConfig[]) {
const isProd = process.env.NODE_ENV === 'production';
const routesImports = [
`import React from 'react';`,
`import ComponentCreator from '@docusaurus/ComponentCreator';`,
Expand Down Expand Up @@ -82,7 +83,7 @@ export async function loadRoutes(pluginsRouteConfigs: RouteConfig[]) {
}

const modulePath = getModulePath(value as Module);
const chunkName = genChunkName(modulePath, prefix, name);
const chunkName = genChunkName(modulePath, prefix, name, isProd);
const loader = `() => import(/* webpackChunkName: '${chunkName}' */ ${JSON.stringify(
modulePath,
)})`;
Expand Down
8 changes: 4 additions & 4 deletions packages/docusaurus/src/webpack/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ export function createBaseConfig(
output: {
pathinfo: false,
path: outDir,
filename: isProd ? '[name].[contenthash].js' : '[name].js',
chunkFilename: isProd ? '[name].[contenthash].js' : '[name].js',
filename: isProd ? '[name].[contenthash:8].js' : '[name].js',
chunkFilename: isProd ? '[name].[contenthash:8].js' : '[name].js',
publicPath: baseUrl,
},
// Don't throw warning when asset created is over 250kb
Expand Down Expand Up @@ -157,8 +157,8 @@ export function createBaseConfig(
},
plugins: [
new MiniCssExtractPlugin({
filename: isProd ? '[name].[contenthash].css' : '[name].css',
chunkFilename: isProd ? '[name].[contenthash].css' : '[name].css',
filename: isProd ? '[name].[contenthash:8].css' : '[name].css',
chunkFilename: isProd ? '[name].[contenthash:8].css' : '[name].css',
}),
],
};
Expand Down