cds-caching 0.3.1 → 0.3.3

package/README.md

@@ -82,7 +82,7 @@ For more control, you can specify additional options:
           "host": "localhost",
           "port": 6379,
           "password": "optional",
-          "url": "redis://..." // Alternative: Redis connection URI
+          "uri": "redis://..." // Alternative: Redis connection URI
 
           // SQLite specific
           "url": "sqlite://./cache.sqlite"
@@ -460,12 +460,21 @@ Templates support the following properties:
 
 
 ```javascript
-
-// Store with tags
+// Store with static tag
 await cache.set("key", "value", { 
   tags: [{ value: "user-123" }] 
 })
 
+// Store with template tag (will generate a tag like "tenant-global-user-anonymous")
+await cache.set("key", "value", { 
+  tags: [{ template: "tenant-{tenant}-user-{user}" }] 
+})
+
+// Store with data-based tag
+await cache.set("key", { id: 123, name: "Product" }, { 
+  tags: [{ data: "id", prefix: "product-" }] 
+})
+
 // Invalidate by tag
 await cache.deleteByTag('user-123')
 ```
@@ -796,4 +805,4 @@ Contributions are welcome! Please read our contributing guidelines and submit pu
 
 ### License
 
-This project is licensed under the MIT License - see the LICENSE file for details.
+This project is licensed under the MIT License - see the LICENSE file for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cds-caching",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "A caching plugin for SAP CAP applications supporting Redis",
   "repository": {
     "type": "git",
@@ -32,25 +32,25 @@
     "release": "release-it"
   },
   "peerDependencies": {
-    "@sap/cds": ">=8"
+    "@sap/cds": ">=9"
   },
   "workspaces": [
     ".",
     "test/**"
   ],
   "dependencies": {
-    "@keyv/compress-gzip": "^2.0.2",
+    "@keyv/compress-gzip": "^2.0.3",
     "@keyv/compress-lz4": "^1.0.0",
-    "@keyv/redis": "^4.3.1",
-    "@keyv/sqlite": "^4.0.1",
-    "keyv": "^5.3.1"
+    "@keyv/redis": "^4.5.0",
+    "@keyv/sqlite": "^4.0.5",
+    "keyv": "^5.3.4"
   },
   "devDependencies": {
-    "eslint": "^9.21.0",
+    "eslint": "^9.30.1",
     "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "release-it": "^18.1.2",
-    "@cap-js/cds-test": "^0.2.0"
+    "jest": "^30.0.4",
+    "release-it": "^19.0.3",
+    "@cap-js/cds-test": "^0.4.0"
   },
   "engines": {
     "node": ">=16"

package/srv/CachingService.js

@@ -21,7 +21,7 @@ class CachingService extends cds.Service {
         this.options = this.options || {
             store: null,
             compression: null,
-            credentials: { }
+            credentials: {}
         };
 
         let store;
@@ -224,6 +224,7 @@ class CachingService extends cds.Service {
             switch (arg1.constructor.name) {
                 case "Request":
                 case "NoaRequest":
+                case "ODataRequest":
                     const req = arg1;
                     const next = arguments[1];
 
@@ -239,7 +240,7 @@ class CachingService extends cds.Service {
                         return cachedValue;
                     }
                     const response = await next();
-                    req.cacheOptions.tags = this.resolveTags(req.cacheOptions.tags, response, req.params);
+                    req.cacheOptions.tags = this.resolveTags(req.cacheOptions.tags, response, { ...req.params, user: req.user.id, tenant: req.tenant, locale: req.locale, hash: this.createKey(req, { template: '{hash}' }) });
                     await this.set(req.cacheKey, response, req.cacheOptions);
                     return response;
                 case "cds.ql":
@@ -259,7 +260,7 @@ class CachingService extends cds.Service {
                             return this.get(query.cacheKey);
                         }
                         const data = await srv.run(query);
-                        options.tags = this.resolveTags(options.tags, data, query.params);
+                        options.tags = this.resolveTags(options.tags, data, { ...query.params, hash: this.createKey(query, { template: '{hash}' }) });
                         await this.set(query.cacheKey, data, options);
                         return data;
                     } else {
@@ -393,6 +394,36 @@ class CachingService extends cds.Service {
                 return [tag];
             }
 
+            // Handle template-based tags
+            if (config.template) {
+                const createHash = (data) => crypto.createHash('md5').update(JSON.stringify(data)).digest('hex');
+
+                const hashParts = [
+                    ...(data ? [data] : []),
+                    ...(params ? [params] : [])
+                ];
+
+                const contextVars = {
+                    tenant: params.tenant || 'global',
+                    user: params.user || 'anonymous',
+                    locale: params.locale || 'en',
+                    hash: createHash(hashParts)
+                };
+
+                const value = config.template.replace(
+                    /\{(tenant|user|locale|hash)\}/g,
+                    (match, variable) => contextVars[variable]
+                );
+
+                const tag = [
+                    config.prefix,
+                    value,
+                    config.suffix
+                ].filter(Boolean).join('');
+
+                return [tag];
+            }
+
             // Handle data-based tags
             if (config.data && dataArray.length) {
                 return dataArray.flatMap(item => {
@@ -459,6 +490,7 @@ class CachingService extends cds.Service {
             switch (keyOrObject.constructor.name) {
                 case "Request":
                 case "NoaRequest":
+                case "ODataRequest":
 
                     return this.createCacheKey((!options.value && !options.template) ? { template: '{tenant}:{user}:{locale}:{hash}' } : options, {
                         req: keyOrObject,

package/srv/util.js

@@ -24,7 +24,7 @@ const bindFunction = async (service, action, isBound = false) => {
             const cache = await cds.connect.to(action['@cache.service'] || "caching");
             const data = await cache.run(req, next, { 
                 ttl: action['@cache.ttl'], 
-                tags: extractCacheProperties(action, 'tags'),
+                tags: action['@cache.tags'], 
                 key: extractCacheProperties(action, 'key')
             });
             return data;
@@ -37,9 +37,11 @@ const bindEntity = async (service, entity) => {
         service.on('READ', entity.name, async (req, next) => {
             const cache = await cds.connect.to(entity['@cache.service'] || "caching");
 
+            console.log(entity);
+
             const data = await cache.run(req, next, {
                 ttl: entity['@cache.ttl'], 
-                tags: extractCacheProperties(entity, 'tags'),
+                tags: entity['@cache.tags'], 
                 key: extractCacheProperties(entity, 'key')
             });
             return data;