TBI - Replace service key (UAA/OAuth2) based connections with re-entrance tickets

packages/abap-deploy-config-inquirer/src/prompts/conditions.ts

@@ -60,7 +60,7 @@ export function showScpQuestion(previousAnswers: AbapDeployConfigAnswersInternal
  */
 function showClientCondition(scp?: boolean): boolean {
     return Boolean(
-        !isAppStudio() && !PromptState.abapDeployConfig?.isS4HC && !scp && !PromptState.abapDeployConfig?.scp
+        !isAppStudio() && !PromptState.abapDeployConfig?.isAbapCloud && !scp && !PromptState.abapDeployConfig?.scp
     );
 }
 
@@ -142,7 +142,7 @@ export function showUi5AppDeployConfigQuestion(ui5AbapPromptOptions?: UI5AbapRep
         !ui5AbapPromptOptions?.hide &&
         ui5AbapPromptOptions?.hideIfOnPremise &&
         !PromptState.abapDeployConfig?.scp &&
-        !PromptState.abapDeployConfig?.isS4HC
+        !PromptState.abapDeployConfig?.isAbapCloud
     ) {
         return false;
     }
@@ -238,7 +238,7 @@ function defaultOrShowTransportQuestion(): boolean {
 export function showTransportInputChoice(options?: TransportInputChoicePromptOptions): boolean {
     if (
         options?.hideIfOnPremise === true &&
-        !PromptState.abapDeployConfig?.isS4HC &&
+        !PromptState.abapDeployConfig?.isAbapCloud &&
         !PromptState.abapDeployConfig?.scp
     ) {
         return false;
@@ -276,7 +276,7 @@ export function defaultOrShowTransportListQuestion(
     return (
         transportInputChoice === TransportChoices.ListExistingChoice &&
         !isTransportListEmpty(PromptState.transportAnswers.transportList) &&
-        !(transportInputChoiceOptions?.hideIfOnPremise === true && PromptState?.abapDeployConfig?.isS4HC === false)
+        !(transportInputChoiceOptions?.hideIfOnPremise === true && PromptState?.abapDeployConfig?.isAbapCloud === false)
     );
 }
 
@@ -311,7 +311,8 @@ export function defaultOrShowManualTransportQuestion(
     return (
         defaultOrShowTransportQuestion() &&
         (transportInputChoice === TransportChoices.EnterManualChoice ||
-            (transportInputChoiceOptions?.hideIfOnPremise === true && PromptState?.abapDeployConfig?.isS4HC === false))
+            (transportInputChoiceOptions?.hideIfOnPremise === true &&
+                PromptState?.abapDeployConfig?.isAbapCloud === false))
     );
 }
 

packages/abap-deploy-config-inquirer/src/prompts/helpers.ts

@@ -17,7 +17,7 @@ import {
 } from '../types';
 import { AuthenticationType, type BackendSystem } from '@sap-ux/store';
 import type { ChoiceOptions, ListChoiceOptions } from 'inquirer';
-import { getSystemDisplayName } from '@sap-ux/fiori-generator-shared';
+import { getBackendSystemDisplayName, getSystemDisplayName } from '@sap-ux/fiori-generator-shared';
 import type { AbapServiceProvider } from '@sap-ux/axios-extension';
 
 /**
@@ -40,32 +40,6 @@ function getDestinationChoices(destinations: Destinations = {}): AbapSystemChoic
     return systemChoices;
 }
 
-/**
- * Returns the display name for the backend system.
- *
- * @param options options for display name
- * @param options.backendSystem backend system
- * @param options.includeUserName include user name in the display name
- * @returns backend display name
- */
-function getBackendDisplayName({
-    backendSystem,
-    includeUserName = true
-}: {
-    backendSystem: BackendSystem;
-    includeUserName?: boolean;
-}): string {
-    const userDisplayName = includeUserName && backendSystem.userDisplayName ? `${backendSystem.userDisplayName}` : '';
-    const systemDisplayName = getSystemDisplayName(
-        backendSystem.name,
-        userDisplayName,
-        !!backendSystem.serviceKeys,
-        backendSystem.authenticationType === AuthenticationType.ReentranceTicket
-    );
-
-    return systemDisplayName;
-}
-
 /**
  * Returns a list of backend system choices.
  *
@@ -102,12 +76,12 @@ async function getBackendTargetChoices(
             }
             return {
                 name: isDefault
-                    ? `${getBackendDisplayName({ backendSystem: system })} (Source system)`
-                    : getBackendDisplayName({ backendSystem: system }) ?? '',
+                    ? `${getBackendSystemDisplayName(system)} (Source system)`
+                    : getBackendSystemDisplayName(system) ?? '',
                 value: system.url,
                 isDefault,
-                scp: !!system.serviceKeys,
-                isS4HC: system.authenticationType === AuthenticationType.ReentranceTicket,
+                scp: !!system.serviceKeys, // legacy service key store entries
+                isAbapCloud: system.authenticationType === AuthenticationType.ReentranceTicket,
                 client: system.client
             };
         });
@@ -123,13 +97,14 @@ async function getBackendTargetChoices(
             name: `${getSystemDisplayName(
                 systemName,
                 user,
-                target.scp,
-                target.authenticationType === AuthenticationType.ReentranceTicket
+                target.scp || target.authenticationType === AuthenticationType.ReentranceTicket
+                    ? 'ABAPCloud'
+                    : undefined // scp is retained for legacy apps yamls that contain this value
             )} (Source system)`,
             value: target.url,
             isDefault: true,
             scp: target.scp,
-            isS4HC: target.authenticationType === AuthenticationType.ReentranceTicket,
+            isAbapCloud: target.authenticationType === AuthenticationType.ReentranceTicket,
             client: target.client
         });
     }

packages/abap-deploy-config-inquirer/src/prompts/validators.ts

@@ -50,7 +50,7 @@ const allowedPackagePrefixes = ['$', 'Z', 'Y', 'SAP'];
 async function validateSystemType(options?: TargetSystemPromptOptions): Promise<boolean | string> {
     if (options?.additionalValidation?.shouldRestrictDifferentSystemType) {
         const isDefaultProviderAbapCloud = AbapServiceProviderManager.getIsDefaultProviderAbapCloud();
-        const isSelectedS4HC = PromptState?.abapDeployConfig?.isS4HC;
+        const isSelectedS4HC = PromptState?.abapDeployConfig?.isAbapCloud;
         if (isDefaultProviderAbapCloud === true && isSelectedS4HC === false) {
             return t('errors.validators.invalidCloudSystem');
         } else if (isDefaultProviderAbapCloud === false && isSelectedS4HC) {
@@ -90,26 +90,26 @@ export async function validateDestinationQuestion(
  * @param props - properties to update
  * @param props.url - url
  * @param props.client - client
- * @param props.isS4HC - is S/4HANA Cloud
+ * @param props.isAbapCloud - Cloud based Abap (either Steampunk or Embedded Steampunk)
  * @param props.scp - is SCP
  * @param props.target - target system
  */
 function updatePromptState({
     url,
     client,
-    isS4HC,
+    isAbapCloud,
     scp,
     target
 }: {
     url: string;
     client?: string;
-    isS4HC?: boolean;
+    isAbapCloud?: boolean;
     scp?: boolean;
     target?: string;
 }): void {
     PromptState.abapDeployConfig.url = url;
     PromptState.abapDeployConfig.client = client;
-    PromptState.abapDeployConfig.isS4HC = isS4HC;
+    PromptState.abapDeployConfig.isAbapCloud = isAbapCloud;
     PromptState.abapDeployConfig.scp = scp;
     PromptState.abapDeployConfig.targetSystem = target;
 }
@@ -134,13 +134,12 @@ export async function updateDestinationPromptState(
         updatePromptState({
             url: dest?.Host,
             client: dest['sap-client'],
-            isS4HC: isS4HC(dest),
+            isAbapCloud: isS4HC(dest),
             scp: isAbapEnvironmentOnBtp(dest)
         });
 
         if (options?.additionalValidation?.shouldRestrictDifferentSystemType) {
-            const isS4HCloud = await isAbapCloud(backendTarget);
-            PromptState.abapDeployConfig.isS4HC = isS4HCloud ?? false;
+            PromptState.abapDeployConfig.isAbapCloud = (await isAbapCloud(backendTarget)) ?? false;
         }
     }
 }
@@ -171,7 +170,7 @@ export async function validateTargetSystem(
                 url: choice.value,
                 client: choice.client ?? '',
                 scp: choice.scp,
-                isS4HC: choice.isS4HC,
+                isAbapCloud: choice.isAbapCloud,
                 target: target
             });
         }
@@ -202,7 +201,7 @@ export function validateUrl(input: string): boolean | string {
             url: input.trim(),
             client: backendSystem?.client,
             scp: !!backendSystem?.serviceKeys,
-            isS4HC: backendSystem?.authenticationType === AuthenticationType.ReentranceTicket
+            isAbapCloud: backendSystem?.authenticationType === AuthenticationType.ReentranceTicket
         });
     } else {
         return t('errors.invalidUrl', { url: input?.trim() });
@@ -305,8 +304,7 @@ export async function validateCredentials(
     });
 
     if (isAppStudio() && shouldCheckSystemType) {
-        const isS4HCloud = await isAbapCloud(backendTarget);
-        PromptState.abapDeployConfig.isS4HC = isS4HCloud ?? false;
+        PromptState.abapDeployConfig.isAbapCloud = (await isAbapCloud(backendTarget)) ?? false;
     }
 
     PromptState.transportAnswers.transportConfigNeedsCreds = transportConfigNeedsCreds ?? false;
@@ -646,8 +644,8 @@ export function validateConfirmQuestion(overwrite: boolean): boolean {
  * @returns {Promise<boolean>} - Resolves to `true` if the package is cloud-ready, `false` otherwise.
  */
 async function validatePackageType(input: string, backendTarget?: BackendTarget): Promise<boolean | string> {
-    const isS4HC = PromptState?.abapDeployConfig?.isS4HC;
-    if (!isS4HC) {
+    const isAbapCloud = PromptState?.abapDeployConfig?.isAbapCloud;
+    if (!isAbapCloud) {
         LoggerHelper.logger.debug(`System is OnPremise, skipping package "${input}" type validation`);
         return true;
     }
@@ -819,7 +817,7 @@ function shouldValidatePackageForStartingPrefix(
         !ui5AbapPromptOptions?.hide &&
         !(
             ui5AbapPromptOptions?.hideIfOnPremise === true &&
-            PromptState.abapDeployConfig?.isS4HC === false &&
+            PromptState.abapDeployConfig?.isAbapCloud === false &&
             PromptState.abapDeployConfig?.scp === false
         )
     );

packages/abap-deploy-config-inquirer/src/service-provider-utils/abap-service-provider.ts

@@ -169,7 +169,7 @@ export class AbapServiceProviderManager {
             } as UrlAbapTarget;
 
             if (
-                PromptState.abapDeployConfig.isS4HC ??
+                PromptState.abapDeployConfig.isAbapCloud ??
                 backendTarget?.abapTarget.authenticationType === AuthenticationType.ReentranceTicket
             ) {
                 abapTarget.authenticationType = AuthenticationType.ReentranceTicket;

packages/abap-deploy-config-inquirer/src/types.ts

@@ -46,7 +46,7 @@ export interface AbapSystemChoice {
     url?: string;
     client?: string;
     isDefault?: boolean;
-    isS4HC?: boolean;
+    isAbapCloud?: boolean;
 }
 
 /**
@@ -255,7 +255,7 @@ export interface AbapDeployConfigAnswers {
 export interface AbapDeployConfigAnswersInternal extends AbapDeployConfigAnswers {
     clientChoice?: string;
     username?: string;
-    isS4HC?: boolean;
+    isAbapCloud?: boolean;
     packageInputChoice?: PackageInputChoices;
     packageManual?: string;
     packageAutocomplete?: string;

packages/abap-deploy-config-inquirer/test/fixtures/targets.ts

@@ -1,4 +1,4 @@
-import { AuthenticationType } from '@sap-ux/store';
+import { AuthenticationType, BackendSystem } from '@sap-ux/store';
 
 export const mockTargetSystems = [
     {
@@ -12,7 +12,8 @@ export const mockTargetSystems = [
         url: 'https://mock.url.target2.com',
         client: '102',
         userDisplayName: 'mockUser2',
-        authenticationType: AuthenticationType.ReentranceTicket
+        authenticationType: AuthenticationType.ReentranceTicket,
+        systemType: 'ABAPCloud'
     },
     {
         name: 'target3',

packages/abap-deploy-config-inquirer/test/prompts/conditions.test.ts

@@ -69,20 +69,20 @@ describe('Test abap deploy config inquirer conditions', () => {
     test('should show client choice question', () => {
         mockIsAppStudio.mockReturnValueOnce(false);
         PromptState.isYUI = false;
-        PromptState.abapDeployConfig.isS4HC = false;
+        PromptState.abapDeployConfig.isAbapCloud = false;
         expect(
             showClientChoiceQuestion({ scp: false, targetSystem: TargetSystemType.Url, url: '', package: '' }, '100')
         ).toBe(true);
         PromptState.resetAbapDeployConfig();
         // Should not show client choice question if SCP is enabled
-        PromptState.abapDeployConfig.isS4HC = false;
+        PromptState.abapDeployConfig.isAbapCloud = false;
         PromptState.abapDeployConfig.scp = true;
         expect(
             showClientChoiceQuestion({ scp: false, targetSystem: TargetSystemType.Url, url: '', package: '' }, '100')
         ).toBe(false);
         PromptState.resetAbapDeployConfig();
         // Should not show client choice question if target system is not a URL
-        PromptState.abapDeployConfig.isS4HC = false;
+        PromptState.abapDeployConfig.isAbapCloud = false;
         PromptState.abapDeployConfig.scp = true;
         expect(showClientChoiceQuestion({ scp: true, url: '', package: '' }, '100')).toBe(false);
         PromptState.resetAbapDeployConfig();
@@ -91,7 +91,7 @@ describe('Test abap deploy config inquirer conditions', () => {
     test('should not show client choice question', () => {
         mockIsAppStudio.mockReturnValueOnce(false);
         PromptState.isYUI = false;
-        PromptState.abapDeployConfig.isS4HC = true;
+        PromptState.abapDeployConfig.isAbapCloud = true;
         expect(
             showClientChoiceQuestion({ scp: true, targetSystem: TargetSystemType.Url, url: '', package: '' }, undefined)
         ).toBe(false);
@@ -114,14 +114,14 @@ describe('Test abap deploy config inquirer conditions', () => {
             PromptState.isYUI = isYui;
             mockIsAppStudio.mockReturnValueOnce(false);
             // Validate client question if SCP is enabled
-            PromptState.abapDeployConfig.isS4HC = false;
+            PromptState.abapDeployConfig.isAbapCloud = false;
             expect(showClientQuestion({ scp: true, targetSystem: TargetSystemType.Url, url: '', package: '' })).toBe(
                 scpEnabled
             );
             PromptState.resetAbapDeployConfig();
             // Validate client question if SCP is disabled
             PromptState.abapDeployConfig.client = '100';
-            PromptState.abapDeployConfig.isS4HC = false;
+            PromptState.abapDeployConfig.isAbapCloud = false;
             expect(
                 showClientQuestion({
                     scp: false,
@@ -190,7 +190,7 @@ describe('Test abap deploy config inquirer conditions', () => {
         };
         PromptState.abapDeployConfig.scp = false;
         expect(showUi5AppDeployConfigQuestion(promptOptions)).toBe(false);
-        PromptState.abapDeployConfig.isS4HC = false;
+        PromptState.abapDeployConfig.isAbapCloud = false;
         expect(showUi5AppDeployConfigQuestion(promptOptions)).toBe(false);
     });
 
@@ -237,7 +237,7 @@ describe('Test abap deploy config inquirer conditions', () => {
 
     test('should not show transport input choice question for onPremise systems', () => {
         PromptState.transportAnswers.transportRequired = false;
-        PromptState.abapDeployConfig.isS4HC = false;
+        PromptState.abapDeployConfig.isAbapCloud = false;
         PromptState.abapDeployConfig.scp = false;
         expect(showTransportInputChoice({ hideIfOnPremise: true })).toBe(false);
     });
@@ -267,7 +267,7 @@ describe('Test abap deploy config inquirer conditions', () => {
     });
 
     test('should not show transport list question', () => {
-        PromptState.abapDeployConfig.isS4HC = false;
+        PromptState.abapDeployConfig.isAbapCloud = false;
         PromptState.transportAnswers.transportList = [
             { transportReqNumber: 'K123456', transportReqDescription: 'Mock transport' }
         ];
@@ -303,7 +303,7 @@ describe('Test abap deploy config inquirer conditions', () => {
     });
 
     test('should show manual transport question when transportInput choice is not provided and transportInputChoice is hidden', () => {
-        PromptState.abapDeployConfig.isS4HC = false;
+        PromptState.abapDeployConfig.isAbapCloud = false;
         expect(defaultOrShowManualTransportQuestion(undefined, { hideIfOnPremise: true })).toBe(true);
     });