@ampproject/toolbox-optimizer
Advanced tools
AMP Optimizer is a tool to server-side enhance the rendering performance of AMP pages. AMP Optimizer implements AMP performance best practices and supports AMP server-side-rendering. By default, it will perform the following optimizations:
The performance optimizations can improve page rendering times by up to 50%. You can read more about the potential performance gains in this blog post.
Important: AMP Optimizer will produce valid AMP, if the input is valid AMP.
Install via:
npm install @ampproject/toolbox-optimizer@canary
Minimal usage:
const AmpOptimizer = require('@ampproject/toolbox-optimizer');
const ampOptimizer = AmpOptimizer.create();
const originalHtml = `
<!doctype html>
<html ⚡>
...
</html>
`
ampOptimizer.transformHtml(originalHtml).then(optimizedHtml => {
console.log(optimizedHtml);
});
You can find a sample implementation here. If you're using express to serve your site, you can use the AMP Optimizer Middleware.
There's also a command line version available:
$ npx @ampproject/toolbox-cli myFile.html
AMP Optimizer inlines CSS styles required by AMP. To make sure, that the inlined CSS stays in sync with the latest AMP release, we recommend to re-generate pages at least once a week. The good news is, out-of-sync CSS will not break your page, as AMP will check the version of the inlined CSS at runtime and will automatically update it to the latest version.
Enable verbose mode to find out why the AMP boilerplate is not being removed. You can
enable verbose mode either when creating a new optimizer instance:
// globally
const optimizer = ampOptimizer.create({
verbose: true
});
... or for individual pages:
// per transformation
ampOptimizer.transformHtml(originalHtml, {
verbose: true
})
Applying the transformations to an AMP file consumes additional server resources. Also, since the entire file is needed to apply the transformations, it also becomes impossible to stream the response while applying it. In order to avoid server overhead, if the set of AMP files to be transformed is known in advance, transformations should be run at build time.
Most websites have a more dynamic nature though and are not able to apply the transformations statically. For such cases it is possible to run the transformations after AMP pages are rendered, e.g. in an Express middleware. In that case, to achieve best performance, it's best to cache transformed pages for subsequent requests. Caching can take place on the CDN level, on the site's internal infrastructure (eg: Memcached), or even on the server itself, if the set of pages is small enough to fit in memory.
Warning: these features are experimental and might result in invalid AMP pages.
When using experimental features resulting in invalid AMP it's best to setup paired AMP mode. Paired AMP mode will add <link rel=amphtml href=${ampUrl}> to the transformed page, were ampUrl needs to point to the valid version of this page.
Example:
const optimizer = AmpOptimizer.create({
transformations: AmpOptimizer.TRANSFORMATIONS_PAIRED_AMP,
});
const ampFilePath = filePath.substring(1, filePath.length)
.replace('.html', '.amp.html');
const transformedHtml = await optimizer.transformHtml(html, {
// needed to calculate the `<link rel=amphtml href=${ampUrl}>`
ampUrl: ampFilePath,
});
The ampRuntimeVersion parameter will rewrite all AMP runtime and extension imports to the specified version. For example:
https://cdn.ampproject.org/v0.js
will be replaced with:
https://cdn.ampproject.org/rtv/001515617716922/v0.js
Versioning the AMP runtime URLs has one main benefit: versioned AMP runtime URLs are served with a longer max-age than the unversioned ones. This means AMP pages served with versioned AMP runtime benefit from better browser caching.
Important: when using versioned AMP runtime URLs make sure to invalidate all caches whenever a new AMP runtime is released. This is to ensure that your AMP pages always use the latest version of the AMP runtime.
You can use @ampproject/toolbox-runtime-version to retrieve the latest version of the AMP runtime. Here is a sample to apply the optimizations including versioning the URLs:
const ampOptimizer = require('@ampproject/toolbox-optimizer');
const ampRuntimeVersion = await runtimeVersion.currentVersion();
// The input string
const originalHtml = `
<!doctype html>
<html ⚡>
...
`
// Additional options can be passed as the second argument
const optimizedHtml = await ampOptimizer.transformHtml(originalHtml, {
ampUrl: 'canonical.amp.html',
ampRuntimeVersion: ampRuntimeVersion
});
console.log(optimizedHtml);
Add placeholders for amp-img and amp-video posters. The placeholders are blurry versions of the corresponding original source. The blur will be displayed as the <amp-img> is rendering, and will fade out once the element is loaded. The current requirements of appending a blurry placeholder is for the element is to be a JPEG that is either responsive or a poster for an amp-video.
Important: blurry image placeholder computation is computationally expensive. Make sure to only use it for static or cached pages.
This transformer supports the following options:
blurredPlaceholders: Enables blurry image placeholder generation. Default is false.imageBasePath: specifies a base path used to resolve an image during build.maxBlurredPlaceholders: Specifies the max number of blurred images. Defaults to 5.blurredPlaceholdersCacheSize: Specifies the max number of blurred images to be cached
to avoid expensive recalculation. Set to 0 if caching should be disabled. Set to -1 if
all placeholders should be cached (good for static sites). Defaults to 30.Usage:
const optimizer = AmpOptimizer.create({
// blurry image placeholders are currently not considered valid AMP
// hence it's recommended to setup paired AMP mode when enabling this feature.
transformations: AmpOptimizer.TRANSFORMATIONS_PAIRED_AMP,
blurredPlaceholders: true,
});
It's possible to rewrite the AMP framework and component imports to a different domain than cdn.ampproject.org.
Example:
const ampOptimizer = require('@ampproject/toolbox-optimizer');
// The input string
const originalHtml = `
<!doctype html>
<html ⚡>
...
`
// Additional options can be passed as the second argument
const optimizedHtml = await ampOptimizer.transformHtml(originalHtml, {
ampUrl: 'canonical.amp.html',
// this will rewrite https://cdn.ampproject.org/v0.js to /amp/v0.js
ampUrlPrefix: '/amp'
});
console.log(optimizedHtml);
FAQs
Server-side rendering for AMPs.
The npm package @ampproject/toolbox-optimizer receives a total of 46,046 weekly downloads. As such, @ampproject/toolbox-optimizer popularity was classified as popular.
We found that @ampproject/toolbox-optimizer demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 16 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.