@sap/cds-compiler 4.1.2 → 4.2.2

package/lib/edm/annotations/preprocessAnnotations.js

@@ -4,7 +4,7 @@ const { makeMessageFunction } = require('../../base/messages.js');
 const { forEachDefinition, forEachGeneric } = require('../../model/csnUtils.js');
 
 
-/**************************************************************************************************
+/** ************************************************************************************************
  * preprocessAnnotations
  *
  * options:
@@ -14,9 +14,9 @@ const { forEachDefinition, forEachGeneric } = require('../../model/csnUtils.js')
  * try to proceed with the processing as good as possible.
  *
  */
-function preprocessAnnotations(csn, serviceName, options) {
+function preprocessAnnotations( csn, serviceName, options ) {
   const { message } = makeMessageFunction(csn, options);
-  let fkSeparator = '_';
+  const fkSeparator = '_';
 
   resolveShortcuts();
 
@@ -32,19 +32,20 @@ function preprocessAnnotations(csn, serviceName, options) {
   }
 
   // return value can be null is target has no key
-  function getKeyOfTargetOfManagedAssoc(anno, assoc) {
+  function getKeyOfTargetOfManagedAssoc( anno, assoc ) {
     // assoc.target can be the name of the target or the object itself
     const targetName = (typeof assoc.target === 'object') ? assoc.target.name : assoc.target;
-    const target     = (typeof assoc.target === 'object') ? assoc.target      : csn.definitions[assoc.target];
+    const target = (typeof assoc.target === 'object') ? assoc.target : csn.definitions[assoc.target];
 
     const keyNames = Object.keys(target.elements).filter(x => target.elements[x].key && !target.elements[x].target);
     if (keyNames.length === 0) {
       keyNames.push('MISSING');
       message('odata-anno-preproc', null, { anno, name: targetName, '#': 'nokey' },
-      'target $(NAME) has no key');
+              'target $(NAME) has no key');
     }
-    else if (keyNames.length > 1)
+    else if (keyNames.length > 1) {
       message('odata-anno-preproc', null, { anno, name: targetName, '#': 'multkeys' });
+    }
 
     return keyNames[0];
   }
@@ -58,28 +59,33 @@ function preprocessAnnotations(csn, serviceName, options) {
   function resolveShortcuts() {
     forEachDefinition(csn, (artifact, artifactName) => {
       const location = [ 'definitions', artifactName ];
-      if(artifactName === serviceName || artifactName.startsWith(serviceName + '.')) {
+      if (artifactName === serviceName || artifactName.startsWith(`${serviceName}.`)) {
         handleAnnotations(artifactName, artifactName, artifact, location);
-        artifact.elements && Object.entries(artifact.elements).forEach(([elementName, element]) => {
-          handleAnnotations(artifactName, elementName, element, [ ...location, 'elements', elementName ]);
-        });
-        artifact.params && Object.entries(artifact.params).forEach(([paramName, param]) => {
-          handleAnnotations(artifactName, paramName, param, [ ...location, 'actions', artifactName, 'params', paramName ]);
-        });
-        forEachGeneric(artifact, 'actions', (action, actionName) => {
-          action.params && Object.entries(action.params).forEach(([paramName, param]) => {
-            handleAnnotations(actionName, paramName, param, [ ...location, 'actions', actionName, 'params', paramName ]);
+        if (artifact.elements) {
+          Object.entries(artifact.elements).forEach(([ elementName, element ]) => {
+            handleAnnotations(artifactName, elementName, element, [ ...location, 'elements', elementName ]);
           });
+        }
+        if (artifact.params) {
+          Object.entries(artifact.params).forEach(([ paramName, param ]) => {
+            handleAnnotations(artifactName, paramName, param, [ ...location, 'actions', artifactName, 'params', paramName ]);
+          });
+        }
+        forEachGeneric(artifact, 'actions', (action, actionName) => {
+          if (action.params) {
+            Object.entries(action.params).forEach(([ paramName, param ]) => {
+              handleAnnotations(actionName, paramName, param, [ ...location, 'actions', actionName, 'params', paramName ]);
+            });
+          }
         });
       }
     });
 
-    function handleAnnotations(defName, carrierName, carrier, location) {
-
+    function handleAnnotations( defName, carrierName, carrier, location ) {
       // collect the names of the carrier's annotation properties
-      const annoNames = Object.keys(carrier).filter( x => x[0] === '@')
+      const annoNames = Object.keys(carrier).filter( x => x[0] === '@');
 
-      annoNames.forEach(aName => {
+      annoNames.forEach((aName) => {
         const aNameWithoutQualifier = aName.split('#')[0];
 
         // Always - draft annotations, value is action name
@@ -97,45 +103,45 @@ function preprocessAnnotations(csn, serviceName, options) {
       });
 
       // inner functions
-      function draftAnnotations(aName, aNameWithoutQualifier) {
+      function draftAnnotations( aName, aNameWithoutQualifier ) {
         if ((carrier.kind === 'entity') &&
             (aNameWithoutQualifier === '@Common.DraftRoot.PreparationAction' ||
               aNameWithoutQualifier === '@Common.DraftRoot.ActivationAction' ||
               aNameWithoutQualifier === '@Common.DraftRoot.EditAction' ||
               aNameWithoutQualifier === '@Common.DraftNode.PreparationAction')
-            ) {
+        ) {
           let value = carrier[aName];
           // prefix with service name, if not already done
-          if (value === 'draftPrepare'  || value === 'draftActivate' || value === 'draftEdit') {
+          if (value === 'draftPrepare' || value === 'draftActivate' || value === 'draftEdit') {
             // mocha test has no whatsMySchemaName
             const schemaName = options.whatsMySchemaName && options.whatsMySchemaName(carrierName) || serviceName;
-            value = carrier[aName] = schemaName + '.' + value;
+            carrier[aName] = `${schemaName}.${value}`;
+            value = carrier[aName];
           }
           // for v2: function imports live inside EntityContainer -> path needs to contain "EntityContainer/"
           //         we decided to prefix names of bound action/functions with entity name -> needs to be reflected in path, too
           if (isV2()) {
-            let entityNameShort = carrierName.split('.').pop();
-            carrier[aName] = value.replace(/(draft(Prepare|Activate|Edit))$/, (match, p1) => 'EntityContainer/' + entityNameShort + '_' + p1)
+            const entityNameShort = carrierName.split('.').pop();
+            carrier[aName] = value.replace(/(draft(Prepare|Activate|Edit))$/, (match, p1) => `EntityContainer/${entityNameShort}_${p1}`);
           }
         }
       }
 
-      function fixedValueListShortCut(anno) {
+      function fixedValueListShortCut( 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
             //       removed from the carrier via this handler
             //       we don't remove anything from the array "annoNames"
 
             // if CollectionPath is explicitly given, no shortcut expansion is made
-            if (carrier['@Common.ValueList.CollectionPath']) {
+            if (carrier['@Common.ValueList.CollectionPath'])
               return false;
-            }
+
 
             if (carrier.kind === 'entity') {
-              message('odata-anno-preproc', [...location, anno], { anno, '#': 'notforentity' });
+              message('odata-anno-preproc', [ ...location, anno ], { anno, '#': 'notforentity' });
               return false;
             }
 
@@ -149,12 +155,12 @@ function preprocessAnnotations(csn, serviceName, options) {
               // value is expected to be an expression, namely the path to an association of the carrier entity
               const assocName = carrier['@Common.ValueList.viaAssociation']['='];
               if (!assocName) {
-                message('odata-anno-preproc', [...location, anno], { anno, '#': 'viaassoc' });
+                message('odata-anno-preproc', [ ...location, anno ], { anno, '#': 'viaassoc' });
                 return false;
               }
               const assoc = csn.definitions[defName].elements[assocName];
               if (!assoc || !assoc.target) {
-                message('odata-anno-preproc', [...location, anno], { anno, id: assocName, '#': 'noassoc' });
+                message('odata-anno-preproc', [ ...location, anno ], { anno, id: assocName, '#': 'noassoc' });
                 return false;
               }
 
@@ -163,29 +169,31 @@ function preprocessAnnotations(csn, serviceName, options) {
             }
             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'))) {
-                message('odata-anno-preproc', [...location, anno],
-                  {
-                    name: '@Common.ValueList.entity', anno: '@Common.ValueList',
-                    value: 'entity', code: 'viaAssociation', '#': 'vallistignored'
-                  });
+              if (annoNames.map(x => x.split('#')[0]).find(x => (x === '@Common.ValueList.viaAssociation'))) {
+                message('odata-anno-preproc', [ ...location, anno ],
+                        {
+                          name: '@Common.ValueList.entity',
+                          anno: '@Common.ValueList',
+                          value: 'entity',
+                          code: 'viaAssociation',
+                          '#': 'vallistignored',
+                        });
                 return false;
               }
 
               const annoVal = carrier['@Common.ValueList.entity']; // name of value list entity
-              if (annoVal['=']) {
-                message('odata-anno-preproc', [...location, anno], { anno, '#': 'notastring' },
-                );
-              }
+              if (annoVal['='])
+                message('odata-anno-preproc', [ ...location, anno ], { anno, '#': 'notastring' });
+
               // mocha test has no whatsMySchemaName
-              const schemaName = options.whatsMySchemaName && options.whatsMySchemaName(defName) || serviceName
+              const schemaName = options.whatsMySchemaName && options.whatsMySchemaName(defName) || serviceName;
               enameShort = annoVal['='] || annoVal;
-              enameFull = schemaName + '.' + enameShort;
+              enameFull = `${schemaName}.${enameShort}`;
             }
 
             const vlEntity = csn.definitions[enameFull]; // (object) value list entity
             if (!vlEntity) {
-              message('odata-anno-preproc', [...location, anno ], { anno, id: enameFull, '#': 'notexist' });
+              message('odata-anno-preproc', [ ...location, anno ], { anno, id: enameFull, '#': 'notexist' });
               return false;
             }
 
@@ -205,11 +213,10 @@ function preprocessAnnotations(csn, serviceName, options) {
 
             // if this carrier is a generated foreign key field and the association is marked @cds.api.ignore
             // rename the localDataProp to be 'assocName/key'
-            if(carrier['@cds.api.ignore']) {
+            if (carrier['@cds.api.ignore']) {
               const assocName = carrier['@odata.foreignKey4'];
-              if(assocName && options.isV4()) {
-                localDataProp = localDataProp.replace(assocName+fkSeparator, assocName+'/');
-              }
+              if (assocName && options.isV4())
+                localDataProp = localDataProp.replace(assocName + fkSeparator, `${assocName}/`);
             }
 
             // valueListProp: the (single) key field of the value list entity
@@ -217,11 +224,12 @@ function preprocessAnnotations(csn, serviceName, options) {
             let valueListProp = null;
             const keys = Object.keys(vlEntity.elements).filter( x => vlEntity.elements[x].key && !vlEntity.elements[x].target );
             if (keys.length === 0) {
-              message('odata-anno-preproc', [...location, anno], { anno, name: enameFull, '#': 'vhlnokey' });
+              message('odata-anno-preproc', [ ...location, anno ], { anno, name: enameFull, '#': 'vhlnokey' });
               return false;
             }
-            else if (keys.length > 1)
-              message('odata-anno-preproc', [...location, anno], { anno, name: enameFull, '#': 'vhlmultkeys' });
+            else if (keys.length > 1) {
+              message('odata-anno-preproc', [ ...location, anno ], { anno, name: enameFull, '#': 'vhlmultkeys' });
+            }
             valueListProp = keys[0];
 
             // textField:
@@ -234,11 +242,14 @@ function preprocessAnnotations(csn, serviceName, options) {
             const Identification = vlEntity['@UI.Identification'];
             if (Identification && Identification[0] && Identification[0]['=']) {
               textField = Identification[0]['='];
-            } else if (Identification && Identification[0] && Identification[0]['Value'] && Identification[0]['Value']['=']) {
-              textField = Identification[0]['Value']['='];
-            } else {
+            }
+            else if (Identification && Identification[0] && Identification[0].Value && Identification[0].Value['=']) {
+              textField = Identification[0].Value['='];
+            }
+            else {
               const stringFields = Object.keys(vlEntity.elements).filter(
-                x => !vlEntity.elements[x].key && vlEntity.elements[x].type === 'cds.String')
+                x => !vlEntity.elements[x].key && vlEntity.elements[x].type === 'cds.String'
+              );
               if (stringFields.length === 1)
                 textField = stringFields[0];
             }
@@ -246,21 +257,21 @@ function preprocessAnnotations(csn, serviceName, options) {
             // explicitly provided parameters win
             let parameters = carrier['@Common.ValueList.Parameters'];
             if (!parameters) {
-              parameters = [{
-                '$Type': 'Common.ValueListParameterInOut',
-                'LocalDataProperty' : { '=' : localDataProp },
-                'ValueListProperty' : valueListProp
-              }];
+              parameters = [ {
+                $Type: 'Common.ValueListParameterInOut',
+                LocalDataProperty: { '=': localDataProp },
+                ValueListProperty: valueListProp,
+              } ];
               if (textField) {
                 parameters[1] = {
-                  '$Type': 'Common.ValueListParameterDisplayOnly',
-                  'ValueListProperty' : textField
+                  $Type: 'Common.ValueListParameterDisplayOnly',
+                  ValueListProperty: textField,
                 };
               }
             }
 
             const newObj = Object.create( Object.getPrototypeOf(carrier) );
-            Object.keys(carrier).forEach( e => {
+            Object.keys(carrier).forEach( (e) => {
               if (e === '@Common.ValueList.entity' || e === '@Common.ValueList.viaAssociation') {
                 newObj['@Common.ValueList.Label'] = label;
                 newObj['@Common.ValueList.CollectionPath'] = enameShort;
@@ -278,7 +289,7 @@ function preprocessAnnotations(csn, serviceName, options) {
             });
             Object.assign(carrier, newObj);
             return true;
-          }
+          };
 
           const success = _fixedValueListShortCut();
           if (!success) {
@@ -289,23 +300,23 @@ function preprocessAnnotations(csn, serviceName, options) {
         }
       }
 
-      function textArrangementReordering(aName, aNameWithoutQualifier) {
+      function textArrangementReordering( aName, aNameWithoutQualifier ) {
         if (aNameWithoutQualifier === '@Common.TextArrangement') {
-          let value = carrier[aName];
-          let textAnno = carrier['@Common.Text'];
+          const value = carrier[aName];
+          const textAnno = carrier['@Common.Text'];
           // can only occur if there is a @Common.Text annotation at the same target
-          if (!textAnno) {
-            message('odata-anno-preproc', [...location, '@Common.TextArrangement'], { anno: '@Common.TextArrangement', name: '@Common.Text', '#': 'txtarr' });
-          }
+          if (!textAnno)
+            message('odata-anno-preproc', [ ...location, '@Common.TextArrangement' ], { anno: '@Common.TextArrangement', name: '@Common.Text', '#': 'txtarr' });
 
-          //change the scalar anno into a "pseudo-structured" one
+
+          // change the scalar anno into a "pseudo-structured" one
           // TODO should be flattened, but then alphabetical order is destroyed
 
           // Do not overwrite existing nested annotation values, instead give existing
           // nested annotation precedence and remove outer annotation (always)
-          if(!carrier['@Common.Text.@UI.TextArrangement'] && textAnno) {
-            carrier['@Common.Text'] = { '$value': textAnno, '@UI.TextArrangement': value };
-          }
+          if (!carrier['@Common.Text.@UI.TextArrangement'] && textAnno)
+            carrier['@Common.Text'] = { $value: textAnno, '@UI.TextArrangement': value };
+
           delete carrier[aName];
         }
       }