@sap/cds-compiler 3.6.0 → 3.6.2

package/CHANGELOG.md

@@ -7,6 +7,15 @@
 Note: `beta` fixes, changes and features are usually not listed in this ChangeLog but [here](doc/CHANGELOG_BETA.md).
 The compiler behavior concerning `beta` features can change at any time without notice.
 
+## Version 3.6.2 - 2023-02-06
+
+### Fixed
+
+- to.hdi(.migration): Don't render `-- generated by cds-compiler version` comment at the top of the HDI-based
+  artifacts, as this caused HDI to detect the file as `changed`
+  and redeploy, causing way longer deployment times. Old behavior can be enabled with option `generatedByComment: true`.
+- to.sql/hdi/hdbcds: Correctly handle variables like `$user` in `exists` filters.
+
 ## Version 3.6.0 - 2023-01-25
 
 ### Added

package/lib/api/options.js

@@ -28,6 +28,7 @@ const publicOptionsNewAPI = [
   'magicVars', // deprecated, not removed in v3 as we have specific error messages for it
   'variableReplacements',
   'pre2134ReferentialConstraintNames',
+  'generatedByComment',
   // ODATA
   'odataVersion',
   'odataFormat',
@@ -120,14 +121,14 @@ module.exports = {
     cdl: options => translateOptions(options, undefined, undefined, undefined, undefined, 'to.cdl'),
     sql: (options) => {
       const hardOptions = { src: 'sql', toSql: true, forHana: true };
-      const defaultOptions = { sqlMapping: 'plain', sqlDialect: 'plain' };
+      const defaultOptions = { sqlMapping: 'plain', sqlDialect: 'plain', generatedByComment: true };
       const processed = translateOptions(options, defaultOptions, hardOptions, undefined, [ 'sql-dialect-and-naming' ], 'to.sql');
 
       return Object.assign({}, processed);
     },
     hdi: (options) => {
       const hardOptions = { src: 'hdi', toSql: true, forHana: true };
-      const defaultOptions = { sqlMapping: 'plain', sqlDialect: 'hana' };
+      const defaultOptions = { sqlMapping: 'plain', sqlDialect: 'hana', generatedByComment: false };
       return translateOptions(options, defaultOptions, hardOptions, { sqlDialect: generateStringValidator([ 'hana' ]) }, undefined, 'to.hdi');
     },
     hdbcds: (options) => {

package/lib/model/csnRefs.js

@@ -74,7 +74,7 @@
 //     const csnPath = ['definitions','P','projection','columns',0];
 //     const subElement = inspectRef( csnPath );  // type T is involved
 //     csn.definitions.T.type = 'some.other.type';
-//     // ({ inspectRef } = csnRefs( csn ));      // invalidate caches
+//     // ({ inspectRef } = csnRefs( csn ));      // drop caches
 //     … = inspectRef( csnPath );  // type T - using the cached or the new?
 //
 // On request, we might add a functions for individual cache invalidations or
@@ -155,6 +155,8 @@
 //   which contains cached data.  Such data can be a link to a CSN node (like
 //   `_effectiveType`/`elements`), scalar (like `$queryNumber`) or link to
 //   another cache object (like `$next`).
+// - A cache entry must not link to a cache object of another main definition;
+//   otherwise, individual cache invalidation does not work.
 // - Usually, each CSN object has an individual cache object.
 // - For CSN queries nodes, cache objects are _shared_: both the CSN nodes
 //   `‹query› = { SELECT: ‹select›, … }` and `‹select›` share the same cache
@@ -260,6 +262,7 @@ function csnRefs( csn, universalReady ) {
     getColumn: elem => getCache( elem, '_column' ),
     getElement: col => getCache( col, '_element' ),
     initDefinition,
+    dropDefinitionCache,
     targetAspect,
     __getCache_forEnrichCsnDebugging: obj => cache.get( obj ),
   };
@@ -486,6 +489,31 @@ function csnRefs( csn, universalReady ) {
       setCache( art, '$origin$step', (kind === 'element' ? step : { [kind]: step }) );
   }
 
+  function dropDefinitionCache( main ) {
+    const queries = getCache( main, '$queries' );
+    if (!queries)               // not yet initialized
+      return;
+    if (!cache.delete( main ))  // not yet initialized
+      return;
+    for (const qcache of queries || []) {
+      const { _select } = qcache;
+      for (const n of Object.keys( _select.mixin || {} ))
+        cache.delete( _select.mixin[n] );
+      dropColumnsCache( _select.columns );
+      traverseDef( _select, null, null, null, a => cache.delete( a ) ); // elements
+    }
+    traverseDef( main, null, null, null, a => cache.delete( a ) );
+  }
+
+  function dropColumnsCache( select ) {
+    if (!select)
+      return;
+    for (const col of select.columns || select.expand || select.inline || []) {
+      dropColumnsCache( col );
+      cache.delete( select );
+    }
+  }
+
   /**
    * @param {CSN.Path} csnPath
    *

package/lib/optionProcessor.js

@@ -293,6 +293,7 @@ optionProcessor.command('Q, toSql')
   .option('    --constraints-in-create-table')
   .option('    --pre2134ReferentialConstraintNames')
   .option('    --disable-hana-comments')
+  .option('    --generated-by-comment')
   .help(`
   Usage: cdsc toSql [options] <files...>
 
@@ -343,6 +344,8 @@ optionProcessor.command('Q, toSql')
                                     "ALTER TABLE ADD CONSTRAINT" statements
    --pre2134ReferentialConstraintNames   Do not prefix the constraint identifier with "c__"
    --disable-hana-comments    Disable rendering of doc comments as SAP HANA comments.
+   --generated-by-comment     Enable rendering of the initial SQL comment for HDI-based artifacts
+
 `);
 
 optionProcessor.command('toRename')

package/lib/render/toSql.js

@@ -230,7 +230,7 @@ function toSqlDdl( csn, options ) {
           sourceString = sourceString.slice('COLUMN '.length);
         sql[name] = `${options.testMode ? '' : sqlVersionLine}CREATE ${sourceString};`;
       }
-      else if (!options.testMode) {
+      else if (!options.testMode && options.generatedByComment) {
         mainResultObj[hdbKind][name] = sqlVersionLine + mainResultObj[hdbKind][name];
       }
     }
@@ -253,7 +253,7 @@ function toSqlDdl( csn, options ) {
     mainResultObj.sql = sql;
 
   for (const name in deletions)
-    deletions[name] = `${options.testMode ? '' : sqlVersionLine}${deletions[name]}`;
+    deletions[name] = `${options.testMode || !options.generatedByComment ? '' : sqlVersionLine}${deletions[name]}`;
 
   timetrace.stop('SQL rendering');
   return mainResultObj;

package/lib/transform/db/transformExists.js

@@ -3,7 +3,6 @@
 const { forAllQueries, forEachDefinition, walkCsnPath } = require('../../model/csnUtils');
 const { setProp } = require('../../base/model');
 const { getRealName } = require('../../render/utils/common');
-const { csnRefs } = require('../../model/csnRefs');
 const { ModelError } = require('../../base/error');
 
 /**
@@ -47,9 +46,11 @@ const { ModelError } = require('../../base/error');
  * @param {CSN.Model} csn
  * @param {CSN.Options} options
  * @param {Function} error
+ * @param {Function} inspectRef
+ * @param {Function} initDefinition
+ * @param {Function} dropDefinitionCache
  */
-function handleExists( csn, options, error ) {
-  let { inspectRef } = csnRefs(csn);
+function handleExists( csn, options, error, inspectRef, initDefinition, dropDefinitionCache ) {
   const generatedExists = new WeakMap();
   forEachDefinition(csn, (artifact, artifactName) => {
     if (artifact.projection) // do the same hack we do for the other stuff...
@@ -78,15 +79,19 @@ function handleExists( csn, options, error ) {
 
           while (toProcess.length > 0) {
             const [ queryPath, exprPath ] = toProcess.pop();
+            // Re-init caches for this artifact
+            dropDefinitionCache(artifact);
+            initDefinition(artifact);
             // leftovers can happen with nested exists - we then need to drill down into the created SELECT
             // 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
             leftovers.reverse();
             toProcess.push(...leftovers); // any leftovers - schedule for further processing
           }
+          // Make sure we leave csnRefs usable
+          dropDefinitionCache(artifact);
+          initDefinition(artifact);
         }
       }, [ 'definitions', artifactName, 'query' ]);
     }
@@ -764,7 +769,7 @@ function handleExists( csn, options, error ) {
    */
   function remapExistingWhere( target, where ) {
     return where.map((part) => {
-      if (part.ref) {
+      if (part.ref && part.$scope !== '$magic') {
         part.ref = [ target, ...part.ref ];
         return part;
       }

package/lib/transform/forRelationalDB.js

@@ -121,6 +121,8 @@ function transformForRelationalDBWithCsn(inputModel, options, moduleName) {
   let artifactRef,
     inspectRef,
     effectiveType,
+    initDefinition,
+    dropDefinitionCache,
     get$combined,
     getCsnDef,
     isAssocOrComposition,
@@ -159,7 +161,7 @@ function transformForRelationalDBWithCsn(inputModel, options, moduleName) {
   timetrace.stop('Validate');
 
   // Needs to happen before tuple expansion, so the newly generated WHERE-conditions have it applied
-  handleExists(csn, options, error);
+  handleExists(csn, options, error, inspectRef, initDefinition, dropDefinitionCache);
 
   // Check if structured elements and managed associations are compared in an expression
   // and expand these structured elements. This tuple expansion allows all other
@@ -441,6 +443,8 @@ function transformForRelationalDBWithCsn(inputModel, options, moduleName) {
     ({ artifactRef,
       inspectRef,
       effectiveType,
+      initDefinition,
+      dropDefinitionCache,
       get$combined,
       getCsnDef,
       isAssocOrComposition,
@@ -451,7 +455,7 @@ function transformForRelationalDBWithCsn(inputModel, options, moduleName) {
 
   function bindCsnReferenceOnly(){
     // invalidate caches for CSN ref API
-    ({ artifactRef, inspectRef, effectiveType } = csnRefs(csn));
+    ({ artifactRef, inspectRef, effectiveType, initDefinition, dropDefinitionCache } = csnRefs(csn));
   }
 
   function handleMixinOnConditions(artifact, artifactName) {

package/package.json

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