@sap/cds-compiler 2.10.4 → 2.12.0

package/lib/render/toSql.js

@@ -4,10 +4,11 @@
 const {
   getLastPartOf, getLastPartOfRef,
   hasValidSkipOrExists, isBuiltinType, generatedByCompilerVersion, getNormalizedQuery,
-  forEachDefinition, getResultingName,
+  forEachDefinition, getResultingName, getVariableReplacement,
 } = require('../model/csnUtils');
 const {
   renderFunc, beautifyExprArray, cdsToSqlTypes, getHanaComment, hasHanaComment,
+  getSqlSnippets,
 } = require('./utils/common');
 const {
   renderReferentialConstraint, getIdentifierUtils,
@@ -15,10 +16,11 @@ const {
 const DuplicateChecker = require('./DuplicateChecker');
 const { checkCSNVersion } = require('../json/csnVersion');
 const { makeMessageFunction } = require('../base/messages');
-const timetrace = require('../utils/timetrace');
+const { timetrace } = require('../utils/timetrace');
 const { isBetaEnabled, isDeprecatedEnabled } = require('../base/model');
 const { smartFuncId } = require('../sql-identifier');
 const { sortCsn } = require('../json/to-csn');
+const { manageConstraints } = require('./manageConstraints');
 
 
 /**
@@ -185,10 +187,10 @@ function toSqlDdl(csn, options) {
   checkCSNVersion(csn, options);
 
   // The final result in hdb-kind-specific form, without leading CREATE, without trailing newlines
-  // (note that the order here is relevant for transmission into 'resultObj.sql' below and that
+  // (note that the order here is relevant for transmission into 'mainResultObj.sql' below and that
   // the attribute names must be the HDI plugin names for --src hdi)
   // The result object may have a `sql` dictionary for `toSql`.
-  const resultObj = {
+  const mainResultObj = {
     hdbtabletype: Object.create(null),
     hdbtable: Object.create(null),
     hdbindex: Object.create(null),
@@ -214,13 +216,12 @@ function toSqlDdl(csn, options) {
       // Current indentation string
       indent: '',
     };
-    renderArtifactInto(artifactName, artifact, resultObj, env);
+    renderArtifactInto(artifactName, artifact, mainResultObj, env);
   });
 
   // Render each deleted artifact
   for (const artifactName in csn.deletions)
-    renderArtifactDeletionInto(artifactName, csn.deletions[artifactName], resultObj);
-
+    renderArtifactDeletionInto(artifactName, csn.deletions[artifactName], mainResultObj);
 
   // Render each artifact extension
   // Only HANA SQL is currently supported.
@@ -231,7 +232,7 @@ function toSqlDdl(csn, options) {
         const artifactName = extension.extend;
         const _artifact = csn.definitions[artifactName];
         const env = { indent: '', _artifact };
-        renderArtifactExtensionInto(artifactName, _artifact, extension, resultObj, env);
+        renderArtifactExtensionInto(artifactName, _artifact, extension, mainResultObj, env);
       }
     }
   }
@@ -244,7 +245,7 @@ function toSqlDdl(csn, options) {
         const artifactName = migration.migrate;
         const _artifact = csn.definitions[artifactName];
         const env = { indent: '', _artifact };
-        renderArtifactMigrationInto(artifactName, migration, resultObj, env);
+        renderArtifactMigrationInto(artifactName, migration, mainResultObj, env);
       }
     }
   }
@@ -265,34 +266,42 @@ function toSqlDdl(csn, options) {
 
   // Handle hdbKinds separately from alterTable case
   // eslint-disable-next-line no-unused-vars
-  const { deletions, migrations, ...hdbKinds } = resultObj;
+  const { deletions, migrations: _, ...hdbKinds } = mainResultObj;
   for (const hdbKind of Object.keys(hdbKinds)) {
-    for (const name in resultObj[hdbKind]) {
+    for (const name in mainResultObj[hdbKind]) {
       if (options.toSql.src === 'sql') {
-        let sourceString = resultObj[hdbKind][name];
+        let sourceString = mainResultObj[hdbKind][name];
         // Hack: Other than in 'hdbtable' files, in HANA SQL COLUMN is not mandatory but default.
         if (options.toSql.dialect === 'hana' && hdbKind === 'hdbtable' && sourceString.startsWith('COLUMN '))
           sourceString = sourceString.slice('COLUMN '.length);
-
         sql[name] = `${options.testMode ? '' : sqlVersionLine}CREATE ${sourceString};`;
       }
       else if (!options.testMode) {
-        resultObj[hdbKind][name] = sqlVersionLine + resultObj[hdbKind][name];
+        mainResultObj[hdbKind][name] = sqlVersionLine + mainResultObj[hdbKind][name];
       }
     }
     if (options.toSql.src === 'sql')
-      delete resultObj[hdbKind];
+      delete mainResultObj[hdbKind];
+  }
+
+  // add `ALTER TABLE ADD CONSTRAINT` statements if requested
+  if (options.sqlDialect !== 'sqlite' && options.constraintsAsAlter) {
+    const alterStmts = manageConstraints(csn, options);
+
+    for ( const constraintName of Object.keys(alterStmts))
+      sql[constraintName] = `${options.testMode ? '' : sqlVersionLine}${alterStmts[constraintName]}`;
+    mainResultObj.sql = sql;
   }
 
   if (options.toSql.src === 'sql')
-    resultObj.sql = sql;
+    mainResultObj.sql = sql;
 
   for (const name in deletions)
     deletions[name] = `${options.testMode ? '' : sqlVersionLine}${deletions[name]}`;
 
 
   timetrace.stop();
-  return resultObj;
+  return mainResultObj;
 
   /**
    * Render an artifact into the appropriate dictionary of 'resultObj'.
@@ -483,7 +492,9 @@ function toSqlDdl(csn, options) {
     env._artifact = art;
     const childEnv = increaseIndent(env);
     const hanaTc = art.technicalConfig && art.technicalConfig.hana;
-    let result = '';
+    // tables can have @sql.prepend and @sql.append
+    const { front, back } = getSqlSnippets(options, art);
+    let result = front;
     // Only HANA has row/column tables
     if (options.toSql.dialect === 'hana') {
       if (hanaTc && hanaTc.storeType) {
@@ -500,13 +511,9 @@ function toSqlDdl(csn, options) {
     result += `TABLE ${tableName}`;
     result += ' (\n';
     const elements = Object.keys(art.elements).map(eltName => renderElement(artifactName, eltName, art.elements[eltName], definitionsDuplicateChecker, getFzIndex(eltName, hanaTc), childEnv)).filter(s => s !== '').join(',\n');
-    if (elements !== '') {
+    if (elements !== '')
       result += elements;
-    }
-    else {
-      // TODO: Already be handled by 'empty-entity' reclassification; better location
-      error(null, [ 'definitions', artifactName ], 'Entities must have at least one element that is non-virtual');
-    }
+
     const uniqueFields = Object.keys(art.elements).filter(name => art.elements[name].unique && !art.elements[name].virtual)
       .map(name => quoteSqlId(name))
       .join(', ');
@@ -517,7 +524,8 @@ function toSqlDdl(csn, options) {
     if (primaryKeys !== '')
       result += `,\n${childEnv.indent}${primaryKeys}`;
 
-    if (art.$tableConstraints && art.$tableConstraints.referential) {
+    const constraintsAsAlter = options.constraintsAsAlter && options.sqlDialect !== 'sqlite';
+    if ( !constraintsAsAlter && art.$tableConstraints && art.$tableConstraints.referential) {
       const renderReferentialConstraintsAsHdbconstraint = options.toSql.src === 'hdi';
       const referentialConstraints = {};
       Object.entries(art.$tableConstraints.referential)
@@ -567,9 +575,12 @@ function toSqlDdl(csn, options) {
     if (options.toSql.dialect === 'hana')
       renderIndexesInto(art.technicalConfig && art.technicalConfig.hana.indexes, artifactName, resultObj, env);
 
-    if (options.toSql.dialect === 'hana' && hasHanaComment(art, options, art))
+    if (options.toSql.dialect === 'hana' && hasHanaComment(art, options))
       result += ` COMMENT '${getHanaComment(art)}'`;
 
+    if (back)
+      result += back;
+
     resultObj.hdbtable[artifactName] = result;
   }
 
@@ -605,12 +616,12 @@ function toSqlDdl(csn, options) {
     if (!(artifactName in resultObj.migrations))
       resultObj.migrations[artifactName] = [];
 
-    const migrations = sqlArray.map(sql => ({ drop, sql }));
+    const migrations = sqlArray.map(migrationSql => ({ drop, sql: migrationSql }));
     resultObj.migrations[artifactName].push(...migrations);
   }
 
-  function addDeletion(resultObj, artifactName, sql) {
-    resultObj.deletions[artifactName] = sql;
+  function addDeletion(resultObj, artifactName, deletionSql) {
+    resultObj.deletions[artifactName] = deletionSql;
   }
 
   /**
@@ -667,9 +678,15 @@ function toSqlDdl(csn, options) {
     if (fzindex && options.toSql.dialect === 'hana')
       result += ` ${renderExpr(fzindex, env)}`;
 
-    if (options.toSql.dialect === 'hana' && hasHanaComment(elm, options, env._artifact))
+    if (options.toSql.dialect === 'hana' && hasHanaComment(elm, options))
       result += ` COMMENT '${getHanaComment(elm)}'`;
 
+    // (table) elements can only have a @sql.append
+    const { back } = getSqlSnippets(options, elm);
+
+    if (back !== '')
+      result += back;
+
     return result;
   }
 
@@ -979,7 +996,7 @@ function toSqlDdl(csn, options) {
    * @param {object} node with `args` to render
    * @param {string} sep Separator between args
    * @param {object} env Render environment
-   * @param {string} syntax Some magic A2J paramter - for calcview parameter rendering
+   * @param {string|null} syntax Some magic A2J parameter - for calcview parameter rendering
    * @returns {string} Rendered arguments
    * @throws Throws if args is not an array or object.
    */
@@ -1002,14 +1019,13 @@ function toSqlDdl(csn, options) {
      * Render the given argument/parameter correctly.
      *
      * @param {string} arg Argument to render
-     * @param {string} syntax Some magic A2J paramter - for calcview parameter rendering
+     * @param {string|null} parameterSyntax Some magic A2J parameter - for calcview parameter rendering
      * @returns {string} Rendered argument
      */
-    function decorateParameter(arg, syntax) {
-      if (syntax === 'calcview')
+    function decorateParameter(arg, parameterSyntax) {
+      if (parameterSyntax === 'calcview')
         return `PLACEHOLDER."$$${arg}$$"`;
 
-
       return quoteSqlId(arg);
     }
   }
@@ -1054,7 +1070,7 @@ function toSqlDdl(csn, options) {
     definitionsDuplicateChecker.addArtifact(art['@cds.persistence.name'], art && art.$location, artifactName);
     let result = `VIEW ${viewName}`;
 
-    if (options.toSql.dialect === 'hana' && hasHanaComment(art, options, art))
+    if (options.toSql.dialect === 'hana' && hasHanaComment(art, options))
       result += ` COMMENT '${getHanaComment(art)}'`;
 
     result += renderParameterDefinitions(artifactName, art.params);
@@ -1070,6 +1086,11 @@ function toSqlDdl(csn, options) {
       result += `${env.indent})`;
     }
 
+    // views can only have a @sql.append
+    const { back } = getSqlSnippets(options, art);
+    if (back)
+      result += back;
+
     return result;
   }
 
@@ -1077,7 +1098,7 @@ function toSqlDdl(csn, options) {
    * Render the parameter definition of a view if any. Return the parameters in parentheses, or an empty string
    *
    * @param {string} artifactName Name of the view
-   * @param {Array} params Array of parameters
+   * @param {Object} params Dictionary of parameters
    * @returns {string} Rendered parameters
    */
   function renderParameterDefinitions(artifactName, params) {
@@ -1087,7 +1108,7 @@ function toSqlDdl(csn, options) {
       for (const pn in params) {
         const p = params[pn];
         if (p.notNull === true || p.notNull === false)
-          info(null, [ 'definitions', artifactName, 'params', pn ], 'Not Null constraints on SQL view parameters are not allowed and are ignored');
+          info('query-ignoring-param-nullability', [ 'definitions', artifactName, 'params', pn ], { '#': 'sql' });
         // do not quote parameter identifiers for naming mode "quoted" / "hdbcds"
         // this would be an incompatible change, as non-uppercased, quoted identifiers
         // are rejected by the HANA compiler.
@@ -1333,27 +1354,27 @@ function toSqlDdl(csn, options) {
    * (no trailing LF, don't indent if inline)
    *
    * @todo Reuse this with toCdl
-   * @param {Array|object|string} x Expression to render
+   * @param {Array|object|string} expr Expression to render
    * @param {object} env Render environment
    * @param {boolean} inline Wether to render the expression inline
    * @param {boolean} nestedExpr Wether to treat the expression as nested
    * @returns {string} Rendered expression
    */
-  function renderExpr(x, env, inline = true, nestedExpr = false) {
+  function renderExpr(expr, env, inline = true, nestedExpr = false) {
     // Compound expression
-    if (Array.isArray(x)) {
-      const tokens = x.map(item => renderExpr(item, env, inline, nestedExpr));
+    if (Array.isArray(expr)) {
+      const tokens = expr.map(item => renderExpr(item, env, inline, nestedExpr));
       return beautifyExprArray(tokens);
     }
-    else if (typeof x === 'object' && x !== null) {
-      if (nestedExpr && x.cast && x.cast.type)
-        return renderExplicitTypeCast(renderExprObject());
-      return renderExprObject();
+    else if (typeof expr === 'object' && expr !== null) {
+      if (nestedExpr && expr.cast && expr.cast.type)
+        return renderExplicitTypeCast(expr, renderExprObject(expr));
+      return renderExprObject(expr);
     }
     // Not a literal value but part of an operator, function etc - just leave as it is
     // FIXME: For the sake of simplicity, we should get away from all this uppercasing in toSql
 
-    return String(x).toUpperCase();
+    return String(expr).toUpperCase();
 
 
     /**
@@ -1361,7 +1382,7 @@ function toSqlDdl(csn, options) {
      *
      * @returns {string} String representation of the expression
      */
-    function renderExprObject() {
+    function renderExprObject(x) {
       if (x.list) {
         return `(${x.list.map(item => renderExpr(item)).join(', ')})`;
       }
@@ -1383,6 +1404,8 @@ function toSqlDdl(csn, options) {
       // Function call, possibly with args (use '=>' for named args)
       else if (x.func) {
         const funcName = smartFuncId(prepareIdentifier(x.func), options.toSql.dialect);
+        if (x.xpr)
+          return renderWindowFunction(funcName, x, env);
         return renderFunc(funcName, x, options.toSql.dialect, a => renderArgs(a, '=>', env, null));
       }
       // Nested expression
@@ -1405,6 +1428,13 @@ function toSqlDdl(csn, options) {
       throw new Error(`Unknown expression: ${JSON.stringify(x)}`);
     }
 
+    function renderWindowFunction(funcName, node, fctEnv) {
+      const suffix = node.xpr[0]; // OVER
+      let r = `${funcName}(${renderArgs(node, '=>', fctEnv, null)})`;
+      r += ` ${suffix} (${renderExpr(node.xpr.slice(1), fctEnv)})`; // do not pass suffix in renderExpr
+      return r;
+    }
+
     function renderExpressionLiteral(x) {
       // Literal value, possibly with explicit 'literal' property
       switch (x.literal || typeof x.val) {
@@ -1441,7 +1471,12 @@ function toSqlDdl(csn, options) {
 
     function renderExpressionRef(x) {
       if (!x.param && !x.global) {
+        const magicReplacement = getVariableReplacement(x.ref, options);
+
         if (x.ref[0] === '$user') {
+          if (magicReplacement !== null)
+            return `'${magicReplacement}'`;
+
           const result = render$user(x);
           // Invalid second path step doesn't cause a return
           if (result)
@@ -1453,6 +1488,9 @@ function toSqlDdl(csn, options) {
           if (result)
             return result;
         }
+        else if (x.ref[0] === '$session' && magicReplacement !== null) {
+          return `'${magicReplacement}'`;
+        }
       }
       // FIXME: We currently cannot distinguish whether '$parameters' was quoted or not - we
       // assume that it was not if the path has length 2 (
@@ -1475,6 +1513,7 @@ function toSqlDdl(csn, options) {
     function render$user(x) {
       // FIXME: this is all not enough: we might need an explicit select item alias
       if (x.ref[1] === 'id') {
+        // Keep the old-style for compatibilty with magicVars.id - instead of magicVars.user.id...
         if (options.toSql.user && typeof options.toSql.user === 'string' || options.toSql.user instanceof String)
           return `'${options.toSql.user}'`;
 
@@ -1482,7 +1521,7 @@ function toSqlDdl(csn, options) {
           return `'${options.toSql.user.id}'`;
 
         if (options.toSql.dialect === 'sqlite' || options.toSql.dialect === 'plain') {
-          warning(null, null, 'The "$user" variable is not supported. Use the "toSql.user" option to set a value for "$user.id"');
+          warning(null, null, 'The "$user" variable is not supported. Use option "variableReplacements" to specify a value for "$user.id"');
           return '\'$user.id\'';
         }
         return 'SESSION_CONTEXT(\'APPLICATIONUSER\')';
@@ -1494,7 +1533,7 @@ function toSqlDdl(csn, options) {
         }
         return 'SESSION_CONTEXT(\'LOCALE\')';
       }
-      // Basically: Second path step was invalid, do nothing
+      // Basically: Second path step was invalid, do nothing - should not happen, see 'unknownMagic.js'
       return null;
     }
     /**
@@ -1547,10 +1586,11 @@ function toSqlDdl(csn, options) {
     /**
      * Renders an explicit `cast()` inside an 'xpr'.
      *
+     * @param {object} x Expression with cast
      * @param {string} value Value to cast
      * @returns {string} CAST statement
      */
-    function renderExplicitTypeCast(value) {
+    function renderExplicitTypeCast(x, value) {
       const typeRef = renderBuiltinType(x.cast.type) + renderTypeParameters(x.cast);
       return `CAST(${value} AS ${typeRef})`;
     }

package/lib/render/utils/common.js

@@ -19,6 +19,7 @@ const {
 } = require('../../model/csnUtils');
 
 const { implicitAs } = require('../../model/csnRefs');
+const { isBetaEnabled } = require('../../base/model');
 
 
 /**
@@ -205,12 +206,11 @@ function addMissingChildContexts(csn, artifactName, killList) {
       addPossibleGaps(name.slice(artifactName.length + 1).split('.'), artifactName);
   }
 
-  function addPossibleGaps(possibleGaps, artifactName) {
-    let possibleGap = artifactName;
+  function addPossibleGaps(possibleGaps, gapArtifactName) {
     for (const gap of possibleGaps) {
-      possibleGap += `.${gap}`;
-      if (!csn.definitions[possibleGap]) {
-        const contextName = possibleGap;
+      gapArtifactName += `.${gap}`;
+      if (!csn.definitions[gapArtifactName]) {
+        const contextName = gapArtifactName;
         csn.definitions[contextName] = {
           kind: 'context',
         };
@@ -355,6 +355,24 @@ function getHanaComment(obj) {
   return obj.doc.split('\n\n')[0].trim().replace(/'/g, "''");
 }
 
+/**
+ * Get the @sql.prepend/append if set - already add a space after/before.
+ * If no value is set, use '';
+ *
+ * @param {CSN.Options} options
+ * @param {object} obj
+ * @returns {object} object with .front and .back
+ */
+function getSqlSnippets(options, obj) {
+  if (isBetaEnabled(options, 'sqlSnippets')) {
+    const front = obj['@sql.prepend'] ? `${obj['@sql.prepend']} ` : '';
+    const back = obj['@sql.append'] ? ` ${obj['@sql.append']}` : '';
+
+    return { front, back };
+  }
+  return { front: '', back: '' };
+}
+
 /**
  * @typedef CdlRenderEnvironment Rendering environment used throughout the render process.
  *
@@ -383,4 +401,5 @@ module.exports = {
   getHanaComment,
   findElement,
   funcWithoutParen,
+  getSqlSnippets,
 };

package/lib/render/utils/sql.js

@@ -13,11 +13,11 @@ const { smartId, delimitedId } = require('../../sql-identifier');
  * @param {boolean} toUpperCase Wether to uppercase the identifier
  * @param {CSN.Model} csn CSN
  * @param {CSN.Options} options is needed for the naming mode and the sql dialect
- * @param {boolean} alterConstraint whether the constraint should be rendered as part of an ALTER TABLE statement
+ * @param {boolean} [alterConstraint=false] whether the constraint should be rendered as part of an ALTER TABLE statement
  *
  * @returns {string} SQL statement which can be used to create the referential constraint on the db.
  */
-function renderReferentialConstraint(constraint, indent, toUpperCase, csn, options, alterConstraint) {
+function renderReferentialConstraint(constraint, indent, toUpperCase, csn, options, alterConstraint = false) {
   let quoteId;
   // for to.hana we can't utilize the sql identifier utils
   if (options.transformation === 'hdbcds') {
@@ -51,14 +51,16 @@ function renderReferentialConstraint(constraint, indent, toUpperCase, csn, optio
   if (!alterConstraint) {
     result += `${indent}FOREIGN KEY(${constraint.foreignKey.map(quoteId).join(', ')})\n`;
     result += `${indent}REFERENCES ${quoteId(getResultingName(csn, names, constraint.parentTable))}(${constraint.parentKey.map(quoteId).join(', ')})\n`;
+    const onDeleteRemark = constraint.onDeleteRemark ? ` -- ${constraint.onDeleteRemark}` : '';
+
     // omit 'RESTRICT' action for ON UPDATE / ON DELETE, because it interferes with deferred constraint check
     if (forSqlite) {
       if (constraint.onDelete === 'CASCADE' )
-        result += `${indent}ON DELETE ${constraint.onDelete}${constraint.onDeleteRemark ? ` -- ${constraint.onDeleteRemark}` : ''}\n`;
+        result += `${indent}ON DELETE ${constraint.onDelete}${onDeleteRemark}\n`;
     }
     else {
       result += `${indent}ON UPDATE RESTRICT\n`;
-      result += `${indent}ON DELETE ${constraint.onDelete}${constraint.onDeleteRemark ? ` -- ${constraint.onDeleteRemark}` : ''}\n`;
+      result += `${indent}ON DELETE ${constraint.onDelete}${onDeleteRemark}\n`;
     }
   }
   // constraint enforcement / validation must be switched off using sqlite pragma statement

package/lib/transform/braceExpression.js

@@ -1,8 +1,10 @@
 'use strict';
 
 function isAlreadyBraced(expression, start, end){
-  const isBraced = start - 1 > -1 && end + 1 < expression.length && expression[start-1] === '(' && expression[end+1] === ')';
-  return isBraced;
+  return start - 1 > -1 &&
+    end + 1 < expression.length &&
+    expression[start-1] === '(' &&
+    expression[end+1] === ')';
 }
 
 function binarycomparison(expression, token, index){