@sapui5/sap.fe.core 1.97.0 → 1.100.0

package/src/sap/fe/core/services/SideEffectsServiceFactory.ts

@@ -1,15 +1,19 @@
-import { ServiceFactory, Service, ServiceContext } from "sap/ui/core/service";
-import { ConverterOutput, EntityType, NavigationProperty, Property } from "@sap-ux/annotation-converter";
-import { Context, ODataMetaModel } from "sap/ui/model/odata/v4";
+import ServiceFactory from "sap/ui/core/service/ServiceFactory";
+import Service from "sap/ui/core/service/Service";
+import { ServiceContext } from "sap/ui/core/service";
+import { ComplexType, ConverterOutput, EntityType, NavigationProperty, Property } from "@sap-ux/annotation-converter";
+import Context from "sap/ui/model/odata/v4/Context";
+import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
 import { convertTypes, EnvironmentCapabilities } from "sap/fe/core/converters/MetaModelConverter";
 import { CommonAnnotationTypes, QualifiedName } from "@sap-ux/vocabularies-types/dist/generated/Common";
 import { Action, NavigationPropertyPath, PropertyPath } from "@sap-ux/vocabularies-types";
-import { Log } from "sap/base";
+import Log from "sap/base/Log";
 
 type SideEffectsSettings = {};
 
 type SideEffectsTargetEntityType = {
 	$NavigationPropertyPath: string;
+	$PropertyPath?: string;
 };
 type SideEffectsTarget = SideEffectsTargetEntityType | string;
 
@@ -28,7 +32,7 @@ type BaseSideEffectsType = {
 	fullyQualifiedName: string;
 } & SideEffectsTargetType;
 
-type ActionSideEffectsType = {
+export type ActionSideEffectsType = {
 	pathExpressions: SideEffectsTarget[];
 	triggerActions?: QualifiedName[];
 };
@@ -70,11 +74,11 @@ type ExtractorPropertyInfo = {
 	navigationPath?: string;
 };
 
-class SideEffectsService extends Service<SideEffectsSettings> {
+export class SideEffectsService extends Service<SideEffectsSettings> {
 	initPromise!: Promise<any>;
 	_oSideEffectsType!: SideEffectsOriginRegistry;
 	_oCapabilities!: EnvironmentCapabilities | undefined;
-	_bInitialized!: Boolean;
+	_bInitialized!: boolean;
 	// !: means that we know it will be assigned before usage
 	init() {
 		this._oSideEffectsType = {
@@ -122,10 +126,11 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 	 * @param {string} sTriggerAction Name of the action
 	 * @param {object} oContext Context
 	 * @param {string} sGroupId The group ID to be used for the request
+	 * @returns {Promise} A promise that is resolved without data or with a return value context when the action call succeeded
 	 */
-	public executeAction(sTriggerAction: String, oContext: Context, sGroupId?: string) {
+	public executeAction(sTriggerAction: string, oContext: Context, sGroupId?: string): Promise<any> {
 		const oTriggerAction: any = oContext.getModel().bindContext(sTriggerAction + "(...)", oContext);
-		oTriggerAction.execute(sGroupId || (oContext as any).getBinding().getUpdateGroupId());
+		return oTriggerAction.execute(sGroupId || (oContext as any).getBinding().getUpdateGroupId());
 	}
 
 	/**
@@ -247,6 +252,24 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 		return oPromise;
 	}
 
+	public requestSideEffectsForODataAction(sideEffects: ActionSideEffectsType, oContext: Context): Promise<any> {
+		let aPromises: Promise<any>[];
+
+		if (sideEffects.triggerActions?.length) {
+			aPromises = sideEffects.triggerActions.map((sTriggerActionName: String) => {
+				return this.executeAction(sTriggerActionName as string, oContext);
+			});
+		} else {
+			aPromises = [];
+		}
+
+		if (sideEffects.pathExpressions?.length) {
+			aPromises.push(this.requestSideEffects(sideEffects.pathExpressions, oContext));
+		}
+
+		return aPromises.length ? Promise.all(aPromises) : Promise.resolve();
+	}
+
 	/**
 	 * Request SideEffects for a navigation property on a specific context.
 	 *
@@ -259,6 +282,7 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 	public requestSideEffectsForNavigationProperty(sNavigationProperty: string, oContext: Context): Promise<any> {
 		const sBaseEntityType = this.getEntityTypeFromContext(oContext);
 		if (sBaseEntityType) {
+			const sNavigationPath = sNavigationProperty + "/";
 			const aSideEffects = this.getODataEntitySideEffects(sBaseEntityType);
 			let aTargets: SideEffectsTarget[] = [];
 			Object.keys(aSideEffects)
@@ -267,9 +291,13 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 					sAnnotationName => {
 						const oSideEffects: ODataSideEffectsType = aSideEffects[sAnnotationName];
 						return (
-							(oSideEffects.SourceProperties || []).some(
-								oPropertyPath => oPropertyPath.value.indexOf(sNavigationProperty) > -1
-							) ||
+							(oSideEffects.SourceProperties || []).some(oPropertyPath => {
+								const sPropertyPath = oPropertyPath.value;
+								return (
+									sPropertyPath.startsWith(sNavigationPath) &&
+									sPropertyPath.replace(sNavigationPath, "").indexOf("/") === -1
+								);
+							}) ||
 							(oSideEffects.SourceEntities || []).some(
 								oNavigationPropertyPath => oNavigationPropertyPath.value === sNavigationProperty
 							)
@@ -279,7 +307,7 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 				.forEach(sAnnotationName => {
 					const oSideEffects: ODataSideEffectsType = aSideEffects[sAnnotationName];
 					if (oSideEffects.TriggerAction) {
-						this.executeAction(oSideEffects.TriggerAction, oContext);
+						this.executeAction(oSideEffects.TriggerAction as string, oContext);
 					}
 					((oSideEffects.TargetEntities as any[]) || [])
 						.concat((oSideEffects.TargetProperties as any[]) || [])
@@ -310,7 +338,7 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 
 	/**
 	 * Adds the text properties required for SideEffects
-	 * If a property has an associated text then this text needs to be added as targetProperties.
+	 * If a property has an associated text then this text needs to be added as targetProperties or targetEntities.
 	 *
 	 * @private
 	 * @ui5-restricted
@@ -319,7 +347,7 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 	 * @returns {object} SideEffects definition with added text properties
 	 */
 	private _addRequiredTextProperties(oSideEffect: BaseSideEffectsType, mEntityType: EntityType): BaseSideEffectsType {
-		const aInitialProperties: string[] = (oSideEffect.TargetProperties || []) as string[],
+		const aInitialProperties: string[] = oSideEffect.TargetProperties || [],
 			aEntitiesRequested: string[] = (oSideEffect.TargetEntities || []).map(navigation => navigation.$NavigationPropertyPath);
 		let aDerivedProperties: ExtractorPropertyInfo[] = [];
 
@@ -333,22 +361,20 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 				// mTarget can be an entity type, navigationProperty or or a complexType
 				const aTargetEntityProperties: Property[] =
 					(mTarget as EntityType).entityProperties ||
-					(mTarget as Property).targetType?.properties ||
+					((mTarget as Property).targetType as ComplexType)?.properties ||
 					(mTarget as NavigationProperty).targetType.entityProperties;
 				if (aTargetEntityProperties) {
 					if (bIsStarProperty) {
-						if (aTargetEntityProperties) {
-							// Add all required properties behind the *
-							aEntitiesRequested.push(sNavigationPropertyPath);
-							aDerivedProperties = aDerivedProperties.concat(
-								aTargetEntityProperties.map(mProperty => {
-									return {
-										navigationPath: sRelativePath,
-										property: mProperty
-									};
-								})
-							);
-						}
+						// Add all required properties behind the *
+						aEntitiesRequested.push(sNavigationPropertyPath);
+						aDerivedProperties = aDerivedProperties.concat(
+							aTargetEntityProperties.map(mProperty => {
+								return {
+									navigationPath: sRelativePath,
+									property: mProperty
+								};
+							})
+						);
 					} else {
 						aDerivedProperties.push({
 							property: aTargetEntityProperties.find(
@@ -368,7 +394,8 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 		aDerivedProperties.forEach(mPropertyInfo => {
 			if (mPropertyInfo.property) {
 				const sTargetTextPath = (mPropertyInfo.property.annotations?.Common?.Text as any)?.path,
-					sTextPathFromInitialEntity = mPropertyInfo.navigationPath + sTargetTextPath;
+					sTextPathFromInitialEntity = mPropertyInfo.navigationPath + sTargetTextPath,
+					sTargetCollectionPath = sTextPathFromInitialEntity.substring(0, sTextPathFromInitialEntity.lastIndexOf("/"));
 				/**
 				 * The property Text must be added only if the property is
 				 * - not part of a star property (.i.e '*' or 'navigation/*') or a targeted Entity
@@ -378,11 +405,20 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 
 				if (
 					sTargetTextPath &&
-					aEntitiesRequested.indexOf(sTextPathFromInitialEntity.substring(0, sTextPathFromInitialEntity.lastIndexOf("/"))) ===
-						-1 &&
+					aEntitiesRequested.indexOf(sTargetCollectionPath) === -1 &&
 					aInitialProperties.indexOf(sTextPathFromInitialEntity) === -1
 				) {
-					oSideEffect.TargetProperties.push(sTextPathFromInitialEntity);
+					// The Text association is added as TargetEntities if it's contained on a different entitySet and not a complexType
+					// Otherwise it's added as targetProperties
+					if (
+						sTargetTextPath.lastIndexOf("/") > -1 &&
+						mEntityType.resolvePath(sTargetCollectionPath)?._type === "NavigationProperty"
+					) {
+						oSideEffect.TargetEntities.push({ $NavigationPropertyPath: sTargetCollectionPath });
+						aEntitiesRequested.push(sTargetCollectionPath);
+					} else {
+						oSideEffect.TargetProperties.push(sTextPathFromInitialEntity);
+					}
 				}
 			}
 		});
@@ -399,22 +435,17 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 	 * @private
 	 * @ui5-restricted
 	 * @param {object} oSideEffects SideEffects definition
-	 * @param {string} sEntityType Name of the entity type
+	 * @param {object} mEntityType Entity type
 	 * @param {string} sBindingParameter Name of the binding parameter
 	 * @returns {object} SideEffects definition
 	 */
 	private _convertSideEffects(
 		oSideEffects: BaseSideEffectsType | BaseAnnotationSideEffectsType,
-		sEntityType: string | undefined,
+		mEntityType: EntityType,
 		sBindingParameter?: string
 	): ODataSideEffectsType {
-		const mEntityType = (this.getConvertedMetaModel() as ConverterOutput).entityTypes.find(oEntityType => {
-			return oEntityType.fullyQualifiedName === sEntityType;
-		});
 		const oTempSideEffects = this._removeBindingParameter(this._convertTargetsFormat(oSideEffects), sBindingParameter);
-		return mEntityType
-			? this._replaceReferencedProperties(this._addRequiredTextProperties(oTempSideEffects, mEntityType), mEntityType)
-			: oTempSideEffects;
+		return this._addRequiredTextProperties(oTempSideEffects, mEntityType);
 	}
 
 	/**
@@ -466,15 +497,13 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 			if (mEntityType) {
 				const mCommonAnnotation: any = oSource.annotations?.Common || {};
 				const mBindingParameter = ((oSource as Action).parameters || []).find(
-					mParameter => mParameter.type === (mEntityType || oSource).fullyQualifiedName
+					mParameter => mParameter.type === mEntityType.fullyQualifiedName
 				);
 				const sBindingParameter = mBindingParameter ? mBindingParameter.fullyQualifiedName.split("/")[1] : "";
 				Object.keys(mCommonAnnotation)
 					.filter(sAnnotationName => mCommonAnnotation[sAnnotationName].$Type === CommonAnnotationTypes.SideEffectsType)
 					.forEach(sAnnotationName => {
-						aSideEffects.push(
-							this._convertSideEffects(mCommonAnnotation[sAnnotationName], mEntityType.fullyQualifiedName, sBindingParameter)
-						);
+						aSideEffects.push(this._convertSideEffects(mCommonAnnotation[sAnnotationName], mEntityType, sBindingParameter));
 					});
 			}
 		}
@@ -514,7 +543,7 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 					mTarget = mTarget.map((mProperty: any) => {
 						const bNavigationPropertyPath = mProperty.$NavigationPropertyPath !== undefined; // Need to test with undefined since  mProperty.$NavigationPropertyPath could be "" (empty string)
 						const sValue = (bNavigationPropertyPath ? mProperty.$NavigationPropertyPath : mProperty).replace(
-							new RegExp("^" + sBindingParameterName + "?."),
+							new RegExp("^" + sBindingParameterName + "/?"),
 							""
 						);
 						return bNavigationPropertyPath ? { $NavigationPropertyPath: sValue } : sValue;
@@ -546,59 +575,6 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 		);
 	}
 
-	/**
-	 * Replaces TargetProperties having reference to Source Properties for a SideEffects
-	 * If a SideEffects Source Property is an navigation entity reference, the SideEffects Target Properties cannot be a property of this navigation entity.
-	 * Indeed this configuration leads to error into the OData V4 Model since response cannot be processed because this would mean that we merge properties of the new target into the old target of the navigation property.
-	 * In order to request new value of these target properties the SideEffects will request for the entire Entity instead of just a set of properties.
-	 * For the first version, we remove all navigation properties and replace them by targetEntities. This change could be improved in next version.
-	 *
-	 * @private
-	 * @ui5-restricted
-	 * @param {object} oSideEffect SideEffects definition
-	 * @param {object} mEntityType  Entity type
-	 * @returns {object} SideEffects definition without referenced target properties
-	 */
-	private _replaceReferencedProperties(oSideEffect: BaseSideEffectsType, mEntityType: EntityType): BaseSideEffectsType {
-		let bSideEffectsChanged: boolean = false;
-		const aEntities: string[] =
-				(oSideEffect.TargetEntities || []).map(mNavigation => {
-					return mNavigation.$NavigationPropertyPath;
-				}) || [],
-			aProperties: string[] = [];
-
-		oSideEffect.TargetProperties.forEach(sPropertyPath => {
-			let bTargetChanged = false;
-			const iLastPathSeparatorIndex = sPropertyPath.lastIndexOf("/");
-			if (iLastPathSeparatorIndex !== -1) {
-				const sNavigationPath = sPropertyPath.substring(0, iLastPathSeparatorIndex);
-				const oTarget = mEntityType.resolvePath(sNavigationPath);
-				if (oTarget && oTarget._type === "NavigationProperty") {
-					//Test if it's not a property bound on complexType (_ComplexType/MyProperty)
-					bSideEffectsChanged = true;
-					bTargetChanged = true;
-					if (!aEntities.includes(sNavigationPath)) {
-						aEntities.push(sNavigationPath);
-					}
-				}
-			}
-			if (!bTargetChanged) {
-				aProperties.push(sPropertyPath);
-			}
-		});
-
-		if (bSideEffectsChanged) {
-			oSideEffect.TargetProperties = aProperties;
-			oSideEffect.TargetEntities = aEntities.map(sNavigationPath => {
-				return {
-					$NavigationPropertyPath: sNavigationPath
-				};
-			});
-		}
-
-		return oSideEffect;
-	}
-
 	/**
 	 * Gets SideEffects action type that come from an OData Service
 	 * Internal routine to get, from converted oData metaModel, SideEffects on actions
@@ -616,15 +592,15 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 		if (aActions) {
 			Object.keys(aActions).forEach(sActionName => {
 				const oAction = mEntityType.actions[sActionName];
-				const triggerActions: String[] = [];
+				const triggerActions: string[] = [];
 				let pathExpressions: SideEffectsTarget[] = [];
 				let aTargets: SideEffectsTarget[] = [];
 
 				this._getSideEffectsFromSource(oAction).forEach(oSideEffect => {
 					const sTriggerAction = oSideEffect.TriggerAction;
 					aTargets = aTargets.concat(oSideEffect.TargetEntities || []).concat((oSideEffect.TargetProperties as any[]) || []);
-					if (sTriggerAction && triggerActions.indexOf(sTriggerAction) === -1) {
-						triggerActions.push(sTriggerAction);
+					if (sTriggerAction && triggerActions.indexOf(sTriggerAction as string) === -1) {
+						triggerActions.push(sTriggerAction as string);
 					}
 				});
 				pathExpressions = this._removeDuplicateTargets(aTargets);
@@ -659,7 +635,7 @@ class SideEffectsService extends Service<SideEffectsSettings> {
 }
 
 class SideEffectsServiceFactory extends ServiceFactory<SideEffectsSettings> {
-	createInstance(oServiceContext: ServiceContext<SideEffectsSettings>) {
+	createInstance(oServiceContext: ServiceContext<SideEffectsSettings>): Promise<any> {
 		const SideEffectsServiceService = new SideEffectsService(oServiceContext);
 		return SideEffectsServiceService.initPromise;
 	}