@sap/cds-dk 7.7.1 → 7.8.0

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

@@ -0,0 +1,182 @@
+const cds = require('../../../cds')
+const cf = require("../../../util/cf")
+const { write, exists } = cds.utils
+
+module.exports = class HttpTemplate extends require('../../plugin') {
+
+  #defaultHost = "http://localhost:4004"
+  #defaultPathPrefix = "/odata/v4/"
+  #defaultDirName = "*"
+  #defaultOutputDir = "http"
+  #defaultAuth = `Authorization: Basic yves:`
+
+  options() {
+    return {
+      'filter': {
+        type: 'string',
+        short: 'f',
+        help: `Specify the path to the service definition file or directory. Default is ${this.#defaultDirName}.`
+      },
+      'for-app': {
+        type: 'string',
+        short: 'a',
+        help: 'Specify the name of the app to generate requests for. If not specified, localhost and default auth will be used.'
+      },
+      'out': {
+        type: 'string',
+        short: 'o',
+        help: 'The output directory. By default, an `http` dir will be created in one of the following: test/tests/__tests__, whichever already exists. If none exists, an `http` dir will be created at the root level.'
+      }
+    }
+  }
+
+  async run() {
+
+    const path = cds.cli.options['filter'] || this.#defaultDirName
+    const csn = await cds.load(path)
+    cds.linked(csn)
+
+    let [hostname, auth] = await this.#getHostnameAndAuth()
+
+    let endpoints = this.#collectEndpointInfo(csn)
+
+    this.#generateRequests(endpoints, hostname, auth)
+  }
+
+  async #getHostnameAndAuth() {
+    if (!cds.cli.options['for-app']) {
+      return [this.#defaultHost, this.#defaultAuth]
+    }
+
+    const env = await cf.getEnv(cds.cli.options['for-app'])
+    const hostname = `https://${env.application_env_json.VCAP_APPLICATION.application_uris[0]}`
+    const { url, clientid, clientsecret } = env.system_env_json.VCAP_SERVICES?.xsuaa[0]?.credentials || {}
+
+    const response = await fetch(`${url}/oauth/token?${new URLSearchParams({
+      grant_type: 'client_credentials',
+      response_type: 'token',
+    })}`, {
+      method: 'GET',
+      headers: {
+        'Authorization': `Basic ${Buffer.from(`${clientid}:${clientsecret}`).toString('base64')}`
+      }
+    })
+    if (response.ok) {
+      const { access_token } = await response.json()
+      const auth = `x-approuter-authorization: bearer ` + access_token
+      return [hostname, auth]
+    } else {
+      throw new Error('Error authenticating ', { url, response })
+    }
+  }
+
+  #collectEndpointInfo(csn) {
+    const mapping = {}
+
+    csn.services.map((s) => {
+      const protocols = this.#getProtocols(s)
+      const paths = this.#getPaths(s, protocols)
+
+      let entityInfo = []
+      const entities = csn.entities(s.name)
+      for (const e in entities) {
+        if (entities[e].name.endsWith('.texts')) {
+          continue
+        }
+        entityInfo.push(this.#addNameAndReadOnly(entities[e]))
+      }
+
+      mapping[s.name] = { entities: entityInfo, paths: paths, protocols: protocols, actions: [] }
+    })
+
+    csn.foreach('action', (a) => {
+      mapping[a.name.split(".")[0]].actions.push(a)
+    })
+
+    return mapping
+  }
+
+  #getProtocols(s) {
+    return s["@protocol"]
+      ? typeof s["@protocol"] === "string"
+        ? [s["@protocol"]]
+        : s["@protocol"]
+      : ["odata"]
+  }
+
+  #getPaths(s, protocols) {
+    let paths = []
+    if (s["@path"]) {
+      paths.push(s["@path"])
+    } else {
+      const serviceName = s.name.replace("Service", "").toLowerCase()
+
+      let prefix = ""
+      if (protocols) {
+        for (const p of protocols) {
+          if (p === "odata-v2") {
+            prefix = "/odata/v2/"
+          } else if (p === "rest") {
+            prefix = "/rest/"
+          } else {
+            prefix = this.#defaultPathPrefix
+          }
+          paths.push(prefix + serviceName)
+        }
+      }
+    }
+    return paths
+  }
+
+  #addNameAndReadOnly(e) {
+    return {
+      name: e.name.split(".")[1],
+      readOnly: (e["@readonly"] || e["@cds.autoexpose"] || e['@odata.singleton']) ?? false,
+    }
+  }
+
+  #generateRequests(mapping, hostname, auth) {
+    for (const service in mapping) {
+      let requests = []
+
+      requests.push(`@server = ${hostname}\n@auth = ${auth}\n`)
+
+      mapping[service].entities.forEach((e) => {
+        for (const path of mapping[service].paths) {
+          const url = `{{server}}${path}/${e.name}`
+          const contentType = `Content-Type: application/json`
+          const authHeader = `{{auth}}`
+
+          requests.push(`GET ${url}\n${authHeader}\n${contentType}\n`)
+
+          if (!e.readOnly) {
+            const allHeaders = `${contentType}\n${authHeader}`
+            requests.push(`POST ${url}\n${allHeaders}\n\n{}\n`)
+
+            requests.push(`PATCH ${url}\n${allHeaders}\n\n{}\n`)
+            requests.push(`DELETE ${url}\n${authHeader}\n`)
+          }
+        }
+      })
+
+      const outputPath = this.#determineOutputPath(service)
+      write(requests.join("\n###\n")).to(outputPath)
+      console.log(`${outputPath} has been created.`)
+    }
+  }
+
+  #determineOutputPath(service) {
+    let outputDir
+    const { out } = cds.cli.options
+    if (out) {
+      outputDir = out.endsWith('/') ? out.slice(0, -1) : out
+    } else if (exists('test') || exists('tests') || exists('__tests__')) {
+      outputDir = exists('test') ? 'test/http' : (exists('tests') ? 'tests/http' : '__tests__/http')
+    } else {
+      outputDir = this.#defaultOutputDir
+    }
+    return `${outputDir}/${service}.http`
+  }
+}
+
+

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

@@ -0,0 +1,14 @@
+---
+modules:
+ - name: {{appName}}-srv
+   type: {{language}}
+   path: {{& srvPath}}
+   requires:
+    - name: {{appName}}-kafka
+
+resources:
+  - name: {{appName}}-kafka
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: kafka
+      service-plan: standard

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

@@ -0,0 +1,22 @@
+{
+  {{#isNodejs}}
+  "dependencies": {
+    "kafkajs": "^2"
+  },
+  "cds": {
+  {{/isNodejs}}
+    "requires": {
+      {{#profile}}
+      "[{{profile}}]": {
+      {{/profile}}
+        "messaging": {
+          "kind": "kafka"
+        }
+      {{#profile}}
+      }
+      {{/profile}}
+    }
+  {{#isNodejs}}
+  }
+  {{/isNodejs}}
+}

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

@@ -0,0 +1,40 @@
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+const { srv4, kafkaMessaging } = require('../../registries/mta')
+const mvn = require('../../mvn')
+
+module.exports = class KafkaTemplate extends require('../../plugin') {
+
+  static hasInProduction(env) {
+    return !!env.requires?.messaging?.kind === 'kafka'
+  }
+
+  async run() {
+    const project = readProject()
+    const { configFile, isNodejs, isJava } = project
+    if (isNodejs) await merge(__dirname, 'files/package.json.hbs').into(configFile, { with: project })
+    if (isJava) await mvn.add('kafka')
+  }
+
+  async combine() {
+    const project = readProject()
+    const { hasMta, srvPath } = project
+
+    if (hasMta) {
+      const srv = srv4(srvPath)
+      await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
+          project,
+          additions: [srv, kafkaMessaging],
+          relationships: [{
+              insert: [kafkaMessaging, 'name'],
+              into: [srv, 'requires', 'name']
+          }]
+      })
+    }
+
+    // REVISIT: Helm support
+    // if (hasHelm || hasHelmUnifiedRuntime) {
+    //   await merge(__dirname, 'files', 'values.yaml').into('chart/values.yaml')
+    // }
+  }
+}

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

@@ -7,12 +7,9 @@ const io = require("../../../lint/io");
 const readline = require("readline");
 const { renderAndCopy } = require('../../template')
 const { LINT_DEV, LINT_GLOBAL } = require("../../constants").OPTIONS;
-const { getConfigPath, getFileExtensions } = require("@sap/eslint-plugin-cds/lib/api");
 const cds = require("../../../cds");
 const { mkdirp, exists } = cds.utils;
-
 const IS_WIN = os.platform() === "win32";
-const ALLOWED_FILE_EXTENSIONS = getFileExtensions();
 const VSCODE_FILE_ASSOCIATIONS = {
   "csv": [ "csv", "csv (semicolon)", "tsv", "tab" ]
 }
@@ -70,7 +67,9 @@ module.exports = class LintTemplate extends require('../../plugin') {
       }
 
       // Generate VS Code extension settings
-      const extensions = ALLOWED_FILE_EXTENSIONS.map((ext) => {
+      const { getFileExtensions } = require("@sap/eslint-plugin-cds/lib/api");
+      const ALLOWED_FILE_EXTENSIONS = getFileExtensions();
+        const extensions = ALLOWED_FILE_EXTENSIONS.map((ext) => {
         return path.extname(ext).replace('.', '');
       })
       extensions.forEach((ext) => {
@@ -151,6 +150,7 @@ module.exports = class LintTemplate extends require('../../plugin') {
   }
 
   async _addEslintPluginConfig() {
+    const { getConfigPath } = require("@sap/eslint-plugin-cds/lib/api");
     let configPath = getConfigPath(cds.root);
     if (!configPath) {
       configPath = path.join(cds.root, ".eslintrc.json");

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

@@ -20,12 +20,16 @@ modules:
 {{#isNodejs}}
     parameters:
       buildpack: nodejs_buildpack
+      readiness-health-check-type: http
+      readiness-health-check-http-endpoint: /health
     build-parameters:
       builder: npm
 {{/isNodejs}}
 {{#isJava}}
     parameters:
       buildpack: sap_java_buildpack
+      readiness-health-check-type: http
+      readiness-health-check-http-endpoint: /
     properties:
       SPRING_PROFILES_ACTIVE: cloud,sandbox
       JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']"

package/lib/init/template/multitenancy/files/values.yaml.hbs

@@ -65,6 +65,6 @@ sidecar:
       memory: 500M
   health:
     liveness:
-      path: /
+      path: /health
     readiness:
-      path: /
+      path: /health

package/lib/util/cf.js

@@ -190,12 +190,16 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
     }
 
     async getServices(app) {
+        const env = await this.getEnv(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 });
         if (apps.resources.length < 1) throw `Cannot find app with name '${app}'`
         const guid = apps.resources[0].guid;
-        const env = await this._cfRequest('/v3/apps/'+guid+'/env', { space_guids, organization_guids, names: app });
-        return Object.values(env.system_env_json.VCAP_SERVICES).flat();
+        return await this._cfRequest('/v3/apps/' + guid + '/env', { space_guids, organization_guids, names: app });
     }
 
     async getService(serviceName, showMessage = true) {