@sap/cds-dk 8.7.3 → 8.8.1

package/lib/init/template/xsuaa/index.js

@@ -2,10 +2,19 @@ const cds = require('../../../cds')
 const { read } = cds.utils
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
-const { srv4, xsuaa, mtxSidecar4 } = require('../../registries/mta')
+const { srv4, xsuaa: xsuaaDefault, xsuaa4, mtxSidecar4 } = require('../../registries/mta')
 
 module.exports = class XsuaaTemplate extends require('../../plugin') {
 
+    options() {
+        return {
+            'plan': {
+                type: 'string',
+                help: 'Specify the service plan.',
+            }
+        }
+    }
+
     static help() {
         return 'authentication via XSUAA'
     }
@@ -26,16 +35,20 @@ module.exports = class XsuaaTemplate extends require('../../plugin') {
         const { hasMultitenancy, hasMta, hasHelm, hasHelmUnifiedRuntime, isJava, srvPath } = project
 
         const cds = require('../../../../lib')
-        const xsSecurity = await (async () => { try {
-            const models = await cds.load(cds.env.folders.srv)
-            return cds.compile.to.xsuaa(models)
-        } catch (error) { /* ignore */ }})() ?? { scopes: [], attributes: [], 'role-templates': [], 'authorities-inheritance': false }
+        const xsSecurity = await (async () => {
+            try {
+                const models = await cds.load(cds.env.folders.srv)
+                return cds.compile.to.xsuaa(models)
+            } catch (error) { /* ignore */ }
+        })() ?? { scopes: [], attributes: [], 'role-templates': [], 'authorities-inheritance': false }
 
         const additions = xsSecurity.scopes.map(scope => ({ in: 'scopes', where: { name: scope.name } }))
         await merge(xsSecurity).into('xs-security.json', { project, additions })
 
         if (hasMta) {
             const srv = srv4(srvPath)
+            const { plan } = cds.cli.options
+            const xsuaa = plan ? xsuaa4(plan) : xsuaaDefault
             const additions = [srv, xsuaa]
             const mtxSidecar = mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar')
             if (hasMultitenancy && isJava) additions.push(mtxSidecar)
@@ -48,19 +61,18 @@ module.exports = class XsuaaTemplate extends require('../../plugin') {
                 insert: [xsuaa, 'name'],
                 into: [mtxSidecar, 'requires', 'name']
             })
-
+            if (plan) project.servicePlan = plan
             await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { project, additions, overwrites, relationships })
         }
 
         if (hasHelm || hasHelmUnifiedRuntime) {
             const overwrites = hasMultitenancy ? [{
                 item: [{
-                  in: 'xsuaa',
-                  where: { serviceOfferingName: 'xsuaa' }
+                    in: 'xsuaa',
+                    where: { serviceOfferingName: 'xsuaa' }
                 }, 'parameters.tenant-mode'], withValue: 'shared'
-              }] : []
+            }] : []
             await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project, overwrites })
-
             await merge({
                 xsuaa: {
                     parameters: {

package/lib/lint/io.js

@@ -1,9 +1,13 @@
 const { read, write, exists, yaml } = require('../cds').utils;
+const cds = require("../cds");
+
 const { readJSONC } = require("../util/fs");
 const path = require("path");
 const term = require("../util/term");
 const JSONC = require('../util/jsonc');
 
+const { COMMAND_INIT } = require("../init/constants");
+
 module.exports = {
   /**
    * Reads ESLint config contents from file
@@ -90,7 +94,7 @@ module.exports = {
       }
     }
     if (isFilePath) {
-      await this.writeEslintConfig(configIn, logger);
+      await this.writeEslintConfig(configIn, cds.cli?.command === COMMAND_INIT, logger);
     }
     return configContents;
   },
@@ -215,12 +219,12 @@ module.exports = {
    * @param {*} configPath config file path to write to
    * @returns {Promise<void>}
    */
-  async writeEslintConfig(configPath, logger = console) {
+  async writeEslintConfig(configPath, force = false, logger = console) {
     let configFile = path.basename(configPath);
     switch (configFile) {
       case "eslint.config.js":
       case "eslint.config.cjs":
-        if (exists(configPath)) {
+        if (!force && exists(configPath)) {
           logger.log(
             `${term.warn(
               `\n\nPlease add the following to your "${configFile}":` +
@@ -252,7 +256,7 @@ module.exports = [
         }
         break;
       case "eslint.config.mjs":
-        if (exists(configPath)) {
+        if (!force && exists(configPath)) {
           logger.log(
             `${term.warn(
               `\n\nPlease add the following to your "${configFile}":` +

package/lib/mtx/util/cf.js

@@ -1,4 +1,3 @@
-const os = require('os');
 const { execFile } = require('child_process');
 
 const cds = require('../../cds');
@@ -139,7 +138,7 @@ async function getSubdomain(appName) {
                 return resolve(errorResult(getErrorMessage(error, stdout)));
             }
 
-            const nl = os.EOL;
+            const nl = '\r?\n'; //more robust than os.EOL;
             const match = new RegExp(`^System-Provided:${nl}(?:\\{${nl}((.|${nl})*?)^}|((.|${nl})*?^}))`, 'm').exec(stdout);
             if (!match) {
                 return resolve(errorResult(`CF reports no system-provided environment for app '${appName}'`));

package/lib/util/cf.js

@@ -32,7 +32,6 @@ const CF_CLIENT_MINIMUM_VERSION = 8;
 const ENCODED_COMMA = encodeURIComponent(',');
 
 module.exports = new class CfUtil {
-    spaceInfo;
 
     async _sleep(ms) {
         return new Promise((resolve) => {
@@ -68,11 +67,11 @@ module.exports = new class CfUtil {
         }
     }
 
-    async cfRequest(urlPath, queryObj, bodyObj) {
-        const url = this.spaceInfo.apiEndpoint + urlPath;
+    async curl(urlPath, queryObj, bodyObj) {
+        const url = this.#target.apiEndpoint + urlPath;
 
         const options = {
-            headers: { 'Authorization': this.spaceInfo.token }
+            headers: { 'Authorization': this.#target.token }
         };
 
         if (queryObj && Object.keys(queryObj).length > 0) {
@@ -96,8 +95,6 @@ module.exports = new class CfUtil {
                 LOG.debug(`POST ${url}\n${JSON.stringify(options, null, 4)}\n${JSON.stringify(response.data, null, 4)}`);
             }
 
-            // require('../../test/testUtil/recorder').record(urlPath, options.params, response.data, 'cf.json');
-
             return response.data;
         } catch (err) {
             if (err instanceof axios.AxiosError) {
@@ -134,111 +131,113 @@ module.exports = new class CfUtil {
         }
     }
 
+    #cfTargetPromise
     async _getCfTargetFromCli() {
-        const result = await this.cfRun('target');
-        if (result?.stdout) {
-            return {
-                apiEndpoint: this._extract(result.stdout, /api endpoint\s*:\s*([^\s]+)/i, `CF API endpoint is missing. Use 'cf login' to login.`),
-                user: this._extract(result.stdout, /user\s*:\s*(.+)/i, `CF user is missing. Use 'cf login' to login.`),
-                org: this._extract(result.stdout, /org\s*:\s*(.+)/i, `CF org is missing. Use 'cf target -o <ORG>' to specify.`),
-                space: this._extract(result.stdout, /space\s*:\s*(.+)/i, `CF space is missing. Use 'cf target -s <SPACE>' to specify.`),
-            };
-        }
+        if (this.#cfTargetPromise) return this.#cfTargetPromise
+        this.#cfTargetPromise = (async () => {
+            const result = await this.cfRun('target')
+            if (result?.stdout) {
+                return {
+                    apiEndpoint: this._extract(result.stdout, /api endpoint\s*:\s*([^\s]+)/i, `CF API endpoint is missing. Use 'cf login' to login.`),
+                    user: this._extract(result.stdout, /user\s*:\s*(.+)/i, `CF user is missing. Use 'cf login' to login.`),
+                    org: this._extract(result.stdout, /org\s*:\s*(.+)/i, `CF org is missing. Use 'cf target -o <ORG>' to specify.`),
+                    space: this._extract(result.stdout, /space\s*:\s*(.+)/i, `CF space is missing. Use 'cf target -s <SPACE>' to specify.`),
+                }
+            }
+        })()
+        return this.#cfTargetPromise
     }
 
     #token
-    async _getCfAuthorization() {
+    #tokenPromise
+    async _token() {
         if (this.#token) return this.#token
-        if (!this._tokenPromise) {
-            this._tokenPromise = this.cfRun('oauth-token')
+        if (!this.#tokenPromise) {
+            this.#tokenPromise = this.cfRun('oauth-token')
             .then(result => {
                 this.#token = result.stdout
                 return this.#token
             })
             .catch(err => {
-                this._tokenPromise = null
+                this.#tokenPromise = null
                 throw err.message
             })
         }
-        return this._tokenPromise
-    }
-
-    async getCfTarget() {
-        await this._checkCliVersion();
-        const token = await this._getCfAuthorization();
-        const target = await this._getCfTargetFromConfigFile() || await this._getCfTargetFromCli();
-        target.token = token;
-        return target;
+        return this.#tokenPromise
     }
 
-    #checkedVersion = false
+    #cfVersionPromise
     async _checkCliVersion() {
-        if (this.#checkedVersion) return
-        this.#checkedVersion = true
-        const result = await this.cfRun('-v');
-        const version = result?.stdout?.match(/version.*(\d+\.\d+\.\d+)/i)
-        if (parseInt(version?.[1]) < CF_CLIENT_MINIMUM_VERSION) {
-            console.log(warn(`
-[Warning] You are using Cloud Foundry client version ${version[1]}. We recommend version ${CF_CLIENT_MINIMUM_VERSION} or higher.
-Deployment will stop in the near future for Cloud Foundry client versions < ${CF_CLIENT_MINIMUM_VERSION}.
-`));
-        }
+        if (this.#cfVersionPromise) return this.#cfVersionPromise
+        this.#cfVersionPromise = (async () => {
+            const result = await this.cfRun('-v');
+            const version = result?.stdout?.match(/version.*(\d+\.\d+\.\d+)/i);
+            if (parseInt(version?.[1]) < CF_CLIENT_MINIMUM_VERSION) {
+                console.log(warn(`
+    [Warning] You are using Cloud Foundry client version ${version[1]}. We recommend version ${CF_CLIENT_MINIMUM_VERSION} or higher.
+    Deployment will stop in the near future for Cloud Foundry client versions < ${CF_CLIENT_MINIMUM_VERSION}.
+                `))
+            }
+        })()
+        return this.#cfVersionPromise
     }
 
-    async getCfSpaceInfo() {
-        if (!this.spaceInfo) {
-            LOG.debug('getting space info');
+    #target
+    async target() {
+        if (!this.#target) {
+            await this._checkCliVersion();
+            const token = await this._token();
+            const target = await this._getCfTargetFromConfigFile() || await this._getCfTargetFromCli();
+            target.token = token;
+            this.#target = target;
 
-            const target = await this.getCfTarget();
-            this.spaceInfo = target;
             const { org, space } = target;
-            const orgs = await this.cfRequest('/v3/organizations', { names: org });
+            const orgs = await this.curl('/v3/organizations', { names: org });
             if (!orgs?.resources?.length) {
                 throw `CF org ${bold(org)} not found!`;
             }
-
             const orgGuid = orgs.resources[0].guid;
-            const spaces = await this.cfRequest('/v3/spaces', { names: space, organization_guids: orgGuid });
+
+            const spaces = await this.curl('/v3/spaces', { names: space, organization_guids: orgGuid });
             if (!spaces?.resources?.length) {
                 throw `CF space ${bold(space)} not found in org ${bold(org)}!`;
             }
 
             const spaceGuid = spaces.resources[0].guid;
 
-            this.spaceInfo = {
+            this.#target = {
                 ...target,
                 orgGuid,
                 spaceGuid
             }
         }
 
-        return this.spaceInfo;
+        return this.#target;
     }
 
-    async getServices(app) {
-        const env = await this.getEnv(app)
+    async services(app) {
+        const env = await this.env(app)
         return Object.values(env.system_env_json.VCAP_SERVICES).flat();
     }
 
-    async getEnv(app) {
-        const { spaceGuid: space_guids, orgGuid: organization_guids } = await this.getCfSpaceInfo();
-        const apps = await this.cfRequest('/v3/apps', { space_guids, organization_guids, names: app });
+    async env(app) {
+        const { spaceGuid: space_guids, orgGuid: organization_guids } = await this.target();
+        const apps = await this.curl('/v3/apps', { space_guids, organization_guids, names: app });
         if (apps.resources.length < 1) throw `Cannot find app with name '${app}'`
         const guid = apps.resources[0].guid;
-        return await this.cfRequest('/v3/apps/' + guid + '/env', { space_guids, organization_guids, names: app });
+        return await this.curl('/v3/apps/' + guid + '/env', { space_guids, organization_guids, names: app });
     }
 
-    async getService(serviceName, showMessage = true) {
-        showMessage && console.log(`getting service ${bold(serviceName)}`);
-        const spaceInfo = await this.getCfSpaceInfo();
+    async service(serviceName) {
+        const target = await this.target();
 
         let counter = POLL_COUNTER;
         while (counter > 0) {
             counter--;
-            const serviceInstances = await this.cfRequest('/v3/service_instances', {
+            const serviceInstances = await this.curl('/v3/service_instances', {
                 names: serviceName,
-                space_guids: spaceInfo.spaceGuid,
-                organization_guids: spaceInfo.orgGuid
+                space_guids: target.spaceGuid,
+                organization_guids: target.orgGuid
             });
             if (!serviceInstances?.resources?.length) {
                 return null;
@@ -269,10 +268,8 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
         throw `Timeout occurred while getting service ${bold(serviceName)}`;
     }
 
-
     async getOrCreateService(serviceOfferingName, planName, serviceName, options) {
-
-        const probeService = await this.getService(serviceName, false);
+        const probeService = await this.service(serviceName);
         if (probeService) {
             console.log(`getting service ${bold(serviceName)}`);
             return probeService;
@@ -280,12 +277,12 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
 
         console.log(`Creating service ${bold(serviceName)} - please be patient...`);
 
-        const spaceInfo = await this.getCfSpaceInfo();
+        const target = await this.target();
 
-        const servicePlan = await this.cfRequest(`/v3/service_plans`, {
+        const servicePlan = await this.curl(`/v3/service_plans`, {
             names: planName,
-            space_guids: spaceInfo.spaceGuid,
-            organization_guids: spaceInfo.orgGuid,
+            space_guids: target.spaceGuid,
+            organization_guids: target.orgGuid,
             service_offering_names: serviceOfferingName
         });
 
@@ -300,7 +297,7 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
             relationships: {
                 space: {
                     data: {
-                        guid: spaceInfo.spaceGuid
+                        guid: target.spaceGuid
                     }
                 },
                 service_plan: {
@@ -315,12 +312,12 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
             body.parameters = { ...options };
         }
 
-        const postResult = await this.cfRequest('/v3/service_instances', undefined, body);
+        const postResult = await this.curl('/v3/service_instances', undefined, body);
         if (postResult?.errors) {
             throw postResult.errors[0].detail;
         }
 
-        const newService = await this.getService(serviceName, false);
+        const newService = await this.service(serviceName);
         if (newService) {
             return newService;
         }
@@ -328,13 +325,11 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
         throw `Could not create service ${bold(serviceName)}`;
     }
 
-    async _getServiceKey(serviceInstance, serviceKeyName, showMessage = true) {
-        showMessage && console.log(`getting service key ${bold(serviceKeyName)}`);
-
+    async _getServiceKey(serviceInstance, serviceKeyName) {
         let counter = POLL_COUNTER;
         while (counter > 0) {
             counter--;
-            const bindings = await this.cfRequest(`/v3/service_credential_bindings`, { names: serviceKeyName, service_instance_guids: serviceInstance.guid });
+            const bindings = await this.curl(`/v3/service_credential_bindings`, { names: serviceKeyName, service_instance_guids: serviceInstance.guid });
             if (!bindings?.resources?.length) {
                 return null;
             }
@@ -347,7 +342,7 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
                     break;
 
                 case OPERATION_STATE_SUCCEEDED: {
-                    const keyDetails = await this.cfRequest(`/v3/service_credential_bindings/${encodeURIComponent(binding.guid)}/details`);
+                    const keyDetails = await this.curl(`/v3/service_credential_bindings/${encodeURIComponent(binding.guid)}/details`);
                     return keyDetails.credentials;
                 }
 
@@ -366,14 +361,14 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
         throw `Timeout occurred while getting service key ${bold(serviceKeyName)}`;
     }
 
-    async getOrCreateServiceKey(serviceInstance, serviceKeyName, parameters, { silent = false, create = true } = {}) {
-        const serviceKey = await this._getServiceKey(serviceInstance, serviceKeyName, false);
-        if (serviceKey || !create) {
-            if (serviceKey && !silent) DEBUG?.(`getting service key ${bold(serviceKeyName)}`);
+    async getOrCreateServiceKey(serviceInstance, serviceKeyName, parameters, { silent = false } = {}) {
+        const serviceKey = await this._getServiceKey(serviceInstance, serviceKeyName);
+        if (serviceKey) {
+            DEBUG?.(`getting service key ${bold(serviceKeyName)}`)
             return serviceKey;
         }
 
-        if (!silent) console.log(`Creating service key ${bold(serviceKeyName)} - please be patient...`);
+        if (!silent) console.log(`creating service key ${bold(serviceKeyName)} - please be patient...`);
 
         const body = {
             type: 'key',
@@ -388,16 +383,41 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
             parameters
         }
 
-        const postResult = await this.cfRequest('/v3/service_credential_bindings', undefined, body);
+        const postResult = await this.curl('/v3/service_credential_bindings', undefined, body);
         if (postResult?.errors) {
             throw postResult.errors[0].detail;
         }
 
-        const newServiceKey = await this._getServiceKey(serviceInstance, serviceKeyName, false);
+        const newServiceKey = await this._getServiceKey(serviceInstance, serviceKeyName);
         if (newServiceKey) {
             return newServiceKey;
         }
 
-        throw `Could not create service key ${bold(serviceKeyName)}`;
+        throw `could not create service key ${bold(serviceKeyName)}`;
+    }
+
+    async org(orgName) {
+        const result = await this.curl('/v3/organizations', { names: orgName })
+        return result?.resources?.[0]
+    }
+
+    async space(orgGuid, spaceName) {
+        const result = await this.curl('/v3/spaces', { names: spaceName, organization_guids: orgGuid })
+        return result?.resources?.find(r => r.relationships.organization.data.guid === orgGuid)
+    }
+
+    async instance(spaceGuid, instanceName) {
+        const result = await this.curl('/v3/service_instances', { names: instanceName, space_guids: spaceGuid })
+        return result?.resources?.find(r => !!r.relationships.space.data.guid)
+    }
+
+    async plan(planGuid) {
+        const result = await this.curl('/v3/service_plans', { guids: planGuid })
+        return result?.resources?.[0]
+    }
+
+    async offering(offeringGuid) {
+        const result = await this.curl('/v3/service_offerings', { guids: offeringGuid })
+        return result?.resources?.[0]
     }
 }

package/lib/util/command.js

@@ -1,5 +1,4 @@
 const cp = require('child_process');
-const os = require('os');
 const cds = require('../cds');
 const LOG = cds.log('cli'), DEBUG = cds.debug('cli');
 
@@ -102,7 +101,7 @@ class LogBuffer {
             this.result = this.result + chunkStr;
         }
 
-        const seq = chunkStr.split(os.EOL);
+        const seq = chunkStr.split(/\r?\n/); // more robust than os.EOL
         this.buffer = this.buffer + seq.shift();
         for (const line of seq) {
             this.flush();

package/lib/util/git.js

@@ -35,7 +35,7 @@ class GitUtil {
             }
         }
 
-        console.log(`Adding entry '${file}' to ${GIT_IGNORE_FILE}.`);
+        console.log(`adding entry '${file}' to ${GIT_IGNORE_FILE}.`);
         let gitignore = await this.readFileSafely(gitIgnorePath);
         gitignore = gitignore + `${os.EOL}# added by cds${os.EOL}${file}${os.EOL}`;