// cache-handler.mjs import { CacheHandler } from "@neshca/cache-handler"; CacheHandler.onCreation(() => { // setup }); export default CacheHandler;

// cache-handler.mjs import { CacheHandler } from "@fortedigital/nextjs-cache-handler"; CacheHandler.onCreation(() => { // setup }); export default CacheHandler;

// instrumentation.ts export async function register() { if (process.env.NEXT_RUNTIME === "nodejs") { const { registerInitialCache } = await import( "@neshca/cache-handler/instrumentation" ); const CacheHandler = (await import("../cache-handler.mjs")).default; await registerInitialCache(CacheHandler); } }

// instrumentation.ts export async function register() { if (process.env.NEXT_RUNTIME === "nodejs") { const { registerInitialCache } = await import( "@fortedigital/nextjs-cache-handler/instrumentation" ); const CacheHandler = (await import("../cache-handler.mjs")).default; await registerInitialCache(CacheHandler); } }

import createRedisHandler from "@fortedigital/nextjs-cache-handler/redis-strings"; const redisHandler = await createRedisHandler({ client: createClient({ url: process.env.REDIS_URL, }), keyPrefix: "myApp:", sharedTagsKey: "myTags", sharedTagsTtlKey: "myTagTtls", });

import { createCluster } from "@redis/client"; import createRedisHandler from "@fortedigital/nextjs-cache-handler/redis-strings"; import { withAdapter } from "@fortedigital/nextjs-cache-handler/cluster/adapter"; const { hostname: redisHostName } = new URL(process.env.REDIS_URL); redis = withAdapter( createCluster({ rootNodes: [{ url: process.env.REDIS_URL }], // optional if you use TLS and need to resolve shards' ip to proper hostname nodeAddressMap(address) { const [_, port] = address.split(":"); return { host: redisHostName, port: Number(port), }; }, }) ); // after using withAdapter you can use redis cluster instance as parameter for createRedisHandler const redisCacheHandler = createRedisHandler({ client: redis, keyPrefix: CACHE_PREFIX, });

import createLruHandler from "@fortedigital/nextjs-cache-handler/local-lru"; const localHandler = createLruHandler({ maxItemsNumber: 10000, maxItemSizeBytes: 1024 * 1024 * 500, });

import createCompositeHandler from "@fortedigital/nextjs-cache-handler/composite"; const compositeHandler = createCompositeHandler({ handlers: [handler1, handler2], setStrategy: (data) => (data?.tags.includes("handler1") ? 0 : 1), });

import createBufferStringDecoratorHandler from "@fortedigital/nextjs-cache-handler/buffer-string-decorator"; const bufferStringDecorator = createBufferStringDecoratorHandler(redisCacheHandler);

import { createClient } from "redis"; import { PHASE_PRODUCTION_BUILD } from "next/constants.js"; import { CacheHandler } from "@fortedigital/nextjs-cache-handler"; import createLruHandler from "@fortedigital/nextjs-cache-handler/local-lru"; import createRedisHandler from "@fortedigital/nextjs-cache-handler/redis-strings"; import createCompositeHandler from "@fortedigital/nextjs-cache-handler/composite"; CacheHandler.onCreation(() => { // Important - It's recommended to use global scope to ensure only one Redis connection is made // This ensures only one instance get created if (global.cacheHandlerConfig) { return global.cacheHandlerConfig; } // Important - It's recommended to use global scope to ensure only one Redis connection is made // This ensures new instances are not created in a race condition if (global.cacheHandlerConfigPromise) { return global.cacheHandlerConfigPromise; } // You may need to ignore Redis locally, remove this block otherwise if (process.env.NODE_ENV === "development") { const lruCache = createLruHandler(); return { handlers: [lruCache] }; } // Main promise initializing the handler global.cacheHandlerConfigPromise = (async () => { let redisClient = null; if (PHASE_PRODUCTION_BUILD !== process.env.NEXT_PHASE) { const settings = { url: process.env.REDIS_URL, pingInterval: 10000, }; // This is optional and needed only if you use access keys if (process.env.REDIS_ACCESS_KEY) { settings.password = process.env.REDIS_ACCESS_KEY; } try { redisClient = createClient(settings); redisClient.on("error", (e) => { if (typeof process.env.NEXT_PRIVATE_DEBUG_CACHE !== "undefined") { console.warn("Redis error", e); } global.cacheHandlerConfig = null; global.cacheHandlerConfigPromise = null; }); } catch (error) { console.warn("Failed to create Redis client:", error); } } if (redisClient) { try { console.info("Connecting Redis client..."); await redisClient.connect(); console.info("Redis client connected."); } catch (error) { console.warn("Failed to connect Redis client:", error); await redisClient .disconnect() .catch(() => console.warn( "Failed to quit the Redis client after failing to connect." ) ); } } const lruCache = createLruHandler(); if (!redisClient?.isReady) { console.error("Failed to initialize caching layer."); global.cacheHandlerConfigPromise = null; global.cacheHandlerConfig = { handlers: [lruCache] }; return global.cacheHandlerConfig; } const redisCacheHandler = createRedisHandler({ client: redisClient, keyPrefix: "nextjs:", }); global.cacheHandlerConfigPromise = null; // This example uses composite handler to switch from Redis to LRU cache if tags contains `memory-cache` tag. // You can skip composite and use Redis or LRU only. global.cacheHandlerConfig = { handlers: [ createCompositeHandler({ handlers: [lruCache, redisCacheHandler], setStrategy: (ctx) => (ctx?.tags.includes("memory-cache") ? 0 : 1), // You can adjust strategy for deciding which cache should the composite use }), ], }; return global.cacheHandlerConfig; })(); return global.cacheHandlerConfigPromise; }); export default CacheHandler;

// @neshca/cache-handler dependencies import { CacheHandler } from "@neshca/cache-handler"; import createLruHandler from "@neshca/cache-handler/local-lru"; // Next/Redis dependencies import { createClient } from "redis"; import { PHASE_PRODUCTION_BUILD } from "next/constants"; // @fortedigital/nextjs-cache-handler dependencies import createCompositeHandler from "@fortedigital/nextjs-cache-handler/composite"; import createRedisHandler from "@fortedigital/nextjs-cache-handler/redis-strings"; import createBufferStringHandler from "@fortedigital/nextjs-cache-handler/buffer-string-decorator"; import { Next15CacheHandler } from "@fortedigital/nextjs-cache-handler"; // Usual onCreation from @neshca/cache-handler CacheHandler.onCreation(() => { // Important - It's recommended to use global scope to ensure only one Redis connection is made // This ensures only one instance get created if (global.cacheHandlerConfig) { return global.cacheHandlerConfig; } // Important - It's recommended to use global scope to ensure only one Redis connection is made // This ensures new instances are not created in a race condition if (global.cacheHandlerConfigPromise) { return global.cacheHandlerConfigPromise; } // You may need to ignore Redis locally, remove this block otherwise if (process.env.NODE_ENV === "development") { const lruCache = createLruHandler(); return { handlers: [lruCache] }; } // Main promise initializing the handler global.cacheHandlerConfigPromise = (async () => { /** @type {import("redis").RedisClientType | null} */ let redisClient = null; if (PHASE_PRODUCTION_BUILD !== process.env.NEXT_PHASE) { const settings = { url: process.env.REDIS_URL, // Make sure you configure this variable pingInterval: 10000, }; // This is optional and needed only if you use access keys if (process.env.REDIS_ACCESS_KEY) { settings.password = process.env.REDIS_ACCESS_KEY; } try { redisClient = createClient(settings); redisClient.on("error", (e) => { if (typeof process.env.NEXT_PRIVATE_DEBUG_CACHE !== "undefined") { console.warn("Redis error", e); } global.cacheHandlerConfig = null; global.cacheHandlerConfigPromise = null; }); } catch (error) { console.warn("Failed to create Redis client:", error); } } if (redisClient) { try { console.info("Connecting Redis client..."); await redisClient.connect(); console.info("Redis client connected."); } catch (error) { console.warn("Failed to connect Redis client:", error); await redisClient .disconnect() .catch(() => console.warn( "Failed to quit the Redis client after failing to connect." ) ); } } const lruCache = createLruHandler(); if (!redisClient?.isReady) { console.error("Failed to initialize caching layer."); global.cacheHandlerConfigPromise = null; global.cacheHandlerConfig = { handlers: [lruCache] }; return global.cacheHandlerConfig; } const redisCacheHandler = createRedisHandler({ client: redisClient, keyPrefix: "nextjs:", }); global.cacheHandlerConfigPromise = null; // This example uses composite handler to switch from Redis to LRU cache if tags contains `memory-cache` tag. // You can skip composite and use Redis or LRU only. global.cacheHandlerConfig = { handlers: [ createCompositeHandler({ handlers: [ lruCache, createBufferStringHandler(redisCacheHandler), // Use `createBufferStringHandler` in Next15 and ignore it in Next14 or below ], setStrategy: (ctx) => (ctx?.tags.includes("memory-cache") ? 0 : 1), // You can adjust strategy for deciding which cache should the composite use }), ], }; return global.cacheHandlerConfig; })(); return global.cacheHandlerConfigPromise; }); export default CacheHandler;