cds-caching 0.3.0 → 0.3.2

package/README.md

@@ -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 Apache License 2.0 - 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.0",
+  "version": "0.3.2",
   "description": "A caching plugin for SAP CAP applications supporting Redis",
   "repository": {
     "type": "git",

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;
@@ -74,6 +74,9 @@ class CachingService extends cds.Service {
             if (typeof event.data.value === "object") {
                 event.data.value = JSON.stringify(event.data.value);
             }
+
+            console.log(event.data);
+
             await this.cache.set(event.data.key, event.data.value, (event.data.ttl || 0))
         });
 
@@ -239,7 +242,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 +262,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 +396,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 => {

package/srv/util.js

@@ -1,5 +1,20 @@
 const cds = require("@sap/cds")
 
+const extractCacheProperties = (entity, prefix) => {
+    const result = {};
+    for (const key of Object.keys(entity)) {
+        if (key.startsWith(`@cache.${prefix}.`)) {
+            const subKey = key.substring(`@cache.${prefix}.`.length);
+            result[subKey] = entity[key];
+        }
+    }
+    // If there are no subproperties but the main property exists, use it directly
+    if (Object.keys(result).length === 0 && entity[`@cache.${prefix}`]) {
+        return entity[`@cache.${prefix}`];
+    }
+    return Object.keys(result).length > 0 ? result : undefined;
+};
+
 const bindFunction = async (service, action, isBound = false) => {
     const cache = await cds.connect.to(action['@cache.service'] || "caching");
     cache.addCachableFunction(action.name.split('.').pop(), action, isBound);
@@ -9,8 +24,8 @@ 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: action['@cache.tags'],
-                key: action['@cache.key']
+                tags: action['@cache.tags'], 
+                key: extractCacheProperties(action, 'key')
             });
             return data;
         })
@@ -21,10 +36,13 @@ const bindEntity = async (service, entity) => {
     service.prepend(function () {
         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: entity['@cache.tags'],
-                key: entity['@cache.key']
+                tags: entity['@cache.tags'], 
+                key: extractCacheProperties(entity, 'key')
             });
             return data;
         })