@sap/cds-compiler 4.7.6 → 4.9.0

package/lib/transform/forRelationalDB.js

@@ -2,9 +2,10 @@
 
 const { setProp, isBetaEnabled } = require('../base/model');
 const { forEachMemberRecursively, forAllQueries, applyTransformationsOnNonDictionary,
-        getArtifactDatabaseNameOf, getElementDatabaseNameOf, isBuiltinType, applyTransformations,
+        getArtifactDatabaseNameOf, getElementDatabaseNameOf, applyTransformations,
         isAspect, walkCsnPath, isPersistedOnDatabase
       } = require('../model/csnUtils');
+const { isBuiltinType } = require('../base/builtins');
 const transformUtils = require('./transformUtils');
 const { translateAssocsToJoinsCSN } = require('./translateAssocsToJoins');
 const { csnRefs, pathId, traverseQuery, columnAlias} = require('../model/csnRefs');
@@ -182,7 +183,7 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
   forEachDefinition(csn, [
     // (001) Add a temporal where condition to views where applicable before assoc2join
     //       assoc2join eventually rewrites the table aliases
-    temporal.getViewDecorator(csn, messageFunctions, csnUtils),
+    temporal.getViewDecorator(csn, messageFunctions, csnUtils, options),
     // check unique constraints - further processing is done in rewriteUniqueConstraints
     assertUnique.prepare(csn, options, messageFunctions)
   ]);
@@ -256,25 +257,14 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
   //
   // First, gather all nodes that are arrayed: Don't replace inline, or getFinalTypeInfo()
   // may not return `.items` for types that were already processed.
+  // TODO: Do this in resolveTypeReferences?
   {
-    const removeItems = new Set();
     applyTransformations(csn, {
       type: (node) => {
-        if (node.items || node.type && csnUtils.getFinalTypeInfo(node.type)?.items)
-          removeItems.add(node);
         renamePrimitiveTypesAndUuid(node.type, node, 'type');
         addDefaultTypeFacets(node, implicitDefaultLengths);
       },
-      items: (node) => removeItems.add(node),
     });
-    // no support for array-of - turn into CLOB/Text
-    // must be done after A2J or compiler checks could change
-    // (e.g. annotation def checks for arrayed types)
-    for (const node of removeItems) {
-      node.type = 'cds.LargeString';
-      delete node.items;
-    }
-    removeItems.clear();
   }
 
   forEachDefinition(csn, [
@@ -294,15 +284,17 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
   // Managed associations get an on-condition - in views and entities
   doA2J && associations.attachOnConditions(csn, csnUtils, pathDelimiter);
 
-  // (045) Strip all query-ish properties from views and projections annotated with '@cds.persistence.table',
-  // and make them entities
-  forEachDefinition(csn, cdsPersistence.getPersistenceTableProcessor(csn, options, messageFunctions));
-
-  // Allow using managed associations as steps in on-conditions to access their fks
-  // To be done after handleAssociations, since then the foreign keys of the managed assocs
-  // are part of the elements
-  if (doA2J)
-    forEachDefinition(csn, associations.getFKAccessFinalizer(csn, csnUtils, pathDelimiter));
+  {
+    // (045) Strip all query-ish properties from views and projections annotated with '@cds.persistence.table',
+    // and make them entities
+    const fns = [cdsPersistence.getPersistenceTableProcessor(csn, options, messageFunctions)];
+    // Allow using managed associations as steps in on-conditions to access their fks
+    // To be done after handleAssociations, since then the foreign keys of the managed assocs
+    // are part of the elements
+    if(doA2J) fns.push(associations.getFKAccessFinalizer(csn, csnUtils, pathDelimiter));
+
+    forEachDefinition(csn, fns);
+  }
 
   // Create convenience views for localized entities/views.
   // To be done after getFKAccessFinalizer because associations are
@@ -328,21 +320,15 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
     // - view with parameters: ok on HANA, not allowed otherwise
     // (don't complain about action/function with parameters)
     handleChecksForWithParameters,
-    // Remove .masked
-    // Check that keys are not explicitly nullable
-    // Check that Associations are not used in entities/views with parameters
-    // (150 b) Strip inheritance
-    // Note that this should happen after implicit redirection, because includes are required for that
-    handleDBChecks,
+    checkAssocsWithParams,
+    // (170) Transform '$self' in backlink associations to appropriate key comparisons
+    // Must happen before draft processing because the artificial ON-conditions in generated
+    // draft shadow entities have crooked '_artifact' links, confusing the backlink processing.
+    // But it must also happen after flattenForeignKeys has been called for all artifacts,
+    // because otherwise we would produce wrong ON-conditions for the keys involved. Sigh ...
+    backlinks.getBacklinkTransformer(csnUtils, messageFunctions, options, pathDelimiter, doA2J)
   ]);
 
-  // (170) Transform '$self' in backlink associations to appropriate key comparisons
-  // Must happen before draft processing because the artificial ON-conditions in generated
-  // draft shadow entities have crooked '_artifact' links, confusing the backlink processing.
-  // But it must also happen after flattenForeignKeys has been called for all artifacts,
-  // because otherwise we would produce wrong ON-conditions for the keys involved. Sigh ...
-  forEachDefinition(csn, backlinks.getBacklinkTransformer(csnUtils, messageFunctions, options, pathDelimiter, doA2J));
-
   /**
    * Referential Constraints are only supported for sql-dialect "hana" and "sqlite".
    * For to.hdbcds with naming mode "hdbcds", no foreign keys are calculated,
@@ -367,16 +353,14 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
   // Apply view-specific transformations
   // (160) Projections now finally become views
   // Replace managed association in group/order by with foreign keys
-  const transformEntityOrViewPass2 = getViewTransformer(csn, options, messageFunctions, transformCommon);
+  const transformEntityOrViewPass2 = getViewTransformer(csn, options, messageFunctions);
   forEachDefinition(csn, transformViews);
 
-  // Recursively apply transformCommon and attach @cds.persistence.name
-  forEachDefinition(csn, recursivelyApplyCommon);
-
   const checkConstraintIdentifiers = (artifact, artifactName, prop, path) => {
     assertConstraintIdentifierUniqueness(artifact, artifactName, path, error);
   };
 
+  // TODO: Could we maybe merge this with the final applyTransformations?
   forEachDefinition(csn, [
     /* assert that there will be no conflicting unique- and foreign key constraint identifiers */
     checkConstraintIdentifiers,
@@ -386,9 +370,26 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
     removeKeyPropInType,
   ]);
 
-  // Remove leading $self to keep renderer-diffs smaller
-  if(doA2J)
-    flattening.removeLeadingSelf(csn);
+
+  // TODO: Could we maybe merge this with the final applyTransformations?
+  applyTransformations(csn, {
+    elements: (parent, prop, elements, path) => {
+      // Attach @cds.persistence.name to elements, replace enums by their base value
+      const artifact = csn.definitions[path[1]];
+      forEach(elements, (name, element) => {
+        replaceEnums(element, name, path.concat(['elements', name]));
+        if ((!element.virtual || artifact.query))
+          csnUtils.addStringAnnotationTo('@cds.persistence.name', getElementDatabaseNameOf(name, options.sqlMapping, options.sqlDialect), element);
+      });
+      // Remove leading $self to keep renderer-diffs smaller
+      if(doA2J && options.transformation === 'hdbcds')
+        flattening.removeLeadingSelf(parent, prop, elements);
+    }
+  }, [(definitions, artifactName, artifact) => {
+    // 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);
+  }], { allowArtifact: artifact => artifact.kind === 'entity'});
 
   throwWithAnyError();
 
@@ -434,7 +435,10 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
         }
       }
     },
-
+    includes: killProp,
+    masked: killProp,
+    localized: killProp,
+    enum: killProp
   }
 
   if(options.sqlDialect === 'postgres') {
@@ -449,8 +453,25 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
     killers.target = killParent;
   }
 
+  const killTypes = [];
+
+  if(doA2J) { // replace types and aspects with dummies to shrink overall CSN size
+    killers.kind = (parent, prop, kind, path) => {
+      if(kind === 'type' || kind === 'aspect') {
+        const artifactName = path[1];
+        killTypes.push(() => {
+          csn.definitions[artifactName] = {
+            kind,
+            type: 'cds.Integer'
+          };
+        })
+      }
+    }
+  }
+
   applyTransformations(csn, killers, [], { skipIgnore: false });
 
+  killTypes.forEach(fn => fn());
   redoProjections.forEach(fn => fn());
 
   timetrace.stop('Transform CSN');
@@ -577,34 +598,12 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
     }
   }
 
-  /**
-   * @param {CSN.Artifact} artifact
-   * @param {string} artifactName
-   */
-  function recursivelyApplyCommon(artifact, artifactName) {
-    if (!artifact.$ignore) {
-      if (artifact.kind !== 'service' && artifact.kind !== 'context')
-        csnUtils.addStringAnnotationTo('@cds.persistence.name', getArtifactDatabaseNameOf(artifactName, options.sqlMapping, csn, options.sqlDialect), artifact);
-
-      forEachMemberRecursively(artifact, (member, memberName, property, path) => {
-        if (property === 'returns')
-          return; // ignore "returns" type
-        transformCommon(member, memberName, path);
-        // (240 b) Annotate elements, foreign keys, parameters etc with their DB names
-        // Virtual elements in entities and types are not annotated, as they have no DB representation.
-        // In views they are, as we generate a null expression for them (null as <colname>)
-        if ((!member.virtual || artifact.query))
-          csnUtils.addStringAnnotationTo('@cds.persistence.name', getElementDatabaseNameOf(memberName, options.sqlMapping, options.sqlDialect), member);
-      }, [ 'definitions', artifactName ]);
-    }
-  }
-
   /**
    * @param {CSN.Artifact} artifact
    * @param {string} artifactName
    */
   function removeKeyPropInType(artifact, artifactName) {
-    if (!artifact.$ignore && artifact.kind === 'type') {
+    if (!doA2J && !artifact.$ignore && artifact.kind === 'type') {
       forEachMemberRecursively(artifact, (member) => {
         if (member.key)
           delete member.key;
@@ -616,47 +615,42 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
    * @param {CSN.Artifact} artifact
    * @param {string} artifactName
    */
-  function handleDBChecks(artifact, artifactName) {
-    // Strip inheritance
-    if (artifact.includes)
-      delete artifact.includes;
-
-    // Process the artifact's  members
-    forEachMemberRecursively(artifact, (member, memberName, prop, path) => {
-      // (100 a) Ignore the property 'masked' itself (but not its effect on projections)
-      if (member.masked)
-        delete member.masked;
-      // Report an error on
-      // - view with parameters that has an element of type association/composition
-      // - association that points to entity with parameters
-      if (member.target && csnUtils.isAssocOrComposition(member) && !isBetaEnabled(options, 'assocsWithParams')) {
-        if (artifact.params) {
-          // HANA does not allow 'WITH ASSOCIATIONS' on something with parameters:
-          // SAP DBTech JDBC: [7]: feature not supported: parameterized sql view cannot support association: line 1 col 1 (at pos 0)
-          message('def-unexpected-paramview-assoc', path, { '#': 'source' });
-        }
-        else if(artifact['@cds.persistence.udf'] || artifact['@cds.persistence.calcview']) {
-          // UDF/CVs w/o params don't support 'WITH ASSOCIATIONS'
-          const anno = artifact['@cds.persistence.udf'] ? '@cds.persistence.udf' : '@cds.persistence.calcview';
-          message('def-unexpected-calcview-assoc', path, { '#': 'source', anno });
-        }
-        if (csn.definitions[member.target].params) {
-          // HANA does not allow association targets with parameters or to UDFs/CVs w/o parameters:
-          // SAP DBTech JDBC: [7]: feature not supported: cannot support create association to a parameterized view
-          message('def-unexpected-paramview-assoc', path, { '#': 'target' });
-        }
-        else if(csn.definitions[member.target]['@cds.persistence.udf'] || csn.definitions[member.target]['@cds.persistence.calcview']) {
-          // HANA won't check the assoc target but when querying an association with target UDF, this is the error:
-          // SAP DBTech JDBC: [259]: invalid table name: target object SYSTEM.UDF does not exist: line 3 col 6 (at pos 43)
-          // CREATE TABLE F (id INTEGER NOT NULL);
-          // CREATE FUNCTION UDF RETURNS TABLE (ID INTEGER) LANGUAGE SQLSCRIPT SQL SECURITY DEFINER AS BEGIN RETURN SELECT ID FROM F; END;
-          // CREATE TABLE Y (  id INTEGER NOT NULL,  toUDF_id INTEGER) WITH ASSOCIATIONS (MANY TO ONE JOIN UDF AS toUDF ON (toUDF.id = toUDF_id));
-          // CREATE VIEW U AS SELECT  id, toUDF.a FROM Y;
-          const anno = csn.definitions[member.target]['@cds.persistence.udf'] ? '@cds.persistence.udf' : '@cds.persistence.calcview';
-          message('def-unexpected-calcview-assoc', path, { '#': 'target', anno });
+  function checkAssocsWithParams(artifact, artifactName) {
+    if(options.transformation === 'hdbcds') {
+      forEachMemberRecursively(artifact, (member, memberName, prop, path) => {
+        // Report an error on
+        // - view with parameters that has an element of type association/composition
+        // - association that points to entity with parameters
+        if (member.target && csnUtils.isAssocOrComposition(member)) {
+          if (artifact.params) {
+            // HANA does not allow 'WITH ASSOCIATIONS' on something with parameters:
+            // SAP DBTech JDBC: [7]: feature not supported: parameterized sql view cannot support association: line 1 col 1 (at pos 0)
+            message('def-unexpected-paramview-assoc', path, { '#': 'source' });
+          }
+          else if(artifact['@cds.persistence.udf'] || artifact['@cds.persistence.calcview']) {
+            // UDF/CVs w/o params don't support 'WITH ASSOCIATIONS'
+            const anno = artifact['@cds.persistence.udf'] ? '@cds.persistence.udf' : '@cds.persistence.calcview';
+            message('def-unexpected-calcview-assoc', path, { '#': 'source', anno });
+          }
+          if (csn.definitions[member.target].params) {
+            // HANA does not allow association targets with parameters or to UDFs/CVs w/o parameters:
+            // SAP DBTech JDBC: [7]: feature not supported: cannot support create association to a parameterized view
+            message('def-unexpected-paramview-assoc', path, { '#': 'target' });
+          }
+          else if(csn.definitions[member.target]['@cds.persistence.udf'] || csn.definitions[member.target]['@cds.persistence.calcview']) {
+            // HANA won't check the assoc target but when querying an association with target UDF, this is the error:
+            // SAP DBTech JDBC: [259]: invalid table name: target object SYSTEM.UDF does not exist: line 3 col 6 (at pos 43)
+            // CREATE TABLE F (id INTEGER NOT NULL);
+            // CREATE FUNCTION UDF RETURNS TABLE (ID INTEGER) LANGUAGE SQLSCRIPT SQL SECURITY DEFINER AS BEGIN RETURN SELECT ID FROM F; END;
+            // CREATE TABLE Y (  id INTEGER NOT NULL,  toUDF_id INTEGER) WITH ASSOCIATIONS (MANY TO ONE JOIN UDF AS toUDF ON (toUDF.id = toUDF_id));
+            // CREATE VIEW U AS SELECT  id, toUDF.a FROM Y;
+            const anno = csn.definitions[member.target]['@cds.persistence.udf'] ? '@cds.persistence.udf' : '@cds.persistence.calcview';
+            message('def-unexpected-calcview-assoc', path, { '#': 'target', anno });
+          }
         }
-      }
-    }, [ 'definitions', artifactName ]);
+      }, [ 'definitions', artifactName ]);
+    }
+
   }
 
   /**
@@ -731,7 +725,7 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
 
 
   /**
-   * Remove `localized` from elements and replace Enum symbols by their values.
+   * Replace Enum symbols by their values.
    *
    * Only applies to elements.
    *
@@ -739,11 +733,7 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
    * @param {String} objName
    * @param {CSN.Path} path
    */
-  function transformCommon(obj, objName, path) {
-    // (100 b) Remove attribute 'localized'
-    if (obj.localized)
-      delete obj.localized;
-
+  function replaceEnums(obj, objName, path) {
     // (190 a) Replace enum symbols by their value (if found)
     replaceEnumSymbolsByValues(obj, path);
 
@@ -832,6 +822,7 @@ function transformForRelationalDBWithCsn(csn, options, messageFunctions) {
   /**
    * @param {CSN.Artifact} artifact
    * @param {string} artifactName
+   * @todo can we do this earlier? Together with another forEachMemberRecursively?
    */
   function checkTypeParameters(artifact, artifactName) {
     forEachMemberRecursively(artifact, (member, memberName, prop, path) => {

package/lib/transform/localized.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const { makeMessageFunction } = require('../base/messages');
-const { setProp, isDeprecatedEnabled} = require('../base/model');
+const { setProp, isDeprecatedEnabled, isBetaEnabled} = require('../base/model');
 const { forEachKey } = require('../utils/objectUtils');
 const { cleanSymbols } = require('../base/cleanSymbols.js');
 const {
@@ -747,7 +747,7 @@ function copyLocation(target, source) {
 }
 
 /**
- * Copy @cds.persistence.exists/skip annotations from the source to
+ * Copy @cds.persistence.skip annotations from the source to
  * the target.  Ignores existing annotations on the _target_.
  *
  * @param {CSN.Artifact} target
@@ -755,14 +755,15 @@ function copyLocation(target, source) {
  * @param {CSN.Options} options
  */
 function copyPersistenceAnnotations(target, source, options) {
-  const doNotCopyExists = isDeprecatedEnabled( options, 'eagerPersistenceForGeneratedEntities' );
+  const copyExists = !isBetaEnabled(options, 'v5preview') &&
+    !isDeprecatedEnabled( options, 'eagerPersistenceForGeneratedEntities' );
   forEachKey(source, anno => {
     // Note:
-    //   Because `.exists` is copied to the convenience view, it could
+    //   v3/v4: Because `.exists` is copied to the convenience view, it could
     //   lead to some localization views referencing non-existing ones.
     //   But that is the contract: User says that it already exists!
-    //   In v2, `.exists` was never copied.
-    if (anno === annoPersistenceSkip || (!doNotCopyExists && anno === '@cds.persistence.exists'))
+    //   v2/>=v5, `.exists` is never copied.
+    if (anno === annoPersistenceSkip || (copyExists && anno === '@cds.persistence.exists'))
       target[anno] = source[anno];
   });
 }