Skip to content

Latest commit

 

History

History
198 lines (157 loc) · 7.38 KB

README.md

File metadata and controls

198 lines (157 loc) · 7.38 KB

Next-Cache-Handler

Introduction

@dbbs/next-cache-handler-core is designed to elevate the performance of Next.js applications by providing a robust caching solution that adapts to cookies, query parameters, and device types. This enables the delivery of content that is finely tuned to the context of each user, significantly improving load times and user experience.

Table of Contents

Features

  • Cache Segmentation: Dynamically segment cache storage based on cookies, query parameters, and device types.
  • Multiple Storage Options: Supports various caching mechanisms including file system cache, in-memory cache, and Redis.
  • Customizable: Flexible configuration options to tailor caching strategies to specific needs.

Quick Start

Installation

Ensure you have Node.js version 12 or higher installed.

npm i @dbbs/next-cache-handler-core
# or
yarn add @dbbs/next-cache-handler-core

Configuration

Create a cacheHandler.js in your project and configure as follows:

import { Cache, FileSystemCache, ConsoleLogger } from '@dbbs/next-cache-handler-core'

const config = {
  cacheCookies: ['my-cookie-1', 'my-cookie-2'],
  cacheQueries: ['my-query-1', 'my-query-2'],
  enableDeviceSplit: true,
  noCacheMatchers: [],
  cache: new FileSystemCache(),
  logger: new ConsoleLogger()
}

Cache.setConfig(config)
export default Cache

Update your next.config.js to use the cache handler.

const nextConfig = {
    cacheHandler: require.resolve('./cacheHandler.js')
}

export default nextConfig

Cache Strategies

Explore various caching strategies to find the best fit for your application's needs:

  • MemoryCache: Ideal for short-lived data in applications with limited cache size requirements. By default limit of size is set to 512MB.
import { Cache, MemoryCache } from '@dbbs/next-cache-handler-core'

Cache.setCacheStrategy(new MemoryCache())
import { Cache, MemoryCache } from '@dbbs/next-cache-handler-core'

// extending size limitation to 1024MB.
Cache.addStrategy(new MemoryCache({ sizeLimit: 1024 }))
  • FileSystemCache: Suitable for persistent caching across application restarts.
import { Cache, FileSystemCache } from '@dbbs/next-cache-handler-core'

Cache.setCacheStrategy(new FileSystemCache())
  • Redis: Perfect for distributed applications requiring shared cache access.
import { Cache } from '@dbbs/next-cache-handler-core'
import { RedisCache } from '@dbbs/next-cache-handler-redis'

// list of all accepted redis connection options.
const redisConnectionOpts = {
    url: 'redis://localhost:5843',
    ...
}

Cache.setCacheStrategy(new RedisCache(redisConnectionOpts))

By default, we use plain Redis as the cache store. But you are able to use Redis with RedisJSON and RedisSearch modules as the cache store. In that case you need to pass extra params to RedisCache class during initialization.

import { Cache } from '@dbbs/next-cache-handler-core'
import { RedisCache, RedisStrategy } from "@dbbs/next-cache-handler-redis"

// list of all accepted redis connection options.
const redisConnectionOpts = {
    url: 'redis://localhost:5843',
    ...
}

Cache.setConfig({
    ...config,
    cache: new RedisCache(redisConnectionOpts, RedisStrategy.RedisJSON),
})
  • S3: Suitable for high scalable applications.
import { Cache } from '@dbbs/next-cache-handler-core'
import { S3Cache } from '@dbbs/next-cache-handler-s3'

Cache.setConfig({
    ...config,
    cache: new S3Cache('cache-bucket-name'),
})

API Reference

Configuration Options

The cache handler accepts the following configuration options:

  • cacheCookies: Array of cookie names to use for cache segmentation
  • cacheQueries: Array of query parameter names to use for cache segmentation
  • enableDeviceSplit: Boolean to enable/disable device-based cache segmentation
  • noCacheMatchers: Array of path patterns to exclude from caching
  • cache: Cache strategy instance (FileSystemCache, MemoryCache, etc.)
  • logger: Logger instance implementing the BaseLogger interface
import { Cache, FileSystemCache } from '@dbbs/next-cache-handler-core'

const config = {
    cacheCookies: ['my-cookie-1', 'my-cookie-2'],
    cacheQueries: ['my-query-1', 'my-query-2'],
    enableDeviceSplit: true,
    noCacheMatchers: [],
    cache: new FileSystemCache(),
    logger: new ConsoleLogger()
}

Cache.setConfig(config)

export default Cache

Logging

Leverage the built-in logger for monitoring cache operations or integrate your custom logger for advanced logging capabilities.

import { BaseLogger, Cache, FileSystemCache } from '@dbbs/next-cache-handler-core'

class MyCustomLogger implements BaseLogger {
    constructor() {}

    info(data) {
        console.log(data)
    }

    error(data) {
        console.error(data)
    }
}

Cache.setCacheStrategy(new FileSystemCache).setLogger(new MyCustomLogger())

Contributing

  • Code Contributions: When contributing code, ensure it adheres to the project's coding standards and write tests where applicable.
  • Documentation: If you are contributing to documentation, ensure your changes are clear, concise, and helpful for other users.
  • Bug Reports and Feature Requests: Use the GitHub Issues section to report bugs or suggest new features. Please provide as much detail as possible to help us understand the issue or feature.

License

The next-cache-handler is open-source software licensed under the MIT License.

Contact Information

We value your feedback and contributions to the next-cache-handler. If you have any questions or suggestions or need support, here are several ways to get in touch with us:

  • General Inquiries and Support: For any general questions about the platform or if you need assistance, please visit our website DBB Software and use the contact form provided.

  • GitHub Issues: For specific issues, feature requests, or bugs related to the platform, please use the GitHub Issues page. This is the fastest way to directly communicate with our development team and track the resolution of your issue.

  • Community Discussion and Contributions: Join our community discussions on GitHub Discussions for broader topics, ideas exchange, and collaborative discussions.

  • Social Media: Follow us on our social media channels for the latest news, updates, and insights:

  • Email Contact: For more formal or detailed inquiries, feel free to reach out to us via email at in@dbbsoftware.com.

We're always here to help and are committed to ensuring you have the best experience with the next-cache-handler. Your input and participation drive the continuous improvement of our platform.