flavrhub / angular-universal-express-cache-engine

Angular Universal Express Cache Engine

Angular Universal Express Cache Engine

Express enging that catches the request by the url so that the request doesn't have to go through all the Angular Universal each time. Really handy to cache static pages.

Uses the cache-manager package for catching, which can be used with a bunch of different engines, checkout it documentation for futher information.

Instalation

Just place the express-engine.ts file in your project and in your server.ts replace:

server.engine('html', ngExpressEngine({
    bootstrap: AppServerModule,
 }));

with

server.engine('html', ngFlavrHubExpressEngine({
    bootstrap: AppServerModule,
    routeCaches
}));

And at the beginning of it specify the routes you want to catch:

const routeCaches = [
    {path: '/', ttl: 86400},
    {path: '/explore-recipes', ttl: 86400, useQueryParams: true}
];

Routes configuration

Each route configuration implements the following interface:

export interface RouteCache {
  path: string;
  useQueryParams?: boolean;
  ttl?: number;

  isCacheableValue?(path: any, req: Request): boolean;
}

• path: The path you want to cache starting with /, for example for the home page will be /
• useQueryParams: Whether the query params of the url should be taken in account on catching. Default: false.
• ttl: Time to live in cache in seconds. Default: 60 seconds.
• isCacheableValue: A function that decide if a value is cacheable on the fly

Results

Before catching

After catching

angular-universal-express-cache-engine's Issues

Can it support wildcard like *?

Hi I would love to utilize this code. I am wondering if it is possible to cache all routes with '*'?

The "path" argument must be of type string. Received undefined

I am trying your implementation but I am getting The "path" argument must be of type string. Received undefined when I refresh localhost, not sure why. I'm still investigating...

One change on my end, I cannot use import { ɵCommonEngine as CommonEngine } from '@nguniversal/common/​engine'; because it causes Cannot find module '@nguniversal/common/​engine' or its corresponding type declarations.
This import { CommonEngine } from '@nguniversal/common/engine'; works, but not sure if that's good to go.

Use Redis instead

How can i use Redis for caching instead of node cache,
Thanks for your work.

Angular universal so slow

Hi, I was doing some proofs of concept with your implementation, since I have very high waiting times in my project, it is an e-commerce and this is affecting the user experience. In my project, I have several routes and I have a question about what this implementation covers:
In the case of routes with path params, how are they defined?
Do I have to define all the routes of my application to be able to cache them?

As extra data, I have deployed the application in iis 7 with iis node. the classic example that you find on the internet to deploy angular universal with iis