@sap/cds-compiler 2.13.8 → 3.0.0

package/lib/render/toRename.js

@@ -1,20 +1,24 @@
 
 'use strict';
 
-const { CompilationError, hasErrors } = require('../base/messages');
+const { makeMessageFunction } = require('../base/messages');
 const { checkCSNVersion } = require('../json/csnVersion');
-const { getUtils } = require('../model/csnUtils');
+const { getUtils, forEachDefinition } = require('../model/csnUtils');
+const { optionProcessor } = require('../optionProcessor');
+const { isBetaEnabled } = require('../base/model');
+const { transformForHanaWithCsn } = require('../transform/forHanaNew');
 
-// FIXME: This is not up-to-date in regards to the changes to hdbcds/sql quoting etc.
 
 /**
+ * FIXME: Not yet supported, only in beta mode
+ * FIXME: This is not up-to-date in regards to the changes to hdbcds/sql quoting etc.
  *
- * Render the augmented CSN 'model' to SQL DDL statements renaming existing tables and their
+ * Generate SQL DDL rename statements for a migration, renaming existing tables and their
  * columns so that they match the result of "toHana" or "toSql" with the 'plain' option for names.
  * Expects the naming convention of the existing tables to be either 'quoted' or 'hdbcds' (default).
- * The following options control what is actually generated:
+ * The following options control what is actually generated (see help above):
  *   options : {
- *     toRename.names      :  existing names, either 'quoted' or 'hdbcds' (default)
+ *     sqlMapping :  existing names, either 'quoted' or 'hdbcds' (default)
  *   }
  * Return a dictionary of top-level artifacts by their names, like this:
  * { "foo" : "RENAME TABLE \"foo\" ...",
@@ -22,34 +26,52 @@ const { getUtils } = require('../model/csnUtils');
  * }
  *
  * @todo clarify input parameters
- * @param {CSN.Model} csn Augmented csn?
+ * @param {CSN.Model} inputCsn CSN?
  * @param {CSN.Options} options Transformation options
  * @returns {object} A dictionary of name: rename statement
  */
-function toRenameDdl(csn, options) {
-  // Merge options (arguments first, then model options and default)
-  const result = Object.create(null);
+function toRename(inputCsn, options) {
+  const { error, warning, throwWithError } = makeMessageFunction(inputCsn, options, 'to.rename');
+
+  // Merge options with defaults.
+  options = Object.assign({ sqlMapping: 'hdbcds' }, options);
+
+  // Verify options
+  optionProcessor.verifyOptions(options, 'toRename').forEach(complaint => warning(null, null, `${complaint}`));
+  checkCSNVersion(inputCsn, options);
+
+  // Requires beta mode
+  if (!isBetaEnabled(options, 'toRename'))
+    error(null, null, 'Generation of SQL rename statements is not supported yet (only in beta mode)');
 
-  checkCSNVersion(csn, options);
+  // FIXME: Currently, 'toRename' implies transformation for HANA (transferring the options to forHana)
+  const csn = transformForHanaWithCsn(inputCsn, options, 'to.rename');
+  // forHanaCsn looses empty contexts and services, add them again so that toRename can calculate the namespaces
+  forEachDefinition(csn, (artifact, artifactName) => {
+    if ((artifact.kind === 'context' || artifact.kind === 'service') && csn.definitions[artifactName] === undefined)
+      csn.definitions[artifactName] = artifact;
+  });
+
+  const result = Object.create(null);
+  const { getNamespaceOfArtifact } = getUtils(csn, false);
 
-  const { getNamespaceOfArtifact } = getUtils(csn);
   // Render each artifact on its own
   for (const artifactName in csn.definitions) {
     const sourceStr = renameTableAndColumns(artifactName, csn.definitions[artifactName]);
-
     if (sourceStr !== '')
       result[artifactName] = sourceStr;
   }
-  // Throw exception in case of errors
-  if (hasErrors(options.messages))
-    throw new CompilationError(options.messages);
 
-  return result;
+  throwWithError();
 
+  return {
+    rename: result,
+    options,
+  };
 
   /**
    * If 'art' is a non-view entity, generate SQL statements to rename the corresponding
-   * table and its columns from the naming conventions given in 'options.toRename.name'
+   * table and its columns from the naming conventions given in 'options.sqlMapping'
    * (either 'quoted' or 'hdbcds') to 'plain'. In addition, drop any existing associations
    * from the columns (they would likely become invalid anyway).
    * Do not rename anything if the names are identical.
@@ -97,7 +119,7 @@ function toRenameDdl(csn, options) {
    * @returns {string} Absolute name
    */
   function absoluteCdsName(name) {
-    if (options.toRename.names !== 'hdbcds')
+    if (options.sqlMapping !== 'hdbcds')
       return name;
 
     const namespaceName = getNamespaceOfArtifact(name);
@@ -108,14 +130,14 @@ function toRenameDdl(csn, options) {
   }
 
   /**
-   * Return 'name' with appropriate "-quotes, also replacing '::' by '.' if 'options.toRename.names'
+   * Return 'name' with appropriate "-quotes, also replacing '::' by '.' if 'options.sqlMapping'
    * is 'quoted'
    *
    * @param {string} name Name to quote
    * @returns {string} Quoted string
    */
   function quoteSqlId(name) {
-    if (options.toRename.names === 'quoted')
+    if (options.sqlMapping === 'quoted')
       name = name.replace(/::/g, '.');
 
     return `"${name.replace(/"/g, '""')}"`;
@@ -134,5 +156,5 @@ function toRenameDdl(csn, options) {
 }
 
 module.exports = {
-  toRenameDdl,
+  toRename,
 };