@sap/cds 5.5.5 → 5.6.3

package/CHANGELOG.md

@@ -4,6 +4,143 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version 5.6.3 - 2021-11-15
+
+### Fixed
+
+- `cds run` does not fail if `cds.requires.multitenancy` is explicitly set to `false`
+- Calculation of `DraftIsCreatedByMe` or `DraftIsProcessedByMe` when expanding or navigating to `DraftAdministrativeData`
+- Nested `any` in `$filter` query option
+- Crash on draft activate after draft edit for not existing composition of one, if no explicit DB service is defined
+- Typescript definition of `srv.delete` no longer leads to a duplication error
+
+## Version 5.6.2 - 2021-11-08
+
+### Fixed
+
+- Handle arrayed elements using templating mechanism
+- OData requests to `$count` endpoint of ETag enabled entity
+- `cds.test` does no longer crash if executed in `cds repl` on a remote service call
+- Crash on draft activate after draft edit for not existing composition of one
+- Ensure request correlation (with default server)
+- `<entity>.texts` points to real text entity
+- Draft union with expand to to-one and to-many
+- No columns in draft lock statement (i.e., use `SELECT 1`)
+
+## Version 5.6.1 - 2021-11-02
+
+### Fixed
+
+- UAA credentials lookup
+- Revert return type validation for `cds.String` for compatibility with older `@sap/cds-mtx` versions
+- Messaging: Ill-defined incoming AMQP messages will not crash the app
+- `cds compile -l` does no longer crash if called without `--to` option
+
+## Version 5.6.0 - 2021-10-29
+
+### Added
+
+- New REST protocol adapter (beta)
+  + Makes use of the beta OData URL to CQN parser. Hence, almost all OData requests are supported (see limitations below).
+  + Activate via `cds.env.features.rest_new_adapter = true`
+  + Out of scope (compared to OData protocol adapter):
+    + OData query option `$apply`
+    + Batch requests (with or without atomicity groups)
+    + Draft handling
+- New GraphQL protocol adapter (alpha)
+  + Serves single endpoint for all services based on `served` event at `/graphql` (subject to change).
+  + Activate via `cds.env.features.graphql = true`
+  + Required additional dependencies: `@graphql-tools/schema`, `express-graphql`, and `graphql`
+  + Not meant for productive use! For example, authentication and authorization are out of scope.
+- Support of the following features when using beta OData URL to CQN parser (`cds.env.features.odata_new_parser`):
+  + REST-style URLs (example: `GET /Foo/1`)
+  + `$expand=*` query option on different nested expand levels (`$levels` is not yet supported)
+  + draft handling
+  + structured keys
+  + streaming
+  + navigation to primitive properties without `$value` query option
+- Optimized Search: Support `$filter` query option in combination with optimize `$search` and localized data (when the environment variable `cds.env.features.optimized_search` is set to `true`)
+- `GET` requests support static values in ON-conditions of composition parents when using unmanaged backlinks
+- `destinationOptions` can be configured for Remote Services
+  + Example:
+    ```json
+      {"cds":{"requires":{
+        "S4": {
+          "destinationOptions": {
+            "selectionStrategy": "subscriberFirst",
+            ...
+          }
+        }
+      }}}
+    ```
+- `forwardAuthToken` can be configured for Remote Services
+  + Example:
+    ```json
+      {"cds":{"requires":{
+        "credentials": {
+          "url": "...",
+          "forwardAuthToken": true
+          }
+        }
+      }}}
+    ```
+- File to store private project settings `.cdsrc-private.json` (should not be checked in source code management)
+- Read additional configuration from JSON files or directory structures using `CDS_CONFIG` env variable
+- Missing typescript definitions for services' `.send` shortcuts `get`, `put`, `post`, `patch`, and `delete`
+- Build VCAP_SERVICES env variable dynamically for compatibility (`cds.env.features.emulate_vcap_services`)
+- GET requests to Remote OData Service are automatically sent as `$batch` if the generated URL is too long
+  + Can be configured via `cds.env.remote.max_get_url_length` (beta, default: 1028).
+- Provide ETag in response headers in case of `prefer: return=minimal`
+- Kibana formatter: log the user's id via `cds.env.log.user = true` (beta)
+  + Consider the data privacy implications!
+- Experimental support for uiflex running locally on sqlite by setting `cds.requires.extensibility.kind = uiflex`
+- Minified `cds.model` (deactivate via `cds.env.features.skip_unused = false`)
+
+### Changed
+
+- Query API: Specified keys are now part of the target path, e.g. `SELECT.from('Books', 1)` will move the key condition into `SELECT.from.ref`.
+  + Deactivate during two month grace period via compat feature flag `cds.env.features.keys_into_where = true`
+- Removed duplicate integrity checks
+- Optimized search: Optimize queries for non-localized elements
+- Non-specified columns are resolved at database layer
+- `cds deploy` no longer enforces the presence of SAP CommonCryptoLib (checked with env variable `SECUDIR`) on Windows since it uses now the built-in security libraries
+- Target keys are not included into a body when sending `PATCH` requests to external services
+
+### Fixed
+
+- Audit logging of non-string values
+- Query API compilation error when keys start with `{`
+- Handling of wrong Edm.DateTimeOffset values
+- Using UUIDs in search with beta OData URL to CQN parser (`cds.env.features.odata_new_parser`)
+- Runtime exception for READ requests with deeply nested navigation and structured keys, for example:
+`GET foo/Bar/b708ad6c-2dd4-40d5-91c0-2e3eacf306d2/Info/sales(a='1010',b='10',c='00')/functions(functionName='error')`
+- The check for the minimum Node.js version now properly enforces version 12.18, i.e. aborts server startup.
+- `cds.test` fails with a clearer error message if the server wasn't started at all
+- Audit logging for modification of personal or sensitive data when using same entity as a composition child in different parent entities
+- Deleting an entity defined with managed composition of one, whereas a dependent entity is defined having an independent managed association to its composition parent no longer crashes the application
+- Audit logging for entities having arrayed elements
+- Filtering for `cds.Date` on Remote OData V2 services
+- Crash when `rollup` function was used in groupBy in odata requests
+- Or for $filter with IsActiveEntity=true for access to active entities
+- Reading draft-enabled entity with `$expand` targeting non-draft associations
+- Delete with sub-select
+- Runtime exception when streaming property annotated with `@Core.MediaType: 'application/json'`
+- Reading streams via navigation when entity containing large data is a part of a draft-enabled composition tree
+- Read draft entity with nested exists restriction
+- Activate draft of entity having `to-one` and `to-many` compositions
+- Caching issue that causes the OData `omit-values` preference in `Prefer` HTTP headers to misbehaves
+- Deletion of draft instances if multiple draft enabled entities are used within one service
+- Queries with `contains` filter targeting a remote odata v2 service
+- Schema evolution support for nested CDS entities in `cds build`
+- I18n texts with quotes and other special characters get escaped correctly if they appear in XML and Json documents
+- Execution of plain SQL statements on SQLite
+- `Content-Disposition` header is now url encoded
+
+### Removed
+
+- Usage of `@sap/xsenv` is superseded with `cds.env` in node.js cds-runtime
+- `@odata.on.insert/update` and `#user/now` are deprecated and will be removed in the next major version. Use `@cds.on.insert/update` and `$user/now` instead.
+
 ## Version 5.5.5 - 2021-10-20
 
 ### Fixed
@@ -58,6 +195,7 @@
 ### Added
 
 - Support for minified models
+- Messaging: Support for string payloads
 - Messaging: Webhooks use 'application/json' as the default content type
 - Messaging: If senders don't use `data` as a property of the payload, then the whole payload is interpreted as `data`
 - Messaging: Support for `$namespace` placeholer in queue name
@@ -155,7 +293,7 @@
 - Messaging: In multitenancy mode, messaging artifacts are only deployed to subscribers (unless the service option `deployForProvider` is set to `true`)
 - Messaging: Incoming messages without corresponding handlers are not acknowledged
 - If a service executes a query targeting a projection on one of its entities, the query is resolved along with projections to an entity known by the executing service. The result is post-processed to reflect the expected result of the incoming query. The reason is that no handlers of the executing service were executed as they did not know the query target.
-  + Deactivate during two month grace period via compact feature flag `cds.env.features.resolve_views = false`
+  + Deactivate during two month grace period via compat feature flag `cds.env.features.resolve_views = false`
 - Use `@sap/cds-compiler`'s `smartId` function to determine whether a reference needs to be quoted.
   + Allows the use of non-word characters in column names, for example `entity Foo { ![bar/bz]: String; }`.
   + Support for columns with spaces with feature flag `cds.env.features.spaced_columns`.

package/apis/services.d.ts

@@ -140,7 +140,37 @@ export class Service extends QueryAPI {
 	 */
 	send (details: { event: Events, data?: object, headers?: object }) : Promise<this>
 
-	// The central method to dispatch events
+	/**
+	 * Constructs and sends a GET request.
+	 * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
+	 */
+	get (entityOrPath: Target, data?: object) : Promise<this>
+	 /**
+	 * Constructs and sends a POST request.
+	 * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
+	 */
+	post (entityOrPath: Target, data?: object) : Promise<this>
+	/**
+	 * Constructs and sends a PUT request.
+	 * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
+	 */
+	put (entityOrPath: Target, data?: object) : Promise<this>
+	/**
+	 * Constructs and sends a PATCH request.
+	 * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
+	 */
+	patch (entityOrPath: Target, data?: object) : Promise<this>
+	 /**
+	 * Constructs and sends a DELETE request.
+	 * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
+	 */
+	delete (entityOrPath: Target, data?: object) : Promise<this>
+	/**
+	 * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
+	 */
+	delete <T>(entity : Definition | string, key?: any) : DELETE<T>
+
+	 // The central method to dispatch events
 	dispatch (msg: EventMessage): Promise<any>
 
 

package/app/index.js

@@ -6,7 +6,7 @@ module.exports = { get html(){
   const odata = srv => Object.keys(srv._adapters).find (a => a.startsWith ('odata'))
   const metadata = srv => odata(srv) ? ` / <a href="${srv.path}/$metadata">$metadata</a>` : ``
 
-  const html = fs.readFileSync(path.join(__dirname,'index.html'),'utf-8')
+  let html = fs.readFileSync(path.join(__dirname,'index.html'),'utf-8')
   // .replace ('{{subtitle}}', 'Version ' + cds.version)
   .replace (/{{package}}/g, _project())
   .replace (/{{app}}/g, cds.env.folders.app.replace(/*trailing slash*/ /\/$/, ''))
@@ -15,16 +15,27 @@ module.exports = { get html(){
     ).join('\n') || '— none —'
   )
   .replace ('{{services}}', cds.service.providers.map (srv => `
-    <h3>
-      <a href="${srv.path}">${srv.path}</a>${metadata(srv)} ${_moreLinks(srv)}
-    </h3>
-    <ul>${_entities_in(srv).map (e => {
-      return `
-      <li>
-        <a href="${srv.path}/${e.replace(/\./g, '_')}">${e}</a> ${_moreLinks(srv, e)}
-      </li>`}).join('')}
-    </ul>
-  `) .join(''))
+        <h3>
+          <a href="${srv.path}">${srv.path}</a>${metadata(srv)} ${_moreLinks(srv)}
+        </h3>
+        <ul>${_entities_in(srv).map (e => {
+          return `
+          <li>
+            <a href="${srv.path}/${e.replace(/\./g, '_')}">${e}</a> ${_moreLinks(srv, e)}
+          </li>`}).join('')}
+        </ul>
+  `).join(''))
+
+  // add /graphql
+  if (cds.env.features.graphql) {
+    html = html.replace(/\n\s*<footer>/, `
+
+        <h3>
+          <a href="/graphql">/graphql</a>
+        </h3>
+
+        <footer>`)
+  }
 
   Object.defineProperty (this,'html',{value:html})
   return html

package/bin/build/buildTaskFactory.js

@@ -150,7 +150,7 @@ class BuildTaskFactory {
     _adaptBuildTargetSettingForJava(projectPath) {
         if (this.env.build.target !== ".") {
             // filter user settings of cds.env
-            const userEnv = this.env.for("cds", projectPath, false, true)
+            const userEnv = this.env.for("cds", projectPath, false)
 
             // use helper as env.build might be undefined
             if (!getProperty(userEnv, "build.target")) {

package/bin/build/provider/buildTaskProviderInternal.js

@@ -174,7 +174,7 @@ class BuildTaskProviderInternal extends BuildTaskProvider {
         }
         // check whether cds config represents a legacy build system config for which requires.db was not configured
         // Note: compat layer sets requires.db: {}
-        const userEnv = this.cds.env.for("cds", projectPath, false, true)
+        const userEnv = this.cds.env.for("cds", projectPath, false)
         return userEnv && (userEnv.get("data.model") || userEnv.get("service.model"))
     }
 

package/bin/build/provider/fiori/index.js

@@ -51,7 +51,7 @@ class FioriAppModuleBuilder extends BuildTaskHandlerEdmx {
 
                 if (javaTask
                     && await isOldJavaStack([javaTask.src, this.buildOptions.root])
-                    && !this.env.for("cds", this.buildOptions.root, false, true).get(ODATA_VERSION)) {
+                    && !this.env.for("cds", this.buildOptions.root, false).get(ODATA_VERSION)) {
 
                     // old java stack
                     // default is now v4 and not v2 anymore, so overwrite with v2 if using default

package/bin/build/provider/hana/2migration.js

@@ -1,6 +1,7 @@
 const path = require('path')
 const parser = require('./migrationtable')
 const { getProperty, BuildError } = require('../../util')
+const { getArtifactCdsPersistenceName } = require('@sap/cds-compiler')
 const { LOG_MODULE_NAMES } = require('../../constants')
 const cdscVersion = `-- generated by cds-compiler version ${require('@sap/cds-compiler/package.json').version}`
 const cds = require('../../cds'), minified = csn => cds.linked(csn).minified()
@@ -12,15 +13,15 @@ module.exports = async (model, lastDevVersion, srcPath, options = {}) => {
     logger = options.logger
   }
 
-  const journalEntityNames = _getJournalEntityNames(model)
-  const { definitions, deletions, migrations, afterImage } = _toHdiMigration(model, lastDevVersion, journalEntityNames, options)
+  const journalFileNames = _getJournalFileNames(model)
+  const { definitions, deletions, migrations, afterImage } = _toHdiMigration(model, lastDevVersion, journalFileNames, options)
   const definitionResult = []
 
   for (const { name, suffix, sql } of definitions) {
     let definitionEntry = { name, suffix, content: sql }
 
     if (suffix === '.hdbtable') {
-      if (journalEntityNames.has(name)) {
+      if (journalFileNames.has(name)) {
         const migration = migrations.find(migration => migration.name === name)
         definitionEntry = await _2migrationtable(srcPath, migration || _emptyMigration(name), sql, options)
       }
@@ -32,14 +33,14 @@ module.exports = async (model, lastDevVersion, srcPath, options = {}) => {
   return { definitions: definitionResult, deletions, afterImage }
 }
 
-function _toHdiMigration(model, lastDevVersion, journalEntityNames, options) {
+function _toHdiMigration(model, lastDevVersion, journalFileNames, options) {
   options.sqlChangeMode = getProperty(options, 'hana.journal.change-mode')
   const result = cdsc.to.hdi.migration(minified(model), options, lastDevVersion);
   if (logger._debug) {
     logger.debug('cdsc.to.hdi.migration returned')
     for (const { name, suffix, sql } of result.definitions) {
       if (suffix === '.hdbtable' || suffix === '.hdbmigrationtable') {
-        if (journalEntityNames.has(name)) {
+        if (journalFileNames.has(name)) {
           const migration = result.migrations.find(migration => migration.name === name)
           logger.debug(`
 File ${name + '.hdbmigrationtable'} - ${migration ? migration.changeset.length : 0} new changes
@@ -132,7 +133,7 @@ function _emptyMigration(name) {
   return { name, suffix: ".hdbmigrationtable", changeset: [] }
 }
 
-function _getJournalEntityNames(model) {
+function _getJournalFileNames(model) {
   const journalNames = new Set(cds.reflect(model).all(item => {
     if (item.kind === 'entity' && item['@cds.persistence.journal'] === true) {
       if (item['@cds.persistence.skip'] === true || item['@cds.persistence.exists'] === true) {
@@ -141,7 +142,7 @@ function _getJournalEntityNames(model) {
       return true
     }
     return false
-  }).map(entity => entity.name))
+  }).map(entity => getArtifactCdsPersistenceName(entity.name, 'quoted', model)))
 
   logger._debug && logger.debug(`\n[hdbmigrationtable] found ${journalNames.size} model entities annotated with '@cds.persistence.journal`)
   logger._debug && logger.debug(`[hdbmigrationtable] ${[...journalNames].join(', ')}\n`)

package/bin/build/provider/java-cf/index.js

@@ -27,7 +27,7 @@ class JavaCfModuleBuilder extends BuildTaskHandlerEdmx {
                 throw new BuildError('CDS compiler version 2 does no longer support the classic CAP Java runtime. It is recommended to migrate to the current CAP Java runtime SDK. See https://cap.cloud.sap/docs/java/migration for more.')
             }
             // default is now v4 and not v2 anymore, so warn and overwrite with v2 if using default
-            if (!this.env.for('cds', this.buildOptions.root, false, true).get(ODATA_VERSION)) {
+            if (!this.env.for('cds', this.buildOptions.root, false).get(ODATA_VERSION)) {
                 odataOptions.version = ODATA_VERSION_V2
                 this.pushMessage('Forcing OData v2 for building though the default is v4. Make sure to define OData v2 in cds configuration.', INFO)
             }

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

@@ -11,7 +11,7 @@ const { defaultLogger, nullLogger } = require('./logger');
 const hdiDeployUtil = require('./hdiDeployUtil');
 const mtaUtil = require('../../build/mtaUtil');
 const runCommand = require('./runCommand');
-const { bold, error, info } = require('../../utils/term');
+const { bold, info } = require('../../utils/term');
 
 
 const IS_WIN = (os.platform() === 'win32');
@@ -27,8 +27,6 @@ class HanaDeployer {
     logger.log(`[cds.deploy] - ${bold('Starting deploy to SAP HANA ...')}`);
     logger.log();
 
-    this._validateEnvironment(logger);
-
     const projectPath = path.resolve(process.env._TEST_CWD || process.cwd());
 
     const { buildResults } = await this._build(buildTaskOptions, model, logger);
@@ -276,20 +274,6 @@ ${entry}
     }
   }
 
-
-  _validateEnvironment(logger) {
-    if (IS_WIN && !process.env.SECUDIR) {
-      const helpUrl = info('https://help.sap.com/viewer/e54136ab6a4a43e6a370265bf0a2d744/latest/en-US/c049e28431ee4e8280cd6f5d1a8937d8.html');
-      const errMessage = error('[ERROR]') + ` [cds.deploy] - In order to use the hdi deployer on ${bold("Windows")} you require the ${bold("SAP CommonCryptoLib")}.
-Please follow ${helpUrl}
-for further information on how to obtain ${bold("SAP CommonCryptoLib")}.
-`;
-      logger.error(errMessage);
-      throw new Error(`[cds.deploy] - Missing SAP CommonCryptoLib`);
-    }
-  }
-
-
   _getVCAPServicesEntry(serviceInstanceName, serviceKey) {
     return {
       hana: [

package/common.cds

@@ -65,6 +65,13 @@ aspect temporal {
 type User : String(255);
 
 
+/*
+ * Aspects for extensible entities.
+ */
+aspect extensible {
+    @cds.api.ignore extensions__ : String
+};
+
 //---------------------------------------------------------------------------
 // Annotations for Fiori UIs...
 
@@ -122,6 +129,7 @@ annotate managed with {
 //---------------------------------------------------------------------------
 // Temporary Workarounds...
 
+// REVISIT: Remove support for @odata.on... and #... with @sap/cds ^6
 // REVISIT: change @odata.on... to @cds.on...
 // REVISIT: @cds.on... should automatically result in @readonly @Core.Computed
 

package/lib/compile/to/sql.js

@@ -1,9 +1,9 @@
 const cds = require ('../..'), minified = csn => cds.linked(csn).minified()
 const cdsc = require ('../cdsc')
 const {unfold_ddl} = cds.alpha_localized
+const EXT_BACK_PACK = 'extensions__'
 
-
-function cds_compile_to_sql (csn,_o) {
+function cds_compile_to_sql_ (csn,_o) {
   const o = cdsc._options.for.sql(_o) //> used twice below...
   const all = cdsc.to.sql (minified(csn),o)
   const sql = unfold_ddl (all.map (each => each
@@ -13,6 +13,26 @@ function cds_compile_to_sql (csn,_o) {
   return sql
 }
 
+function cds_compile_to_sql (csn,_o) {
+  const defs = cds.linked(csn).definitions
+  for (let each in defs) {
+    const d = defs[each], q = d.query
+    // q may have SET instead of SELECT
+    if (q && q.SELECT && q.SELECT.columns && _is_extensible(d)) _add_extensions2 (q.SELECT.columns)
+  }
+  function _is_extensible (d) {
+    if(!d || !d.elements) return false
+    if (EXT_BACK_PACK in d.elements) return true
+    else return _is_extensible (d.__proto__)
+  }
+  function _add_extensions2 (cols) {
+    if (cols.some(({ref}) => ref && ref[0] === EXT_BACK_PACK)) return
+    cols.push({ref:[EXT_BACK_PACK]})
+  }
+  const ddl = cds_compile_to_sql_ (csn,_o)
+  return ddl
+}
+
 
 function cds_compile_to_hdbtable (csn,o) {
   const all = cdsc.to.hdi (minified(csn),o)

package/lib/connect/bindings.js

@@ -19,9 +19,10 @@ module.exports = class Bindings {
         return bindings.import() .then (r,e)
     }
 
-    constructor() {
+    constructor(url) {
         this._source = require ('path') .resolve (cds.root, registry.replace(/^~/, require('os').homedir()))
         this.cds = {provides:{}}
+        this.url = url
     }
 
     async load (sync) {

package/lib/core/reflect.js

@@ -1,5 +1,6 @@
 const { types, classes:{ service, entity, action, event, any, struct, array, context, annotation } } = require('.')
 const _kinds = { annotation, context, service, action, event, entity, view:entity }
+const _minified = Symbol('minified')
 
 class LinkedCSN extends any {
 
@@ -25,6 +26,7 @@ class LinkedCSN extends any {
         /* else: */         any.prototype
       )
       if (p.key && !d.key && d.kind === 'element') Object.defineProperty (d,'key',{value:undefined})  //> don't propagate .key
+      if (d.elements && d.elements.localized) Object.defineProperty (d,'texts',{value: defs [d.elements.localized.target] })
       try { return Object.setPrototypeOf(d,p) }            //> link d to resolved proto
       catch(e) {                                          //> cyclic proto error
         let msg = d.name; for (; p && p.name; p = p.__proto__) msg += ' > '+p.name
@@ -48,6 +50,7 @@ class LinkedCSN extends any {
 
   minified (skip = global.cds.env.features.skip_unused) {
     if (!skip) return this
+    if (this[_minified]) return this; else _set (this,_minified,true)
     const csn = this, all = csn.definitions, reached = new Set
     const roots = skip === 'all' ? this.services : this.each(_root)
     for (let each of roots) _visit (each)
@@ -74,7 +77,7 @@ class LinkedCSN extends any {
         if (n.endsWith('.texts'))  delete all[n.replace('.texts','_texts')]
       }
     }
-    return csn
+    return this
   }
 
   *each (x, defs=this.definitions) {