@sap/open.fe 1.94.0

package/packages/sap.fe.core/src/sap/fe/core/services/SideEffectsServiceFactory.js

@@ -0,0 +1,5 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+ *      (c) Copyright 2009-2021 SAP SE. All rights reserved
+ */
+sap.ui.define(["sap/ui/core/service/ServiceFactory","sap/ui/core/service/Service","sap/fe/core/converters/MetaModelConverter","sap/base/Log"],function(S,a,M,L){"use strict";var c=M.convertTypes;function b(o,e){var i=Object.keys(o);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(o);if(e){p=p.filter(function(u){return Object.getOwnPropertyDescriptor(o,u).enumerable;});}i.push.apply(i,p);}return i;}function _(e){for(var i=1;i<arguments.length;i++){var o=arguments[i]!=null?arguments[i]:{};if(i%2){b(Object(o),true).forEach(function(p){d(e,p,o[p]);});}else if(Object.getOwnPropertyDescriptors){Object.defineProperties(e,Object.getOwnPropertyDescriptors(o));}else{b(Object(o)).forEach(function(p){Object.defineProperty(e,p,Object.getOwnPropertyDescriptor(o,p));});}}return e;}function d(o,e,v){if(e in o){Object.defineProperty(o,e,{value:v,enumerable:true,configurable:true,writable:true});}else{o[e]=v;}return o;}function f(i,C){if(!(i instanceof C)){throw new TypeError("Cannot call a class as a function");}}function g(e,p){for(var i=0;i<p.length;i++){var o=p[i];o.enumerable=o.enumerable||false;o.configurable=true;if("value"in o)o.writable=true;Object.defineProperty(e,o.key,o);}}function h(C,p,e){if(p)g(C.prototype,p);if(e)g(C,e);return C;}function j(e,i){if(typeof i!=="function"&&i!==null){throw new TypeError("Super expression must either be null or a function");}e.prototype=Object.create(i&&i.prototype,{constructor:{value:e,writable:true,configurable:true}});if(i)k(e,i);}function k(o,p){k=Object.setPrototypeOf||function k(o,p){o.__proto__=p;return o;};return k(o,p);}function l(D){var e=q();return function p(){var i=r(D),o;if(e){var N=r(this).constructor;o=Reflect.construct(i,arguments,N);}else{o=i.apply(this,arguments);}return m(this,o);};}function m(e,i){if(i&&(typeof i==="object"||typeof i==="function")){return i;}return n(e);}function n(e){if(e===void 0){throw new ReferenceError("this hasn't been initialised - super() hasn't been called");}return e;}function q(){if(typeof Reflect==="undefined"||!Reflect.construct)return false;if(Reflect.construct.sham)return false;if(typeof Proxy==="function")return true;try{Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],function(){}));return true;}catch(e){return false;}}function r(o){r=Object.setPrototypeOf?Object.getPrototypeOf:function r(o){return o.__proto__||Object.getPrototypeOf(o);};return r(o);}var s=function(i){j(s,i);var o=l(s);function s(){f(this,s);return o.apply(this,arguments);}h(s,[{key:"init",value:function e(){this._oSideEffectsType={oData:{entities:{},actions:{}},control:{}};this._bInitialized=false;this.initPromise=Promise.resolve(this);}},{key:"addControlSideEffects",value:function u(e,p){if(p.sourceControlId){var C=_(_({},p),{},{fullyQualifiedName:e+"/SideEffectsForControl/"+p.sourceControlId});var E=this._oSideEffectsType.control[e]||{};E[C.sourceControlId]=C;this._oSideEffectsType.control[e]=E;}}},{key:"executeAction",value:function p(T,C,G){var e=C.getModel().bindContext(T+"(...)",C);e.execute(G||C.getBinding().getUpdateGroupId());}},{key:"getConvertedMetaModel",value:function u(){var C=this.getContext();var e=C.scopeObject;var p=e.getModel().getMetaModel();return c(p,this._oCapabilities);}},{key:"getEntityTypeFromContext",value:function u(C){var e=C.getModel().getMetaModel(),p=e.getMetaPath(C.getPath()),E=e.getObject(p)["$Type"];return E;}},{key:"getODataEntitySideEffects",value:function p(e){return this._oSideEffectsType.oData.entities[e]||{};}},{key:"getODataActionSideEffects",value:function u(A,C){if(C){var e=this.getEntityTypeFromContext(C);if(e){var p;return(p=this._oSideEffectsType.oData.actions[e])===null||p===void 0?void 0:p[A];}}return undefined;}},{key:"initializeSideEffects",value:function u(C){var e=this;this._oCapabilities=C;if(!this._bInitialized){var p=this.getConvertedMetaModel();p.entityTypes.forEach(function(v){e._oSideEffectsType.oData.entities[v.fullyQualifiedName]=e._retrieveODataEntitySideEffects(v);e._oSideEffectsType.oData.actions[v.fullyQualifiedName]=e._retrieveODataActionsSideEffects(v);});this._bInitialized=true;}}},{key:"removeControlSideEffects",value:function p(C){var e=this;Object.keys(this._oSideEffectsType.control).forEach(function(E){if(e._oSideEffectsType.control[E][C]){delete e._oSideEffectsType.control[E][C];}});}},{key:"requestSideEffects",value:function u(p,C,G){this._logRequest(p,C);var P;try{P=C.requestSideEffects(p,G);}catch(e){P=Promise.reject(e);}return P;}},{key:"requestSideEffectsForNavigationProperty",value:function u(N,C){var e=this;var B=this.getEntityTypeFromContext(C);if(B){var p=this.getODataEntitySideEffects(B);var T=[];Object.keys(p).filter(function(A){var v=p[A];return(v.SourceProperties||[]).some(function(P){return P.value.indexOf(N)>-1;})||(v.SourceEntities||[]).some(function(w){return w.value===N;});}).forEach(function(A){var v=p[A];if(v.TriggerAction){e.executeAction(v.TriggerAction,C);}(v.TargetEntities||[]).concat(v.TargetProperties||[]).forEach(function(w){return T.push(w);});});T=this._removeDuplicateTargets(T);if(T.length>0){return this.requestSideEffects(T,C).catch(function(E){return L.error("SideEffects - Error while processing SideEffects for Navigation Property "+N,E);});}}return Promise.resolve();}},{key:"getControlEntitySideEffects",value:function p(e){return this._oSideEffectsType.control[e]||{};}},{key:"_addRequiredTextProperties",value:function u(e,E){var I=e.TargetProperties||[],p=(e.TargetEntities||[]).map(function(v){return v.$NavigationPropertyPath;});var D=[];I.forEach(function(P){var v=P.endsWith("*"),N=P.substring(0,P.lastIndexOf("/")),R=N?N+"/":"",T=E.resolvePath(N)||E;if(T){var w;var x=T.entityProperties||((w=T.targetType)===null||w===void 0?void 0:w.properties)||T.targetType.entityProperties;if(x){if(v){if(x){p.push(N);D=D.concat(x.map(function(y){return{navigationPath:R,property:y};}));}}else{D.push({property:x.find(function(y){return y.name===P.split("/").pop();}),navigationPath:R});}}else{L.info("SideEffects - The entity type associated to property path "+P+" cannot be resolved");}}else{L.info("SideEffects - The property path "+P+" cannot be resolved");}});D.forEach(function(P){if(P.property){var v,w,x;var T=(v=P.property.annotations)===null||v===void 0?void 0:(w=v.Common)===null||w===void 0?void 0:(x=w.Text)===null||x===void 0?void 0:x.path,y=P.navigationPath+T;if(T&&p.indexOf(y.substring(0,y.lastIndexOf("/")))===-1&&I.indexOf(y)===-1){e.TargetProperties.push(y);}}});return e;}},{key:"_convertSideEffects",value:function u(e,E,B){var p=this.getConvertedMetaModel().entityTypes.find(function(v){return v.fullyQualifiedName===E;});var T=this._removeBindingParameter(this._convertTargetsFormat(e),B);return p?this._replaceReferencedProperties(this._addRequiredTextProperties(T,p),p):T;}},{key:"_convertTargetsFormat",value:function u(e){var T=(e.TargetProperties||[]).reduce(function(v,w){var x=typeof w==="string"&&w||w.type==="PropertyPath"&&w.value;if(x){v.push(x);}else{L.error("SideEffects - Error while processing TargetProperties for SideEffects"+e.fullyQualifiedName);}return v;},[]),p=(e.TargetEntities||[]).map(function(v){return{"$NavigationPropertyPath":v.$NavigationPropertyPath||v.value||""};});return _(_({},e),{TargetProperties:T,TargetEntities:p});}},{key:"_getSideEffectsFromSource",value:function y(e){var p=this;var u=[];var v=["EntityType","Action"];if(e._type&&v.indexOf(e._type)>-1){var E=e._type==="EntityType"?e:e.sourceEntityType;if(E){var w;var C=((w=e.annotations)===null||w===void 0?void 0:w.Common)||{};var B=(e.parameters||[]).find(function(P){return P.type===(E||e).fullyQualifiedName;});var x=B?B.fullyQualifiedName.split("/")[1]:"";Object.keys(C).filter(function(A){return C[A].$Type==="com.sap.vocabularies.Common.v1.SideEffectsType";}).forEach(function(A){u.push(p._convertSideEffects(C[A],E.fullyQualifiedName,x));});}}return u;}},{key:"_logRequest",value:function e(p,C){var T=p.reduce(function(P,u){return P+"\n\t\t"+(u.$NavigationPropertyPath||u||"");},"");L.debug("SideEffects - Request:\n\tContext path : "+C.getPath()+"\n\tProperty paths :"+T);}},{key:"_removeBindingParameter",value:function p(e,B){if(B){var T=["TargetProperties","TargetEntities"];T.forEach(function(u){var v=e[u];if(v){v=v.map(function(P){var N=P.$NavigationPropertyPath!==undefined;var V=(N?P.$NavigationPropertyPath:P).replace(new RegExp("^"+B+"?."),"");return N?{$NavigationPropertyPath:V}:V;});}e[u]=v;});}return e;}},{key:"_removeDuplicateTargets",value:function e(T){return T.filter(function(p,I,T){return T.findIndex(function(u){return u===p||p.$NavigationPropertyPath&&u.$NavigationPropertyPath===p.$NavigationPropertyPath;})===I;});}},{key:"_replaceReferencedProperties",value:function v(e,E){var p=false;var u=(e.TargetEntities||[]).map(function(N){return N.$NavigationPropertyPath;})||[],P=[];e.TargetProperties.forEach(function(w){var T=false;var x=w.lastIndexOf("/");if(x!==-1){var N=w.substring(0,x);var y=E.resolvePath(N);if(y&&y._type==="NavigationProperty"){p=true;T=true;if(!u.includes(N)){u.push(N);}}}if(!T){P.push(w);}});if(p){e.TargetProperties=P;e.TargetEntities=u.map(function(N){return{$NavigationPropertyPath:N};});}return e;}},{key:"_retrieveODataActionsSideEffects",value:function v(e){var p=this;var u={};var A=e.actions;if(A){Object.keys(A).forEach(function(w){var x=e.actions[w];var y=[];var z=[];var T=[];p._getSideEffectsFromSource(x).forEach(function(B){var C=B.TriggerAction;T=T.concat(B.TargetEntities||[]).concat(B.TargetProperties||[]);if(C&&y.indexOf(C)===-1){y.push(C);}});z=p._removeDuplicateTargets(T);u[w]={pathExpressions:z,triggerActions:y};});}return u;}},{key:"_retrieveODataEntitySideEffects",value:function p(e){var E={};this._getSideEffectsFromSource(e).forEach(function(u){E[u.fullyQualifiedName]=u;});return E;}},{key:"getInterface",value:function e(){return this;}}]);return s;}(a);var t=function(e){j(t,e);var i=l(t);function t(){f(this,t);return i.apply(this,arguments);}h(t,[{key:"createInstance",value:function u(o){var p=new s(o);return p.initPromise;}}]);return t;}(S);return t;},false);

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

@@ -0,0 +1,668 @@
+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 { 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";
+
+type SideEffectsSettings = {};
+
+type SideEffectsTargetEntityType = {
+	$NavigationPropertyPath: string;
+};
+type SideEffectsTarget = SideEffectsTargetEntityType | string;
+
+type SideEffectsTargetType = {
+	TargetProperties: string[];
+	TargetEntities: SideEffectsTargetEntityType[];
+};
+
+type BaseAnnotationSideEffectsType = {
+	TargetProperties: string[];
+	TargetEntities: NavigationPropertyPath[];
+	fullyQualifiedName: string;
+};
+
+type BaseSideEffectsType = {
+	fullyQualifiedName: string;
+} & SideEffectsTargetType;
+
+type ActionSideEffectsType = {
+	pathExpressions: SideEffectsTarget[];
+	triggerActions?: QualifiedName[];
+};
+
+export type ControlSideEffectsType = Partial<BaseSideEffectsType> & {
+	fullyQualifiedName: string;
+	SourceProperties: string[];
+	sourceControlId: string;
+};
+
+export type ODataSideEffectsType = BaseSideEffectsType & {
+	SourceProperties?: PropertyPath[];
+	SourceEntities?: NavigationPropertyPath[];
+	TriggerAction?: QualifiedName;
+};
+
+export type SideEffectsType = ControlSideEffectsType | ODataSideEffectsType;
+
+export type ODataSideEffectsEntityDictionary = Record<string, ODataSideEffectsType>;
+export type ODataSideEffectsActionDictionary = Record<string, ActionSideEffectsType>;
+export type ControlSideEffectsEntityDictionary = Record<string, ControlSideEffectsType>;
+
+type SideEffectsOriginRegistry = {
+	oData: {
+		entities: {
+			[entity: string]: Record<string, ODataSideEffectsType>;
+		};
+		actions: {
+			[entity: string]: Record<string, ActionSideEffectsType>;
+		};
+	};
+	control: {
+		[entity: string]: Record<string, ControlSideEffectsType>;
+	};
+};
+
+type ExtractorPropertyInfo = {
+	property: Property;
+	navigationPath?: string;
+};
+
+class SideEffectsService extends Service<SideEffectsSettings> {
+	initPromise!: Promise<any>;
+	_oSideEffectsType!: SideEffectsOriginRegistry;
+	_oCapabilities!: EnvironmentCapabilities | undefined;
+	_bInitialized!: Boolean;
+	// !: means that we know it will be assigned before usage
+	init() {
+		this._oSideEffectsType = {
+			oData: {
+				entities: {},
+				actions: {}
+			},
+			control: {}
+		};
+		this._bInitialized = false;
+		this.initPromise = Promise.resolve(this);
+	}
+
+	/**
+	 * Adds a SideEffects control
+	 * SideEffects definition is added by a control to keep data up to date
+	 * These SideEffects get limited scope compared with SideEffects coming from an OData service:
+	 * - Only one SideEffects definition can be defined for the combination entity type - control Id
+	 * - Only SideEffects source properties are recognized and used to trigger SideEffects
+	 *
+	 * Ensure the sourceControlId matches the associated SAPUI5 control ID.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {string} sEntityType Name of the entity type
+	 * @param {object} oSideEffect SideEffects definition
+	 */
+	public addControlSideEffects(sEntityType: string, oSideEffect: Omit<ControlSideEffectsType, "fullyQualifiedName">): void {
+		if (oSideEffect.sourceControlId) {
+			const oControlSideEffect: ControlSideEffectsType = {
+				...oSideEffect,
+				fullyQualifiedName: sEntityType + "/SideEffectsForControl/" + oSideEffect.sourceControlId
+			};
+			const mEntityControlSideEffects = this._oSideEffectsType.control[sEntityType] || {};
+			mEntityControlSideEffects[oControlSideEffect.sourceControlId] = oControlSideEffect;
+			this._oSideEffectsType.control[sEntityType] = mEntityControlSideEffects;
+		}
+	}
+
+	/**
+	 * Executes SideEffects action.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {string} sTriggerAction Name of the action
+	 * @param {object} oContext Context
+	 * @param {string} sGroupId The group ID to be used for the request
+	 */
+	public executeAction(sTriggerAction: String, oContext: Context, sGroupId?: string) {
+		const oTriggerAction: any = oContext.getModel().bindContext(sTriggerAction + "(...)", oContext);
+		oTriggerAction.execute(sGroupId || (oContext as any).getBinding().getUpdateGroupId());
+	}
+
+	/**
+	 * Gets converted OData metaModel.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @returns {object} Converted OData metaModel
+	 */
+	public getConvertedMetaModel(): ConverterOutput {
+		const oContext = this.getContext();
+		const oComponent = oContext.scopeObject as any;
+		const oMetaModel: ODataMetaModel = oComponent.getModel().getMetaModel();
+		return convertTypes(oMetaModel, this._oCapabilities);
+	}
+
+	/**
+	 * Gets the entity type of a context.
+	 *
+	 * @function
+	 * @name getEntityTypeFromContext
+	 * @param {object} oContext Context
+	 * @returns {string | undefined } Entity Type
+	 */
+	public getEntityTypeFromContext(oContext: Context): string | undefined {
+		const oMetaModel = oContext.getModel().getMetaModel(),
+			sMetaPath = (oMetaModel as any).getMetaPath(oContext.getPath()),
+			sEntityType = oMetaModel.getObject(sMetaPath)["$Type"];
+		return sEntityType;
+	}
+
+	/**
+	 * Gets the SideEffects that come from an OData service.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {string} sEntityTypeName Name of the entity type
+	 * @returns {object} SideEffects dictionary
+	 */
+	public getODataEntitySideEffects(sEntityTypeName: string): Record<string, ODataSideEffectsType> {
+		return this._oSideEffectsType.oData.entities[sEntityTypeName] || {};
+	}
+
+	/**
+	 * Gets the SideEffects that come from an OData service.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {string} sActionName Name of the action
+	 * @param {object} oContext Context
+	 * @returns {object} SideEffects definition
+	 */
+	public getODataActionSideEffects(sActionName: string, oContext?: Context): ActionSideEffectsType | undefined {
+		if (oContext) {
+			const sEntityType = this.getEntityTypeFromContext(oContext);
+			if (sEntityType) {
+				return this._oSideEffectsType.oData.actions[sEntityType]?.[sActionName];
+			}
+		}
+		return undefined;
+	}
+
+	/**
+	 * Generates the dictionary for the SideEffects.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param oCapabilities The current capabilities
+	 */
+	public initializeSideEffects(oCapabilities?: EnvironmentCapabilities): void {
+		this._oCapabilities = oCapabilities;
+		if (!this._bInitialized) {
+			const oConvertedMetaModel = this.getConvertedMetaModel();
+			oConvertedMetaModel.entityTypes.forEach(entityType => {
+				this._oSideEffectsType.oData.entities[entityType.fullyQualifiedName] = this._retrieveODataEntitySideEffects(entityType);
+				this._oSideEffectsType.oData.actions[entityType.fullyQualifiedName] = this._retrieveODataActionsSideEffects(entityType); // only bound actions are analyzed since unbound ones don't get SideEffects
+			});
+			this._bInitialized = true;
+		}
+	}
+
+	/**
+	 * Removes all SideEffects related to a control.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {string} sControlId Control Id
+	 */
+	public removeControlSideEffects(sControlId: string): void {
+		Object.keys(this._oSideEffectsType.control).forEach(sEntityType => {
+			if (this._oSideEffectsType.control[sEntityType][sControlId]) {
+				delete this._oSideEffectsType.control[sEntityType][sControlId];
+			}
+		});
+	}
+
+	/**
+	 * Request SideEffects on a specific context.
+	 *
+	 * @function
+	 * @name requestSideEffects
+	 * @param {Array} aPathExpressions Targets of SideEffects to be executed
+	 * @param {object} oContext Context where SideEffects need to be executed
+	 * @param {string} sGroupId The group ID to be used for the request
+	 * @returns {Promise} Promise on SideEffects request
+	 */
+	public requestSideEffects(aPathExpressions: SideEffectsTarget[], oContext: Context, sGroupId?: string): Promise<any> {
+		this._logRequest(aPathExpressions, oContext);
+		let oPromise: Promise<any>;
+		/**
+		 * Context.requestSideEffects either returns a promise or throws a new error. This return is caught if an error is thrown
+		 * to avoid breaking the promise chain.
+		 */
+		try {
+			oPromise = (oContext as any).requestSideEffects(aPathExpressions, sGroupId) as Promise<any>;
+		} catch (e) {
+			oPromise = Promise.reject(e);
+		}
+		return oPromise;
+	}
+
+	/**
+	 * Request SideEffects for a navigation property on a specific context.
+	 *
+	 * @function
+	 * @name requestSideEffectsForNavigationProperty
+	 * @param {string} sNavigationProperty Navigation property
+	 * @param {object} oContext Context where SideEffects need to be executed
+	 * @returns {object} SideEffects request on SAPUI5 context
+	 */
+	public requestSideEffectsForNavigationProperty(sNavigationProperty: string, oContext: Context): Promise<any> {
+		const sBaseEntityType = this.getEntityTypeFromContext(oContext);
+		if (sBaseEntityType) {
+			const aSideEffects = this.getODataEntitySideEffects(sBaseEntityType);
+			let aTargets: SideEffectsTarget[] = [];
+			Object.keys(aSideEffects)
+				.filter(
+					// Keep relevant SideEffects
+					sAnnotationName => {
+						const oSideEffects: ODataSideEffectsType = aSideEffects[sAnnotationName];
+						return (
+							(oSideEffects.SourceProperties || []).some(
+								oPropertyPath => oPropertyPath.value.indexOf(sNavigationProperty) > -1
+							) ||
+							(oSideEffects.SourceEntities || []).some(
+								oNavigationPropertyPath => oNavigationPropertyPath.value === sNavigationProperty
+							)
+						);
+					}
+				)
+				.forEach(sAnnotationName => {
+					const oSideEffects: ODataSideEffectsType = aSideEffects[sAnnotationName];
+					if (oSideEffects.TriggerAction) {
+						this.executeAction(oSideEffects.TriggerAction, oContext);
+					}
+					((oSideEffects.TargetEntities as any[]) || [])
+						.concat((oSideEffects.TargetProperties as any[]) || [])
+						.forEach(mTarget => aTargets.push(mTarget));
+				});
+			// Remove duplicate properties
+			aTargets = this._removeDuplicateTargets(aTargets);
+			if (aTargets.length > 0) {
+				return this.requestSideEffects(aTargets, oContext).catch(oError =>
+					Log.error("SideEffects - Error while processing SideEffects for Navigation Property " + sNavigationProperty, oError)
+				);
+			}
+		}
+		return Promise.resolve();
+	}
+
+	/**
+	 * Gets the SideEffects that come from controls.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {string} sEntityTypeName Entity type Name
+	 * @returns {object} SideEffects dictionary
+	 */
+	public getControlEntitySideEffects(sEntityTypeName: string): Record<string, ControlSideEffectsType> {
+		return this._oSideEffectsType.control[sEntityTypeName] || {};
+	}
+
+	/**
+	 * Adds the text properties required for SideEffects
+	 * If a property has an associated text then this text needs to be added as targetProperties.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {object} oSideEffect SideEffects definition
+	 * @param {object} mEntityType Entity type
+	 * @returns {object} SideEffects definition with added text properties
+	 */
+	private _addRequiredTextProperties(oSideEffect: BaseSideEffectsType, mEntityType: EntityType): BaseSideEffectsType {
+		const aInitialProperties: string[] = (oSideEffect.TargetProperties || []) as string[],
+			aEntitiesRequested: string[] = (oSideEffect.TargetEntities || []).map(navigation => navigation.$NavigationPropertyPath);
+		let aDerivedProperties: ExtractorPropertyInfo[] = [];
+
+		aInitialProperties.forEach(sPropertyPath => {
+			const bIsStarProperty = sPropertyPath.endsWith("*"), // Can be '*' or '.../navProp/*'
+				sNavigationPropertyPath: string = sPropertyPath.substring(0, sPropertyPath.lastIndexOf("/")),
+				sRelativePath = sNavigationPropertyPath ? sNavigationPropertyPath + "/" : "",
+				mTarget: any = mEntityType.resolvePath(sNavigationPropertyPath) || mEntityType;
+
+			if (mTarget) {
+				// 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 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
+									};
+								})
+							);
+						}
+					} else {
+						aDerivedProperties.push({
+							property: aTargetEntityProperties.find(
+								mProperty => mProperty.name === sPropertyPath.split("/").pop()
+							) as Property,
+							navigationPath: sRelativePath
+						});
+					}
+				} else {
+					Log.info("SideEffects - The entity type associated to property path " + sPropertyPath + " cannot be resolved");
+				}
+			} else {
+				Log.info("SideEffects - The property path " + sPropertyPath + " cannot be resolved");
+			}
+		});
+
+		aDerivedProperties.forEach(mPropertyInfo => {
+			if (mPropertyInfo.property) {
+				const sTargetTextPath = (mPropertyInfo.property.annotations?.Common?.Text as any)?.path,
+					sTextPathFromInitialEntity = mPropertyInfo.navigationPath + sTargetTextPath;
+				/**
+				 * 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
+				 * - not include into the initial targeted properties of SideEffects
+				 *  Indeed in the two listed cases, the property containing text will be/is requested by initial SideEffects configuration.
+				 */
+
+				if (
+					sTargetTextPath &&
+					aEntitiesRequested.indexOf(sTextPathFromInitialEntity.substring(0, sTextPathFromInitialEntity.lastIndexOf("/"))) ===
+						-1 &&
+					aInitialProperties.indexOf(sTextPathFromInitialEntity) === -1
+				) {
+					oSideEffect.TargetProperties.push(sTextPathFromInitialEntity);
+				}
+			}
+		});
+
+		return oSideEffect;
+	}
+	/**
+	 * Converts SideEffects to expected format
+	 *  - Converts SideEffects targets to expected format
+	 *  - Removes binding parameter from SideEffects targets properties
+	 *  - Adds the text properties
+	 *  - Replaces TargetProperties having reference to Source Properties for a SideEffects.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {object} oSideEffects SideEffects definition
+	 * @param {string} sEntityType Name of the entity type
+	 * @param {string} sBindingParameter Name of the binding parameter
+	 * @returns {object} SideEffects definition
+	 */
+	private _convertSideEffects(
+		oSideEffects: BaseSideEffectsType | BaseAnnotationSideEffectsType,
+		sEntityType: string | undefined,
+		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;
+	}
+
+	/**
+	 * Converts SideEffects targets (TargetEntities and TargetProperties) to expected format
+	 *  - TargetProperties as array of string
+	 *  - TargetEntities as array of object with property $NavigationPropertyPath.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {object} oSideEffects SideEffects definition
+	 * @returns {object} Converted SideEffects
+	 */
+	private _convertTargetsFormat(oSideEffects: BaseSideEffectsType | BaseAnnotationSideEffectsType): BaseSideEffectsType {
+		const TargetProperties: string[] = ((oSideEffects.TargetProperties as any[]) || []).reduce(function(aTargetProperties, vTarget) {
+				const sTarget = (typeof vTarget === "string" && vTarget) || (vTarget.type === "PropertyPath" && vTarget.value);
+				if (sTarget) {
+					aTargetProperties.push(sTarget);
+				} else {
+					Log.error("SideEffects - Error while processing TargetProperties for SideEffects" + oSideEffects.fullyQualifiedName);
+				}
+				return aTargetProperties;
+			}, []),
+			TargetEntities: SideEffectsTargetEntityType[] = ((oSideEffects.TargetEntities as any[]) || []).map(mTargetEntity => {
+				/**
+				 *  SideEffects that comes from SAP FE get TargetEntities with $NavigationPropertyPath whereas
+				 *  ones coming from the converted OData model gets a NavigationPropertyPath format
+				 *
+				 */
+				return { "$NavigationPropertyPath": mTargetEntity.$NavigationPropertyPath || mTargetEntity.value || "" };
+			});
+		return { ...oSideEffects, ...{ TargetProperties, TargetEntities } };
+	}
+
+	/**
+	 * Gets SideEffects related to an entity type or action that come from an OData Service
+	 * Internal routine to get, from converted oData metaModel, SideEffects related to a specific entity type or action
+	 * and to convert these SideEffects with expected format.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {object} oSource Entity type or action
+	 * @returns {object} Array of SideEffects
+	 */
+	private _getSideEffectsFromSource(oSource: any): ODataSideEffectsType[] {
+		const aSideEffects: ODataSideEffectsType[] = [];
+		const authorizedTypes = ["EntityType", "Action"];
+		if (oSource._type && authorizedTypes.indexOf(oSource._type) > -1) {
+			const mEntityType: EntityType | undefined = oSource._type === "EntityType" ? oSource : oSource.sourceEntityType;
+			if (mEntityType) {
+				const mCommonAnnotation: any = oSource.annotations?.Common || {};
+				const mBindingParameter = ((oSource as Action).parameters || []).find(
+					mParameter => mParameter.type === (mEntityType || oSource).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)
+						);
+					});
+			}
+		}
+		return aSideEffects;
+	}
+
+	/**
+	 * Logs SideEffects request.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {Array} aPathExpressions SideEffects targets
+	 * @param {object} oContext Context
+	 */
+	private _logRequest(aPathExpressions: SideEffectsTarget[], oContext: Context) {
+		const sTargetPaths = aPathExpressions.reduce(function(sPaths, mTarget) {
+			return sPaths + "\n\t\t" + ((mTarget as SideEffectsTargetEntityType).$NavigationPropertyPath || mTarget || "");
+		}, "");
+		Log.debug("SideEffects - Request:\n\tContext path : " + oContext.getPath() + "\n\tProperty paths :" + sTargetPaths);
+	}
+
+	/**
+	 * Removes name of binding parameter on SideEffects targets.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {object} oSideEffects SideEffects definition
+	 * @param {string} sBindingParameterName Name of binding parameter
+	 * @returns {object} SideEffects definition
+	 */
+	private _removeBindingParameter(oSideEffects: BaseSideEffectsType, sBindingParameterName?: string): BaseSideEffectsType {
+		if (sBindingParameterName) {
+			const aTargets = ["TargetProperties", "TargetEntities"];
+			aTargets.forEach(sTarget => {
+				let mTarget = (oSideEffects as any)[sTarget];
+				if (mTarget) {
+					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 + "?."),
+							""
+						);
+						return bNavigationPropertyPath ? { $NavigationPropertyPath: sValue } : sValue;
+					});
+				}
+				(oSideEffects as any)[sTarget] = mTarget;
+			});
+		}
+		return oSideEffects;
+	}
+
+	/**
+	 * Remove duplicates in SideEffects targets.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {Array} aTargets SideEffects targets
+	 * @returns {Array} SideEffects targets without duplicates
+	 */
+	private _removeDuplicateTargets(aTargets: SideEffectsTarget[]): SideEffectsTarget[] {
+		return aTargets.filter(
+			(mTarget: any, iIndex, aTargets) =>
+				aTargets.findIndex((mSearchTarget: any) => {
+					return (
+						mSearchTarget === mTarget || // PropertyPath
+						(mTarget.$NavigationPropertyPath && mSearchTarget.$NavigationPropertyPath === mTarget.$NavigationPropertyPath) // NavigationPropertyPath
+					);
+				}) === iIndex
+		);
+	}
+
+	/**
+	 * 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
+	 * related to a specific entity type and to convert these SideEffects with
+	 * expected format.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {object} mEntityType Entity type
+	 * @returns {object} Entity type SideEffects dictionary
+	 */
+	private _retrieveODataActionsSideEffects(mEntityType: EntityType): Record<string, ActionSideEffectsType> {
+		const oSideEffects: Record<string, ActionSideEffectsType> = {};
+		const aActions = mEntityType.actions;
+		if (aActions) {
+			Object.keys(aActions).forEach(sActionName => {
+				const oAction = mEntityType.actions[sActionName];
+				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);
+					}
+				});
+				pathExpressions = this._removeDuplicateTargets(aTargets);
+				oSideEffects[sActionName] = { pathExpressions, triggerActions };
+			});
+		}
+		return oSideEffects;
+	}
+
+	/**
+	 * Gets SideEffects entity type that come from an OData Service
+	 * Internal routine to get, from converted oData metaModel, SideEffects
+	 * related to a specific entity type and to convert these SideEffects with
+	 * expected format.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {object} mEntityType Entity type
+	 * @returns {object} Entity type SideEffects dictionary
+	 */
+	private _retrieveODataEntitySideEffects(mEntityType: EntityType): Record<string, ODataSideEffectsType> {
+		const oEntitySideEffects: Record<string, ODataSideEffectsType> = {};
+		this._getSideEffectsFromSource(mEntityType).forEach(oSideEffects => {
+			oEntitySideEffects[oSideEffects.fullyQualifiedName] = oSideEffects;
+		});
+		return oEntitySideEffects;
+	}
+
+	getInterface(): any {
+		return this;
+	}
+}
+
+class SideEffectsServiceFactory extends ServiceFactory<SideEffectsSettings> {
+	createInstance(oServiceContext: ServiceContext<SideEffectsSettings>) {
+		const SideEffectsServiceService = new SideEffectsService(oServiceContext);
+		return SideEffectsServiceService.initPromise;
+	}
+}
+
+export default SideEffectsServiceFactory;