@sap/cds-compiler 3.4.2 → 3.5.0

package/lib/edm/annotations/preprocessAnnotations.js

@@ -10,12 +10,12 @@ const { forEachDefinition } = require('../../model/csnUtils.js');
  * options:
  *   v
  *
- * This module never produces errors. In case of "unexpected" situations we issue a warning and
+ * This module never produces errors. In case of "unexpected" situations we issue a message and
  * try to proceed with the processing as good as possible.
  *
  */
 function preprocessAnnotations(csn, serviceName, options) {
-  const { warning } = makeMessageFunction(csn, options);
+  const { message } = makeMessageFunction(csn, options);
   let fkSeparator = '_';
 
   resolveShortcuts();
@@ -32,7 +32,7 @@ function preprocessAnnotations(csn, serviceName, options) {
   }
 
   // return value can be null is target has no key
-  function getKeyOfTargetOfManagedAssoc(assoc) {
+  function getKeyOfTargetOfManagedAssoc(anno, assoc) {
     // assoc.target can be the name of the target or the object itself
     let targetName = (typeof assoc.target === 'object') ? assoc.target.name : assoc.target;
     let target     = (typeof assoc.target === 'object') ? assoc.target      : csn.definitions[assoc.target];
@@ -40,10 +40,11 @@ function preprocessAnnotations(csn, serviceName, options) {
     let keyNames = Object.keys(target.elements).filter(x => target.elements[x].key && !target.elements[x].target);
     if (keyNames.length === 0) {
       keyNames.push('MISSING');
-      warning(null, null, `in annotation preprocessing: target ${targetName} has no key`);
+      message('odata-anno-preproc', null, { anno, name: targetName, '#': 'nokey' },
+      'target $(NAME) has no key');
     }
     else if (keyNames.length > 1)
-      warning(null, null, `in annotation preprocessing: target ${targetName} has multiple key elements`);
+      message('odata-anno-preproc', null, { anno, name: targetName, '#': 'multkeys' });
     
     return keyNames[0];
   }
@@ -58,32 +59,29 @@ function preprocessAnnotations(csn, serviceName, options) {
     let art = null;
 
     forEachDefinition(csn, (artifact, artifactName) => {
+      const location = [ 'definitions', artifactName ];
       if(artifactName === serviceName || artifactName.startsWith(serviceName + '.')) {
         art = artifactName;
-        handleAnnotations(artifactName, artifact);
+        handleAnnotations(artifactName, artifact, location);
         artifact.elements && Object.entries(artifact.elements).forEach(([elementName, element]) => {
-          handleAnnotations(elementName, element);
+          handleAnnotations(elementName, element, [ ...location, 'elements', elementName ]);
         });
         artifact.actions && Object.values(artifact.actions).forEach(action => {
           action.params && Object.entries(action.params).forEach(([paramName, param]) => {
-            handleAnnotations(paramName, param);
+            handleAnnotations(paramName, param, [ ...location, 'actions', action, 'params', paramName ]);
           });
         });
       }
     });
 
-    function handleAnnotations(carrierName, carrier) {
+    function handleAnnotations(carrierName, carrier, location) {
 
       // collect the names of the carrier's annotation properties
-      let annoNames = Object.keys(carrier).filter( x => x.substr(0,1) === '@')
+      let annoNames = Object.keys(carrier).filter( x => x[0] === '@')
 
       for (let aName of annoNames) {
         let aNameWithoutQualifier = aName.split('#')[0];
 
-        //for warning messages
-        let ctx = 'target: ' + art + '/' + carrierName;
-
-
         // Always - draft annotations, value is action name
         //   - v2: prefix with entity name
         //   - prefix with service name
@@ -91,11 +89,11 @@ function preprocessAnnotations(csn, serviceName, options) {
 
         // Always - FixedValueListShortcut
         //   expand shortcut form of ValueList annotation
-        fixedValueListShortCut(carrier, aNameWithoutQualifier, ctx);
+        fixedValueListShortCut(carrier, aNameWithoutQualifier);
 
         // Always - TextArrangementReordering
         //   convert @Common.TextArrangement annotation that is on same level as Text annotation into a nested annotation
-        textArrangementReordering(carrier, aName, aNameWithoutQualifier, ctx);
+        textArrangementReordering(carrier, aName, aNameWithoutQualifier);
       }
 
       // inner functions
@@ -121,9 +119,9 @@ function preprocessAnnotations(csn, serviceName, options) {
         }
       }
 
-      function fixedValueListShortCut(carrier, aNameWithoutQualifier, ctx) {
-        if (aNameWithoutQualifier === '@Common.ValueList.entity' ||
-            aNameWithoutQualifier === '@Common.ValueList.viaAssociation') {
+      function fixedValueListShortCut(carrier, anno) {
+        if (anno === '@Common.ValueList.entity' ||
+            anno === '@Common.ValueList.viaAssociation') {
 
           const _fixedValueListShortCut = () => {
             // note: we loop over all annotations that were originally present, even if they are
@@ -136,7 +134,7 @@ function preprocessAnnotations(csn, serviceName, options) {
             }
 
             if (carrier.kind === 'entity') {
-              warning(null, null, `annotation preprocessing/${aNameWithoutQualifier}: annotation must not be used for an entity, ${ctx}`);
+              message('odata-anno-preproc', [...location, anno], { anno, '#': 'notforentity' });
               return false;
             }
 
@@ -146,32 +144,37 @@ function preprocessAnnotations(csn, serviceName, options) {
             let enameShort = null;  // (string) name of value list entity, short (i.e. name within service)
             let enameFull = null;   // (string) name of value list entity, fully qualified name
 
-            if (aNameWithoutQualifier === '@Common.ValueList.viaAssociation') {
+            if (anno === '@Common.ValueList.viaAssociation') {
               // value is expected to be an expression, namely the path to an association of the carrier entity
               let assocName = carrier['@Common.ValueList.viaAssociation']['='];
               if (!assocName) {
-                warning(null, null, `in annotation preprocessing/${aNameWithoutQualifier}: value of 'viaAssociation' must be a path, ${ctx}`);
+                message('odata-anno-preproc', [...location, anno], { anno, '#': 'viaassoc' });
                 return false;
               }
               let assoc = csn.definitions[art].elements[assocName];
               if (!assoc || !assoc.target) {
-                warning(null, null, `in annotation preprocessing/${aNameWithoutQualifier}: there is no association "${assocName}", ${ctx}`);
+                message('odata-anno-preproc', [...location, anno], { anno, id: assocName, '#': 'noassoc' });
                 return false;
               }
 
               enameFull = assoc.target.name || assoc.target; // full name
               enameShort = enameFull.split('.').pop();
             }
-            else if (aNameWithoutQualifier === '@Common.ValueList.entity') {
+            else if (anno === '@Common.ValueList.entity') {
               // if both annotations are present, ignore 'entity' and raise a message
               if (annoNames.map(x=>x.split('#')[0]).find(x=>(x==='@Common.ValueList.viaAssociation'))) {
-                warning(null, null, `in annotation preprocessing/@Common.ValueList: 'entity' is ignored, as 'viaAssociation' is present, ${ctx}`);
+                message('odata-anno-preproc', [...location, anno],
+                  { 
+                    name: '@Common.ValueList.entity', anno: '@Common.ValueList', 
+                    value: 'entity', code: 'viaAssociation', '#': 'vallistignored'
+                  });
                 return false;
               }
 
               let annoVal = carrier['@Common.ValueList.entity']; // name of value list entity
               if (annoVal['=']) {
-                warning(null, null, `in annotation preprocessing/${aNameWithoutQualifier}: annotation value must be a string, ${ctx}`);
+                message('odata-anno-preproc', [...location, anno], { anno, '#': 'notastring' },
+                );
               }
 
               let nameprefix = art.replace(/.[^.]+$/, ''); // better way of getting the service name?
@@ -182,7 +185,7 @@ function preprocessAnnotations(csn, serviceName, options) {
 
             let vlEntity = csn.definitions[enameFull]; // (object) value list entity
             if (!vlEntity) {
-              warning(null, null, `in annotation preprocessing/${aNameWithoutQualifier}: entity "${enameFull}" does not exist, ${ctx}`);
+              message('odata-anno-preproc', [...location, anno ], { anno, id: enameFull, '#': 'notexist' });
               return false;
             }
 
@@ -196,7 +199,8 @@ function preprocessAnnotations(csn, serviceName, options) {
             //   if this is a managed assoc, use fk field instead (if there is a single one)
             let localDataProp = carrierName.split('/').pop();
             if (carrier.target && carrier.on === undefined) {
-              localDataProp = localDataProp + fkSeparator + getKeyOfTargetOfManagedAssoc(carrier);
+              localDataProp = localDataProp + fkSeparator + 
+                getKeyOfTargetOfManagedAssoc(anno, carrier);
             }
 
             // if this carrier is a generated foreign key field and the association is marked @cds.api.ignore
@@ -209,15 +213,15 @@ function preprocessAnnotations(csn, serviceName, options) {
             }
 
             // valueListProp: the (single) key field of the value list entity
-            //   if no key or multiple keys -> warning
+            //   if no key or multiple keys -> message
             let valueListProp = null;
             let keys = Object.keys(vlEntity.elements).filter( x => vlEntity.elements[x].key && !vlEntity.elements[x].target );
             if (keys.length === 0) {
-              warning(null, null, `in annotation preprocessing/value help shortcut: entity "${enameFull}" has no key, ${ctx}`);
+              message('odata-anno-preproc', [...location, anno], { anno, name: enameFull, '#': 'vhlnokey' });
               return false;
             }
             else if (keys.length > 1)
-              warning(null, null, `in annotation preprocessing/value help shortcut: entity "${enameFull}" has more than one key, ${ctx}`);
+              message('odata-anno-preproc', [...location, anno], { anno, name: enameFull, '#': 'vhlmultkeys' });
             valueListProp = keys[0];
 
             // textField:
@@ -278,20 +282,20 @@ function preprocessAnnotations(csn, serviceName, options) {
 
           const success = _fixedValueListShortCut();
           if (!success) {
-            // In case of failure, avoid subsequent warnings
-            delete carrier[aNameWithoutQualifier];
+            // In case of failure, avoid subsequent messages
+            delete carrier[anno];
             delete carrier['@Common.ValueList.type'];
           }
         }
       }
 
-      function textArrangementReordering(carrier, aName, aNameWithoutQualifier, ctx) {
+      function textArrangementReordering(carrier, aName, aNameWithoutQualifier) {
         if (aNameWithoutQualifier === '@Common.TextArrangement') {
           let value = carrier[aName];
           let textAnno = carrier['@Common.Text'];
           // can only occur if there is a @Common.Text annotation at the same target
           if (!textAnno) {
-            warning(null, null, `in annotation preprocessing: TextArrangement shortcut without Text annotation, ${ctx}`);
+            message('odata-anno-preproc', [...location, '@Common.TextArrangement'], { anno: '@Common.TextArrangement', name: '@Common.Text', '#': 'txtarr' });
           }
 
           //change the scalar anno into a "pseudo-structured" one