@sap-ux/abap-deploy-config-sub-generator 0.1.8 → 0.1.9

package/generators/app/index.js

@@ -6,7 +6,6 @@ const deploy_config_generator_shared_1 = require("@sap-ux/deploy-config-generato
 const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 const abap_deploy_config_inquirer_1 = require("@sap-ux/abap-deploy-config-inquirer");
 const abap_deploy_config_writer_1 = require("@sap-ux/abap-deploy-config-writer");
-const telemetry_1 = require("@sap-ux/telemetry");
 const ui5_config_1 = require("@sap-ux/ui5-config");
 const project_access_1 = require("@sap-ux/project-access");
 const store_1 = require("@sap-ux/store");
@@ -49,11 +48,8 @@ class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
     async initializing() {
         await super.initializing();
         await (0, i18n_1.initI18n)();
-        if (this.env.conflicter) {
-            this.env.conflicter.force = this.options.force ?? true;
-        }
         deploy_config_generator_shared_1.DeploymentGenerator.logger?.debug((0, utils_1.t)('debug.initTelemetry'));
-        await (0, telemetry_1.initTelemetrySettings)({
+        await fiori_generator_shared_1.TelemetryHelper.initTelemetrySettings({
             consumerModule: {
                 name: '@sap-ux/abap-deploy-config-sub-generator',
                 version: this.rootGeneratorVersion()
@@ -61,6 +57,9 @@ class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
             internalFeature: (0, feature_toggle_1.isInternalFeaturesSettingEnabled)(),
             watchTelemetrySettingStore: false
         });
+        if (this.env.conflicter) {
+            this.env.conflicter.force = this.options.force ?? true;
+        }
         if (!this.launchDeployConfigAsSubGenerator) {
             await this._initializing();
         }
@@ -165,14 +164,29 @@ class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
             const prompAnswers = await this.prompt(abapDeployConfigPrompts);
             this.answers = (0, abap_deploy_config_inquirer_1.reconcileAnswers)(prompAnswers, abapAnswers);
         }
-        this._reconcileAnswersWithOptions();
+        await this._reconcileAnswersWithOptions();
     }
-    _processAbapTargetAnswers() {
+    async _processAbapTargetAnswers() {
         this.answers.destination = this.options.destination || this.answers.destination;
-        this.answers.url = this.options.url || this.answers.url;
+        this.answers.url =
+            this.options.url || this.answers.url || (await (0, utils_1.determineUrlFromDestination)(this.answers.destination));
         this.answers.client = this.options.client || this.answers.client;
-        this.answers.scp = this.options.scp || this.answers.scp;
-        this.answers.isS4HC = this.options.isS4HC || this.answers.isS4HC;
+        this.answers.scp =
+            this.options.scp ||
+                this.answers.scp ||
+                (await (0, utils_1.determineScpFromTarget)({
+                    url: this.answers.url,
+                    client: this.answers.client,
+                    destination: this.answers.destination
+                }));
+        this.answers.isS4HC =
+            this.options.isS4HC ||
+                this.answers.isS4HC ||
+                (await (0, utils_1.determineS4HCFromTarget)({
+                    url: this.answers.url,
+                    client: this.answers.client,
+                    destination: this.answers.destination
+                }));
         if (!(0, btp_utils_1.isAppStudio)() && this.answers.scp) {
             // ensure there is no client for SCP on vscode
             delete this.answers.client;
@@ -191,7 +205,9 @@ class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
         // Set transport
         if (!this.answers.transport) {
             this.answers.transport =
-                (0, abap_deploy_config_inquirer_1.getTransportAnswer)(this.options) || (0, abap_deploy_config_inquirer_1.getTransportAnswer)(this.answers);
+                this.options.transport ??
+                    ((0, abap_deploy_config_inquirer_1.getTransportAnswer)(this.options) ||
+                        (0, abap_deploy_config_inquirer_1.getTransportAnswer)(this.answers));
         }
     }
     /**
@@ -199,8 +215,8 @@ class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
      *
      * Options may be passed from parent generator, or from the command line.
      */
-    _reconcileAnswersWithOptions() {
-        this._processAbapTargetAnswers();
+    async _reconcileAnswersWithOptions() {
+        await this._processAbapTargetAnswers();
         this._processBspAppAnswers();
         this.answers.index = this.options.index ?? this.answers.index;
         this.answers.overwrite = this.options.overwrite ?? this.answers.overwrite;

package/generators/utils/helpers.d.ts

@@ -0,0 +1,23 @@
+import type { AbapTarget } from '@sap-ux/ui5-config';
+/**
+ * Retrieves the URL for the provided destination.
+ *
+ * @param destination - the destination name
+ * @returns the URL of the destination or undefined if not found
+ */
+export declare function determineUrlFromDestination(destination?: string): Promise<string | undefined>;
+/**
+ * Determines if the ABAP target is a cloud system.
+ *
+ * @param target - abap target containing either a destination or a URL
+ * @returns - true if the target is a cloud system, false otherwise
+ */
+export declare function determineScpFromTarget(target: AbapTarget): Promise<boolean>;
+/**
+ * Determine if the ABAP target is an S4 Hana Cloud system.
+ *
+ * @param target - abap target containing either a destination or a URL
+ * @returns - true if the target is an s4hana cloud system, false otherwise
+ */
+export declare function determineS4HCFromTarget(target: AbapTarget): Promise<boolean>;
+//# sourceMappingURL=helpers.d.ts.map

package/generators/utils/helpers.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.determineUrlFromDestination = determineUrlFromDestination;
+exports.determineScpFromTarget = determineScpFromTarget;
+exports.determineS4HCFromTarget = determineS4HCFromTarget;
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const deploy_config_generator_shared_1 = require("@sap-ux/deploy-config-generator-shared");
+const store_1 = require("@sap-ux/store");
+let cachedDestinations = {};
+let cachedBackendSystems = [];
+/**
+ * Small utility function to check whether the backend system keys are identical.
+ *
+ * @param backend  - backend system from the store
+ * @param target - the abap target passed in
+ * @returns true if the systems are the same
+ */
+function isSameSystem(backend, target) {
+    return (backend.url.trim().replace(/\/$/, '') === target.url?.trim().replace(/\/$/, '') &&
+        (backend.client ?? '') === (target?.client ?? ''));
+}
+/**
+ * Retrieve the destinations from SAP BTP.
+ *
+ * @returns destinations object
+ */
+async function getDestinations() {
+    if (Object.keys(cachedDestinations)?.length === 0) {
+        try {
+            cachedDestinations = await (0, btp_utils_1.listDestinations)({ stripS4HCApiHosts: true });
+        }
+        catch (e) {
+            deploy_config_generator_shared_1.DeploymentGenerator.logger.error(`Failed to fetch destinations. Error: ${e.message}`);
+        }
+    }
+    return cachedDestinations;
+}
+/**
+ * Retrieve the list of backend systems from the secure store.
+ *
+ * @returns list of backend systems
+ */
+async function getBackendSystems() {
+    if (cachedBackendSystems?.length === 0) {
+        try {
+            const systemStore = await (0, store_1.getService)({
+                logger: deploy_config_generator_shared_1.DeploymentGenerator.logger,
+                entityName: 'system'
+            });
+            cachedBackendSystems = await systemStore?.getAll();
+        }
+        catch (e) {
+            deploy_config_generator_shared_1.DeploymentGenerator.logger.error(`Failed to fetch systems list. Error: ${e.message}`);
+        }
+    }
+    return cachedBackendSystems;
+}
+/**
+ * Retrieves the URL for the provided destination.
+ *
+ * @param destination - the destination name
+ * @returns the URL of the destination or undefined if not found
+ */
+async function determineUrlFromDestination(destination) {
+    let url;
+    if ((0, btp_utils_1.isAppStudio)() && destination) {
+        const destinations = await getDestinations();
+        url = destinations?.[destination]?.Host;
+    }
+    return url;
+}
+/**
+ * Determines if the ABAP target is a cloud system.
+ *
+ * @param target - abap target containing either a destination or a URL
+ * @returns - true if the target is a cloud system, false otherwise
+ */
+async function determineScpFromTarget(target) {
+    let isScp = false;
+    if ((0, btp_utils_1.isAppStudio)() && target.destination) {
+        const destinations = await getDestinations();
+        if (destinations?.[target.destination]) {
+            isScp = (0, btp_utils_1.isAbapEnvironmentOnBtp)(destinations?.[target.destination]);
+        }
+    }
+    else if (target.url) {
+        const backendSystems = await getBackendSystems();
+        const backendSystem = backendSystems?.find((backend) => isSameSystem(backend, target));
+        isScp = !!backendSystem?.serviceKeys;
+    }
+    return isScp;
+}
+/**
+ * Determine if the ABAP target is an S4 Hana Cloud system.
+ *
+ * @param target - abap target containing either a destination or a URL
+ * @returns - true if the target is an s4hana cloud system, false otherwise
+ */
+async function determineS4HCFromTarget(target) {
+    let isS4HCloud = false;
+    if ((0, btp_utils_1.isAppStudio)() && target.destination) {
+        const destinations = await getDestinations();
+        if (destinations?.[target.destination]) {
+            isS4HCloud = (0, btp_utils_1.isS4HC)(destinations?.[target.destination]);
+        }
+    }
+    else if (target.url) {
+        const backendSystems = await getBackendSystems();
+        const backendSystem = backendSystems?.find((backend) => isSameSystem(backend, target));
+        isS4HCloud = backendSystem?.authenticationType === store_1.AuthenticationType.ReentranceTicket;
+    }
+    return isS4HCloud;
+}
+//# sourceMappingURL=helpers.js.map

package/generators/utils/index.d.ts

@@ -1,4 +1,5 @@
 export { indexHtmlExists } from './project';
 export { handleProjectDoesNotExist } from './error-handler';
 export { t } from './i18n';
+export { determineScpFromTarget, determineUrlFromDestination, determineS4HCFromTarget } from './helpers';
 //# sourceMappingURL=index.d.ts.map

package/generators/utils/index.js

@@ -1,10 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.t = exports.handleProjectDoesNotExist = exports.indexHtmlExists = void 0;
+exports.determineS4HCFromTarget = exports.determineUrlFromDestination = exports.determineScpFromTarget = exports.t = exports.handleProjectDoesNotExist = exports.indexHtmlExists = void 0;
 var project_1 = require("./project");
 Object.defineProperty(exports, "indexHtmlExists", { enumerable: true, get: function () { return project_1.indexHtmlExists; } });
 var error_handler_1 = require("./error-handler");
 Object.defineProperty(exports, "handleProjectDoesNotExist", { enumerable: true, get: function () { return error_handler_1.handleProjectDoesNotExist; } });
 var i18n_1 = require("./i18n");
 Object.defineProperty(exports, "t", { enumerable: true, get: function () { return i18n_1.t; } });
+var helpers_1 = require("./helpers");
+Object.defineProperty(exports, "determineScpFromTarget", { enumerable: true, get: function () { return helpers_1.determineScpFromTarget; } });
+Object.defineProperty(exports, "determineUrlFromDestination", { enumerable: true, get: function () { return helpers_1.determineUrlFromDestination; } });
+Object.defineProperty(exports, "determineS4HCFromTarget", { enumerable: true, get: function () { return helpers_1.determineS4HCFromTarget; } });
 //# sourceMappingURL=index.js.map

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/SAP/open-ux-tools.git",
     "directory": "packages/abap-deploy-config-sub-generator"
   },
-  "version": "0.1.8",
+  "version": "0.1.9",
   "license": "Apache-2.0",
   "main": "generators/app/index.js",
   "files": [
@@ -21,15 +21,14 @@
   "dependencies": {
     "i18next": "23.5.1",
     "@sap-devx/yeoman-ui-types": "1.14.4",
-    "@sap-ux/abap-deploy-config-inquirer": "1.4.8",
+    "@sap-ux/abap-deploy-config-inquirer": "1.4.9",
     "@sap-ux/abap-deploy-config-writer": "0.1.4",
     "@sap-ux/btp-utils": "1.1.0",
-    "@sap-ux/deploy-config-generator-shared": "0.1.4",
+    "@sap-ux/deploy-config-generator-shared": "0.1.5",
     "@sap-ux/feature-toggle": "0.3.0",
-    "@sap-ux/fiori-generator-shared": "0.12.4",
+    "@sap-ux/fiori-generator-shared": "0.12.5",
     "@sap-ux/logger": "0.7.0",
     "@sap-ux/project-access": "1.30.2",
-    "@sap-ux/telemetry": "0.6.3",
     "@sap-ux/ui5-config": "0.28.2"
   },
   "devDependencies": {