@sap/cds-compiler 2.15.4 → 2.15.6

package/CHANGELOG.md

@@ -7,6 +7,12 @@
 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 2.15.6 - 2022-07-26
+
+### Fixed
+
+- Annotations on sub-elements were lost during re-compilation.
+
 ## Version 2.15.4 - 2022-06-09
 
 ### Fixed

package/lib/api/main.js

@@ -36,7 +36,7 @@ const propertyToCheck = {
 const { cloneCsnNonDict } = require('../model/csnUtils');
 const { toHdbcdsSource } = require('../render/toHdbcds');
 const { ModelError } = require('../base/error');
-const { forEach } = require('../utils/objectUtils');
+const { forEach, forEachKey } = require('../utils/objectUtils');
 
 const relevantGeneralOptions = [ /* for future generic options */ ];
 const relevantOdataOptions = [ 'sqlMapping', 'odataFormat' ];
@@ -639,6 +639,7 @@ function publishCsnProcessor( processor, _name ) {
    */
   function api( csn, options = {}, ...args ) {
     try {
+      checkOutdatedOptions( options );
       return processor( csn, options, ...args );
     }
     catch (err) {
@@ -662,6 +663,48 @@ function publishCsnProcessor( processor, _name ) {
   }
 }
 
+// Note: No toCsn, because @sap/cds may still use it (2022-06-15)
+const oldBackendOptionNames = [ 'toSql', 'toOdata', 'toHana', 'forHana' ];
+/**
+ * Checks if outdated options are used and if so, throw a compiler error.
+ * These include:
+ *  - magicVars (now variableReplacements)
+ *  - toOdata/toSql/toHana/forHana -> now flat options
+ *
+ * @param {CSN.Options} options Backend options
+ */
+function checkOutdatedOptions(options) {
+  if (!options)
+    return;
+  const { warning } = makeMessageFunction(null, options, 'api');
+
+  // This warning has been emitted once, we don't need to emit it again.
+  if (options.messages && options.messages.some(m => m.messageId === 'api-invalid-option'))
+    return;
+
+  for (const name of oldBackendOptionNames) {
+    if (typeof options[name] === 'object') // may be a boolean due to internal options
+      warning('api-invalid-option', null, { '#': 'std', name });
+  }
+
+  if (options.magicVars)
+    warning('api-invalid-option', null, { '#': 'magicVars' });
+
+  // Don't check `options.magicVars`.  It's likely that the user renamed `magicVars` but
+  // forgot about user -> $user and locale -> $user.locale
+  if (options.variableReplacements) {
+    if (options.variableReplacements.user)
+      warning('api-invalid-option', null, { '#': 'user' });
+    if (options.variableReplacements.locale)
+      warning('api-invalid-option', null, { '#': 'locale' });
+  }
+
+  forEachKey(options.variableReplacements || {}, (name) => {
+    if (!name.startsWith('$') && name !== 'user' && name !== 'locale')
+      warning('api-invalid-option', null, { '#': 'noDollar', name });
+  });
+}
+
 
 /**
  * Option format used by the old API, where they are grouped thematically.

package/lib/base/message-registry.js

@@ -193,6 +193,14 @@ for (const oldName in oldMessageIds) {
 
 // For messageIds, where no text has been provided via code (central def)
 const centralMessageTexts = {
+  'api-invalid-option': {
+    std: 'Option $(NAME) is deprecated! Use SNAPI options instead',
+    magicVars: 'Option “magicVars” is deprecated! Use “variableReplacements” instead. See <https://cap.cloud.sap/docs/guides/databases#configuring-variables> for details',
+    user: 'Option “variableReplacements” expects “$user” instead of “user”. See <https://cap.cloud.sap/docs/guides/databases#configuring-variables> for details',
+    locale: 'Option “variableReplacements” expects “$user.locale” instead of “locale”. See <https://cap.cloud.sap/docs/guides/databases#configuring-variables> for details',
+    'noDollar': 'Option “variableReplacements” does not know $(NAME). Did you forget a leading “$”?'
+  },
+
   'anno-duplicate': 'Duplicate assignment with $(ANNO)',
   'anno-mismatched-ellipsis': 'An array with $(CODE) can only be used if there is an assignment below with an array value',
   'anno-unexpected-ellipsis': 'No base annotation available to apply $(CODE)',

package/lib/compiler/populate.js

@@ -109,6 +109,8 @@ function populate( model ) {
   function traverseElementEnvironments( art ) {
     populateView( art );
     environment( art );
+    if (art.elements$)
+      mergeSpecifiedElements(art);
     forEachMember( art, traverseElementEnvironments );
   }
 
@@ -425,8 +427,6 @@ function populate( model ) {
         setLink( view, '_status', '_query' );
         // must be run in order “sub query in FROM first”:
         traverseQueryPost( view.query, null, populateQuery );
-        if (view.elements$)     // specified elements
-          mergeSpecifiedElements( view );
         if (!view.$entity) {
           model._entities.push( view );
           view.$entity = ++model.$entity;
@@ -435,14 +435,25 @@ function populate( model ) {
     }
   }
 
-  function mergeSpecifiedElements( view ) {
+  /**
+   * Merge _specified_ elements with _inferred_ elements in the given view/element,
+   * where specified elements can appear through CSN.
+   *
+   * We only copy annotations, since they are not part of `columns`,
+   * but only appear in `elements` in CSN.
+   *
+   * This is important to ensure re-compilability.
+   *
+   * @param art
+   */
+  function mergeSpecifiedElements( art ) {
     // Later we use specified elements as proxies to inferred of leading query
     // (No, we probably do not.)
-    for (const id in view.elements) {
-      const ielem = view.elements[id];  // inferred element
-      const selem = view.elements$[id]; // specified element
+    for (const id in art.elements) {
+      const ielem = art.elements[id];  // inferred element
+      const selem = art.elements$[id]; // specified element
       if (!selem) {
-        info( 'query-missing-element', [ ielem.name.location, view ], { id },
+        info( 'query-missing-element', [ ielem.name.location, art ], { id },
               'Element $(ID) is missing in specified elements' );
       }
       else {
@@ -452,13 +463,20 @@ function populate( model ) {
             ielem[prop] = selem[prop];
         }
         selem.$replacement = true;
+        if (selem.elements) {
+          setLink(ielem, 'elements$', selem.elements);
+          delete selem.elements;
+        }
       }
     }
-    for (const id in view.elements$) {
-      const selem = view.elements$[id]; // specified element
-      if (!selem.$replacement) {
-        error( 'query-unspecified-element', [ selem.name.location, selem ], { id },
-               'Element $(ID) does not result from the query' );
+    // Without element expansion, we can't merge nested elements.
+    if (art.kind === 'entity' || enableExpandElements) {
+      for (const id in art.elements$) {
+        const selem = art.elements$[id]; // specified element
+        if (!selem.$replacement) {
+          error( 'query-unspecified-element', [ selem.name.location, selem ], { id },
+                 'Element $(ID) does not result from the query' );
+        }
       }
     }
   }

package/package.json

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