@sap/cds-compiler 6.7.3 → 6.8.0

package/lib/transform/forRelationalDB.js

@@ -1,6 +1,7 @@
 'use strict';
 
-const { setProp, isBetaEnabled } = require('../base/model');
+const { isBetaEnabled } = require('../base/specialOptions');
+const shuffleGen = require('../utils/shuffle');
 const {
   forEachMemberRecursively, forAllQueries, applyTransformationsOnNonDictionary,
   getArtifactDatabaseNameOf, getElementDatabaseNameOf, applyTransformations,
@@ -10,7 +11,7 @@ const transformUtils = require('./transformUtils');
 const { translateAssocsToJoinsCSN } = require('./translateAssocsToJoins');
 const {
   csnRefs, pathId, traverseQuery, columnAlias,
-} = require('../model/csnRefs');
+} = require('../base/csnRefs');
 const { checkCSNVersion } = require('../json/csnVersion');
 const validate = require('../checks/validator');
 const { rejectManagedAssociationsAndStructuresForHdbcdsNames } = require('../checks/selectItems');
@@ -18,7 +19,7 @@ const { addTenantFields } = require('../transform/addTenantFields');
 const { addLocalizationViewsWithJoins, addLocalizationViews } = require('../transform/localized');
 const { timetrace } = require('../utils/timetrace');
 const { createReferentialConstraints, assertConstraintIdentifierUniqueness } = require('./db/constraints');
-const { forEach } = require('../utils/objectUtils');
+const { setProp, forEach } = require('../utils/objectUtils');
 const handleExists = require('./db/assocsToQueries/transformExists');
 const { rewriteCalculatedElementsInViews, processCalculatedElementsInEntities } = require('./db/rewriteCalculatedElements');
 const replaceAssociationsInGroupByOrderBy = require('./db/groupByOrderBy');
@@ -35,9 +36,14 @@ const associations = require('./db/associations');
 const backlinks = require('./db/backlinks');
 const { getDefaultTypeLengths } = require('../render/utils/common');
 const { featureFlags, removeFeatureFlags } = require('./featureFlags');
-const { cloneCsnNonDict, cloneFullCsn } = require('../model/cloneCsn');
+const { cloneCsnNonDict, cloneFullCsn } = require('../base/cloneCsn');
 const { processSqlServices, createServiceDummy } = require('./db/processSqlServices');
 const { expandWildcard } = require('./db/expansion');
+const removeEnums = require('../checks/enums');
+const {
+  getQueryFeatureFlagSetter, getDefinitionFeatureFlagSetter,
+} = require('../checks/featureFlags');
+const generateFioriTreeViews = require('./fioriTreeViews');
 
 // By default: Do not process non-entities/views
 function forEachDefinition(csn, cb) {
@@ -61,6 +67,10 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
   csn = cloneFullCsn(csn, options);
   timetrace.stop('Clone CSN');
 
+  const { shuffleDict } = shuffleGen(options.testMode);
+  if (options.testMode && csn.definitions)
+    csn.definitions = shuffleDict(csn.definitions);
+
   if (options.tenantDiscriminator)
     addTenantFields(csn, options);
 
@@ -92,12 +102,21 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
     bindCsnReference();
   }
 
-  ensureColumnNames(csn, options, csnUtils);
+  const setQueryFeatureFlags = getQueryFeatureFlagSetter(csn);
+  const setDefinitionFeatureFlags = getDefinitionFeatureFlagSetter(csn, options);
 
+  // csnRefs cache init, expandWildcards, ensureColumnNames, and feature flags in one loop
+  // as preparation for the following transformations and validations
   forEachDefinition(csn, (def) => {
-    // TODO: Combine query traversal with ensureColumnNames()
-    if (def.query || def.projection)
-      traverseQuery(def.query || def, null, null, query => expandWildcard(query, csnUtils, options));
+    csnUtils.initDefinition(def);
+    if (def.query || def.projection) {
+      traverseQuery(def.query || def, null, null, (query) => {
+        expandWildcard(query, csnUtils, options);
+        ensureColumnNames(query, csnUtils, options);
+        setQueryFeatureFlags(query);
+      });
+    }
+    setDefinitionFeatureFlags(def);
   });
 
   const dialect = options.sqlDialect;
@@ -165,6 +184,8 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
     $env: killProp,
     $path: killProp,
     $scope: killProp,
+    // Remove enums - the compiler already resolved them
+    ...removeEnums,
   });
 
   bindCsnReferenceOnly();
@@ -197,6 +218,9 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
   if (doA2J)
     handleAssocToJoins();
 
+  if (options.testMode && csn.definitions)
+    csn.definitions = shuffleDict(csn.definitions);
+
   bindCsnReference();
 
   const redoProjections = [];
@@ -332,10 +356,12 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
   // Projections now finally become views
   // Replace managed association in group/order by with foreign keys
   const transformEntityOrViewPass2 = getViewTransformer(csn, options, messageFunctions);
+  const { setAnnotation, addElement, createScalarElement } = transformUtils.getTransformers(csn, options, messageFunctions);
   forEachDefinition(csn, [ (artifact, artifactName) => {
     findAndMarkSqlServiceArtifacts(artifact, artifactName);
     if (artifact.$dummyService)
       createServiceDummy(artifact, artifactName, csn, messageFunctions);
+    generateFioriTreeViews(artifact, artifactName, messageFunctions, csnUtils, { setAnnotation, addElement, createScalarElement }, options);
   }, transformViews ]);
 
   if (!doA2J) {
@@ -702,7 +728,7 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
           break;
         }
         case 'cds.Vector': {
-          if (options.sqlDialect !== 'hana') {
+          if (options.sqlDialect !== 'hana' && options.sqlDialect !== 'sqlite') {
             error('ref-unsupported-type', path, {
               '#': 'hana',
               type: node.type,
@@ -715,6 +741,12 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
               '#': 'hdbcds', type: node.type, value: options.sqlDialect,
             });
           }
+          // Technical limitation of SQLite vector extension
+          else if (options.sqlDialect === 'sqlite' && node.length && node.length % 4 !== 0) {
+            error('ref-unexpected-args', path, {
+              '#': 'vector_length', elemref: path.at(-1),
+            });
+          }
           break;
         }
         default:

package/lib/transform/localized.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const { makeMessageFunction } = require('../base/messages');
-const { setProp } = require('../base/model');
+const { setProp } = require('../utils/objectUtils');
 const { forEachKey } = require('../utils/objectUtils');
 const {
   applyAnnotationsFromExtensions,
@@ -15,7 +15,7 @@ const {
   cloneCsnNonDict,
   sortCsnDefinitionsForTests,
   sortCsn,
-} = require('../model/cloneCsn');
+} = require('../base/cloneCsn');
 
 const annoPersistenceSkip = '@cds.persistence.skip';
 

package/lib/transform/odata/createForeignKeys.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const { isBuiltinType } = require('../../base/builtins');
-const { setProp } = require('../../base/model');
+const { setProp } = require('../../utils/objectUtils');
 const {
   applyTransformations, implicitAs, copyAnnotations, isDeepEqual,
 } = require('../../model/csnUtils');

package/lib/transform/odata/flattening.js

@@ -7,13 +7,13 @@ const {
 } = require('../../model/csnUtils');
 const { isBuiltinType, isMagicVariable } = require('../../base/builtins');
 const transformUtils = require('../transformUtils');
-const { setProp } = require('../../base/model');
+const { setProp } = require('../../utils/objectUtils');
 const {
   applyTransformationsOnDictionary,
   applyTransformationsOnNonDictionary,
 } = require('../db/applyTransformations.js');
 const { handleManagedAssociationsAndCreateForeignKeys } = require('../db/flattening');
-const { cloneCsnNonDict } = require('../../model/cloneCsn');
+const { cloneCsnNonDict } = require('../../base/cloneCsn');
 const { forEach } = require('../../utils/objectUtils');
 const { assignAnnotation } = require('../../edm/edmUtils');
 

package/lib/transform/odata/toFinalBaseType.js

@@ -1,6 +1,7 @@
 'use strict';
 
-const { setProp, isBetaEnabled } = require('../../base/model');
+const { setProp } = require('../../utils/objectUtils.js');
+const { isBetaEnabled } = require('../../base/specialOptions');
 const {
   transformAnnotationExpression,
   forEachDefinition,
@@ -9,7 +10,7 @@ const {
 } = require('../../model/csnUtils');
 const { isBuiltinType } = require('../../base/builtins');
 const { isArtifactInSomeService, isArtifactInService } = require('./utils');
-const { cloneCsnDict, cloneCsnNonDict } = require('../../model/cloneCsn');
+const { cloneCsnDict, cloneCsnNonDict } = require('../../base/cloneCsn');
 
 function expandToFinalBaseType(csn, transformers, csnUtils, services, options, error) {
   const isV4 = options.odataVersion === 'v4';

package/lib/transform/odata/typesExposure.js

@@ -6,7 +6,8 @@
  * @module typesExposure
  */
 
-const { setProp, isBetaEnabled } = require('../../base/model');
+const { setProp } = require('../../utils/objectUtils');
+const { isBetaEnabled } = require('../../base/specialOptions');
 const { defNameWithoutServiceOrContextName, isArtifactInService } = require('./utils');
 const {
   getNamespace, copyAnnotations,
@@ -14,7 +15,7 @@ const {
 } = require('../../model/csnUtils');
 const { isBuiltinType } = require('../../base/builtins');
 const { CompilerAssertion } = require('../../base/error');
-const { cloneCsnNonDict } = require('../../model/cloneCsn');
+const { cloneCsnNonDict } = require('../../base/cloneCsn');
 
 /**
  * A given CDS model is a set of n definitions D = {v_1, ..., v_n } spanning a type dependency

package/lib/transform/transformUtils.js

@@ -4,7 +4,7 @@
 // different backends.
 // The sibling of model/transform/TransformUtil.js which works with compacted new CSN.
 
-const { setProp } = require('../base/model');
+const { setProp } = require('../utils/objectUtils');
 
 const { copyAnnotations, applyTransformations, isDeepEqual } = require('../model/csnUtils');
 const { getUtils, implicitAs } = require('../model/csnUtils');
@@ -12,7 +12,7 @@ const { typeParameters } = require('../compiler/builtins');
 const { isBuiltinType } = require('../base/builtins');
 const { ModelError, CompilerAssertion } = require('../base/error');
 const { forEach } = require('../utils/objectUtils');
-const { cloneCsnNonDict, cloneCsnDict } = require('../model/cloneCsn');
+const { cloneCsnNonDict, cloneCsnDict } = require('../base/cloneCsn');
 const { addTenantFieldToArt } = require('./addTenantFields');
 const { tupleExpansion } = require('./tupleExpansion');
 

package/lib/transform/translateAssocsToJoins.js

@@ -1,6 +1,7 @@
 'use strict';
 
-const { setProp, isBetaEnabled } = require('../base/model');
+const { setProp } = require('../utils/objectUtils');
+const { isBetaEnabled } = require('../base/specialOptions');
 const { makeMessageFunction } = require('../base/messages');
 const { recompileX } = require('../compiler/index');
 const {

package/lib/transform/tupleExpansion.js

@@ -1,12 +1,12 @@
 'use strict';
 
-const { setProp } = require('../base/model');
+const { setProp } = require('../utils/objectUtils');
 const { applyTransformations, isDollarSelfOrProjectionOperand, implicitAs } = require('../model/csnUtils');
 const { isBuiltinType } = require('../base/builtins');
-const { condAsTree } = require('../model/xprAsTree');
+const { condAsTree } = require('../base/xprAsTree');
 const { pathToMessageString } = require('../base/messages');
-const { pathId } = require('../model/csnRefs');
-const { cloneCsnNonDict } = require('../model/cloneCsn');
+const { pathId } = require('../base/csnRefs');
+const { cloneCsnNonDict } = require('../base/cloneCsn');
 
 /**
  * All relational operators supported by tuple expansion.

package/lib/transform/universalCsn/universalCsnEnricher.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const { setProp } = require('../../base/model');
-const shuffleGen = require('../../base/shuffle');
+const { setProp } = require('../../utils/objectUtils');
+const shuffleGen = require('../../utils/shuffle');
 const { setAnnotationIfNotDefined, makeClientCompatible } = require('./utils');
 const {
   forEachDefinition,
@@ -98,7 +98,11 @@ module.exports = (csn, options) => {
     cardinality: notWithItemsOrElements,
   };
 
-  if (options.testMode) {
+  if (!options.testMode) {
+    // after enrichment, CSN has flavor 'inferred' (internal name: 'client')
+    csn.meta = Object.assign( {}, csn.meta, { compilerCsnFlavor: 'inferred' } );
+  }
+  else {
     const { shuffleDict } = shuffleGen( options.testMode );
     csn.definitions = shuffleDict( csn.definitions );
   }

package/lib/transform/universalCsn/utils.js

@@ -3,7 +3,7 @@
 const {
   applyTransformations,
 } = require('../../model/csnUtils');
-const { setProp } = require('../../base/model');
+const { setProp } = require('../../utils/objectUtils');
 
 /**
  * Set the annotation on the carrier if it is not already present.

package/lib/{base → utils}/lazyload.js

@@ -1,3 +1,12 @@
+// Provide some on-demand `require`
+
+// To use:
+//   const lazyload = require('./base/lazyload')( module );
+//   const My = lazyload('../My/Module');  // replaces `require('../My/Module')`
+//
+// The required module must export an object.  Do not def-struct, i.e.
+//   const { Foo, bar } = lazyload('../My/Module');  // DO NOT DO THIS
+
 'use strict';
 
 function createLazyload( callingModule ) {

package/lib/{base → utils}/node-helpers.js

@@ -1,5 +1,7 @@
 // Wrappers around core JavaScript / node functions
 
+// TODO: consider using Promise.allSettled() instead
+
 'use strict';
 
 class PromiseAllError extends Error {

package/lib/utils/objectUtils.js

@@ -1,5 +1,26 @@
+// Utilities for JavaScript objects
+
 'use strict';
 
+
+/**
+ * Like `obj.prop = value`, but not serialized.
+ * It's important to set `enumerable` explicitly to false (although 'false' is the default),
+ * as else, if the property already exists, it keeps the old setting for enumerable.
+ *
+ * @param {object} obj
+ * @param {string} prop
+ * @param {any} value
+ */
+function setProp( obj, prop, value ) {
+  const descriptor = {
+    value, configurable: true, writable: true, enumerable: false,
+  };
+  Object.defineProperty( obj, prop, descriptor );
+  return value;
+}
+
+
 /**
  * Copy "property" from the source object to the target object.
  * Only if it exists in the source object (using "in" operator).
@@ -14,7 +35,8 @@ function copyPropIfExist( sourceObj, property, targetObj ) {
 }
 
 /**
- * Loops over all elements in an object and calls the specified callback(key,obj)
+ * Loops over all properties with their values in an object and
+ * calls the specified callback(key,obj)
  *
  * @param {object} obj
  * @param {(key: string, value: object) => void} callback
@@ -27,8 +49,8 @@ function forEach( obj, callback ) {
 }
 
 /**
- * Loops over all elements in an object and calls the specified callback(o[key]) for each key
- * --> can be used as substitute for `Object.values(…).forEach(…)`
+ * Loops over all property values in an object and calls the specified callback(o[key])
+ * for each key --> can be used as substitute for `Object.values(…).forEach(…)`
  *
  * @param  {object} o the object which values should be iterated
  * @param  {Function} callback
@@ -41,8 +63,8 @@ function forEachValue( o, callback ) {
 }
 
 /**
- * Loops over all elements in an object and calls the specified callback(key) for each key
- * --> can be used as substitute for `Object.keys(…).forEach(…)`
+ * Loops over all properties with their values in an object and calls the specified callback(key)
+ * for each key --> can be used as substitute for `Object.keys(…).forEach(…)`
  *
  * @param  {object} o the object which keys should be iterated
  * @param  {Function} callback
@@ -55,7 +77,7 @@ function forEachKey( o, callback ) {
 }
 
 /**
- * Sets a property as "hidden" (a.k.a. non-enumerable).
+ * Sets a property as "hidden" (a.k.a. non-enumerable).  Same as `setProp`.
  *
  * @param {object} obj
  * @param {string} prop
@@ -80,6 +102,7 @@ function hasNonEnumerable( object, propertyName ) {
 }
 
 module.exports = {
+  setProp,
   copyPropIfExist,
   forEach,
   forEachValue,

package/lib/{base → utils}/optionProcessorHelper.js

@@ -1,3 +1,7 @@
+// Create "option processor"
+
+// Remark: is not just used by cdsc, but also by various scripts.
+
 'use strict';
 
 /**
@@ -122,11 +126,14 @@ function createOptionProcessor() {
    * Note that you can only call this function once.  Only the last invocation sets
    * the positional arguments.
    *
-   * @param {string}   argumentDefinition Positional arguments, e.g. '<input> <output>' or '<files...>'
-   * @param {object[]} argList            Array, to which the parsed arguments will be added.  Default is global scope.
+   * @param {string}   argumentDefinition Positional arguments,
+   *                                      e.g. '<input> <output>' or '<files...>'
+   * @param {object[]} argList            Array, to which the parsed arguments will be added.
+   *                                      Default is global scope.
    * @private
    */
-  function _setPositionalArguments( argumentDefinition, argList = optionProcessor.positionalArguments ) {
+  function _setPositionalArguments( argumentDefinition,
+                                    argList = optionProcessor.positionalArguments ) {
     if (argList.find(arg => arg.isDynamic))
       throw new Error('Can\'t add positional arguments after a dynamic one');
 
@@ -397,7 +404,8 @@ function createOptionProcessor() {
 
 
     // Complain about first missing positional arguments
-    const missingArg = getCurrentPositionArguments().find(arg => arg.required && !result.args[arg.name]);
+    const missingArg = getCurrentPositionArguments()
+      .find(arg => arg.required && !result.args[arg.name]);
     if (missingArg) {
       const forCommand = result.command ? ` for '${ result.command }'` : '';
       const errorMsg = `Missing positional argument${ forCommand }: <${ missingArg.name }${ missingArg.isDynamic ? '...' : '' }>`;
@@ -496,7 +504,8 @@ function createOptionProcessor() {
         if (currentCommand) {
           // Not found at all.  We dig into the other cdsc commands in order to check if
           // the option expects a parameter and if so to take the next argument as a value
-          const otherCmd = Object.keys(optionProcessor.commands).find(cmd => optionProcessor.commands[cmd].options[arg]);
+          const otherCmd = Object.keys(optionProcessor.commands)
+            .find(cmd => optionProcessor.commands[cmd].options[arg]);
           const otherCmdOpt = otherCmd && optionProcessor.commands[otherCmd].options[arg];
           if (otherCmdOpt && hasParamForUnknown(otherCmdOpt))
             return 1;
@@ -567,7 +576,8 @@ function createOptionProcessor() {
        * @returns {boolean}
        */
       function hasParamForUnknown( opt ) {
-        return ((!opt || opt.param) && (i + 1) < argv.length && !argv[i + 1].match('(^[.-])|[.](csn|cdl|cds|json)$'));
+        return ((!opt || opt.param) &&
+                (i + 1) < argv.length && !argv[i + 1].match('(^[.-])|[.](csn|cdl|cds|json)$'));
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-compiler",
-  "version": "6.7.3",
+  "version": "6.8.0",
   "description": "CDS (Core Data Services) compiler and backends",
   "homepage": "https://cap.cloud.sap/",
   "author": "SAP SE (https://www.sap.com)",
@@ -34,7 +34,7 @@
     "deployHdiGitDiffs": "CDS_COMPILER_DEPLOY_HANA=1 mocha --reporter-option maxDiffSize=0 --extensions .hdi test3/test.deploy.git-diffs.js",
     "gentest3": "cross-env MAKEREFS=${MAKEREFS:-'true'} mocha --reporter-option maxDiffSize=0 test3/testRefFiles.js",
     "coverage": "cross-env npx nyc mocha --reporter-option maxDiffSize=0 test/ test3/testRefFiles.js && npx nyc report --reporter=lcov",
-    "coverage:piper": "cross-env npx nyc mocha --reporter test/TestMochaReporter.js --reporter-options mochaFile=./coverage/TEST-results.xml --reporter-option maxDiffSize=0 --timeout 10000 test/ test3/ && npx nyc report --reporter=cobertura && npx nyc report --reporter=lcov",
+    "coverage:piper": "cross-env npx nyc mocha --reporter test/TestMochaReporter.js --reporter-options mochaFile=./coverage/TEST-results.xml --reporter-option maxDiffSize=0 --timeout 10000 test/ test3/ && npx nyc report --reporter=lcov",
     "lint": "eslint bin/ benchmark/ lib/ test/ test3/ scripts/ && node scripts/linter/lintConstants.js && node scripts/linter/lintGrammar.js && node scripts/linter/lintTests.js test3/ && node scripts/linter/lintMessages.js && node scripts/linter/lintMessageIdCoverage.js lib/ && markdownlint README.md CHANGELOG.md doc/ internalDoc/ && cd share/messages && markdownlint . && cd ../../ && node scripts/check-changelog.js",
     "lint:edmx": "node scripts/odata/lint-edmx-v4.js",
     "tslint": "tsc --pretty -p .",