@sap-ux/repo-app-import-sub-generator 1.2.81 → 1.2.83

package/generators/app/index.js

@@ -121,10 +121,12 @@ export default class extends Generator {
         catch (error) {
             RepoAppDownloadLogger.logger?.error(t('error.writingPhase', { error: error instanceof Error ? error.message : String(error) }));
             const failEvent = this.downloadType === AppDownloadType.AbapRepository
-                ? EventName.ABAP_REPO_DOWNLOAD_FAIL
-                : EventName.ADT_QUICK_DEPLOY_DOWNLOAD_FAIL;
+                ? EventName.ABAP_REPO_APP_WRITING_FAILED
+                : EventName.ADT_QUICK_DEPLOY_APP_WRITING_FAILED;
+            // Fires when the writing phase throws — includes the caught error message for diagnosis.
             await sendTelemetry(failEvent, TelemetryHelper.createTelemetryData({
                 appType: generatorName,
+                errorMessage: error instanceof Error ? error.message : String(error),
                 ...this.options.telemetryData
             }) ?? {}).catch(() => {
                 // telemetry errors are non-fatal
@@ -338,9 +340,10 @@ export default class extends Generator {
         try {
             this.appWizard.showInformation(downloadTypeConfig[this.downloadType].generatorSuccessMsg, MessageType.notification);
             await this._handlePostAppGeneration();
+            // Fires when the full generation pipeline completes without error.
             const successEvent = this.downloadType === AppDownloadType.AbapRepository
-                ? EventName.ABAP_REPO_DOWNLOAD_SUCCESS
-                : EventName.ADT_QUICK_DEPLOY_DOWNLOAD_SUCCESS;
+                ? EventName.ABAP_REPO_DOWNLOAD_COMPLETE
+                : EventName.ADT_QUICK_DEPLOY_COMPLETE;
             await sendTelemetry(successEvent, TelemetryHelper.createTelemetryData({
                 appType: generatorName,
                 ...this.options.telemetryData

package/generators/telemetryEvents/index.d.ts

@@ -2,11 +2,21 @@
  * Event names for telemetry for the generator when downloading an app from repository
  */
 export declare const EventName: {
+    /** Zip file successfully fetched from the ABAP repository during the prompting phase. */
     readonly ABAP_REPO_DOWNLOAD_SUCCESS: "ABAP_REPO_DOWNLOAD_SUCCESS";
+    /** Full ABAP repository app generation completed successfully - fired in end(). */
+    readonly ABAP_REPO_DOWNLOAD_COMPLETE: "ABAP_REPO_DOWNLOAD_COMPLETE";
+    /** Writing phase failed for an ABAP repository download (caught exception). */
+    readonly ABAP_REPO_APP_WRITING_FAILED: "ABAP_REPO_APP_WRITING_FAILED";
+    /** Server returned no content — legacy ABAP system without repository content. */
     readonly ABAP_REPO_DOWNLOAD_FAIL: "ABAP_REPO_DOWNLOAD_FAIL";
-    readonly ABAP_REPO_DOWNLOAD_NO_FILES_RETURNED: "ABAP_REPO_DOWNLOAD_NO_FILES_RETURNED";
+    /** Zip file successfully fetched during ADT quick-deploy prompting phase. */
     readonly ADT_QUICK_DEPLOY_DOWNLOAD_SUCCESS: "ADT_QUICK_DEPLOY_DOWNLOAD_SUCCESS";
-    readonly ADT_QUICK_DEPLOY_DOWNLOAD_FAIL: "ADT_QUICK_DEPLOY_DOWNLOAD_FAIL";
+    /** Full ADT quick-deploy app generation completed successfully (fired in end()). */
+    readonly ADT_QUICK_DEPLOY_COMPLETE: "ADT_QUICK_DEPLOY_COMPLETE";
+    /** Writing phase failed for an ADT quick-deploy download (caught exception). */
+    readonly ADT_QUICK_DEPLOY_APP_WRITING_FAILED: "ADT_QUICK_DEPLOY_APP_WRITING_FAILED";
+    /** Post-generation migration hook completed for an ABAP repository app. */
     readonly ABAP_REPO_DOWNLOAD_MIGRATION_COMPLETED: "ABAP_REPO_DOWNLOAD_MIGRATION_COMPLETED";
 };
 export type EventName = (typeof EventName)[keyof typeof EventName];

package/generators/telemetryEvents/index.js

@@ -2,11 +2,21 @@
  * Event names for telemetry for the generator when downloading an app from repository
  */
 export const EventName = {
+    /** Zip file successfully fetched from the ABAP repository during the prompting phase. */
     ABAP_REPO_DOWNLOAD_SUCCESS: 'ABAP_REPO_DOWNLOAD_SUCCESS',
+    /** Full ABAP repository app generation completed successfully - fired in end(). */
+    ABAP_REPO_DOWNLOAD_COMPLETE: 'ABAP_REPO_DOWNLOAD_COMPLETE',
+    /** Writing phase failed for an ABAP repository download (caught exception). */
+    ABAP_REPO_APP_WRITING_FAILED: 'ABAP_REPO_APP_WRITING_FAILED',
+    /** Server returned no content — legacy ABAP system without repository content. */
     ABAP_REPO_DOWNLOAD_FAIL: 'ABAP_REPO_DOWNLOAD_FAIL',
-    ABAP_REPO_DOWNLOAD_NO_FILES_RETURNED: 'ABAP_REPO_DOWNLOAD_NO_FILES_RETURNED',
+    /** Zip file successfully fetched during ADT quick-deploy prompting phase. */
     ADT_QUICK_DEPLOY_DOWNLOAD_SUCCESS: 'ADT_QUICK_DEPLOY_DOWNLOAD_SUCCESS',
-    ADT_QUICK_DEPLOY_DOWNLOAD_FAIL: 'ADT_QUICK_DEPLOY_DOWNLOAD_FAIL',
+    /** Full ADT quick-deploy app generation completed successfully (fired in end()). */
+    ADT_QUICK_DEPLOY_COMPLETE: 'ADT_QUICK_DEPLOY_COMPLETE',
+    /** Writing phase failed for an ADT quick-deploy download (caught exception). */
+    ADT_QUICK_DEPLOY_APP_WRITING_FAILED: 'ADT_QUICK_DEPLOY_APP_WRITING_FAILED',
+    /** Post-generation migration hook completed for an ABAP repository app. */
     ABAP_REPO_DOWNLOAD_MIGRATION_COMPLETED: 'ABAP_REPO_DOWNLOAD_MIGRATION_COMPLETED'
 };
 //# sourceMappingURL=index.js.map

package/generators/utils/download-utils.d.ts

@@ -26,9 +26,13 @@ export declare function extractZip(extractedProjectPath: string, fs: Editor): Pr
  * Downloads application files from the ABAP repository.
  *
  * @param {string} repoName - The repository name of the application.
- * @returns {Promise<boolean>} - Resolves to false if no data was returned (such as on a legacy ABAP system), true otherwise.
+ * @returns `{ success: true }` on success, or `{ success: false, errorMessage }` if the server
+ * returns no content (e.g. a legacy ABAP system that does not support repository downloads).
  */
-export declare function downloadApp(repoName: string): Promise<boolean>;
+export declare function downloadApp(repoName: string): Promise<{
+    success: boolean;
+    errorMessage?: string;
+}>;
 /**
  * Resolve a transport request for the given app/package.
  *

package/generators/utils/download-utils.js

@@ -59,7 +59,8 @@ export async function extractZip(extractedProjectPath, fs) {
  * Downloads application files from the ABAP repository.
  *
  * @param {string} repoName - The repository name of the application.
- * @returns {Promise<boolean>} - Resolves to false if no data was returned (such as on a legacy ABAP system), true otherwise.
+ * @returns `{ success: true }` on success, or `{ success: false, errorMessage }` if the server
+ * returns no content (e.g. a legacy ABAP system that does not support repository downloads).
  */
 export async function downloadApp(repoName) {
     const serviceProvider = PromptState.systemSelection?.connectedSystem?.serviceProvider;
@@ -68,13 +69,15 @@ export async function downloadApp(repoName) {
     RepoAppDownloadLogger.logger?.debug(`App download started: ${repoName}`);
     const downloadedAppPackage = await ui5AbapRepository.downloadFiles(repoName);
     if (!downloadedAppPackage || downloadedAppPackage.length === 0) {
-        RepoAppDownloadLogger.logger?.error(t('error.appDownloadFailed'));
-        return false;
+        // Legacy ABAP systems may return empty content rather than an error response.
+        const errorMessage = t('error.appDownloadFailed');
+        RepoAppDownloadLogger.logger?.error(errorMessage);
+        return { success: false, errorMessage };
     }
     RepoAppDownloadLogger.logger?.debug(`App download completed: ${repoName}`);
     // store downloaded package in prompt state
     PromptState.admZip = downloadedAppPackage;
-    return true;
+    return { success: true };
 }
 /**
  * Resolve a transport request for the given app/package.

package/generators/utils/validators.js

@@ -129,15 +129,23 @@ export async function validateAppSelection(answers, appList, quickDeployedAppCon
     // Valid app selected, try to download
     if (answers?.appId) {
         try {
-            const downloadSucceeded = await downloadApp(answers.repoName);
-            if (!downloadSucceeded) {
+            const result = await downloadApp(answers.repoName);
+            if (!result.success) {
                 if (downloadType === AppDownloadType.AbapRepository) {
-                    await sendTelemetry(EventName.ABAP_REPO_DOWNLOAD_NO_FILES_RETURNED, TelemetryHelper.createTelemetryData({}) ?? {}).catch(() => {
+                    // Fires when the server returns no content — legacy ABAP system without repository content.
+                    await sendTelemetry(EventName.ABAP_REPO_DOWNLOAD_FAIL, TelemetryHelper.createTelemetryData({ errorMessage: result.errorMessage }) ?? {}).catch(() => {
                         // telemetry errors are non-fatal
                     });
                 }
                 return await generateAppDownloadFailedHelpLink();
             }
+            // Fires when the zip is successfully fetched — before writing begins.
+            const downloadSuccessEvent = downloadType === AppDownloadType.AbapRepository
+                ? EventName.ABAP_REPO_DOWNLOAD_SUCCESS
+                : EventName.ADT_QUICK_DEPLOY_DOWNLOAD_SUCCESS;
+            await sendTelemetry(downloadSuccessEvent, TelemetryHelper.createTelemetryData({}) ?? {}).catch(() => {
+                // telemetry errors are non-fatal
+            });
             const isQfaJsonPresent = hasQfaJson();
             if (!isQfaJsonPresent && downloadType === AppDownloadType.ADTQuickDeploy) {
                 appWizard?.showError(t('error.qfaJsonNotFound', { jsonFileName: qfaJsonFileName }), MessageType.notification);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/repo-app-import-sub-generator",
   "description": "Generator to download LROP Fiori applications deployed from an ABAP repository.",
-  "version": "1.2.81",
+  "version": "1.2.83",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,7 +30,7 @@
     "@sap-ux/inquirer-common": "1.0.46",
     "@sap-ux/project-access": "2.3.0",
     "@sap-ux/odata-service-inquirer": "3.2.24",
-    "@sap-ux/fiori-elements-writer": "3.1.77",
+    "@sap-ux/fiori-elements-writer": "3.1.78",
     "@sap-ux/fiori-freestyle-writer": "3.0.121",
     "@sap-ux/logger": "1.0.3",
     "@sap-ux/project-input-validator": "1.0.23",