@sap/ux-ui5-tooling 1.24.0 → 1.25.0

package/dist/preview-middleware/dist/client/adp/change-file-validator.js

@@ -0,0 +1,128 @@
+"use strict";
+
+sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../utils/info-center-message"], function (log, ___sap_ux_private_control_property_editor_common, ___utils_info_center_message) {
+  "use strict";
+
+  const MessageBarType = ___sap_ux_private_control_property_editor_common["MessageBarType"];
+  const sendInfoCenterMessage = ___utils_info_center_message["sendInfoCenterMessage"];
+  const CHANGE_TYPE = {
+    addXML: 'addXML',
+    codeExt: 'codeExt'
+  };
+  /**
+   * Type guard for changes that reference a fragment or controller extension file.
+   *
+   * @param change flex change object
+   * @returns true if the change is an addXML with fragmentPath or a codeExt with codeRef
+   */
+  function isFragmentOrCodeExtChange(change) {
+    return !!change.reference && (change.changeType === CHANGE_TYPE.addXML && !!change.content?.fragmentPath || change.changeType === CHANGE_TYPE.codeExt && !!change.content?.codeRef);
+  }
+
+  /**
+   * Builds a lookup map from module name patterns to change metadata
+   * for addXML and codeExt changes.
+   *
+   * @param changes record of change objects keyed by flex key
+   * @returns map from module name substring to orphaned change entry
+   */
+  function buildModuleNameMap(changes) {
+    const map = new Map();
+    for (const change of Object.values(changes)) {
+      if (!isFragmentOrCodeExtChange(change)) {
+        continue;
+      }
+      const prefix = change.reference.replaceAll('.', '/');
+      const path = change.changeType === CHANGE_TYPE.addXML ? change.content?.fragmentPath ?? '' : change.content?.codeRef ?? '';
+      const changeFileName = `${change.fileName}.${change.fileType ?? 'change'}`;
+      const key = change.moduleName ?? `${prefix}/changes/${path}`;
+      map.set(key, {
+        changeFileName,
+        filePath: path,
+        changeType: change.changeType
+      });
+    }
+    return map;
+  }
+
+  /**
+   * Creates an error handler that matches error messages against known module names
+   * and sends InfoCenter errors for orphaned change files.
+   *
+   * @param moduleNameMap map from module name substring to orphaned change entry
+   * @returns error handler function
+   */
+  function createErrorHandler(moduleNameMap, restoreConsole) {
+    return message => {
+      for (const [moduleName, entry] of moduleNameMap) {
+        if (message.includes(moduleName)) {
+          sendInfoCenterMessage({
+            title: {
+              key: 'ADP_ORPHANED_CHANGE_ERROR_TITLE'
+            },
+            description: {
+              key: 'ADP_ORPHANED_FILE_DESCRIPTION',
+              params: [entry.filePath, entry.changeFileName]
+            },
+            type: MessageBarType.error
+          }).catch(error => {
+            log.error('Failed to send orphaned change InfoCenter message', error);
+          });
+          moduleNameMap.delete(moduleName);
+          if (moduleNameMap.size === 0) {
+            restoreConsole();
+          }
+          break;
+        }
+      }
+    };
+  }
+
+  /**
+   * Initializes orphaned change file detection.
+   *
+   * Fetches loaded flex changes, builds a lookup map of module names for addXML and codeExt changes,
+   * and wraps console.error to intercept UI5 flex change application errors. When UI5 fails to load
+   * a fragment or controller extension referenced by a change file, the error is intercepted and an
+   * actionable message is shown in the InfoCenter advising the user to delete the orphaned change file.
+   */
+  async function initOrphanedChangeDetection() {
+    const baseUrl = document.getElementById('sap-ui-bootstrap')?.dataset.openUxPreviewBaseUrl ?? '';
+    const response = await fetch(`${baseUrl}/preview/api/changes`, {
+      method: 'GET',
+      headers: {
+        'content-type': 'application/json'
+      }
+    });
+    if (!response.ok) {
+      log.error(`Failed to fetch changes for orphaned change detection: ${response.status}`);
+      return;
+    }
+    const changes = await response.json();
+    const moduleNameMap = buildModuleNameMap(changes);
+    if (moduleNameMap.size === 0) {
+      return;
+    }
+    const consoleRef = globalThis.console;
+    const originalConsoleError = consoleRef.error;
+    const restore = () => {
+      consoleRef.error = originalConsoleError;
+    };
+    const handler = createErrorHandler(moduleNameMap, restore);
+    const safetyTimeout = setTimeout(restore, 60_000);
+    consoleRef.error = (...args) => {
+      originalConsoleError.apply(consoleRef, args);
+      const message = args.filter(arg => typeof arg === 'string').join('');
+      handler(message);
+      if (moduleNameMap.size === 0) {
+        clearTimeout(safetyTimeout);
+      }
+    };
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.initOrphanedChangeDetection = initOrphanedChangeDetection;
+  return __exports;
+});
+//# sourceMappingURL=change-file-validator.js.map

package/dist/preview-middleware/dist/client/adp/change-file-validator.ts

@@ -0,0 +1,158 @@
+import log from 'sap/base/Log';
+import { MessageBarType } from '@sap-ux-private/control-property-editor-common';
+
+import { sendInfoCenterMessage } from '../utils/info-center-message';
+
+const CHANGE_TYPE = {
+    addXML: 'addXML',
+    codeExt: 'codeExt'
+};
+
+type FlexChangeType = (typeof CHANGE_TYPE)[keyof typeof CHANGE_TYPE];
+
+interface ChangeContent {
+    fragmentPath?: string;
+    codeRef?: string;
+}
+
+interface Change {
+    changeType: string;
+    fileName: string;
+    fileType?: string;
+    reference: string;
+    moduleName?: string;
+    content?: ChangeContent;
+}
+
+interface OrphanedChangeEntry {
+    changeFileName: string;
+    filePath: string;
+    changeType: FlexChangeType;
+}
+
+interface RelevantChange extends Change {
+    changeType: FlexChangeType;
+    reference: string;
+}
+
+/**
+ * Type guard for changes that reference a fragment or controller extension file.
+ *
+ * @param change flex change object
+ * @returns true if the change is an addXML with fragmentPath or a codeExt with codeRef
+ */
+function isFragmentOrCodeExtChange(change: Change): change is RelevantChange {
+    return (
+        !!change.reference &&
+        ((change.changeType === CHANGE_TYPE.addXML && !!change.content?.fragmentPath) ||
+            (change.changeType === CHANGE_TYPE.codeExt && !!change.content?.codeRef))
+    );
+}
+
+/**
+ * Builds a lookup map from module name patterns to change metadata
+ * for addXML and codeExt changes.
+ *
+ * @param changes record of change objects keyed by flex key
+ * @returns map from module name substring to orphaned change entry
+ */
+function buildModuleNameMap(changes: Record<string, Change>): Map<string, OrphanedChangeEntry> {
+    const map = new Map<string, OrphanedChangeEntry>();
+
+    for (const change of Object.values(changes)) {
+        if (!isFragmentOrCodeExtChange(change)) {
+            continue;
+        }
+
+        const prefix = change.reference.replaceAll('.', '/');
+        const path = change.changeType === CHANGE_TYPE.addXML ? change.content?.fragmentPath ?? '' : change.content?.codeRef ?? '';
+        const changeFileName = `${change.fileName}.${change.fileType ?? 'change'}`;
+        const key = change.moduleName ?? `${prefix}/changes/${path}`;
+
+        map.set(key, { changeFileName, filePath: path, changeType: change.changeType });
+    }
+
+    return map;
+}
+
+/**
+ * Creates an error handler that matches error messages against known module names
+ * and sends InfoCenter errors for orphaned change files.
+ *
+ * @param moduleNameMap map from module name substring to orphaned change entry
+ * @returns error handler function
+ */
+function createErrorHandler(
+    moduleNameMap: Map<string, OrphanedChangeEntry>,
+    restoreConsole: () => void
+): (message: string) => void {
+    return (message: string) => {
+        for (const [moduleName, entry] of moduleNameMap) {
+            if (message.includes(moduleName)) {
+                sendInfoCenterMessage({
+                    title: { key: 'ADP_ORPHANED_CHANGE_ERROR_TITLE' },
+                    description: {
+                        key: 'ADP_ORPHANED_FILE_DESCRIPTION',
+                        params: [entry.filePath, entry.changeFileName]
+                    },
+                    type: MessageBarType.error
+                }).catch((error) => {
+                    log.error('Failed to send orphaned change InfoCenter message', error);
+                });
+                moduleNameMap.delete(moduleName);
+                if (moduleNameMap.size === 0) {
+                    restoreConsole();
+                }
+                break;
+            }
+        }
+    };
+}
+
+/**
+ * Initializes orphaned change file detection.
+ *
+ * Fetches loaded flex changes, builds a lookup map of module names for addXML and codeExt changes,
+ * and wraps console.error to intercept UI5 flex change application errors. When UI5 fails to load
+ * a fragment or controller extension referenced by a change file, the error is intercepted and an
+ * actionable message is shown in the InfoCenter advising the user to delete the orphaned change file.
+ */
+export async function initOrphanedChangeDetection(): Promise<void> {
+    const baseUrl = document.getElementById('sap-ui-bootstrap')?.dataset.openUxPreviewBaseUrl ?? '';
+    const response = await fetch(`${baseUrl}/preview/api/changes`, {
+        method: 'GET',
+        headers: { 'content-type': 'application/json' }
+    });
+
+    if (!response.ok) {
+        log.error(`Failed to fetch changes for orphaned change detection: ${response.status}`);
+        return;
+    }
+
+    const changes = (await response.json()) as Record<string, Change>;
+    const moduleNameMap = buildModuleNameMap(changes);
+
+    if (moduleNameMap.size === 0) {
+        return;
+    }
+
+    const consoleRef = globalThis.console;
+    const originalConsoleError = consoleRef.error;
+
+    const restore = (): void => {
+        consoleRef.error = originalConsoleError;
+    };
+
+    const handler = createErrorHandler(moduleNameMap, restore);
+
+    const safetyTimeout = setTimeout(restore, 60_000);
+
+    consoleRef.error = (...args: unknown[]) => {
+        originalConsoleError.apply(consoleRef, args);
+        const message = args.filter((arg): arg is string => typeof arg === 'string').join('');
+        handler(message);
+        if (moduleNameMap.size === 0) {
+            clearTimeout(safetyTimeout);
+        }
+    };
+}

package/dist/preview-middleware/dist/client/adp/init.js

@@ -1,6 +1,6 @@
 "use strict";
 
-sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../utils/version", "../cpe/init", "./sync-views-utils", "../utils/application", "./quick-actions/load", "./init-dialogs", "../utils/info-center-message", "../cpe/communication-service"], function (log, ___sap_ux_private_control_property_editor_common, ___utils_version, __init, ___sync_views_utils, ___utils_application, ___quick_actions_load, ___init_dialogs, ___utils_info_center_message, ___cpe_communication_service) {
+sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../utils/version", "../cpe/init", "./sync-views-utils", "../utils/application", "./quick-actions/load", "./init-dialogs", "../utils/info-center-message", "../cpe/communication-service", "./change-file-validator"], function (log, ___sap_ux_private_control_property_editor_common, ___utils_version, __init, ___sync_views_utils, ___utils_application, ___quick_actions_load, ___init_dialogs, ___utils_info_center_message, ___cpe_communication_service, ___change_file_validator) {
   "use strict";
 
   function _interopRequireDefault(obj) {
@@ -38,6 +38,7 @@ sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-privat
   const initDialogs = ___init_dialogs["initDialogs"];
   const sendInfoCenterMessage = ___utils_info_center_message["sendInfoCenterMessage"];
   const CommunicationService = ___cpe_communication_service["CommunicationService"];
+  const initOrphanedChangeDetection = ___change_file_validator["initOrphanedChangeDetection"];
   var __exports = async function (rta) {
     const flexSettings = rta.getFlexSettings();
     if (flexSettings.telemetry === true) {
@@ -104,6 +105,9 @@ sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-privat
       CommunicationService.sendAction(toggleAppPreviewVisibility(false));
       return;
     }
+    initOrphanedChangeDetection().catch(error => {
+      log.error('Failed to run orphaned change detection', error);
+    });
     log.debug('ADP init executed.');
   };
   return __exports;

package/dist/preview-middleware/dist/client/adp/init.ts

@@ -23,6 +23,7 @@ import { loadDefinitions } from './quick-actions/load';
 import { initDialogs } from './init-dialogs';
 import { sendInfoCenterMessage } from '../utils/info-center-message';
 import { CommunicationService } from '../cpe/communication-service';
+import { initOrphanedChangeDetection } from './change-file-validator';
 
 export default async function (rta: RuntimeAuthoring) {
     const flexSettings = rta.getFlexSettings();
@@ -88,5 +89,9 @@ export default async function (rta: RuntimeAuthoring) {
         return;
     }
 
+    initOrphanedChangeDetection().catch((error) => {
+        log.error('Failed to run orphaned change detection', error);
+    });
+
     log.debug('ADP init executed.');
 }

package/dist/preview-middleware/dist/client/cpe/changes/service.js

@@ -370,6 +370,88 @@ sap.ui.define(["open/ux/preview/client/thirdparty/@sap-ux-private/control-proper
       }
     }
 
+    /**
+     * Build a PendingGenericChange and track config change path if applicable.
+     *
+     * @param changeDefinition - change definition object
+     * @param changeType - the change type string
+     * @param handler - the generic change handler
+     * @param isActive - whether the change is currently active
+     * @param fileName - file name of the change
+     * @param textBundle - i18n text bundle
+     * @returns Promise resolving to PendingGenericChange
+     */
+    async buildGenericChange(changeDefinition, changeType, handler, isActive, fileName, textBundle) {
+      const {
+        properties,
+        changeTitle,
+        controlId,
+        changeType: type,
+        subtitle
+      } = await handler(changeDefinition, {
+        textBundle,
+        appComponent: this.options.rta.getRootControlInstance(),
+        configPropertyControlIdMap: this.configPropertyControlIdMap
+      });
+      const genericChange = {
+        kind: GENERIC_CHANGE_KIND,
+        type: 'pending',
+        changeType: type ?? changeType,
+        ...(subtitle && {
+          subtitle
+        }),
+        isActive,
+        title: textBundle.getText(changeTitle),
+        fileName,
+        ...(controlId && {
+          controlId
+        }),
+        properties
+      };
+      if (changeType === 'appdescr_fe_changePageConfiguration') {
+        const configChangePath = changeDefinition.content.entityPropertyChange.propertyPath;
+        if (genericChange.isActive) {
+          this.configPropertyPath.add(configChangePath);
+        } else {
+          // remove value from set if change is undone
+          this.configPropertyPath.delete(configChangePath);
+        }
+        this.trackPendingConfigChanges(genericChange);
+      }
+      return genericChange;
+    }
+
+    /**
+     * Build a fallback PendingChange for changes without a registered handler.
+     *
+     * @param changeType - the change type string
+     * @param selectorId - optional selector/control ID
+     * @param isActive - whether the change is currently active
+     * @param fileName - file name of the change
+     * @returns PendingChange
+     */
+    buildFallbackChange(changeType, selectorId, isActive, fileName) {
+      const title = TITLE_MAP[changeType] ?? '';
+      let result = {
+        type: PENDING_CHANGE_TYPE,
+        kind: UNKNOWN_CHANGE_KIND,
+        ...(title && {
+          title
+        }),
+        changeType,
+        isActive,
+        fileName
+      };
+      if (selectorId) {
+        result = {
+          ...result,
+          kind: 'control',
+          controlId: selectorId
+        };
+      }
+      return result;
+    }
+
     /**
      * Prepares the type of change based on the command and other parameters.
      *
@@ -391,65 +473,11 @@ sap.ui.define(["open/ux/preview/client/thirdparty/@sap-ux-private/control-proper
         fileName
       } = changeDefinition;
       const handler = GENERIC_CHANGE_HANDLER[changeType];
+      const isActive = index >= inactiveCommandCount;
       if (handler) {
-        const {
-          properties,
-          changeTitle,
-          controlId,
-          changeType: type,
-          subtitle
-        } = await handler(changeDefinition, {
-          textBundle,
-          appComponent: this.options.rta.getRootControlInstance(),
-          configPropertyControlIdMap: this.configPropertyControlIdMap
-        });
-        const genericChange = {
-          kind: GENERIC_CHANGE_KIND,
-          type: 'pending',
-          changeType: type ?? changeType,
-          ...(subtitle && {
-            subtitle
-          }),
-          isActive: index >= inactiveCommandCount,
-          title: textBundle.getText(changeTitle),
-          fileName,
-          ...(controlId && {
-            controlId
-          }),
-          properties
-        };
-        if (changeType === 'appdescr_fe_changePageConfiguration') {
-          const configChangePath = changeDefinition.content.entityPropertyChange.propertyPath;
-          if (genericChange.isActive) {
-            this.configPropertyPath.add(configChangePath);
-          } else {
-            // remove value from set if change is undone
-            this.configPropertyPath.delete(configChangePath);
-          }
-          this.trackPendingConfigChanges(genericChange);
-        }
-        return genericChange;
-      } else {
-        const title = TITLE_MAP[changeType] ?? '';
-        let result = {
-          type: PENDING_CHANGE_TYPE,
-          kind: UNKNOWN_CHANGE_KIND,
-          ...(title && {
-            title
-          }),
-          changeType,
-          isActive: index >= inactiveCommandCount,
-          fileName
-        };
-        if (selectorId) {
-          result = {
-            ...result,
-            kind: 'control',
-            controlId: selectorId
-          };
-        }
-        return result;
+        return this.buildGenericChange(changeDefinition, changeType, handler, isActive, fileName, textBundle);
       }
+      return this.buildFallbackChange(changeType, selectorId, isActive, fileName);
     }
 
     /**

package/dist/preview-middleware/dist/client/cpe/changes/service.ts

@@ -433,6 +433,94 @@ export class ChangeService extends EventTarget {
         }
     }
 
+    /**
+     * Build a PendingGenericChange and track config change path if applicable.
+     *
+     * @param changeDefinition - change definition object
+     * @param changeType - the change type string
+     * @param handler - the generic change handler
+     * @param isActive - whether the change is currently active
+     * @param fileName - file name of the change
+     * @param textBundle - i18n text bundle
+     * @returns Promise resolving to PendingGenericChange
+     */
+    private async buildGenericChange(
+        changeDefinition: ChangeDefinition,
+        changeType: string,
+        handler: ChangeHandler<GenericChange>,
+        isActive: boolean,
+        fileName: string,
+        textBundle: Awaited<ReturnType<typeof getTextBundle>>
+    ): Promise<PendingGenericChange> {
+        const {
+            properties,
+            changeTitle,
+            controlId,
+            changeType: type,
+            subtitle
+        } = await handler(changeDefinition as unknown as GenericChange, {
+            textBundle,
+            appComponent: this.options.rta.getRootControlInstance(),
+            configPropertyControlIdMap: this.configPropertyControlIdMap
+        });
+        const genericChange: PendingGenericChange = {
+            kind: GENERIC_CHANGE_KIND,
+            type: 'pending',
+            changeType: type ?? changeType,
+            ...(subtitle && { subtitle }),
+            isActive,
+            title: textBundle.getText(changeTitle),
+            fileName,
+            ...(controlId && { controlId }),
+            properties
+        };
+        if (changeType === 'appdescr_fe_changePageConfiguration') {
+            const configChangePath = (changeDefinition as ConfigChange).content.entityPropertyChange.propertyPath;
+            if (genericChange.isActive) {
+                this.configPropertyPath.add(configChangePath);
+            } else {
+                // remove value from set if change is undone
+                this.configPropertyPath.delete(configChangePath);
+            }
+            this.trackPendingConfigChanges(genericChange);
+        }
+        return genericChange;
+    }
+
+    /**
+     * Build a fallback PendingChange for changes without a registered handler.
+     *
+     * @param changeType - the change type string
+     * @param selectorId - optional selector/control ID
+     * @param isActive - whether the change is currently active
+     * @param fileName - file name of the change
+     * @returns PendingChange
+     */
+    private buildFallbackChange(
+        changeType: string,
+        selectorId: string | undefined,
+        isActive: boolean,
+        fileName: string
+    ): PendingChange {
+        const title = TITLE_MAP[changeType] ?? '';
+        let result: PendingChange = {
+            type: PENDING_CHANGE_TYPE,
+            kind: UNKNOWN_CHANGE_KIND,
+            ...(title && { title }),
+            changeType,
+            isActive,
+            fileName
+        };
+        if (selectorId) {
+            result = {
+                ...result,
+                kind: 'control',
+                controlId: selectorId
+            };
+        }
+        return result;
+    }
+
     /**
      * Prepares the type of change based on the command and other parameters.
      *
@@ -462,60 +550,11 @@ export class ChangeService extends EventTarget {
         const changeDefinition = change.getDefinition ? change.getDefinition() : (change.getJson() as ChangeDefinition);
         const { fileName } = changeDefinition;
         const handler = GENERIC_CHANGE_HANDLER[changeType as ChangeType] as unknown as ChangeHandler<GenericChange>;
+        const isActive = index >= inactiveCommandCount;
         if (handler) {
-            const {
-                properties,
-                changeTitle,
-                controlId,
-                changeType: type,
-                subtitle
-            } = await handler(changeDefinition as unknown as GenericChange, {
-                textBundle,
-                appComponent: this.options.rta.getRootControlInstance(),
-                configPropertyControlIdMap: this.configPropertyControlIdMap
-            });
-            const genericChange: PendingGenericChange = {
-                kind: GENERIC_CHANGE_KIND,
-                type: 'pending',
-                changeType: type ?? changeType,
-                ...(subtitle && { subtitle }),
-                isActive: index >= inactiveCommandCount,
-                title: textBundle.getText(changeTitle),
-                fileName,
-                ...(controlId && { controlId }),
-                properties
-            };
-            if (changeType === 'appdescr_fe_changePageConfiguration') {
-                const configChangePath = (changeDefinition as ConfigChange).content.entityPropertyChange.propertyPath;
-                if (genericChange.isActive) {
-                        this.configPropertyPath.add(configChangePath);
-                } else {
-                    // remove value from set if change is undone
-                    this.configPropertyPath.delete(configChangePath);
-                }
-                this.trackPendingConfigChanges(genericChange);
-            }
-            return genericChange;
-        } else {
-            const title = TITLE_MAP[changeType] ?? '';
-            let result: PendingChange = {
-                type: PENDING_CHANGE_TYPE,
-                kind: UNKNOWN_CHANGE_KIND,
-                ...(title && { title }),
-                changeType,
-                isActive: index >= inactiveCommandCount,
-                fileName
-            };
-
-            if (selectorId) {
-                result = {
-                    ...result,
-                    kind: 'control',
-                    controlId: selectorId
-                };
-            }
-            return result;
+            return this.buildGenericChange(changeDefinition, changeType, handler, isActive, fileName, textBundle);
         }
+        return this.buildFallbackChange(changeType, selectorId, isActive, fileName);
     }
 
     /**