@sap/cds-compiler 3.0.2 → 3.1.0

package/lib/render/toSql.js

@@ -126,8 +126,9 @@ function toSqlDdl(csn, options) {
       fromElementsObj(artifactName, tableName, elementsObj, env, duplicateChecker) {
         // Only extend with 'ADD' for elements/associations
         // TODO: May also include 'RENAME' at a later stage
+        const alterEnv = activateAlterMode(env);
         const elements = Object.entries(elementsObj)
-          .map(([ name, elt ]) => renderElement(artifactName, name, elt, duplicateChecker, null, env))
+          .map(([ name, elt ]) => renderElement(artifactName, name, elt, duplicateChecker, null, alterEnv))
           .filter(s => s !== '');
 
         if (elements.length)
@@ -203,7 +204,7 @@ function toSqlDdl(csn, options) {
       Render comment string.
      */
     comment(comment) {
-      return comment && renderStringForSql(comment, options.sqlDialect) || 'NULL';
+      return comment && renderStringForSql(getHanaComment({ doc: comment }), options.sqlDialect) || 'NULL';
     },
     /*
       Alter SQL snippet for entity.
@@ -437,7 +438,7 @@ function toSqlDdl(csn, options) {
     function getEltStr(defVariant, eltName) {
       return defVariant.target
         ? renderAssociationElement(eltName, defVariant, env)
-        : renderElement(artifactName, eltName, defVariant, null, null, env);
+        : renderElement(artifactName, eltName, defVariant, null, null, activateAlterMode(env));
     }
     function getEltStrNoProps(defVariant, eltName, ...props) {
       const defNoProps = Object.assign({}, defVariant);
@@ -464,7 +465,7 @@ function toSqlDdl(csn, options) {
     // Change entity properties
     if (migration.properties) {
       for (const [ prop, def ] of Object.entries(migration.properties)) {
-        if (prop === 'doc') {
+        if (prop === 'doc' && !options.disableHanaComments) { // def.new may be `null`
           const alterComment = render.alterEntityComment(tableName, def.new);
           addMigration(resultObj, artifactName, false, alterComment);
         }
@@ -530,7 +531,7 @@ function toSqlDdl(csn, options) {
           }
         }
 
-        if (def.old.doc !== def.new.doc) {
+        if (!options.disableHanaComments && def.old.doc !== def.new.doc) {
           const eltStrOldNoDoc = getEltStrNoProps(def.old, eltName, 'doc');
           const eltStrNewNoDoc = getEltStrNoProps(def.new, eltName, 'doc');
           if (eltStrOldNoDoc === eltStrNewNoDoc) { // only `doc` changed
@@ -756,7 +757,7 @@ function toSqlDdl(csn, options) {
       duplicateChecker.addElement(quotedElementName, elm.$location, elementName);
 
     let result = `${env.indent + quotedElementName} ${renderTypeReference(artifactName, elementName, elm)
-    }${renderNullability(elm, true)}`;
+    }${renderNullability(elm, true, env.alterMode)}`;
     if (elm.default)
       result += ` DEFAULT ${renderExpr(elm.default, env)}`;
 
@@ -1398,9 +1399,15 @@ function toSqlDdl(csn, options) {
    *
    * @param {object} obj Object to render for
    * @param {boolean} treatKeyAsNotNull Whether to render KEY as not null
+   * @param {boolean} deltaMode Look for a $notNull and use that with precedence over notNull
    * @returns {string} NULL/NOT NULL or ''
    */
-  function renderNullability(obj, treatKeyAsNotNull = false) {
+  function renderNullability(obj, treatKeyAsNotNull = false, deltaMode = false) {
+    if (deltaMode && obj.$notNull !== undefined) { // can be set via compare.js if it goes from "not null" to implicit "null"
+      return obj.$notNull ? ' NOT NULL' : ' NULL';
+    }
+
+
     if (obj.notNull === undefined && !(obj.key && treatKeyAsNotNull)) {
       // Attribute not set at all
       return '';
@@ -1535,7 +1542,7 @@ function toSqlDdl(csn, options) {
           return 'SESSION_CONTEXT(\'LOCALE\')';
         return '\'en\''; // default language
       }
-      // Basically: Second path step was invalid, do nothing - should not happen, see 'unknownMagic.js'
+      // Basically: Second path step was invalid, do nothing - should not happen.
       return null;
     }
     /**
@@ -1658,6 +1665,15 @@ function toSqlDdl(csn, options) {
   function increaseIndent(env) {
     return Object.assign({}, env, { indent: `${env.indent}  ` });
   }
+  /**
+   * Returns a copy of 'env' with alterMode set to true
+   *
+   * @param {object} env Render environment
+   * @returns {object} Render environment with alterMode
+   */
+  function activateAlterMode(env) {
+    return Object.assign({ alterMode: true }, env);
+  }
 }
 
 /**

package/lib/render/utils/common.js

@@ -286,8 +286,8 @@ const cdsToSqlTypes = {
     'cds.LargeString': 'text',
     'cds.hana.CLOB': 'text',
     'cds.LargeBinary': 'bytea',
-    'cds.Binary': 'VARCHAR',
-    'cds.hana.BINARY': 'VARCHAR',
+    'cds.Binary': 'bytea',
+    'cds.hana.BINARY': 'bytea',
     'cds.Double': 'double precision',
     'cds.hana.TINYINT': 'INTEGER',
   },
@@ -358,11 +358,10 @@ function hasHanaComment(obj, options) {
  * Return the comment of the given artifact or element.
  * Uses the first block (everything up to the first empty line (double \n)).
  * Remove leading/trailing whitespace.
- * Does not escape any characters.
+ * Does not escape any characters, use e.g. `getEscapedHanaComment()` for HDBCDS.
  *
  * @param {CSN.Artifact|CSN.Element} obj
  * @returns {string}
- * @todo Warning/info to user?
  */
 function getHanaComment(obj) {
   return obj.doc.split('\n\n')[0].trim();

package/lib/transform/db/associations.js

@@ -107,12 +107,12 @@ function attachOnConditions(csn, pathDelimiter) {
  * @param {string} pathDelimiter
  * @returns {(artifact: CSN.Artifact, artifactName: string) => void} Callback for forEachDefinition
  */
-function getManagedAssocStepsInOnConditionFinalizer(csn, pathDelimiter) {
+function getFKAccessFinalizer(csn, pathDelimiter) {
   const {
     inspectRef,
   } = getUtils(csn);
 
-  return handleManagedAssocStepsInOnCondition;
+  return handleManagedAssocSteps;
 
   /**
    * Loop over all elements and for all unmanaged associations translate
@@ -123,45 +123,53 @@ function getManagedAssocStepsInOnConditionFinalizer(csn, pathDelimiter) {
    * @param {CSN.Artifact} artifact Artifact to check
    * @param {string} artifactName Name of the artifact
    */
-  function handleManagedAssocStepsInOnCondition(artifact, artifactName) {
-    for (const elemName in artifact.elements) {
-      const elem = artifact.elements[elemName];
-      // The association is an unmanaged on
-      if (!elem.keys && elem.target && elem.on) {
-        applyTransformationsOnNonDictionary(elem, 'on', {
-          ref: (refOwner, prop, ref, path) => {
-            // [<assoc base>.]<managed assoc>.<field>
-            if (ref.length > 1) {
-              const { links } = inspectRef(path);
-              if (links) {
-                // eslint-disable-next-line for-direction
-                for (let i = links.length - 1; i >= 0; i--) {
-                  const link = links[i];
-                  // We found the latest managed assoc path step
-                  if (link.art && link.art.target && link.art.keys &&
+  function handleManagedAssocSteps(artifact, artifactName) {
+    const transformer = {
+      ref: (refOwner, prop, ref, path) => {
+        // [<assoc base>.]<managed assoc>.<field>
+        if (ref.length > 1) {
+          const { links } = inspectRef(path);
+          if (links) {
+            // eslint-disable-next-line for-direction
+            for (let i = links.length - 1; i >= 0; i--) {
+              const link = links[i];
+              // We found the latest managed assoc path step
+              if (link.art && link.art.target && link.art.keys &&
                     // Doesn't work when ref-target (filter condition) or similar is used
                     !ref.slice(i).some(refElement => typeof refElement !== 'string')) {
-                    // We join the managed assoc with everything following it
-                    const sourceElementName = ref.slice(i).join(pathDelimiter);
-                    const source = findSource(links, i - 1) || artifact;
-                    // allow specifying managed assoc on the source side
-                    const fks = link.art.keys.filter(fk => ref[i] + pathDelimiter + fk.ref[0] === sourceElementName);
-                    if (fks && fks.length >= 1) {
-                      const fk = fks[0];
-                      const managedAssocStepName = refOwner.ref[i];
-                      const fkName = `${managedAssocStepName}${pathDelimiter}${fk.as}`;
-                      if (source && source.elements[fkName])
-                        refOwner.ref = [ ...ref.slice(0, i), fkName ];
-                    }
-                  }
+                // We join the managed assoc with everything following it
+                const sourceElementName = ref.slice(i).join(pathDelimiter);
+                const source = findSource(links, i - 1) || artifact;
+                // allow specifying managed assoc on the source side
+                const fks = link.art.keys.filter(fk => ref[i] + pathDelimiter + fk.ref[0] === sourceElementName);
+                if (fks && fks.length >= 1) {
+                  const fk = fks[0];
+                  const managedAssocStepName = refOwner.ref[i];
+                  const fkName = `${managedAssocStepName}${pathDelimiter}${fk.as}`;
+                  if (source && source.elements[fkName])
+                    refOwner.ref = [ ...ref.slice(0, i), fkName ];
                 }
               }
             }
-          },
-        }, {}, [ 'definitions', artifactName, 'elements', elemName ]);
-      }
+          }
+        }
+      },
+    };
+    for (const elemName in artifact.elements) {
+      const elem = artifact.elements[elemName];
+      // The association is an unmanaged one
+      if (!elem.keys && elem.target && elem.on)
+        applyTransformationsOnNonDictionary(elem, 'on', transformer, {}, [ 'definitions', artifactName, 'elements', elemName ]);
+    }
+
+    if (artifact.query || artifact.projection) {
+      applyTransformationsOnNonDictionary(artifact, artifact.query ? 'query' : 'projection', {
+        orderBy: (parent, prop, thing, path) => applyTransformationsOnNonDictionary(parent, prop, transformer, {}, path),
+        groupBy: (parent, prop, thing, path) => applyTransformationsOnNonDictionary(parent, prop, transformer, {}, path),
+      }, {}, [ 'definitions', artifactName ]);
     }
 
+
     /**
      * Find out where the managed association is
      *
@@ -183,5 +191,5 @@ function getManagedAssocStepsInOnConditionFinalizer(csn, pathDelimiter) {
 }
 module.exports = {
   attachOnConditions,
-  getManagedAssocStepsInOnConditionFinalizer,
+  getFKAccessFinalizer,
 };

package/lib/transform/db/cdsPersistence.js

@@ -78,7 +78,6 @@ function getAssocToSkippedIgnorer(csn, options, messageFunctions) {
    * @param {string} memberName
    * @param {string} prop
    * @param {CSN.Path} path
-   * @todo Why do we check for @cds.persistence.exists here if the parent-function only calls this for skip/abstract?
    */
   function ignore(member, memberName, prop, path) {
     if (options.sqlDialect === 'hana' &&

package/lib/transform/db/flattening.js

@@ -47,7 +47,6 @@ function removeLeadingSelf(csn) {
  * @param {object} iterateOptions
  */
 function resolveTypeReferences(csn, options, resolved, pathDelimiter, iterateOptions = {}) {
-  const typeCache = Object.create(null); // TODO: Argument as well?
   /**
    * Remove .localized from the element and any sub-elements
    *
@@ -83,14 +82,14 @@ function resolveTypeReferences(csn, options, resolved, pathDelimiter, iterateOpt
     cast: (parent, prop, cast, path) => {
       // Resolve cast already - we otherwise lose .localized
       if (cast.type && !isBuiltinType(cast.type) && (!options.toOdata || options.toOdata && !isODataV4BuiltinFromService(cast.type, path) && !isODataItems(cast.type)))
-        toFinalBaseType(parent.cast, resolved, true, typeCache);
+        toFinalBaseType(parent.cast, resolved, true);
     },
     // @ts-ignore
     type: (parent, prop, type, path) => {
       if (options.toOdata && parent.kind && parent.kind in ignoreOdataKinds)
         return;
       if (!isBuiltinType(type) && (!options.toOdata || options.toOdata && !isODataV4BuiltinFromService(type, path) && !isODataItems(type))) {
-        toFinalBaseType(parent, resolved, true, typeCache);
+        toFinalBaseType(parent, resolved, true);
         // structured types might not have the child-types replaced.
         // Drill down to ensure this.
         if (parent.elements) {
@@ -99,7 +98,7 @@ function resolveTypeReferences(csn, options, resolved, pathDelimiter, iterateOpt
             const elements = stack.pop();
             for (const e of Object.values(elements)) {
               if (e.type && !isBuiltinType(e.type))
-                toFinalBaseType(e, resolved, true, typeCache);
+                toFinalBaseType(e, resolved, true);
 
               if (e.elements)
                 stack.push(e.elements);

package/lib/transform/db/transformExists.js

@@ -349,7 +349,7 @@ function handleExists(csn, options, error) {
     const newExpr = [];
     const query = walkCsnPath(csn, queryPath);
     const expr = walkCsnPath(csn, exprPath);
-    const queryBase = query.SELECT.from.ref ? (query.SELECT.from.as || query.SELECT.from.ref[0]) : null;
+    const queryBase = query.SELECT.from.ref ? (query.SELECT.from.as || query.SELECT.from.ref) : null;
     const sources = getQuerySources(query.SELECT);
 
     for (let i = 0; i < expr.length; i++) {
@@ -457,7 +457,7 @@ function handleExists(csn, options, error) {
    *
    * A valid $self-backlink is handled in translateDollarSelfToWhere.
    *
-   * For an ordinary unmanaged association, we do the the following for each part of the on-condition:
+   * For an ordinary unmanaged association, we do the following for each part of the on-condition:
    * - target side: We prefix the real target and cut off the assoc-name from the ref
    * - source side w/ leading $self: We remove the $self and add the source side entity/query source
    * - source side w/o leading $self: We simply add the source side entity/query source in front of the ref
@@ -730,15 +730,17 @@ function handleExists(csn, options, error) {
   /**
    * Get the name of the source-side query source
    *
-   * @param {string|null} queryBase
+   * @param {string | Array | null} queryBase
    * @param {boolean} isPrefixedWithTableAlias
    * @param {CSN.Column} current
    * @param {CSN.Path} path
    * @returns {string}
    */
   function getBase(queryBase, isPrefixedWithTableAlias, current, path) {
-    if (queryBase)
-      return getRealName(csn, queryBase);
+    if (typeof queryBase === 'string') // alias
+      return queryBase;
+    else if (queryBase) // ref
+      return queryBase.length > 1 ? queryBase[queryBase.length - 1] : getRealName(csn, queryBase[0]);
     else if (isPrefixedWithTableAlias)
       return current.ref[0];
     return getParent(current, path);

package/lib/transform/draft/db.js

@@ -19,7 +19,7 @@ const booleanBuiltin = 'cds.Boolean';
  * @param {object} messageFunctions
  */
 function generateDrafts(csn, options, pathDelimiter, messageFunctions) {
-  const draftSuffix = isDeprecatedEnabled(options, '_generatedEntityNameWithUnderscore') ? '_drafts' : '.drafts';
+  const draftSuffix = '.drafts';
   // All services of the model - needed for drafts
   const allServices = getServiceNames(csn);
   const draftRoots = new WeakMap();

package/lib/transform/forHanaNew.js

@@ -265,10 +265,10 @@ function transformForHanaWithCsn(inputModel, options, moduleName) {
   // To be done after handleAssociations, since then the foreign keys of the managed assocs
   // are part of the elements
   if (doA2J)
-    forEachDefinition(csn, associations.getManagedAssocStepsInOnConditionFinalizer(csn, pathDelimiter));
+    forEachDefinition(csn, associations.getFKAccessFinalizer(csn, pathDelimiter));
 
   // Create convenience views for localized entities/views.
-  // To be done after getManagedAssocStepsInOnConditionFinalizer because associations are
+  // To be done after getFKAccessFinalizer because associations are
   // handled and before handleDBChecks which removes the localized attribute.
   // Association elements of localized convenience views do not have hidden properties
   // like $managed set, so we cannot do this earlier on.
@@ -392,6 +392,15 @@ function transformForHanaWithCsn(inputModel, options, moduleName) {
             setProp(SET, 'elements', query.SELECT.elements);
         }
       }
+    },
+
+  }
+
+  if(options.sqlDialect === 'postgres') {
+    killers.length = (parent) => {
+      if (parent.type === 'cds.Binary' || parent.type === 'cds.hana.BINARY') {
+        delete parent.length;
+      }
     }
   }
 

package/lib/transform/forOdataNew.js

@@ -178,7 +178,7 @@ function transform4odataWithCsn(inputModel, options) {
   // To be done after handleManagedAssociationsAndCreateForeignKeys,
   // since then the foreign keys of the managed assocs are part of the elements
   if(!structuredOData)
-    forEachDefinition(csn, associations.getManagedAssocStepsInOnConditionFinalizer(csn, '_'));
+    forEachDefinition(csn, associations.getFKAccessFinalizer(csn, '_'));
 
   // structure flattener reports errors, further processing is not safe -> throw exception in case of errors
   throwWithAnyError();

package/lib/transform/odata/typesExposure.js

@@ -10,6 +10,7 @@ const { setProp } = require('../../base/model');
 const { defNameWithoutServiceOrContextName, isArtifactInService } = require('./utils');
 const { cloneCsnNonDict, isBuiltinType, forEachDefinition, forEachMember } = require('../../model/csnUtils');
 const { copyAnnotations } = require('../../model/csnUtils');
+const { isBetaEnabled } = require('../../base/model.js');
 
 function typesExposure(csn, whatsMyServiceName, requestedServiceNames, fallBackSchemaName, options, csnUtils, message) {
   const { error } = message;
@@ -92,11 +93,16 @@ function typesExposure(csn, whatsMyServiceName, requestedServiceNames, fallBackS
               : getAnonymousTypeNameInMultiSchema(newTypeName, parentName || defName))
           : `${serviceName}.${newTypeName}`;
 
-      // as soon as we leave of the anonymous world,
-      // we're no longer in a key def => don't set notNull:true on named types
-      if (!isAnonymous && isKey)
-        isKey = false;
-
+      if (!isAnonymous) {
+        // as soon as we leave of the anonymous world,
+        // we're no longer in a key def => don't set notNull:true on named types
+        if(isKey)
+          isKey = false;
+        // in case this was a named type and if the openess does not match the type definition
+        // expose the type as a new one not changing the original definition.
+        if((!!node['@open'] !== !!typeDef['@open']) && isBetaEnabled(options, 'odataOpenType'))
+          fullQualifiedNewTypeName += node['@open'] ? '_open' : '_closed';
+      }
       // check if that type is already defined
       let newType = csn.definitions[fullQualifiedNewTypeName];
       if (newType) {
@@ -111,6 +117,9 @@ function typesExposure(csn, whatsMyServiceName, requestedServiceNames, fallBackS
          * Treat items.elements as ordinary elements for now.
          */
         newType = createNewStructType(elements);
+        // if using node enforces open/closed, set it on type
+        if(node['@open'] !== undefined)
+          newType['@open'] = node['@open']
         if (node.$location)
           setProp(newType, '$location', node.$location);
 

package/lib/utils/moduleResolve.js

@@ -25,7 +25,6 @@ const extensions = [ '.cds', '.csn', '.json' ];
  * @todo Re-think:
  *   - Why can't a JAVA installation set a (symbolic) link?
  *   - Preferred to a local installation? Not the node-way!
- *   - Why a global?  The Umbrella could pass it as an option.
  *
  * @param {string} modulePath
  * @param {CSN.Options} options

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-compiler",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "CDS (Core Data Services) compiler and backends",
   "homepage": "https://cap.cloud.sap/",
   "author": "SAP SE (https://www.sap.com)",
@@ -16,7 +16,7 @@
   "scripts": {
     "download": "node scripts/downloadANTLR.js",
     "gen": "node ./scripts/build.js && node scripts/genGrammarChecksum.js",
-    "xmakeBeforeInstall": "echo \"Due to binary mirror, use sqlite 5.0.8 explicitly\" && npm install --save --save-exact --no-package-lock sqlite3@5.0.8",
+    "xmakeBeforeInstall": "echo \"Due to binary mirror, use sqlite 5.0.11 explicitly\" && npm install --save --save-exact --no-package-lock sqlite3@5.0.11",
     "xmakeAfterInstall": "npm run gen",
     "xmakePrepareRelease": "echo \"$(node scripts/stripReadme.js README.md)\" > README.md && node scripts/assertSnapshotVersioning.js && node scripts/assertChangelog.js && node scripts/cleanup.js --remove-dev",
     "test": "node scripts/verifyGrammarChecksum.js && mocha --reporter min --reporter-option maxDiffSize=0 scripts/testLazyLoading.js && mocha --parallel --reporter min --reporter-option maxDiffSize=0 test/ test3/",

package/lib/checks/unknownMagic.js

@@ -1,41 +0,0 @@
-'use strict';
-
-const { getVariableReplacement } = require('../model/csnUtils');
-
-// 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.variableReplacements
- *
- * @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 &&
-          getVariableReplacement(ref, this.options) === null)
-      this.error('ref-missing-replacement', parent.$location, { elemref: parent }, 'Missing replacement for variable $(ELEMREF)');
-  }
-}
-
-module.exports = {
-  ref: unknownMagicVariable,
-};