@knaus94/prisma-extension-cache-manager 1.5.72 → 2.0.1

package/README.md

@@ -6,7 +6,6 @@ A caching extension for [Prisma](https://www.prisma.io/), compatible with [cache
 
 - [cache-manager](https://www.npmjs.com/package/cache-manager) compatibility
 - Only model queries can be cacheable (no $query or $queryRaw)
-- Supported Decimal
 
 ## Installation
 

package/dist/index.d.ts

@@ -1,12 +1,7 @@
 import { ModelExtension, PrismaRedisCacheConfig } from "./types";
-/**
- * Основная функция расширения Prisma для управления кешированием с использованием Redis.
- * @param config - Конфигурация для кеша Redis и TTL по умолчанию.
- * @returns Prisma расширение.
- */
-declare const _default: ({ cache, debug, ttl: defaultTTL }: PrismaRedisCacheConfig) => (client: any) => import("@prisma/client/extension").PrismaClientExtends<import("@prisma/client/runtime/library").InternalArgs<{}, {
+declare const _default: ({ cache }: PrismaRedisCacheConfig) => (client: any) => import("@prisma/client/extension").PrismaClientExtends<import("@prisma/client/runtime/library").InternalArgs<{}, {
     $allModels: ModelExtension;
 }, {}, {
-    $cache: import("cache-manager-ioredis-yet").RedisCache;
+    $cache: import("cache-manager").Cache;
 }>>;
 export default _default;

package/dist/index.js

@@ -1,286 +1,85 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const types_1 = require("./types");
-const crypto_1 = require("crypto");
-const library_1 = require("@prisma/client/runtime/library");
+const object_code_1 = require("object-code");
 const extension_1 = require("@prisma/client/extension");
-const msgpack_lite_1 = require("msgpack-lite");
-/**
- * Создаем codec
- * В дальнейшем используем его encode/decode для сериализации/десериализации.
- */
-const codec = (0, msgpack_lite_1.createCodec)();
-const TYPE_DECIMAL = 0x3F;
-const TYPE_DATE = 0x0d;
-/**
- * Регистрируем тип `Decimal`.
- * - При кодировании превращаем `Decimal` в строку.
- * - При декодировании восстанавливаем обратно в `Decimal`.
- */
-codec.addExtPacker(TYPE_DECIMAL, library_1.Decimal, (decimal) => {
-    return (0, msgpack_lite_1.encode)(decimal.toString());
-});
-codec.addExtUnpacker(TYPE_DECIMAL, (buffer) => {
-    return new library_1.Decimal((0, msgpack_lite_1.decode)(buffer));
-});
-/**
- * Регистрируем тип `Date`.
- * - При кодировании превращаем `Date` в строку.
- * - При декодировании восстанавливаем обратно в `Date`.
- */
-codec.addExtPacker(TYPE_DATE, Date, (date) => {
-    return (0, msgpack_lite_1.encode)(date.toISOString());
-});
-codec.addExtUnpacker(TYPE_DATE, (buffer) => {
-    return new Date((0, msgpack_lite_1.decode)(buffer));
-});
-/**
- * Генерирует уникальный ключ для кеширования на основе модели и аргументов запроса.
- * @param options - Опции для генерации ключа.
- * @returns Сгенерированный ключ.
- */
-function generateComposedKey(options) {
-    const hash = (0, crypto_1.createHash)("md5")
-        .update(JSON.stringify(options.queryArgs))
-        .digest("hex");
-    return `${options.model}@${hash}`;
-}
-/**
- * Создаёт ключ с опциональным пространством имен.
- * @param key - Основной ключ.
- * @param namespace - Пространство имен.
- * @returns Полный ключ с пространством имен, если оно указано.
- */
-function createKey(key, namespace) {
-    return namespace ? `${namespace}:${key}` : key;
-}
-/**
- * Сериализация данных
- */
-function serialize(data) {
-    return (0, msgpack_lite_1.encode)(data, { codec });
-}
-/**
- * Десериализация данных
- */
-function deserialize(buffer) {
-    return (0, msgpack_lite_1.decode)(buffer, { codec });
-}
-/**
- * Обрабатывает удаление ключей из кеша после операций записи.
- * @param cache - Кеш-менеджер.
- * @param uncacheOption - Опции удаления кеша.
- * @param result - Результат операции.
- * @returns Promise<boolean> указывающий на успешность удаления.
- */
-async function processUncache(cache, uncacheOption, result) {
-    let keysToDelete = [];
-    // 1) Если uncacheOption — функция, она может вернуть ключ(и) для удаления.
-    if (typeof uncacheOption === "function") {
-        const keys = uncacheOption(result);
-        keysToDelete = Array.isArray(keys) ? keys : [keys];
-    }
-    // 2) Если строка — просто один ключ.
-    else if (typeof uncacheOption === "string") {
-        keysToDelete = [uncacheOption];
-    }
-    // 3) Если массив:
-    else if (Array.isArray(uncacheOption)) {
-        // 3a) Простой массив строк.
-        if (typeof uncacheOption[0] === "string") {
-            keysToDelete = uncacheOption;
-        }
-        // 3b) Массив объектов { namespace, key }.
-        else if (typeof uncacheOption[0] === "object") {
-            keysToDelete = uncacheOption.map((obj) => obj.namespace ? `${obj.namespace}:${obj.key}` : obj.key);
-        }
-    }
-    if (keysToDelete.length === 0)
-        return true;
-    try {
-        await cache.store.mdel(...keysToDelete);
-        return true;
-    }
-    catch (error) {
-        return false;
-    }
-}
-/**
- * Определяет, следует ли использовать кеширование для текущей операции.
- * @param cacheOption - Опции кеширования.
- * @returns boolean указывающий, использовать ли кеш.
- */
-function shouldUseCache(cacheOption) {
-    return (cacheOption !== undefined &&
-        ["boolean", "object", "number", "string"].includes(typeof cacheOption));
-}
-/**
- * Определяет, следует ли использовать удаление из кеша для текущей операции.
- * @param uncacheOption - Опции удаления кеша.
- * @returns boolean указывающий, использовать ли удаление кеша.
- */
-function shouldUseUncache(uncacheOption) {
-    return (uncacheOption !== undefined &&
-        (typeof uncacheOption === "function" ||
-            typeof uncacheOption === "string" ||
-            Array.isArray(uncacheOption)));
-}
-/**
- * Основная функция расширения Prisma для управления кешированием с использованием Redis.
- * @param config - Конфигурация для кеша Redis и TTL по умолчанию.
- * @returns Prisma расширение.
- */
-exports.default = ({ cache, debug, ttl: defaultTTL }) => {
-    return extension_1.Prisma.defineExtension({
-        name: "prisma-extension-cache-manager",
-        client: {
-            // Делаем кеш доступным в клиенте через $cache
-            $cache: cache,
-        },
-        model: {
-            $allModels: {},
-        },
-        query: {
-            $allModels: {
-                /**
-                 * Обрабатывает все операции моделей, добавляя логику кеширования.
-                 * @param params - Параметры операции.
-                 * @returns Результат операции, возможно из кеша.
-                 */
-                async $allOperations({ model, operation, args, query }) {
-                    // Проверяем, относится ли операция к кешируемым
-                    if (!types_1.CACHE_OPERATIONS.includes(operation)) {
-                        return query(args);
-                    }
-                    // Операции, при которых данные в БД меняются
-                    const isWriteOperation = [
-                        "create",
-                        "createMany",
-                        "updateMany",
-                        "upsert",
-                        "update",
-                    ].includes(operation);
-                    // Извлекаем специальные поля cache / uncache (если есть)
-                    const { cache: cacheOption, uncache: uncacheOption, ...queryArgs } = args;
-                    const useCache = shouldUseCache(cacheOption);
-                    const useUncache = shouldUseUncache(uncacheOption);
-                    // 1. Если кеш не нужен, просто выполняем запрос и,
-                    //    при необходимости, очищаем кеш (uncache).
-                    if (!useCache) {
-                        const result = await query(queryArgs);
-                        if (useUncache) {
-                            await processUncache(cache, uncacheOption, result);
-                        }
-                        return result;
-                    }
-                    // 2. Генерируем ключ кеша + TTL
-                    let cacheKey;
-                    let ttl;
-                    // 2a) Простые варианты cacheOption (true, число, строка)
-                    if (["boolean", "number", "string"].includes(typeof cacheOption)) {
-                        cacheKey =
-                            typeof cacheOption === "string"
-                                ? cacheOption // Если cacheOption — строка, используем её как ключ напрямую
-                                : generateComposedKey({ model, queryArgs }); // Иначе генерируем ключ
-                        // Если cacheOption — число, оно означает TTL
-                        ttl = typeof cacheOption === "number" ? cacheOption : undefined;
-                    }
-                    // 2b) Если cacheOption — объект с key: function,
-                    //     нужно сначала сделать запрос к БД, чтобы функция могла сгенерировать ключ
-                    else if (typeof cacheOption.key === "function") {
-                        // Выполняем запрос к базе
-                        const result = await query(queryArgs);
-                        // Если нужно, удаляем из кеша
-                        if (useUncache) {
-                            await processUncache(cache, uncacheOption, result);
-                        }
-                        // Функция генерирует ключ на основе результатов
-                        cacheKey = cacheOption.key(result);
-                        ttl = cacheOption.ttl;
-                        if (ttl === undefined) {
-                            ttl = defaultTTL;
-                        }
-                        if (ttl) {
-                            ttl = Math.ceil(ttl / 1000);
-                        }
-                        // Сохраняем результат в кеш
-                        try {
-                            const encoded = serialize(result);
-                            await (ttl && ttl > 0
-                                ? cache.store.client.set(cacheKey, encoded, "EX", ttl)
-                                : cache.store.client.set(cacheKey, encoded));
-                            if (debug) {
-                                console.log("Data cached with key (function):", cacheKey, "encoded:", encoded, "decoded:", result);
-                            }
-                        }
-                        catch (e) {
-                            if (debug) {
-                                console.error("Failed to set cache", e);
-                            }
-                        }
-                        return result;
-                    }
-                    // 2c) Иначе берём ключ/namespace/ttl из объекта
-                    else {
-                        cacheKey =
-                            createKey(cacheOption.key, cacheOption.namespace) ||
-                                generateComposedKey({ model, queryArgs });
-                        ttl = cacheOption.ttl;
-                    }
-                    // 3. Если это операция чтения, пробуем вернуть данные из кеша
-                    if (!isWriteOperation) {
-                        try {
-                            // Используем getBuffer, т.к. сохраняем бинарные данные
-                            const cached = await cache.store.client.getBuffer(cacheKey);
-                            if (cached) {
-                                const data = deserialize(cached);
-                                if (debug) {
-                                    console.log("Cache hit for key:", cacheKey, "data", cached, "decoded", data);
-                                }
-                                return data;
-                            }
-                            else {
-                                if (debug) {
-                                    console.log("Cache miss for key:", cacheKey);
-                                }
-                            }
-                        }
-                        catch (e) {
-                            if (debug) {
-                                console.error("Failed to get cache", e);
-                            }
-                        }
-                    }
-                    // 4. Выполняем запрос к БД (операция чтения или записи)
-                    const result = await query(queryArgs);
-                    // 5. Если нужно, удаляем ключи из кеша
-                    if (useUncache) {
-                        await processUncache(cache, uncacheOption, result);
-                    }
-                    if (ttl === undefined) {
-                        ttl = defaultTTL;
-                    }
-                    if (ttl) {
-                        ttl = Math.ceil(ttl / 1000);
-                    }
-                    // 6. Сохраняем результат запроса в кеш
+/* helpers -------------------------------------------------------------- */
+const hashKey = (m, a) => `${m}@${(0, object_code_1.hash)(a)}`;
+const ns = (k, n) => (n ? `${n}:${k}` : k);
+const WRITE_OPS = new Set([
+    "create",
+    "createMany",
+    "updateMany",
+    "upsert",
+    "update",
+]);
+const toUncache = (opt, res) => !opt
+    ? []
+    : typeof opt === "function"
+        ? Array(opt(res))
+        : typeof opt === "string"
+            ? [opt]
+            : opt.map((o) => typeof o === "string" ? o : ns(o.key, o.namespace));
+/* extension ------------------------------------------------------------ */
+exports.default = ({ cache }) => extension_1.Prisma.defineExtension({
+    name: "prisma-extension-cache-manager",
+    client: { $cache: cache },
+    model: { $allModels: {} },
+    query: {
+        $allModels: {
+            async $allOperations({ model, operation, args, query }) {
+                if (!types_1.CACHE_OPERATIONS.includes(operation))
+                    return query(args);
+                const { cache: cOpt, uncache, ...queryArgs } = args;
+                const finish = async (res) => {
+                    const dels = toUncache(uncache, res);
+                    if (dels.length)
+                        cache.mdel(dels).catch(() => { });
+                    return res;
+                };
+                if (cOpt === undefined)
+                    return finish(await query(queryArgs));
+                /* key + ttl */
+                let key;
+                let ttl;
+                if (typeof cOpt !== "object" || Array.isArray(cOpt)) {
+                    key = typeof cOpt === "string" ? cOpt : hashKey(model, queryArgs);
+                    if (typeof cOpt === "number")
+                        ttl = cOpt;
+                }
+                else if (typeof cOpt.key === "function") {
+                    const res = await query(queryArgs);
+                    await finish(res);
+                    key = cOpt.key(res);
+                    ttl = cOpt.ttl; // как есть
                     try {
-                        const encoded = serialize(result);
-                        await (ttl && ttl > 0
-                            ? cache.store.client.set(cacheKey, encoded, "EX", ttl)
-                            : cache.store.client.set(cacheKey, encoded));
-                        if (debug) {
-                            console.log("Data cached with key:", cacheKey, "encoded:", encoded, "decoded:", result);
-                        }
+                        await cache.set(key, res, ttl);
                     }
-                    catch (e) {
-                        if (debug) {
-                            console.error("Failed to set cache", e);
-                        }
+                    catch { }
+                    return res;
+                }
+                else {
+                    key = ns(cOpt.key ?? hashKey(model, queryArgs), cOpt.namespace);
+                    ttl = cOpt.ttl;
+                }
+                /* try cache for reads */
+                if (!WRITE_OPS.has(operation)) {
+                    try {
+                        const hit = await cache.get(key);
+                        if (hit != null)
+                            return hit;
                     }
-                    return result;
-                },
+                    catch { }
+                }
+                /* DB round-trip */
+                const res = await query(queryArgs);
+                await finish(res);
+                try {
+                    await cache.set(key, res, ttl);
+                }
+                catch { }
+                return res;
             },
         },
-    });
-};
+    },
+});

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import { Prisma } from "@prisma/client/extension";
-import { RedisCache } from "cache-manager-ioredis-yet";
+import { Cache } from "cache-manager";
 export declare const REQUIRED_ARGS_OPERATIONS: readonly ["delete", "findUnique", "findUniqueOrThrow", "aggregate", "groupBy", "update", "upsert", "create", "createMany", "updateMany"];
 export declare const OPTIONAL_ARGS_OPERATIONS: readonly ["findMany", "findFirst", "findFirstOrThrow", "count"];
 export declare const CACHE_OPERATIONS: readonly ["delete", "findUnique", "findUniqueOrThrow", "aggregate", "groupBy", "update", "upsert", "create", "createMany", "updateMany", "findMany", "findFirst", "findFirstOrThrow", "count"];
@@ -34,7 +34,7 @@ export interface PrismaCacheArgs<T, A, O extends RequiredArgsOperation | Optiona
     }[];
 }
 export interface PrismaRedisCacheConfig {
-    cache: RedisCache;
+    cache: Cache;
     debug?: boolean;
     ttl?: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knaus94/prisma-extension-cache-manager",
-  "version": "1.5.72",
+  "version": "2.0.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/knaus94/prisma-extension-cache-manager.git"
@@ -40,11 +40,10 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "devDependencies": {
-    "@types/msgpack-lite": "^0.1.11",
-    "@types/node": "^20.10.6",
-    "prettier": "^3.1.1",
+    "@types/node": "^22.15.18",
+    "prettier": "^3.5.3",
     "rimraf": "^5.0.5",
-    "typescript": "^5.3.3"
+    "typescript": "^5.8.3"
   },
   "publishConfig": {
     "access": "public"
@@ -55,14 +54,12 @@
     ]
   },
   "dependencies": {
-    "@prisma/client": "^5.7.1",
-    "cache-manager": "^5.2.3",
-    "cache-manager-ioredis-yet": "^2.1.1",
-    "msgpack-lite": "^0.1.26"
+    "@prisma/client": "^6.8.2",
+    "cache-manager": "^6.4.3",
+    "object-code": "^1.3.3"
   },
   "peerDependencies": {
-    "@nestjs/cache-manager": "^1.0.0",
-    "cache-manager": "^5.2.0",
-    "cache-manager-ioredis-yet": "^2.1.1"
+    "@nestjs/cache-manager": "^3.0.1",
+    "cache-manager": "^6.4.3"
   }
 }