@sap/cds-compiler 2.11.2 → 2.13.6

package/lib/render/manageConstraints.js

@@ -5,6 +5,7 @@ const {
   forEachDefinition,
   getResultingName,
 } = require('../model/csnUtils');
+const { forEach } = require('../utils/objectUtils');
 
 const {
   renderReferentialConstraint, getIdentifierUtils,
@@ -13,7 +14,7 @@ const {
 /**
  * This render middleware can be used to generate SQL DDL ALTER TABLE <table> ALTER / ADD / DROP CONSTRAINT <constraint> statements for a given CDL model.
  * Moreover, it can be used to generate .hdbconstraint artifacts.
- * Depending on the options.manageConstraints provided,the VALIDATED / ENFORCED flag of the constraints can be adjusted.
+ * Depending on the options.manageConstraints provided, the VALIDATED / ENFORCED flag of the constraints can be adjusted.
  *
  * @param {CSN.Model} csn
  * @param {CSN.Options} options
@@ -29,25 +30,24 @@ function manageConstraints(csn, options) {
   const { quoteSqlId } = getIdentifierUtils(options);
   forEachDefinition(csn, (artifact) => {
     if (artifact.$tableConstraints && artifact.$tableConstraints.referential) {
-      Object.entries(artifact.$tableConstraints.referential)
-        .forEach(([ fileName, constraint ]) => {
-          const renderAlterConstraintStatement = alter && src !== 'hdi';
-          const renderedConstraint = renderReferentialConstraint(constraint, indent, false, csn, options, renderAlterConstraintStatement);
-          if (src === 'hdi') {
-            resultArtifacts[fileName] = renderedConstraint;
-            return;
-          }
-          let alterTableStatement = '';
-          alterTableStatement += `${indent}ALTER TABLE ${quoteSqlId(getResultingName(csn, options.toSql.names, constraint.dependentTable))}`;
-          if (renderAlterConstraintStatement)
-            alterTableStatement += `\n${indent}ALTER ${renderedConstraint};`;
-          else if (drop)
-            alterTableStatement += `${indent} DROP CONSTRAINT ${quoteSqlId(constraint.identifier)};`;
-          else
-            alterTableStatement += `\n${indent}ADD ${renderedConstraint};`;
-
-          resultArtifacts[fileName] = alterTableStatement;
-        });
+      forEach(artifact.$tableConstraints.referential, (fileName, constraint) => {
+        const renderAlterConstraintStatement = alter && src !== 'hdi';
+        const renderedConstraint = renderReferentialConstraint(constraint, indent, false, csn, options, renderAlterConstraintStatement);
+        if (src === 'hdi') {
+          resultArtifacts[fileName] = renderedConstraint;
+          return;
+        }
+        let alterTableStatement = '';
+        alterTableStatement += `${indent}ALTER TABLE ${quoteSqlId(getResultingName(csn, options.toSql.names, constraint.dependentTable))}`;
+        if (renderAlterConstraintStatement)
+          alterTableStatement += `\n${indent}ALTER ${renderedConstraint};`;
+        else if (drop)
+          alterTableStatement += `${indent} DROP CONSTRAINT ${quoteSqlId(constraint.identifier)};`;
+        else
+          alterTableStatement += `\n${indent}ADD ${renderedConstraint};`;
+
+        resultArtifacts[fileName] = alterTableStatement;
+      });
     }
   });
   return resultArtifacts;
@@ -65,25 +65,29 @@ function listReferentialIntegrityViolations(csn, options) {
   const referentialConstraints = getListOfAllConstraints(csn);
   const resultArtifacts = {};
   const indent = '    ';
-  const increaseIndent = indent => `${indent}    `;
+  const increaseIndent = str => `    ${str}`;
   // helper function to reduce parent key / foreign key array to a comma separated string which can be used in a select clause
   const keyStringReducer = prefix => (prev, curr, index) => (index > 0 ? `${prev},\n${curr} AS "${prefix}:${curr}"` : prev);
   // helper function to reduce the parent key / foreign key arrays of a referential constraint to a join list which can be used in a where clause
   const joinPkWithFkReducer = (constraint, subQueryAlias, mainQueryAlias) => (prev, curr, index) => (index > 0
     ? `${prev} AND
-    ${increaseIndent(indent)}${mainQueryAlias}.${quoteSqlId(constraint.foreignKey[index])} = ${subQueryAlias}.${quoteSqlId(constraint.parentKey[index])}`
+    ${increaseIndent(indent)}"${mainQueryAlias}".${quoteSqlId(constraint.foreignKey[index])} = ${subQueryAlias}.${quoteSqlId(constraint.parentKey[index])}`
     : increaseIndent(increaseIndent(indent)) + prev);
 
-  Object.entries(referentialConstraints).forEach(([ identifier, constraint ]) => {
+  Object.entries(referentialConstraints).forEach(([ identifier, constraint ], index) => {
     let selectViolations = 'SELECT\n';
+    // this column indicates which SELECT revealed the integrity violation
+    // and helps to identify the corrupted table
+    selectViolations += `${index} as "SELECT-ID",\n`;
     // SELECT <primary_key>,
     const primaryKeyList = selectPrimaryKeyColumns(constraint);
     if (primaryKeyList)
       selectViolations += `${primaryKeyList},\n`;
     // ... <foreign_key>
     selectViolations += selectForeignKeyColumns(constraint);
-    // ... FROM <dependent table> AS "MAIN"
-    selectViolations += `\nFROM ${quoteAndGetResultingName(constraint.dependentTable)} AS "MAIN"\n`;
+    const mainQueryAlias = `MAIN_${index}`;
+    // ... FROM <dependent table> AS "${index}"
+    selectViolations += `\nFROM ${quoteAndGetResultingName(constraint.dependentTable)} AS "${mainQueryAlias}"\n`;
     // ... WHERE NOT (<(part of) foreign key is null>)
     selectViolations += whereNotForeignKeyIsNull(constraint);
     /*
@@ -91,7 +95,7 @@ function listReferentialIntegrityViolations(csn, options) {
             SELECT * FROM <parent_table> WHERE <dependent_table>.<foreign_key> = <parent_table>.<parent_key>
         )
     */
-    selectViolations += andNoMatchingPrimaryKeyExists(constraint);
+    selectViolations += andNoMatchingPrimaryKeyExists(constraint, mainQueryAlias);
     resultArtifacts[identifier] = selectViolations;
   });
 
@@ -147,21 +151,21 @@ function listReferentialIntegrityViolations(csn, options) {
    * Generate SQL sub-SELECT, listing all rows of the parent table where no matching primary key column for the respective foreign key is found.
    *
    * @param {CSN.ReferentialConstraint} constraint
+   * @param {string} mainQueryAlias
    * @returns AND NOT EXISTS ( SELECT * FROM <parent_table> WHERE <dependent_table>.<foreign_key> = <parent_table>.<parent_key> ) statement
    */
-  function andNoMatchingPrimaryKeyExists(constraint) {
+  function andNoMatchingPrimaryKeyExists(constraint, mainQueryAlias) {
     let andNotExists = `\n${indent}AND NOT EXISTS (\n`;
     andNotExists += `${increaseIndent(indent)}SELECT * FROM ${quoteAndGetResultingName(constraint.parentTable)}`;
     // add an alias to both queries so that they can be distinguished at all times
     const subQueryAlias = '"SUB"';
-    const mainQueryAlias = '"MAIN"';
     andNotExists += ` AS ${subQueryAlias}`;
     andNotExists += '\n';
     const joinListReducer = joinPkWithFkReducer(constraint, subQueryAlias, mainQueryAlias);
     andNotExists += `${increaseIndent(indent)}WHERE (\n`;
     andNotExists += constraint.foreignKey
       .reduce(joinListReducer,
-              `${mainQueryAlias}.${quoteSqlId(constraint.foreignKey[0])} = ${subQueryAlias}.${quoteSqlId(constraint.parentKey[0])}`);
+              `"${mainQueryAlias}".${quoteSqlId(constraint.foreignKey[0])} = ${subQueryAlias}.${quoteSqlId(constraint.parentKey[0])}`);
     andNotExists += `\n${increaseIndent(indent)})`;
     andNotExists += `\n${indent});`;
     return andNotExists;
@@ -179,10 +183,9 @@ function getListOfAllConstraints(csn) {
   const referentialConstraints = {};
   forEachDefinition(csn, (artifact) => {
     if (artifact.$tableConstraints && artifact.$tableConstraints.referential) {
-      Object.entries(artifact.$tableConstraints.referential)
-        .forEach(([ identifier, referentialConstraint ]) => {
-          referentialConstraints[identifier] = referentialConstraint;
-        });
+      forEach(artifact.$tableConstraints.referential, (identifier, referentialConstraint) => {
+        referentialConstraints[identifier] = referentialConstraint;
+      });
     }
   });
   return referentialConstraints;