@sap/cds-dk 8.3.0 → 8.4.1

package/lib/deploy/to-hana/hana.js

@@ -3,7 +3,7 @@ const path = require('path');
 const fs = require('fs').promises;
 
 const cds = require('../../../lib/cds');
-const { exists, read } = cds.utils;
+const { exists, read, write, mkdirp } = cds.utils;
 
 const { build } = require('../../build');
 
@@ -38,7 +38,7 @@ module.exports = new class HanaDeployer {
   async deploy(options = {}) {
     let { model, serviceName: pServiceName, tunnelAddress, vcapFile, undeployWhitelist, hdiOptions = {}, dry, storeCredentials } = options;
 
-    options.for = options.for || 'hybrid';
+    options.for ??= 'hybrid';
 
     if (model) {
       throw `Specifying a CDS model for HANA deployment is not supported.
@@ -67,68 +67,73 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
       }
     }
 
-    const buildResults = await this._build();
+    let buildResult
+    if (cds.cli.options?.['no-build']) {
+      console.log(`Provided flag '--no-build', skipping cds build`)
+    } else {
+      buildResult = await this._build();
+    }
 
     if (process.env.TARGET_CONTAINER) {
       vcapEnv.TARGET_CONTAINER = process.env.TARGET_CONTAINER;
     }
 
-    for (const { task, result } of buildResults) {
-      if (dry) {
-        const sortedResult = Array.from(result.hana).sort();
-        for (const file of sortedResult) {
-          const srcPath = path.join(result.dest, file);
-          console.log(`-- ${path.relative(cds.root, srcPath)}`);
-          console.log(await read(srcPath));
-          console.log();
-        }
+    if (dry) {
+      const sortedResult = Array.from(buildResult.hana).sort();
+      for (const file of sortedResult) {
+        const srcPath = path.join(buildResult.dest, file);
+        console.log(`-- ${path.relative(cds.root, srcPath)}`);
+        console.log(await read(srcPath));
+        console.log();
+      }
+    } else {
+      // the primary database is always built and deployed 
+      const dest = path.join(cds.env.build.target, cds.env.folders.db);
+
+      let serviceName = pServiceName;
+      let serviceKeyName;
+      const { instance, key } = cds.requires.db?.binding ?? {};
+      if (!serviceName && instance) {
+        serviceName = instance;
+        serviceKeyName = key;
+      }
+
+      if (undeployWhitelist) {
+        console.log('Writing undeploy.json');
+        await write(undeployWhitelist).to(dest, 'undeploy.json')
+      }
+
+      const hasVCAPEnv = Object.keys(vcapEnv).length > 0;
+      if (!serviceName && hasVCAPEnv) {
+        await mkdirp(dest);
       } else {
-        const dest = task.dest;
+        const { cfServiceInstanceName, cfServiceInstanceKeyName, serviceKey } =
+          await this._getOrCreateCFService(dest, serviceName, serviceKeyName, tunnelAddress);
 
-        let serviceName = pServiceName;
-        let serviceKeyName;
-        if (!serviceName && cds.env.requires.db?.binding?.instance) {
-          serviceName = cds.env.requires.db.binding.instance;
-          serviceKeyName = cds.env.requires.db.binding.key;
+        serviceName ??= cfServiceInstanceName;
+        serviceKeyName ??= cfServiceInstanceKeyName
+        if (!vcapEnv.VCAP_SERVICES || serviceName) {
+          vcapEnv.VCAP_SERVICES = this._getVCAPServicesEntry(cfServiceInstanceName, serviceKey);
         }
 
-        if (undeployWhitelist) {
-          console.log('Writing undeploy.json');
-          await fs.write(path.join(dest, 'undeploy.json'), JSON.stringify(undeployWhitelist, null, 2));
+        if (storeCredentials) {
+          await this._addInstanceToDefaultEnvJson([dest, cds.root], cfServiceInstanceName, serviceKey);
         }
+      }
 
-        const hasVCAPEnv = Object.keys(vcapEnv).length > 0;
-        if (!serviceName && hasVCAPEnv) {
-          await fs.mkdir(dest, { recursive: true });
-        } else {
-          const { cfServiceInstanceName, cfServiceInstanceKeyName, serviceKey } =
-            await this._getOrCreateCFService(dest, serviceName, serviceKeyName, tunnelAddress);
-
-          serviceName ??= cfServiceInstanceName;
-          serviceKeyName ??= cfServiceInstanceKeyName
-          if (!vcapEnv.VCAP_SERVICES || serviceName) {
-            vcapEnv.VCAP_SERVICES = this._getVCAPServicesEntry(cfServiceInstanceName, serviceKey);
-          }
-
-          if (storeCredentials) {
-            await this._addInstanceToDefaultEnvJson([dest, cds.root], cfServiceInstanceName, serviceKey);
-          }
-        }
+      console.log(`${bold('Starting deployment to SAP HANA ...')}`);
+      DEBUG?.({ dest, vcapEnv, hdiOptions })
+      await hdi.deploy(dest, vcapEnv, hdiOptions);
 
-        console.log(`${bold('Starting deployment to SAP HANA ...')}`);
-        DEBUG?.({ dest, vcapEnv, hdiOptions })
-        await hdi.deploy(dest, vcapEnv, hdiOptions);
-
-        if (!hasVCAPEnv) {
-          const bindOptions = {
-            ...options,
-            to: `${serviceName}:${serviceKeyName}`,
-            for: options.for,
-            kind: task.for
-          }
-          const services = await bind(bindOptions);
-          await storeBindings(services, bindOptions);
+      if (!hasVCAPEnv) {
+        const bindOptions = {
+          ...options,
+          to: `${serviceName}:${serviceKeyName}`,
+          for: options.for,
+          kind: BUILD_TASK_HANA
         }
+        const services = await bind(bindOptions);
+        await storeBindings(services, bindOptions);
       }
 
       if (storeCredentials) {
@@ -145,7 +150,7 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
       console.warn(warn(warnings.join('\n')));
     }
 
-    return { buildResults };
+    return buildResult;
   }
 
 
@@ -168,7 +173,7 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
     console.log(`Using container ${bold(cfServiceInstanceName)}`);
 
     const cfConfig = cfServiceInstanceMta?.parameters?.config;
-    const serviceInstance = await this.createHanaService(cfServiceInstanceName, cfConfig);
+    const serviceInstance = await cfUtil.getOrCreateService('hana', 'hdi-shared', cfServiceInstanceName, cfConfig);
 
     const cfServiceInstanceKeyName = serviceKeyName ?? `${cfServiceInstanceName}-key`;
     let credentials = await cfUtil.getOrCreateServiceKey(serviceInstance, cfServiceInstanceKeyName, { permissions: 'development' });
@@ -182,25 +187,6 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
     return { cfServiceInstanceName, cfServiceInstanceKeyName, serviceKey: credentials, serviceInstance }
   }
 
-
-  async createHanaService(instanceName, cfConfig) {
-    // hana or hanatrial, error if neither found
-    try {
-      return await cfUtil.getOrCreateService('hana', 'hdi-shared', instanceName, cfConfig);
-    } catch (error) {
-      if (error.command && /offering .* not found/i.test(error.command.stderr)) {
-        console.log(`Falling back to 'hanatrial'`);
-        return await cfUtil.getOrCreateService('hanatrial', 'hdi-shared', instanceName, cfConfig);
-      }
-      else if (error.command && /no database/i.test(error.command.stderr)) {
-        console.log(`No database connected to 'hana' service. Falling back to 'hanatrial'`);
-        return await cfUtil.getOrCreateService('hanatrial', 'hdi-shared', instanceName, cfConfig);
-      }
-      throw error;
-    }
-  }
-
-
   _validateCredentials(credentials, cfServiceInstanceKey) {
     if (!credentials) {
       throw `Could not create service key ${bold(cfServiceInstanceKey)}.`;
@@ -225,9 +211,11 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
       src: cds.env.folders.db,
       [OUTPUT_MODE]: OUTPUT_MODE_FILESYSTEM | OUTPUT_MODE_RESULT
     }
-
     console.log(`Running build`);
-    return build(buildTaskOptions);
+    
+    // cds build throws an error if the src folder does not exist
+    const buildResult = await build(buildTaskOptions);
+    return buildResult[0].result;
   }
 
   async _addInstanceToDefaultEnvJson(currentFolders, serviceInstanceName, serviceKey) {

package/lib/env/schemas/cds-rc.js

@@ -131,6 +131,141 @@ module.exports = {
                     }
                 },
 
+                import: {
+                    type: "object",
+                    description: "Set CDS import configurations.",
+                    additionalProperties: false,
+                    properties: {
+                        as: {
+                            type: "string",
+                            description: "Converts the input file into one of these supported formats: cds, csn or json.",
+                            $ref: "#/$defs/import-options/as"
+                        },
+                        from: {
+                            type: "string",
+                            description: "Imports the model from the one of the given options: edmx, openapi or asyncapi.",
+                            $ref: "#/$defs/import-options/from"
+                        },
+                        force: {
+                            type: "boolean",
+                            description: "Forcefully overwrites the contents in the CDS file and updates the checksum",
+                        },
+                        no_save: {
+                            type: "boolean",
+                            description: "Skips updating ./package.json.",
+                        },
+                        out: {
+                            type: "string",
+                            description: "Output file written to the specified location."
+                        },
+                        dry: {
+                            type: "boolean",
+                            description: "Writes the converted csn to stdout only.",
+                        },
+                        keepNamespace: {
+                            type: "boolean",
+                            description: "Keeps the original namespace from the edmx content instead of using the filename by default.",
+                            default: false
+                        },
+                        includeNamespaces: {
+                            type: "string",
+                            description: "Imports only entities matching to the given list of namespaces."
+                        }
+                    }
+                },
+                
+                export: {
+                    type: "object",
+                    description: "Customize cds compile settings",
+                    additionalProperties: false,
+                    properties: {
+                        asyncapi: {
+                            type: "object",
+                            description: "AsyncAPI settings for cds compile",
+                            additionalProperties: false,
+                            properties: {
+                                application_namespace: {
+                                    type: "string",
+                                    description: "The registered namespace of the application"
+                                },
+                                merged: {
+                                    type: "object",
+                                    description: "properties that needs to be there when merged option is used",
+                                    additionalProperties: false, 
+                                    properties: {
+                                        title: {
+                                            type: "string",
+                                            description: "Title to be used for merged doc"
+                                        },
+                                        version: {
+                                            type: "string",
+                                            description: "Version to be used for merged doc"
+                                        },
+                                        short_text: {
+                                            type: "string",
+                                            description: "Short decription of the AsyncAPIs"
+                                        },
+                                        description: {
+                                            type: "string",
+                                            description: "Description to be used for the merged doc"
+                                        }
+                                    }
+                                },
+                                event_spec_version: {
+                                    type: "string",
+                                    description: "Mentions the version of AsyncAPI spec"
+                                },
+                                event_source: {
+                                    type: "string",
+                                    description: "Event source information",
+                                    default: "{region}/{applicationNamespace}/{instanceId}",
+                                },
+                                event_source_params: {
+                                    type: "object",
+                                    description: "Parameters related to the source of event",
+                                    default: {
+                                        region: {
+                                        "description": "The regional context of the application.",
+                                        "schema": {
+                                            "type": "string"
+                                        }
+                                        },
+                                        applicationNamespace: {
+                                        "description": "The registered namespace of the application.",
+                                        "schema": {
+                                            "type": "string"
+                                        }
+                                        },
+                                        instanceId: {
+                                        "description": "The instance id (tenant, installation, ...) of the application.",
+                                        "schema": {
+                                            "type": "string"
+                                        }
+                                        }
+                                    },
+                                    additionalProperties: false,
+                                    region: {
+                                        type: "string",
+                                        description: "The regional context of the application"
+                                    },
+                                    applicationNamespace: {
+                                        type: "string",
+                                        description: "The registered namespace of the application"
+                                    },
+                                    instanceId: {
+                                        type: "string",
+                                        description: "The instance id (tenant, installation, ...) of the application."
+                                    }
+                                },
+                                event_characteristics: {
+                                    type: "object",
+                                    description: "The characteristics defined for events",
+                                    additionalProperties: true
+                                }
+                            }
+                        }
+                    }
+                },
                 // deploy specific schema
                 deploy: {
                     type: "object",
@@ -164,7 +299,8 @@ module.exports = {
                 "mtx-extension",
                 "mtx",
                 "node-cf",
-                "java-cf"
+                "java-cf",
+                "helm"
             ],
             enumDescriptions: [
                 "Node.js build plugin",
@@ -174,7 +310,8 @@ module.exports = {
                 "MTX extension build plugin",
                 "MTX build plugin",
                 "Node.js Cloud Foundry build plugin",
-                "Java Cloud Foundry build plugin"
+                "Java Cloud Foundry build plugin",
+                "Helm chart build plugin"
             ]
         },
 
@@ -193,6 +330,41 @@ module.exports = {
                     }
                 }
             ]
+        },
+
+        import_options: {
+            from: {
+                oneOf: [
+                    {
+                        const: "asyncapi",
+                        description: "AsyncAPI specification"
+                    },
+                    {
+                        const: "edmx",
+                        description: "OData specification"
+                    },
+                    {
+                        const: "openapi",
+                        description: "OpenAPI specification"
+                    }
+                ]
+            },
+            as: {
+                oneOf: [
+                    {
+                        const: "cds",
+                        description: "Converts the input file into cds format"
+                    },
+                    {
+                        const: "csn",
+                        description: "Converts the input file into csn format"
+                    },
+                    {
+                        const: "json",
+                        description: "Converts the input file into json format"
+                    }
+                ]
+            }
         }
     }
 }

package/lib/import/asyncapi/parserContext.js

@@ -6,12 +6,11 @@ module.exports = class ParserContext {
      * @constructor
      */
     constructor(content) {
-        this.topics = this.getTopics(content);
         this.services = this.getServicesFromContent(content);
     }
 
-    getTopicName(channelName) {
-        return channelName.startsWith('ce/') ? channelName.substring(3) : channelName;
+    getTopicName(eventName) {
+        return eventName.startsWith('ce/') ? eventName.substring(3) : eventName;
     }
 
     getEventName(messageRefString) {
@@ -19,28 +18,6 @@ module.exports = class ParserContext {
         return lastSlashIndex == -1 ? '' : messageRefString.substring(lastSlashIndex + 1);
     }
 
-    /**
-     * Return an obect with topic annotations for messages
-     */
-    getTopics(content) {
-        const topics = {};
-
-        Object.entries(content.channels).forEach(([key, value]) => {
-            const topic = this.getTopicName(key);
-            if (value.subscribe && value.subscribe.message && value.subscribe.message.$ref) {
-                const event = this.getEventName(value.subscribe.message.$ref);
-                topics[event] = topic;
-            }
-
-            if (value.publish && value.publish.message && value.publish.message.$ref) {
-                const event = this.getEventName(value.publish.message.$ref);
-                topics[event] = topic;
-            }
-        });
-
-        return topics;
-    }
-
     /**
      * Returns services from the asyncapi json object along with the events and annotations.
      * @returns an object with all the services.
@@ -49,7 +26,7 @@ module.exports = class ParserContext {
         const services = {};
         const serviceAnnotations = this.getServiceAnnotations(content);
 
-        Object.entries(content.components.messages).forEach(([key, value]) => {
+        Object.entries(content.components.messages).forEach(([, value]) => {
             let eventName;
             // Message name should be used to capture the event name
             if (value.name) {
@@ -71,10 +48,7 @@ module.exports = class ParserContext {
             const eventAnnotations = this.getEventAnnotations(value);
 
             // add topic annotation
-            if (this.topics[key]) {
-                eventAnnotations['@topic'] = this.topics[key];
-            }
-
+            eventAnnotations['@topic'] = this.getTopicName(eventName);
             let properties = {};
             let types = {};
 

package/lib/import/odata/v2parser.js

@@ -1650,8 +1650,9 @@ function _generateEDMXJSON2CSN(jsonObj, ignorePersistenceSkip, parserContext) {
 	}
 
 	// Construct CSN entity based on EDMX entity
-	let entityJson = jsonObj["edmx:Edmx"]["edmx:DataServices"].Schema.EntityType;	
-	if (!Array.isArray(entityJson)) entityJson = [entityJson];
+	let entityJson = jsonObj["edmx:Edmx"]["edmx:DataServices"].Schema.EntityType;
+	// if entityJson exists(ignoring the case of no entity) and is not an array, convert it to an array to handle the case of single entity	
+	if (entityJson && !Array.isArray(entityJson)) entityJson = [entityJson];
 	const definitions = [];
 
 	if (parserContext.mockServerUc) {