@sap/cds-dk 8.2.3 → 8.4.0

package/lib/build/util.js

@@ -6,6 +6,7 @@ const execAsync = require('util').promisify(cp.exec)
 const IS_WIN = require('os').platform() === 'win32'
 const { SEVERITY_ERROR, FILE_EXT_CDS } = require('./constants');
 const DEBUG = cds.debug('cli|build')
+const SECRETS = /(passw)|(cert)|(ca)|(secret)|(key)/i
 
 function getProperty(src, segments) {
     segments = Array.isArray(segments) ? segments : segments.split('.')
@@ -68,31 +69,42 @@ function relativePaths(root, qualifiedPaths) {
     return qualifiedPaths
 }
 
-function redactCredentials(config, o) {
-    return JSON.stringify(config, (k, v) => {
-        if (!v) {
-            return v
-        }
-        if (k === 'credentials') {
-            try {
-                return _redacted(v)
-            } catch (e) {/* ignored */ }
+function redactCredentials(config) {
+    if (typeof config !== 'object' || config === null) {
+        return config;
+    }
+
+    if (Array.isArray(config)) {
+        return config.map(item => redactCredentials(item));
+    } else {
+        const newConfig = Object.assign({}, config);
+        for (let key in newConfig) {
+            if (key === 'credentials') {
+                newConfig[key] = _redacted(newConfig[key]);
+            } else {
+                newConfig[key] = redactCredentials(newConfig[key]);
+            }
         }
-        return v
-    }, o && o.indents || 2)
+        return newConfig;
+    }
 }
 
-/** redacts password-like strings, also reducing clutter in output */
+/**
+ * Masks password-like strings, also reducing clutter in output
+ * @param {any} cred - object or array with credentials
+ * @returns {any}
+ */
 function _redacted(cred) {
-    const secrets = /(password)|(certificate)|(ca)/i // 'certificate' and 'ca' on HANA
-    const newCred = Object.assign({}, cred)
-    Object.keys(newCred)
-        .filter(k => typeof newCred[k] === 'string' && secrets.test(k))
-        .forEach(k => newCred[k] = '...')
-    return newCred
+    if (!cred) return cred
+    if (Array.isArray(cred)) return cred.map(c => typeof c === 'string' ? '...' : _redacted(c))
+    if (typeof cred === 'object') {
+      const newCred = Object.assign({}, cred)
+      Object.keys(newCred).forEach(k => (typeof newCred[k] === 'string' && SECRETS.test(k)) ? (newCred[k] = '...') : (newCred[k] = _redacted(newCred[k])))
+      return newCred
+    }
+    return cred
 }
-
-
+  
 /**
  * Returns a list of fully qualified model names belonging to the '@sap' namespace that cannot be resolved.
  * E.g. the module might NOT have been installed.

package/lib/compile/to-mermaid.js

@@ -1,6 +1,8 @@
 const cds = require('../cds')
 
 module.exports = function to_mermaid (model, options={}) {
+  if (typeof model === 'string' && /mta.*\.ya?ml/.test(model)) return to_mta_mermaid(model)
+
   options = Object.assign({
     assocnames: false,     // include association names
     elements  : false,     // include all elements { falsy | 'all'|true | 'keys' }
@@ -119,3 +121,88 @@ function resolveTargets (query) {
 
   return targets
 }
+
+function to_mta_mermaid (file) {
+  const content = cds.utils.fs.readFileSync(file, 'utf8')
+  const mta = cds.utils.yaml.parse(content)
+  const { modules = [], resources = [] } = mta
+
+  const all = new Set([...modules.map(m => m.name), ...resources.map(r => r.name)])
+  const provided = new Set()
+  const required = new Set()
+
+  let diag = 'graph LR\n'
+
+  const appModules = modules.filter(module => module.provides && module.provides.length > 0)
+  const utilityModules = modules.filter(module => !module.provides || module.provides.length === 0)
+
+  diag += '  subgraph Modules\n'
+  appModules.forEach(module => {
+    diag += `    subgraph ${module.name}\n`
+    module.provides.forEach(provide => {
+      provided.add(provide.name)
+      diag += `      ${provide.name}["${provide.name}"]\n`
+    })
+    diag += `    end\n`
+  })
+  utilityModules.forEach(module => {
+    diag += `    ${module.name}["${module.name}"]:::module\n`
+  })
+  diag += '  end\n'
+
+  diag += '  subgraph Resources\n'
+  resources.forEach(resource => {
+    diag += `    ${resource.name}["${resource.name}"]:::resource\n`
+  })
+  diag += '  end\n'
+
+  modules.forEach(module => {
+    if (module.requires) {
+      module.requires.forEach(require => {
+        required.add(require.name)
+        if (!all.has(require.name) && !provided.has(require.name)) {
+          diag += `  ${module.name} -->|requires| ${require.name}:::missing\n`
+        } else {
+          diag += `  ${module.name} -->|requires| ${require.name}\n`
+        }
+      })
+    }
+  })
+  resources.forEach(resource => {
+    if (resource.requires) {
+      resource.requires.forEach(require => {
+        required.add(require.name)
+        if (!all.has(require.name) && !provided.has(require.name)) {
+          diag += `  ${resource.name} -->|requires| ${require.name}:::missing\n`
+        } else {
+          diag += `  ${resource.name} -->|requires| ${require.name}\n`
+        }
+      })
+    }
+  })
+
+  provided.forEach(api => {
+    if (!required.has(api)) {
+      diag += `  class ${api} unused\n`
+    } else {
+      diag += `  class ${api} api\n`
+    }
+  })
+  modules.forEach(module => {
+    diag += `  class ${module.name} module\n`
+  })
+  resources.forEach(resource => {
+    diag += `  class ${resource.name} resource\n`
+  })
+
+  diag += `
+    classDef module fill:#36aeff,stroke:#333,stroke-width:2px;
+    classDef resource fill:#2bab43,stroke:#333,stroke-width:2px;
+    classDef api fill:#e03da4,stroke:#333,stroke-width:2px;
+    classDef missing fill:#ffcccc,stroke:#ff0000,stroke-width:2px,color:#ff0000;
+    classDef unused fill:#ffcccc,stroke:#ff0000,stroke-width:2px,color:#ff0000;
+  `
+
+  return diag
+}
+

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

@@ -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.
@@ -168,7 +168,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 +182,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)}.`;

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/common.js

@@ -17,7 +17,7 @@ let optionsMapping = {
 };
 
 let apiOptions = ['includeNamespaces', 'keepNamespace', 'beta'];
-let commonOptions = ['no_copy', 'no_save', 'out', 'dry', 'as', 'from', 'force', 'config', 'destination'];
+let commonOptions = ['no_copy', 'no_save', 'out', 'dry', 'as', 'from', 'force', 'config', 'destination', 'name'];
 
 async function generateEDMX2JSON(edmx) {
     let cjson = convert.xml2json(edmx, {
@@ -344,7 +344,7 @@ async function _updatePackageJson(dest, services, kind, cwd, config, destination
     if (!config && destination) {
         config = { "[production]": { credentials: { destination } } };
     }
-
+    
     let package_json_updated = false;
     for (let service of services) {
         // existing service configuration data can be updated, e.g. in case of delta imports

package/lib/import/importapi.js

@@ -7,11 +7,11 @@ let asyncapi = require('./asyncapi');
 let messages = require('./message').getMessages();
 
 module.exports = Object.assign(cds_import, {
-    from: cds.lazified({
+    from: {
         edmx: cds_import_from_edmx,
         openapi: cds_import_from_openapi,
         asyncapi: cds_import_from_asyncapi
-    })
+    }
 });
 
 /**
@@ -95,7 +95,7 @@ async function cds_import_from_openapi(filepath, options = {}) {
     return csn;
 }
 
-/** 
+/**
  * This is the import API function to generate CSN from asyncapi files.
  * @param {string} filepath
  * - a single valid filepath

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) {