@cap-js-community/common 0.2.2 → 0.2.4

package/CHANGELOG.md

@@ -0,0 +1,87 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## Version 0.2.4 - 2025-07-03
+
+### Fixed
+
+- Multi-tenancy fixes
+- Improve reference detection
+- Deactivate TTL for negative value and static entities
+
+## Version 0.2.3 - 2025-07-01
+
+### Fixed
+
+- Improve reference detection
+
+## Version 0.2.2 - 2025-06-26
+
+### Fixed
+
+- Improve reference detection for aliases
+
+## Version 0.2.1 - 2025-06-26
+
+### Fixed
+
+- Improve reference detection
+- Static non-tenant aware replication via `cds.replicate.static`
+
+## Version 0.2.0 - 2025-06-03
+
+### Fixed
+
+- CDS 9 compatibility
+
+## Version 0.1.7 - 2025-05-08
+
+### Fixed
+
+- Enabling journal mode and changing entity in same cycle is not allowed
+
+## Version 0.1.6 - 2025-05-07
+
+### Fixed
+
+- Redis 4
+
+## Version 0.1.5 - 2025-05-05
+
+### Fixed
+
+- Dependencies
+
+## Version 0.1.4 - 2025-04-10
+
+### Fixed
+
+- Improvements
+
+## Version 0.1.3 - 2025-04-10
+
+### Fixed
+
+- Redis client improvements
+
+## Version 0.1.2 - 2025-04-09
+
+### Fixed
+
+- Improvements
+
+## Version 0.1.1 - 2025-04-09
+
+### Fixed
+
+- Improvements
+
+## Version 0.1.0 - 2025-04-09
+
+### Added
+
+- Internal release

package/README.md

@@ -121,6 +121,7 @@ Options can be passed to migration check via CDS environment via `cds.migrationC
 
 - Maintain the whitelist extension file `migration-extension-whitelist.json` for compatible changes:
   - **Whitelist Entity**:
+
   ```json
   {
     "definitions": {
@@ -128,7 +129,9 @@ Options can be passed to migration check via CDS environment via `cds.migrationC
     }
   }
   ```
+
   - **Whitelist Entity Element**:
+
   ```json
   {
     "definitions": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/common",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "CAP Node.js Community Common",
   "homepage": "https://cap.cloud.sap/",
   "engines": {
@@ -20,7 +20,8 @@
     "bin",
     "src",
     "LICENSE",
-    "cds-plugin.js"
+    "cds-plugin.js",
+    "CHANGELOG.md"
   ],
   "main": "index.js",
   "types": "index.d.ts",
@@ -44,7 +45,7 @@
     "audit": "npm audit --only=prod"
   },
   "dependencies": {
-    "@cap-js/sqlite": "^2.0.1",
+    "@cap-js/sqlite": "^2.0.2",
     "commander": "^14.0.0",
     "redis": "^4.7.1",
     "verror": "^1.10.1"
@@ -52,17 +53,17 @@
   "devDependencies": {
     "@cap-js-community/common": "./",
     "@cap-js/cds-test": "^0.4.0",
-    "@sap/cds": "^9.0.4",
+    "@sap/cds": "^9.1.0",
     "@sap/cds-common-content": "^3.0.1",
-    "@sap/cds-dk": "^9.0.5",
-    "eslint": "9.29.0",
+    "@sap/cds-dk": "^9.1.0",
+    "eslint": "9.30.1",
     "eslint-config-prettier": "10.1.5",
     "eslint-plugin-jest": "29.0.1",
     "eslint-plugin-n": "^17.20.0",
-    "jest": "30.0.3",
+    "jest": "30.0.4",
     "jest-html-reporters": "3.1.7",
     "jest-junit": "16.0.0",
-    "prettier": "3.6.1",
+    "prettier": "3.6.2",
     "shelljs": "^0.10.0"
   },
   "cds": {

package/src/replication-cache/ReplicationCache.js

@@ -73,10 +73,14 @@ class ReplicationCache {
             this.options?.credentials?.database &&
             this.options?.credentials?.database !== Constants.InMemory
           ) {
-            this.log.debug("Preparing replication cache template database");
-            this.template = createDB(Tenant.Template, this.model, this.options).catch((err) => {
-              this.log.error("Preparing replication cache failed", err);
-            });
+            this.log.info("Preparing replication cache template database");
+            this.template = createDB(Tenant.Template, this.model, this.options)
+              .then(() => {
+                this.log.info("Prepared replication cache template database");
+              })
+              .catch((err) => {
+                this.log.error("Preparing replication cache failed", err);
+              });
           }
         }
       }
@@ -178,7 +182,7 @@ class ReplicationCache {
       if (fromRefs.length === 0 || !this.relevant(fromRefs)) {
         return await next();
       }
-      let refs = queryRefs(model, req.query);
+      let refs = queryRefs(model, req.query, req.target);
       if (!this.options.deploy) {
         if (!this.localized(req.query, refs)) {
           return await next();
@@ -220,9 +224,17 @@ class ReplicationCache {
         if (this.options.measure) {
           return this.measure(
             async () => {
-              return db.tx({ ...req.context }, async (tx) => {
-                return tx.run(req.query);
-              });
+              return db.tx(
+                {
+                  tenant: req.context.tenant,
+                  locale: req.context.locale,
+                  user: req.context.user,
+                  http: req.context.http,
+                },
+                async (tx) => {
+                  return tx.run(req.query);
+                },
+              );
             },
             async () => {
               await next();
@@ -585,6 +597,7 @@ class ReplicationCacheEntry {
     this.db = tenant.db;
     this.ref = ref;
     this.definition = this.csn[ref];
+    this.static = !!this.definition[Annotations.ReplicateStatic];
     this.preload = this.cache.options.preload && this.definition[Annotations.ReplicatePreload];
     this.name = this.definition.name.replace(/\./gi, "_");
     this.status = Status.New;
@@ -614,13 +627,15 @@ class ReplicationCacheEntry {
             await this.load(thread);
             this.status = Status.Ready;
             this.failures = 0;
-            this.timeout = setTimeout(async () => {
-              this.cache.log.debug("Replication cache ref TTL reached", {
-                tenant: this.tenant.id,
-                ref: this.ref,
-              });
-              await this.clear(true);
-            }, this.ttl).unref();
+            if (this.ttl > 0 && !this.static) {
+              this.timeout = setTimeout(async () => {
+                this.cache.log.debug("Replication cache ref TTL reached", {
+                  tenant: this.tenant.id,
+                  ref: this.ref,
+                });
+                await this.clear(true);
+              }, this.ttl).unref();
+            }
           }
           this.cache.log.debug("Preparing replication cache ref finished", {
             tenant: this.tenant.id,
@@ -779,7 +794,11 @@ async function createDB(tenant, model, options) {
   const db = new SQLiteService(tenant ?? Tenant.Default, model, {
     kind: "sqlite",
     impl: "@cap-js/sqlite",
-    credentials: { ...options.credentials, database: filePath },
+    multiTenant: false,
+    credentials: {
+      ...options.credentials,
+      database: filePath,
+    },
   });
   await db.init();
   if (options.deploy && (filePath === Constants.InMemory || tenant === Tenant.Template)) {
@@ -818,13 +837,18 @@ function baseRefs(model, refs) {
   const baseRefs = [];
   let currentRefs = refs;
   let nextRefs = [];
+  const visited = new Set();
   while (currentRefs.length > 0) {
     for (const ref of currentRefs) {
+      if (visited.has(ref)) {
+        continue;
+      }
+      visited.add(ref);
       const definition = model.definitions[ref];
       if (!definition.query) {
         baseRefs.push(ref);
       } else {
-        nextRefs = nextRefs.concat(queryRefs(model, definition.query));
+        nextRefs = nextRefs.concat(queryRefs(model, definition.query, definition));
       }
     }
     currentRefs = nextRefs;
@@ -853,33 +877,61 @@ function queryFromRefs(model, query) {
   return unique(selectFromRefs(model, query));
 }
 
-function queryRefs(model, query) {
+function queryRefs(model, query, definition) {
   if (!query.SELECT) {
     return [];
   }
-  return unique(selectRefs(model, query));
+  return unique(selectRefs(model, definition, query));
 }
 
 function selectFromRefs(model, query) {
   let refs = [];
-  if (query.SELECT.from.SELECT) {
-    refs = selectFromRefs(model, query.SELECT.from);
-  } else if (query.SELECT.from.ref) {
+  if (query.SELECT.from.ref) {
     refs = resolveRefs(model, query.SELECT.from.ref);
-  } else if ((query.SELECT.from.join || query.SELECT.from.SET) && query.SELECT.from.args) {
-    refs = query.SELECT.from.args.reduce((refs, arg) => {
-      refs = refs.concat(resolveRefs(model, arg.ref || arg));
-      return refs;
-    }, []);
+  } else if (query.SELECT.from.args) {
+    for (const arg of query.SELECT.from.args) {
+      if (arg.ref) {
+        refs = refs.concat(resolveRefs(model, arg.ref));
+      } else if (arg.args) {
+        refs = refs.concat(selectFromRefs(model, { SELECT: { from: { args: arg.args } } }));
+      }
+    }
+  } else if (query.SELECT.from.SET?.args) {
+    for (const arg of query.SELECT.from.SET.args) {
+      refs = refs.concat(selectFromRefs(model, arg));
+    }
+  } else if (query.SELECT.from.SELECT) {
+    refs = selectFromRefs(model, query.SELECT.from);
   }
   return refs;
 }
 
-function selectFromAliases(model, query) {
+function selectFromPrimaryRef(model, query) {
+  if (query.SELECT.from.ref) {
+    return resolveRef(model, query.SELECT.from.ref);
+  } else if (query.SELECT.from.args) {
+    for (const arg of query.SELECT.from.args) {
+      if (arg.ref) {
+        return resolveRef(model, arg.ref);
+      } else if (arg.args) {
+        return selectFromPrimaryRef(model, { SELECT: { from: { args: arg.args } } });
+      }
+    }
+  } else if (query.SELECT.from.SET?.args) {
+    for (const arg of query.SELECT.from.SET.args) {
+      return selectFromPrimaryRef(model, arg);
+    }
+  } else if (query.SELECT.from.SELECT) {
+    return selectFromPrimaryRef(model, query.SELECT.from);
+  }
+}
+
+function selectFromAliases(model, definition, query) {
   let aliases = {};
-  if (query.SELECT.from.SELECT) {
-    // Sub-select aliases are not (yet) supported
-  } else if (query.SELECT.from.ref) {
+  if (definition?.name) {
+    aliases["$self"] = definition.name;
+  }
+  if (query.SELECT.from.ref) {
     const ref = resolveRef(model, query.SELECT.from.ref);
     if (query.SELECT.from.as) {
       aliases[query.SELECT.from.as] = ref;
@@ -887,39 +939,84 @@ function selectFromAliases(model, query) {
       const as = ref.split(".").pop();
       aliases[as] = ref;
     }
-  } else if ((query.SELECT.from.join || query.SELECT.from.SET) && query.SELECT.from.args) {
+  } else if (query.SELECT.from.args) {
     for (const arg of query.SELECT.from.args) {
-      const ref = resolveRef(model, arg.ref);
-      if (arg.as) {
-        aliases[arg.as] = ref;
-      } else {
-        const as = ref.split(".").pop();
-        aliases[as] = ref;
+      if (arg.ref) {
+        const ref = resolveRef(model, arg.ref);
+        if (arg.as) {
+          aliases[arg.as] = ref;
+        } else {
+          const as = ref.split(".").pop();
+          aliases[as] = ref;
+        }
+      } else if (arg.args) {
+        aliases = {
+          ...aliases,
+          ...selectFromAliases(model, definition, { SELECT: { from: { args: arg.args } } }),
+        };
       }
     }
+  } else if (query.SELECT.from.SET?.args) {
+    for (const arg of query.SELECT.from.SET.args) {
+      aliases = {
+        ...aliases,
+        ...selectFromAliases(model, definition, arg),
+      };
+    }
+  } else if (query.SELECT.from.SELECT) {
+    aliases = {
+      ...aliases,
+      ...selectFromAliases(model, definition, query.SELECT.from),
+    };
   }
   return aliases;
 }
 
-function selectRefs(model, query) {
-  let refs = selectFromRefs(model, query);
-  const aliases = selectFromAliases(model, query);
-  if (query._target) {
-    const target = model.definitions[query._target.name];
-    if (query.SELECT.orderBy) {
-      refs = refs.concat(expressionRefs(model, target, query.SELECT.orderBy, query.SELECT.mixin, aliases));
-    }
-    if (query.SELECT.columns) {
-      refs = refs.concat(expressionRefs(model, target, query.SELECT.columns, query.SELECT.mixin, aliases));
-      refs = refs.concat(expandRefs(model, target, query.SELECT.columns, query.SELECT.mixin, aliases));
-    }
-    if (query.SELECT.where) {
-      refs = refs.concat(expressionRefs(model, target, query.SELECT.where, query.SELECT.mixin, aliases));
-    }
-    if (query.SELECT.having) {
-      refs = refs.concat(expressionRefs(model, target, query.SELECT.having, query.SELECT.mixin, aliases));
+function selectOuterAliases(model, target, columns, mixins, aliases) {
+  const outerAliases = {};
+  if (columns) {
+    for (const column of columns) {
+      if (column.ref) {
+        const as = column.as || column.ref[column.ref.length - 1];
+        let current = target;
+        for (const ref of column.ref) {
+          const currentTarget = targetEntity(model, current, mixins, aliases, ref);
+          if (currentTarget != null) {
+            current = currentTarget;
+          }
+        }
+        outerAliases[as] = (current || target).name;
+      }
     }
   }
+  return outerAliases;
+}
+
+function selectRefs(model, definition, query, aliases) {
+  let targetName = selectFromPrimaryRef(model, query);
+  const target = targetName ? model.definitions[targetName] : undefined;
+  let refs = selectFromRefs(model, query);
+  aliases = {
+    ...aliases,
+    ...selectFromAliases(model, definition, query),
+  };
+  if (query.SELECT.columns) {
+    refs = refs.concat(expressionRefs(model, target, query.SELECT.columns, query.SELECT.mixin, aliases));
+    refs = refs.concat(expandRefs(model, target, query.SELECT.columns, query.SELECT.mixin, aliases));
+  }
+  if (query.SELECT.where) {
+    refs = refs.concat(expressionRefs(model, target, query.SELECT.where, query.SELECT.mixin, aliases));
+  }
+  const outerAliases = {
+    ...aliases,
+    ...selectOuterAliases(model, target, query.SELECT.columns, query.SELECT.mixin, aliases),
+  };
+  if (query.SELECT.having) {
+    refs = refs.concat(expressionRefs(model, target, query.SELECT.having, query.SELECT.mixin, outerAliases));
+  }
+  if (query.SELECT.orderBy) {
+    refs = refs.concat(expressionRefs(model, target, query.SELECT.orderBy, query.SELECT.mixin, outerAliases));
+  }
   return refs;
 }
 
@@ -965,11 +1062,14 @@ function identifierRefs(model, definition, expressions, mixins, aliases) {
       let current = definition;
       let currentMixins = mixins;
       for (const ref of expression.ref) {
-        current = target(model, current, currentMixins, aliases, ref);
-        if (current !== null) {
-          currentMixins = {};
+        if (current?.name !== definition?.name) {
           refs.push(current.name);
         }
+        if (ref.startsWith("$")) {
+          break;
+        }
+        current = targetEntity(model, current, currentMixins, aliases, ref);
+        currentMixins = {};
       }
     }
   }
@@ -984,7 +1084,12 @@ function expressionRefs(model, definition, expressions, mixins, aliases) {
     } else if (expression.args) {
       refs = refs.concat(expressionRefs(model, definition, expression.args, mixins, aliases));
     } else if (expression.SELECT) {
-      refs = refs.concat(selectRefs(model, expression));
+      refs = refs.concat(
+        selectRefs(model, undefined, expression, {
+          ...aliases,
+          ["$self"]: undefined,
+        }),
+      );
     }
   }
   return refs;
@@ -997,7 +1102,7 @@ function expandRefs(model, definition, columns, mixins, aliases) {
       let current = definition;
       let currentMixins = mixins;
       for (const ref of column.ref) {
-        current = target(model, current, currentMixins, aliases, ref);
+        current = targetEntity(model, current, currentMixins, aliases, ref);
         currentMixins = {};
         refs.push(current.name);
       }
@@ -1007,17 +1112,17 @@ function expandRefs(model, definition, columns, mixins, aliases) {
   return refs;
 }
 
-function target(model, entity, mixins, aliases, ref) {
+function targetEntity(model, entity, mixins, aliases, ref) {
   if (aliases?.[ref]) {
     return typeof aliases[ref] === "string" ? model.definitions[aliases[ref]] : aliases[ref];
   }
-  if (entity.name.endsWith(`.${ref}`)) {
+  if (entity?.name.endsWith(`.${ref}`)) {
     return entity;
   }
-  const element = entity.elements[ref] || mixins?.[ref];
+  const element = entity?.elements[ref] || mixins?.[ref];
   if (!element) {
     cds.log(Component).warn("Reference not found in entity", {
-      entity: entity.name,
+      entity: entity?.name,
       ref,
     });
   }