fix: align mta and package.json changes

.changeset/thin-lizards-melt.md

@@ -0,0 +1,5 @@
+---
+'@sap-ux/cf-deploy-config-writer': patch
+---
+
+Align mta.yaml for standalone and ensure external package.json changes are refected

packages/cf-deploy-config-sub-generator/test/fixtures/sap-ux-test/mta.abapservice.yaml

@@ -26,7 +26,9 @@ resources:
           config:
               tenant-mode: dedicated
               xsappname: sap-ux-test-${space-guid}
+          path: ./xs-security.json
           service: xsuaa
+          service-name: sap-ux-test-xsuaa-service
           service-plan: application
     - name: sap-ux-test-html5-repo-runtime
       type: org.cloudfoundry.managed-service

packages/cf-deploy-config-sub-generator/test/fixtures/sap-ux-test/mta.connectivity.yaml

@@ -26,7 +26,9 @@ resources:
           config:
               tenant-mode: dedicated
               xsappname: sap-ux-test-${space-guid}
+          path: ./xs-security.json
           service: xsuaa
+          service-name: sap-ux-test-xsuaa-service
           service-plan: application
     - name: sap-ux-test-html5-repo-runtime
       type: org.cloudfoundry.managed-service

packages/cf-deploy-config-sub-generator/test/fixtures/sap-ux-test/mta.maximum.yaml

@@ -27,7 +27,9 @@ resources:
           config:
               tenant-mode: dedicated
               xsappname: sap-ux-test-${space-guid}
+          path: ./xs-security.json
           service: xsuaa
+          service-name: sap-ux-test-xsuaa-service
           service-plan: application
     - name: sap-ux-test-html5-repo-runtime
       type: org.cloudfoundry.managed-service

packages/cf-deploy-config-sub-generator/test/fixtures/sap-ux-test/mta.minimum.yaml

@@ -25,7 +25,9 @@ resources:
           config:
               tenant-mode: dedicated
               xsappname: sap-ux-test-${space-guid}
+          path: ./xs-security.json
           service: xsuaa
+          service-name: sap-ux-test-xsuaa-service
           service-plan: application
     - name: sap-ux-test-html5-repo-runtime
       type: org.cloudfoundry.managed-service

packages/cf-deploy-config-writer/package.json

@@ -43,7 +43,8 @@
     "i18next": "25.3.0",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "hasbin": "1.2.3"
+    "hasbin": "1.2.3",
+    "lodash": "4.17.21"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -53,6 +54,7 @@
     "@types/fs-extra": "9.0.13",
     "@types/js-yaml": "4.0.9",
     "@types/semver": "7.5.2",
+    "@types/lodash": "4.14.202",
     "memfs": "3.4.13",
     "js-yaml": "3.14.0",
     "fs-extra": "10.0.0",

packages/cf-deploy-config-writer/src/cf-writer/app-config.ts

@@ -422,7 +422,7 @@ async function updateManifest(cfConfig: CFConfig, fs: Editor): Promise<void> {
  */
 async function updateHTML5AppPackage(cfConfig: CFConfig, fs: Editor): Promise<void> {
     let deployArgs: string[] = [];
-    if (fileExists(fs, join(cfConfig.appPath, FileName.MtaExtYaml))) {
+    if (await fileExists(join(cfConfig.appPath, FileName.MtaExtYaml), fs)) {
         deployArgs = ['-e', FileName.MtaExtYaml];
     }
     // Added for all flows

packages/cf-deploy-config-writer/src/cf-writer/base-config.ts

@@ -25,7 +25,7 @@ export async function generateBaseConfig(config: CFBaseConfig, fs?: Editor, logg
     }
     logger?.debug(`Generate base configuration using: \n ${JSON.stringify(config)}`);
     validateMtaConfig(config);
-    if (fileExists(fs, join(config.mtaPath, config.mtaId))) {
+    if (await fileExists(join(config.mtaPath, config.mtaId), fs)) {
         throw new Error(t('error.mtaFolderAlreadyExists'));
     }
     createMTA(config as MTABaseConfig);

packages/cf-deploy-config-writer/src/mta-config/mta.ts

@@ -196,8 +196,10 @@ export class MtaConfig {
             name: `${this.prefix?.slice(0, 100)}-uaa`,
             type: 'org.cloudfoundry.managed-service',
             parameters: {
-                'service-plan': 'application',
                 service: 'xsuaa',
+                'service-plan': 'application',
+                path: './xs-security.json',
+                'service-name': `${this.prefix?.slice(0, 100)}-xsuaa-service`,
                 config: { xsappname: `${this.prefix?.slice(0, 100)}` + '-${space-guid}', 'tenant-mode': 'dedicated' }
             }
         };

packages/cf-deploy-config-writer/src/utils.ts

@@ -1,4 +1,5 @@
 import { join, normalize, posix } from 'path';
+import { promises as fs, readFileSync } from 'fs';
 import { coerce, satisfies } from 'semver';
 import type { Editor } from 'mem-fs-editor';
 import { CommandRunner } from '@sap-ux/nodejs-utils';
@@ -33,6 +34,7 @@ import {
     CDSPackage
 } from './constants';
 import { type MTABaseConfig, type CFBaseConfig, type CFAppConfig } from './types';
+import merge from 'lodash/merge';
 
 let cachedDestinationsList: Destinations = {};
 
@@ -221,29 +223,37 @@ export function setMtaDefaults(config: CFBaseConfig): void {
  * @param {object} Options Input params
  * @param {string} Options.mtaId - MTA ID to be written to package.json
  * @param {string} Options.rootPath - MTA project path
- * @param fs - optional reference to a mem-fs editor
+ * @param memFs - optional reference to a mem-fs editor
  */
 export async function updateRootPackage(
     { mtaId, rootPath }: { mtaId: string; rootPath: string },
-    fs: Editor
+    memFs: Editor
 ): Promise<void> {
-    const packageExists = fileExists(fs, join(rootPath, FileName.Package));
+    const packageFilePath = join(rootPath, FileName.Package);
+    const packageExists = await fileExists(packageFilePath, memFs);
     // Append package.json only if mta.yaml is at a different level to the HTML5 app
     if (packageExists) {
         // Align CDS versions if missing otherwise mta.yaml before-all scripts will fail
-        await alignCdsVersions(rootPath, fs);
-        await addPackageDevDependency(rootPath, Rimraf, RimrafVersion, fs);
-        await addPackageDevDependency(rootPath, MbtPackage, MbtPackageVersion, fs);
+        await alignCdsVersions(rootPath, memFs);
+        await addPackageDevDependency(rootPath, Rimraf, RimrafVersion, memFs);
+        await addPackageDevDependency(rootPath, MbtPackage, MbtPackageVersion, memFs);
         let deployArgs: string[] = [];
-        if (fs?.exists(join(rootPath, FileName.MtaExtYaml))) {
+        if (memFs?.exists(join(rootPath, FileName.MtaExtYaml))) {
             deployArgs = ['-e', FileName.MtaExtYaml];
         }
         for (const script of [
             { name: 'undeploy', run: undeployMTAScript(mtaId) },
             { name: 'build', run: `${MTABuildScript} --mtar archive` },
             { name: 'deploy', run: rootDeployMTAScript(deployArgs) }
         ]) {
-            await updatePackageScript(rootPath, script.name, script.run, fs);
+            await updatePackageScript(rootPath, script.name, script.run, memFs);
+        }
+        // Need to handle external changes to package.json i.e. cds and devDependencies.
+        // Note: disk package.json might not exist, for example, when creating a new project from scratch.
+        if (await fileExists(packageFilePath)) {
+            const memoryJson = (memFs?.readJSON(packageFilePath, {}) || {}) as Package;
+            const diskJson = JSON.parse(readFileSync(packageFilePath, 'utf8')) as Package;
+            memFs.writeJSON(packageFilePath, merge({}, memoryJson, diskJson));
         }
     }
 }
@@ -309,10 +319,19 @@ export async function runCommand(cwd: string, cmd: string, args: string[], error
 /**
  * Check if a file exists in the file system.
  *
- * @param fs reference to a mem-fs editor
  * @param filePath Path to the file
+ * @param memFs reference to a mem-fs editor
  * @returns true if the file exists, false otherwise
  */
-export function fileExists(fs: Editor, filePath: string): boolean {
-    return fs.exists(filePath);
+export async function fileExists(filePath: string, memFs?: Editor): Promise<boolean> {
+    try {
+        if (memFs) {
+            return memFs.exists(filePath);
+        } else {
+            await fs.access(filePath);
+            return true;
+        }
+    } catch {
+        return false;
+    }
 }

packages/cf-deploy-config-writer/test/unit/__snapshots__/cap-appfrontend.test.ts.snap

@@ -58,24 +58,24 @@ exports[`CF Writer with CAP App Frontend Generate deployment config Add HTML5 ap
 
 exports[`CF Writer with CAP App Frontend Generate deployment config Add HTML5 app to CAP App Frontend Project 3`] = `
 "{
-    \\"dependencies\\": {
-        \\"@sap/cds\\": \\"^8\\",
-        \\"express\\": \\"^4\\",
-        \\"@sap/xssec\\": \\"^4\\"
-    },
-    \\"devDependencies\\": {
-        \\"@cap-js/cds-types\\": \\"^0.9.0\\",
-        \\"@cap-js/sqlite\\": \\"^1\\",
-        \\"@sap/cds-dk\\": \\"^8\\",
-        \\"rimraf\\": \\"^5.0.5\\",
-        \\"mbt\\": \\"^1.2.29\\"
-    },
-    \\"cds\\": {},
-    \\"scripts\\": {
-        \\"undeploy\\": \\"cf undeploy cappapp --delete-services --delete-service-keys --delete-service-brokers\\",
-        \\"build\\": \\"rimraf resources mta_archives && mbt build --mtar archive\\",
-        \\"deploy\\": \\"cf deploy mta_archives/archive.mtar --retries 1\\"
-    }
+  \\"dependencies\\": {
+    \\"@sap/cds\\": \\"^8\\",
+    \\"express\\": \\"^4\\",
+    \\"@sap/xssec\\": \\"^4\\"
+  },
+  \\"devDependencies\\": {
+    \\"@cap-js/cds-types\\": \\"^0.9.0\\",
+    \\"@cap-js/sqlite\\": \\"^1\\",
+    \\"@sap/cds-dk\\": \\"^8\\",
+    \\"rimraf\\": \\"^5.0.5\\",
+    \\"mbt\\": \\"^1.2.29\\"
+  },
+  \\"cds\\": {},
+  \\"scripts\\": {
+    \\"undeploy\\": \\"cf undeploy cappapp --delete-services --delete-service-keys --delete-service-brokers\\",
+    \\"build\\": \\"rimraf resources mta_archives && mbt build --mtar archive\\",
+    \\"deploy\\": \\"cf deploy mta_archives/archive.mtar --retries 1\\"
+  }
 }
 "
 `;

packages/cf-deploy-config-writer/test/unit/__snapshots__/cap.test.ts.snap

@@ -277,16 +277,16 @@ builder:
   },
   "package.json": Object {
     "contents": "{
-    \\"cds\\": {},
-    \\"devDependencies\\": {
-        \\"rimraf\\": \\"^5.0.5\\",
-        \\"mbt\\": \\"^1.2.29\\"
-    },
-    \\"scripts\\": {
-        \\"undeploy\\": \\"cf undeploy cappapp --delete-services --delete-service-keys --delete-service-brokers\\",
-        \\"build\\": \\"rimraf resources mta_archives && mbt build --mtar archive\\",
-        \\"deploy\\": \\"cf deploy mta_archives/archive.mtar --retries 1\\"
-    }
+  \\"cds\\": {},
+  \\"devDependencies\\": {
+    \\"rimraf\\": \\"^5.0.5\\",
+    \\"mbt\\": \\"^1.2.29\\"
+  },
+  \\"scripts\\": {
+    \\"undeploy\\": \\"cf undeploy cappapp --delete-services --delete-service-keys --delete-service-brokers\\",
+    \\"build\\": \\"rimraf resources mta_archives && mbt build --mtar archive\\",
+    \\"deploy\\": \\"cf deploy mta_archives/archive.mtar --retries 1\\"
+  }
 }
 ",
     "state": "modified",

packages/cf-deploy-config-writer/test/unit/__snapshots__/index-base.test.ts.snap

@@ -328,7 +328,9 @@ resources:
     config:
       tenant-mode: dedicated
       xsappname: standalonewithabapserviceprovider-\${space-guid}
+    path: ./xs-security.json
     service: xsuaa
+    service-name: standalonewithabapserviceprovider-xsuaa-service
     service-plan: application
 - name: standalonewithabapserviceprovider-html5-repo-runtime
   type: org.cloudfoundry.managed-service
@@ -478,7 +480,9 @@ resources:
     config:
       tenant-mode: dedicated
       xsappname: standalone-with-connectivity-service-\${space-guid}
+    path: ./xs-security.json
     service: xsuaa
+    service-name: standalone-with-connectivity-service-xsuaa-service
     service-plan: application
 - name: standalone-with-connectivity-service-html5-repo-runtime
   type: org.cloudfoundry.managed-service

packages/cf-deploy-config-writer/test/unit/__snapshots__/index-cap.test.ts.snap

@@ -313,8 +313,10 @@ resources:
   - name: captestproject-uaa
     type: org.cloudfoundry.managed-service
     parameters:
-      service-plan: application
       service: xsuaa
+      service-plan: application
+      path: ./xs-security.json
+      service-name: captestproject-xsuaa-service
       config:
         xsappname: 'captestproject-\${space-guid}'
         tenant-mode: dedicated

packages/cf-deploy-config-writer/test/unit/__snapshots__/mta.test.ts.snap

@@ -302,8 +302,10 @@ resources:
   - name: standaloneBasic-uaa
     type: org.cloudfoundry.managed-service
     parameters:
-      service-plan: application
       service: xsuaa
+      service-plan: application
+      path: ./xs-security.json
+      service-name: standaloneBasic-xsuaa-service
       config:
         xsappname: 'standaloneBasic-\${space-guid}'
         tenant-mode: dedicated