@sap/cds-dk 4.4.2 → 4.5.4

package/lib/import/v2parser.js

@@ -9,12 +9,15 @@ let allEntities = [];
 let allEntitiesMC = [];
 let allEntitySetMap = {};
 let allEntitySetMapMC = {};
+let allFunctionImports = [];
+let allFunctionImportsMap = {};
 let allAssociations = {};
 let allAssociationSets = {};
 let allComplexTypes = {};
 let allComplexTypeDocs = {};
 let allInheritedComplexTypes = {};
 let messages = require("./message").getMessages();
+let common = require("./common");
 let versionInfo = require('../../package.json').version;
 
 let edmxncdsdatatype = {
@@ -48,6 +51,8 @@ function _initialize() {
 	allEntitiesMC.length = 0;
 	allEntitySetMap = {};
 	allEntitySetMapMC = {};
+	allFunctionImports.length = 0;
+	allFunctionImportsMap = {};
 	allAssociations = {};
 	allAssociationSets = {};
 	allComplexTypes = {};
@@ -55,10 +60,6 @@ function _initialize() {
 	allInheritedComplexTypes = {};
 }
 
-function getNamespace() {
-	return serviceNamespace;
-}
-
 function _isValidEDMX(jsonObj) {
 	let isValid = false;
 	let edmx;
@@ -195,7 +196,9 @@ function _extractEntityFromEntitySet(entitySet) {
 	Object.keys(entitySet).forEach((key) => {
 		if (key === "_attributes") {
 			allEntitySetMap[entitySet[key].Name] = entitySet[key].EntityType;
-			allEntitySetMapMC[entitySet[key].EntityType] = entitySet[key].Name;
+			if (allEntitySetMapMC[entitySet[key].EntityType] === undefined)
+				allEntitySetMapMC[entitySet[key].EntityType] = [];
+			allEntitySetMapMC[entitySet[key].EntityType].push(entitySet[key].Name);
 			entityName = _extractEntityFromNamespace(entitySet[key].EntityType);
 			allEntities.push(entityName);
 			allEntitiesMC.push(entitySet[key].Name);
@@ -216,15 +219,101 @@ function _extractAllEntityFromEntitySets(entitySets) {
 	}
 }
 
+function _extractNameFromFunctionImport(entityName) {
+	let entityId = "";
+	let pos = entityName.lastIndexOf("_");
+	if (pos < 0) {
+		return entityName;
+	}
+	entityId = entityName.substring(pos + 1);
+	return entityId;
+}
+
+function _getFunctionAttributes(functionImport, serviceNamespaceParam)
+{
+	let funcAttributes = [];
+	if(functionImport["_attributes"])
+	{
+		funcAttributes.push(serviceNamespaceParam + _extractNameFromFunctionImport(functionImport["_attributes"].Name));
+		funcAttributes.push(functionImport["_attributes"]["m:HttpMethod"]);
+		if(functionImport["_attributes"].ReturnType)
+		{
+			funcAttributes.push(functionImport["_attributes"].ReturnType);
+		} else {
+			funcAttributes.push(-1);
+		}
+	}
+
+	if(functionImport["Parameter"])
+	{
+		funcAttributes.push(functionImport["Parameter"]);
+	} else {
+		funcAttributes.push(-1);
+	}
+
+	if(functionImport["Documentation"])
+	{
+		funcAttributes.push(_parseDocumentationTag(functionImport["Documentation"]));
+	} else {
+		funcAttributes.push(-1);
+	}
+
+	return funcAttributes;
+}
+
+function _extractFunctionImport(functionImport, serviceNamespaceParam)
+{
+	//extracting the bounded and unbounded function import
+	let boundedFunctionImports = [];
+	let entityName;
+	Object.keys(functionImport).forEach((key) => {
+		if(key === "_attributes") {
+			if(functionImport[key]["sap:action-for"])
+			{
+				//storing bounded function imports 
+				entityName = _extractEntityFromNamespace(functionImport[key]["sap:action-for"]);
+				boundedFunctionImports = (allFunctionImportsMap[entityName]) ? allFunctionImportsMap[entityName] : [];
+				boundedFunctionImports.push(_getFunctionAttributes(functionImport,""));
+				allFunctionImportsMap[entityName] = boundedFunctionImports;
+			}
+			else
+			{
+				//storing unbounded function imports
+				allFunctionImports.push(_getFunctionAttributes(functionImport,serviceNamespaceParam + "."));
+			}
+		}
+	});
+}
+
+//extracting the function imports from the metadata
+function _extractAllFunctionImports(functionImports, serviceNamespaceParam)
+{
+	let i;
+	if (functionImports.length) {
+		//Has many function imports in metadata
+		for (i = 0; i < functionImports.length; i++) {
+			_extractFunctionImport(functionImports[i], serviceNamespaceParam);
+		}
+	} else {
+		//Has only one function import in metadata
+		_extractFunctionImport(functionImports, serviceNamespaceParam);
+	}
+}
+
+function _removeCarriageReturn(text) {
+    return text.replace(/(?:\\[rn]|[\r\n]+)+/gm, "\\n").replace(/\s+/g, ' ').trim();
+}
+
 // to parse the documentation tag
-function _parseDocumentationTag(documentedContent){
+function _parseDocumentationTag(documentedContent) {
 	let documentation = "";
-	if(documentedContent.Summary && documentedContent.Summary._text)
-		documentation = documentedContent.Summary._text;
-	if(documentedContent.LongDescription && documentedContent.LongDescription._text) {
-		if(documentedContent.Summary)
+	if (documentedContent.Summary && documentedContent.Summary._text) {
+		documentation = _removeCarriageReturn(documentedContent.Summary._text);
+	}	
+	if (documentedContent.LongDescription && documentedContent.LongDescription._text) {
+		if (documentedContent.Summary)
 			documentation += "\\n\\n";
-		documentation += documentedContent.LongDescription._text;
+		documentation += _removeCarriageReturn(documentedContent.LongDescription._text);
 	}
 	return documentation;
 }
@@ -271,11 +360,12 @@ function _getServiceEntityProperty(
 	scale,
 	displayFormat,
 	isKey,
-	documentation
+	documentation,
+	isCollection
 ) {
 	let cdsDataType = null;
 	let hasInvalidPrecision = false;
-	let propertyJson;
+	let propertyJson='';
 	if (length && length > 0) {
 		cdsDataType = edmxncdsdatatype[dataType + "_m"];
 	} else if (precision && precision > 0) {
@@ -301,11 +391,23 @@ function _getServiceEntityProperty(
 		cdsDataType = dataType;
 	}
 
-	propertyJson = '"' + propertyName + '": {\n';
+	//Possibility of entity type or entity set as the data type
+	if (!cdsDataType && allEntitySetMapMC[dataType]) {
+		cdsDataType = serviceNamespace + "." + allEntitySetMapMC[dataType];
+	} else if(!cdsDataType && allEntitySetMap[_extractEntityFromNamespace(dataType)]) {
+		cdsDataType = dataType;
+	}
+
+	if(propertyName)
+		propertyJson = '"' + propertyName + '": {\n';
 
 	if (isKey) {
 		propertyJson = propertyJson + '"key": true,\n';
 	}
+	if(isCollection === 1)
+	{
+		propertyJson = propertyJson + '"items": { \n'
+	}
 	propertyJson = propertyJson + '"type":"' + cdsDataType + '"';
 	if (length && length > 0) {
 		propertyJson = propertyJson + ',\n"length":' + length;
@@ -317,10 +419,16 @@ function _getServiceEntityProperty(
 			propertyJson = propertyJson + ',\n"scale":' + 0;
 		}
 	}
+	if(isCollection === 1)
+	{
+		propertyJson = propertyJson + '\n}'
+	}
 	if(documentation != -1 && documentation != undefined){
 		propertyJson = propertyJson + ',\n"doc":"' + documentation + '"';
 	}
-	propertyJson = propertyJson + "\n}";
+
+	if(propertyName)
+		propertyJson = propertyJson + "\n}";
 	return propertyJson;
 }
 
@@ -349,7 +457,8 @@ function _getServiceComplexType(complexTypeKey, complexType) {
 						complexTypeProperty.Scale,
 						complexTypeProperty["sap:display-format"],
 						false,
-						complexTypeProperty.doc
+						complexTypeProperty.doc,
+						-1
 					);
 				if (i !== complexType.length - 1) {
 					complexTypeCSN = complexTypeCSN + ",\n";
@@ -372,7 +481,8 @@ function _getServiceComplexType(complexTypeKey, complexType) {
 					complexTypeProperty.Scale,
 					complexTypeProperty["sap:display-format"],
 					false,
-					complexTypeProperty.doc
+					complexTypeProperty.doc,
+					-1
 				);
 		}
 	}
@@ -410,6 +520,116 @@ function _getServiceComplexTypes() {
 	return complexTypeCSN;
 }
 
+function _parseParameter(parameter)
+{
+	let csn = "";
+	let doc;
+	let isCollection = -1;
+	if(parameter.Documentation)
+		doc = _parseDocumentationTag(parameter.Documentation);
+	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"].MaxLength,
+				parameter["_attributes"].Precision,
+				parameter["_attributes"].Scale,
+				parameter["_attributes"]["sap:display-format"],
+				false,
+				doc,
+				isCollection);
+	return csn;
+}
+
+function  _parseParametersFunctionImport(parameters, isBounded) {
+	let csn = "";
+	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) {
+				csn = csn + ",\n";
+			} else {
+				csn = csn + "\n";
+			}
+		}
+	} else {
+		csn = csn + _parseParameter(parameters);
+	}
+
+	return csn;
+}
+
+function _getFunctionImport(functionImport,isBounded) {
+	let noValue;
+	let csn = "";
+	csn = csn + '"' + functionImport[0] + '": { \n';
+	csn = csn + '"kind": "';
+	if(functionImport[1] === "GET")
+	{
+		csn = csn + "function";
+	} else if(functionImport[1] === "POST")
+	{
+		csn = csn + "action";
+	}
+	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 }';
+		}
+	}
+	if(functionImport[2] !== -1)
+	{
+		csn = csn + ", \n";
+		csn = csn + '"returns": { \n';
+		let isCollection = -1;
+		if(functionImport[2].substring(0,10) === 'Collection')
+		{
+			functionImport[2] = functionImport[2].substring(11,functionImport[2].length-1);
+			isCollection = 1;
+		}
+		//return type
+		csn = csn + _getServiceEntityProperty(noValue,functionImport[2],noValue,noValue,noValue,noValue,noValue,noValue,isCollection);
+		csn = csn + '\n }';
+	}
+	if(functionImport[4] !== -1)
+	{
+		csn = csn + ',\n "doc": "' + functionImport[4] + '"'; 
+	}
+
+	csn = csn + "\n }";
+	return csn;
+}
+
+function _getAllFunctionImports(functionImports,isBounded) {
+	let functionImportCSN = "";
+	let i;
+	for(i=0; i<functionImports.length;i++)
+	{
+		functionImportCSN = 
+			functionImportCSN +
+			_getFunctionImport(functionImports[i],isBounded);
+		if(i!== functionImports.length - 1) {
+			functionImportCSN = functionImportCSN + ",\n";
+		} else {
+			functionImportCSN = functionImportCSN + "\n";
+		}
+	}
+
+	return functionImportCSN;
+}
+
 function _getEntityName(entity) {
 	return entity._attributes.Name;
 }
@@ -537,7 +757,8 @@ function _generateCSNEntityKeys(entityKeysList, entityPropertiesMap) {
 				propAttributes[3],
 				propAttributes[4],
 				true,
-				propAttributes[5]
+				propAttributes[5],
+				-1
 			);
 		if (i !== entityKeysList.length - 1) {
 			csnEntity = csnEntity + ",\n";
@@ -574,7 +795,8 @@ function _generateCSNEntityProperties(entityKeysList, entityPropertiesMap) {
 					propAttributes[3],
 					propAttributes[4],
 					false,
-					propAttributes[5]
+					propAttributes[5],
+					-1
 				);
 			if (i !== entityProperties.length - 1) {
 				csnEntity = csnEntity + ",\n";
@@ -869,17 +1091,24 @@ function _getServiceEntityNavigationProperty(navPropAttributes, mockServerUc) {
 
 	csn = csn + '"' + navPropName + '": {\n';
 	// if documentatin exists for navigation property
-	if(navPropDoc)
-		csn = csn + `"doc": "${navPropDoc}",` + "\n";
+	if (navPropDoc) {
+		csn = csn + '"doc":' + `"Please add  an ON condition\\n${navPropDoc}",\n`;
+	} else {
+		csn = csn + '"doc": "Please add  an ON condition", \n';
+	}
 	csn = csn + '"type": "cds.Association",\n';
-	csn =
-		csn +
+	csn = csn +
 		_getCSNAssociatedEntitySet(
 			relationshipName,
 			toRole,
 			navPropName,
 			mockServerUc
 		);
+	// Convert managed associations and compositions in unmanaged with empty key to avoid
+    // "generation" of keys, that do not exist in the external service.
+	if (common.checkForEmptyKeys(csn, "V2")) {
+		csn = csn + ',\n"keys": []\n';
+	}
 	csn = csn + "}";
 
 	return csn;
@@ -927,7 +1156,6 @@ function _constructServiceEntity(
 	entityPropertiesMap,
 	entityNavigationPropertiesMap,
 	entityAttributes,
-	ignorePersistenceSkip,
 	mockServerUc,
 	documentation
 ) {
@@ -937,9 +1165,6 @@ function _constructServiceEntity(
 	let csnProperties;
 	let hasProperties;
 	csnEntity = csnEntity + '"kind": "entity",\n';
-	if (ignorePersistenceSkip === false) {
-		csnEntity = csnEntity + '"@cds.persistence.skip": true,\n';
-	}
 	if (
 		entityAttributes.Abstract &&
 		entityAttributes.Abstract.toUpperCase() === "TRUE"
@@ -983,6 +1208,21 @@ function _constructServiceEntity(
 		csnEntity =
 			csnEntity + '"includes": ["' + entityAttributes.BaseType + '"]\n';
 	}
+
+	//if the function import is bounded to entitySet 
+	if (allFunctionImportsMap[entityName])
+	{
+		csnEntity = csnEntity + ', \n "actions": {\n';
+		csnEntity = csnEntity + _getAllFunctionImports(allFunctionImportsMap[entityName],1);
+		csnEntity = csnEntity + "}";
+	}
+	else if (allFunctionImportsMap[_extractEntityFromNamespace(allEntitySetMap[entityName])]) //if the function import is bounded to entityType
+	{
+		csnEntity = csnEntity + ', \n "actions": {\n';
+		csnEntity = csnEntity + _getAllFunctionImports(allFunctionImportsMap[_extractEntityFromNamespace(allEntitySetMap[entityName])],1);
+		csnEntity = csnEntity + "}";
+	}
+
 	return csnEntity;
 }
 
@@ -990,7 +1230,6 @@ function _parseServiceEntity(
 	serviceNamespaceParam,
 	entityName,
 	entity,
-	ignorePersistenceSkip,
 	mockServerUc
 ) {
 	let entityAttributes;
@@ -1039,7 +1278,6 @@ function _parseServiceEntity(
 		entityPropertiesMap,
 		entityNavigationPropertiesMap,
 		entityAttributes,
-		ignorePersistenceSkip,
 		mockServerUc,
 		documentation
 	);
@@ -1055,24 +1293,31 @@ function _getEntitesWithNamesFromEntitySets(
 			allEntitySetMapMC[
 			serviceNamespaceParam + "." + _getEntityName(entity)
 			]
-		: (entity) => _getEntityName(entity);
+		: (entity) => [_getEntityName(entity)];
 
 	const isNameInEntitySet = mockServerUc
 		? (name) => allEntitiesMC.indexOf(name) >= 0
 		: (name) => allEntities.indexOf(name) >= 0;
 
+	const getEntitySetNames = entityWithName => {
+		for (let i = 0; i < entityWithName.name.length; i++) {
+			if (!isNameInEntitySet(entityWithName.name[i]))
+				return false;
+		}
+		return true;
+	};
+
 	return entityJson
 		.map((entity) => ({
 			entity,
 			name: getEntityName(entity),
 		}))
-		.filter((entityWithName) => isNameInEntitySet(entityWithName.name));
+		.filter((entityWithName) => getEntitySetNames(entityWithName));
 }
 
 function _getServiceEntitites(
 	serviceNamespaceParam,
 	entityJson = [],
-	ignorePersistenceSkip,
 	mockServerUc
 ) {
 	const entities = Array.isArray(entityJson) ? entityJson : [entityJson];
@@ -1084,17 +1329,17 @@ function _getServiceEntitites(
 
 	if (entitiesWithNames.length) {
 		return (
-			entitiesWithNames
-				.map((entityWithName) =>
+			entitiesWithNames.map((entityWithName) => 
+				entityWithName.name.map((entityName) =>
 					_parseServiceEntity(
 						serviceNamespaceParam,
-						entityWithName.name,
+						entityName,
 						entityWithName.entity,
-						ignorePersistenceSkip,
 						mockServerUc
 					)
 				)
 				.join("},") + "}"
+			)
 		);
 	}
 	return "";
@@ -1103,7 +1348,6 @@ function _getServiceEntitites(
 function _generateEDMXJSON2CSN(
 	jsonObj,
 	serviceNamespaceParam,
-	ignorePersistenceSkip,
 	mockServerUc
 ) {
 	const csn = {};
@@ -1132,6 +1376,13 @@ function _generateEDMXJSON2CSN(
 	if (entitySets) {
 		_extractAllEntityFromEntitySets(entitySets);
 	}
+	// Extract function imports
+	const functionImports = 
+		jsonObj["edmx:Edmx"]["edmx:DataServices"].Schema.EntityContainer
+			.FunctionImport;
+	if(functionImports) {
+		_extractAllFunctionImports(functionImports, serviceNamespaceParam);
+	}
 	// Extract complex types
 	const complexTypes =
 		jsonObj["edmx:Edmx"]["edmx:DataServices"].Schema.ComplexType;
@@ -1145,11 +1396,12 @@ function _generateEDMXJSON2CSN(
 	const definitions = [];
 
 	if (mockServerUc) {
-		let def = '"' + serviceNamespaceParam + '": {"kind": "service"';
-		let schemaDoc = jsonObj["edmx:Edmx"]["edmx:DataServices"].Schema.Documentation;
-		// if documentation exists for schema
-		if(schemaDoc)
-			def += ',\n' + `"doc": "${_parseDocumentationTag(schemaDoc)}"`;
+		let def  = '"' + serviceNamespaceParam + '": {"kind": "service"' + ',\n' + '"@cds.external": true';
+		
+		let serviceDoc = jsonObj["edmx:Edmx"]["edmx:DataServices"]["Schema"].EntityContainer.Documentation;
+		// if documentation exists for service
+		if(serviceDoc)
+			def += ',\n' + `"doc": "${_parseDocumentationTag(serviceDoc)}"`;
 		def += "}";
 		definitions.push(def);
 	}
@@ -1159,12 +1411,17 @@ function _generateEDMXJSON2CSN(
 		definitions.push(_getServiceComplexTypes());
 	}
 
+	//if there are unbounded function imports
+	if(Object.keys(allFunctionImports).length > 0)
+	{
+		definitions.push(_getAllFunctionImports(allFunctionImports,0)); //passing 0 for unbounded actions/functions
+	}
+
 	if (entityJson) {
 		definitions.push(
 			_getServiceEntitites(
 				serviceNamespaceParam,
 				entityJson,
-				ignorePersistenceSkip,
 				mockServerUc
 			)
 		);
@@ -1180,7 +1437,6 @@ function _generateEDMXJSON2CSN(
 
 function getEdmxv2CSN(
 	edmx2jsonModel,
-	ignorePersistenceSkip,
 	mockServerUc
 ) {
 	let csnDataModel;
@@ -1192,7 +1448,6 @@ function getEdmxv2CSN(
 		csnDataModel = _generateEDMXJSON2CSN(
 			edmx2jsonModel,
 			serviceNamespace,
-			ignorePersistenceSkip,
 			mockServerUc
 		);
 	}
@@ -1200,6 +1455,5 @@ function getEdmxv2CSN(
 }
 
 module.exports = {
-	getEdmxv2CSN,
-	getNamespace,
+	getEdmxv2CSN
 };