@sap/cds-dk 4.6.4 → 4.8.0

package/lib/import/v2parser.js

@@ -9,6 +9,7 @@ let allEntities = [];
 let allEntitiesMC = [];
 let allEntitySetMap = {};
 let allEntitySetMapMC = {};
+let allEntitySetNamespaces = {};
 let allFunctionImports = [];
 let allFunctionImportsMap = {};
 let allAssociations = {};
@@ -22,6 +23,7 @@ let allowAllNamespaces = false;
 let messages = require("./message").getMessages();
 let common = require("./common");
 let versionInfo = require('../../package.json').version;
+const { warn } = require('@sap/cds/bin/utils/term');
 
 let edmxncdsdatatype = {
 	"Edm.String": "cds.LargeString",
@@ -30,15 +32,14 @@ let edmxncdsdatatype = {
 	"Edm.Int32": "cds.Integer",
 	"Edm.Int64": "cds.Integer64",
 	"Edm.Decimal": "cds.DecimalFloat",
-	"Edm.DateTime": "cds.DateTime",
-	"Edm.DateTimeOffset": "cds.Timestamp",
+	"Edm.DateTime": "cds.DateTime", 
+	"Edm.DateTimeOffset": "cds.DateTime",
 	"Edm.Time": "cds.Time",
 	"Edm.Binary": "cds.LargeBinary",
 	"Edm.Guid": "cds.UUID",
 	"Edm.Byte": "cds.Integer",
 	"Edm.SByte": "cds.Integer",
 	"Edm.Double": "cds.Double",
-	"Edm.Single": "cds.DecimalFloat",
 	// Special handling of data types
 	"Edm.String_m": "cds.String", // Max length
 	"Edm.Decimal_p": "cds.Decimal", // Precision, scale
@@ -47,6 +48,11 @@ let edmxncdsdatatype = {
 	"Edm.Binary_m": "cds.Binary", // Max Length
 	"Edm.Byte_m": "cds.Integer", // Max Length
 	"Edm.Double_p": "cds.Double", // Precision, scale
+	// Special handling with annotations
+	"Edm.Single_a": "cds.Double",
+	"Edm.Stream_a" : "cds.LargeBinary",
+	"Edm.DateTimeOffset_a" : "cds.Timestamp", //precision > 0
+	"Edm.DateTime_a" : "cds.Timestamp" //precision > 0
 };
 
 function _initialize() {
@@ -243,6 +249,9 @@ function _extractEntityFromEntitySet(entitySet) {
 				allEntitySetMapMC[entitySet[key].EntityType] = [];
 			allEntitySetMapMC[entitySet[key].EntityType].push(entitySet[key].Name);
 			entityName = _extractEntityFromNamespace(entitySet[key].EntityType);
+			let namespaces = namespaceAttributeFilter(entitySet[key]);
+			if(namespaces.length)
+				allEntitySetNamespaces[entitySet[key].Name] = namespaces;
 			allEntities.push(entityName);
 			allEntitiesMC.push(entitySet[key].Name);
 		}
@@ -409,9 +418,16 @@ function _getServiceEntityProperty(
 	displayFormat,
 	isKey,
 	documentation,
-	isCollection,
 	allowedNamespaceAttributes = -1
 ) {
+	let isCollection = -1;
+	//preprocessing of datatype in case it is a collection
+	if(dataType.substring(0,10) === 'Collection')
+	{
+		dataType = dataType.substring(11,dataType.length-1);
+		isCollection = 1;
+	}
+
 	let cdsDataType = null;
 	let hasInvalidPrecision = false;
 	let propertyJson='';
@@ -420,8 +436,9 @@ function _getServiceEntityProperty(
 	} else if (precision && precision > 0) {
 		cdsDataType = edmxncdsdatatype[dataType + "_p"];
 		// Falling back to actual data type as precision has no meaning for 'Date' related data types
+		// Using _a data type if precision is there for 'Date' related data types
 		if (cdsDataType === undefined) {
-			cdsDataType = edmxncdsdatatype[dataType];
+			cdsDataType = edmxncdsdatatype[dataType + "_a"];
 			hasInvalidPrecision = true;
 		}
 	} else if (displayFormat && displayFormat === "Date") {
@@ -430,6 +447,10 @@ function _getServiceEntityProperty(
 		cdsDataType = edmxncdsdatatype[dataType];
 	}
 
+	//checks if it's an annotation case
+	if (!cdsDataType) {
+		cdsDataType = edmxncdsdatatype[dataType + "_a"];
+	}
 	// Lookup from complex type properties
 	if (!cdsDataType && allComplexTypes[dataType]) {
 		cdsDataType = dataType;
@@ -442,11 +463,23 @@ function _getServiceEntityProperty(
 
 	//Possibility of entity type or entity set as the data type
 	if (!cdsDataType && allEntitySetMapMC[dataType]) {
-		cdsDataType = serviceNamespace + "." + allEntitySetMapMC[dataType];
+		cdsDataType = serviceNamespace + "." + allEntitySetMapMC[dataType][0];
 	} else if(!cdsDataType && allEntitySetMap[_extractEntityFromNamespace(dataType)]) {
 		cdsDataType = dataType;
 	}
 
+	//if the cdsDataType is undefined/ not supported
+	if(cdsDataType === undefined)
+	{
+		let message = '"' + dataType + '" is not supported'; 
+		if(propertyName)
+			message += ' (in element:"' + propertyName + '")';
+		else
+			message += ' (in return type)'
+		console.log(warn(message));
+		return "";
+	}
+
 	if(propertyName)
 		propertyJson = '"' + propertyName + '": {\n';
 
@@ -458,6 +491,13 @@ function _getServiceEntityProperty(
 		propertyJson = propertyJson + '"items": { \n'
 	}
 	propertyJson = propertyJson + '"type":"' + cdsDataType + '"';
+
+	//if annotations to be added
+	if(edmxncdsdatatype[dataType + "_a"] && cdsDataType != "cds.Date")
+	{
+		propertyJson = propertyJson + ',\n"@odata.type": "' + dataType + '"'; 
+	}
+
 	if (length && length > 0) {
 		propertyJson = propertyJson + ',\n"length":' + length;
 	} else if (precision && precision > 0 && hasInvalidPrecision === false) {
@@ -468,6 +508,14 @@ function _getServiceEntityProperty(
 			propertyJson = propertyJson + ',\n"scale":' + 0;
 		}
 	}
+	
+	//adding precision in case of DateTime datatypes
+	if((dataType === "Edm.DateTimeOffset" || dataType === "Edm.DateTime") && cdsDataType != "cds.Date")
+	{
+		if(!precision || precision === -1) precision = 0;
+		propertyJson = propertyJson + ',\n"@odata.precision": ' + precision;
+	}
+
 	if(isCollection === 1)
 	{
 		propertyJson = propertyJson + '\n}'
@@ -503,12 +551,10 @@ function _getServiceComplexType(complexTypeKey, complexType) {
 				complexTypeProperty = complexType[i]._attributes;
 				if(complexType[i].Documentation)
 					complexTypeProperty.doc = _parseDocumentationTag(complexType[i].Documentation);
-
 				let namespaceAttributes = namespaceAttributeFilter(complexTypeProperty)	
 				const complexTypePropertyNamespace = namespaceAttributes.length ? namespaceAttributes : -1
 					
-				complexTypeCSN =
-					complexTypeCSN +
+				let complexProperty =
 					_getServiceEntityProperty(
 						complexTypeProperty.Name,
 						complexTypeProperty.Type,
@@ -518,10 +564,10 @@ function _getServiceComplexType(complexTypeKey, complexType) {
 						complexTypeProperty["sap:display-format"],
 						false,
 						complexTypeProperty.doc,
-						-1,
 						complexTypePropertyNamespace
 					);
-				if (i !== complexType.length - 1) {
+				complexTypeCSN = complexTypeCSN + complexProperty;
+				if (i !== complexType.length - 1 && complexProperty != "") {
 					complexTypeCSN = complexTypeCSN + ",\n";
 				} else {
 					complexTypeCSN = complexTypeCSN + "\n";
@@ -547,10 +593,13 @@ function _getServiceComplexType(complexTypeKey, complexType) {
 					complexTypeProperty["sap:display-format"],
 					false,
 					complexTypeProperty.doc,
-					-1,
 					complexTypePropertyNamespace
 				);
 		}
+
+		if (complexTypeCSN && (complexTypeCSN.endsWith(",\n") || complexTypeCSN.endsWith(",\n\n"))) {
+			complexTypeCSN = complexTypeCSN.substring(0, complexTypeCSN.lastIndexOf(",\n")) + "\n";
+		}
 	}
 	complexTypeCSN = complexTypeCSN + "}\n";
 	if (allInheritedComplexTypes[complexTypeKey]) {
@@ -590,41 +639,35 @@ function _parseParameter(parameter)
 {
 	let csn = "";
 	let doc;
-	let isCollection = -1;
 	if(parameter.Documentation)
 		doc = _parseDocumentationTag(parameter.Documentation);
 
 	let namespaceAttributes = namespaceAttributeFilter(parameter._attributes);
 	const parameterNamespaceAttributes = namespaceAttributes.length ? namespaceAttributes : -1;
 
-	let type = parameter["_attributes"].Type;
-	if(type.substring(0,10) === 'Collection')
-	{
-		type = type.substring(11,type.length-1);
-		isCollection = 1;
-	}
 	csn = csn + _getServiceEntityProperty(parameter["_attributes"].Name,
-				type,
+				parameter["_attributes"].Type,
 				parameter["_attributes"].MaxLength,
 				parameter["_attributes"].Precision,
 				parameter["_attributes"].Scale,
 				parameter["_attributes"]["sap:display-format"],
 				false,
 				doc,
-				isCollection,
 				parameterNamespaceAttributes);
 	return csn;
 }
 
 function  _parseParametersFunctionImport(parameters, isBounded) {
 	let csn = "";
+	let parameterCsn = "";
 	let i = isBounded===1 ? 1 : 0;
 	if(parameters.length)
 	{
 		for(i;i<parameters.length;i++)
 		{
-			csn = csn + _parseParameter(parameters[i]);
-			if(i!== parameters.length - 1) {
+			parameterCsn = _parseParameter(parameters[i]);
+			csn = csn + parameterCsn;
+			if(i!== parameters.length - 1 && parameterCsn != "") {
 				csn = csn + ",\n";
 			} else {
 				csn = csn + "\n";
@@ -634,6 +677,9 @@ function  _parseParametersFunctionImport(parameters, isBounded) {
 		csn = csn + _parseParameter(parameters);
 	}
 
+	if (csn && (csn.endsWith(",\n") || csn.endsWith(",\n\n"))) {
+		csn= csn.substring(0, csn.lastIndexOf(",\n")) + "\n";
+	}
 	return csn;
 }
 
@@ -648,31 +694,37 @@ function _getFunctionImport(functionImport,isBounded) {
 	} else if(functionImport[1] === "POST")
 	{
 		csn = csn + "action";
+	} else {
+		let message = functionImport[0].substring(functionImport[0].lastIndexOf(".") + 1) + " has kind " + functionImport[1] + " which is not supported.";
+		console.log(warn(message));
+		return "";
 	}
 	csn = csn + '"';
 	if(functionImport[3] !== -1)
 	{
 		if(isBounded === 0 || (isBounded === 1 && functionImport[3] instanceof Array ))
 		{
-			csn = csn + ", \n";
-			csn = csn + '"params": { \n';
-			csn = csn + _parseParametersFunctionImport(functionImport[3],isBounded);
-			csn = csn + '\n }';
+			let parametersCsn = _parseParametersFunctionImport(functionImport[3],isBounded);
+			if(parametersCsn != "")
+			{
+				csn = csn + ", \n";
+				csn = csn + '"params": { \n';
+				csn = csn + _parseParametersFunctionImport(functionImport[3],isBounded);
+				csn = csn + '\n }';
+			}
 		}
 	}
 	if(functionImport[2] !== -1)
 	{
-		csn = csn + ", \n";
-		csn = csn + '"returns": { \n';
-		let isCollection = -1;
-		if(functionImport[2].substring(0,10) === 'Collection')
+		let returnCsn = _getServiceEntityProperty(noValue,functionImport[2],noValue,noValue,noValue,noValue,noValue,noValue);
+		if(returnCsn != "")
 		{
-			functionImport[2] = functionImport[2].substring(11,functionImport[2].length-1);
-			isCollection = 1;
+			csn = csn + ", \n";
+			csn = csn + '"returns": { \n';
+			//return type
+			csn = csn + returnCsn;
+			csn = csn + '\n }';
 		}
-		//return type
-		csn = csn + _getServiceEntityProperty(noValue,functionImport[2],noValue,noValue,noValue,noValue,noValue,noValue,isCollection);
-		csn = csn + '\n }';
 	}
 	if(functionImport[4] !== -1 && functionImport[4])
 	{
@@ -684,21 +736,25 @@ function _getFunctionImport(functionImport,isBounded) {
 }
 
 function _getAllFunctionImports(functionImports,isBounded) {
-	let functionImportCSN = "";
+	let functionImportsCSN = "";
 	let i;
+	let functionImportCSN = "";
 	for(i=0; i<functionImports.length;i++)
 	{
-		functionImportCSN = 
-			functionImportCSN +
-			_getFunctionImport(functionImports[i],isBounded);
-		if(i!== functionImports.length - 1) {
-			functionImportCSN = functionImportCSN + ",\n";
+		functionImportCSN = _getFunctionImport(functionImports[i],isBounded);
+		functionImportsCSN = functionImportsCSN + functionImportCSN;
+		if(i!== functionImports.length - 1 && functionImportCSN !== "" ) {
+			functionImportsCSN = functionImportsCSN + ",\n";
 		} else {
-			functionImportCSN = functionImportCSN + "\n";
+			functionImportsCSN = functionImportsCSN + "\n";
 		}
 	}
 
-	return functionImportCSN;
+	//if last function import is omitted, remove the extra characters
+	if (functionImportsCSN && (functionImportsCSN.endsWith(",\n") || functionImportsCSN.endsWith(",\n\n"))) {
+		functionImportsCSN= functionImportsCSN.substring(0, functionImportsCSN.lastIndexOf(",\n")) + "\n";
+	}
+	return functionImportsCSN;
 }
 
 function _getEntityName(entity) {
@@ -830,8 +886,7 @@ function _generateCSNEntityKeys(entityKeysList, entityPropertiesMap) {
 	let i;
 	for (i = 0; i < entityKeysList.length; i++) {
 		propAttributes = entityPropertiesMap[entityKeysList[i]];
-		csnEntity =
-			csnEntity +
+		let keyCsn =
 			_getServiceEntityProperty(
 				entityKeysList[i],
 				propAttributes[0],
@@ -841,13 +896,16 @@ function _generateCSNEntityKeys(entityKeysList, entityPropertiesMap) {
 				propAttributes[4],
 				true,
 				propAttributes[5],
-				-1,
 				propAttributes[6]
 			);
-		if (i !== entityKeysList.length - 1) {
+		csnEntity = csnEntity + keyCsn;
+		if (i !== entityKeysList.length - 1 && keyCsn != "") {
 			csnEntity = csnEntity + ",\n";
 		}
 	}
+	if (csnEntity && (csnEntity.endsWith(",\n") || csnEntity.endsWith(",\n\n"))) {
+		csnEntity= csnEntity.substring(0, csnEntity.lastIndexOf(",\n")) + "\n";
+	}
 	return csnEntity;
 }
 
@@ -869,8 +927,7 @@ function _generateCSNEntityProperties(entityKeysList, entityPropertiesMap) {
 		// Include Property which are not part of keys
 		if (entityKeysList.indexOf(property) === -1) {
 			propAttributes = entityPropertiesMap[property];
-			csnEntity =
-				csnEntity +
+			let propertyString =
 				_getServiceEntityProperty(
 					property,
 					propAttributes[0],
@@ -880,10 +937,10 @@ function _generateCSNEntityProperties(entityKeysList, entityPropertiesMap) {
 					propAttributes[4],
 					false,
 					propAttributes[5],
-					-1,
 					propAttributes[6]
 				);
-			if (i !== entityProperties.length - 1) {
+			csnEntity = csnEntity + propertyString;
+			if (i !== entityProperties.length - 1 && propertyString != "") {
 				csnEntity = csnEntity + ",\n";
 			} else {
 				csnEntity = csnEntity + "\n";
@@ -891,7 +948,9 @@ function _generateCSNEntityProperties(entityKeysList, entityPropertiesMap) {
 		}
 	}
 	// Last property can be an key; eliminate additional delimiter.
-	if (csnEntity && csnEntity.endsWith(",\n")) {
+	// Last property can have undefined datatype and be ignored too
+	//doubt
+	if (csnEntity && (csnEntity.endsWith(",\n") || csnEntity.endsWith(",\n\n"))) {
 		csnEntity = csnEntity.substring(0, csnEntity.lastIndexOf(",\n")) + "\n";
 	}
 	return csnEntity;
@@ -1179,12 +1238,11 @@ function _getServiceEntityNavigationProperty(navPropAttributes, mockServerUc) {
 	if(allowedNamespaceAttributes.length) {
 		csn += _generateNamespaceAttributes(allowedNamespaceAttributes, false);
 	}
-	// if documentatin exists for navigation property
-	if (navPropDoc) {
-		csn = csn + '"doc":' + `"Please add  an ON condition\\n${navPropDoc}",\n`;
-	} else {
-		csn = csn + '"doc": "Please add  an ON condition", \n';
-	}
+	// annotation for on conditions
+	csn = csn + `"@cds.ambiguous": "missing on condition?",\n`;
+	// if documentation exists for navigation property
+	if (navPropDoc)
+		csn = csn + '"doc":' + ` "${navPropDoc}",\n`;
 	csn = csn + '"type": "cds.Association",\n';
 	csn = csn +
 		_getCSNAssociatedEntitySet(
@@ -1249,6 +1307,8 @@ function _constructServiceEntity(
 	mockServerUc,
 	documentation
 ) {
+	let filteredNamespaces = {};
+	let namespaces = [];
 	let serviceEntityName = serviceNamespaceParam + "." + entityName;
 	let csnEntity = '"' + serviceEntityName + '": {\n';
 	let csnKeys;
@@ -1265,10 +1325,29 @@ function _constructServiceEntity(
 		csnEntity = csnEntity + '"abstract": true,\n';
 	}
 
-	if(entityAttributes.allowedNamespaceAttributes.length)
-	{
-		csnEntity += _generateNamespaceAttributes(entityAttributes.allowedNamespaceAttributes, false);
+	/* Merging the namespace list from entity set and entity type
+	And in case of same label, entity set's value will have precedence */
+	if(allEntitySetNamespaces[entityName]){
+		allEntitySetNamespaces[entityName].forEach((item) => {
+			filteredNamespaces[Object.keys(item)[0]] = Object.values(item)[0];
+		});
 	}
+	if(entityAttributes.allowedNamespaceAttributes.length){
+		entityAttributes.allowedNamespaceAttributes.forEach((item) => {
+			if(!filteredNamespaces[Object.keys(item)[0]]){
+				filteredNamespaces[Object.keys(item)[0]] = Object.values(item)[0];
+			}
+		});
+	}
+	Object.keys(filteredNamespaces).forEach((item) => {
+		let obj = {};
+		obj[item] = filteredNamespaces[item];
+		namespaces.push(obj)
+	});
+
+	if(namespaces)
+		csnEntity += _generateNamespaceAttributes(namespaces, false);
+	
 	// if documentation exists for the entity
 	if (documentation) {
 		csnEntity = csnEntity + `"doc": "${documentation}",` + '\n';
@@ -1277,13 +1356,18 @@ function _constructServiceEntity(
 
 	// Key Entity attributes
 	csnKeys = _generateCSNEntityKeys(entityKeysList, entityPropertiesMap);
-	csnEntity = csnEntity + csnKeys;
 
 	// Non key Entity attributes
 	csnProperties = _generateCSNEntityProperties(
 		entityKeysList,
 		entityPropertiesMap
 	);
+	csnProperties = csnKeys + csnProperties;
+	//to remove additional ',\n' in case key datatype is undefined
+	if (csnProperties && csnProperties.startsWith(",\n")) {
+		csnProperties = csnProperties.substring(csnProperties.indexOf(",\n") + 2);
+	}
+	
 	csnEntity = csnEntity + csnProperties;
 
 	// No keys and No properties found
@@ -1501,13 +1585,15 @@ function _generateEDMXJSON2CSN(
 
 	if (mockServerUc) {
 		let def  = '"' + serviceNamespaceParam + '": {"kind": "service"' + ',\n' + '"@cds.external": true';
-		
 		let serviceDoc = jsonObj["edmx:Edmx"]["edmx:DataServices"]["Schema"].EntityContainer.Documentation;
+		let namespaceAttributes = namespaceAttributeFilter(jsonObj["edmx:Edmx"]["edmx:DataServices"]["Schema"].EntityContainer["_attributes"]);
 		// if documentation exists for service
 		if (serviceDoc) {
 			let doc = _parseDocumentationTag(serviceDoc);
 			if (doc) def += ',\n' + `"doc": "${doc}"`;
 		}
+		if(namespaceAttributes.length)
+			def += _generateNamespaceAttributes(namespaceAttributes,true);
 		def += "}";
 		definitions.push(def);
 	}