README

Description

Generates HTML for client-side rendered content via AWS Lambda. This plugin sends request to AWS Lambda Prerender function which renders content with Puppeteer and returns HTML back through REST API callback.

Install

Preferable way is to use Composer:
```
composer require innocode-digital/wp-prerender-aws-lambda
```
By default, it will be installed as Must Use Plugin. It's possible to control with extra.installer-paths in composer.json.

Alternate way is to clone this repo to wp-content/mu-plugins/ or wp-content/plugins/:

cd wp-content/plugins/
git clone git@github.com:innocode-digital/wp-prerender-aws-lambda.git
cd wp-prerender-aws-lambda/
composer install

If plugin was installed as regular plugin then activate AWS Lambda Prerender from Plugins page or WP-CLI: wp plugin activate wp-prerender-aws-lambda.

Configuration

Add the following constants to wp-config.php:

define( 'AWS_LAMBDA_PRERENDER_KEY', '' );
define( 'AWS_LAMBDA_PRERENDER_SECRET', '' );
define( 'AWS_LAMBDA_PRERENDER_REGION', '' ); // e.g. eu-west-1

define( 'AWS_LAMBDA_PRERENDER_FUNCTION', '' ); // Optional, default value is "prerender-production-render"

Create Lambda function on AWS. Expected default name is prerender-production-render but you may use any other. There is a prepared function AWS Lambda Prerender.

Used user should have InvokeFunction in policy.

define( 'AWS_LAMBDA_PRERENDER_DB_TABLE', '' ); // Optional, default value is "innocode_prerender"

define( 'AWS_LAMBDA_PRERENDER_QUERY_ARG', '' ); // Optional, default value is "innocode_prerender"

It's possible to change database table name where HTML will be stored and query argument which is using when serverless function makes request to website.

Usage

Plugin automatically generates HTML on Post/Page and Term save action with updating of related content like Frontpage, but it's possible to control this behavior e.g. if you do not want to update author's archive page on post save then use next filter:

add_filter( 'innocode_prerender_should_update_post_author', function (
    (bool) $should_update,
    int $object_id,
    $id
) : bool {
    // Do not update achive page of author with user id 5.
    if ( $id == 5 ) {
        return false;
    }

    return $should_update;
}, 10, 3 );

Also, plugin generates HTML "on the fly" when someone visits any of object with template e.g. single post and if there is no content in database for current object in current version then cron task will be scheduled to make new request to Lambda.

If theme does not support e.g. date archives then it's possible to disable them at all:

add_filter( 'innocode_prerender_template', function ( string $template ) : string {
    if ( $template == 'date_archive' ) {
        return '';
    }

    return $template;
} );

Also, it's possible to add custom template in addition to existing:

Create new template from Innocode\Prerender\Abstracts\AbstractTemplate class:

...
use Innocode\Prerender\Abstracts\AbstractTemplate;

class YourTemplate extends AbstractTemplate
{
    ...
}

Implement method stubs in your template class.
Add your template class object to templates collection:

$your_template = new YourTemplate();
innocode_prerender()->insert_templates( [ $your_template ] );

By default, plugin uses selector #app to grab content, i.e. that your client-side application is wrapped in block with ID app:

<div id="app"></div>

If it's needed to change selector use next hook:

add_filter( 'innocode_prerender_selector', function () : string {
    return '#main';
} )

Notes

Existing templates

post - Post, Page and Custom Post Type
term - Category, Tag and Custom Taxonomy Term
author - Author Archive
frontpage - Front Page
post_type_archive - Post Type Archive
date_archive - Year, Month and Day Archives

Version

It was mentioned above that content has a version, and you may want to upgrade it at some point, most obvious case when something has been changed in client-side rendered layout. In this case it's needed to bump new version:

if ( function_exists( 'innocode_prerender' ) ) {
    innocode_prerender()
        ->get_db()
        ->get_html_version()
        ->bump();
}

But, you can install Flush Cache Buttons plugin which adds possibility to do this action by clicking on the button in admin panel.

Modify content during prerendering

Sometimes content which is prerendered should be different from what we get on client-side e.g. you may need to exclude certain element. In this case use JavaScript global variable:

if (window.__INNOCODE_PRERENDER__) {
    // Only for prerendering.
} else {
    // Only for client-side.
}

innocode-digital / wp-prerender-aws-lambda

Maintainers

Details