@sapui5/sap.fe.core 1.95.0 → 1.98.0

package/src/sap/fe/core/services/RoutingServiceFactory.js

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 sap.ui.define(
 	[
@@ -17,7 +17,9 @@ sap.ui.define(
 		"sap/fe/core/helpers/ModelHelper",
 		"sap/fe/core/helpers/EditState",
 		"sap/fe/core/actions/messageHandling",
-		"sap/fe/core/controllerextensions/Placeholder"
+		"sap/fe/core/controllerextensions/Placeholder",
+		"sap/fe/core/helpers/AppStartupHelper",
+		"sap/ui/model/odata/v4/ODataUtils"
 	],
 	function(
 		Service,
@@ -33,7 +35,9 @@ sap.ui.define(
 		ModelHelper,
 		EditState,
 		MessageHandling,
-		Placeholder
+		Placeholder,
+		AppStartupHelper,
+		ODataUtils
 	) {
 		"use strict";
 
@@ -71,10 +75,11 @@ sap.ui.define(
 
 				this.initPromise = Promise.resolve(that);
 			},
-
-			exit: function() {
+			beforeExit: function() {
 				this.oRouter.detachRouteMatched(this._fnOnRouteMatched);
 				this.eventProvider.fireEvent("routeMatched", {});
+			},
+			exit: function() {
 				this.eventProvider.destroy();
 			},
 
@@ -113,7 +118,7 @@ sap.ui.define(
 
 					// Check route pattern: all patterns need to end with ':?query:', that we use for parameters
 					if (sRoutePattern.length < 8 || sRoutePattern.indexOf(":?query:") !== sRoutePattern.length - 8) {
-						Log.error("Pattern for route " + sRouteName + " doesn't end with ':?query:' : " + sRoutePattern);
+						Log.warning("Pattern for route " + sRouteName + " doesn't end with ':?query:' : " + sRoutePattern);
 					}
 					var iRouteLevel = that._getViewLevelFromPattern(sRoutePattern, 0);
 					that._mRoutes[sRouteName] = {
@@ -211,13 +216,13 @@ sap.ui.define(
 						that.sContextPath = oSettings.contextPath || "/" + oSettings.entitySet;
 					}
 					if (!that.sContextPath) {
-						Log.error(
+						Log.warning(
 							"Cannot determine default contextPath: contextPath or entitySet missing in default target: " +
 								sDefaultTargetName
 						);
 					}
 				} else {
-					Log.error("Cannot determine default contextPath: no default route found.");
+					Log.warning("Cannot determine default contextPath: no default route found.");
 				}
 
 				// We need to establish the correct path to the different pages, including the navigation properties
@@ -234,11 +239,7 @@ sap.ui.define(
 							var settings = target.options.settings;
 							var sContextPath = settings.contextPath || (settings.entitySet ? "/" + settings.entitySet : "");
 							if (!settings.fullContextPath && sContextPath) {
-								if (target.viewLevel === 0 || target.viewLevel === undefined) {
-									settings.fullContextPath = "/";
-								} else {
-									settings.fullContextPath = sContextPath + "/";
-								}
+								settings.fullContextPath = sContextPath + "/";
 							}
 							Object.keys(settings.navigation || {}).forEach(function(sNavName) {
 								// Check if it's a navigation property
@@ -250,13 +251,12 @@ sap.ui.define(
 											that._mTargets[sTargetName].options.settings &&
 											!that._mTargets[sTargetName].options.settings.fullContextPath
 										) {
-											var targetNav;
-											if (sNavName.startsWith("/")) {
-												targetNav = sNavName;
+											if (target.viewLevel === 0) {
+												that._mTargets[sTargetName].options.settings.fullContextPath = "/" + sNavName + "/";
 											} else {
-												targetNav = settings.fullContextPath + sNavName;
+												that._mTargets[sTargetName].options.settings.fullContextPath =
+													settings.fullContextPath + sNavName + "/";
 											}
-											that._mTargets[sTargetName].options.settings.fullContextPath = targetNav + "/";
 										}
 									});
 								}
@@ -365,6 +365,7 @@ sap.ui.define(
 				var oParametersPromise;
 				try {
 					var sContextPath = oContext.getPath();
+					var oMetaModel = oContext.getModel().getMetaModel();
 					var aContextPathParts = sContextPath.split("/");
 					var aAllResolvedParameterPromises = Object.keys(mParameters).map(
 						function(sParameterKey) {
@@ -377,7 +378,14 @@ sap.ui.define(
 								// We go up the current context path as many times as necessary
 								var aLocalParts = aContextPathParts.slice(0, aContextPathParts.length - aRelativeParts.length + 1);
 								aLocalParts.push(aRelativeParts[aRelativeParts.length - 1]);
-								return oContext.requestProperty(aLocalParts.join("/"));
+
+								var sPropertyPath = aLocalParts.join("/");
+								var oMetaContext = oMetaModel.getMetaContext(sPropertyPath);
+								return oContext.requestProperty(sPropertyPath).then(function(oValue) {
+									var oPropertyInfo = oMetaContext.getObject();
+									var sEdmType = oPropertyInfo.$Type;
+									return ODataUtils.formatLiteral(oValue, sEdmType);
+								});
 							});
 
 							return Promise.all(aResolvedParameterPromises).then(
@@ -425,7 +433,8 @@ sap.ui.define(
 			 * @param {boolean} [mParameters.bPersistOPScroll] The bPersistOPScroll will be used for scrolling to first tab
 			 * @param {number} [mParameters.updateFCLLevel] `+1` if we add a column in FCL, `-1` to remove a column, 0 to stay on the same column
 			 * @param {boolean} [mParameters.noPreservationCache] Do navigation without taking into account the preserved cache mechanism
-			 * @param {boolean} [mParameters.bRecreateContext] Force re-creation of the context instaed of using the one passed as parameter
+			 * @param {boolean} [mParameters.bRecreateContext] Force re-creation of the context instead of using the one passed as parameter
+			 * @param {boolean} [mParameters.bForceFocus] Forces focus selection after navigation
 			 * @param {object} [oViewData] View data
 			 * @param {object} [oCurrentTargetInfo] The target information from which the navigation is triggered
 			 * @returns {Promise} Promise which is resolved once the navigation is triggered
@@ -485,10 +494,7 @@ sap.ui.define(
 						mEventParameters.routeInformation = this._getRouteInformation(this.sCurrentRouteName);
 						mEventParameters.routePattern = this.sCurrentRoutePattern;
 						mEventParameters.views = this.aCurrentViews;
-
-						// Store a fake focus information for the current hash, so that the logic to find the first editable / clickable
-						// element in the OP gets triggered
-						this.oRouterProxy.storeFocusForHash(0, null, this.oRouterProxy.getHash());
+						this.oRouterProxy.setFocusForced(mParameters.bForceFocus);
 
 						this._fireRouteMatchEvents(mEventParameters);
 
@@ -531,7 +537,35 @@ sap.ui.define(
 						}.bind(this)
 					);
 				}
-				return this.oRouterProxy.navToHash(sTargetPath, false, mParameters.noPreservationCache);
+
+				var that = this;
+				return this.oRouterProxy
+					.navToHash(sTargetPath, false, mParameters.noPreservationCache, mParameters.bForceFocus)
+					.then(function(bNavigated) {
+						if (!bNavigated) {
+							// The navigation did not happen --> remove the navigation parameters from the queue as they shouldn't be used
+							that.navigationInfoQueue.pop();
+						}
+					});
+			},
+
+			/**
+			 * Navigates to a route.
+			 *
+			 * @function
+			 * @name sap.fe.core.controllerextensions.Routing#navigateToRoute
+			 * @memberof sap.fe.core.controllerextensions.Routing
+			 * @static
+			 * @param {string} [sTargetRouteName] Name of the target route
+			 * @param {object} [oRouteParameters] Parameters to be used with route to create the target hash
+			 * @returns {Promise} Promise that is resolved when the navigation is finalized
+			 *
+			 * @ui5-restricted
+			 * @final
+			 */
+			navigateToRoute: function(sTargetRouteName, oRouteParameters) {
+				var sTargetURL = this.oRouter.getURL(sTargetRouteName, oRouteParameters);
+				return this.oRouterProxy.navToHash(sTargetURL);
 			},
 
 			/**
@@ -773,14 +807,15 @@ sap.ui.define(
 					.getStartupParameters()
 					.then(function(oStartupParameters) {
 						var bHasStartUpParameters = oStartupParameters !== undefined && Object.keys(oStartupParameters).length !== 0;
+						var sHash = that.oRouter.getHashChanger().getHash();
 						// Manage startup parameters (in case of no iapp-state)
-						if (!bIsIappState && bHasStartUpParameters) {
-							var sHash = that.oRouter.getHashChanger().getHash();
-							if (oStartupParameters.preferredMode && oStartupParameters.preferredMode[0] === "create" && !sHash) {
-								// Logic for create mode
-								return that._managePreferredModeCreateStartup();
+						if (!bIsIappState && bHasStartUpParameters && !sHash) {
+							if (oStartupParameters.preferredMode && oStartupParameters.preferredMode[0].indexOf("create") !== -1) {
+								// Create mode
+								return that._manageCreateStartup(oStartupParameters);
 							} else {
-								return that._manageDeeplinkStartup(oStartupParameters);
+								// Deep link
+								return that._manageDeepLinkStartup(oStartupParameters);
 							}
 						}
 					})
@@ -791,317 +826,52 @@ sap.ui.define(
 				return initPromise;
 			},
 
-			getDefaultCreateHash: function() {
-				var sContextPath = this.getContextPath();
-				var sHash = sContextPath.substring(1) + "(...)?i-action=create";
-				if (this.oRouter.getRouteInfoByHash(sHash)) {
-					return sHash;
-				} else {
-					throw new Error("No route match for creating a new " + sContextPath.substring(1));
-				}
+			getDefaultCreateHash: function(oStartupParameters) {
+				return AppStartupHelper.getDefaultCreateHash(oStartupParameters, this.getContextPath(), this.oRouter);
 			},
 
-			_managePreferredModeCreateStartup: function() {
+			_manageCreateStartup: function(oStartupParameters) {
 				var that = this;
-				return this.oMetaModel
-					.requestObject(this.getContextPath() + "@")
-					.then(function(oEntitySetAnnotations) {
-						var sMetaPath,
-							bCreatable = true;
-						if (
-							oEntitySetAnnotations["@com.sap.vocabularies.Common.v1.DraftRoot"] &&
-							oEntitySetAnnotations["@com.sap.vocabularies.Common.v1.DraftRoot"]["NewAction"]
-						) {
-							sMetaPath =
-								that.getContextPath() +
-								"@com.sap.vocabularies.Common.v1.DraftRoot/NewAction@Org.OData.Core.V1.OperationAvailable";
-						} else if (
-							oEntitySetAnnotations["@com.sap.vocabularies.Session.v1.StickySessionSupported"] &&
-							oEntitySetAnnotations["@com.sap.vocabularies.Session.v1.StickySessionSupported"]["NewAction"]
-						) {
-							sMetaPath =
-								that.getContextPath() +
-								"@com.sap.vocabularies.Session.v1.StickySessionSupported/NewAction@Org.OData.Core.V1.OperationAvailable";
-						}
-						if (sMetaPath) {
-							var bNewActionOperationAvailable = that.oMetaModel.getObject(sMetaPath);
-							if (bNewActionOperationAvailable === false) {
-								bCreatable = false;
-							}
-						} else {
-							var oInsertRestrictions = oEntitySetAnnotations["@Org.OData.Capabilities.V1.InsertRestrictions"];
-							if (oInsertRestrictions && oInsertRestrictions.Insertable === false) {
-								bCreatable = false;
-							}
-						}
-						if (bCreatable) {
-							var sPath = that.getDefaultCreateHash();
-							that.oRouter.getHashChanger().replaceHash(sPath);
-							that.bExitOnNavigateBackToRoot = true;
-						}
-					})
-					.catch(function() {
-						Log.error("Cannot fetch the Annotations");
-					});
-			},
 
-			_manageDeeplinkStartup: function(oStartUpParameters) {
-				var that = this,
-					aExternallyNavigablePages;
-
-				// Need to preload the entity set informations in the metamodel
-				return this.oMetaModel
-					.requestObject("/$EntityContainer/")
-					.then(function() {
-						// Check if semantic keys are present in url parameters for every object page at each level
-						var oLevelOfObjectPages = that._getNavigablePages(that.oAppComponent.getManifest()["sap.ui5"].routing);
-
-						aExternallyNavigablePages = that._findTargetPagesFromStartupParams(oLevelOfObjectPages, oStartUpParameters);
-
-						// Load the respective objects for all object pages found in the previous step
-						var aContextPromises = aExternallyNavigablePages.map(function(oPage) {
-							var oCompleteFilter, oListBind;
-							if (oPage.isSemanticKeyNavigation) {
-								oCompleteFilter = that._createFilter(oPage.draft, oPage.semanticKeys, oStartUpParameters);
-							} else {
-								oCompleteFilter = that._createFilter(oPage.draft, oPage.technicalKeys, oStartUpParameters);
-							}
-							oListBind = that.oModel.bindList(oPage.contextPath, undefined, undefined, oCompleteFilter);
-							return oListBind.requestContexts(0, 2);
-						});
-
-						return Promise.all(aContextPromises);
-					})
-					.then(function(aValues) {
-						if (aValues.length) {
-							// Make sure we only get 1 context per promise, and flatten the array
-							var aContexts = [];
-							aValues.forEach(function(aFoundContexts) {
-								if (aFoundContexts.length === 1) {
-									aContexts.push(aFoundContexts[0]);
-								}
-							});
-
-							// Keep hash if navigation has been done, navigation takes precedence over Startup parameters
-							if (aContexts.length === aValues.length && !that.oRouter.getHashChanger().getHash()) {
-								var sHash = that._buildStartupHash(aExternallyNavigablePages, aContexts);
-								if (sHash) {
-									//Replace the hash with newly created hash
-									that.oRouter.getHashChanger().replaceHash(sHash);
-								}
-							}
+				return AppStartupHelper.getCreateStartupHash(oStartupParameters, that.getContextPath(), that.oRouter, that.oMetaModel).then(
+					function(sNewHash) {
+						if (sNewHash) {
+							that.oRouter.getHashChanger().replaceHash(sNewHash);
+							that.bExitOnNavigateBackToRoot = true;
 						}
-					})
-					.catch(function(error) {
-						Log.info("Could not find results for list bind: " + error);
-					});
-			},
-
-			_getNavigablePages: function(oRouting) {
-				var aRoutes = oRouting.routes,
-					oTargets = oRouting.targets,
-					mPageMap = {};
-				for (var i = 0; i < aRoutes.length; i++) {
-					var oPage = {},
-						sPattern = aRoutes[i].pattern,
-						sTarget = aRoutes[i].target,
-						iLevel = sPattern.split("/").length - 1;
-					oPage["pattern"] = sPattern;
-					if (sPattern === ":?query:" || sPattern === "") {
-						continue;
-					}
-					if (iLevel === 1 && sPattern.split("/")[iLevel] === ":?query:") {
-						iLevel = 0;
 					}
-					oPage["level"] = iLevel;
-					if (Array.isArray(sTarget)) {
-						//target is Array in case of FCL
-						oPage["target"] = sTarget[sTarget.length - 1];
-					} else {
-						oPage["target"] = sTarget;
-					}
-					if (oTargets[oPage.target].options && oTargets[oPage.target].options.settings) {
-						oPage["allowDeepLinking"] = oTargets[oPage.target].options.settings.allowDeepLinking;
-						var sContextPath =
-							oTargets[oPage.target].options.settings.contextPath ||
-							(oTargets[oPage.target].options.settings.entitySet && "/" + oTargets[oPage.target].options.settings.entitySet);
-						oPage["contextPath"] = sContextPath;
-					}
-					if (!oPage["allowDeepLinking"] && oPage["level"] !== 0) {
-						continue;
-					} else if (!mPageMap[oPage.level]) {
-						mPageMap[oPage.level] = [];
-					}
-					mPageMap[oPage.level].push(oPage);
-				}
-				return mPageMap;
+				);
 			},
 
-			/**
-			 * For each level (starting at 0), find the first object page corresponding to an object
-			 * that can be determined with the keys passed as startup parameters.
-			 * Stop when no OP that can be can be found for a given level.
-			 *
-			 * @param {object} mPagesByLevel A map (level --> array of pages at that level)
-			 * @param {object} oStartupParameters The startup parameters of the application
-			 * @returns {Array} Array of all pages that can be reached with the provided parameters
-			 */
-			_findTargetPagesFromStartupParams: function(mPagesByLevel, oStartupParameters) {
-				var iLevel = 0,
-					aReachablePages = [],
-					bFound = true;
-
-				while (bFound && iLevel in mPagesByLevel) {
-					var aObjectPages = mPagesByLevel[iLevel];
-
-					// loop through pages at each level
-					// use for-loop to break early
-					bFound = false;
-					for (var i = 0; i < aObjectPages.length; ++i) {
-						var oObjectPage = aObjectPages[i];
-						if (!oObjectPage.contextPath && oObjectPage.level === 0) {
-							oObjectPage.contextPath = this.getContextPath();
-						}
-						if (!oObjectPage.contextPath) {
-							continue;
-						}
-
-						oObjectPage.entityType = this.oMetaModel.getObject("/$EntityContainer" + oObjectPage.contextPath + "/");
-						oObjectPage.draft =
-							this.oMetaModel.getObject(
-								"/$EntityContainer" + oObjectPage.contextPath + "@com.sap.vocabularies.Common.v1.DraftRoot"
-							) ||
-							this.oMetaModel.getObject(
-								"/$EntityContainer" + oObjectPage.contextPath + "@com.sap.vocabularies.Common.v1.DraftNode"
-							);
-						oObjectPage.technicalKeys = oObjectPage.entityType["$Key"];
-						oObjectPage.semanticKeys = this.oMetaModel.getObject(
-							"/$EntityContainer" + oObjectPage.contextPath + "/@com.sap.vocabularies.Common.v1.SemanticKey"
-						);
-
-						if (this._checkForKeys(oObjectPage.semanticKeys, oStartupParameters)) {
-							// make record if semantic keys are available in URL params
-							oObjectPage.isSemanticKeyNavigation = true;
-							aReachablePages.push(oObjectPage);
-							bFound = true;
-							break;
-						} else if (oObjectPage.level === 0 && this._checkForKeys(oObjectPage.technicalKeys, oStartupParameters)) {
-							// Support for Technical Keys for root level object page
-							oObjectPage.isSemanticKeyNavigation = false;
-							aReachablePages.push(oObjectPage);
-							bFound = true;
-							break;
-						}
-					}
-
-					++iLevel;
-				}
-
-				return aReachablePages;
-			},
+			_manageDeepLinkStartup: function(oStartupParameters) {
+				var that = this;
 
-			/**
-			 * Creates the filter for the entity set.
-			 *
-			 * @param {object} oDraftDetail The details of draft node
-			 * @param {Array} aKeys Array of semantic keys or technical keys of the page
-			 * @param {object} oStartUpParameters URL parameters
-			 * @returns {object} Filters for the entity set
-			 */
-			_createFilter: function(oDraftDetail, aKeys, oStartUpParameters) {
-				var aFilters = [],
-					bFilteringCaseSensitive = ModelHelper.isFilteringCaseSensitive(this.oMetaModel);
-
-				for (var j = 0; j < aKeys.length; j++) {
-					var sProperty = aKeys[j].$PropertyPath;
-					if (!sProperty) {
-						// Technical Keys Scenario
-						sProperty = aKeys[j];
-						if (sProperty === "IsActiveEntity") {
-							oDraftDetail = false;
+				return AppStartupHelper.getDeepLinkStartupHash(
+					this.oAppComponent.getManifest()["sap.ui5"].routing,
+					oStartupParameters,
+					this.oModel
+				).then(function(oDeepLink) {
+					var sHash;
+					if (oDeepLink.context) {
+						var sTechnicalPath = oDeepLink.context.getPath(),
+							sSemanticPath = SemanticKeyHelper.getSemanticPath(oDeepLink.context);
+
+						if (sSemanticPath !== sTechnicalPath) {
+							// Store the mapping technical <-> semantic path to avoid recalculating it later
+							// and use the semantic path instead of the technical one
+							that.setLastSemanticMapping({ technicalPath: sTechnicalPath, semanticPath: sSemanticPath });
 						}
-					}
-					var sValue = oStartUpParameters[sProperty][0];
-					if (sValue) {
-						aFilters.push(
-							new Filter({
-								path: sProperty,
-								operator: FilterOperator.EQ,
-								value1: sValue,
-								caseSensitive: bFilteringCaseSensitive
-							})
-						);
-					} else {
-						return undefined;
-					}
-				}
-				if (oDraftDetail) {
-					var oDraftFilter = new Filter({
-						filters: [new Filter("IsActiveEntity", "EQ", false), new Filter("SiblingEntity/IsActiveEntity", "EQ", null)],
-						and: false
-					});
-					aFilters.push(oDraftFilter);
-				}
-				var oCompleteFilter = new Filter(aFilters, true);
-				return oCompleteFilter;
-			},
 
-			/**
-			 * Check for Semantic Keys/ Technical Keys in the URL.
-			 *
-			 * @param {Array} aKeys Array of semantic keys or technical keys of the page
-			 * @param {object} oParameters URL parameters
-			 * @returns {boolean} True if Semantic Keys are available in URL
-			 */
-			_checkForKeys: function(aKeys, oParameters) {
-				if (aKeys && aKeys.length) {
-					for (var j = 0; j < aKeys.length; j++) {
-						var sPropertyPath = aKeys[j].$PropertyPath;
-						if (!sPropertyPath) {
-							// Technical Keys do not require $ProperyPath
-							sPropertyPath = aKeys[j];
-						}
-						var aPropertyValue = oParameters[sPropertyPath];
-						if (!aPropertyValue || (aPropertyValue && aPropertyValue.length > 1)) {
-							return false;
-						}
+						sHash = sSemanticPath.substring(1); // To remove the leading '/'
+					} else if (oDeepLink.hash) {
+						sHash = oDeepLink.hash;
 					}
-					return true;
-				}
-				return false;
-			},
-
-			_buildStartupHash: function(aReachablePages, aContexts) {
-				var sHash;
 
-				if (aContexts.length === 1) {
-					// Navigation to first-level object page
-					// We check if we have to use a semantic path
-					var sTechnicalPath = aContexts[0].getPath(),
-						sSemanticPath = SemanticKeyHelper.getSemanticPath(aContexts[0]);
-
-					if (sSemanticPath !== sTechnicalPath) {
-						// Store the mapping technical <-> semantic path to avoid recalculating it later
-						// and use the semantic path instead of the technical one
-						this.setLastSemanticMapping({ technicalPath: sTechnicalPath, semanticPath: sSemanticPath });
+					if (sHash) {
+						//Replace the hash with newly created hash
+						that.oRouter.getHashChanger().replaceHash(sHash);
 					}
-
-					sHash = sSemanticPath.substring(1); // To remove the leading '/'
-				} else if (aContexts.length > 1) {
-					// Navigation to a deeper level --> use the pattern of the deepest object page
-					// and replace the parameters by the ID from the contexts
-					var aParts = aReachablePages[aReachablePages.length - 1].pattern.split("/");
-
-					sHash = aParts
-						.map(function(sPart, iIndex) {
-							var sKey = sPart.split("(")[0];
-							var sValue = aContexts[iIndex].getPath().split("(")[1];
-							return sKey + "(" + sValue; // sValue contains the closing ')'
-						})
-						.join("/");
-				}
-
-				return sHash;
+				});
 			},
 
 			getOutbounds: function() {