@sap/cds-compiler 3.9.4 → 3.9.8

package/CHANGELOG.md

@@ -7,6 +7,24 @@
 Note: `beta` fixes, changes and features are usually not listed in this ChangeLog but [here](doc/CHANGELOG_BETA.md).
 The compiler behavior concerning `beta` features can change at any time without notice.
 
+## Version 3.9.8 - 2023-08-03
+
+### Fixed
+
+- to.edm(x):
+  + Don't expand `@mandatory` if element has an annotation with prefix `@Common.FieldControl.`.
+  + Fix a bug when referencing nested many structures, especially referring to a managed association via
+  `$self` comparison.
+- to.sql/hdi/hdbcds: Detect navigation into arrayed structures and raise helpful errors instead of running into internal errors.
+
+## Version 3.9.6 - 2023-07-27
+
+### Fixed
+
+- to.edm(x): Revert change introduced with [3.9.0](#version-390---2023-04-20)
+    "Correct referential constraint calculation for `[0..1]` backlink associations".
+- for.odata: Process shortcut annotations sequence independent.
+
 ## Version 3.9.4 - 2023-06-07
 
 ### Fixed

package/lib/base/message-registry.js

@@ -116,6 +116,7 @@ const centralMessages = {
   'type-ambiguous-target': { severity: 'Warning' },
 
   'ref-autoexposed': { severity: 'Error', configurableFor: 'deprecated' },
+  'ref-unexpected-many-navigation': { severity: 'Error' },
   // Published! Used in @sap/cds-lsp; if renamed, add to oldMessageIds and contact colleagues
   'ref-undefined-art':    { severity: 'Error' },
   'ref-undefined-def':    { severity: 'Error' },
@@ -521,6 +522,9 @@ const centralMessageTexts = {
     std: '$(ART) can\'t be extended because it originates from an include',
     elements: '$(ART) can\'t be extended by elements/enums because it originates from an include',
   },
+  'ref-unexpected-many-navigation': {
+    std: 'Unexpected navigation into arrayed structure',
+  },
   'ref-unexpected-scope': {
     std: 'Unexpected parameter reference',
     calc: 'Calculated elements can\'t use parameter references',

package/lib/checks/manyNavigations.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const { applyTransformationsOnNonDictionary } = require('../model/csnUtils');
+
+/**
+ * Check all refs in the given parent for the traversal of paths
+ * into `.items`
+ *
+ * @param {object} parent Object with the expression as a property
+ * @param {string} propOnParent Name of the expression property on parent
+ * @param {Array} e Expression to check - see module.exports
+ * @param {CSN.Path} path
+ */
+function navigationIntoMany( parent, propOnParent, e, path ) {
+  applyTransformationsOnNonDictionary(parent, propOnParent, {
+    ref: (_parent, _prop, ref, _path) => {
+      const itemNavigationIndex = _parent._links?.findIndex(l => l.art.items);
+      if (itemNavigationIndex !== -1 && _parent.ref.length > itemNavigationIndex + 1)
+        this.message('ref-unexpected-many-navigation', _path);
+    },
+  }, { skipStandard: { type: true } }, path);
+}
+
+module.exports = {
+  columns: navigationIntoMany,
+  from: navigationIntoMany,
+  on: navigationIntoMany,
+  having: navigationIntoMany,
+  groupBy: navigationIntoMany,
+  orderBy: navigationIntoMany,
+  where: navigationIntoMany,
+  xpr: navigationIntoMany,
+};

package/lib/checks/validator.js

@@ -11,6 +11,7 @@ const enrich = require('./enricher');
 const { validateSelectItems } = require('./selectItems');
 const { rejectParamDefaultsInHanaCds, warnAboutDefaultOnAssociationForHanaCds } = require('./defaultValues');
 const validateCdsPersistenceAnnotation = require('./cdsPersistence');
+const navigationIntoMany = require('./manyNavigations');
 const checkUsedTypesForAnonymousAspectComposition = require('./managedInType');
 const validateHasPersistedElements = require('./hasPersistedElements');
 const checkForHanaTypes = require('./checkForTypes');
@@ -71,7 +72,7 @@ const forRelationalDBArtifactValidators
   checkSqlAnnotationOnArtifact,
 ];
 
-const forRelationalDBCsnValidators = [ nonexpandableStructuredInExpression ];
+const forRelationalDBCsnValidators = [ nonexpandableStructuredInExpression, navigationIntoMany ];
 /**
  * @type {Array<(query: CSN.Query, path: CSN.Path) => void>}
  */

package/lib/edm/edm.js

@@ -1118,7 +1118,7 @@ function getEdm(options, messageFunctions) {
             : undefined;
         if(partner && partner['@odata.navigable'] !== false && this._csn._edmParentCsn.kind !== 'type') {
           // $abspath[0] is main entity
-          this._edmAttributes.Partner = partner.$abspath.slice(1).join(options.pathDelimiter);
+          this._edmAttributes.Partner = partner.$abspath.slice(1).join('/');
         }
 
         /*
@@ -1217,13 +1217,16 @@ function getEdm(options, messageFunctions) {
     // V4 referential constraints!
     addReferentialConstraintNodes()
     {
+      // flip the constrains if this is a $self partner
       let _constraints = this._csn._constraints;
+      let [i,j] = [0,1];
       if(this._csn._constraints._partnerCsn) {
         _constraints = this._csn._constraints._partnerCsn._constraints;
+        [i,j] = [1,0];
       }
       _constraints.constraints && Object.values(_constraints.constraints).forEach(c =>
         this.append(new ReferentialConstraint(this._v,
-          { Property: c[0].join(options.pathDelimiter), ReferencedProperty: c[1].join(options.pathDelimiter) } ) )
+          { Property: c[i].join(options.pathDelimiter), ReferencedProperty: c[j].join(options.pathDelimiter) } ) )
       );
     }
   }

package/lib/edm/edmPreprocessor.js

@@ -657,9 +657,13 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
       env = env[ps];
       if (env && env.constructor === Object) {
         path.push(ps);
-        if(env.items)
+        // jump over many items but not if this is an element
+        if (env.items) {
           env = env.items;
-        if(env.type && !isBuiltinType(env.type) && !env.elements)
+          if (p[i + 1] === 'items')
+            i++;
+        }
+        if (env.type && !isBuiltinType(env.type) && !env.elements)
           env = csn.definitions[env.type];
       }
     }

package/lib/edm/edmUtils.js

@@ -764,14 +764,14 @@ function getBaseName(name) {
 }
 
 // This is a poor mans path resolver for $self partner paths only
-function resolveOriginAssoc(csn, env, path) {
-  for(const segment of path) {
-    let elements = (env.items && env.items.elements || env.elements);
-    if(elements)
-      env = env.elements[segment];
-    let type = (env.items && env.items.type || env.type);
-    if(type && !isBuiltinType(type) && !(env.items && env.items.elements || env.elements))
-      env = csn.definitions[env.type];
+function resolveOriginAssoc( csn, env, path ) {
+  for (const segment of path) {
+    const elements = (env?.items?.elements || env?.elements);
+    if (elements)
+      env = elements[segment];
+    const type = (env?.items?.type || env?.type);
+    if (type && !isBuiltinType(type) && !(env?.items?.elements || env?.elements))
+      env = csn.definitions[type];
   }
   return env;
 }

package/lib/language/genericAntlrParser.js

@@ -413,6 +413,12 @@ function checkExtensionDict( dict ) {
           def[prop] = dup[prop]; // continuation semantics: last wins
         }
       }
+      if (dup.$annotations) {   // update deprecated $annotations for cds-lsp / annotation modeler
+        if (def.$annotations)
+          def.$annotations.push( ...dup.$annotations );
+        else
+          def.$annotations = dup.$annotations;
+      }
     }
     def.$duplicates = null;
   }

package/lib/transform/db/applyTransformations.js

@@ -52,7 +52,7 @@ function applyTransformationsInternal( parent, prop, customTransformers, artifac
    * The customTransformers are applied here (and only here).
    *
    * @param {object | Array} _parent the thing that has _prop
-   * @param {string|number} _prop the name of the current property
+   * @param {string|number} _prop the name of the current property or index
    * @param {object} node The value of node[_prop]
    */
   function standard( _parent, _prop, node ) {

package/lib/transform/forOdataNew.js

@@ -346,44 +346,43 @@ function transform4odataWithCsn(inputModel, options) {
           setAnnotation(node, name.replace(setPrefix, setMappings[setPrefix]), node[name]);
         }
       }
-
+    });
       // Special case: '@readonly' becomes a triplet of capability restrictions for entities,
       // but '@Core.Immutable' for everything else.
-      if (!(node['@readonly'] && node['@insertonly'])) {
-        if (name === '@readonly' && node[name]) {
-          if (node.kind === 'entity' || node.kind === 'aspect') {
-            setAnnotation(node, '@Capabilities.DeleteRestrictions.Deletable', false);
-            setAnnotation(node, '@Capabilities.InsertRestrictions.Insertable', false);
-            setAnnotation(node, '@Capabilities.UpdateRestrictions.Updatable', false);
-          } else {
-            setAnnotation(node, '@Core.Computed', true);
-          }
-        }
-        // @insertonly is effective on entities/queries only
-        else if (name === '@insertonly' && node[name]) {
-          if (node.kind === 'entity' || node.kind === 'aspect') {
-            setAnnotation(node, '@Capabilities.DeleteRestrictions.Deletable', false);
-            setAnnotation(node, '@Capabilities.ReadRestrictions.Readable', false);
-            setAnnotation(node, '@Capabilities.UpdateRestrictions.Updatable', false);
-          }
+    if (!(node['@readonly'] && node['@insertonly'])) {
+      if (node['@readonly']) {
+        if (node.kind === 'entity' || node.kind === 'aspect') {
+          setAnnotation(node, '@Capabilities.DeleteRestrictions.Deletable', false);
+          setAnnotation(node, '@Capabilities.InsertRestrictions.Insertable', false);
+          setAnnotation(node, '@Capabilities.UpdateRestrictions.Updatable', false);
+        } else {
+          setAnnotation(node, '@Core.Computed', true);
         }
       }
-      // Only on element level: translate @mandatory
-      if (name === '@mandatory' && node[name] &&
-        node.kind === undefined && node['@Common.FieldControl'] === undefined) {
-        setAnnotation(node, '@Common.FieldControl', { '#': 'Mandatory' });
+        // @insertonly is effective on entities/queries only
+      if (node['@insertonly'] && (node.kind === 'entity' || node.kind === 'aspect')) {
+        setAnnotation(node, '@Capabilities.DeleteRestrictions.Deletable', false);
+        setAnnotation(node, '@Capabilities.ReadRestrictions.Readable', false);
+        setAnnotation(node, '@Capabilities.UpdateRestrictions.Updatable', false);
       }
+    }
 
-      if (name === '@assert.format' && node[name] !== null)
-        setAnnotation(node, '@Validation.Pattern', node['@assert.format']);
+    // Only on element level: translate @mandatory
+    if (node['@mandatory'] &&
+      node.kind === undefined &&
+      !Object.entries(node).some(([k,v]) => k === '@Common.FieldControl' || k.startsWith('@Common.FieldControl.') && v != null)) {
+      setAnnotation(node, '@Common.FieldControl', { '#': 'Mandatory' });
+    }
 
-      if (name === '@assert.range' && node[name] !== null) {
-        if (Array.isArray(node['@assert.range']) && node['@assert.range'].length === 2) {
-          setAnnotation(node, '@Validation.Minimum', node['@assert.range'][0]);
-          setAnnotation(node, '@Validation.Maximum', node['@assert.range'][1]);
-        }
+    if (node['@assert.format'] != null)
+      setAnnotation(node, '@Validation.Pattern', node['@assert.format']);
+
+    if (node['@assert.range'] != null) {
+      if (Array.isArray(node['@assert.range']) && node['@assert.range'].length === 2) {
+        setAnnotation(node, '@Validation.Minimum', node['@assert.range'][0]);
+        setAnnotation(node, '@Validation.Maximum', node['@assert.range'][1]);
       }
-    });
+    }
   }
 
   // Apply default type facets to each type definition and every member

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-compiler",
-  "version": "3.9.4",
+  "version": "3.9.8",
   "description": "CDS (Core Data Services) compiler and backends",
   "homepage": "https://cap.cloud.sap/",
   "author": "SAP SE (https://www.sap.com)",