fuxi-de/puppy-nest

ssr service implemented via puppeteer for usage in NestJS

SSR Service for usage in NestJS Applications

What is this?

This package is a NestJS Module which implements a simple SSR function to prerender any SPA via Puppeteer and return the rendered HTML back to the client. Because these are the times we live in :).

Why you would ever want to use this technique is perfectly described here by Eric Bidelman. Long story short, it takes very little changes to your SPA to make SSR work this way, without refactoring your SPA to some SSR Framework like NUXT or NEXT. You can even just serve the prerendered Markup to the google bot and let your users use the normal SPA.

In the example he uses express, but as I personally prefer NestJS and Typescript, thats how I implemented what he describes in the article.

Installation

You can add this Module to any Nest Application by installing it via Yarn

yarn add @fuxifuchs/puppy-nest

Afterwards all you need to do is import the module into your Application Module and you should be good to go.

import { Module } from '@nestjs/common';
import { RenderingModule } from '@fuxifuchs/puppy-nest';

@Module({
  imports: [RenderingModule],
})
export class AppModule {}

Usage

After installing the package and adding it to your Application Module you should see that there is a new route when running your Nest Application locally via:

yarn start:dev

There should be some console output looking like the following:

[Nest] 39175   - 2021-03-11 16:48:54   [RoutesResolver] RenderingController {/prerender}: +4ms
[Nest] 39175   - 2021-03-11 16:48:54   [RouterExplorer] Mapped {/prerender, GET} route +3ms

This means, that all went as expected and your application now accepts GET requests under the /prerender endpoint. This is coming straight from the Rendering.module. The /prerender endpoint needs to be called with a query param called url which specifies what Resource should be prerendered and a query param called selector which specifies which HTML Selector should be waited for and will return the rendered HTML and how long the Headless rendering took as response.

An example Request would look like this:

curl --location --request GET 'http://localhost:3000/prerender/?url=https://google.de&selector=body'

For any changes required to your SPA to make this technique work, please refer to the Article by Eric Bidelman as he already described what is necessary in great detail :).

License

Licensed under the MIT License - see the LICENSE file for details.