npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@devraj95/middy-redis-cache

v1.0.3

Published

redis cache middleware for serverless API Gateway routes

Downloads

7

Readme

middy-redis-cache

A middy middleware to cache response from serverless API Gateway routes

This package will help you add caching to routes with minimum code.

@middy/core package is used to add the redis middleware to your route

Installation

To install middy-redis-cache, simply:

npm install @devraj95/middy-redis-cache

Usage

Basic Example

import middy from "@middy/core";
import redisCacheMiddleware, { setDefaultConfig } from "@devraj95/middy-redis-cache";

// sets caching config for all middleware calls of middy-redis-cache
setDefaultConfig({
    skipCachingFunc: (middyEvent: any) => middyEvent?.response?.body === "{}" || middyEvent?.response?.body === null,
    redisConfig: {
        password: <<PASSWORD>>,
        socket: {
            host: <<HOST>>,
            port: <<PORT>>,
        },
    },
});

export const getEmployee = middy(async (event: any) => {
    try {
        const { employeeId = "" }: { employeeId: string } = event?.pathParameters;

        console.log(`Inside getEmployee Details for employeeId: ${employeeId}`);

        const employee = fetchEmployeeDetails(employeeId) // function to fetch employee details

        return {
            statusCode: 200,
            body: JSON.stringify(employee),
        };
    } catch (error: any) {
        console.log("Error in fetching employees data", error);
        return {
            statusCode: 400,
            body: error.message,
        };
    }
}).use(
    redisCacheMiddleware({
        expire: 30 * 60,
        key: (middyEvent: any) => {
            const { employeeId } = middyEvent?.event?.pathParameters || {};
            return `EMPLOYEES_${employeeId}`;
        },
    })
);

Configuration Options

These are the available config options.

Except for redisConfig, all other config options can be set as default at global level, applicable to all routes, or at a route level

{
    // redis connection options, need to be defined in setDefaultConfig function
    //default: { socket: { host: "localhost", port: 6379 } }
    redisConfig: {
        socket: {
            host: <<REDIS HOST STRING>>,
            port: <<REDIS PORT>>
        }
    },

    // define when to skip caching the response, for example: skip caching when the controller returns empty response
    //default: (middyEvent: any) => !middyEvent?.response?.body
    skipCachingFunc: <<function returning boolean>>

    //define how to return response on cache hit
    //default: (cachedBody: string, middyEvent: any) => ({ statusCode: 200, body: cachedBody,})
    // cachedBody: JSON stringified cache stored in redis, middyEvent: middy middleware event object
    responseFunc: <<function returnng API Gateway response body>>

    //define the redis cache key
    //if function,
    //  - has access to middyEvent (middy middleware event)
    //  - example: (middyEvent: any) => { return `KEY_ ${middyEvent?.event?.pathParameters?.id}`}
    //default: "TEST_KEY"
    key: <<string or function>>

    //define expiry of redis cache key
    //default: 24 hours
    expire: <<time in seconds>>
}

Redis Unavailability

If the redis server becomes unavailable, the middy-redis-cache object will emit errors but will not crash the app. The requests during this time will be bypass cache and will return fresh data

Once the redis recovers, the caching will begin working again.