@sap/cds-compiler 2.12.0 → 2.13.6

package/lib/transform/db/groupByOrderBy.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const { ModelError } = require('../../base/error');
+
 /**
  * Replace (formerly) managed association in a GROUP BY/ORDER BY with its foreign keys.
  *
@@ -89,7 +91,7 @@ function replaceAssociationsInGroupByOrderBy(inputQuery, options, inspectRef, er
 function getForeignKeyRefs(assoc) {
   return assoc.keys.map((fk) => {
     if (!fk.$generatedFieldName)
-      throw new Error(`Expecting generated field name for foreign key: ${JSON.stringify(fk)}`);
+      throw new ModelError(`Expecting generated field name for foreign key: ${JSON.stringify(fk)}`);
 
     return { ref: [ fk.$generatedFieldName ] };
   });

package/lib/transform/db/transformExists.js

@@ -4,6 +4,7 @@ const { forAllQueries, forEachDefinition, walkCsnPath } = require('../../model/c
 const { setProp } = require('../../base/model');
 const { getRealName } = require('../../render/utils/common');
 const { csnRefs } = require('../../model/csnRefs');
+const { ModelError } = require('../../base/error');
 
 /**
  * Turn a `exists assoc[filter = 100]` into a `exists (select 1 as dummy from assoc.target where <assoc on condition> and assoc.target.filter = 100)`.
@@ -48,7 +49,7 @@ const { csnRefs } = require('../../model/csnRefs');
  * @param {Function} error
  */
 function handleExists(csn, options, error) {
-  const { inspectRef } = csnRefs(csn);
+  let { inspectRef } = csnRefs(csn);
   const generatedExists = new WeakMap();
   forEachDefinition(csn, (artifact, artifactName) => {
     if (artifact.projection) // do the same hack we do for the other stuff...
@@ -81,6 +82,8 @@ function handleExists(csn, options, error) {
             // to check for further exists
             const { result, leftovers } = processExists(queryPath, exprPath);
             walkCsnPath(csn, exprPath.slice(0, -1))[exprPath[exprPath.length - 1]] = result;
+            if (leftovers.length > 0)
+              inspectRef = csnRefs(csn).inspectRef; // Refresh caches - we need to resolve stuff in the newly created subquery
             toProcess.push(...leftovers.reverse()); // any leftovers - schedule for further processing
           }
         }
@@ -496,11 +499,16 @@ function handleExists(csn, options, error) {
         whereExtension.push({ ref: [ target, ...part.ref.slice(1) ] });
       }
       else if (part.$scope === '$self') { // source side - "absolute" scope
-        // cut off the $self, as we prefix the entity name now
-        whereExtension.push({ ref: [ base, ...part.ref.slice(1) ] });
+        const column = part._art._column;
+        if (column && column.as) { // Replace with the "original" expression (the .ref, .xpr etc.)
+          whereExtension.push(translateToSourceSide(column));
+        }
+        else {
+          whereExtension.push(assignAndDeleteAs({}, part, { ref: [ base, ...part.ref.slice(1) ] }));
+        }
       }
       else if (art) { // source side - with local scope
-        if (isPrefixedWithTableAlias)
+        if (isPrefixedWithTableAlias || part.$scope === 'alias')
           whereExtension.push({ ref: [ ...current.ref.slice(0, -1), ...part.ref ] });
         else
           whereExtension.push({ ref: [ base, ...current.ref.slice(0, -1), ...part.ref ] });
@@ -512,6 +520,51 @@ function handleExists(csn, options, error) {
 
     return whereExtension;
 
+
+    /**
+     * Run Object.assign on all of the passed in parameters and delete a .as at the end
+     *
+     * @param {...any} args
+     * @returns {object} The merged args without an .as property
+     */
+    function assignAndDeleteAs(...args) {
+      const obj = Object.assign.apply(null, args);
+      delete obj.as;
+      return obj;
+    }
+    /**
+     * Translate the given obj (a column-like thing) into an expression that we can use in the WHERE.
+     * - Strip off $self/$projection and correctly replace with source expression
+     * - Drill further down into .xpr
+     * - Correctly set table alias in front of ref
+     *
+     * @param {object} obj
+     * @returns {object}
+     */
+    function translateToSourceSide(obj) {
+      if (obj.ref) {
+        if (obj.$scope === '$self') { // TODO: Check with this way down, do we keep the links?
+          const column = obj._art._column;
+          if (column && column.as)
+            return translateToSourceSide(column);
+          return assignAndDeleteAs({}, obj, { ref: [ base, ...obj.ref.slice(1) ] });
+        }
+        else if (typeof obj.$env === 'string') {
+          return assignAndDeleteAs({}, obj, { ref: [ obj.$env, ...obj.ref ] });
+        }
+
+        return assignAndDeleteAs({}, obj, { ref: [ ...obj.ref ] });
+      }
+      else if (obj.xpr) { // we need to drill further down into .xpr
+        return assignAndDeleteAs({}, obj, { xpr: obj.xpr.map(translateToSourceSide) });
+      }
+      else if (obj.args) {
+        return assignAndDeleteAs({}, obj, { args: obj.args.map(translateToSourceSide) });
+      }
+
+      return obj;
+    }
+
     /**
      * Check that an expression triple is a valid $self
      *
@@ -584,7 +637,7 @@ function handleExists(csn, options, error) {
   }
 
   /**
-   * Check (using inspectRef -> links), wether the first path step is an entity or query source
+   * Check (using inspectRef -> links), whether the first path step is an entity or query source
    *
    * @param {CSN.Path} path
    * @returns {boolean}
@@ -634,7 +687,7 @@ function handleExists(csn, options, error) {
       return error(null, xpr.$path, 'Boolean $env is not handled yet - please report this error!');
     }
     else if (xpr.ref) {
-      throw new Error('Missing $env and missing leading artifact ref - throwing to trigger recompilation!');
+      throw new ModelError('Missing $env and missing leading artifact ref - throwing to trigger recompilation!');
     }
   }
 

package/lib/transform/db/views.js

@@ -5,6 +5,7 @@ const {
 } = require('../../model/csnUtils');
 const { implicitAs, csnRefs } = require('../../model/csnRefs');
 const { isBetaEnabled } = require('../../base/model');
+const { ModelError } = require('../../base/error');
 
 /**
  * If a mixin association is published, return the mixin association.
@@ -38,7 +39,7 @@ function getMixinAssocOfQueryIfPublished(query, association, associationName) {
 }
 
 /**
- * Check wether the given artifact uses the given mixin association.
+ * Check whether the given artifact uses the given mixin association.
  *
  * We can rely on the fact that there can be no usage starting with $self/$projection,
  * since lib/checks/selectItems.js forbids that.
@@ -182,10 +183,10 @@ function getViewTransformer(csn, options, messageFunctions, transformCommon) {
       const matchingCombined = $combined[elemName];
       // Internal errors - this should never happen!
       if (matchingCombined.length > 1) { // should already be caught by compiler
-        throw new Error(`Ambiguous name - can't be resolved: ${elemName}. Found in: ${matchingCombined.map(o => o.parent)}`);
+        throw new ModelError(`Ambiguous name - can't be resolved: ${elemName}. Found in: ${matchingCombined.map(o => o.parent)}`);
       }
       else if (matchingCombined.length === 0) { // no clue how this could happen? Invalid CSN?
-        throw new Error(`No matching entry found in UNION of all elements for: ${elemName}`);
+        throw new ModelError(`No matching entry found in UNION of all elements for: ${elemName}`);
       }
       alias = matchingCombined[0].parent;
     }
@@ -304,7 +305,7 @@ function getViewTransformer(csn, options, messageFunctions, transformCommon) {
               parent.ref = ref;
               return ref;
             },
-          }, elementsPath.concat(elemName));
+          }, {}, elementsPath.concat(elemName));
         }
 
         if (!mixinElem._ignore)

package/lib/transform/draft/.eslintrc.json

@@ -0,0 +1,38 @@
+{
+  "root": true,
+  "plugins": ["sonarjs", "jsdoc"],
+  "extends": ["../../../.eslintrc-ydkjsi.json", "plugin:sonarjs/recommended", "plugin:jsdoc/recommended"],
+  "rules": {
+    "prefer-const": "error",
+    "quotes": ["error", "single", "avoid-escape"],
+    "prefer-template": "error",
+    "no-trailing-spaces": "error",
+    "template-curly-spacing":["error", "never"],
+    "complexity": ["warn", 30],
+    "max-len": "off",
+    // Don't enforce stupid descriptions
+    "jsdoc/require-param-description": "off",
+    "jsdoc/require-returns-description": "off",
+    // Sometimes if-else's are more specific
+    "sonarjs/prefer-single-boolean-return": "off",
+    // Very whiny and nitpicky
+    "sonarjs/cognitive-complexity": "off",
+    // Does not recognize TS types
+    "jsdoc/no-undefined-types": "off",
+    // Whiny and annoying
+    "sonarjs/no-duplicate-string": "off"
+  },
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "sourceType": "script"
+  },
+  "env": {
+    "es6": true,
+    "node": true
+  },
+  "settings": {
+    "jsdoc": {
+      "mode": "typescript"
+    }
+  }
+}

package/lib/transform/{db/draft.js → draft/db.js}

@@ -6,6 +6,7 @@ const {
 } = require('../../model/csnUtils');
 const { setProp, isDeprecatedEnabled } = require('../../base/model');
 const { getTransformers } = require('../transformUtilsNew');
+const { ModelError } = require('../../base/error');
 const draftAnnotation = '@odata.draft.enabled';
 const booleanBuiltin = 'cds.Boolean';
 
@@ -38,7 +39,7 @@ function generateDrafts(csn, options, pathDelimiter, messageFunctions) {
    * @param {string} artifactName
    */
   function generateDraft(artifact, artifactName) {
-    if ((artifact.kind === 'entity' || artifact.kind === 'view') &&
+    if ((artifact.kind === 'entity') &&
         hasAnnotationValue(artifact, draftAnnotation) &&
         isPartOfService(artifactName)) {
       // Determine the set of target draft nodes belonging to this draft root (the draft root
@@ -79,7 +80,7 @@ function generateDrafts(csn, options, pathDelimiter, messageFunctions) {
         const draftNodeName = elem.target;
         // Sanity check
         if (!draftNode)
-          throw new Error(`Expecting target to be resolved: ${JSON.stringify(elem, null, 2)}`);
+          throw new ModelError(`Expecting target to be resolved: ${JSON.stringify(elem, null, 2)}`);
 
         // Ignore composition if not part of a service
         if (!isPartOfService(draftNodeName)) {
@@ -89,7 +90,7 @@ function generateDrafts(csn, options, pathDelimiter, messageFunctions) {
         }
         // Barf if a draft node other than the root has @odata.draft.enabled itself
         if (draftNode !== rootArtifact && hasAnnotationValue(draftNode, draftAnnotation)) {
-          error(null, [ 'definitions', artifactName, 'elements', elemName ], 'Composition in draft-enabled entity can\'t lead to another entity with “@odata.draft.enabled”');
+          error('ref-unexpected-draft-enabled', [ 'definitions', artifactName, 'elements', elemName ], { anno: '@odata.draft.enabled' });
           delete draftNodes[draftNodeName];
           continue;
         }
@@ -110,7 +111,7 @@ function generateDrafts(csn, options, pathDelimiter, messageFunctions) {
   function generateDraftForHana(artifact, artifactName, draftRootName) {
     // Sanity check
     if (!isPartOfService(artifactName))
-      throw new Error(`Expecting artifact to be part of a service: ${JSON.stringify(artifact)}`);
+      throw new ModelError(`Expecting artifact to be part of a service: ${JSON.stringify(artifact)}`);
 
 
     // The name of the draft shadow entity we should generate
@@ -312,7 +313,7 @@ function generateDrafts(csn, options, pathDelimiter, messageFunctions) {
     function getDraftShadowEntityFor(draftNode, draftNodeName) {
       // Sanity check
       if (!draftNodes[draftNodeName])
-        throw new Error(`Not a draft node: ${draftNodeName}`);
+        throw new ModelError(`Not a draft node: ${draftNodeName}`);
 
       return { shadowTarget: csn.definitions[`${draftNodeName}${draftSuffix}`], shadowTargetName: `${draftNodeName}${draftSuffix}` };
     }

package/lib/transform/draft/odata.js

@@ -0,0 +1,227 @@
+'use strict';
+
+const { forEachDefinition, getUtils, getServiceNames } = require('../../model/csnUtils');
+const { forEach } = require('../../utils/objectUtils');
+const { isArtifactInSomeService, getServiceOfArtifact } = require('../odata/utils');
+const { getTransformers } = require('../transformUtilsNew');
+const { ModelError } = require('../../base/error');
+const { makeMessageFunction } = require('../../base/messages');
+
+/**
+ * - Generate artificial draft fields if requested
+ *
+ * - Check associations for:
+ *      - exposed associations do not point to non-exposed targets
+ *      - structured types must not contain associations for OData V2
+ * - Element must not be an 'array of' for OData V2 TODO: move to the validator
+ * - Perform checks for exposed non-abstract entities and views - check media type and key-ness
+ *
+ * @param {CSN.Model} csn
+ * @param {CSN.Options} options
+ * @param {Array} [services] Will be calculated JIT if not provided
+ * @returns {CSN.Model} Returns the transformed input model
+ * @todo should be done by the compiler - Check associations for valid foreign keys
+ * @todo check if needed at all: Remove '$projection' from paths in the element's ON-condition
+ */
+function generateDrafts(csn, options, services) {
+  const {
+    createForeignKeyElement,
+    createAndAddDraftAdminDataProjection, createScalarElement,
+    createAssociationElement, createAssociationPathComparison,
+    addElement, createAction, assignAction,
+    resetAnnotation,
+  } = getTransformers(csn, options);
+
+  const {
+    getFinalType,
+    getServiceName,
+    hasAnnotationValue,
+    getFinalBaseType,
+    getFinalTypeDef,
+  } = getUtils(csn);
+
+  const { error, info } = makeMessageFunction(csn, options, 'for.odata');
+
+  if (!services)
+    services = getServiceNames(csn);
+
+  const visitedArtifacts = Object.create(null);
+  // @ts-ignore
+  const externalServices = services.filter(serviceName => csn.definitions[serviceName]['@cds.external']);
+  // @ts-ignore
+  const isExternalServiceMember = (_art, name) => externalServices.includes(getServiceName(name));
+
+  forEachDefinition(csn, (def, defName) => {
+    // Generate artificial draft fields for entities/views if requested, ignore if not part of a service
+    if (def.kind === 'entity' && def['@odata.draft.enabled'] && isArtifactInSomeService(defName, services))
+      generateDraftForOdata(def, defName, def);
+
+    visitedArtifacts[defName] = true;
+  }, { skipArtifact: isExternalServiceMember });
+
+  return csn;
+  /**
+   * Generate all that is required in ODATA for draft enablement of 'artifact' into the artifact,
+   * into its transitively reachable composition targets, and into the model.
+   * 'rootArtifact' is the root artifact where composition traversal started.
+   *
+   * Constraints
+   * Draft Root: Exactly one PK of type UUID
+   * Draft Node: One PK of type UUID + 0..1 PK of another type
+   * Draft Node: Must not be reachable from multiple draft roots
+   *
+   * @param {CSN.Artifact} artifact
+   * @param {string} artifactName
+   * @param {CSN.Artifact} rootArtifact artifact where composition traversal started
+   */
+  function generateDraftForOdata(artifact, artifactName, rootArtifact) {
+    // Sanity check
+    // @ts-ignore
+    if (!isArtifactInSomeService(artifactName, services))
+      throw new ModelError(`Expecting artifact to be part of a service: ${JSON.stringify(artifact)}`);
+
+    // Nothing to do if already draft-enabled (composition traversal may have circles)
+    if ((artifact['@Common.DraftRoot.PreparationAction'] || artifact['@Common.DraftNode.PreparationAction']) &&
+        artifact.actions && artifact.actions.draftPrepare)
+      return;
+
+
+    // Generate the DraftAdministrativeData projection into the service, unless there is already one
+    // @ts-ignore
+    const draftAdminDataProjectionName = `${getServiceOfArtifact(artifactName, services)}.DraftAdministrativeData`;
+    let draftAdminDataProjection = csn.definitions[draftAdminDataProjectionName];
+    if (!draftAdminDataProjection) {
+      // @ts-ignore
+      draftAdminDataProjection = createAndAddDraftAdminDataProjection(getServiceOfArtifact(artifactName, services));
+    }
+    // Report an error if it is not an entity or not what we expect
+    if (draftAdminDataProjection.kind !== 'entity' || !draftAdminDataProjection.elements.DraftUUID) {
+      error(null, [ 'definitions', draftAdminDataProjectionName ], { name: draftAdminDataProjectionName },
+            'Generated entity $(NAME) conflicts with existing artifact');
+    }
+    // Generate the annotations describing the draft actions (only draft roots can be activated/edited)
+    if (artifact === rootArtifact) {
+      resetAnnotation(artifact, '@Common.DraftRoot.ActivationAction', 'draftActivate', info, [ 'definitions', draftAdminDataProjectionName ]);
+      resetAnnotation(artifact, '@Common.DraftRoot.EditAction', 'draftEdit', info, [ 'definitions', draftAdminDataProjectionName ]);
+      resetAnnotation(artifact, '@Common.DraftRoot.PreparationAction', 'draftPrepare', info, [ 'definitions', draftAdminDataProjectionName ]);
+    }
+    else {
+      resetAnnotation(artifact, '@Common.DraftNode.PreparationAction', 'draftPrepare', info, [ 'definitions', draftAdminDataProjectionName ]);
+    }
+
+    Object.values(artifact.elements || {}).forEach( (elem) => {
+      // Make all non-key elements nullable
+      if (elem.notNull && elem.key !== true)
+        delete elem.notNull;
+    });
+    // Generate the additional elements into the draft-enabled artifact
+
+    // key IsActiveEntity : Boolean default true
+    const isActiveEntity = createScalarElement('IsActiveEntity', 'cds.Boolean', true, true, false);
+    isActiveEntity.IsActiveEntity['@UI.Hidden'] = true;
+    addElement(isActiveEntity, artifact, artifactName);
+
+    // HasActiveEntity : Boolean default false
+    const hasActiveEntity = createScalarElement('HasActiveEntity', 'cds.Boolean', false, false, true);
+    hasActiveEntity.HasActiveEntity['@UI.Hidden'] = true;
+    addElement(hasActiveEntity, artifact, artifactName);
+
+    // HasDraftEntity : Boolean default false;
+    const hasDraftEntity = createScalarElement('HasDraftEntity', 'cds.Boolean', false, false, true);
+    hasDraftEntity.HasDraftEntity['@UI.Hidden'] = true;
+    addElement(hasDraftEntity, artifact, artifactName);
+
+    // @odata.contained: true
+    // DraftAdministrativeData : Association to one DraftAdministrativeData;
+    const draftAdministrativeData = createAssociationElement('DraftAdministrativeData', draftAdminDataProjectionName, true);
+    draftAdministrativeData.DraftAdministrativeData.cardinality = { max: 1 };
+    draftAdministrativeData.DraftAdministrativeData['@odata.contained'] = true;
+    draftAdministrativeData.DraftAdministrativeData['@UI.Hidden'] = true;
+    addElement(draftAdministrativeData, artifact, artifactName);
+
+    // Note that we need to do the ODATA transformation steps for managed associations
+    // (foreign key field generation, generatedFieldName) by hand, because the corresponding
+    // transformation steps have already been done on all artifacts when we come here)
+    let uuidDraftKey = draftAdministrativeData.DraftAdministrativeData.keys.filter(key => key.ref && key.ref.length === 1 && key.ref[0] === 'DraftUUID');
+    if (uuidDraftKey && uuidDraftKey[0]) {
+      uuidDraftKey = uuidDraftKey[0]; // filter returns an array, but it has only one element
+      const path = [ 'definitions', artifactName, 'elements', 'DraftAdministrativeData', 'keys', 0 ];
+      createForeignKeyElement(draftAdministrativeData.DraftAdministrativeData, 'DraftAdministrativeData', uuidDraftKey, artifact, artifactName, path);
+    }
+    // SiblingEntity : Association to one <artifact> on (... IsActiveEntity unequal, all other key fields equal ...)
+    const siblingEntity = createAssociationElement('SiblingEntity', artifactName, false);
+    siblingEntity.SiblingEntity.cardinality = { max: 1 };
+    addElement(siblingEntity, artifact, artifactName);
+    // ... on SiblingEntity.IsActiveEntity != IsActiveEntity ...
+    siblingEntity.SiblingEntity.on = createAssociationPathComparison('SiblingEntity', 'IsActiveEntity', '!=', 'IsActiveEntity');
+
+    // Iterate elements
+    // TODO: Iterative vs recursive? What is more likely: Super deep nesting or cycles via malicious CSN?
+    if (artifact.elements) {
+      // No need to reverse the stack, not order dependent
+      const stack = [ artifact ];
+      while (stack.length > 0) {
+        const { elements } = stack.pop();
+        forEach(elements, (elemName, elem) => {
+          if (elemName !== 'IsActiveEntity' && elem.key) {
+            // Amend the ON-condition above:
+            // ... and SiblingEntity.<keyfield> = <keyfield> ... (for all key fields except 'IsActiveEntity')
+            const cond = createAssociationPathComparison('SiblingEntity', elemName, '=', elemName);
+            cond.push('and');
+            cond.push(...siblingEntity.SiblingEntity.on);
+            siblingEntity.SiblingEntity.on = cond;
+          }
+
+          // Draft-enable the targets of composition elements (draft nodes), too
+          // TODO rewrite
+          if (elem.target && elem.type && getFinalType(elem.type) === 'cds.Composition') {
+            const draftNode = csn.definitions[elem.target];
+
+            // Ignore if that is our own draft root
+            if (draftNode !== rootArtifact) {
+              // Report error when the draft node has @odata.draft.enabled itself
+              if (hasAnnotationValue(draftNode, '@odata.draft.enabled', true)) {
+                error('ref-unexpected-draft-enabled', [ 'definitions', artifactName, 'elements', elemName ], { anno: '@odata.draft.enabled' });
+              }
+              // Ignore composition if it's target is not part of a service or explicitly draft disabled
+              else if (!getServiceName(elem.target) || hasAnnotationValue(draftNode, '@odata.draft.enabled', false)) {
+                return;
+              }
+              else {
+                // Generate draft stuff into the target
+                generateDraftForOdata(draftNode, elem.target, rootArtifact);
+              }
+            }
+          }
+          else if (elem.elements) { // anonymous structure
+            stack.push(elem);
+          }
+          else if (elem.type) { // types - possibly structured
+            const typeDef = elem.type.ref ? getFinalBaseType(elem.type) : getFinalTypeDef(elem.type);
+            if (typeDef.elements)
+              stack.push(typeDef);
+          }
+        });
+      }
+    }
+
+
+    // Generate the actions into the draft-enabled artifact (only draft roots can be activated/edited)
+
+    // action draftPrepare (SideEffectsQualifier: String) return <artifact>;
+    const draftPrepare = createAction('draftPrepare', artifactName, 'SideEffectsQualifier', 'cds.String');
+    assignAction(draftPrepare, artifact);
+
+    if (artifact === rootArtifact) {
+      // action draftActivate() return <artifact>;
+      const draftActivate = createAction('draftActivate', artifactName);
+      assignAction(draftActivate, artifact);
+
+      // action draftEdit (PreserveChanges: Boolean) return <artifact>;
+      const draftEdit = createAction('draftEdit', artifactName, 'PreserveChanges', 'cds.Boolean');
+      assignAction(draftEdit, artifact);
+    }
+  }
+}
+
+module.exports = generateDrafts;