@sapui5/sap.fe.core 1.95.0 → 1.98.0

package/src/sap/fe/core/helpers/KeepAliveHelper.ts

@@ -0,0 +1,202 @@
+import { Control } from "sap/ui/core";
+import { View } from "sap/ui/core/mvc";
+import { Log } from "sap/base";
+import { ODataMetaModel } from "sap/ui/model/odata/v4";
+import { getEntitySetPath } from "sap/fe/core/helpers/ModelHelper";
+import { BaseManifestSettings } from "sap/fe/core/converters/ManifestSettings";
+import { JSONModel } from "sap/ui/model/json";
+import {
+	RefreshStrategyType,
+	SORefreshStrategy,
+	RefreshStrategies,
+	PATH_TO_STORE,
+	SOAction
+} from "sap/fe/core/helpers/KeepAliveRefreshTypes";
+
+// Private functions - start
+const _fnSimplifyEntitySetPath = function(metaModel: ODataMetaModel, entitySetPathToUse: string): string {
+	const entitySetPath = getEntitySetPath(entitySetPathToUse);
+	const entitySet = entitySetPath.indexOf("$NavigationPropertyBinding") > -1 && metaModel.getObject(entitySetPath);
+	return entitySet ? "/" + entitySet : entitySetPathToUse;
+};
+const _fnIsApplicable = function(primaryPath: string, key: string, strategy: RefreshStrategyType): boolean {
+	return primaryPath === key || (strategy === RefreshStrategyType.IncludingDependents && primaryPath.startsWith(key));
+};
+/**
+ * Check if given path resides in the context path provided.
+ *
+ * @param {ODataMetaModel} metaModel MetaModel to be used
+ * @param {string} contextPath Context path to be used
+ * @param {string} path Path to be used
+ * @param {RefreshStrategyType} strategy Strategy, it could be 'self' | 'includingDependents'
+ * @returns {boolean} Returns true if the context path is applicable.
+ */
+const _isPathApplicableToContextPath = function(
+	metaModel: ODataMetaModel,
+	contextPath: string,
+	path: string,
+	strategy: RefreshStrategyType
+): boolean {
+	let contextPathToCheck = contextPath.startsWith("/") ? contextPath : "/" + contextPath,
+		pathToCheck = path.startsWith("/") ? path : "/" + path;
+	if (!_fnIsApplicable(contextPathToCheck, pathToCheck, strategy)) {
+		contextPathToCheck = _fnSimplifyEntitySetPath(metaModel, contextPathToCheck);
+		if (!_fnIsApplicable(contextPathToCheck, pathToCheck, strategy)) {
+			pathToCheck = _fnSimplifyEntitySetPath(metaModel, pathToCheck);
+		} else {
+			return true;
+		}
+	}
+	return _fnIsApplicable(contextPathToCheck, pathToCheck, strategy);
+};
+// Private functions - end
+/**
+ * Get controls to refresh in a view.
+ *
+ * @param {View} view View of the controls
+ * @param {Control[]} controls Context path to be used
+ * @returns {Control[]} Returns controls that need to be refreshed.
+ */
+const getControlsForRefresh = function(view: View, controls: Control[]): Control[] {
+	const controlsForRefresh: Control[] = [];
+	const metaModel = view.getModel().getMetaModel() as ODataMetaModel;
+	const internalModel = view.getModel("internal");
+	const refreshStrategy = internalModel.getProperty(PATH_TO_STORE) || {};
+	if (controls) {
+		controls.forEach(function(control) {
+			const contextPath = control.data("targetCollectionPath");
+			for (const key in refreshStrategy) {
+				const strategy = refreshStrategy[key];
+				if (controlsForRefresh.indexOf(control) === -1 && _isPathApplicableToContextPath(metaModel, contextPath, key, strategy)) {
+					controlsForRefresh.push(control);
+				}
+			}
+		});
+	}
+	return controlsForRefresh;
+};
+/**
+ * Get refresh strategy for the control for a context path.
+ *
+ * @param {Control} control Control from which refresh info is needed
+ * @param {string} contextPath ContextPath for properities
+ * @returns {RefreshStrategyType} Returns strategy for control refresh.
+ */
+const getControlRefreshStrategyForContextPath = function(control: Control, contextPath: string): RefreshStrategyType | undefined {
+	const metaModel = control.getModel().getMetaModel() as ODataMetaModel;
+	const internalModel = control.getModel("internal");
+	const refreshStrategy = internalModel.getProperty(PATH_TO_STORE) || {};
+	let strategy;
+	if (contextPath) {
+		for (const key in refreshStrategy) {
+			const strategyToCheck = refreshStrategy[key];
+			if (_isPathApplicableToContextPath(metaModel, contextPath, key, strategyToCheck)) {
+				strategy = strategyToCheck;
+				if (strategy === "includingDependents") {
+					break;
+				}
+			}
+		}
+	}
+	return strategy;
+};
+/**
+ * Get refresh info from view.
+ *
+ * @param {View} view View from which refresh info is needed
+ * @returns {RefreshStrategyType | undefined} Returns strategy for view refresh.
+ */
+const getViewRefreshInfo = function(view: View): RefreshStrategyType | undefined {
+	const viewData = view.getViewData() as BaseManifestSettings,
+		contextPath = viewData && (viewData?.contextPath || "/" + viewData?.entitySet);
+	return KeepAliveHelper.getControlRefreshStrategyForContextPath(view, contextPath);
+};
+
+/**
+ * Get refresh strategy for an intent.
+ *
+ * @param {RefreshStrategies} refreshStrategies RefreshStrategies to consider
+ * @param {string} semanticObject Outbound Semantic Object
+ * @param {string} action Outbound Action
+ * @returns {SORefreshStrategy | undefined} Returns refresh strategies to use for the intent.
+ */
+const getRefreshStrategyForIntent = function(
+	refreshStrategies: RefreshStrategies,
+	semanticObject?: string,
+	action?: string
+): SORefreshStrategy | undefined {
+	const soAction = semanticObject && action && semanticObject + "-" + action;
+	const intents = refreshStrategies.intents;
+	const soActionIntentMatch = intents && soAction && intents[soAction];
+	const soIntentMatch = !soActionIntentMatch && intents && semanticObject && intents[semanticObject];
+
+	return soActionIntentMatch || soIntentMatch || refreshStrategies?.defaultBehavior || refreshStrategies?._feDefault;
+};
+/**
+ * Store control refresh strategy for hash in the internal model.
+ *
+ * @param {Control} control Control for the refresh strategy
+ * @param {SOAction} hash Shell hash object
+ */
+const storeControlRefreshStrategyForHash = function(control: Control, hash: SOAction): void {
+	if (control && control.getModel("viewData") && control.getModel("internal")) {
+		const viewData = control.getModel("viewData");
+		const refreshStrategies: RefreshStrategies = viewData.getProperty(PATH_TO_STORE);
+		if (refreshStrategies) {
+			const internalModel = control.getModel("internal");
+			const refreshStrategy: SORefreshStrategy | undefined = KeepAliveHelper.getRefreshStrategyForIntent(
+				refreshStrategies,
+				hash?.semanticObject,
+				hash?.action
+			);
+			(internalModel as JSONModel<{}>).setProperty(PATH_TO_STORE, refreshStrategy);
+		}
+	}
+};
+
+/**
+ * Method to refresh and restore the view if neccessary.
+ *
+ * @param {object} view Control for the refresh strategy
+ * @returns {object} A promise after view refresh and restore are triggered
+ */
+const restoreView = function(view: View): Promise<any> {
+	const internalModelContext = view.getBindingContext("internal");
+	const controller = view.getController();
+	const viewState = (controller as any)?.viewState;
+	let refreshBindings = Promise.resolve();
+	if (internalModelContext && internalModelContext.getProperty("restoreStatus") === "pending") {
+		if (viewState.refreshViewBindings) {
+			refreshBindings = viewState.refreshViewBindings();
+			refreshBindings
+				.then(function() {
+					Log.info("FE V4: Refresh was triggered successfull: " + view.getId());
+				})
+				.catch(function(err) {
+					Log.warning("FE V4: Refresh was unsuccessfull: " + view.getId(), err);
+				});
+		}
+		refreshBindings = refreshBindings
+			.then(function() {
+				viewState.onRestore();
+				internalModelContext.setProperty("restoreStatus", "done");
+			})
+			.catch(function(error) {
+				Log.warning("FE V4: Restore was unsuccessfull: " + view.getId(), error);
+			});
+	}
+	return refreshBindings;
+};
+
+/**
+ * helper class for KeepAlive feature in sap.fe.
+ */
+const KeepAliveHelper = {
+	getControlsForRefresh,
+	getControlRefreshStrategyForContextPath,
+	getViewRefreshInfo,
+	getRefreshStrategyForIntent,
+	storeControlRefreshStrategyForHash,
+	restoreView
+};
+export default KeepAliveHelper;

package/src/sap/fe/core/helpers/KeepAliveRefreshTypes.js

@@ -0,0 +1,32 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+ *      (c) Copyright 2009-2021 SAP SE. All rights reserved
+ */
+sap.ui.define([], function () {
+  "use strict";
+
+  var _exports = {};
+
+  /**
+   * Enumeration for supported refresh strategy type
+   */
+  var RefreshStrategyType;
+  /**
+   * Configuration of a RefreshStrategy
+   */
+
+  (function (RefreshStrategyType) {
+    RefreshStrategyType["Self"] = "self";
+    RefreshStrategyType["IncludingDependents"] = "includingDependents";
+  })(RefreshStrategyType || (RefreshStrategyType = {}));
+
+  _exports.RefreshStrategyType = RefreshStrategyType;
+
+  /**
+   * Path used to store information
+   */
+  var PATH_TO_STORE = "/refreshStrategyOnAppRestore";
+  _exports.PATH_TO_STORE = PATH_TO_STORE;
+  return _exports;
+}, false);
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIktlZXBBbGl2ZVJlZnJlc2hUeXBlcy50cyJdLCJuYW1lcyI6WyJSZWZyZXNoU3RyYXRlZ3lUeXBlIiwiUEFUSF9UT19TVE9SRSJdLCJtYXBwaW5ncyI6IjtBQUFBO0FBQ0E7QUFDQTs7Ozs7O0FBRkE7QUFDQTtBQUNBO01BQ1lBLG1CO0FBSVo7QUFDQTtBQUNBOzthQU5ZQSxtQjtBQUFBQSxJQUFBQSxtQjtBQUFBQSxJQUFBQSxtQjtLQUFBQSxtQixLQUFBQSxtQjs7OztBQTZCWjtBQUNBO0FBQ0E7QUFDTyxNQUFNQyxhQUFxQixHQUFHLDhCQUE5QiIsInNvdXJjZVJvb3QiOiIuIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBFbnVtZXJhdGlvbiBmb3Igc3VwcG9ydGVkIHJlZnJlc2ggc3RyYXRlZ3kgdHlwZVxuICovXG5leHBvcnQgZW51bSBSZWZyZXNoU3RyYXRlZ3lUeXBlIHtcblx0U2VsZiA9IFwic2VsZlwiLFxuXHRJbmNsdWRpbmdEZXBlbmRlbnRzID0gXCJpbmNsdWRpbmdEZXBlbmRlbnRzXCJcbn1cbi8qKlxuICogQ29uZmlndXJhdGlvbiBvZiBhIFJlZnJlc2hTdHJhdGVneVxuICovXG5leHBvcnQgdHlwZSBTT1JlZnJlc2hTdHJhdGVneSA9IHtcblx0W2VudGl0eVNldE5hbWVPckNvbnRleHRQYXRoOiBzdHJpbmddOiBSZWZyZXNoU3RyYXRlZ3lUeXBlO1xufTtcbi8qKlxuICogQ29uZmlndXJhdGlvbiBvZiBhIFJlZnJlc2hTdHJhdGVnaWVzXG4gKi9cbmV4cG9ydCB0eXBlIFJlZnJlc2hTdHJhdGVnaWVzID0ge1xuXHRpbnRlbnRzPzoge1xuXHRcdFtzb0FjdGlvbjogc3RyaW5nXTogU09SZWZyZXNoU3RyYXRlZ3k7IC8vICdzb0FjdGlvbicgZm9ybWF0IGlzIFwiPFNlbWFudGljT2JqZWN0Pi08QWN0aW9uPlwiXG5cdH07XG5cdGRlZmF1bHRCZWhhdmlvcj86IFNPUmVmcmVzaFN0cmF0ZWd5O1xuXHRfZmVEZWZhdWx0PzogU09SZWZyZXNoU3RyYXRlZ3k7XG59O1xuXG4vKipcbiAqIENvbmZpZ3VyYXRpb24gZm9yIGhhc2ggd2l0aCBzZW1hbnRpY09iamVjdCBhbmQgYWN0aW9uXG4gKi9cbmV4cG9ydCB0eXBlIFNPQWN0aW9uID0ge1xuXHRzZW1hbnRpY09iamVjdD86IHN0cmluZztcblx0YWN0aW9uPzogc3RyaW5nO1xufTtcblxuLyoqXG4gKiBQYXRoIHVzZWQgdG8gc3RvcmUgaW5mb3JtYXRpb25cbiAqL1xuZXhwb3J0IGNvbnN0IFBBVEhfVE9fU1RPUkU6IHN0cmluZyA9IFwiL3JlZnJlc2hTdHJhdGVneU9uQXBwUmVzdG9yZVwiO1xuIl19

package/src/sap/fe/core/helpers/KeepAliveRefreshTypes.ts

@@ -0,0 +1,36 @@
+/**
+ * Enumeration for supported refresh strategy type
+ */
+export enum RefreshStrategyType {
+	Self = "self",
+	IncludingDependents = "includingDependents"
+}
+/**
+ * Configuration of a RefreshStrategy
+ */
+export type SORefreshStrategy = {
+	[entitySetNameOrContextPath: string]: RefreshStrategyType;
+};
+/**
+ * Configuration of a RefreshStrategies
+ */
+export type RefreshStrategies = {
+	intents?: {
+		[soAction: string]: SORefreshStrategy; // 'soAction' format is "<SemanticObject>-<Action>"
+	};
+	defaultBehavior?: SORefreshStrategy;
+	_feDefault?: SORefreshStrategy;
+};
+
+/**
+ * Configuration for hash with semanticObject and action
+ */
+export type SOAction = {
+	semanticObject?: string;
+	action?: string;
+};
+
+/**
+ * Path used to store information
+ */
+export const PATH_TO_STORE: string = "/refreshStrategyOnAppRestore";