@sap-ux/preview-middleware 1.0.41 → 1.0.44

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

@@ -20,57 +20,55 @@ sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-privat
   }
 
   /**
-   * Builds a lookup map from module name patterns to change metadata
-   * for addXML and codeExt changes.
+   * Builds the set of module name patterns to watch for in error messages,
+   * derived from addXML and codeExt changes.
    *
    * @param changes record of change objects keyed by flex key
-   * @returns map from module name substring to orphaned change entry
+   * @returns set of module name substrings identifying orphaned-change error messages
    */
-  function buildModuleNameMap(changes) {
-    const map = new Map();
+  function buildModuleNameSet(changes) {
+    const moduleNames = new Set();
     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
-      });
+      moduleNames.add(change.moduleName || `${prefix}/changes/${path}`); // || not ?? — empty string is falsy, fall back to computed path
     }
-    return map;
+    return moduleNames;
   }
 
+  /**
+   * UI5's `sap/base/Log` prefixes every message with a timestamp
+   * (`YYYY-MM-DD HH:MM:SS.mmmmmm `). Strip it so the InfoCenter shows just the error text.
+   */
+  const UI5_LOG_TIMESTAMP = /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+\s+/;
+
   /**
    * Creates an error handler that matches error messages against known module names
-   * and sends InfoCenter errors for orphaned change files.
+   * and forwards the original browser error to the InfoCenter.
    *
-   * @param moduleNameMap map from module name substring to orphaned change entry
+   * @param moduleNames set of module name substrings to watch for
+   * @param onAllMatched callback invoked once every watched module name has been matched
    * @returns error handler function
    */
-  function createErrorHandler(moduleNameMap, restoreConsole) {
+  function createErrorHandler(moduleNames, onAllMatched) {
     return message => {
-      for (const [moduleName, entry] of moduleNameMap) {
+      for (const moduleName of moduleNames) {
         if (message.includes(moduleName)) {
           sendInfoCenterMessage({
             title: {
-              key: 'ADP_ORPHANED_CHANGE_ERROR_TITLE'
-            },
-            description: {
-              key: 'ADP_ORPHANED_FILE_DESCRIPTION',
-              params: [entry.filePath, entry.changeFileName]
+              key: 'ADP_CHANGE_ERROR_TITLE'
             },
+            description: message.replace(UI5_LOG_TIMESTAMP, ''),
             type: MessageBarType.error
           }).catch(error => {
             log.error('Failed to send orphaned change InfoCenter message', error);
           });
-          moduleNameMap.delete(moduleName);
-          if (moduleNameMap.size === 0) {
-            restoreConsole();
+          moduleNames.delete(moduleName);
+          if (moduleNames.size === 0) {
+            onAllMatched();
           }
           break;
         }
@@ -81,43 +79,91 @@ sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-privat
   /**
    * 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.
+   * Wraps `console.error` synchronously so early errors (emitted during app bootstrap, before
+   * the changes list has been fetched) are captured in a buffer. Once the changes are loaded,
+   * the buffered messages are replayed against the set of module names derived from addXML and
+   * codeExt changes. Subsequent errors are matched live. When UI5 fails to load a fragment or
+   * controller extension referenced by a change file, the original error is forwarded to the
+   * InfoCenter so the user sees the exact browser message.
+   *
+   * @returns a cancel function — call it to stop detection and immediately restore console.error.
    */
-  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;
-    }
+  function initOrphanedChangeDetection() {
     const consoleRef = globalThis.console;
     const originalConsoleError = consoleRef.error;
+    const BUFFER_LIMIT = 200;
+    const buffer = [];
+    let moduleNames;
+    let handler;
+    let cancelled = false;
     const restore = () => {
       consoleRef.error = originalConsoleError;
     };
-    const handler = createErrorHandler(moduleNameMap, restore);
-    const safetyTimeout = setTimeout(restore, 60_000);
+    const cancel = () => {
+      cancelled = true;
+      buffer.length = 0;
+      restore();
+      clearTimeout(safetyTimeout);
+    };
+    const safetyTimeout = setTimeout(cancel, 60_000);
     consoleRef.error = (...args) => {
       originalConsoleError.apply(consoleRef, args);
+      if (cancelled) {
+        return;
+      }
       const message = args.filter(arg => typeof arg === 'string').join('');
-      handler(message);
-      if (moduleNameMap.size === 0) {
-        clearTimeout(safetyTimeout);
+      if (handler) {
+        handler(message);
+        if (moduleNames?.size === 0) {
+          clearTimeout(safetyTimeout);
+        }
+      } else if (buffer.length < BUFFER_LIMIT) {
+        buffer.push(message);
       }
     };
+    void loadModuleNamesAndReplay();
+    async function loadModuleNamesAndReplay() {
+      try {
+        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 (cancelled) {
+          return;
+        }
+        if (!response.ok) {
+          log.error(`Failed to fetch changes for orphaned change detection: ${response.status}`);
+          cancel();
+          return;
+        }
+        const changes = await response.json();
+        if (cancelled) {
+          return;
+        }
+        moduleNames = buildModuleNameSet(changes);
+        if (moduleNames.size === 0) {
+          cancel();
+          return;
+        }
+        handler = createErrorHandler(moduleNames, cancel);
+
+        // Replay any errors emitted before the changes list was loaded.
+        for (const message of buffer) {
+          handler(message);
+          if (moduleNames.size === 0) {
+            break;
+          }
+        }
+        buffer.length = 0;
+      } catch (error) {
+        log.error('Failed to run orphaned change detection', error);
+        cancel();
+      }
+    }
+    return cancel;
   }
   var __exports = {
     __esModule: true

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

@@ -8,8 +8,6 @@ const CHANGE_TYPE = {
     codeExt: 'codeExt'
 };
 
-type FlexChangeType = (typeof CHANGE_TYPE)[keyof typeof CHANGE_TYPE];
-
 interface ChangeContent {
     fragmentPath?: string;
     codeRef?: string;
@@ -24,14 +22,8 @@ interface Change {
     content?: ChangeContent;
 }
 
-interface OrphanedChangeEntry {
-    changeFileName: string;
-    filePath: string;
-    changeType: FlexChangeType;
-}
-
 interface RelevantChange extends Change {
-    changeType: FlexChangeType;
+    changeType: (typeof CHANGE_TYPE)[keyof typeof CHANGE_TYPE];
     reference: string;
 }
 
@@ -50,14 +42,14 @@ function isFragmentOrCodeExtChange(change: Change): change is RelevantChange {
 }
 
 /**
- * Builds a lookup map from module name patterns to change metadata
- * for addXML and codeExt changes.
+ * Builds the set of module name patterns to watch for in error messages,
+ * derived from addXML and codeExt changes.
  *
  * @param changes record of change objects keyed by flex key
- * @returns map from module name substring to orphaned change entry
+ * @returns set of module name substrings identifying orphaned-change error messages
  */
-function buildModuleNameMap(changes: Record<string, Change>): Map<string, OrphanedChangeEntry> {
-    const map = new Map<string, OrphanedChangeEntry>();
+function buildModuleNameSet(changes: Record<string, Change>): Set<string> {
+    const moduleNames = new Set<string>();
 
     for (const change of Object.values(changes)) {
         if (!isFragmentOrCodeExtChange(change)) {
@@ -65,43 +57,47 @@ function buildModuleNameMap(changes: Record<string, Change>): Map<string, Orphan
         }
 
         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 });
+        const path =
+            change.changeType === CHANGE_TYPE.addXML
+                ? change.content?.fragmentPath ?? ''
+                : change.content?.codeRef ?? '';
+        moduleNames.add(change.moduleName || `${prefix}/changes/${path}`); // || not ?? — empty string is falsy, fall back to computed path
     }
 
-    return map;
+    return moduleNames;
 }
 
+/**
+ * UI5's `sap/base/Log` prefixes every message with a timestamp
+ * (`YYYY-MM-DD HH:MM:SS.mmmmmm `). Strip it so the InfoCenter shows just the error text.
+ */
+const UI5_LOG_TIMESTAMP = /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+\s+/;
+
 /**
  * Creates an error handler that matches error messages against known module names
- * and sends InfoCenter errors for orphaned change files.
+ * and forwards the original browser error to the InfoCenter.
  *
- * @param moduleNameMap map from module name substring to orphaned change entry
+ * @param moduleNames set of module name substrings to watch for
+ * @param onAllMatched callback invoked once every watched module name has been matched
  * @returns error handler function
  */
 function createErrorHandler(
-    moduleNameMap: Map<string, OrphanedChangeEntry>,
-    restoreConsole: () => void
+    moduleNames: Set<string>,
+    onAllMatched: () => void
 ): (message: string) => void {
     return (message: string) => {
-        for (const [moduleName, entry] of moduleNameMap) {
+        for (const moduleName of moduleNames) {
             if (message.includes(moduleName)) {
                 sendInfoCenterMessage({
-                    title: { key: 'ADP_ORPHANED_CHANGE_ERROR_TITLE' },
-                    description: {
-                        key: 'ADP_ORPHANED_FILE_DESCRIPTION',
-                        params: [entry.filePath, entry.changeFileName]
-                    },
+                    title: { key: 'ADP_CHANGE_ERROR_TITLE' },
+                    description: message.replace(UI5_LOG_TIMESTAMP, ''),
                     type: MessageBarType.error
                 }).catch((error) => {
                     log.error('Failed to send orphaned change InfoCenter message', error);
                 });
-                moduleNameMap.delete(moduleName);
-                if (moduleNameMap.size === 0) {
-                    restoreConsole();
+                moduleNames.delete(moduleName);
+                if (moduleNames.size === 0) {
+                    onAllMatched();
                 }
                 break;
             }
@@ -112,47 +108,102 @@ function createErrorHandler(
 /**
  * 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.
+ * Wraps `console.error` synchronously so early errors (emitted during app bootstrap, before
+ * the changes list has been fetched) are captured in a buffer. Once the changes are loaded,
+ * the buffered messages are replayed against the set of module names derived from addXML and
+ * codeExt changes. Subsequent errors are matched live. When UI5 fails to load a fragment or
+ * controller extension referenced by a change file, the original error is forwarded to the
+ * InfoCenter so the user sees the exact browser message.
+ *
+ * @returns a cancel function — call it to stop detection and immediately restore console.error.
  */
-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;
-    }
-
+export function initOrphanedChangeDetection(): () => void {
     const consoleRef = globalThis.console;
     const originalConsoleError = consoleRef.error;
 
+    const BUFFER_LIMIT = 200;
+    const buffer: string[] = [];
+    let moduleNames: Set<string> | undefined;
+    let handler: ((message: string) => void) | undefined;
+    let cancelled = false;
+
     const restore = (): void => {
         consoleRef.error = originalConsoleError;
     };
 
-    const handler = createErrorHandler(moduleNameMap, restore);
+    const cancel = (): void => {
+        cancelled = true;
+        buffer.length = 0;
+        restore();
+        clearTimeout(safetyTimeout);
+    };
 
-    const safetyTimeout = setTimeout(restore, 60_000);
+    const safetyTimeout = setTimeout(cancel, 60_000);
 
     consoleRef.error = (...args: unknown[]) => {
         originalConsoleError.apply(consoleRef, args);
+        if (cancelled) {
+            return;
+        }
         const message = args.filter((arg): arg is string => typeof arg === 'string').join('');
-        handler(message);
-        if (moduleNameMap.size === 0) {
-            clearTimeout(safetyTimeout);
+        if (handler) {
+            handler(message);
+            if (moduleNames?.size === 0) {
+                clearTimeout(safetyTimeout);
+            }
+        } else if (buffer.length < BUFFER_LIMIT) {
+            buffer.push(message);
         }
     };
+
+    void loadModuleNamesAndReplay();
+
+    async function loadModuleNamesAndReplay(): Promise<void> {
+        try {
+            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 (cancelled) {
+                return;
+            }
+
+            if (!response.ok) {
+                log.error(`Failed to fetch changes for orphaned change detection: ${response.status}`);
+                cancel();
+                return;
+            }
+
+            const changes = (await response.json()) as Record<string, Change>;
+
+            if (cancelled) {
+                return;
+            }
+
+            moduleNames = buildModuleNameSet(changes);
+
+            if (moduleNames.size === 0) {
+                cancel();
+                return;
+            }
+
+            handler = createErrorHandler(moduleNames, cancel);
+
+            // Replay any errors emitted before the changes list was loaded.
+            for (const message of buffer) {
+                handler(message);
+                if (moduleNames.size === 0) {
+                    break;
+                }
+            }
+            buffer.length = 0;
+        } catch (error) {
+            log.error('Failed to run orphaned change detection', error as Error);
+            cancel();
+        }
+    }
+
+    return cancel;
 }

package/dist/client/adp/init.js

@@ -40,6 +40,7 @@ sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-privat
   const CommunicationService = ___cpe_communication_servicejs["CommunicationService"];
   const initOrphanedChangeDetection = ___change_file_validatorjs["initOrphanedChangeDetection"];
   var __exports = async function (rta) {
+    const cancelOrphanedChangeDetection = initOrphanedChangeDetection();
     const flexSettings = rta.getFlexSettings();
     if (flexSettings.telemetry === true) {
       enableTelemetry();
@@ -103,11 +104,9 @@ sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-privat
         type: MessageBarType.error
       });
       CommunicationService.sendAction(toggleAppPreviewVisibility(false));
+      cancelOrphanedChangeDetection();
       return;
     }
-    initOrphanedChangeDetection().catch(error => {
-      log.error('Failed to run orphaned change detection', error);
-    });
     log.debug('ADP init executed.');
   };
   return __exports;

package/dist/client/adp/init.ts

@@ -26,6 +26,8 @@ import { CommunicationService } from '../cpe/communication-service.js';
 import { initOrphanedChangeDetection } from './change-file-validator.js';
 
 export default async function (rta: RuntimeAuthoring) {
+    const cancelOrphanedChangeDetection = initOrphanedChangeDetection();
+
     const flexSettings = rta.getFlexSettings();
     if (flexSettings.telemetry === true) {
         enableTelemetry();
@@ -86,12 +88,9 @@ export default async function (rta: RuntimeAuthoring) {
             type: MessageBarType.error
         });
         CommunicationService.sendAction(toggleAppPreviewVisibility(false));
+        cancelOrphanedChangeDetection();
         return;
     }
 
-    initOrphanedChangeDetection().catch((error) => {
-        log.error('Failed to run orphaned change detection', error);
-    });
-
     log.debug('ADP init executed.');
 }

package/dist/client/messagebundle.properties

@@ -67,8 +67,7 @@ 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}.
-ADP_ORPHANED_CHANGE_ERROR_TITLE = Missing File Detected
-ADP_ORPHANED_FILE_DESCRIPTION = The "{0}" file referenced by the "{1}" change was not found. To resolve this error, delete the change file.
+ADP_CHANGE_ERROR_TITLE = Change Error
 ADP_ADD_ACTION_DIALOG_ACTION_ID_LABEL = Action ID
 ADP_ADD_ACTION_DIALOG_BUTTON_TEXT_LABEL = Button Text
 ADP_ADD_ACTION_DIALOG_HANDLER_METHOD_LABEL = Handler Method

package/package.json

@@ -10,7 +10,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "1.0.41",
+  "version": "1.0.44",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -28,12 +28,12 @@
     "mem-fs-editor": "9.4.0",
     "qrcode": "1.5.4",
     "@sap/bas-sdk": "3.13.9",
-    "@sap-ux/adp-tooling": "1.0.32",
+    "@sap-ux/adp-tooling": "1.0.34",
     "@sap-ux/btp-utils": "2.0.5",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@1.0.7",
     "@sap-ux/feature-toggle": "1.0.5",
     "@sap-ux/logger": "1.0.3",
-    "@sap-ux/project-access": "2.1.6",
+    "@sap-ux/project-access": "2.1.7",
     "@sap-ux/system-access": "1.0.7",
     "@sap-ux/i18n": "1.0.2"
   },
@@ -54,7 +54,7 @@
     "nock": "14.0.15",
     "npm-run-all2": "8.0.4",
     "supertest": "7.2.2",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@1.0.41",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@1.0.44",
     "@sap-ux-private/playwright": "1.0.5",
     "@sap-ux/axios-extension": "2.0.7",
     "@sap-ux/store": "2.0.4",