@sap/cds-dk 7.2.0 → 7.3.0

package/lib/import/odata/v4parser.js

@@ -9,7 +9,7 @@ let common = require("../common");
 let versionInfo = require("../../../package.json").version;
 let Multimap = require("./util/MultiMap");
 const ignoreObjects = ["$Reference"]; // add all the objects that needs to be ignored for parsing.
-const { warn } = require("../../util/term");
+const { warn, info } = require("../../util/term");
 const MetadataConverterFactory = require("./metadataconverter/MetadataConverterFactory");
 
 const edmPrimitiveTypes = [
@@ -1216,6 +1216,12 @@ function _parseAnnotations(schemaAnnotations, csnDefs, parserContext) {
     });
 }
 
+function _addSuffixForCollisionTypes(fqName, suffix) {
+    console.log(info(`INFO: Due to collision in ${fqName} suffix "${suffix}" is added.`));
+    const suffixedFqElementName = (fqName + suffix);
+    return suffixedFqElementName;
+}
+
 function _parseEntityContainer(csnDefs, entityContainerElements, parserContext) {
     const entityContainerElementNames = Object.keys(entityContainerElements);
     const redundantElementNames = [];
@@ -1241,16 +1247,26 @@ function _parseEntityContainer(csnDefs, entityContainerElements, parserContext)
             let fqDefRefName = _resolveAliasedElementName(definitionRefName, parserContext);
             let fqElementName = parserContext.primarySchema + "." + ecElement;
 
-            /**
-             * For now we don't support the collision between entitycontainer element name
-             * and any of the schema elemetents like entitytype, complextype, etc.
-             * TODO: In future we might have to support it.
-             */
             if (csnDefs[fqElementName] && csnDefs[fqElementName].kind !== kind) {
-                throw new Error(messages.ELEMENT_NAME_COLLISION + ecElement);
+                console.log(info(messages.COLLISION_DETECTED));
+                let suffixedFqElementName;
+                // Check the type category that experienced the collision
+                if (parserContext.complexTypes.includes(fqElementName)) {
+                    suffixedFqElementName = _addSuffixForCollisionTypes(fqElementName, "_ComplexType");
+                } else if (parserContext.enumTypes.includes(fqElementName)) {
+                    suffixedFqElementName = _addSuffixForCollisionTypes(fqElementName, "_EnumType");
+                } else if (parserContext.typeDefinitions.includes(fqElementName)) {
+                    suffixedFqElementName = _addSuffixForCollisionTypes(fqElementName, "_TypeDefinition");
+                }
+                // copy the definition with new suffixed name and delete the old definition from csnDefs
+                csnDefs[suffixedFqElementName] = csnDefs[fqElementName];
+                delete csnDefs[fqElementName];
             }
 
             if (fqElementName !== fqDefRefName) {
+                if (csnDefs[fqElementName] && !parserContext.entityToEntitySetMap.get(fqElementName)) {
+                    fqElementName = _addSuffixForCollisionTypes(fqElementName, "_EntityType");
+                }
                 csnDefs[fqElementName] = Object.assign({}, csnDefs[fqDefRefName]);
                 /**
                  * Capture all the defintion reference element name which are no

package/lib/index.js

@@ -18,3 +18,8 @@ cds.extend (cds.compile.to.constructor) .with (class {
 if (cds.compile.to.constructor.name === 'Object') { // not a class as in cds 7
   cds.compile.to.xsuaa = require('./compile/to-xsuaa')
 }
+
+cds.schema = cds.schema || {} // backward compatibility
+cds.extend (cds.schema) .with ( {
+  overlay4: require('./env/schema')
+})

package/lib/init/constants.js

@@ -4,7 +4,7 @@ module.exports = {
     COMMAND_INIT: 'init',
     COMMAND_ADD: 'add',
 
-    MAVEN_ARCHETYPE_VERSION: '2.2.0',
+    MAVEN_ARCHETYPE_VERSION: '2.3.0',
 
     OPTIONS: Object.freeze({
         JAVA: 'java',
@@ -24,6 +24,7 @@ module.exports = {
         EXTENSIBILITY: 'extensibility',
         XSUAA: 'xsuaa',
         HANA: 'hana',
+        POSTGRES: 'postgres',
         SQLITE: 'sqlite',
         H2: 'h2',
         ENTERPRISE_MESSAGING: 'enterprise-messaging',
@@ -38,7 +39,8 @@ module.exports = {
         LINT_GLOBAL: 'lint:global',
         LINT_DEV: 'lint:dev',
         HELM: 'helm',
-        TYPER: 'typer'
+        TYPER: 'typer',
+        HTML5_REPO: 'html5-repo'
     }),
 
     PROJECT_TYPE: Object.freeze({ nodejs: 1, java: 2, unknown: 3 }),

package/lib/init/index.js

@@ -126,9 +126,8 @@ module.exports = class CDSGenerator {
     }
 
     async stepInit(projectName, options) {
-
-        if (!cds.cli?.command) {
-            // called from CAP generator
+        if (options) {
+            // called from CAP generator with options
             cds.cli = {
                 command: COMMAND_INIT,
                 // keep caller independent from internal names

package/lib/init/template/_merging/registry-mta.js

@@ -126,6 +126,25 @@ const serviceManager = {
     }]
 }
 
+const postgres = {
+    in: 'resources',
+    where: [{
+        property: 'parameters.service',
+        isEqualTo: 'postgresql-db',
+    }]
+}
+
+const postgresDeployer = {
+    in: 'modules',
+    where: [{
+        property: 'type',
+        isEqualTo: 'nodejs',
+    }, {
+        property: 'path',
+        isEqualTo: 'gen/pg',
+    }]
+}
+
 const saasRegistry = {
     in: 'resources',
     where: [{
@@ -255,6 +274,8 @@ module.exports = {
     hdbDeployer,
     hdiContainer,
     serviceManager,
+    postgres,
+    postgresDeployer,
     saasRegistry,
     redis,
     srvApi4,

package/lib/init/template/approuter/files/mta.yaml.hbs

@@ -19,7 +19,7 @@ modules:
 
   - name: {{appName}}
     type: approuter.nodejs
-    path: {{& approuterPath }}
+    path: {{& appPath}}
     parameters:
       keep-existing-routes: true
       disk-quota: 256M

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

@@ -3,7 +3,7 @@ const { exists } = cds.utils
 const { join } = require('path')
 const { readProject } = require('../../util/projectReader')
 const { mergeJSON, mergeYAML, sort } = require('../../util/merge')
-const { XSUAA, KIBANA } = require('../../constants').OPTIONS
+const { XSUAA, KIBANA, HTML5_REPO } = require('../../constants').OPTIONS
 const {
     srvNode4, srvJava4, mtxSidecar4, approuter, // Modules
     xsuaa, // BTP Services
@@ -16,8 +16,7 @@ const { copyAndTrack, parseMd5File, writeMd5File } = require('../../util/md5')
 module.exports = class ApprouterTemplate extends require('../templateBase') {
 
     static hasFacet(env) {
-        return exists(join(env.folders.app, 'router', 'xs-app.json')) ||
-               exists(join(env.folders.app, 'xs-app.json'))
+        return exists(join(env.folders.app, 'xs-app.json'))
     }
 
     getDependencies() {
@@ -25,20 +24,20 @@ module.exports = class ApprouterTemplate extends require('../templateBase') {
     }
 
     getRelatedFacets() {
-        return [KIBANA]
+        return [KIBANA, HTML5_REPO]
     }
 
     async run() {
-        const { approuterPath } = await readProject()
-        const appPackageJSONPath = join(approuterPath, 'package.json')
+        const { appPath = 'app' } = await readProject()
+        const appPackageJSONPath = join(appPath, 'package.json')
         await mergeJSON(appPackageJSONPath, join(__dirname, 'files', 'package.json'))
         await sort(appPackageJSONPath, 'dependencies')
-        await mergeJSON(join(approuterPath, 'default-env.json'), join(__dirname, 'files', 'default-env.json'))
+        await mergeJSON(join(appPath, 'default-env.json'), join(__dirname, 'files', 'default-env.json'))
     }
 
     async runDependentMerging(context = {}) {
         const project = await readProject()
-        const { isNodejs, isJava, isExtensible, isMultitenant, hasMta, hasHelm, srvPath, approuterPath } = project
+        const { isNodejs, isJava, isExtensible, isMultitenant, hasMta, hasHelm, srvPath, appPath } = project
 
         if (hasMta) {
             const srv = (isNodejs ? srvNode4 : srvJava4)(srvPath)
@@ -115,9 +114,10 @@ module.exports = class ApprouterTemplate extends require('../templateBase') {
             }
 
             if (isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData);
+
         }
 
-        const xsAppPath = join(approuterPath, 'xs-app.json')
+        const xsAppPath = join(appPath, 'xs-app.json')
         const additions = isExtensible ? [{ ...approuterExtensibility, at: 0 }] : []
         await mergeJSON(xsAppPath, join(__dirname, 'files', 'xs-app.json.hbs'), project, { additions })
     }

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

@@ -1,6 +1,6 @@
 const { join } = require('path')
 const { readProject } = require('../../util/projectReader')
-const { mergeJSON, mergeYAML } = require('../../util/merge')
+const { mergeYAML } = require('../../util/merge')
 const { copyAndTrack, parseMd5File, writeMd5File } = require('../../util/md5')
 const { srvJava4, srvNode4, connectivity } = require('../_merging/registry-mta')
 
@@ -11,9 +11,10 @@ module.exports = class ConnectivityTemplate extends require('../templateBase') {
     }
 
     async run() {
-        const project = await readProject()
-        const { configFile } = project
-        await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
+        // Disable setting cds.requires.connectivity for now.
+        // const project = await readProject()
+        // const { configFile } = project
+        // await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
     }
 
     async runDependentMerging(context = {}) {

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

@@ -22,7 +22,7 @@ module.exports = class DestinationTemplate extends require('../templateBase') {
 
     async runDependentMerging(context = {}) {
         const project = await readProject()
-        const { isJava, hasHelm, hasDestination, hasMta, srvPath, hasHtml5Repo } = project
+        const { isJava, hasHelm, hasDestination, hasMta, srvPath } = project
 
         if (hasMta) {
             const srv = (isJava ? srvJava4 : srvNode4)(srvPath)
@@ -36,7 +36,6 @@ module.exports = class DestinationTemplate extends require('../templateBase') {
 
         if (hasHelm) {
             const binding = hasDestination && { srv: { bindings: { destination: { serviceInstanceName: 'destination' }}}}
-            const html5Binding = hasHtml5Repo && { 'html5-apps-deployer': { bindings: { destination: { serviceInstanceName: 'destination' }}}}
 
             //in case facet is being added to the already exisiting charts folder
             let isIndependentCommand = false
@@ -48,13 +47,11 @@ module.exports = class DestinationTemplate extends require('../templateBase') {
                 join('chart', 'values.yaml'),
                 {
                     ...binding,
-                    ...html5Binding,
                     destination: {
                         serviceOfferingName: 'destination',
                         servicePlanName: 'lite',
                         parameters: {
-                            version: '1.0.0',
-                            ...(hasHtml5Repo) && { HTML5Runtime_enabled: true }
+                            version: '1.0.0'
                         }
                     }
                 }

package/lib/init/template/html5-repo/index.js

@@ -27,7 +27,7 @@ module.exports = class Html5RepoTemplate extends require('../templateBase') {
     }
 
     async runDependentMerging(context = {}) {
-        const { appName, hasHelm } = await readProject()
+        const { appName, hasHelm, hasApprouter} = await readProject()
 
         if (hasHelm) {
             //in case facet is being added to the already exisiting charts folder
@@ -69,14 +69,38 @@ module.exports = class Html5RepoTemplate extends require('../templateBase') {
                         }
                     },
                     backendDestinations: {},
+                    destination: {
+                        parameters: {
+                            HTML5Runtime_enabled: true
+                        }
+                    }
                 }
             )
-
+            
             // copy content deployment chart if it is not present
             const HelmTemplate = require(`../helm`);
             const helmTemplate = new HelmTemplate(context.oldTrackingData, context.newTrackingData);
-            isIndependentCommand = isIndependentCommand | await helmTemplate.addSubChart('content-deployment');
 
+            if (hasApprouter) {
+                await mergeYAML(
+                    join('chart', 'values.yaml'),
+                    {
+                        'html5-apps-repo-runtime': {
+                            serviceOfferingName: 'html5-apps-repo',
+                            servicePlanName: 'app-runtime'
+                        },
+                        approuter: {
+                            bindings: {
+                                'html5-apps-repo-runtime': { serviceInstanceName: 'html5-apps-repo-runtime' }
+                            }
+                        },
+                    }
+                )
+                await helmTemplate.addDependency('service-instance', 'html5-apps-repo-runtime');
+            }
+
+            isIndependentCommand = isIndependentCommand | await helmTemplate.addSubChart('content-deployment');
+            
             // add dependency entry in chart.yaml
             await helmTemplate.addDependency('content-deployment', 'html5-apps-deployer');
 

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

@@ -4,17 +4,23 @@ const { exists } = cds.utils
 const { copyRenderedYAML } = require('../../../util/fs')
 const { readProject } = require('../../util/projectReader')
 const { mergeJSON, sort } = require('../../util/merge')
-
+const {
+    APPROUTER, XSUAA, MULTITENANCY, EXTENSIBILITY,
+    MTA, HELM,
+    HANA, POSTGRES,
+    ENTERPRISE_MESSAGING, ENTERPRISE_MESSAGING_SHARED, REDIS_MESSAGING,
+    CONNECTIVITY, DESTINATION
+} = require('../../constants').OPTIONS
 module.exports = class MtaTemplate extends require('../templateBase') {
 
     static hasFacet() {
         const { options } = cds.cli
-        if (!options?.add.has('mta') && options?.add.has('helm')) return false
+        if (!options?.add.has(MTA) && options?.add.has(HELM)) return false
         return exists('mta.yaml')
     }
 
     getRelatedFacets() {
-        return ['approuter', 'xsuaa', 'multitenancy', 'hana', 'extensibility', 'enterprise-messaging', 'enterprise-messaging-shared', 'redis-messaging', 'connectivity', 'destination']
+        return [APPROUTER, XSUAA, MULTITENANCY, HANA, POSTGRES, EXTENSIBILITY, ENTERPRISE_MESSAGING, ENTERPRISE_MESSAGING_SHARED, REDIS_MESSAGING, CONNECTIVITY, DESTINATION]
     }
 
     async run() {

package/lib/init/template/postgres/files/mta.yaml.hbs

@@ -0,0 +1,27 @@
+---
+modules:
+  - name: {{appName}}-srv
+    type: {{language}}
+    path: {{& srvPath}}
+    requires:
+      - name: {{appName}}-postgres
+
+  - name: {{appName}}-postgres-deployer
+    type: nodejs
+    path: gen/pg
+    parameters:
+      buildpack: nodejs_buildpack
+      no-route: true
+      no-start: true
+      tasks:
+        - name: deploy-to-postgresql
+          command: npm start
+    requires:
+      - name: {{appName}}-postgres
+
+resources:
+  - name: {{appName}}-postgres
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: postgresql-db
+      service-plan: development

package/lib/init/template/postgres/files/package.json.hbs

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@cap-js/postgres": "^1"
+  }
+}

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

@@ -0,0 +1,52 @@
+const { join } = require('path')
+const cds = require('../../../cds')
+const { read } = cds.utils
+const { readProject } = require('../../util/projectReader')
+const { mergeJSON, mergeYAML } = require('../../util/merge')
+const { srvNode4, srvJava4, postgres, postgresDeployer } = require('../_merging/registry-mta')
+
+module.exports = class PostgresTemplate extends require('../templateBase') {
+
+  async canRun() {
+    const { hasMta, hasHelm, isJava } = await readProject(this.options)
+    if (isJava)             throw `'cds add postgres' is not available for Java yet`
+    if (hasHelm && !hasMta) throw `'cds add postgres' is not available for Kyma yet`
+    return true
+  }
+
+  static hasFacet(env) {
+    return env.requires?.db?.kind === 'postgres'
+  }
+
+  async run() {
+    const project = await readProject(this.options)
+    const { configFile } = project
+    project.shortcut = !(await read(configFile)).cds?.requires?.db?.kind
+    await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
+    await this.runDependentMerging()
+  }
+
+  async runDependentMerging() {
+    const project = await readProject(this.options)
+    const { hasMta, isNodejs, srvPath } = project
+
+    if (hasMta) {
+      const srv = (isNodejs ? srvNode4 : srvJava4)(srvPath)
+      await mergeYAML(
+          'mta.yaml',
+          join(__dirname, 'files', 'mta.yaml.hbs'),
+          project,
+          {
+              additions: [srv, postgres, postgresDeployer],
+              relationships: [{
+                  insert: [postgres, 'name'],
+                  into: [srv, 'requires', 'name']
+              }, {
+                insert: [postgres, 'name'],
+                into: [postgresDeployer, 'requires', 'name']
+            }]
+          }
+      )
+    }
+  }
+}

package/lib/init/util/projectReader.js

@@ -81,7 +81,6 @@ module.exports = new class ProjectReader {
             get hasMta()         { return _hasFacet('mta') },
             get hasHelm()        { return _hasFacet('helm') },
             get appPath()        { return env.folders.app ?? 'app' },
-            get approuterPath()  { return join(env.folders.app ?? 'app', 'router') },
             get appVersion()     { return appVersion },
             get appName()        { return appName },
             get appId()          { return appId },

package/lib/util/pruneAxiosErrors.js

@@ -1,19 +1,33 @@
+function stacklessError(message) {
+    const { stackTraceLimit } = Error;
+    Error.stackTraceLimit = 0;
+    const error = new Error(message);
+    Error.stackTraceLimit = stackTraceLimit;
+    return error;
+}
+
 require('axios').interceptors.response.use(
     response => response,
     axError => {
+        const { inspect } = require('util');
         const { url, method } = axError.config ?? {};
-        const { code, response } = axError;
-        const { status, data } = response ?? {};
-        const reason = data?.error /* RFC 6749 */ ?? axError.message;
+        const { response = {} } = axError;
+        const { status, statusText } = response;
+        let { data } = response;
+        if (Buffer.isBuffer(data)) {
+            data = JSON.parse(data.toString());
+        }
+        const reason = data?.error /* RFC 6749 */ && (typeof data.error === 'string' ? data.error : inspect(data.error));
         const message = (url && method ? `${method.toUpperCase()} ${url} ` : '') +
             'failed' +
-            (status || code ? ':' : '') +
+            (status || statusText ? ':' : '') +
             (status ? ` ${status}` : '') +
-            (code ? ` ${code}` : '') +
-            `. ${reason}.` +
-            (data ? ` Details: '${data.error_description /* RFC 6749 */ || require('util').inspect(data)}'.` : '');
+            (statusText ? ` ${statusText}` : '') +
+            (reason ? `. ${reason}` : '') +
+            (data ? `. Details: '${data.error_description /* RFC 6749 */ || inspect(data)}'` : '');
 
-        const error = new Error(message);
+        const error = stacklessError(message);
+        error.status = status;
         if (require('../').debug('req')) {
             error.cause = axError;
         }