@sap/cds-compiler 2.4.4 → 2.10.2

package/lib/base/model.js

@@ -19,7 +19,6 @@ const queryOps = {
  */
 const availableBetaFlags = {
   // enabled by --beta-mode
-  keylessManagedAssoc: true,
   foreignKeyConstraints: true,
   toRename: true,
   addTextsLanguageAssoc: true,
@@ -28,9 +27,9 @@ const availableBetaFlags = {
   mapAssocToJoinCardinality: true,
   ignoreAssocPublishingInUnion: true,
   nestedProjections: true,
+  enableUniversalCsn: true,
+  windowFunctions: true,
   // disabled by --beta-mode
-  pretransformedCSN: false,
-  renderSQL: false,
   nestedServices: false,
 };
 
@@ -181,63 +180,6 @@ function setProp (obj, prop, value) {
   return value;
 }
 
-// FIXME: this function is only used by old tests -- REMOVE!
-//
-// Clone 'node', transforming nodes therein recursively. Object 'transformers' is expected
-// to contain a mapping of property 'key' names to transformer functions. The node's properties
-// are walked recursively, calling each transformer function on its corresponding property
-// 'key' of 'node', replacing 'value' in 'resultNode' with the function's return value
-// (returning 'undefined' will delete the property).
-// If no transformation function is found for 'key', the first letter of 'key' is tried
-// instead (this seems to be intended for handling annotations that start with '@' ?)
-// FIXME: Do we really need this ?
-// If `withArtifactLink` is set, the `_artifact` links of `node` are copied too (not cloned,
-// of course).
-// Regardless of their names, transformers are never applied to dictionary elements.
-//
-// The transformer functions are called with the following signature:
-//   transformer(value, node, resultNode, key)
-function cloneWithTransformations(node, transformers, withArtifactLink) {
-
-  return transformNode(node);
-
-  // This general transformation function will be applied to each node recursively
-  function transformNode(node) {
-    // Return primitive values and null unchanged, but let objects and dictionaries through
-    // (Note that 'node instanceof Object' would be false for dictionaries).
-    if (node === null || typeof node !== 'object') {
-      return node
-    }
-    // Simply return if node is to be ignored
-    if (node._ignore)
-      return undefined;
-    // Transform arrays element-wise
-    if (Array.isArray(node)) {
-      return node.map(transformNode);
-    }
-    // Things not having 'proto' are dictionaries
-    const proto = Object.getPrototypeOf(node);
-    // Iterate own properties of 'node' and transform them into 'resultNode'
-    const resultNode = Object.create(proto);
-    for (let key of Object.keys(node)) {
-      // Dictionary always use transformNode(), other objects their transformer according to key
-      const transformer = !proto ? transformNode : transformers[key] || transformers[key.charAt(0)];
-      // Apply transformer, or use transformNode() if there is none
-      const resultValue = (transformer || transformNode)(node[key], node, resultNode, key);
-      if (resultValue !== undefined) {
-        resultNode[key] = resultValue;
-      }
-    }
-    // For non-dictionaries, take over `_artifact` if requested
-    if (withArtifactLink && proto) {
-      let pd = Object.getOwnPropertyDescriptor(node, '_artifact')
-      if (pd)
-        Object.defineProperty(resultNode, '_artifact', pd);
-    }
-    return resultNode;
-  }
-}
-
 
 module.exports = {
   isBetaEnabled,
@@ -252,5 +194,4 @@ module.exports = {
   forEachGeneric,
   forEachInOrder,
   setProp,
-  cloneWithTransformations,
 };

package/lib/checks/arrayOfs.js

@@ -48,7 +48,6 @@ function validateAssociationsInItems(member) {
  *
  * @param {CSN.Artifact} art Artifact
  * @param {string} artName Name of the artifact
- *
  */
 function checkChainedArray(art, artName) {
   if (!this.csnUtils.getServiceName(artName))

package/lib/checks/defaultValues.js

@@ -35,8 +35,33 @@ function validateDefaultValues(member, memberName, prop, path) {
  * @param {CSN.Path} path Path to the member
  */
 function rejectParamDefaultsInHanaCds(member, memberName, prop, path) {
-  if (member.default && prop === 'params' && this.options.toHana)
+  if (member.default && prop === 'params' && this.options.transformation === 'hdbcds')
     this.error(null, path, 'Parameter default values are not supported in SAP HANA CDS');
 }
 
-module.exports = { validateDefaultValues, rejectParamDefaultsInHanaCds };
+/**
+ * For HANA CDS, we render a default for a mixin if the projected entity contains
+ * a derived association with a default defined on it. This leads to a deployment error
+ * and should be warned about.
+ *
+ * @param {CSN.Element} member Member to validate
+ * @param {string} memberName Name of the member
+ * @param {string} prop Property being looped over
+ * @param {CSN.Path} path Path to the member
+ */
+function warnAboutDefaultOnAssociationForHanaCds(member, memberName, prop, path) {
+  const art = this.csn.definitions[path[1]];
+  if (!art.query && this.options.transformation === 'hdbcds' && member.target && member.default) {
+    this.warning(null, path, { '#': member._type.type === 'cds.Association' ? 'std' : 'comp' },
+                 {
+                   std: 'Unexpected default defined on association',
+                   comp: 'Unexpected default defined on composition',
+                 });
+  }
+}
+
+module.exports = {
+  validateDefaultValues,
+  rejectParamDefaultsInHanaCds,
+  warnAboutDefaultOnAssociationForHanaCds,
+};

package/lib/checks/elements.js

@@ -2,7 +2,6 @@
 
 const { forEachMember, forEachMemberRecursively } = require('../model/csnUtils');
 const { isGeoTypeName } = require('../compiler/builtins');
-const { isBetaEnabled } = require('../base/model');
 
 // Only to be used with validator.js - a correct `this` value needs to be provided!
 
@@ -103,15 +102,11 @@ function checkVirtualElement(member) {
  * @param {CSN.Artifact} art The artifact
  */
 function checkManagedAssoc(art) {
-  forEachMemberRecursively(art, (member, memberName) => {
+  forEachMemberRecursively(art, (member) => {
     if (this.csnUtils.isAssocOrComposition(member.type) &&
         !isManagedComposition.bind(this)(member)) {
       if (member.on)
         return;
-      if (!isBetaEnabled(this.options, 'keylessManagedAssoc') && (!member.keys || member.keys.length === 0)) {
-        this.error(null, member.$path, { name: memberName },
-                   `The managed association $(NAME) has no foreign keys`);
-      }
       const max = member.cardinality && member.cardinality.max;
       if (max === '*' || Number(max) > 1) {
         const isNoDb = art['@cds.persistence.skip'] || art['@cds.persistence.exists'];

package/lib/checks/enricher.js

@@ -31,7 +31,7 @@ function enrichCsn( csn ) {
     target: simpleRef,
     includes: simpleRef,
     // Annotations are ignored.
-    '@': () => {},
+    '@': () => { /* ignore annotations */ },
   };
   let cleanupCallbacks = [];
 
@@ -103,7 +103,9 @@ function enrichCsn( csn ) {
 
   // eslint-disable-next-line jsdoc/require-jsdoc
   function pathRef( node, prop, path ) {
-    const { links, art, scope } = inspectRef( csnPath );
+    const {
+      links, art, scope, $env,
+    } = inspectRef( csnPath );
     if (links) {
       setProp(node, '_links', links);
       cleanupCallbacks.push(() => delete node._links);
@@ -112,6 +114,10 @@ function enrichCsn( csn ) {
       setProp(node, '_art', art );
       cleanupCallbacks.push(() => delete node._art);
     }
+    if ($env) {
+      setProp(node, '$env', $env );
+      cleanupCallbacks.push(() => delete node.$env);
+    }
     setProp(node, '$scope', scope);
     cleanupCallbacks.push(() => delete node.$scope);
     setProp(node, '$path', [ ...csnPath ]);

package/lib/checks/foreignKeys.js

@@ -1,7 +1,5 @@
 'use strict';
 
-const { isBetaEnabled } = require('../base/model');
-
 // Only to be used with validator.js - a correct this value needs to be provided!
 
 /**
@@ -20,17 +18,13 @@ function validateForeignKeys(member) {
 
   // Declared as arrow-function to keep scope the same (this value)
   const handleAssociation = (mem) => {
-    let elementCount = 0;
     for (let i = 0; i < mem.keys.length; i++) {
       if (mem.keys[i].ref) {
         if (!mem.keys[i]._art)
           continue;
         // eslint-disable-next-line no-use-before-define
         checkForItems(mem.keys[i]._art);
-        elementCount++;
       }
-      if (!isBetaEnabled(this.options, 'keylessManagedAssoc') && elementCount === 0)
-        this.error(null, member.$path, 'Empty structured types/elements must not be used as foreign keys');
     }
   };
 

package/lib/checks/managedWithoutKeys.js

@@ -0,0 +1,17 @@
+'use strict';
+
+
+/**
+ * Trigger a recompilation in case of an association without .keys and without .on
+ *
+ * @param {CSN.Element} member the element to be checked
+ * @param {string} memberName the elements name
+ * @param {string} prop which kind of member are we looking at -> only prop "elements"
+ */
+function managedWithoutKeys(member, memberName, prop) {
+  if (prop === 'elements' && member.target && !member.keys && !member.on) { // trigger recompilation
+    throw new Error('Expected association to have either an on-condition or foreign keys.');
+  }
+}
+
+module.exports = managedWithoutKeys;

package/lib/checks/nonexpandableStructured.js

@@ -0,0 +1,38 @@
+'use strict';
+
+const { otherSideIsExpandableStructure, resolveArtifactType } = require('./utils');
+
+/**
+ * Check the given expression for non-expandable structure usage
+ *
+ * @param {object} parent Object with the expression as a property
+ * @param {string} name Name of the expression property on parent
+ * @param {Array} expression Expression to check - .on .xpr .having and .where
+ */
+function nonexpandableStructuredInExpression(parent, name, expression) {
+  for (let i = 0; i < expression.length; i++) {
+    if (expression[i].ref) {
+      const { ref } = expression[i];
+      // eslint-disable-next-line prefer-const
+      let { _art, $scope } = expression[i];
+      if (!_art)
+        continue;
+      const validStructuredElement = otherSideIsExpandableStructure.call(this, expression, i);
+      if (_art) {
+        _art = resolveArtifactType.call(this, _art);
+        // Paths of an expression may end on a structured element only if both operands in the expression end on a structured element
+        if (_art.elements && !validStructuredElement && $scope !== '$self') { // TODO: Use $self to navigate to struct
+          this.error(null, expression[i].$path, { elemref: { ref } },
+                     'Unexpected usage of structured type $(ELEMREF)');
+        }
+      }
+    }
+  }
+}
+
+module.exports = {
+  on: nonexpandableStructuredInExpression,
+  having: nonexpandableStructuredInExpression,
+  where: nonexpandableStructuredInExpression,
+  xpr: nonexpandableStructuredInExpression,
+};

package/lib/checks/onConditions.js

@@ -1,6 +1,7 @@
 'use strict';
 
-const { forEachGeneric, isBuiltinType } = require('../model/csnUtils');
+const { forEachGeneric } = require('../model/csnUtils');
+const { otherSideIsExpandableStructure, resolveArtifactType } = require('./utils');
 
 // Only to be used with validator.js - a correct this value needs to be provided!
 
@@ -42,48 +43,6 @@ function otherSideIsValidDollarSelf(on, startIndex) {
   return false;
 }
 
-/**
- * Check that the opposite operand to a relational term is something
- * structured that can be used for tuple expansion. This can either be a
- * real 'elements' thing or a managed association/composition with foreign keys.
- *
- * @param {Array} on the on condition which to check
- * @param {number} startIndex the index of the relational term in the on condition array
- * @returns {boolean} indicates whether the other side of a relational term is expandable
- */
-function otherSideIsExpandableStructure(on, startIndex) {
-  if (on[startIndex - 1] && [ '=', '<', '>', '>=', '<=', '!=', '<>' ].includes(on[startIndex - 1]))
-    return isOk(resolveArtifactType.call(this, on[startIndex - 2]._art));
-
-  else if (on[startIndex + 1] && [ '=', '<', '>', '>=', '<=', '!=', '<>' ].includes(on[startIndex + 1]))
-    return isOk(resolveArtifactType.call(this, on[startIndex + 2]._art));
-
-  return false;
-
-  /**
-   * Artifact is structured or a managed association/compoisition
-   *
-   * @param {CSN.Artifact} art Artifact
-   * @returns {boolean} True if expandable
-   */
-  function isOk(art) {
-    return !!(art && (art.elements || (art.target && art.keys)));
-  }
-}
-
-/**
- * Get the real type of an artifact
- *
- * @param {object} art Whatever _art by csnRefs can be - element or artifact
- * @returns {object} final artifact type
- */
-function resolveArtifactType(art) {
-  if (art && art.type && !isBuiltinType(art.type))
-    return this.getFinalBaseType(art);
-
-  return art;
-}
-
 /**
  * Validate an on-condition
  *
@@ -100,6 +59,11 @@ function resolveArtifactType(art) {
  */
 function validateOnCondition(member, memberName, property, path) {
   if (member && member.on) {
+    // complain about nullability constraint on managed composition
+    if (member.targetAspect && {}.hasOwnProperty.call(member, 'notNull')) {
+      this.warning(null, path.concat([ 'on' ]),
+                   'Unexpected nullability constraint defined on managed composition');
+    }
     for (let i = 0; i < member.on.length; i++) {
       if (member.on[i].ref) {
         const { ref } = member.on[i];
@@ -148,8 +112,8 @@ function validateOnCondition(member, memberName, property, path) {
           // 2) Path ends on an association (managed or unmanaged) and the other operand is a '$self'
 
           // If this path ends structured or on an association, perform the check:
-          if ((_art.elements || _art.target) &&
-             !( /* 1) */ (_art.elements || _art.target && _art.keys) && validStructuredElement ||
+          if ((_art.target) &&
+             !( /* 1) */ (_art.target && _art.keys) && validStructuredElement ||
              /* 2) */ (_art.target && validDollarSelf)) &&
              !_art.virtual) {
             this.error(null, onPath, { elemref: { ref } },

package/lib/checks/queryNoDbArtifacts.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { hasBoolAnnotation, isPersistedOnDatabase, isBuiltinType } = require('../model/csnUtils');
+const { hasAnnotationValue, isPersistedOnDatabase, isBuiltinType } = require('../model/csnUtils');
 /**
  * Make sure that all source artifacts and association targets reach the database
  * (otherwise the view can't be activated), but only if the source artifact is NOT activated against the database
@@ -69,13 +69,31 @@ function checkQueryForNoDBArtifacts(query) {
       const pathStep = obj.ref[i].id ? obj.ref[i].id : obj.ref[i];
       const name = art.target ? art.target : pathStep;
       if (!isPersistedOnDatabase(endArtifact)) {
-        const cdsPersistenceSkipped = hasBoolAnnotation(endArtifact, '@cds.persistence.skip');
-        this.error( null, obj.$path, {
-          id: pathStep, elemref: obj, name, '#': cdsPersistenceSkipped ? 'std' : 'abstract',
-        }, {
-          std: 'Unexpected “@cds.persistence.skip” annotation on association target $(NAME) of $(ID) in path $(ELEMREF)',
-          abstract: 'Unexpected “abstract” association target $(NAME) of $(ID) in path $(ELEMREF)',
-        } );
+        const nextElement = obj.ref[i + 1];
+        /**
+         * if we only navigate to foreign keys of the managed association in a view, we do not need to join,
+         * thus we can produce the view even if the target of the association is not persisted
+         *
+         * @param {CSN.Element} assoc association in ref
+         * @param {string} nextStep the ref step following the association
+         * @returns {boolean} true if no join will be generated
+         */
+        const isJoinRelevant = (assoc, nextStep) => {
+          if (!assoc.keys)
+            return true;
+          const isExposedColumnAssocOrComposition = this.csnUtils.isAssocOrComposition(obj._art.type);
+          return !assoc.keys
+            .some(fk => fk.ref[0] === nextStep && !isExposedColumnAssocOrComposition);
+        };
+        if (isJoinRelevant(art, nextElement)) {
+          const cdsPersistenceSkipped = hasAnnotationValue(endArtifact, '@cds.persistence.skip');
+          this.error( null, obj.$path, {
+            id: pathStep, elemref: obj, name, '#': cdsPersistenceSkipped ? 'std' : 'abstract',
+          }, {
+            std: 'Unexpected “@cds.persistence.skip” annotation on association target $(NAME) of $(ID) in path $(ELEMREF)',
+            abstract: 'Unexpected “abstract” association target $(NAME) of $(ID) in path $(ELEMREF)',
+          } );
+        }
       }
       // check managed association to have foreign keys array filled
       if (art.keys && leafCount(art) === 0) {
@@ -101,7 +119,7 @@ function checkQueryForNoDBArtifacts(query) {
     }
   };
 
-  if (isPersistedOnDatabase(this.artifact) && !hasBoolAnnotation(this.artifact, '@cds.persistence.table')) {
+  if (isPersistedOnDatabase(this.artifact) && !hasAnnotationValue(this.artifact, '@cds.persistence.table')) {
     const generalQueryProperties = [ 'from', 'columns', 'where', 'groupBy', 'orderBy', 'having', 'limit' ];
     for (const prop of generalQueryProperties) {
       const queryPart = (query.SELECT || query.SET)[prop];

package/lib/checks/selectItems.js

@@ -11,7 +11,7 @@ const { forEachGeneric } = require('../model/csnUtils');
  */
 function validateSelectItems(query) {
   const { SELECT } = query;
-  if (!SELECT || !SELECT.columns)
+  if (!SELECT)
     return;
 
   forEachGeneric(SELECT, 'columns', (selectItem) => {
@@ -24,5 +24,28 @@ function validateSelectItems(query) {
       }
     }
   });
+  // .call() with 'this' to ensure we have access to the options
+  rejectManagedAssociationsAndStructuresForHdbcsNames.call(this, SELECT, SELECT.$path);
 }
-module.exports = validateSelectItems;
+
+
+/**
+ * For the to.hdbcds transformation with naming mode 'hdbcds', structures and managed associations are not flattened/resolved.
+ * It is therefore not possible to publish such elements in a view.
+ * This function iterates over all published elements of a query artifact and asserts that no such elements are published.
+ *
+ * @param {CSN.Artifact} queryArtifact the query artifact which should be checked
+ * @param {CSN.Path} artifactPath the path to that artifact
+ */
+function rejectManagedAssociationsAndStructuresForHdbcsNames(queryArtifact, artifactPath) {
+  if (this.options.transformation === 'hdbcds' && this.options.sqlMapping === 'hdbcds') {
+    forEachGeneric(queryArtifact, 'elements', (selectItem, elemName, prop, elementPath) => {
+      if (this.csnUtils.isManagedAssociationElement(selectItem))
+        this.error('query-unexpected-assoc-hdbcds', elementPath);
+      if (this.csnUtils.isStructured(selectItem))
+        this.error('query-unexpected-structure-hdbcds', elementPath);
+    }, artifactPath);
+  }
+}
+
+module.exports = { validateSelectItems, rejectManagedAssociationsAndStructuresForHdbcsNames };

package/lib/checks/types.js

@@ -1,9 +1,28 @@
 'use strict';
 
-const { getUtils, isBuiltinType } = require('../model/csnUtils');
+const { getUtils, isBuiltinType, hasAnnotationValue } = require('../model/csnUtils');
 
 // Only to be used with validator.js - a correct this value needs to be provided!
 
+/**
+ * Scale must not be 'variable' or 'floating'
+ *
+ * scale property is always propagated
+ *
+ * @param {CSN.Element} member the element to be checked
+ * @param {string} memberName the elements name
+ * @param {string} prop which kind of member are we looking at -> only prop "elements"
+ * @param {CSN.Path} path the path to the member
+ */
+function checkDecimalScale(member, memberName, prop, path) {
+  if (hasAnnotationValue(this.artifact, '@cds.persistence.exists') ||
+     // skip is already filtered in validator, here for completeness
+     hasAnnotationValue(this.artifact, '@cds.persistence.skip'))
+    return;
+  if (member.scale && [ 'variable', 'floating' ].includes(member.scale))
+    this.error(null, path, { name: member.scale }, 'Unexpected scale $(NAME)');
+}
+
 /**
  * View parameter for hana must be of scalar type
  *
@@ -165,4 +184,9 @@ function hasArtifactTypeInformation(artifact) {
     artifact.type;     // => `type A : [type of] Integer`
 }
 
-module.exports = { checkTypeDefinitionHasType, checkElementTypeDefinitionHasType, checkTypeIsScalar };
+module.exports = {
+  checkTypeDefinitionHasType,
+  checkElementTypeDefinitionHasType,
+  checkTypeIsScalar,
+  checkDecimalScale,
+};

package/lib/checks/unknownMagic.js

@@ -0,0 +1,38 @@
+'use strict';
+
+// We only care about the "wild" ones - $at is validated by the compiler
+const magicVariables = {
+  $user: [
+    'id',     // $user.id
+    'locale', // $user.locale
+  ],
+  $session: [
+    // no valid ways for this
+  ],
+};
+
+/**
+ * Check that the given ref does not use magic variables for which we don't have
+ * a valid way of rendering.
+ *
+ * Valid ways:
+ * - We know what to do -> $user.id on HANA
+ * - The user tells us what to do -> options.magicVars
+ *
+ * @param {object} parent Object with the ref as a property
+ * @param {string} name Name of the ref property on parent
+ * @param {Array} ref to check
+ */
+function unknownMagicVariable(parent, name, ref) {
+  if (parent.$scope && parent.$scope === '$magic') {
+    const [ head, ...rest ] = ref;
+    const tail = rest.join('.');
+    const magicVariable = magicVariables[head];
+    if (magicVariable && magicVariable.indexOf(tail) === -1)
+      this.error(null, parent.$location, { id: tail, elemref: parent }, 'Magic variable is not supported - path $(ELEMREF), step $(ID)');
+  }
+}
+
+module.exports = {
+  ref: unknownMagicVariable,
+};

package/lib/checks/utils.js

@@ -0,0 +1,61 @@
+'use strict';
+
+const { isBuiltinType } = require('../model/csnUtils');
+
+/**
+ * Prepare the ref steps so that they are loggable
+ *
+ * @param {any} refStep part of a ref
+ * @returns {string} Loggable string
+ */
+function logReady(refStep) {
+  return refStep.id || refStep;
+}
+
+/**
+ * Check that the opposite operand to a relational term is something
+ * structured that can be used for tuple expansion. This can either be a
+ * real 'elements' thing or a managed association/composition with foreign keys.
+ *
+ * @param {Array} on the on condition which to check
+ * @param {number} startIndex the index of the relational term in the on condition array
+ * @returns {boolean} indicates whether the other side of a relational term is expandable
+ */
+function otherSideIsExpandableStructure(on, startIndex) {
+  if (on[startIndex - 1] && [ '=', '<', '>', '>=', '<=', '!=', '<>' ].includes(on[startIndex - 1]))
+    return isOk(resolveArtifactType.call(this, on[startIndex - 2]._art));
+
+  else if (on[startIndex + 1] && [ '=', '<', '>', '>=', '<=', '!=', '<>' ].includes(on[startIndex + 1]))
+    return isOk(resolveArtifactType.call(this, on[startIndex + 2]._art));
+
+  return false;
+
+  /**
+   * Artifact is structured or a managed association/compoisition
+   *
+   * @param {CSN.Artifact} art Artifact
+   * @returns {boolean} True if expandable
+   */
+  function isOk(art) {
+    return !!(art && (art.elements || (art.target && art.keys)));
+  }
+}
+
+/**
+ * Get the real type of an artifact
+ *
+ * @param {object} art Whatever _art by csnRefs can be - element or artifact
+ * @returns {object} final artifact type
+ */
+function resolveArtifactType(art) {
+  if (art && art.type && !isBuiltinType(art.type))
+    return this.getFinalBaseType(art);
+
+  return art;
+}
+
+module.exports = {
+  logReady,
+  otherSideIsExpandableStructure,
+  resolveArtifactType,
+};