@sap/cds-compiler 2.13.8 → 3.0.0

package/lib/compiler/index.js

@@ -33,6 +33,7 @@ const check = require('./checks');
 
 const { emptyWeakLocation } = require('../base/location');
 const { createMessageFunctions, deduplicateMessages } = require('../base/messages');
+const { checkRemovedDeprecatedFlags } = require('../base/model');
 const { promiseAllDoNotRejectImmediately } = require('../base/node-helpers');
 const { cdsFs } = require('../utils/file');
 
@@ -128,30 +129,35 @@ function compileX( filenames, dir = '', options = {}, fileCache = Object.create(
   // if (Object.getPrototypeOf( fileCache ))
   //   fileCache = Object.assign( Object.create(null), fileCache );
   dir = path.resolve(dir);
-  const a = processFilenames( filenames, dir );
-
-  const model = { sources: a.sources, options };
+  const model = { sources: null, options };
   model.$messageFunctions = createMessageFunctions( options, 'compile', model );
-  let all = promiseAllDoNotRejectImmediately( a.files.map(readAndParse) );
-
-  all = all
+  let input = null;
+
+  let all = processFilenames( filenames, dir )
+    .then((processedInput) => {
+      input = processedInput;
+      model.sources = input.sources;
+    })
+    .then(() => promiseAllDoNotRejectImmediately( input.files.map(readAndParse) ))
     .then( testInvocation, (reason) => {
       // do not reject with PromiseAllError, use InvocationError:
       const errs = reason.valuesOrErrors.filter( e => e instanceof Error );
       // internal error if no file IO error (has property `path`)
       return Promise.reject( errs.find( e => !e.path ) ||
-                             new InvocationError( [ ...a.repeated, ...errs ]) );
+                             new InvocationError( [ ...input.repeated, ...errs ]) );
     });
+
   if (!options.parseOnly && !options.parseCdl)
     all = all.then( readDependencies );
+
   return all.then( () => {
-    moduleLayers.setLayers( a.sources );
+    moduleLayers.setLayers( input.sources );
     return compileDoX( model );
   });
 
   // Read file `filename` and parse its content, return messages
   async function readAndParse( filename ) {
-    const { sources } = a;
+    const { sources } = input;
     if ( filename === false )   // module which has not been found
       return [];
     const rel = sources[filename] || path.relative( dir, filename );
@@ -173,9 +179,9 @@ function compileX( filenames, dir = '', options = {}, fileCache = Object.create(
 
   // Combine the parse results (if there are not file IO errors)
   function testInvocation( values ) {
-    if (a.repeated.length)
+    if (input.repeated.length)
       // repeated file names in invocation => just report these
-      return Promise.reject( new InvocationError(a.repeated) );
+      return Promise.reject( new InvocationError(input.repeated) );
     return values;
   }
 
@@ -219,18 +225,19 @@ function compileX( filenames, dir = '', options = {}, fileCache = Object.create(
  * @param {string} [dir=""] Base directory. All files are resolved relatively
  *                          to this directory
  * @param {object} [options={}] Compilation options.
+ * @param {object} [fileCache]
  * @returns {XSN.Model} Augmented CSN
  */
 function compileSyncX( filenames, dir = '', options = {}, fileCache = Object.create(null) ) {
   // A non-proper dictionary (i.e. with prototype) is safe if the keys are
   // absolute file names - they start with `/` or `\` or similar
   dir = path.resolve(dir);
-  const a = processFilenames( filenames, dir );
+  const a = processFilenamesSync( filenames, dir );
 
   const model = { sources: a.sources, options };
   model.$messageFunctions = createMessageFunctions( options, 'compile', model );
 
-  let asts = [];
+  const asts = [];
   const errors = [];
   a.files.forEach( val => readAndParseSync( val, (err, ast) => {
     if (err)
@@ -248,17 +255,16 @@ function compileSyncX( filenames, dir = '', options = {}, fileCache = Object.cre
   if (!options.parseOnly && !options.parseCdl) {
     while (asts.length) {
       const fileNames = readDependenciesSync( asts );
-      asts = [];
-      // TODO: check the following eslint error
-      // eslint-disable-next-line no-loop-func
-      fileNames.forEach( (fileName) => {
+      asts.length = 0;
+      // Push dependencies to `ast`. Only works because readAndParseSync() is synchronous.
+      for (const fileName of fileNames) {
         readAndParseSync(fileName, ( err, ast ) => {
           if (err)
             throw err;
           if (ast)
             asts.push( ast );
         });
-      } );
+      }
     }
   }
 
@@ -373,6 +379,15 @@ function compileSourcesX( sourcesDict, options = {} ) {
       ast.location = { file: filename };
       assertConsistency( ast, options );
     }
+
+    for (const dep of sources[filename].dependencies || []) {
+      if (!dep.realname) {
+        // `realname` is used by setLayers(). For compileSources(), we don't resolve
+        // the USING paths and use the literal instead, which may be part of the
+        // source dictionary.
+        dep.realname = dep.val;
+      }
+    }
   }
   moduleLayers.setLayers( sources );
 
@@ -386,14 +401,15 @@ function compileSourcesX( sourcesDict, options = {} ) {
  * @param {object} options Options
  * @returns {object} XSN
  *
- * TODO: probaby issue message api-recompiled-csn there.
+ * TODO: probably issue message api-recompiled-csn there.
  */
 function recompileX( csn, options ) {
-  options = { ...options, parseCdl: false, $recompile: true };
-  // TODO: $recompile: true should be enough
   // Explicitly set parseCdl to false because backends cannot handle it
-  // Explicitly delete all toCsn options:
+  options = { ...options, parseCdl: false, $recompile: true };
+  // Reset csnFlavor: Use client style (default)
+  delete options.csnFlavor;
   delete options.toCsn;
+  // TODO: $recompile: true should be enough
 
   const file = csn.$location && csn.$location.file &&
     csn.$location.file.replace(/[.]cds$/, '.cds.csn') || '<recompile>.csn';
@@ -423,6 +439,9 @@ function compileDoX( model ) {
   const { throwWithError } = model.$messageFunctions;
   if (!options.testMode)
     model.meta = {}; // provide initial central meta object
+
+  checkRemovedDeprecatedFlags( options, model.$messageFunctions );
+
   if (options.parseOnly) {
     throwWithError();
     return model;
@@ -453,32 +472,76 @@ function compileDoX( model ) {
   return propagator.propagate( model );
 }
 
-// Process an array of `filenames`.  Returns an object with properties:
-//  - `sources`: dictionary which has a filename as key (value is irrelevant)
-//  - `files`: the argument array without repeating the same name
-//  - `repeated`: array of filenames which have been repeatedly listed
-//    (listed only once here even if listed thrice)
-//
-// Note: there is nothing file-specific about the filenames, the filenames are
-// not normalized - any strings work
-function processFilenames( filenames, dir ) {
-  const sources = Object.create(null); // not {} = no [[Prototype]]
-  const files = [];
-  const repeated = [];
+/**
+ * Process an array of `filenames`.  Returns an object with properties:
+ *  - `sources`: dictionary which has a filename as key (value is irrelevant)
+ *  - `files`: the argument array without repeating the same name
+ *  - `repeated`: array of filenames which have been repeatedly listed
+ *    (listed only once here even if listed thrice)
+ *
+ * Note: there is nothing file-specific about the filenames, the filenames are
+ * not normalized - any strings work
+ */
+async function processFilenames( filenames, dir ) {
+  const filenameMap = Object.create(null);
 
+  const promises = [];
   for (const originalName of filenames) {
-    let name = path.resolve(dir, originalName);
+    const setName = (name) => {
+      filenameMap[originalName] = name;
+    };
+    // Resolve possible symbolic link; if the file does not exist
+    // we just continue using the original name because readFile()
+    // already handles non-existent files.
+    const promise = fs.promises.realpath(path.resolve(dir, originalName))
+      .then(setName, () => setName(originalName));
+    promises.push(promise);
+  }
+
+  await Promise.all(promises);
+  return createSourcesDict( filenames, filenameMap, dir );
+}
+
+/**
+ * Synchronous version of processFilenames().
+ */
+function processFilenamesSync( filenames, dir ) {
+  const filenameMap = Object.create(null);
 
+  for (const originalName of filenames) {
+    let name = path.resolve(dir, originalName);
     try {
       // Resolve possible symbolic link; if the file does not exist
       // we just continue using the original name because readFile()
       // already handles non-existent files.
-      name = fs.realpathSync(name);
+      name = fs.realpathSync.native(name);
     }
     catch (e) {
       // Ignore the not-found (ENOENT) error
     }
+    filenameMap[originalName] = name;
+  }
+
+  return createSourcesDict( filenames, filenameMap, dir );
+}
 
+/**
+ * Creates the sources dictionary as well as a list of absolute filenames.
+ * If files are repeated, `repeated` will contain ArgumentErrors for it.
+ *
+ * @param {string[]} filenames List of (possibly relative) filenames. Defines the file order.
+ * @param {Record<string, string>} filenameMap Map from original name to actual filename
+ *                                             (e.g. from symlink to underlying path)
+ * @param {string} dir "Current working directory"
+ * @return {{sources: object, files: string[], repeated: ArgumentError[]}}
+ */
+function createSourcesDict( filenames, filenameMap, dir ) {
+  const sources = Object.create(null);
+  const files = [];
+  const repeated = [];
+
+  for (const originalName of filenames) {
+    const name = filenameMap[originalName];
     if (!sources[name]) {
       sources[name] = path.relative( dir, name );
       files.push(name);
@@ -488,10 +551,10 @@ function processFilenames( filenames, dir ) {
       repeated.push( new ArgumentError( name, msg ) );
     }
   }
+
   return { sources, files, repeated };
 }
 
-
 module.exports = {
   parseX,
   compileX,

package/lib/compiler/moduleLayers.js

@@ -53,6 +53,12 @@ function layer( art ) {
   return art && art._layerRepresentative;
 }
 
+function realname( art ) {
+  while (art && art.kind !== 'source')
+    art = art._block;
+  return art && art.realname || '';
+}
+
 function compareLayer( a, b ) {
   while (a && a.kind !== 'source')
     a = a._block;
@@ -64,5 +70,6 @@ function compareLayer( a, b ) {
 module.exports = {
   setLayers,
   layer,
+  realname,
   compareLayer,
 };

package/lib/compiler/populate.js

@@ -5,9 +5,9 @@
 // used when resolving element references: when starting a references at a
 // certain definition or element, which names are allowed next?
 //
-// To calculate that info, the compiler might needs the same info for other
-// definitions. In other words: it calls itself recursively (using an iterative
-// algorithm where appropriate).  The be able to calculate that info on demand,
+// To calculate that info, the compiler might need the same info for other
+// definitions.  In other words: it calls itself recursively (using an iterative
+// algorithm where appropriate).  To be able to calculate that info on demand,
 // the definitions need to have enough information, which must have been set in
 // an earlier compiler phase.  It is essential to do things in the right order.
 
@@ -74,21 +74,21 @@ function populate( model ) {
   let newAutoExposed = [];
 
   // behavior depending on option `deprecated`:
-  const enableExpandElements = !isDeprecatedEnabled( options, 'noElementsExpansion' );
+  const enableExpandElements = !isDeprecatedEnabled( options, '_noElementsExpansion' );
   // TODO: we should get rid of noElementsExpansion soon; both
   // beta.nestedProjections and beta.universalCsn do not work with it.
   const scopedRedirections
         = enableExpandElements &&
-          !isDeprecatedEnabled( options, 'generatedEntityNameWithUnderscore' ) &&
-          !isDeprecatedEnabled( options, 'shortAutoexposed' ) &&
-          !isDeprecatedEnabled( options, 'longAutoexposed' ) &&
-          !isDeprecatedEnabled( options, 'noInheritedAutoexposeViaComposition' ) &&
-          !isDeprecatedEnabled( options, 'noScopedRedirections' );
+          !isDeprecatedEnabled( options, '_generatedEntityNameWithUnderscore' ) &&
+          !isDeprecatedEnabled( options, '_shortAutoexposed' ) &&
+          !isDeprecatedEnabled( options, '_longAutoexposed' ) &&
+          !isDeprecatedEnabled( options, '_noInheritedAutoexposeViaComposition' ) &&
+          !isDeprecatedEnabled( options, '_noScopedRedirections' );
   const autoexposeViaComposition
-        = (isDeprecatedEnabled( options, 'noInheritedAutoexposeViaComposition' ))
+        = (isDeprecatedEnabled( options, '_noInheritedAutoexposeViaComposition' ))
           ? 'Composition'
           : true;
-  const redirectInSubQueries = isDeprecatedEnabled( options, 'redirectInSubQueries' );
+  const redirectInSubQueries = isDeprecatedEnabled( options, '_redirectInSubQueries' );
 
   forEachDefinition( model, traverseElementEnvironments );
   while (newAutoExposed.length) {
@@ -166,7 +166,7 @@ function populate( model ) {
     const chain = [];
     while (art && !('_effectiveType' in art) &&
            (art.type || art._origin || art.value && art.value.path) &&
-           // TODO: really stop at art.enum?
+           // TODO: really stop at art.enum? See #8942
            !art.target && !art.enum && !art.elements && !art.items) {
       chain.push( art );
       setLink( art, '_effectiveType', 0 ); // initial setting in case of cycles
@@ -564,7 +564,8 @@ function populate( model ) {
         error( null, [ col.location, query ], { prop: (col.expand ? 'expand' : 'inline') },
                'Unsupported nested $(PROP)' );
       }
-      if (!col.value && !col.expand)
+      // If neither expression (value), expand nor new association.
+      if (!col.value && !col.expand && !(col.target && col.type))
         continue;             // error should have been reported by parser
       if (col.inline) {
         col.kind = '$inline';
@@ -1093,7 +1094,7 @@ function populate( model ) {
       return false;
     }
     // no @cds.autoexpose or @cds.autoexpose:null
-    // TODO: introduce deprecated.noInheritedAutoexposeViaComposition
+    // TODO: introduce deprecated._noInheritedAutoexposeViaComposition
     art.$autoexpose = model.$compositionTargets[art.name.absolute]
       ? autoexposeViaComposition
       : null;
@@ -1102,15 +1103,15 @@ function populate( model ) {
 
   function autoExposedName( target, service, elemScope ) {
     const { absolute } = target.name;
-    if (isDeprecatedEnabled( options, 'shortAutoexposed' )) {
+    if (isDeprecatedEnabled( options, '_shortAutoexposed' )) {
       const parent = definitionScope( target )._parent;
       const name = (parent) ? absolute.substring( parent.name.absolute.length + 1 ) : absolute;
-      // no need for dedot here (as opposed to deprecated.longAutoexposed), as
+      // no need for dedot here (as opposed to deprecated._longAutoexposed), as
       // the name for dependent entities have already been created using `_` then
       return `${ service.name.absolute }.${ name }`;
     }
-    if (isDeprecatedEnabled( options, 'longAutoexposed' )) {
-      const dedot = isDeprecatedEnabled( options, 'generatedEntityNameWithUnderscore' );
+    if (isDeprecatedEnabled( options, '_longAutoexposed' )) {
+      const dedot = isDeprecatedEnabled( options, '_generatedEntityNameWithUnderscore' );
       return `${ service.name.absolute }.${ dedot ? absolute.replace( /\./g, '_' ) : absolute }`;
     }
     const base = definitionScope( target );

package/lib/compiler/propagator.js

@@ -56,9 +56,9 @@ function propagate( model ) {
     returns,
   };
   const { options } = model;
-  const enableExpandElements = !isDeprecatedEnabled( options, 'noElementsExpansion' );
+  const enableExpandElements = !isDeprecatedEnabled( options, '_noElementsExpansion' );
   // eslint-disable-next-line max-len
-  const oldVirtualNotNullPropagation = isDeprecatedEnabled( options, 'oldVirtualNotNullPropagation' );
+  const oldVirtualNotNullPropagation = isDeprecatedEnabled( options, '_oldVirtualNotNullPropagation' );
 
   forEachDefinition( model, run );
 
@@ -117,6 +117,9 @@ function propagate( model ) {
   function runMembers( art ) {
     // console.log('MEMBERS:',refString(art), art.elements ? Object.keys(art.elements) : 0)
     forEachMember( art, run ); // after propagation in parent!
+    // propagate to sub query elements even if not requested:
+    if (art.$queries)
+      art.$queries.forEach( run );
     let obj = art;
     if (art.returns) {
       obj = art.returns;
@@ -186,7 +189,7 @@ function propagate( model ) {
     if (!type || type._main)
       return false;
     // We do not consider the $expand status, as elements are already expanded
-    // by the resolve(), and if not due to deprecated.noElementsExpansion
+    // by the resolve(), and if not due to deprecated._noElementsExpansion
     run( type );
     return type[prop];
   }
@@ -230,7 +233,7 @@ function propagate( model ) {
   }
 
   function notWithExpand( prop, target, source ) {
-    if (!target.expand)
+    if (!target.expand || prop === 'type' && source.elements)
       always( prop, target, source );
   }