@sap-ux/preview-middleware 0.23.54 → 0.23.55

package/dist/client/cpe/additional-change-info/add-xml-additional-info.js

@@ -4,6 +4,7 @@ sap.ui.define(["../../utils/core", "../../adp/quick-actions/control-types"], fun
   "use strict";
 
   const getControlById = ____utils_core["getControlById"];
+  const findViewByControl = ____utils_core["findViewByControl"];
   const ANALYTICAL_TABLE_TYPE = ____adp_quick_actions_control_types["ANALYTICAL_TABLE_TYPE"];
   const GRID_TABLE_TYPE = ____adp_quick_actions_control_types["GRID_TABLE_TYPE"];
   const MDC_TABLE_TYPE = ____adp_quick_actions_control_types["MDC_TABLE_TYPE"];
@@ -11,20 +12,20 @@ sap.ui.define(["../../utils/core", "../../adp/quick-actions/control-types"], fun
   function getAddXMLAdditionalInfo(change) {
     const selectorId = change.getSelector()?.id ?? '';
     const targetAggregation = change.getContent()?.targetAggregation ?? '';
-    const controlType = getControlById(selectorId)?.getMetadata().getName() ?? '';
+    const targetControl = getControlById(selectorId);
+    const controlType = targetControl?.getMetadata().getName() ?? '';
     const templateName = getFragmentTemplateName(selectorId, targetAggregation);
+    const viewName = targetControl ? findViewByControl(targetControl)?.getViewName() ?? '' : '';
+    const result = {};
     if (templateName) {
-      return {
-        templateName
-      };
+      result.templateName = templateName;
     }
-    if (controlType && targetAggregation) {
-      return {
-        targetAggregation,
-        controlType
-      };
+    if (controlType && targetAggregation && viewName) {
+      result.targetAggregation = targetAggregation;
+      result.controlType = controlType;
+      result.viewName = viewName;
     }
-    return undefined;
+    return Object.keys(result).length > 0 ? result : undefined;
   }
   function getFragmentTemplateName(selectorId, targetAggregation) {
     const control = getControlById(selectorId);

package/dist/client/cpe/additional-change-info/add-xml-additional-info.ts

@@ -1,5 +1,5 @@
 import FlexChange from 'sap/ui/fl/Change';
-import { getControlById } from '../../utils/core';
+import { getControlById, findViewByControl } from '../../utils/core';
 import {
     ANALYTICAL_TABLE_TYPE,
     GRID_TABLE_TYPE,
@@ -12,6 +12,7 @@ export type AddXMLAdditionalInfo = {
     templateName?: string;
     targetAggregation?: string;
     controlType?: string;
+    viewName?: string;
 };
 
 export type AddXMLChangeContent = {
@@ -21,15 +22,22 @@ export type AddXMLChangeContent = {
 export function getAddXMLAdditionalInfo(change: FlexChange<AddXMLChangeContent>): AddXMLAdditionalInfo | undefined {
     const selectorId = change.getSelector()?.id ?? '';
     const targetAggregation = change.getContent()?.targetAggregation ?? '';
-    const controlType = getControlById(selectorId)?.getMetadata().getName() ?? '';
+    const targetControl = getControlById(selectorId);
+    const controlType = targetControl?.getMetadata().getName() ?? '';
     const templateName = getFragmentTemplateName(selectorId, targetAggregation);
+    const viewName = targetControl ? (findViewByControl(targetControl)?.getViewName() ?? '') : '';
+
+    const result: AddXMLAdditionalInfo = {};
     if (templateName) {
-        return { templateName };
+        result.templateName = templateName;
     }
-    if (controlType && targetAggregation) {
-        return { targetAggregation, controlType };
+    if (controlType && targetAggregation && viewName) {
+        result.targetAggregation = targetAggregation;
+        result.controlType = controlType;
+        result.viewName = viewName;
     }
-    return undefined;
+    
+    return Object.keys(result).length > 0 ? result : undefined;
 }
 
 export function getFragmentTemplateName(selectorId: string, targetAggregation: string): string {

package/dist/client/cpe/init.js

@@ -1,11 +1,12 @@
 "use strict";
 
-sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../utils/error", "./changes/service", "./communication-service", "./connector-service", "./context-menu-service", "./documentation", "./outline/service", "./quick-actions/quick-action-service", "./rta-service", "./selection", "./ui5-utils"], function (Log, ___sap_ux_private_control_property_editor_common, ___utils_error, ___changes_service, ___communication_service, ___connector_service, ___context_menu_service, ___documentation, ___outline_service, ___quick_actions_quick_action_service, ___rta_service, ___selection, ___ui5_utils) {
+sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../utils/error", "./changes/service", "./communication-service", "./connector-service", "./context-menu-service", "./documentation", "./outline/service", "./quick-actions/quick-action-service", "./rta-service", "./selection", "./ui5-utils", "./odata-health/odata-health-checker", "../utils/info-center-message", "./odata-health/odata-health-status"], function (Log, ___sap_ux_private_control_property_editor_common, ___utils_error, ___changes_service, ___communication_service, ___connector_service, ___context_menu_service, ___documentation, ___outline_service, ___quick_actions_quick_action_service, ___rta_service, ___selection, ___ui5_utils, ___odata_health_odata_health_checker, ___utils_info_center_message, ___odata_health_odata_health_status) {
   "use strict";
 
   const appLoaded = ___sap_ux_private_control_property_editor_common["appLoaded"];
   const enableTelemetry = ___sap_ux_private_control_property_editor_common["enableTelemetry"];
   const iconsLoaded = ___sap_ux_private_control_property_editor_common["iconsLoaded"];
+  const MessageBarType = ___sap_ux_private_control_property_editor_common["MessageBarType"];
   const getError = ___utils_error["getError"];
   const ChangeService = ___changes_service["ChangeService"];
   const CommunicationService = ___communication_service["CommunicationService"];
@@ -17,6 +18,9 @@ sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-privat
   const RtaService = ___rta_service["RtaService"];
   const SelectionService = ___selection["SelectionService"];
   const getIcons = ___ui5_utils["getIcons"];
+  const ODataHealthChecker = ___odata_health_odata_health_checker["ODataHealthChecker"];
+  const sendInfoCenterMessage = ___utils_info_center_message["sendInfoCenterMessage"];
+  const ODataUpStatus = ___odata_health_odata_health_status["ODataUpStatus"];
   function init(rta) {
     let registries = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
     Log.info('Initializing Control Property Editor');
@@ -44,6 +48,25 @@ sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-privat
     const outlineService = new OutlineService(rta, changesService);
     const quickActionService = new QuickActionService(rta, outlineService, registries, changesService);
     const services = [connectorService, selectionService, changesService, contextMenuService, outlineService, rtaService, quickActionService];
+
+    // Do health check to all available oData service instances.
+    const oDataHealthChecker = new ODataHealthChecker(rta);
+    oDataHealthChecker.getHealthStatus().then(healthStatus => healthStatus.map(status => status instanceof ODataUpStatus ? Promise.resolve() : sendInfoCenterMessage({
+      title: {
+        key: 'ADP_ODATA_HEALTH_CHECK_TITLE'
+      },
+      description: {
+        key: 'ADP_ODATA_SERVICE_DOWN_DESCRIPTION',
+        params: [status.serviceUrl, status.errorMessage]
+      },
+      type: MessageBarType.warning
+    }))).catch(error => sendInfoCenterMessage({
+      title: {
+        key: 'ADP_ODATA_HEALTH_CHECK_TITLE'
+      },
+      description: getError(error).message,
+      type: MessageBarType.warning
+    }));
     try {
       loadDefaultLibraries();
       const allPromises = services.map(service => {

package/dist/client/cpe/init.ts

@@ -4,7 +4,8 @@ import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
 import {
     appLoaded,
     enableTelemetry,
-    iconsLoaded
+    iconsLoaded,
+    MessageBarType
 } from '@sap-ux-private/control-property-editor-common';
 
 import { getError } from '../utils/error';
@@ -20,6 +21,9 @@ import { RtaService } from './rta-service';
 import { SelectionService } from './selection';
 import type { ActionHandler, Service } from './types';
 import { getIcons } from './ui5-utils';
+import { ODataHealthChecker } from './odata-health/odata-health-checker';
+import { sendInfoCenterMessage } from '../utils/info-center-message';
+import { ODataUpStatus } from './odata-health/odata-health-status';
 
 export default function init(
     rta: RuntimeAuthoring,
@@ -59,6 +63,32 @@ export default function init(
         quickActionService
     ];
 
+    // Do health check to all available oData service instances.
+    const oDataHealthChecker = new ODataHealthChecker(rta);
+    oDataHealthChecker
+        .getHealthStatus()
+        .then((healthStatus) =>
+            healthStatus.map((status) =>
+                status instanceof ODataUpStatus
+                    ? Promise.resolve()
+                    : sendInfoCenterMessage({
+                          title: { key: 'ADP_ODATA_HEALTH_CHECK_TITLE' },
+                          description: {
+                              key: 'ADP_ODATA_SERVICE_DOWN_DESCRIPTION',
+                              params: [status.serviceUrl, status.errorMessage]
+                          },
+                          type: MessageBarType.warning
+                      })
+            )
+        )
+        .catch((error) =>
+            sendInfoCenterMessage({
+                title: { key: 'ADP_ODATA_HEALTH_CHECK_TITLE' },
+                description: getError(error).message,
+                type: MessageBarType.warning
+            })
+        );
+
     try {
         loadDefaultLibraries();
         const allPromises = services.map((service) => {

package/dist/client/cpe/odata-health/odata-health-checker.js

@@ -0,0 +1,128 @@
+"use strict";
+
+sap.ui.define(["sap/base/Log", "sap/ui/model/odata/v2/ODataModel", "sap/ui/model/odata/v4/ODataModel", "./odata-health-status"], function (Log, ODataModelV2, ODataModelV4, ___odata_health_status) {
+  "use strict";
+
+  const ODataDownStatus = ___odata_health_status["ODataDownStatus"];
+  const ODataUpStatus = ___odata_health_status["ODataUpStatus"];
+  /**
+   * The OData version type.
+   */
+  /**
+   * Describes an OData service instance.
+   */
+  /**
+   * Use this class to do a health check for all available OData services, supports both v2 and v4
+   * format. This health checker ensures not only that $metadata is valid, but also that the UI5 framework
+   * itself can consume the service via its models.
+   */
+  class ODataHealthChecker {
+    /**
+     * The OData type.
+     */
+    static ODATA_TYPE = 'OData';
+
+    /**
+     * The default OData version.
+     */
+    static DEFAULT_ODATA_VERSION = 'v2';
+
+    /**
+     * Use this helper function to filter the OData data source items from the manifest.
+     * @param src The service data source.
+     * @returns True if the data source represents an OData service.
+     */
+    isOdataService = src => src.type === ODataHealthChecker.ODATA_TYPE;
+
+    /**
+     * Use this helper function to map the OData data source to the internal structure
+     * used in this class.
+     * @param src The OData service data source.
+     * @returns The OData service info object.
+     */
+    toOdataServiceInfo = src => ({
+      serviceUrl: src.uri,
+      oDataVersion: src.settings?.odataVersion ?? ODataHealthChecker.DEFAULT_ODATA_VERSION
+    });
+    constructor(rta) {
+      this.rta = rta;
+    }
+
+    /**
+     * Does a health check to all available OData services.
+     *
+     * @returns Resolves with an array containing the health
+     * status for each OData service.
+     */
+    async getHealthStatus() {
+      const oDataHealthCheckStartTime = Date.now();
+      const services = this.getServices();
+      const metadataPromises = await Promise.allSettled(services.map(_ref => {
+        let {
+          serviceUrl,
+          oDataVersion
+        } = _ref;
+        return this.getServiceMetadata(serviceUrl, oDataVersion);
+      }));
+      const oDataHealthCheckDurationInSec = ((Date.now() - oDataHealthCheckStartTime) / 1000).toFixed(2);
+      Log.info(`OData service health check took ${oDataHealthCheckDurationInSec} sec.`);
+      return metadataPromises.map((metadataPromise, idx) => metadataPromise.status === 'fulfilled' ? new ODataUpStatus(services[idx].serviceUrl) : new ODataDownStatus(services[idx].serviceUrl, metadataPromise.reason));
+    }
+
+    /**
+     * This method does a strong health check (with the ODataModel). This ensures not only
+     * that the $metadata is valid, but also that the UI5 framework itself can consume the service via its models.
+     * Some services may have valid $metadata but still fail in the UI5’s ODataModel
+     * (e.g., weird annotations, CORS issues, etc.).
+     *
+     * @param serviceUrl The OData service url.
+     * @param oDataVersion The OData version.
+     * @returns Resolved with valid metadata.
+     */
+    getServiceMetadata(serviceUrl, oDataVersion) {
+      switch (oDataVersion) {
+        case 'v2':
+        case '2.0':
+          return this.getServiceV2Metadata(serviceUrl);
+        case 'v4':
+        case '4.0':
+          return this.getServiceV4Metadata(serviceUrl);
+      }
+    }
+    getServiceV2Metadata(serviceUrl) {
+      const oModel = new ODataModelV2({
+        serviceUrl,
+        json: true,
+        // We do not want the annotations concatenated to the final result.
+        loadAnnotationsJoined: false
+      });
+      // This method actually returns promise which is resolved with the metadata.
+      return oModel.metadataLoaded(true).finally(
+      // Do clean up in case the helath check is done multiple times.
+      () => oModel.destroy());
+    }
+    getServiceV4Metadata(serviceUrl) {
+      const oModel = new ODataModelV4({
+        serviceUrl,
+        // Only metadata loaded. We only want the model to load $metadata,
+        // not fetch entity data or bind to any UI controls.
+        synchronizationMode: 'None'
+      });
+      // This method actually returns promise which is resolved with the metadata.
+      return oModel.getMetaModel().requestObject('/').finally(
+      // Do clean up in case the helath check is done multiple times.
+      () => oModel.destroy());
+    }
+    getServices() {
+      const manifest = this.rta.getRootControlInstance().getManifest();
+      const dataSources = manifest?.['sap.app']?.dataSources;
+      return Object.values(dataSources ?? {}).filter(this.isOdataService).map(this.toOdataServiceInfo);
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.ODataHealthChecker = ODataHealthChecker;
+  return __exports;
+});
+//# sourceMappingURL=odata-health-checker.js.map

package/dist/client/cpe/odata-health/odata-health-checker.ts

@@ -0,0 +1,149 @@
+import type * as ManifestNamespace from '@ui5/manifest/types/manifest';
+import Log from 'sap/base/Log';
+import ODataModelV2 from 'sap/ui/model/odata/v2/ODataModel';
+import ODataModelV4 from 'sap/ui/model/odata/v4/ODataModel';
+import RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
+import { ODataDownStatus, ODataHealthStatus, ODataMetadata, ODataUpStatus } from './odata-health-status';
+
+type Manifest = ManifestNamespace.SAPJSONSchemaForWebApplicationManifestFile;
+type DataSource = ManifestNamespace.DataSource;
+
+/**
+ * The OData version type.
+ */
+type ODataVersion = 'v2' | 'v4' | '2.0' | '4.0';
+
+/**
+ * Describes an OData service instance.
+ */
+interface ODataServiceInfo {
+    /**
+     * The URL of the OData service.
+     */
+    serviceUrl: string;
+    /**
+     * The OData protocol version.
+     */
+    oDataVersion: ODataVersion;
+}
+
+/**
+ * Use this class to do a health check for all available OData services, supports both v2 and v4
+ * format. This health checker ensures not only that $metadata is valid, but also that the UI5 framework
+ * itself can consume the service via its models.
+ */
+export class ODataHealthChecker {
+    /**
+     * The OData type.
+     */
+    private static readonly ODATA_TYPE: string = 'OData';
+
+    /**
+     * The default OData version.
+     */
+    private static readonly DEFAULT_ODATA_VERSION: ODataVersion = 'v2';
+
+    /**
+     * Use this helper function to filter the OData data source items from the manifest.
+     * @param src The service data source.
+     * @returns True if the data source represents an OData service.
+     */
+    private readonly isOdataService = (src: DataSource): boolean => src.type === ODataHealthChecker.ODATA_TYPE;
+
+    /**
+     * Use this helper function to map the OData data source to the internal structure
+     * used in this class.
+     * @param src The OData service data source.
+     * @returns The OData service info object.
+     */
+    private readonly toOdataServiceInfo = (src: DataSource): ODataServiceInfo => ({
+        serviceUrl: src.uri,
+        oDataVersion: src.settings?.odataVersion ?? ODataHealthChecker.DEFAULT_ODATA_VERSION
+    });
+
+    constructor(private readonly rta: RuntimeAuthoring) {}
+
+    /**
+     * Does a health check to all available OData services.
+     *
+     * @returns Resolves with an array containing the health
+     * status for each OData service.
+     */
+    async getHealthStatus(): Promise<ODataHealthStatus[]> {
+        const oDataHealthCheckStartTime = Date.now();
+
+        const services = this.getServices();
+        const metadataPromises = await Promise.allSettled(
+            services.map(({ serviceUrl, oDataVersion }) => this.getServiceMetadata(serviceUrl, oDataVersion))
+        );
+
+        const oDataHealthCheckDurationInSec = ((Date.now() - oDataHealthCheckStartTime) / 1000).toFixed(2);
+        Log.info(`OData service health check took ${oDataHealthCheckDurationInSec} sec.`);
+
+        return metadataPromises.map((metadataPromise, idx) =>
+            metadataPromise.status === 'fulfilled'
+                ? new ODataUpStatus(services[idx].serviceUrl)
+                : new ODataDownStatus(services[idx].serviceUrl, metadataPromise.reason)
+        );
+    }
+
+    /**
+     * This method does a strong health check (with the ODataModel). This ensures not only
+     * that the $metadata is valid, but also that the UI5 framework itself can consume the service via its models.
+     * Some services may have valid $metadata but still fail in the UI5’s ODataModel
+     * (e.g., weird annotations, CORS issues, etc.).
+     *
+     * @param serviceUrl The OData service url.
+     * @param oDataVersion The OData version.
+     * @returns Resolved with valid metadata.
+     */
+    private getServiceMetadata(serviceUrl: string, oDataVersion: ODataVersion): Promise<ODataMetadata> {
+        switch (oDataVersion) {
+            case 'v2':
+            case '2.0':
+                return this.getServiceV2Metadata(serviceUrl);
+            case 'v4':
+            case '4.0':
+                return this.getServiceV4Metadata(serviceUrl);
+        }
+    }
+
+    private getServiceV2Metadata(serviceUrl: string): Promise<ODataMetadata> {
+        const oModel = new ODataModelV2({
+            serviceUrl,
+            json: true,
+            // We do not want the annotations concatenated to the final result.
+            loadAnnotationsJoined: false
+        });
+        // This method actually returns promise which is resolved with the metadata.
+        return oModel.metadataLoaded(true).finally(
+            // Do clean up in case the helath check is done multiple times.
+            () => oModel.destroy()
+        );
+    }
+
+    private getServiceV4Metadata(serviceUrl: string): Promise<ODataMetadata> {
+        const oModel = new ODataModelV4({
+            serviceUrl,
+            // Only metadata loaded. We only want the model to load $metadata,
+            // not fetch entity data or bind to any UI controls.
+            synchronizationMode: 'None'
+        });
+        // This method actually returns promise which is resolved with the metadata.
+        return oModel
+            .getMetaModel()
+            .requestObject('/')
+            .finally(
+                // Do clean up in case the helath check is done multiple times.
+                () => oModel.destroy()
+            );
+    }
+
+    private getServices(): ODataServiceInfo[] {
+        const manifest: Manifest = this.rta.getRootControlInstance().getManifest() as unknown as Manifest;
+        const dataSources = manifest?.['sap.app']?.dataSources;
+        return Object.values(dataSources ?? {})
+            .filter(this.isOdataService)
+            .map(this.toOdataServiceInfo);
+    }
+}

package/dist/client/cpe/odata-health/odata-health-status.js

@@ -0,0 +1,63 @@
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * Represents the status for a healthy OData service.
+   */
+  class ODataUpStatus {
+    /**
+     * Creates an instance representing a healthy OData service.
+     *
+     * @param serviceUrl The service url.
+     */
+    constructor(serviceUrl) {
+      this.serviceUrl = serviceUrl;
+    }
+  }
+
+  /**
+   * Represents the status for an unhealthy OData service.
+   */
+  class ODataDownStatus {
+    /**
+     * Creates an instance representing an unhealthy OData service.
+     *
+     * @param serviceUrl The service url.
+     * @param reason The provided reason for the failure.
+     */
+    constructor(serviceUrl, reason) {
+      this.serviceUrl = serviceUrl;
+      this.reason = reason;
+      this.errorMessage = this.formatReason(reason);
+    }
+
+    /**
+     * Formats the reason.
+     *
+     * @param reason The provided reason for the failure.
+     * @returns Formatted reason as string.
+     */
+    formatReason(reason) {
+      if (reason instanceof Error) {
+        return reason.message;
+      }
+      if (typeof reason === 'string') {
+        return reason;
+      }
+      try {
+        return JSON.stringify(reason);
+      } catch {
+        return String(reason);
+      }
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.ODataUpStatus = ODataUpStatus;
+  __exports.ODataDownStatus = ODataDownStatus;
+  return __exports;
+});
+//# sourceMappingURL=odata-health-status.js.map

package/dist/client/cpe/odata-health/odata-health-status.ts

@@ -0,0 +1,52 @@
+export type ODataMetadata = Record<string, unknown>;
+
+/**
+ * Represents the status for a healthy OData service.
+ */
+export class ODataUpStatus {
+    /**
+     * Creates an instance representing a healthy OData service.
+     *
+     * @param serviceUrl The service url.
+     */
+    constructor(public readonly serviceUrl: string) {}
+}
+
+/**
+ * Represents the status for an unhealthy OData service.
+ */
+export class ODataDownStatus {
+    readonly errorMessage: string;
+
+    /**
+     * Creates an instance representing an unhealthy OData service.
+     *
+     * @param serviceUrl The service url.
+     * @param reason The provided reason for the failure.
+     */
+    constructor(public readonly serviceUrl: string, public readonly reason: unknown) {
+        this.errorMessage = this.formatReason(reason);
+    }
+
+    /**
+     * Formats the reason.
+     *
+     * @param reason The provided reason for the failure.
+     * @returns Formatted reason as string.
+     */
+    private formatReason(reason: unknown): string {
+        if (reason instanceof Error) {
+            return reason.message;
+        }
+        if (typeof reason === 'string') {
+            return reason;
+        }
+        try {
+            return JSON.stringify(reason);
+        } catch {
+            return String(reason);
+        }
+    }
+}
+
+export type ODataHealthStatus = ODataUpStatus | ODataDownStatus;

package/dist/client/messagebundle.properties

@@ -65,6 +65,8 @@ ADP_CONTROLLER_ERROR_TITLE = Controller Error
 ADP_EXTENSION_POINT_ERROR_TITLE = Extension Point Error
 ADP_CREATE_CONTROLLER_EXTENSION_TITLE = Create Controller Extension
 ADP_CREATE_CONTROLLER_EXTENSION_DESCRIPTION = Controller extension with name ''{0}'' was created.
+ADP_ODATA_HEALTH_CHECK_TITLE = OData Service Health Check
+ADP_ODATA_SERVICE_DOWN_DESCRIPTION = The OData service with the {0} endpoint is down. Error: {1}.
 CHANGES_VISIBLE_AFTER_SAVE_AND_RELOAD_TITLE = Save and Reload Required
 CHANGES_VISIBLE_AFTER_SAVE_AND_RELOAD_DESCRIPTION = Note: The change will be visible after save and reload.
 CHANGE_CREATION_FAILED_TITLE = Change Creation Failed