@sap/cds-compiler 5.0.6 → 5.1.2

package/lib/optionProcessor.js

@@ -23,6 +23,7 @@ optionProcessor
   .option('    --options <file>')
   .option('-w, --warning <level>', { valid: ['0', '1', '2', '3'] })
   .option('    --quiet')
+  .option('-i, --stdin')
   .option('    --show-message-id')
   .option('    --no-message-id')
   .option('    --no-message-context')
@@ -89,6 +90,7 @@ optionProcessor
        --cds-home <dir>     When set, modules starting with '@sap/cds/' are searched in <dir>
        --module-lookup-directories <list>  Comma separated list of directories to look
                             for CDS modules. Default is 'node_modules/'.
+   -i, --stdin              Read input from stdin.
        --                   Indicate the end of options (helpful if source names start with "-")
 
   Type options

package/lib/render/toCdl.js

@@ -13,11 +13,11 @@ const { typeParameters, specialFunctions } = require('../compiler/builtins');
 const { isAnnotationExpression } = require('../base/builtins');
 const { forEach } = require('../utils/objectUtils');
 const {
-  generatedByCompilerVersion,
   getNormalizedQuery,
 } = require('../model/csnUtils');
 const { isBuiltinType } = require('../base/builtins');
 const { cloneFullCsn } = require('../model/cloneCsn');
+const { getKeysDict } = require('../model/csnRefs');
 
 const identifierRegex = /^[$_a-zA-Z][$_a-zA-Z0-9]*$/;
 const specialFunctionKeywords = Object.create(null);
@@ -62,7 +62,7 @@ function csnToCdl( csn, options, msg ) {
   const hanaRequiresAbsolutePath = usings.available.includes('hana');
 
   const cdlResult = Object.create(null);
-  cdlResult.model = options.testMode ? '' : `// ${generatedByCompilerVersion()} \n`;
+  cdlResult.model = '';
 
   const subelementAnnotates = [];
 
@@ -676,7 +676,7 @@ function csnToCdl( csn, options, msg ) {
       artifact = artifact.items;
     }
 
-    if (!artifact.elements && !artifact.enum)
+    if (!artifact.elements && !artifact.enum && !artifact.keys)
       return null;
 
     const annotate = { annotate: env.path[1] };
@@ -712,15 +712,16 @@ function csnToCdl( csn, options, msg ) {
      */
     function collectAnnos( annotateObj, art ) {
       if (!Object.hasOwnProperty.call(art, 'elements') &&
-          !Object.hasOwnProperty.call(art, 'enum'))
+        !Object.hasOwnProperty.call(art, 'enum') &&
+        !Object.hasOwnProperty.call(art, 'keys'))
         return false;
 
-      const dictKey = art.elements ? 'elements' : 'enum';
-      // Use "elements" for both enums and elements. This is allowed in extensions.
+      const dict = art.enum || art.keys && getKeysDict(art) || art.elements;
+      // Use "elements" for all. This is allowed in extensions.
       const collected = { elements: Object.create(null) };
       let hasAnnotation = false;
 
-      forEach(art[dictKey], (elemName, element) => {
+      forEach(dict, (elemName, element) => {
         if (!collected.elements[elemName])
           collected.elements[elemName] = { };
 

package/lib/render/toHdbcds.js

@@ -2,7 +2,7 @@
 
 const {
   getLastPartOf, getLastPartOfRef,
-  hasValidSkipOrExists, generatedByCompilerVersion, getNormalizedQuery,
+  hasValidSkipOrExists, getNormalizedQuery,
   getRootArtifactName, getResultingName, getNamespace, forEachMember, getVariableReplacement, hasAnnotationValue,
   pathName,
 } = require('../model/csnUtils');
@@ -167,7 +167,6 @@ function toHdbcdsSource( csn, options, messageFunctions ) {
     if (sourceStr !== '') {
       const name = plainNames ? artifactName.replace(/\./g, '_').toUpperCase() : artifactName;
       hdbcds[name] = [
-        !options.testMode ? `// ${generatedByCompilerVersion()} \n` : '',
         renderNamespaceDeclaration(name, env),
         renderUsings(name, env),
         sourceStr,

package/lib/render/toSql.js

@@ -3,7 +3,7 @@
 
 const {
   getLastPartOf, getLastPartOfRef,
-  hasValidSkipOrExists, generatedByCompilerVersion, getNormalizedQuery,
+  hasValidSkipOrExists, getNormalizedQuery,
   forEachDefinition, getResultingName,
   getVariableReplacement, pathName,
 } = require('../model/csnUtils');
@@ -186,8 +186,11 @@ function toSqlDdl( csn, options, messageFunctions ) {
     deletions: Object.create(null),
     constraintDeletions: [],
     migrations: Object.create(null),
+    hdbrole: Object.create(null),
   };
 
+  const sqlServiceEntities = Object.create(null);
+
   // Registries for artifact and element names per CSN section
   const definitionsDuplicateChecker = new DuplicateChecker(options.sqlMapping);
   const deletionsDuplicateChecker = new DuplicateChecker();
@@ -252,6 +255,25 @@ function toSqlDdl( csn, options, messageFunctions ) {
     });
   }
 
+  // Can only happen for HDI based deployment
+  // .hdbrole documentation: https://help.sap.com/docs/SAP_HANA_PLATFORM/3823b0f33420468ba5f1cf7f59bd6bd9/625d7733c30b4666b4a522d7fa68a550.html
+  Object.keys(sqlServiceEntities).forEach((sqlServiceName) => {
+    const accessRole = {
+      role: {
+        name: renderArtifactNameWithoutQuotes(`${sqlServiceName }.access`),
+        object_privileges: Object.entries(sqlServiceEntities[sqlServiceName]).map(([ name, entity ]) => ({
+          name: renderArtifactNameWithoutQuotes(name),
+          type: entity.query || entity.projection ? 'VIEW' : 'TABLE',
+          privileges: [ 'SELECT' ],
+          privileges_with_grant_option: [],
+        })),
+      },
+    };
+
+    if (accessRole.role.object_privileges.length > 0)
+      mainResultObj.hdbrole[`${sqlServiceName }_access`] = JSON.stringify(accessRole, null, 2);
+  });
+
   // trigger artifact and element name checks
   definitionsDuplicateChecker.check(error, options);
   extensionsDuplicateChecker.check(error);
@@ -264,7 +286,6 @@ function toSqlDdl( csn, options, messageFunctions ) {
   // (relying on the order of dictionaries above)
   // FIXME: Should consider inter-view dependencies, too
   const sql = Object.create(null);
-  const sqlVersionLine = `-- ${generatedByCompilerVersion()}\n`;
 
   // Handle hdbKinds separately from alterTable case
   const {
@@ -278,10 +299,7 @@ function toSqlDdl( csn, options, messageFunctions ) {
         // Hack: Other than in 'hdbtable' files, in HANA SQL COLUMN is not mandatory but default.
         if (options.sqlDialect === 'hana' && hdbKind === 'hdbtable' && sourceString.startsWith('COLUMN '))
           sourceString = sourceString.slice('COLUMN '.length);
-        sql[name] = `${options.testMode ? '' : sqlVersionLine}CREATE ${sourceString};`;
-      }
-      else if (!options.testMode && options.generatedByComment) {
-        mainResultObj[hdbKind][name] = sqlVersionLine + mainResultObj[hdbKind][name];
+        sql[name] = `CREATE ${sourceString};`;
       }
     }
     if (options.src === 'sql')
@@ -295,7 +313,7 @@ function toSqlDdl( csn, options, messageFunctions ) {
 
     forEachKey(alterStmts, (constraintName) => {
       if (!csn.unchangedConstraints?.has(constraintName))
-        constraints[constraintName] = `${options.testMode ? '' : sqlVersionLine}${alterStmts[constraintName]}`;
+        constraints[constraintName] = `${alterStmts[constraintName]}`;
     });
     mainResultObj.constraints = constraints;
   }
@@ -304,7 +322,7 @@ function toSqlDdl( csn, options, messageFunctions ) {
     mainResultObj.sql = sql;
 
   for (const name in deletions)
-    deletions[name] = `${options.testMode || !options.generatedByComment ? '' : sqlVersionLine}${deletions[name]}`;
+    deletions[name] = `${deletions[name]}`;
 
   timetrace.stop('SQL rendering');
   return mainResultObj;
@@ -325,6 +343,10 @@ function toSqlDdl( csn, options, messageFunctions ) {
 
     switch (art.kind) {
       case 'entity':
+        if (art.$sqlService) { // collect entities that are in a sql service so we can render the .hdbrole later
+          sqlServiceEntities[art.$sqlService] ??= Object.create(null);
+          sqlServiceEntities[art.$sqlService][artifactName] = art;
+        }
         if (art.query || art.projection) {
           const result = renderView(artifactName, art, env);
           if (result)
@@ -350,6 +372,20 @@ function toSqlDdl( csn, options, messageFunctions ) {
     }
   }
 
+  /**
+   * Render the given artifactName according to the sqlMapping, but
+   * - uppercased for plain
+   * - without enclosing " for quoted/hdbcds
+   *
+   * @param {string} artifactName
+   * @returns {string}
+   */
+  function renderArtifactNameWithoutQuotes( artifactName ) {
+    if (options.sqlMapping === 'plain')
+      return renderArtifactName(artifactName).toUpperCase();
+    return renderArtifactName(artifactName).slice(1, -1); // trim leading/trailing "
+  }
+
   /**
    * Render an artifact extension into the appropriate dictionary of 'resultObj'.
    * Only SAP HANA SQL is currently supported.

package/lib/transform/db/backlinks.js

@@ -193,7 +193,7 @@ function getBacklinkTransformer( csnUtils, messageFunctions, options, pathDelimi
     // Transform comparison of $self to managed association into AND-combined foreign key comparisons
     if (assoc.keys) {
       if (assoc.keys.length)
-        return transformDollarSelfComparisonWithManagedAssoc(assocOp, assoc, assocName, elemName);
+        return transformDollarSelfComparisonWithManagedAssoc(assocOp, assoc, assocName, elemName, art, path);
 
       if (options.transformation !== 'effective')
         elem.$ignore = true;
@@ -202,7 +202,7 @@ function getBacklinkTransformer( csnUtils, messageFunctions, options, pathDelimi
 
     // Transform comparison of $self to unmanaged association into "reversed" ON-condition
     else if (assoc.on) {
-      return transformDollarSelfComparisonWithUnmanagedAssoc(assocOp, assoc, assocName, elemName);
+      return transformDollarSelfComparisonWithUnmanagedAssoc(assocOp, assoc, assocName, elemName, art, path);
     }
 
     throw new ModelError(`Expected either managed or unmanaged association in $self-comparison: ${JSON.stringify(elem.on)}`);
@@ -220,9 +220,11 @@ function getBacklinkTransformer( csnUtils, messageFunctions, options, pathDelimi
    * @param {CSN.Element} assoc
    * @param {string} originalAssocName
    * @param {string} elemName
+   * @param {CSN.Artifact} art
+   * @param {CSN.Path} path
    * @returns {Array} New on-condition
    */
-  function transformDollarSelfComparisonWithManagedAssoc( assocOp, assoc, originalAssocName, elemName ) {
+  function transformDollarSelfComparisonWithManagedAssoc( assocOp, assoc, originalAssocName, elemName, art, path) {
     const conditions = [];
     // if the element was structured then it was flattened => change of the delimiter from '.' to '_'
     // this is done in the flattening, but as we do not alter the onCond itself there should be done here as well
@@ -245,7 +247,9 @@ function getBacklinkTransformer( csnUtils, messageFunctions, options, pathDelimi
       if (prepend$self)
         a[1].ref = [ '$self', ...a[1].ref ];
 
-
+      // Not without a2j so we can rely on a certain model state
+      if (doA2J && prepend$self && art.elements[k.ref[1]] || !prepend$self && !art.elements[k.ref[0]])
+        messageFunctions.message('ref-missing-self-counterpart', path, { prop: k.ref[0], name: assocName });
       conditions.push([ a[0], '=', a[1] ]);
     });
 
@@ -268,9 +272,11 @@ function getBacklinkTransformer( csnUtils, messageFunctions, options, pathDelimi
    * @param {CSN.Element} assoc
    * @param {string} originalAssocName
    * @param {string} elemName
+   * @param {CSN.Artifact} art
+   * @param {CSN.Path} path
    * @returns {Array} New on-condition
    */
-  function transformDollarSelfComparisonWithUnmanagedAssoc( assocOp, assoc, originalAssocName, elemName ) {
+  function transformDollarSelfComparisonWithUnmanagedAssoc( assocOp, assoc, originalAssocName, elemName, art, path ) {
     // if the element was structured then it may have been flattened => change of the delimiter from '.' to '_'
     // this is done in the flattening, but as we do not alter the onCond itself there should be done here as well
     elemName = elemName.replace(/\./g, pathDelimiter);
@@ -279,11 +285,14 @@ function getBacklinkTransformer( csnUtils, messageFunctions, options, pathDelimi
     const newOnCond = cloneCsnNonDict(assoc.on, options);
     applyTransformationsOnNonDictionary({ on: newOnCond }, 'on', {
       ref: (parent, prop, ref) => {
+        let sourceSide = false;
         // we are in the "path" from the forwarding assoc => need to remove the first part of the path
         if (ref[0] === assocName) {
           ref.shift();
           if (prepend$self)
             ref.unshift('$self');
+
+          sourceSide = true;
         }
         else if (ref.length > 1 && ref[0] === '$self' && ref[1] === assocName) {
           // We could also have a $self in front of the assoc name - so we would need to shift twice
@@ -291,6 +300,8 @@ function getBacklinkTransformer( csnUtils, messageFunctions, options, pathDelimi
           ref.shift();
           if (prepend$self)
             ref.unshift('$self');
+
+          sourceSide = true;
         }
         else { // we are in the backlink assoc "path" => need to push at the beginning the association's id
           ref.unshift(elemName);
@@ -299,6 +310,10 @@ function getBacklinkTransformer( csnUtils, messageFunctions, options, pathDelimi
           if (ref[1] === '$self')
             ref.splice(1, 1);
         }
+
+        // Not without a2j so we can rely on a certain model state
+        if (doA2J && sourceSide && (prepend$self && !art.elements[ref[1]] || !prepend$self && !art.elements[ref[0]]))
+          messageFunctions.message('ref-missing-self-counterpart', path, { '#': 'unmanaged', prop: ref[0], name: assocName });
       },
     });
     return newOnCond;

package/lib/transform/db/killAnnotations.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const { sqlServiceAnnotation } = require('./processSqlServices');
+
 const requiredAnnos = {
   '@cds.persistence.skip': true,
   '@cds.persistence.exists': true,
@@ -22,6 +24,7 @@ const requiredAnnos = {
   '@cds.autoexposed': true,
   '@cds.redirection.target': true,
   '@Core.Computed': true,
+  [sqlServiceAnnotation]: true,
 };
 
 /**

package/lib/transform/db/processSqlServices.js

@@ -0,0 +1,63 @@
+'use strict';
+
+const { setProp } = require('../../base/model');
+
+const sqlServiceAnnotation = '@protocol';
+// Problem: How can we clone a Symbol when sorting?
+// const sqlServiceEntities = Symbol.for('SQL Service enabled entities');
+/**
+ * Find all entities in SQL services and mark them with an annotation and
+ * remember them in a symbol property for easier processing in toSql-rendering.
+ *
+ * @param {CSN.Model} csn
+ * @returns {Function}
+ */
+function processSqlServices(csn) {
+  setProp(csn, '$sqlServiceEntities', Object.create(null));
+  return function findAndMarkSqlServiceArtifacts(artifact, artifactName) {
+    const sqlServiceName = isEntityInSqlService(artifact, artifactName, csn);
+    if (sqlServiceName?.length > 0)
+      setProp(artifact, '$sqlService', sqlServiceName);
+  };
+}
+
+/**
+ *
+ * @param {CSN.Artifact} artifact
+ * @returns {boolean}
+ */
+function isSqlService(artifact) {
+  return artifact.kind === 'service' && artifact[sqlServiceAnnotation] === 'sql';
+}
+/**
+ *
+ * @param {CSN.Artifact} artifact
+ * @param {string} artifactName
+ * @param {CSN.Model} csn
+ * @returns {string|null}
+ */
+function isEntityInSqlService(artifact, artifactName, csn) {
+  if (artifact.kind !== 'entity' || !artifactName.includes('.'))
+    return null;
+
+  const nameParts = artifactName.split('.');
+  for (let i = nameParts.length; i >= 0; i--) {
+    const possibleServiceName = nameParts.slice(0, i).join('.');
+    if (!csn.definitions[possibleServiceName])
+      continue;
+
+    const definition = csn.definitions[possibleServiceName];
+    if (isSqlService(definition))
+      return possibleServiceName;
+
+    // We don't allow nested services/contexts - if we find one, we don't need to keep searching
+    if (definition.kind === 'service' || definition.kind === 'context')
+      return null;
+  }
+
+  return null;
+}
+
+module.exports = {
+  processSqlServices, isSqlService, sqlServiceAnnotation,
+};

package/lib/transform/draft/odata.js

@@ -230,14 +230,19 @@ function generateDrafts( csn, options, services, messageFunctions ) {
 
     function $draft2$self(member) {
       Object.keys(member).forEach(pn => {
-        if(pn[0] === '@')
+        if(pn[0] === '@') {
+          let refChanged = false;
           transformExpression(member, pn,{
             ref: (_parent, _prop, xpr, _path) => {
               if(xpr[0] === '$draft') {
                 xpr[0] = '$self';
+                refChanged = true;
               }
             }
           });
+          if (refChanged)
+            member[pn]['='] = true;
+        }
       });
     }
 

package/lib/transform/forRelationalDB.js

@@ -34,6 +34,7 @@ const backlinks = require('./db/backlinks');
 const { getDefaultTypeLengths } = require('../render/utils/common');
 const { featureFlags } = require('./db/featureFlags');
 const { cloneCsnNonDict, cloneFullCsn } = require('../model/cloneCsn');
+const { processSqlServices } = require('./db/processSqlServices');
 
 // By default: Do not process non-entities/views
 function forEachDefinition(csn, cb) {
@@ -368,6 +369,8 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
     removeKeyPropInType,
   ]);
 
+  // TODO: Might have to do this earlier if we want special rendering for projections?
+  const findAndMarkSqlServiceArtifacts = options.sqlDialect === 'hana' && options.src === 'hdi' && csn.meta?.[featureFlags]?.$sqlService ? processSqlServices(csn): () => {}
 
   // TODO: Could we maybe merge this with the final applyTransformations?
   applyTransformations(csn, {
@@ -387,6 +390,8 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
     // Attach @cds.persistence.name to artifacts
     if (!artifact.$ignore && artifact.kind !== 'service' && artifact.kind !== 'context')
       csnUtils.addStringAnnotationTo('@cds.persistence.name', getArtifactDatabaseNameOf(artifactName, options.sqlMapping, csn, options.sqlDialect), artifact);
+
+    findAndMarkSqlServiceArtifacts(artifact, artifactName);
   }], { allowArtifact: artifact => artifact.kind === 'entity'});
 
   throwWithAnyError();
@@ -700,6 +705,10 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
         newCsn.definitions[artName].technicalConfig = art.technicalConfig;
 
     });
+
+    // To ensure we preserve feature flags
+    newCsn.meta = csn.meta;
+
     csn = newCsn;
   }
 

package/lib/utils/file.js

@@ -4,6 +4,8 @@
 
 const fs = require('fs');
 const util = require('util');
+const path = require('path');
+const os = require('os');
 
 /**
  * Split the given source string into its lines.  Respects Unix,
@@ -16,6 +18,74 @@ function splitLines( src ) {
   return src.split(/\r\n?|\n/);
 }
 
+/**
+ * Returns the file's normalized extension, e.g. for `file.CDS` -> `cds`
+ * Returns null if the given filename is not a string.
+ *
+ * @param filename
+ * @returns {null|string}
+ */
+function fileExtension( filename ) {
+  if (typeof filename === 'string')
+    return path.extname( filename ).slice(1).toLowerCase();
+  return null;
+}
+
+/**
+ * Create a temporary file path using the system's temporary folder and a filename
+ * consisting of the given name/extension and a random string.
+ *
+ * @param {string} name
+ * @param {string} extension
+ * @returns {string}
+ */
+function tmpFilePath( name, extension ) {
+  const crypto = require('crypto');
+  const id = crypto.randomBytes(32).toString('hex');
+  const filename = `${ name }-${ id }.${ extension }`;
+  return path.join(os.tmpdir(), filename);
+}
+
+/**
+ * Read input from the given stream.
+ * See https://nodejs.org/api/stream.html#readablereadsize
+ *
+ * @returns {Promise<string>}
+ */
+function readStream( stream ) {
+  return new Promise((resolve, reject) => {
+    const chunks = [];
+
+    const listeners = {
+      __proto__: null,
+      data: onData,
+      error: onError,
+      end: onEnd,
+    };
+    for (const name in listeners)
+      stream.on(name, listeners[name]);
+
+    function onData( chunk ) {
+      chunks.push(chunk);
+    }
+
+    function onEnd() {
+      removeListeners();
+      resolve(chunks.join(''));
+    }
+
+    function onError( error ) {
+      removeListeners();
+      reject(error);
+    }
+
+    function removeListeners() {
+      for (const name in listeners)
+        stream.removeListener(name, listeners[name]);
+    }
+  });
+}
+
 /**
  * Returns filesystem utils readFile(), isFile(), realpath() for _CDS_ usage.
  * This includes a trace as well as usage of a file cache.
@@ -61,18 +131,18 @@ function cdsFs( fileCache, enableTrace ) {
   };
 
 
-  function realpathSync( path, cb ) {
+  function realpathSync( filepath, cb ) {
     try {
-      cb(null, fs.realpathSync(path));
+      cb(null, fs.realpathSync(filepath));
     }
     catch (err) {
       cb(err, null);
     }
   }
 
-  function realpathSyncNative( path, cb ) {
+  function realpathSyncNative( filepath, cb ) {
     try {
-      cb(null, fs.realpathSync.native(path));
+      cb(null, fs.realpathSync.native(filepath));
     }
     catch (err) {
       cb(err, null);
@@ -194,5 +264,8 @@ function cdsFs( fileCache, enableTrace ) {
 
 module.exports = {
   splitLines,
+  readStream,
+  fileExtension,
+  tmpFilePath,
   cdsFs,
 };

package/package.json

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