feat: Adapt CF ADP project structure to work with approuter backend middleware (#4436)

* feat: add approuter support

* refactor: code improvements

* refactor: interfaces and jsdocs

* refactor: code and split methods

* refactor: move types

* chore: add cset

* refactor: move types

* refactor: set default env options in process

* refactor: code improvements

* refactor: middleware options

* test: add test suites

* test: add test suites

* fix: sonar issues

* refactor: improve code quality and tests

* test: add test case

* fix: sonar issue with regxp

* feat: add service cred retrieval for approuter env options

* test: add new tooling tests

* test: add missing test cases

* fix: sonar issues

* fix: dest merging from env path

* fix: review comments

* feat: add approuter lazy loading, dynamic port allocation, loop prevention mechanism

* fix: sonar issue

* refactor: move interfaces

* refactor: code improvements

* feat: add needed configurations for bas

* refactor: clear text

* feat: update xsuaa service runtime

* fix: incorrect credentials object return for vcap services

* fix: add error handling for approuter start

* Linting auto fix commit

* fix: add wait flag for cf cli when updating service

* refactor: adjust the structure of cf project and clenup files

* refactor: bump package versions

* chore: add cset

* refactor: remove comment

* chore: update cset

* fix: review comments

* fix: merge errors

* chore: remove extra cset

* test: update snapshot

* fix: bump specVersion of cf backend middleware

* chore: update cset

* fix: version ^

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: nikmace

.changeset/strict-papers-shave.md

@@ -0,0 +1,8 @@
+---
+'@sap-ux/generator-adp': patch
+'@sap-ux/adp-tooling': patch
+'@sap-ux/create': patch
+'@sap-ux/backend-proxy-middleware-cf': patch
+---
+
+feat: Adapt CF ADP project structure to work with approuter backend middleware

packages/adp-tooling/src/cf/app/discovery.ts

@@ -1,13 +1,11 @@
 import type AdmZip from 'adm-zip';
-import { readFileSync, existsSync } from 'node:fs';
-import { join } from 'node:path';
 
 import type { ToolsLogger } from '@sap-ux/logger';
 
 import { t } from '../../i18n';
 import { extractXSApp } from '../utils';
 import { getFDCApps } from '../services/api';
-import type { CfConfig, CFApp, ServiceKeys, XsApp, XsAppRoute } from '../../types';
+import type { CfConfig, CFApp, ServiceKeys, XsApp } from '../../types';
 
 /**
  * Get the app host ids from service keys.
@@ -56,30 +54,6 @@ export function getBackendUrlsFromServiceKeys(serviceKeys: ServiceKeys[]): strin
     return urls;
 }
 
-/**
- * Extract destination to URL mapping from service key endpoints.
- *
- * @param {ServiceKeys[]} serviceKeys - The service keys containing endpoints.
- * @returns {Map<string, string>} Map of destination names to URLs.
- */
-function extractDestinationToUrlMap(serviceKeys: ServiceKeys[]): Map<string, string> {
-    const destinationToUrl = new Map<string, string>();
-    const endpoints = serviceKeys[0]?.credentials?.endpoints as
-        | Record<string, { url?: string; destination?: string }>
-        | undefined;
-
-    if (endpoints && typeof endpoints === 'object') {
-        for (const key in endpoints) {
-            const endpoint = endpoints[key];
-            if (endpoint?.url && endpoint.destination) {
-                destinationToUrl.set(endpoint.destination, endpoint.url);
-            }
-        }
-    }
-
-    return destinationToUrl;
-}
-
 /**
  * Clean regex pattern from route source.
  *
@@ -105,116 +79,6 @@ function cleanRoutePath(source: string): string {
     return path;
 }
 
-/**
- * Process a route and extract path and pathRewrite from source and target.
- *
- * @param {XsAppRoute} route - The route object from xs-app.json.
- * @param {Map<string, { paths: Set<string>; pathRewrite?: string }>} destinationToPaths - Map to store destination info.
- */
-function processRouteForDestination(
-    route: XsAppRoute,
-    destinationToPaths: Map<string, { paths: Set<string>; pathRewrite?: string }>
-): void {
-    const destination = route.destination;
-    const service = route.service;
-
-    if (!destination || service === 'html5-apps-repo-rt' || !route.source) {
-        return;
-    }
-
-    const path = cleanRoutePath(route.source);
-    if (path) {
-        if (!destinationToPaths.has(destination)) {
-            destinationToPaths.set(destination, { paths: new Set<string>() });
-        }
-
-        const destInfo = destinationToPaths.get(destination)!;
-        destInfo.paths.add(path);
-
-        // Extract pathRewrite from target if available
-        if (route.target && typeof route.target === 'string') {
-            const pathRewrite = cleanRoutePath(route.target);
-            if (pathRewrite && !destInfo.pathRewrite) {
-                destInfo.pathRewrite = pathRewrite;
-            }
-        }
-    }
-}
-
-/**
- * Extract destination to paths mapping from xs-app.json routes with pathRewrite info.
- *
- * @param {string} xsAppPath - Path to xs-app.json file.
- * @returns {Map<string, { paths: Set<string>; pathRewrite?: string }>} Map of destination names to path info.
- */
-function extractDestinationToPathsMap(xsAppPath: string): Map<string, { paths: Set<string>; pathRewrite?: string }> {
-    const destinationToPaths = new Map<string, { paths: Set<string>; pathRewrite?: string }>();
-
-    try {
-        const xsAppContent = readFileSync(xsAppPath, 'utf8');
-        const xsApp = JSON.parse(xsAppContent) as XsApp;
-
-        if (xsApp?.routes) {
-            for (const route of xsApp.routes) {
-                processRouteForDestination(route, destinationToPaths);
-            }
-        }
-    } catch (e) {
-        throw new Error(t('error.invalidXsAppJson', { error: (e as Error).message }));
-    }
-
-    return destinationToPaths;
-}
-
-/**
- * Maps backend URLs to their corresponding OAuth paths based on destination matching
- * between xs-app.json routes and credentials.json endpoints.
- *
- * @param {ServiceKeys[]} serviceKeys - The service keys containing endpoints with destinations.
- * @param {string} basePath - Path to the .adp/reuse folder containing xs-app.json files.
- * @returns {Array<{ url: string; paths: string[]; pathRewrite?: string }>} Array of URL-to-paths mappings with optional pathRewrite.
- */
-export function getBackendUrlsWithPaths(
-    serviceKeys: ServiceKeys[],
-    basePath: string
-): Array<{ url: string; paths: string[]; pathRewrite?: string }> {
-    const destinationToUrl = extractDestinationToUrlMap(serviceKeys);
-
-    const reuseXsAppPath = join(basePath, '.adp', 'reuse', 'xs-app.json');
-    const distXsAppPath = join(basePath, 'dist', 'xs-app.json');
-
-    let xsAppPath: string;
-    if (existsSync(reuseXsAppPath)) {
-        xsAppPath = reuseXsAppPath;
-    } else if (existsSync(distXsAppPath)) {
-        xsAppPath = distXsAppPath;
-    } else {
-        throw new Error(t('error.xsAppJsonNotFound', { paths: `${reuseXsAppPath}, ${distXsAppPath}` }));
-    }
-
-    const destinationToPaths = extractDestinationToPathsMap(xsAppPath);
-
-    const result = [];
-
-    for (const [destination, pathInfo] of destinationToPaths.entries()) {
-        const url = destinationToUrl.get(destination);
-        if (url) {
-            const entry: { url: string; paths: string[]; pathRewrite?: string } = {
-                url,
-                paths: Array.from(pathInfo.paths)
-            };
-
-            if (pathInfo.pathRewrite) {
-                entry.pathRewrite = pathInfo.pathRewrite;
-            }
-
-            result.push(entry);
-        }
-    }
-
-    return result;
-}
-
 /**
  * Extract endpoint destinations from service keys.
  *

packages/adp-tooling/src/cf/project/ui5-app-info.ts

@@ -4,7 +4,6 @@ import yaml from 'js-yaml';
 import type { Editor } from 'mem-fs-editor';
 
 import type { ToolsLogger } from '@sap-ux/logger';
-import type { UI5Config } from '@sap-ux/ui5-config';
 
 import type {
     MtaModule,
@@ -19,9 +18,7 @@ import type {
 import { AppRouterType } from '../../types';
 import { createServices } from '../services/api';
 import { getProjectNameForXsSecurity, getYamlContent } from './yaml-loader';
-import { getBackendUrlsWithPaths, getServiceKeyDestinations } from '../app/discovery';
-import { getVariant } from '../../base/helper';
-import { getReusableLibraryPaths } from './ui5-app-info';
+import { getServiceKeyDestinations } from '../app/discovery';
 
 const CF_MANAGED_SERVICE = 'org.cloudfoundry.managed-service';
 const HTML5_APPS_REPO = 'html5-apps-repo';
@@ -502,96 +499,3 @@ export async function adjustMtaYaml(
 
     return yamlContent;
 }
-
-/**
- * Add fiori-tools-servestatic configuration to ui5.yaml and removes previously added configuration.
- *
- * @param basePath - path to application root
- * @param ui5Config - UI5 configuration object
- * @param logger - logger instance
- */
-export async function addServeStaticMiddleware(
-    basePath: string,
-    ui5Config: UI5Config,
-    logger?: ToolsLogger
-): Promise<void> {
-    try {
-        if (ui5Config.findCustomMiddleware('fiori-tools-servestatic')) {
-            ui5Config.removeCustomMiddleware('fiori-tools-servestatic');
-        }
-
-        const paths: Array<{ path: string; src: string; fallthrough: boolean }> = [];
-
-        // Add reusable library paths from ui5AppInfo.json if it exists
-        paths.push(...getReusableLibraryPaths(basePath, logger));
-
-        const variant = await getVariant(basePath);
-        const builtVariantId = variant.id.replaceAll('.', '_');
-
-        paths.push(
-            {
-                path: `/changes/${builtVariantId}`,
-                src: './webapp/changes',
-                fallthrough: true
-            },
-            {
-                path: `/${builtVariantId}/i18n`,
-                src: './webapp/i18n',
-                fallthrough: true
-            }
-        );
-
-        ui5Config.addCustomMiddleware([
-            {
-                name: 'fiori-tools-servestatic',
-                beforeMiddleware: 'compression',
-                configuration: {
-                    paths
-                }
-            }
-        ]);
-    } catch (error) {
-        logger?.warn(`Could not add fiori-tools-servestatic configuration: ${(error as Error).message}`);
-        throw error;
-    }
-}
-
-/**
- * Add backend-proxy-middleware-cf configuration to ui5.yaml.
- *
- * @param basePath - path to application root
- * @param ui5Config - UI5 configuration object
- * @param serviceKeys - service keys from Cloud Foundry
- * @param logger - logger instance
- */
-export function addBackendProxyMiddleware(
-    basePath: string,
-    ui5Config: UI5Config,
-    serviceKeys: ServiceKeys[],
-    logger?: ToolsLogger
-): void {
-    try {
-        if (ui5Config.findCustomMiddleware('backend-proxy-middleware-cf')) {
-            ui5Config.removeCustomMiddleware('backend-proxy-middleware-cf');
-        }
-
-        const urlsWithPaths = getBackendUrlsWithPaths(serviceKeys, basePath);
-
-        if (urlsWithPaths.length === 0) {
-            logger?.info('No backend URLs with paths found. Skipping backend-proxy-middleware-cf configuration.');
-            return;
-        }
-
-        ui5Config.addCustomMiddleware([
-            {
-                name: 'backend-proxy-middleware-cf',
-                afterMiddleware: 'compression',
-                configuration: {
-                    backends: urlsWithPaths
-                }
-            }
-        ]);
-    } catch (error) {
-        logger?.warn(`Could not add backend-proxy-middleware-cf configuration: ${(error as Error).message}`);
-    }
-}

packages/adp-tooling/src/cf/project/yaml.ts

@@ -10,8 +10,6 @@ import {
     adjustMtaYaml,
     getAppHostIds,
     getOrCreateServiceInstanceKeys,
-    addServeStaticMiddleware,
-    addBackendProxyMiddleware,
     getCfUi5AppInfo,
     getProjectNameForXsSecurity
 } from '../cf';
@@ -121,24 +119,20 @@ export async function writeUi5AppInfo(basePath: string, ui5AppInfo: CfUi5AppInfo
 }
 
 /**
- * Generate CF configuration for an adaptation project.
+ * Setup CF adaptation project for local preview.
+ * Fetches ui5AppInfo.json and builds the project.
  *
  * @param basePath - path to project root
  * @param yamlPath - path to the project configuration file in YAML format
  * @param cfConfig - CF configuration
  * @param logger - logger instance
- * @param fs - mem-fs editor instance
- * @returns updated mem-fs editor instance
  */
-export async function generateCfConfig(
+export async function setupCfPreview(
     basePath: string,
     yamlPath: string,
     cfConfig: CfConfig,
-    logger?: ToolsLogger,
-    fs?: Editor
-): Promise<Editor> {
-    fs ??= create(createStorage());
-
+    logger?: ToolsLogger
+): Promise<void> {
     const ui5Config = await readUi5Yaml(basePath, yamlPath);
 
     const bundlerTask = ui5Config.findCustomTask<{ space?: string; serviceInstanceName?: string }>(
@@ -170,10 +164,5 @@ export async function generateCfConfig(
     }
 
     await writeUi5AppInfo(basePath, ui5AppInfo, logger);
-    await addServeStaticMiddleware(basePath, ui5Config, logger);
     await runBuild(basePath, { ADP_BUILDER_MODE: 'preview' });
-    addBackendProxyMiddleware(basePath, ui5Config, serviceInfo.serviceKeys, logger);
-
-    fs.write(join(basePath, yamlPath), ui5Config.toString());
-    return fs;
 }