@sap/cds-dk 9.6.1 → 9.7.0

package/lib/init/template/nodejs/files/.vscode/tasks.json

@@ -4,20 +4,7 @@
     {
       "type": "shell",
       "label": "cds watch",
-      "command": "cds",
-      "args": ["watch"],
-      "group": {
-        "kind": "build",
-        "isDefault": true
-      },
-      "problemMatcher": []
-    },
-    {
-      "type": "shell",
-      "label": "cds serve",
-      "command": "cds",
-      "args": ["serve", "--with-mocks", "--in-memory?"],
-      "problemMatcher": []
+      "command": "cds watch",
     }
   ]
 }

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

@@ -1,10 +1,8 @@
 {
   "name": "{{ projectName }}",
   "version": "1.0.0",
-  "description": "A simple CAP project.",
   "dependencies": {
-    "@sap/cds": "^9",
-    "express": "^4"
+    "@sap/cds": "^9"
   },
   "devDependencies": {
     "@cap-js/sqlite": "^2"
@@ -13,4 +11,4 @@
     "start": "cds-serve"
   },
   "private": true
-}
+}

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

@@ -1,9 +1,8 @@
-const { join } = require('path')
 const cds = require('../../../cds')
 const { exists, mkdirp, path } = cds.utils
-const { env4 } = require('../../projectReader')
-const { URLS, OPTIONS: { NODEJS, JAVA }, COMMAND_ADD } = require('../../constants')
+const { OPTIONS: { NODEJS, JAVA } } = require('../../constants')
 const term = require('../../../util/term')
+const { merge } = require('../../merge')
 const { renderAndCopy } = require('../../template')
 
 module.exports = class NodejsTemplate extends require('../../plugin') {
@@ -17,9 +16,6 @@ module.exports = class NodejsTemplate extends require('../../plugin') {
     }
 
     async canRun() {
-        if (cds.cli.command === COMMAND_ADD) {
-            throw `You can't change the runtime of an existing project.`
-        }
         if (cds.cli.options.add?.has(JAVA)) {
             throw `only one runtime per project is supported – specify either ${term.bold(JAVA)} or ${term.bold(NODEJS)}`
         }
@@ -27,13 +23,13 @@ module.exports = class NodejsTemplate extends require('../../plugin') {
     }
 
     async run() {
-        const { db, srv, app } = env4('production').folders
-        await renderAndCopy(join(__dirname, 'files'), cds.root, { projectName: path.basename(cds.root) })
+        const { db, srv, app } = cds.env.folders
+        if (cds.cli.command === 'init' && cds.cli.options.force) {
+            await renderAndCopy(path.join(__dirname, 'files'), cds.root, { projectName: path.basename(cds.root) })
+        } else {
+            await merge(__dirname, 'files/package.json.hbs').into('package.json', { with: { projectName: path.basename(cds.root) }})
+        }
         await Promise.all([db, srv, app].map(p => mkdirp(p)))
     }
 
-    async finalize() {
-        console.log(`\nfind samples on ${term.link(URLS.SAMPLES)}`)
-        console.log(`learn about next steps at ${term.link(URLS.CAPIRE)}`)
-    }
 }

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

@@ -1,6 +1,7 @@
 const { join } = require('path')
-const cds = require('../../../cds'), { read, write, copy } = cds.utils
-const { env4, readProject } = require('../../projectReader')
+const cds = require('../../../cds')
+const { read, write, copy } = cds.utils
+const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
 const { renderAndCopy } = require('../../template')
 const mvn = require('../../mvn')
@@ -18,10 +19,8 @@ module.exports = class SampleTemplate extends require('../../plugin') {
             const ExtensionGenerator = require('../extension')
             return new ExtensionGenerator().addSample()
         }
-
-        const env = env4('production')
-        const { db, srv, app } = env.folders
-        const i18n = env.i18n.folders[0]
+        const { db, srv, app } = cds.env.folders
+        const i18n = cds.env.i18n.folders[0]
         const { appName, appPath } = project
 
         if (project.language === 'java') {

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

@@ -1,7 +1,13 @@
 {
+  {{#profileProduction}}
+  "dependencies": {
+    "@cap-js/sqlite": "^2"
+  }
+  {{/profileProduction}}
+  {{^profileProduction}}
   "devDependencies": {
     "@cap-js/sqlite": "^2"
-  }{{#profile}},
+  }{{/profileProduction}}{{#profile}},
   "cds": {
     "requires": {
       "[{{profile}}]": {

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

@@ -144,7 +144,7 @@ async function createNodeTest(proj) {
  */
 async function loadModel() {
   try {
-    return cds.linked(cds.minify(await cds.load([cds.env.roots])))
+    return cds.linked(cds.minify(await cds.load(cds.env.roots)))
   } catch (err) {
     if (err.code === 'MODEL_NOT_FOUND')  return null
     throw new Error(`Error compiling CDS files. Run 'npm install' and try again.`, {cause:err})

package/lib/init/template/tiny-sample/files/nodejs/db/data/CatalogService.Books.csv

@@ -0,0 +1,6 @@
+ID,title,author
+1,Wuthering Heights,Emily Brontë
+2,Jane Eyre,Charlotte Brontë
+3,The Raven,Edgar Allen Poe
+4,Eleonora,Edgar Allen Poe
+5,Catweazle,Richard Carpenter

package/lib/init/template/tiny-sample/files/nodejs/srv/cat-service.cds

@@ -0,0 +1,5 @@
+@odata service CatalogService {
+  entity Books { 
+    key ID:Integer; title:String; author:String;
+  }
+} 

package/lib/init/template/tiny-sample/index.js

@@ -2,7 +2,7 @@ const { join } = require('path')
 const cds = require('../../../../lib/cds'), { copy } = cds.utils
 const { renderAndCopy } = require('../../template')
 const mvn = require('../../mvn')
-const { env4, readProject } = require('../../projectReader')
+const { readProject } = require('../../projectReader')
 const { JAVA } = require('../../constants')
 
 module.exports = class TinySampleTemplate extends require('../../plugin') {
@@ -18,7 +18,7 @@ module.exports = class TinySampleTemplate extends require('../../plugin') {
                 await mvn.add('tiny_sample')
             }
         } else {
-            const { db, srv } = env4('production').folders
+            const { db, srv } = cds.env.folders
             await Promise.all([
                 copy(join(__dirname, 'files', 'nodejs', 'db')).to(db),
                 renderAndCopy(join(__dirname, 'files', 'nodejs', 'srv'), srv, { dbFolder: db.replace(/[\\/]+$/, '') })

package/lib/init/template/workzone-standard/files/mta.yaml.hbs

@@ -88,3 +88,9 @@ resources:
     parameters:
       service: html5-apps-repo
       service-plan: app-host
+
+  - name: {{appName}}-auth
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: xsuaa
+      service-plan: application

package/lib/init/template/workzone-standard/index.js

@@ -3,7 +3,7 @@ const { read, write, exists } = cds.utils
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
 const { join } = require('path')
-const { destination, destinations, srv4, html5RepoHost, mtxSidecar4 } = require('../../registries/mta')
+const { destination, destinations, xsuaa, srv4, html5RepoHost, mtxSidecar4 } = require('../../registries/mta')
 const { odataApi } = require('../../registries/xs-app')
 
 module.exports = class extends require('../../plugin') {
@@ -41,7 +41,7 @@ module.exports = class extends require('../../plugin') {
 
   async combine() {
     const project = readProject()
-    const { isJava, addMta, hasMta, srvPath, apps, appPath, appUIPaths, addMultitenancy, strippedAppName } = project
+    const { isJava, addMta, hasMta, srvPath, apps, appPath, appUIPaths, addMultitenancy, addXsuaa, strippedAppName } = project
 
     await Promise.all(appUIPaths.map(async p => {
       project.uiApp = p
@@ -78,7 +78,7 @@ module.exports = class extends require('../../plugin') {
       await write('mtx/sidecar/package.json', mtxPackageJson, { spaces: 2 })
     }
 
-    if (addMta || addMultitenancy && hasMta) {
+    if (addMta || (addMultitenancy || addXsuaa) && hasMta) {
       const srv = srv4(srvPath)
       const additions = [srv, destinations, destination, {
         in: [destination, 'requires'],
@@ -91,6 +91,16 @@ module.exports = class extends require('../../plugin') {
           into: [mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar'), 'requires', 'name']
         })
       }
+      if (addXsuaa) {
+        relationships.push({
+          insert: [xsuaa],
+          into: [destinations, 'requires']
+        })
+        additions.push({
+            in: [destinations, 'parameters.content.instance.destinations' ],
+            where: { Authentication: 'OAuth2UserTokenExchange' }
+        })
+      }
 
       await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project, additions, relationships })
     }

package/lib/init/validate.js

@@ -1,15 +1,20 @@
 const { PROJECT_FILES } = require('./constants')
-const REGEX_PROJECT_NAME = /[^0-9a-zA-Z_-]+/g
+
+// max. 64 chars, starts with letter, number, '_', contains only letters (upper and lower case), numbers, '_' or '-'
+const REGEX_PROJECT_NAME = /^[0-9a-z_][0-9a-z_-]{0,63}$/i
+
 const cds = require('../../lib/cds')
 const { exists } = cds.utils
 const { bold } = require('../../lib/util/term')
 
 module.exports.projectName = projectName => {
-  if (!projectName) throw 'specify a project name'
-  const invalidChars = new Set(projectName.match(REGEX_PROJECT_NAME)) // remove duplicates
-  if (invalidChars.size > 0) {
-    throw `project name '${projectName}' contains at least one character ('${[...invalidChars]}') which is not supported in npm package names.
-Specify a different project name by replacing characters with '_' or '-', for example '${projectName.replace(REGEX_PROJECT_NAME, '_')}' or '${projectName.replace(REGEX_PROJECT_NAME, '-')}'.`
+  if (!projectName) throw 'Specify a project name.'
+  if (!projectName.match(REGEX_PROJECT_NAME)) {
+    throw `This project name is not supported.
+Specify a different project name which
+ starts with a letter, number or '_' and
+ contains only letters, numbers, '_' or '-' and
+ is 64 characters or less.`
   }
 }
 

package/lib/util/checksum.js

@@ -1,7 +1,7 @@
 const cds = require('../../lib/cds')
 const { read, stat } = cds.utils
 const crypto = require('crypto')
-const { getFiles } = require('../build/util')
+const { find } = require('../util/fs')
 
 /**
  * Calculate a checksum for a directory, excluding specified patterns.
@@ -25,7 +25,7 @@ async function calcDirChecksum(dirPath, filter = [], hashFunction = 'sha256', op
     return hash.digest('hex')
   }
 
-  const files = [...(await getFiles(dirPath, filter, [], true)), ...optionalFiles].sort()
+  const files = [...(await find(dirPath, { filter, ignoreSymlinks: true })), ...optionalFiles].sort()
   for (const file of files) {
     try {
       hash.update(file)

package/lib/util/fs.js

@@ -1,69 +1,125 @@
-const { parse } = require('node:path')
-
+const os = require('node:os')
+const { parse, join } = require('node:path')
+const { promises: fsp } = require('node:fs')
 const YAML = require('yaml')
 const { read, write } = require('../cds').utils
 const JSONC = require('./jsonc')
 
-// REVISIT: Consider merging with template util
-
-module.exports = new class FsUtil {
+/* YAML */
 
-    constructor() {
-        this.copyRenderedJSON = this.copyRenderedJSON.bind(this)
-        this.copyRenderedYAML = this.copyRenderedYAML.bind(this)
+async function readYAML(src, project) {
+    let file
+    try {
+        file = await read(src, 'utf8')
+    } catch (e) {
+        if (e.code === 'ENOENT') return undefined
+        throw e
     }
-
-    async readYAML(src, project) {
-        let file
-        try {
-            file = await read(src, 'utf8')
-        } catch (e) {
-            if (e.code === 'ENOENT') return undefined
-            throw e
-        }
-        if (project) {
-            const Mustache = require('mustache')
-            const renderedFile = Mustache.render(file, project)
-            return YAML.parseDocument(renderedFile)
-        }
-        return YAML.parseDocument(file)
+    if (project) {
+        const Mustache = require('mustache')
+        const renderedFile = Mustache.render(file, project)
+        return YAML.parseDocument(renderedFile)
     }
+    return YAML.parseDocument(file)
+}
 
-    async writeYAML(dst, yaml) {
-        const content = YAML.stringify(yaml, { collectionStyle: 'block', lineWidth: 150, directives: false })
-        await write(content).to(dst)
-    }
+async function writeYAML(dst, yaml) {
+    const content = YAML.stringify(yaml, { collectionStyle: 'block', lineWidth: 150, directives: false })
+    await write(content).to(dst)
+}
 
-    async copyRenderedYAML(src, dst, project) {
-        const yaml = await this.readYAML(src, project)
-        await write(yaml.toString()).to(dst)
-    }
+async function copyRenderedYAML(src, dst, project) {
+    const yaml = await readYAML(src, project)
+    await write(yaml.toString()).to(dst)
+}
 
-    async readJSON(src, project) {
-        const file = await read(src, 'utf8')
-        if (project) {
-            const Mustache = require('mustache')
-            const renderedFile = Mustache.render(file, project)
-            return JSON.parse(renderedFile)
-        }
-        try {
-            return JSON.parse(file)
-        } catch (error) {
-            throw new Error(error.message + '\n' + file)
-        }
-    }
+/* JSON and JSONC */
 
-    async readJSONC(src) {
-        return JSONC.parse(await read(src, 'utf8'))
+async function readJSON(src, project) {
+    const file = await read(src, 'utf8')
+    if (project) {
+        const Mustache = require('mustache')
+        const renderedFile = Mustache.render(file, project)
+        return JSON.parse(renderedFile)
     }
-
-    async copyRenderedJSON(src, dst, project) {
-        const json = await this.readJSON(src, project)
-        await write(dst, json, { spaces: 2 })
+    try {
+        return JSON.parse(file)
+    } catch (error) {
+        throw new Error(error.message + '\n' + file)
     }
+}
+
+async function readJSONC(src) {
+    return JSONC.parse(await read(src, 'utf8'))
+}
+
+async function copyRenderedJSON(src, dst, project) {
+    const json = await readJSON(src, project)
+    await write(dst, json, { spaces: 2 })
+}
+
+/* General */
+
+function isRoot(folder) {
+    const { root, dir } = parse(folder)
+    return root === dir
+}
+
+const DEFAULT_CONCURRENCY = (() => {
+  const cpu = os.availableParallelism()
+  const uv = Number(process.env.UV_THREADPOOL_SIZE) || 4
+  // Keep libuv busy without building huge backlogs. Clamp to [8,64].
+  return Math.min(64, Math.max(8, Math.min(cpu * 4, uv * 2)))
+})()
 
-    isRoot(folder) {
-        const { root, dir } = parse(folder)
-        return root === dir
+/**
+ * Recursively finds files in a directory tree with parallel traversal.
+ *
+ * @param {string} dir - Root directory to search
+ * @param {Object} [options] - Search options
+ * @param {(file: string) => boolean} [options.filter] - Filter predicate for paths
+ * @param {boolean} [options.ignoreSymlinks=false] - Skip symbolic links
+ * @returns {Promise<string[]>} Array of matching file paths
+ */
+async function find(dir, { filter, ignoreSymlinks = false } = {}) {
+    const files = /** @type {string[]} */([])
+    const queue = /** @type {string[]} */([dir])
+    const active = new Set()
+    const visit = async (/** @type {string} */ d) => {
+        let entries = /** @type {import('fs').Dirent[]} */([])
+        try { entries = await fsp.readdir(d, { withFileTypes: true }) }
+        catch { return }
+
+        await Promise.all(entries.map(async dirent => {
+            const p = join(d, dirent.name)
+            if (filter && !filter(p)) return
+            if (dirent.isDirectory()) { queue.push(p); return }
+            if (dirent.isFile()) { files.push(p); return }
+            if (!ignoreSymlinks && dirent.isSymbolicLink()) {
+                try {
+                    const stat = await fsp.stat(p)
+                    stat.isDirectory() ? queue.push(p) : files.push(p)
+                } catch { /* ignore */ }
+            }
+        }))
     }
+    while (queue.length || active.size) {
+        while (queue.length && active.size < DEFAULT_CONCURRENCY) {
+            const p = visit(queue.shift()).finally(() => active.delete(p))
+            active.add(p)
+        }
+        if (active.size) await Promise.race(active)
+    }
+    return files
+}
+
+module.exports = {
+    readYAML,
+    writeYAML,
+    copyRenderedYAML,
+    readJSON,
+    readJSONC,
+    copyRenderedJSON,
+    find,
+    isRoot
 }

package/lib/util/glob.js

@@ -9,7 +9,8 @@ const IGNORE_DIRS = new Set(['node_modules', '.git', '.hg', '.svn', 'dist', 'tar
  * Returns an AsyncIterator of those (recursive) subdirectories that match the glob pattern.
  * Skips common large directories (node_modules, .git, .hg, .svn, dist, target, build, out).
  * @param {string} pattern - The glob pattern to match against.
- * @param {string} cwd - The current working directory to start the search from.
+ * @param {object} options
+ * @param {string} options.cwd - The current working directory to start the search from.
  * @returns An array of relative paths that match the glob pattern.
  */
 async function* glob(pattern, { cwd } = { cwd: process.cwd() }) {

package/lib/util/term.js

@@ -49,13 +49,7 @@ Object.assign (format, {
     return `[${asErr('ERROR')}] ${toString(o, 'Error', withStack)}`
   },
   warn: o => DEBUG ? o : `[${asWarn('WARNING')}] ${toString(o, 'Warning')}`,
-  info: o => DEBUG ? o : `[${asInfo('INFO')}] ${toString(o, 'Info')}`,
-
-  poorMarkdown: (md) => {  return md
-    .replace(/\n# ([^\n]*)\n/g, `\n${as(t.bold, '$1')}\n`)
-    .replace(/ \*([^*]+)\*/g,   ` ${as(t.bold, '$1')}`)
-    .replace(/ _([^_]+)_/g,     ` ${as(t.link, '$1')}`)
-  }
+  info: o => DEBUG ? o : `[${asInfo('INFO')}] ${toString(o, 'Info')}`
 })
 
 function toString(o, severity, withStack) {

package/lib/util/write.js

@@ -30,7 +30,7 @@ const write = module.exports = Object.assign (
 	 * Fluent API to write (output) .to (dest...)
 	 * @param content - the content to be written; will be JSON.stringified if it's not a string
 	 */
-	(content) => ({ // NOSONAR
+	(content) => ({
 		/**
 		 * @param {string} [folder] - optional separately specified destination folder
 		 * @param {string} file - the filename to write to
@@ -56,7 +56,7 @@ const write = module.exports = Object.assign (
 /**
  * @returns {Promise<[string]>} a Promise resolving to an array of all written filenames
  */
-function _write (content, /*to:*/ dest, _many) { // NOSONAR
+function _write (content, /*to:*/ dest, _many) {
 
 	if (content instanceof Promise)  return content.then (c => _write(c, dest, _many))
 
@@ -95,5 +95,3 @@ function _write (content, /*to:*/ dest, _many) { // NOSONAR
 	.then (()=> file)
 
 }
-
-/* eslint no-console:off */

package/lib/watch/watched.js

@@ -26,7 +26,7 @@
   }}
 
   function _no_models_found(e) { console.log (`
-    No models found in ${e.locations||cds.resolve(e.model||'*',false)}.
+    No models found in ${(e.files||cds.resolve(e.model||'*',false)).filter(f => !(f in {schema:1,services:2}))}.
     Waiting for some to arrive...
   `)}