@sap/cds-compiler 2.12.0 → 2.15.2

package/lib/transform/db/expansion.js

@@ -8,6 +8,7 @@ const {
 } = require('../../model/csnUtils');
 const { csnRefs, implicitAs } = require('../../model/csnRefs');
 const { setProp, isBetaEnabled } = require('../../base/model');
+const { forEach } = require('../../utils/objectUtils');
 
 /**
  * For keys, columns, groupBy and orderBy, expand structured things.
@@ -19,9 +20,10 @@ const { setProp, isBetaEnabled } = require('../../base/model');
  * @param {object} messageFunctions
  * @param {Function} messageFunctions.error
  * @param {Function} messageFunctions.info
- * @param {Function} messageFunctions.throwWithError
+ * @param {Function} messageFunctions.throwWithAnyError
+ * @param {object} iterateOptions
  */
-function expandStructureReferences(csn, options, pathDelimiter, { error, info, throwWithError }) {
+function expandStructureReferences(csn, options, pathDelimiter, { error, info, throwWithAnyError }, iterateOptions = {}) {
   const {
     isStructured, get$combined, getFinalBaseType, getServiceName,
   } = getUtils(csn);
@@ -39,7 +41,11 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
       const artifact = csn.definitions[path[1]];
       if (!hasAnnotationValue(artifact, '@cds.persistence.table')) {
         const root = get$combined({ SELECT: parent });
-        parent.columns = replaceStar(root, columns, parent.excluding);
+        // TODO: replace with the correct options.transformation?
+        // Do not expand the * in OData for a moment, not to introduce changes
+        // while the OData CSN is still official
+        if (!options.toOdata)
+          parent.columns = replaceStar(root, columns, parent.excluding);
         parent.columns = expand(parent.columns, path.concat('columns'), true);
       }
     },
@@ -49,7 +55,7 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
     orderBy: (parent, name, orderBy, path) => {
       parent.orderBy = expand(orderBy, path.concat('orderBy'));
     },
-  });
+  }, [], iterateOptions);
 
   /**
    * Turn .expand/.inline into normal refs. @cds.persistence.skip .expand with to-many (and all transitive views).
@@ -71,16 +77,25 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
         if (!hasAnnotationValue(artifact, '@cds.persistence.table')) {
           const rewritten = rewrite(root, parent.columns, parent.excluding);
           parent.columns = rewritten.columns;
-          if (rewritten.toMany.length > 0) {
+          /*
+           * Do not remove unexpandable many columns in OData
+          */
+          if (rewritten.toMany.length > 0 && !options.toOdata) {
             markAsToDummyfy(artifact, path[1]);
             if (getServiceName(path[1]) === null)
               error( null, [ 'definitions', path[1] ], { name: path[1] }, 'Unexpected .expand with to-many association in entity $(NAME), which is outside any service');
           }
+          else {
+            parent.columns = rewritten.columns;
+          }
         }
       },
     });
 
-    dummyfy();
+    // OData must keep @cds.persistence.skip definitions
+    // to present them in the API (and CSN)
+    if (!options.toOdata)
+      dummyfy();
 
     cleanup.forEach(fn => fn());
 
@@ -88,23 +103,26 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
 
 
     const publishing = [];
-
-    applyTransformations(csn, {
-      target: (parent, name, target, path) => {
-        if (toDummyfy.indexOf(target) !== -1) {
-          publishing.push({
-            parent, name, target, path: [ ...path ],
-          });
-        }
-      },
-      from: check,
-      columns: check,
-      where: check,
-      groupBy: check,
-      orderBy: check,
-      having: check,
-      limit: check,
-    });
+    // OData must allow navigations to @cds.persistence.skip targets
+    // as valid navigations in the API
+    if (!options.toOdata) {
+      applyTransformations(csn, {
+        target: (parent, name, target, path) => {
+          if (toDummyfy.indexOf(target) !== -1) {
+            publishing.push({
+              parent, name, target, path: [ ...path ],
+            });
+          }
+        },
+        from: check,
+        columns: check,
+        where: check,
+        groupBy: check,
+        orderBy: check,
+        having: check,
+        limit: check,
+      });
+    }
 
 
     /**
@@ -165,7 +183,7 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
     }
 
     // We would be broken if we continue with assoc usage to now skipped
-    throwWithError();
+    throwWithAnyError();
 
 
     for (const {
@@ -194,7 +212,7 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
       while (stack.length > 0) {
         const [ a, n ] = stack.pop();
         if (a[_dependents]) {
-          Object.entries(a[_dependents]).forEach(([ dependentName, dependent ]) => {
+          forEach(a[_dependents], (dependentName, dependent) => {
             stack.push([ dependent, dependentName ]);
           });
         }
@@ -236,7 +254,7 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
     /**
      * Rewrite expand and inline to "normal" refs
      *
-     * @param {CSN.Artifact} root All elements visible fromt he query source ($combined)
+     * @param {CSN.Artifact} root All elements visible from the query source ($combined)
      * @param {CSN.Column[]} columns
      * @param {string[]} excluding
      * @returns {{columns: Array, toMany: Array}} Object with rewritten columns (.expand/.inline) and with any .expand + to-many
@@ -244,8 +262,12 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
     function rewrite(root, columns, excluding) {
       const allToMany = [];
       const newThing = [];
-      // Replace stars - needs to happen here since the .expand/.inline first path step affects the root *
-      columns = replaceStar(root, columns, excluding);
+      const containsExpandInline = columns.some(col => col.expand || col.inline);
+      if (containsExpandInline) // Replace stars - needs to happen before resolving .expand/.inline since the .expand/.inline first path step affects the root *
+        columns = replaceStar(root, columns, excluding);
+      else
+        return { columns, toMany: [] };
+
       for (const col of columns) {
         if (col.expand) {
           // TODO: Can col.ref be empty without an as? Assumption is it cannot - if it has, it's an error, we throw, compiler checks.
@@ -269,7 +291,7 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
     }
 
     /**
-     * Check wether the given object is a to-many association
+     * Check whether the given object is a to-many association
      *
      * @param {CSN.Element} obj
      * @returns {boolean}
@@ -301,6 +323,11 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
       while (stack.length > 0) {
         const [ base, current, currentRef, currentAlias ] = stack.pop();
         if (isToMany(current) && current.expand) {
+          expanded.push({
+            expand: current.expand,
+            ref: currentRef,
+            as: currentAlias.join(pathDelimiter),
+          });
           toManys.push({ art: current, ref: currentRef, as: currentAlias.join(pathDelimiter) });
         }
         else if (current.expand) {
@@ -380,8 +407,8 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
      * @returns {string|null} Name of any entity
      */
     function findAnEntity() {
-      for (const [ name, artifact ] of Object.entries(csn.definitions)) {
-        if (artifact.kind === 'entity' && !artifact.query)
+      for (const name in csn.definitions) {
+        if (Object.hasOwnProperty.call(csn.definitions, name) && csn.definitions[name].kind === 'entity' && !csn.definitions[name].query)
           return name;
       }
       return null;
@@ -435,7 +462,7 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
    *
    * @param {Array} thing
    * @param {CSN.Path} path
-   * @param {boolean} [withAlias=false] Wether to "expand" the (implicit) alias aswell.
+   * @param {boolean} [withAlias=false] Whether to "expand" the (implicit) alias aswell.
    * @returns {Array} New array - with all structured things expanded
    */
   function expand(thing, path, withAlias = false) {
@@ -522,7 +549,7 @@ function expandStructureReferences(csn, options, pathDelimiter, { error, info, t
   /**
    * Replace the star and correctly put shadowed things in the right place.
    *
-   * @param {Object} base The raw set of things a * can expand to
+   * @param {object} base The raw set of things a * can expand to
    * @param {Array} subs Things - the .expand/.inline or .columns
    * @param {string[]} [excluding=[]]
    * @returns {Array} If there was a star, expand it and handle shadowing/excluding, else just return subs