wp-calypso/client/server/isomorphic-routing/index.js

import debugFactory from 'debug';
import { isEmpty } from 'lodash';
import { stringify } from 'qs';
import { setSectionMiddleware } from 'calypso/controller';
import performanceMark from 'calypso/server/lib/performance-mark';
import { serverRender, setShouldServerSideRender, markupCache } from 'calypso/server/render';
import { createQueryClientSSR } from 'calypso/state/query-client-ssr';
import { setRoute } from 'calypso/state/route/actions';

const debug = debugFactory( 'calypso:pages' );

export function serverRouter( expressApp, setUpRoute, section ) {
	return function ( route, ...middlewares ) {
		expressApp.get(
			route,
			( req, res, next ) => {
				const markup = markupCache.get( getCacheKey( req ) );
				if ( markup ) {
					req.context.cachedMarkup = markup;
				}
				req.context.usedSSRHandler = true;
				debug(
					`Using SSR pipeline for path: ${
						req.path
					} with handler ${ route }. Cached layout: ${ !! markup }`
				);
				next();
			},
			setUpRoute,
			combineMiddlewares(
				setSectionMiddleware( section ),
				setRouteMiddleware,
				setShouldServerSideRender,
				...middlewares
			),
			// Regular serverRender when there are no errors.
			serverRender,

			// Capture the error. This assumes that any of the previous middlewares
			// have changed req.context to include info about the error, and serverRender
			// will render it.
			( err, req, res, next ) => {
				performanceMark( req.context, 'serverRouter error handler' );
				req.error = err;
				res.status( err.status || 404 );
				if ( err.status >= 500 ) {
					req.logger.error( err );
				} else {
					req.logger.warn( err );
				}
				serverRender( req, res, next );
				performanceMark( req.context, 'post-handling serverRouter error' );
				// Keep propagating the error to ensure regular middleware doesn't get executed.
				// In particular, without this we'll try to render a 404 page.
				next( err );
			}
		);
	};
}

function setRouteMiddleware( context, next ) {
	context.store.dispatch( setRoute( context.pathname, context.query ) );

	next();
}

function combineMiddlewares( ...middlewares ) {
	return function ( req, res, expressNext ) {
		req.context = getEnhancedContext( req, res );
		applyMiddlewares(
			req.context,
			...middlewares,

			// These two middlewares transfer the control back to Express. We need two, one
			// to end the chain of middlewares when there is no error, and another one
			// for when there is an error.
			// eslint-disable-next-line no-unused-vars
			( context, next ) => expressNext(),
			// eslint-disable-next-line no-unused-vars
			( err, context, next ) => expressNext( err )
		);
	};
}

// TODO: Maybe merge into getDefaultContext().
function getEnhancedContext( req, res ) {
	return Object.assign( {}, req.context, {
		isServerSide: true,
		originalUrl: req.originalUrl,
		path: req.url,
		queryClient: createQueryClientSSR(),
		pathname: req.path,
		params: req.params,
		query: req.query,
		redirect: res.redirect.bind( res ),
		res,
	} );
}

function applyMiddlewares( context, ...middlewares ) {
	// This method will run all middlewares chained. Every time a middlware calls
	// `next`, it will pass the control to the next middleware and so on. But if
	// at any point a middleware calls `next(error)`, only middlewares that declare
	// 3 arguments (aka error handlers) will be called from that point.
	const liftedMiddlewares = middlewares.map( ( middleware ) => ( next, err ) => {
		try {
			if ( ! err && middleware.length !== 3 ) {
				// No errors so far, call next middleware
				return middleware( context, next );
			}
			if ( err && middleware.length === 3 ) {
				// There is an error and this middleware can handle errors
				return middleware( err, context, next );
			}
			// At this point we are in either of these scenarios:
			// * There is an error but this middlware is not an error handler
			// * There is not an error but this middleware is an error handler
			// In both cases this middleware shouldn't run, so we just skip to the next one.
			next( err );
		} catch ( error ) {
			// The middleware throw an error, capture it and pass it to the next
			// middleware in the chain.
			next( error );
		}
	} );

	compose( ...liftedMiddlewares )();
}

function compose( ...functions ) {
	return functions.reduceRight(
		( composed, f ) => ( err ) => f( composed, err ),
		() => {}
	);
}

export function getNormalizedPath( pathname, query ) {
	// Make sure that paths like "/themes" and "/themes/" are considered the same.
	// Checks for longer lengths to avoid removing the "starting" slash for the
	// base route.
	if ( pathname.length > 1 && pathname.endsWith( '/' ) ) {
		pathname = pathname.slice( 0, -1 );
	}

	if ( isEmpty( query ) ) {
		return pathname;
	}

	return pathname + '?' + stringify( query, { sort: ( a, b ) => a.localeCompare( b ) } );
}

// Given an Express request object, return a cache key.
export function getCacheKey( { path, query, context } ) {
	return `${ getNormalizedPath( path, query ) }:gdpr=${ context.showGdprBanner }`;
}