@sapui5/sap.fe.core 1.103.0 → 1.106.0

package/src/sap/fe/core/controllerextensions/SideEffects.ts

@@ -28,16 +28,23 @@ type FieldEventPropertyType = {
 	sideEffectsMap: FieldSideEffectDictionary;
 };
 
-type FieldSideEffectPropertyType = {
+type BaseSideEffectPropertyType = {
 	name: string;
 	immediate?: boolean;
-	context: Context;
 	sideEffects: SideEffectsType;
 	previouslyFailed?: boolean;
 };
 
+export type MassEditFieldSideEffectPropertyType = BaseSideEffectPropertyType;
+
+export type FieldSideEffectPropertyType = BaseSideEffectPropertyType & {
+	context: Context;
+};
+
 type FieldSideEffectDictionary = Record<string, FieldSideEffectPropertyType>;
 
+type MassEditFieldSideEffectDictionary = Record<string, MassEditFieldSideEffectPropertyType>;
+
 type FailedSideEffectDictionary = Record<string, SideEffectsType[]>;
 
 type FieldGroupSideEffectType = {
@@ -96,6 +103,12 @@ class SideEffectsControllerExtension extends ControllerExtension {
 		return this._mFailedSideEffects;
 	}
 
+	@publicExtension()
+	@finalExtension()
+	public deleteFailedRequestsForAContext(contextPath: string) {
+		delete this._mFailedSideEffects[contextPath];
+	}
+
 	/**
 	 * Manages the workflow for SideEffects with related changes to a field
 	 * The following scenarios are managed:
@@ -139,9 +152,9 @@ class SideEffectsControllerExtension extends ControllerExtension {
 
 					aImmediateSideEffectsProperties
 						.filter((mImmediateSideEffects) => mImmediateSideEffects.previouslyFailed === true)
-						.forEach((mImmediateSideEffects) =>
-							this._addFailedSideEffects(mImmediateSideEffects.sideEffects, mImmediateSideEffects.context)
-						);
+						.forEach((mImmediateSideEffects) => {
+							this._addFailedSideEffects(mImmediateSideEffects.sideEffects, mImmediateSideEffects.context);
+						});
 				}
 			});
 	}
@@ -261,32 +274,38 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @name requestSideEffects
 	 * @param oSideEffects SideEffects to be executed
 	 * @param oContext Context where SideEffects need to be executed
+	 * @param groupId
+	 * @param fnGetTargets The callback function which will give us the targets and actions if it was coming through some specific handling.
 	 * @returns SideEffects request on SAPUI5 context
 	 */
 	@publicExtension()
 	@finalExtension()
-	public requestSideEffects(oSideEffects: SideEffectsType, oContext: Context): Promise<any> {
-		let fResolver: any, fRejector: any;
-		const oPromise = new Promise(function (resolve, reject) {
-			fResolver = resolve;
-			fRejector = reject;
-		});
-		const aTargets: any[] = ((oSideEffects.TargetEntities as any[]) || []).concat((oSideEffects.TargetProperties as any[]) || []),
-			sTriggerAction: String | undefined = (oSideEffects as ODataSideEffectsType).TriggerAction;
-
+	public async requestSideEffects(
+		oSideEffects: SideEffectsType,
+		oContext: Context,
+		groupId?: string,
+		fnGetTargets?: Function
+	): Promise<any> {
+		let aTargets: any[], sTriggerAction;
+		if (fnGetTargets) {
+			const targetsAndActionData = await fnGetTargets(oSideEffects);
+			aTargets = targetsAndActionData["aTargets"];
+			sTriggerAction = targetsAndActionData["TriggerAction"];
+		} else {
+			aTargets = ((oSideEffects.TargetEntities as any[]) || []).concat((oSideEffects.TargetProperties as any[]) || []);
+			sTriggerAction = (oSideEffects as ODataSideEffectsType).TriggerAction;
+		}
 		if (sTriggerAction) {
-			this._oSideEffectsService.executeAction(sTriggerAction, oContext);
+			this._oSideEffectsService.executeAction(sTriggerAction, oContext, groupId);
 		}
 
-		this._oSideEffectsService
-			.requestSideEffects(aTargets, oContext)
-			.then(() => fResolver())
-			.catch((oError: any) => {
+		if (aTargets.length) {
+			return this._oSideEffectsService.requestSideEffects(aTargets, oContext, groupId).catch((oError: any) => {
 				this._addFailedSideEffects(oSideEffects, oContext);
-				fRejector(oError);
+				return Promise.reject(oError);
 			});
-
-		return oPromise;
+		}
+		return Promise.resolve();
 	}
 
 	/**
@@ -319,6 +338,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	@finalExtension()
 	private _addFailedSideEffects(oSideEffects: SideEffectsType, oContext: Context): void {
 		const sContextPath: string = oContext.getPath();
+
 		this._mFailedSideEffects[sContextPath] = this._mFailedSideEffects[sContextPath] || [];
 		const bIsNotAlreadyListed = this._mFailedSideEffects[sContextPath].every(
 			(mFailedSideEffects) => oSideEffects.fullyQualifiedName !== mFailedSideEffects.fullyQualifiedName
@@ -418,27 +438,24 @@ class SideEffectsControllerExtension extends ControllerExtension {
 
 	/**
 	 * Gets the appropriate context on which SideEffects can be requested.
-	 * The correct one must have the binding parameter $$patchWithoutSideEffects.
+	 *  The correct one must have the binding parameter $$patchWithoutSideEffects.
 	 *
-	 * @function
-	 * @name _getContextForSideEffects
-	 * @param oSourceField Field
-	 * @param sSideEffectEntityType Target entity type of the SideEffects annotation
-	 * @returns SAPUI5 Context
+	 * @param oBindingContext
+	 * @param sSideEffectEntityType
+	 * @returns SAPUI5 Context or undefined
 	 */
-	@privateExtension()
+	@publicExtension()
 	@finalExtension()
-	private _getContextForSideEffects(oSourceField: FieldControl, sSideEffectEntityType: string): Context | undefined {
-		const oBindingContext = oSourceField.getBindingContext();
+	public getContextForSideEffects(oBindingContext: any, sSideEffectEntityType: string): Context | undefined {
 		let oContextForSideEffects = oBindingContext,
 			sEntityType = this._oSideEffectsService.getEntityTypeFromContext(oBindingContext);
 
 		if (sSideEffectEntityType !== sEntityType) {
-			oContextForSideEffects = (oBindingContext as any).getBinding().getContext();
+			oContextForSideEffects = oBindingContext.getBinding().getContext();
 			if (oContextForSideEffects) {
 				sEntityType = this._oSideEffectsService.getEntityTypeFromContext(oContextForSideEffects);
 				if (sSideEffectEntityType !== sEntityType) {
-					oContextForSideEffects = (oContextForSideEffects as any).getBinding().getContext();
+					oContextForSideEffects = oContextForSideEffects.getBinding().getContext();
 					if (oContextForSideEffects) {
 						sEntityType = this._oSideEffectsService.getEntityTypeFromContext(oContextForSideEffects);
 						if (sSideEffectEntityType !== sEntityType) {
@@ -474,10 +491,10 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 */
 	private _getFieldPromise(oEvent: Event): Promise<any> {
 		const promise = oEvent.getParameter("promise") || Promise.resolve();
-
+		const validity = FieldRuntime.getFieldStateOnChange(oEvent).state.validity;
 		return promise.then(() => {
 			return new Promise(function (resolve, reject) {
-				if (!FieldRuntime.getFieldStateOnChange(oEvent).state.validity) {
+				if (!validity) {
 					reject();
 				} else {
 					resolve(true);
@@ -516,34 +533,15 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @returns SideEffects map
 	 */
 	private _getFieldSideEffectsMap(oField: FieldControl): FieldSideEffectDictionary {
-		const mSideEffectsMap: FieldSideEffectDictionary = {},
-			aFieldGroupIds: string[] = oField.getFieldGroupIds(),
+		let mSideEffectsMap: FieldSideEffectDictionary = {};
+		const aFieldGroupIds: string[] = oField.getFieldGroupIds(),
 			sViewEntitySetSetName = this._oView.getViewData().entitySet,
 			oViewEntitySet = (this._oSideEffectsService.getConvertedMetaModel() as ConvertedMetadata).entitySets.find((oEntitySet) => {
 				return oEntitySet.name === sViewEntitySetSetName;
 			});
 
 		// SideEffects coming from an OData Service
-		aFieldGroupIds.forEach((sFieldGroupId) => {
-			const bIsImmediate: boolean = sFieldGroupId.indexOf("$$ImmediateRequest") !== -1,
-				sName: string = sFieldGroupId.replace("$$ImmediateRequest", ""),
-				aSideEffectParts: string[] = sName.split("#"),
-				sSideEffectEntityType: string = aSideEffectParts[0],
-				sSideEffectPath: string = `${sSideEffectEntityType}@com.sap.vocabularies.Common.v1.SideEffects${
-					aSideEffectParts.length === 2 ? `#${aSideEffectParts[1]}` : ""
-				}`,
-				oSideEffect: SideEffectsType | undefined =
-					this._oSideEffectsService.getODataEntitySideEffects(sSideEffectEntityType)?.[sSideEffectPath],
-				oContext: Context | undefined = this._getContextForSideEffects(oField, sSideEffectEntityType);
-			if (oSideEffect && oContext) {
-				mSideEffectsMap[sName] = {
-					name: sName,
-					immediate: bIsImmediate,
-					sideEffects: oSideEffect,
-					context: oContext
-				};
-			}
-		});
+		mSideEffectsMap = this.generateSideEffectsMapFromSideEffectId(aFieldGroupIds, oField) as FieldSideEffectDictionary;
 
 		//SideEffects coming from control(s)
 		if (sViewEntitySetSetName && oViewEntitySet) {
@@ -551,7 +549,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 				mFieldPath: any = (oField.getAggregation("customData") as any[]).find((oCustomData) => {
 					return oCustomData.getKey() === "sourcePath";
 				}),
-				oContext: Context | undefined = this._getContextForSideEffects(oField, sViewEntityType);
+				oContext: Context | undefined = this.getContextForSideEffects(oField.getBindingContext(), sViewEntityType);
 
 			if (mFieldPath && oContext) {
 				const sFieldPath = mFieldPath.getValue().replace(`/${sViewEntitySetSetName}/`, ""),
@@ -575,6 +573,62 @@ class SideEffectsControllerExtension extends ControllerExtension {
 		return mSideEffectsMap;
 	}
 
+	/**
+	 * Get side effect Name, sideeffect obj and entity type from a given fieldGroupId.
+	 *
+	 * @param sFieldGroupId
+	 * @returns Data about sideeffect name, entitytype, side effect object and if it is immediate.
+	 */
+	private _getDataToGenerateSideEffectsMapFromSideEffectId(sFieldGroupId: any) {
+		const bIsImmediate: boolean = sFieldGroupId.indexOf("$$ImmediateRequest") !== -1,
+			sName: string = sFieldGroupId.replace("$$ImmediateRequest", ""),
+			aSideEffectParts: string[] = sName.split("#"),
+			sSideEffectEntityType: string = aSideEffectParts[0],
+			sSideEffectPath: string = `${sSideEffectEntityType}@com.sap.vocabularies.Common.v1.SideEffects${
+				aSideEffectParts.length === 2 ? `#${aSideEffectParts[1]}` : ""
+			}`,
+			oSideEffect: SideEffectsType | undefined =
+				this._oSideEffectsService.getODataEntitySideEffects(sSideEffectEntityType)?.[sSideEffectPath];
+		return { sName, bIsImmediate, oSideEffect, sSideEffectEntityType };
+	}
+
+	/**
+	 * Generate the side effects map from id which is the entity and qualifier
+	 * for the given entity.
+	 *
+	 * @function
+	 * @param aFieldGroupIds
+	 * @param oField
+	 * @returns Side effect map with data
+	 */
+
+	@publicExtension()
+	@finalExtension()
+	public generateSideEffectsMapFromSideEffectId(
+		aFieldGroupIds: string[],
+		oField?: FieldControl
+	): MassEditFieldSideEffectDictionary | FieldSideEffectDictionary {
+		const mSideEffectsMap: MassEditFieldSideEffectDictionary | FieldSideEffectDictionary = {};
+		aFieldGroupIds.forEach((sFieldGroupId: any) => {
+			const { sName, bIsImmediate, oSideEffect, sSideEffectEntityType } =
+				this._getDataToGenerateSideEffectsMapFromSideEffectId(sFieldGroupId);
+			const oContext: Context | undefined = oField
+				? this.getContextForSideEffects(oField.getBindingContext(), sSideEffectEntityType)
+				: undefined;
+			if (oSideEffect && (!oField || (oField && oContext))) {
+				mSideEffectsMap[sName] = {
+					name: sName,
+					immediate: bIsImmediate,
+					sideEffects: oSideEffect
+				};
+				if (oField) {
+					(mSideEffectsMap[sName] as FieldSideEffectPropertyType).context = oContext!;
+				}
+			}
+		});
+		return mSideEffectsMap;
+	}
+
 	/**
 	 * Manages the SideEffects with related changes to a field
 	 * List: gets immediate SideEffects requests
@@ -599,45 +653,47 @@ class SideEffectsControllerExtension extends ControllerExtension {
 
 		Object.keys(mFieldSideEffectsMap).forEach((sSideEffectName) => {
 			const oSideEffectProperty: FieldSideEffectPropertyType = mFieldSideEffectsMap[sSideEffectName],
-				sSideEffectContextPath = oSideEffectProperty.context.getPath(),
-				aFailedSideEffects = this._mFailedSideEffects[sSideEffectContextPath];
-
-			// Check if there is any previously failed request for this context
-			if (aFailedSideEffects) {
-				delete this._mFailedSideEffects[sSideEffectContextPath];
-				mFailedSideEffectsName[sSideEffectContextPath] = {};
-				aFailedSideEffects.forEach((mFailedSideEffects) => {
-					mFailedSideEffectsName[sSideEffectContextPath][mFailedSideEffects.fullyQualifiedName] = true;
-					aImmediateSideEffectsProperties.push({
-						name: sSideEffectName,
-						previouslyFailed: true,
-						sideEffects: mFailedSideEffects,
-						context: oSideEffectProperty.context
-					});
-				});
-			}
-			if (oSideEffectProperty.immediate) {
-				// SideEffects will be executed immediately after event promise validation
-				if (!mFailedSideEffectsName[sSideEffectContextPath]?.[oSideEffectProperty.sideEffects.fullyQualifiedName]) {
-					aImmediateSideEffectsProperties.push({
-						name: sSideEffectName,
-						sideEffects: oSideEffectProperty.sideEffects,
-						context: oSideEffectProperty.context
+				sSideEffectContextPath = oSideEffectProperty.context?.getPath();
+			if (sSideEffectContextPath) {
+				const aFailedSideEffects = this._mFailedSideEffects[sSideEffectContextPath];
+
+				if (aFailedSideEffects) {
+					delete this._mFailedSideEffects[sSideEffectContextPath];
+					mFailedSideEffectsName[sSideEffectContextPath] = {};
+					aFailedSideEffects.forEach((mFailedSideEffects: any) => {
+						mFailedSideEffectsName[sSideEffectContextPath][mFailedSideEffects.fullyQualifiedName] = true;
+						aImmediateSideEffectsProperties.push({
+							name: sSideEffectName,
+							previouslyFailed: true,
+							sideEffects: mFailedSideEffects,
+							context: oSideEffectProperty.context
+						});
 					});
 				}
-			} else {
-				// Add deferred SideEffects to the related dictionary
-				this._mFieldGroupQueue[sSideEffectName] = this._mFieldGroupQueue[sSideEffectName] || {};
-				const mSideEffectContextPath = this._mFieldGroupQueue[sSideEffectName][sSideEffectContextPath] || {
-					promises: [],
-					sideEffectProperty: oSideEffectProperty,
-					processStarted: false
-				};
-				mSideEffectContextPath.promises = mSideEffectContextPath.promises.concat([
-					oFieldPromiseForFieldGroup,
-					oFieldGroupPreRequisite as Promise<any>
-				]);
-				this._mFieldGroupQueue[sSideEffectName][sSideEffectContextPath] = mSideEffectContextPath;
+
+				if (oSideEffectProperty.immediate) {
+					// SideEffects will be executed immediately after event promise validation
+					if (!mFailedSideEffectsName[sSideEffectContextPath]?.[oSideEffectProperty.sideEffects.fullyQualifiedName]) {
+						aImmediateSideEffectsProperties.push({
+							name: sSideEffectName,
+							sideEffects: oSideEffectProperty.sideEffects,
+							context: oSideEffectProperty.context
+						});
+					}
+				} else {
+					// Add deferred SideEffects to the related dictionary
+					this._mFieldGroupQueue[sSideEffectName] = this._mFieldGroupQueue[sSideEffectName] || {};
+					const mSideEffectContextPath = this._mFieldGroupQueue[sSideEffectName][sSideEffectContextPath] || {
+						promises: [],
+						sideEffectProperty: oSideEffectProperty,
+						processStarted: false
+					};
+					mSideEffectContextPath.promises = mSideEffectContextPath.promises.concat([
+						oFieldPromiseForFieldGroup,
+						oFieldGroupPreRequisite as Promise<any>
+					]);
+					this._mFieldGroupQueue[sSideEffectName][sSideEffectContextPath] = mSideEffectContextPath;
+				}
 			}
 		});
 		return aImmediateSideEffectsProperties;