Noteworthy Programs Map

    @momopig/prerender-spa-plugin

    1.0.0 • Public • Published

    Prerender SPA Plugin

    This package is forked from the original by Chris Fritz

    The purpose of this fork is to upgrade all dependencies and resolve issues with Webpack 5, and support rendering page need authorize

    ---

    About prerender-spa-plugin

    • based on puppeteer
    • support webpack5
    • support routes need authorize

    Examples

    Framework-specific examples can be found in the examples/ directory.

    Basic Usage (webpack.config.js)

    const path = require('path')
    const PrerenderSPAPlugin = require('@momopig/prerender-spa-plugin')
    
    module.exports = {
      plugins: [
        ...new PrerenderSPAPlugin({
          // Required - The path to the webpack-outputted app to prerender.
          staticDir: path.join(__dirname, 'dist'),
          // Required - Routes to render.
          routes: ['/', '/about', '/some/deep/nested/route'],
    
          // optional - Routes need authorize
          authRoutes: ['/pageNeedAuth'],
    
          // optional - support authRoutes
          cookies: [{
            name: 'seesionId',
    
            // persistent token
            value: 'Hp2qERZ_H60hBo',
            domain: '127.0.0.1'
          }],
    
          server: {
            port: 8181,
    
            // optional - support authRoutes
            proxy: {
    
              // path rule: node express
              '/api': {
                target: 'http://dev.com',
                changeOrigin: true
              }
            }
          }
        }),
      ],
    }

    Advanced Usage (webpack.config.js)

    const path = require('path')
    const PrerenderSPAPlugin = require('@momopig/prerender-spa-plugin')
    const Renderer = PrerenderSPAPlugin.PuppeteerRenderer
    
    module.exports = {
      plugins: [
        ...new PrerenderSPAPlugin({
          // Required - The path to the webpack-outputted app to prerender.
          staticDir: path.join(__dirname, 'dist'),
    
          // Optional - The path your rendered app should be output to.
          // (Defaults to staticDir.)
          outputDir: path.join(__dirname, 'prerendered'),
    
          // Optional - The location of index.html
          indexPath: path.join(__dirname, 'dist', 'index.html'),
    
          // Required - Routes to render.
          routes: ['/', '/about', '/some/deep/nested/route'],
    
          // Optional - Allows you to customize the HTML and output path before
          // writing the rendered contents to a file.
          // renderedRoute can be modified and it or an equivelant should be returned.
          // renderedRoute format:
          // {
          //   route: String, // Where the output file will end up (relative to outputDir)
          //   originalRoute: String, // The route that was passed into the renderer, before redirects.
          //   html: String, // The rendered HTML for this route.
          //   outputPath: String // The path the rendered HTML will be written to.
          // }
          postProcess(renderedRoute) {
            // Ignore any redirects.
            renderedRoute.route = renderedRoute.originalRoute
            // Basic whitespace removal. (Don't use this in production.)
            renderedRoute.html = renderedRoute.html.split(/>[\s]+</gim).join('><')
            // Remove /index.html from the output path if the dir name ends with a .html file extension.
            // For example: /dist/dir/special.html/index.html -> /dist/dir/special.html
            if (renderedRoute.route.endsWith('.html')) {
              renderedRoute.outputPath = path.join(__dirname, 'dist', renderedRoute.route)
            }
    
            return renderedRoute
          },
    
          // Optional - Uses html-minifier (https://github.com/kangax/html-minifier)
          // To minify the resulting HTML.
          // Option reference: https://github.com/kangax/html-minifier#options-quick-reference
          minify: {
            collapseBooleanAttributes: true,
            collapseWhitespace: true,
            decodeEntities: true,
            keepClosingSlash: true,
            sortAttributes: true,
          },
    
          // Server configuration options.
          server: {
            // Normally a free port is autodetected, but feel free to set this if needed.
            port: 8001,
          },
    
          // The actual renderer to use. (Feel free to write your own)
          // Available renderers: https://github.com/Tribex/prerenderer/tree/master/renderers
          renderer: new Renderer({
            // Optional - The name of the property to add to the window object with the contents of `inject`.
            injectProperty: '__PRERENDER_INJECTED',
            // Optional - Any values you'd like your app to have access to via `window.injectProperty`.
            inject: {
              foo: 'bar',
            },
    
            // Optional - defaults to 0, no limit.
            // Routes are rendered asynchronously.
            // Use this to limit the number of routes rendered in parallel.
            maxConcurrentRoutes: 4,
    
            // Optional - Wait to render until the specified event is dispatched on the document.
            // eg, with `document.dispatchEvent(new Event('custom-render-trigger'))`
            renderAfterDocumentEvent: 'custom-render-trigger',
    
            // Optional - Wait to render until the specified element is detected using `document.querySelector`
            renderAfterElementExists: 'my-app-element',
    
            // Optional - Wait to render until a certain amount of time has passed.
            // NOT RECOMMENDED
            renderAfterTime: 5000, // Wait 5 seconds.
    
            // Other puppeteer options.
            // (See here: https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions)
            headless: false, // Display the browser window when rendering. Useful for debugging.
          }),
        }),
      ],
    }

    What is Prerendering?

    Recently, SSR (Server Side Rendering) has taken the JavaScript front-end world by storm. The fact that you can now render your sites and apps on the server before sending them to your clients is an absolutely revolutionary idea (and totally not what everyone was doing before JS client-side apps got popular in the first place...)

    However, the same criticisms that were valid for PHP, ASP, JSP, (and such) sites are valid for server-side rendering today. It's slow, breaks fairly easily, and is difficult to implement properly.

    Thing is, despite what everyone might be telling you, you probably don't need SSR. You can get almost all the advantages of it (without the disadvantages) by using prerendering. Prerendering is basically firing up a headless browser, loading your app's routes, and saving the results to a static HTML file. You can then serve it with whatever static-file-serving solution you were using previously. It just works with HTML5 navigation and the likes. No need to change your code or add server-side rendering workarounds.

    In the interest of transparency, there are some use-cases where prerendering might not be a great idea.

    • Tons of routes - If your site has hundreds or thousands of routes, prerendering will be really slow. Sure you only have to do it once per update, but it could take ages. Most people don't end up with thousands of static routes, but just in-case...
    • Dynamic Content - If your render routes that have content that's specific to the user viewing it or other dynamic sources, you should make sure you have placeholder components that can display until the dynamic content loads on the client-side. Otherwise it might be a tad weird.

    Available Renderers

    • @momopig/renderer-puppeteer - Uses puppeteer to render pages in headless Chrome.

    Which renderer should I use?

    Use @momopig/renderer-puppeteer if: You're prerendering up to a couple hundred pages and want accurate results (bye-bye RAM!).

    Plugin Options

    Option Type Required? Default Description
    staticDir String Yes None The root path to serve your app from.
    routes Array Yes None Routes to render.
    authRoutes Array No None Routes need authorize
    cookies Array No None Support authRoutes
    outputDir String No None Where the prerendered pages should be output. If not set, defaults to staticDir.
    indexPath String No staticDir/index.html The index file to fall back on for SPAs.
    postProcess Function(Object context): [Object | Promise] No None See the Using the postProcess Option section.
    minify Object No None Minifies the resulting HTML using html-minifier. Full list of options available here.
    server Object No None App server configuration options (See below)
    renderer Renderer Instance or Configuration Object No new PuppeteerRenderer() The renderer you'd like to use to prerender the app. It's recommended that you specify this, but if not it will default to @prerenderer/renderer-puppeteer.

    Server Options

    Option Type Required? Default Description
    port Integer No First free port after 8000 The port for the app server to run on.
    proxy Object No No proxying Proxy configuration. Has the same signature as webpack-dev-server

    Using The postProcess Option

    The postProcess(Object context): Object | Promise function in your renderer configuration allows you to adjust the output of prerender-spa-plugin before writing it to a file. It is called once per rendered route and is passed a context object in the form of:

    {
      // The prerendered route, after following redirects.
      route: String,
      // The original route passed, before redirects.
      originalRoute: String,
      // The resulting HTML for the route.
      html: String,
      // The path to write the rendered HTML to.
      // This is null (automatically calculated after postProcess)
      // unless explicitly set.
      outputPath: String || null
    }

    You can modify context.html to change what gets written to the prerendered files and/or modify context.route or context.outputPath to change the output location.

    You are expected to adjust those properties as needed, then return the context object, or a promise that resolves to it like so:

    postProcess(context) {
      // Remove /index.html from the output path if the dir name ends with a .html file extension.
      // For example: /dist/dir/special.html/index.html -> /dist/dir/special.html
      if (context.route.endsWith('.html')) {
        context.outputPath = path.join(__dirname, 'dist', context.route)
      }
    
      return context
    }
    
    postProcess(context) {
      return someAsyncProcessing(context.html)
        .then((html) => {
          context.html = html;
          return context;
        });
    }

    Vue.js Notes

    If you are having issues prerendering with Vue.js, try adding the data-server-rendered="true" attribute to your root app element. This will cause Vue to treat your current page as an already-rendered app and update it rather than completely rerendering the whole tree. You can add the attribute using postProcess or by manipulating the DOM with JavaScript prior prerendering with renderAfterDocumentEvent.


    @momopig/renderer-puppeteer options

    Option Type Required? Default Description
    maxConcurrentRoutes Number No 0 (No limit) The number of routes allowed to be rendered at the same time. Useful for breaking down massive batches of routes into smaller chunks.
    inject Object No None An object to inject into the global scope of the rendered page before it finishes loading. Must be JSON.stringifiy-able. The property injected to is window['__PRERENDER_INJECTED'] by default.
    injectProperty String No __PRERENDER_INJECTED The property to mount inject to during rendering.
    renderAfterDocumentEvent String No None Wait to render until the specified event is fired on the document. (You can fire an event like so: document.dispatchEvent(new Event('custom-render-trigger'))
    renderAfterElementExists String (Selector) No None Wait to render until the specified element is detected using document.querySelector
    renderAfterTime Integer (Milliseconds) No None Wait to render until a certain amount of time has passed.
    skipThirdPartyRequests Boolean No false Automatically block any third-party requests. (This can make your pages load faster by not loading non-essential scripts, styles, or fonts.)
    consoleHandler function(route: String, message: ConsoleMessage) No None Allows you to provide a custom console.* handler for pages. Argument one to your function is the route being rendered, argument two is the Puppeteer ConsoleMessage object.
    [Puppeteer Launch Options] ? No None Any additional options will be passed to puppeteer.launch(), such as headless: false.

    Tips & Troubleshooting

    JS not firing before prerender?

    If you have code that relies on the existence of <body> (and you almost certainly do), simply run it in a callback to the DOMContentLoaded event: (Otherwise you'll find that prerender-spa-plugin will output the contents of your page before your JS runs.)

    document.addEventListener('DOMContentLoaded', function () {
      // your code
    })

    For example, if you're using Vue.js and mounting to a <div id="app"> in <body>:

    const root = new Vue({
      // ...
    })
    
    document.addEventListener('DOMContentLoaded', function () {
      root.$mount('#app')
    })

    Inline Styles

    If you rely on inline CSS, i.e. you do not extract CSS from your bundle and, thus, experience duplicate CSS style tags, consider using extract-text-webpack-plugin to extract CSS into a separate file and then either inject CSS back into a template.html file using html-webpack-plugin or just call it as an external CSS file.

    Either way, there will not be any unnecessary styles inside JS.

    Caveats

    • For obvious reasons, prerender-spa-plugin only works for SPAs that route using the HTML5 history API. index.html#/hash/route URLs will unfortunately not work.
    • Whatever client-side rendering library you're using should be able to at least replace any server-rendered content or diff with it.
      • For Vue.js 1 use replace: false on root components.
      • For Vue.js 2 Ensure your root component has the same id as the prerendered element it's replacing. Otherwise you'll end up with duplicated content.

    Install

    npm i @momopig/prerender-spa-plugin

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    39.7 kB

    Total Files

    6

    Last publish

    Collaborators

    • momopig