@sap-ux/generator-adp 0.7.21 → 0.7.24

package/generators/app/index.d.ts

@@ -104,6 +104,14 @@ export default class extends Generator {
      * Indicates if the CF feature is enabled.
      */
     private readonly isCfFeatureEnabled;
+    /**
+     * Tools ID.
+     */
+    private toolsId;
+    /**
+     * Telemetry collector instance.
+     */
+    private telemetryCollector;
     /**
      * Creates an instance of the generator.
      *
@@ -120,6 +128,10 @@ export default class extends Generator {
      * Prompts the user for the CF project path.
      */
     private _promptForCfProjectPath;
+    /**
+     * Collects the telemetry data for the ADP generator.
+     */
+    private _collectTelemetryData;
     /**
      * Determines the target environment based on the current context.
      * Sets the target environment and updates related state accordingly.

package/generators/app/index.js

@@ -6,18 +6,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = require("node:path");
 const yeoman_generator_1 = __importDefault(require("yeoman-generator"));
+const uuid_1 = require("uuid");
 const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
 const adp_tooling_1 = require("@sap-ux/adp-tooling");
 const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 const logger_1 = require("@sap-ux/logger");
 const feature_toggle_1 = require("@sap-ux/feature-toggle");
-const telemetryEvents_1 = require("../telemetryEvents");
+const telemetry_1 = require("@sap-ux/telemetry");
 const appWizardCache_1 = require("../utils/appWizardCache");
 const deps_1 = require("../utils/deps");
 const i18n_1 = require("../utils/i18n");
 const logger_2 = __importDefault(require("../utils/logger"));
 const opts_1 = require("../utils/opts");
 const parse_json_input_1 = require("../utils/parse-json-input");
+const telemetry_2 = require("../telemetry");
 const steps_1 = require("../utils/steps");
 const subgenHelpers_1 = require("../utils/subgenHelpers");
 const templates_1 = require("../utils/templates");
@@ -135,6 +137,14 @@ class default_1 extends yeoman_generator_1.default {
      * Indicates if the CF feature is enabled.
      */
     isCfFeatureEnabled;
+    /**
+     * Tools ID.
+     */
+    toolsId;
+    /**
+     * Telemetry collector instance.
+     */
+    telemetryCollector;
     /**
      * Creates an instance of the generator.
      *
@@ -183,13 +193,7 @@ class default_1 extends yeoman_generator_1.default {
         this.isCfLoggedIn = await (0, adp_tooling_1.isLoggedInCf)(this.cfConfig, this.logger);
         this.logger.info(`isCfInstalled: ${this.cfInstalled}`);
         const isInternalUsage = (0, feature_toggle_1.isInternalFeaturesSettingEnabled)();
-        if (!this.jsonInput) {
-            const shouldShowTargetEnv = this.cfInstalled && this.isCfFeatureEnabled;
-            this.prompts.splice(0, 0, (0, steps_1.getWizardPages)(shouldShowTargetEnv));
-            this.prompter = this._getOrCreatePrompter();
-            this.cfPrompter = new cf_services_1.CFServicesPrompter(isInternalUsage, this.isCfLoggedIn, this.logger);
-        }
-        await fiori_generator_shared_1.TelemetryHelper.initTelemetrySettings({
+        await (0, telemetry_1.initTelemetrySettings)({
             consumerModule: {
                 name: '@sap/generator-fiori:generator-adp',
                 version: this.rootGeneratorVersion()
@@ -197,6 +201,13 @@ class default_1 extends yeoman_generator_1.default {
             internalFeature: isInternalUsage,
             watchTelemetrySettingStore: false
         });
+        this.telemetryCollector = new telemetry_2.TelemetryCollector();
+        if (!this.jsonInput) {
+            const shouldShowTargetEnv = this.cfInstalled && this.isCfFeatureEnabled;
+            this.prompts.splice(0, 0, (0, steps_1.getWizardPages)(shouldShowTargetEnv));
+            this.prompter = this._getOrCreatePrompter();
+            this.cfPrompter = new cf_services_1.CFServicesPrompter(isInternalUsage, this.isCfLoggedIn, this.logger);
+        }
     }
     async prompting() {
         if (this.jsonInput) {
@@ -263,13 +274,15 @@ class default_1 extends yeoman_generator_1.default {
     }
     async writing() {
         try {
+            this.toolsId = (0, uuid_1.v4)();
+            if (this.jsonInput) {
+                await this._initFromJson();
+            }
+            this._collectTelemetryData();
             if (this.isCfEnv) {
                 await this._generateAdpProjectArtifactsCF();
                 return;
             }
-            if (this.jsonInput) {
-                await this._initFromJson();
-            }
             if (this.shouldCreateExtProject) {
                 await (0, subgenHelpers_1.addExtProjectGen)({
                     configAnswers: this.configAnswers,
@@ -291,7 +304,8 @@ class default_1 extends yeoman_generator_1.default {
                 manifest,
                 layer: this.layer,
                 packageJson,
-                logger: this.toolsLogger
+                logger: this.toolsLogger,
+                toolsId: this.toolsId
             });
             if (config.options) {
                 config.options.templatePathOverwrite = (0, templates_1.getTemplatesOverwritePath)();
@@ -318,20 +332,22 @@ class default_1 extends yeoman_generator_1.default {
         }
     }
     async end() {
-        if (this.shouldCreateExtProject) {
-            return;
-        }
-        const telemetryData = fiori_generator_shared_1.TelemetryHelper.createTelemetryData({
-            appType: 'generator-adp',
-            ...this.options.telemetryData
-        }) ?? {};
         const projectPath = this._getProjectPath();
-        if (telemetryData) {
-            (0, fiori_generator_shared_1.sendTelemetry)(telemetryEvents_1.EventName.ADAPTATION_PROJECT_CREATED, telemetryData, projectPath).catch((error) => {
-                this.logger.error((0, i18n_1.t)('error.telemetry', { error }));
+        const data = fiori_generator_shared_1.TelemetryHelper.createTelemetryData({
+            appType: 'generator-adp',
+            ...this.options.telemetryData,
+            ...this.telemetryCollector.telemetryData
+        });
+        if (data) {
+            (0, fiori_generator_shared_1.sendTelemetry)(telemetry_2.EventName.ADAPTATION_PROJECT_CREATED, data, projectPath)
+                .then(() => {
+                this.logger.log(`Event ${telemetry_2.EventName.ADAPTATION_PROJECT_CREATED} successfully sent`);
+            })
+                .catch((error) => {
+                this.logger.error(`Failed to send telemetry: ${error}`);
             });
         }
-        if (this.isCli || this.isCfEnv) {
+        if (this.isCli || this.isCfEnv || this.shouldCreateExtProject) {
             return;
         }
         try {
@@ -364,6 +380,35 @@ class default_1 extends yeoman_generator_1.default {
             this.logger.log(`Project path information: ${path}`);
         }
     }
+    /**
+     * Collects the telemetry data for the ADP generator.
+     */
+    _collectTelemetryData() {
+        const telemetryData = {
+            wasFlpConfigDone: this.attributeAnswers?.addFlpConfig ?? false,
+            wasTypeScriptChosen: this.attributeAnswers?.enableTypeScript ?? false,
+            wasDeployConfigDone: this.attributeAnswers?.addDeployConfig ?? false,
+            wasExtProjectGenerated: this.shouldCreateExtProject ?? false
+        };
+        if (this.isCfEnv) {
+            telemetryData.baseAppTechnicalName = this.cfPrompter?.manifest?.['sap.app']?.id ?? '';
+            telemetryData.projectType = 'cf';
+        }
+        else {
+            const isCloud = this.prompter?.isCloud ?? false;
+            telemetryData.projectType = isCloud ? 'cloudReady' : 'onPremise';
+            telemetryData.baseAppTechnicalName = this.configAnswers?.application?.id ?? '';
+        }
+        if (this.jsonInput) {
+            telemetryData.ui5VersionSelected = (0, adp_tooling_1.getLatestVersion)(this.publicVersions);
+        }
+        else {
+            const version = this.attributeAnswers?.ui5Version ?? (0, adp_tooling_1.getLatestVersion)(this.prompter?.ui5?.publicVersions) ?? '';
+            telemetryData.ui5VersionSelected = (0, adp_tooling_1.getFormattedVersion)(version);
+        }
+        telemetryData.systemUI5Version = this.prompter?.ui5?.systemVersion ?? '';
+        this.telemetryCollector.setBatch(telemetryData);
+    }
     /**
      * Determines the target environment based on the current context.
      * Sets the target environment and updates related state accordingly.
@@ -430,7 +475,7 @@ class default_1 extends yeoman_generator_1.default {
         if (cached) {
             return cached;
         }
-        const prompter = new configuration_1.ConfigPrompter(this.systemLookup, this.layer, this.logger);
+        const prompter = new configuration_1.ConfigPrompter(this.systemLookup, this.layer, this.logger, this.telemetryCollector);
         (0, appWizardCache_1.cachePut)(this.appWizard, { prompter }, this.logger);
         return prompter;
     }
@@ -440,6 +485,7 @@ class default_1 extends yeoman_generator_1.default {
     async _generateAdpProjectArtifactsCF() {
         const projectPath = this.destinationPath();
         const publicVersions = await (0, adp_tooling_1.fetchPublicVersions)(this.logger);
+        this.telemetryCollector.setBatch({ ui5VersionSelected: (0, adp_tooling_1.getLatestVersion)(publicVersions) });
         const manifest = this.cfPrompter.manifest;
         if (!manifest) {
             throw new Error('Manifest not found for base app.');
@@ -459,7 +505,9 @@ class default_1 extends yeoman_generator_1.default {
             backendUrl,
             oauthPaths,
             projectPath,
-            publicVersions
+            publicVersions,
+            packageJson: (0, deps_1.getPackageInfo)(),
+            toolsId: this.toolsId
         });
         if (config.options) {
             config.options.templatePathOverwrite = (0, templates_1.getTemplatesOverwritePath)();
@@ -475,6 +523,9 @@ class default_1 extends yeoman_generator_1.default {
         if (this.isCfEnv) {
             return (0, node_path_1.join)(this.destinationPath(), this.attributeAnswers.projectName);
         }
+        if (this.shouldCreateExtProject) {
+            return (0, node_path_1.join)(process.cwd(), this.attributeAnswers.projectName);
+        }
         return (0, node_path_1.join)(this.attributeAnswers.targetFolder, this.attributeAnswers.projectName);
     }
     /**
@@ -507,6 +558,7 @@ class default_1 extends yeoman_generator_1.default {
         };
         this.abapProvider = await (0, adp_tooling_1.getConfiguredProvider)(providerOptions, this.logger);
         const applications = await (0, adp_tooling_1.loadApps)(this.abapProvider, this.isCustomerBase);
+        this.telemetryCollector.setBatch({ numberOfApplications: applications.length });
         const application = applications.find((application) => application.id === baseApplicationName);
         if (!application) {
             throw new Error((0, i18n_1.t)('error.applicationNotFound', { appName: baseApplicationName }));

package/generators/app/questions/configuration.d.ts

@@ -3,6 +3,7 @@ import { FlexLayer } from '@sap-ux/adp-tooling';
 import { type AbapServiceProvider } from '@sap-ux/axios-extension';
 import type { ToolsLogger } from '@sap-ux/logger';
 import type { Manifest, ManifestNamespace } from '@sap-ux/project-access';
+import type { TelemetryCollector } from '../../telemetry';
 import type { ConfigPromptOptions, ConfigQuestion } from '../types';
 /**
  * A stateful prompter class that creates configuration questions.
@@ -11,6 +12,7 @@ import type { ConfigPromptOptions, ConfigQuestion } from '../types';
 export declare class ConfigPrompter {
     private readonly systemLookup;
     private readonly logger;
+    private readonly telemetryCollector;
     /**
      * Indicates if the current layer is based on a customer base.
      */
@@ -139,8 +141,9 @@ export declare class ConfigPrompter {
      * @param {SystemLookup} systemLookup - The source system class to retrieve system endpoints.
      * @param {FlexLayer} layer - The FlexLayer used to determine the base (customer or otherwise).
      * @param {ToolsLogger} logger - Instance of the logger.
+     * @param {TelemetryCollector} telemetryCollector - Instance of the telemetry collector.
      */
-    constructor(systemLookup: SystemLookup, layer: FlexLayer, logger: ToolsLogger);
+    constructor(systemLookup: SystemLookup, layer: FlexLayer, logger: ToolsLogger, telemetryCollector: TelemetryCollector);
     /**
      * Retrieves an array of configuration questions based on provided options.
      * This is the only public method for retrieving prompts.

package/generators/app/questions/configuration.js

@@ -19,6 +19,7 @@ const validators_1 = require("./helper/validators");
 class ConfigPrompter {
     systemLookup;
     logger;
+    telemetryCollector;
     /**
      * Indicates if the current layer is based on a customer base.
      */
@@ -161,10 +162,12 @@ class ConfigPrompter {
      * @param {SystemLookup} systemLookup - The source system class to retrieve system endpoints.
      * @param {FlexLayer} layer - The FlexLayer used to determine the base (customer or otherwise).
      * @param {ToolsLogger} logger - Instance of the logger.
+     * @param {TelemetryCollector} telemetryCollector - Instance of the telemetry collector.
      */
-    constructor(systemLookup, layer, logger) {
+    constructor(systemLookup, layer, logger, telemetryCollector) {
         this.systemLookup = systemLookup;
         this.logger = logger;
+        this.telemetryCollector = telemetryCollector;
         this.isCustomerBase = layer === "CUSTOMER_BASE" /* FlexLayer.CUSTOMER_BASE */;
     }
     /**
@@ -467,7 +470,10 @@ class ConfigPrompter {
             if (typeof validationResult === 'string') {
                 return validationResult;
             }
+            this.telemetryCollector.startTiming('applicationListLoadingTime');
             this.targetApps = await (0, adp_tooling_1.loadApps)(this.abapProvider, this.isCustomerBase);
+            this.telemetryCollector.setBatch({ numberOfApplications: this.targetApps.length });
+            this.telemetryCollector.endTiming('applicationListLoadingTime');
             this.isLoginSuccessful = true;
             return true;
         }
@@ -506,7 +512,10 @@ class ConfigPrompter {
                 if (typeof validationResult === 'string') {
                     return validationResult;
                 }
+                this.telemetryCollector.startTiming('applicationListLoadingTime');
                 this.targetApps = await (0, adp_tooling_1.loadApps)(this.abapProvider, this.isCustomerBase);
+                this.telemetryCollector.setBatch({ numberOfApplications: this.targetApps.length });
+                this.telemetryCollector.endTiming('applicationListLoadingTime');
             }
             return true;
         }

package/generators/telemetry/collector.d.ts

@@ -0,0 +1,39 @@
+import type { AdpTelemetryData, AdpTelemetryTimerProperties } from '../types';
+/**
+ * Telemetry collector for ADP generator. Tracks telemetry data throughout the generation process.
+ */
+export declare class TelemetryCollector {
+    /**
+     * Map of timing mark names.
+     */
+    private readonly timingMarkNames;
+    /**
+     * Telemetry data.
+     */
+    private readonly data;
+    /**
+     * Gets the telemetry data.
+     *
+     * @returns {AdpTelemetryData} The telemetry data.
+     */
+    get telemetryData(): AdpTelemetryData;
+    /**
+     * Sets a batch of telemetry data.
+     *
+     * @param {Partial<AdpTelemetryData>} data - The data to set.
+     */
+    setBatch(data: Partial<AdpTelemetryData>): void;
+    /**
+     * Starts timing for a specific timer property. Call endTiming with the same key to record the duration.
+     *
+     * @param {keyof AdpTelemetryTimerProperties} key - The timer property name that will store the duration (e.g., 'applicationListLoadingTime').
+     */
+    startTiming(key: keyof AdpTelemetryTimerProperties): void;
+    /**
+     * Ends timing for a specific timer property and sets the duration in the telemetry data in milliseconds.
+     *
+     * @param {keyof AdpTelemetryTimerProperties} key - The timer property name where the duration should be stored (must match the key used in startTiming).
+     */
+    endTiming(key: keyof AdpTelemetryTimerProperties): void;
+}
+//# sourceMappingURL=collector.d.ts.map

package/generators/telemetry/collector.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TelemetryCollector = void 0;
+const telemetry_1 = require("@sap-ux/telemetry");
+const DEFAULT_DATA = {
+    wasExtProjectGenerated: false,
+    wasFlpConfigDone: false,
+    wasDeployConfigDone: false,
+    wasTypeScriptChosen: false
+};
+/**
+ * Telemetry collector for ADP generator. Tracks telemetry data throughout the generation process.
+ */
+class TelemetryCollector {
+    /**
+     * Map of timing mark names.
+     */
+    timingMarkNames = new Map();
+    /**
+     * Telemetry data.
+     */
+    data = { ...DEFAULT_DATA };
+    /**
+     * Gets the telemetry data.
+     *
+     * @returns {AdpTelemetryData} The telemetry data.
+     */
+    get telemetryData() {
+        return this.data;
+    }
+    /**
+     * Sets a batch of telemetry data.
+     *
+     * @param {Partial<AdpTelemetryData>} data - The data to set.
+     */
+    setBatch(data) {
+        Object.assign(this.data, data);
+    }
+    /**
+     * Starts timing for a specific timer property. Call endTiming with the same key to record the duration.
+     *
+     * @param {keyof AdpTelemetryTimerProperties} key - The timer property name that will store the duration (e.g., 'applicationListLoadingTime').
+     */
+    startTiming(key) {
+        const markName = telemetry_1.PerformanceMeasurementAPI.startMark(key);
+        this.timingMarkNames.set(key, markName);
+    }
+    /**
+     * Ends timing for a specific timer property and sets the duration in the telemetry data in milliseconds.
+     *
+     * @param {keyof AdpTelemetryTimerProperties} key - The timer property name where the duration should be stored (must match the key used in startTiming).
+     */
+    endTiming(key) {
+        const markName = this.timingMarkNames.get(key);
+        if (markName !== undefined) {
+            telemetry_1.PerformanceMeasurementAPI.endMark(markName);
+            telemetry_1.PerformanceMeasurementAPI.measure(markName);
+            const duration = telemetry_1.PerformanceMeasurementAPI.getMeasurementDuration(markName);
+            this.setBatch({ [key]: duration });
+            this.timingMarkNames.delete(key);
+        }
+    }
+}
+exports.TelemetryCollector = TelemetryCollector;
+//# sourceMappingURL=collector.js.map

package/generators/{telemetryEvents/index.d.ts → telemetry/events.d.ts}

@@ -4,4 +4,4 @@
 export declare enum EventName {
     ADAPTATION_PROJECT_CREATED = "ADAPTATION_PROJECT_CREATED"
 }
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=events.d.ts.map

package/generators/{telemetryEvents/index.js → telemetry/events.js}

@@ -8,4 +8,4 @@ var EventName;
 (function (EventName) {
     EventName["ADAPTATION_PROJECT_CREATED"] = "ADAPTATION_PROJECT_CREATED";
 })(EventName || (exports.EventName = EventName = {}));
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=events.js.map

package/generators/telemetry/index.d.ts

@@ -0,0 +1,3 @@
+export * from './collector';
+export * from './events';
+//# sourceMappingURL=index.d.ts.map

package/generators/telemetry/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./collector"), exports);
+__exportStar(require("./events"), exports);
+//# sourceMappingURL=index.js.map

package/generators/types.d.ts

@@ -8,4 +8,59 @@ export interface Credentials {
     username: string;
     password: string;
 }
+/**
+ * Properties that can be timed (duration measurements in milliseconds).
+ */
+export interface AdpTelemetryTimerProperties {
+    /**
+     * Application list loading time in milliseconds.
+     */
+    applicationListLoadingTime?: number;
+}
+/**
+ * Regular telemetry data properties (non-timing).
+ */
+export interface AdpTelemetryProperties {
+    /**
+     * Project type: onprem, cloud, or cf.
+     */
+    projectType?: 'onPremise' | 'cloudReady' | 'cf';
+    /**
+     * Base app technical name (SAP app ID).
+     */
+    baseAppTechnicalName?: string;
+    /**
+     * UI5 version selected by the user.
+     */
+    ui5VersionSelected?: string;
+    /**
+     * System UI5 version detected.
+     */
+    systemUI5Version?: string;
+    /**
+     * Number of applications in the list.
+     */
+    numberOfApplications?: number;
+    /**
+     * Whether an extension project was generated.
+     */
+    wasExtProjectGenerated: boolean;
+    /**
+     * Whether FLP configuration was done during initial generation.
+     */
+    wasFlpConfigDone: boolean;
+    /**
+     * Whether deploy configuration was done during initial generation.
+     */
+    wasDeployConfigDone: boolean;
+    /**
+     * Whether TypeScript was chosen.
+     */
+    wasTypeScriptChosen: boolean;
+}
+/**
+ * Complete telemetry data collected throughout the ADP generation process.
+ */
+export interface AdpTelemetryData extends AdpTelemetryProperties, AdpTelemetryTimerProperties {
+}
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -3,7 +3,7 @@
   "displayName": "SAPUI5 Adaptation Project",
   "homepage": "https://help.sap.com/viewer/584e0bcbfd4a4aff91c815cefa0bce2d/Cloud/en-US/ada9567b767941aba8d49fdb4fdedea7.html",
   "description": "Adaptation project allows you to create an app variant for an existing SAP Fiori elements-based or SAPUI5 freestyle application, without changing the original application.",
-  "version": "0.7.21",
+  "version": "0.7.24",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,18 +30,19 @@
     "i18next": "25.3.0",
     "yeoman-generator": "5.10.0",
     "uuid": "10.0.0",
-    "@sap-ux/adp-tooling": "0.18.21",
-    "@sap-ux/axios-extension": "1.24.6",
+    "@sap-ux/adp-tooling": "0.18.24",
+    "@sap-ux/axios-extension": "1.25.0",
     "@sap-ux/btp-utils": "1.1.6",
     "@sap-ux/feature-toggle": "0.3.5",
-    "@sap-ux/inquirer-common": "0.9.16",
+    "@sap-ux/inquirer-common": "0.10.0",
     "@sap-ux/logger": "0.7.2",
     "@sap-ux/project-access": "1.32.16",
-    "@sap-ux/store": "1.3.5",
-    "@sap-ux/system-access": "0.6.32",
+    "@sap-ux/store": "1.4.0",
+    "@sap-ux/system-access": "0.6.34",
     "@sap-ux/project-input-validator": "0.6.38",
-    "@sap-ux/fiori-generator-shared": "0.13.43",
-    "@sap-ux/odata-service-writer": "0.27.38"
+    "@sap-ux/fiori-generator-shared": "0.13.44",
+    "@sap-ux/odata-service-writer": "0.28.0",
+    "@sap-ux/telemetry": "0.6.48"
   },
   "devDependencies": {
     "@jest/types": "30.0.1",
@@ -56,7 +57,7 @@
     "fs-extra": "10.0.0",
     "rimraf": "6.0.1",
     "yeoman-test": "6.3.0",
-    "@sap-ux/deploy-config-sub-generator": "0.5.19"
+    "@sap-ux/deploy-config-sub-generator": "0.5.22"
   },
   "engines": {
     "node": ">=20.x"