@sap/cds 7.1.1 → 7.1.2

package/CHANGELOG.md

@@ -4,6 +4,18 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version 7.1.2 - 2023-08-11
+
+### Fixed
+
+- `req.tenant` is undefined when using new OData parser
+- Draft: replace some occurrences of the `arr.push(...largeArray)` pattern when copying large arrays to prevent maximum call stack size exceeded errors due to large deep update processing when saving the draft
+- Do not add keys to diff as they could be renamed (which leads to SQL error)
+- Custom bound actions for draft-enabled entities don't trigger a READ request on application service anymore
+- `cds.connect.to('db', options)`: add-hoc options for SAP HANA Database Service
+- Reading key-less singleton with `$select` clause while using the new OData parser `cds.env.features.odata_new_parser`
+- Don't use colored logs if `process.env.NO_COLOR` is set or not logging to a terminal (i.e., `!process.stdout.isTTY || !process.stderr.isTTY`)
+
 ## Version 7.1.1 - 2023-08-01
 
 ### Fixed
@@ -312,6 +324,7 @@ cds env requires/cds.xt.ModelProviderService
 ## Version 6.6.0 - 2023-02-27
 
 ### Added
+
 - Improved error handling for `cds build` if the SaaS base model is missing in an extension project.
 - Support for reliable paging using `$skiptoken`. Can be activated via `cds.query.limit.reliablePaging = true`
 - Built-in models are now added to existing model options of custom build tasks.

package/lib/dbs/cds-deploy.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 const cds = require('../index'), { local } = cds.utils
-const COLORS = !!process.stdout.isTTY && !!process.stderr.isTTY
+const COLORS = !!process.stdout.isTTY && !!process.stderr.isTTY && !process.env.NO_COLOR
 const GREY = COLORS ? '\x1b[2m' : ''
 const RESET = COLORS ? '\x1b[0m' : ''
 let DEBUG // IMPORTANT: initialized later after await cds.plugins

package/libx/_runtime/cds-services/adapter/odata-v4/ODataRequest.js

@@ -90,6 +90,7 @@ class ODataRequest extends cds.Request {
       // REVISIT needed in case of $batch, replace after removing okra
       const method = odataReq.getIncomingRequest().method
       const { user } = req
+      const tenant = req.tenant || user?.tenant
       const info = metaInfo(query, type, service, data, req, upsert)
       const { event, unbound } = info
       if (event === 'READ') {
@@ -98,7 +99,8 @@ class ODataRequest extends cds.Request {
         if (!isStreaming(segments)) handleStreamProperties(target, query, service.model, true)
       }
       const _queryOptions = odataReq.getQueryOptions()
-      super({ event, target, data, query: unbound ? {} : query, user, method, headers, req, res, _queryOptions })
+      // prettier-ignore
+      super({ event, target, data, query: unbound ? {} : query, user, tenant, method, headers, req, res, _queryOptions })
       this._metaInfo = info.metadata
     } else {
       /*

package/libx/_runtime/cds-services/services/utils/compareJson.js

@@ -133,11 +133,6 @@ const _addToBeDeletedEntriesToResult = (results, entity, keys, newValues, oldVal
 
 const _normalizeToArray = value => (Array.isArray(value) ? value : value === null ? [] : [value])
 
-const _addKeysToEntryIfNotExists = (keys, newEntry) => {
-  if (!newEntry) return
-  for (const key of keys) if (!(key in newEntry)) newEntry[key] = undefined
-}
-
 const _isUnManaged = element => {
   return element.on && !element._isSelfManaged
 }
@@ -207,11 +202,7 @@ const compareJsonDeep = (entity, newValue = [], oldValue = [], opts) => {
   for (const newEntry of newValues) {
     const result = {}
     const oldEntry = _getCorrespondingEntryWithSameKeys(oldValues, newEntry, keys)
-
-    _addKeysToEntryIfNotExists(keys, newEntry)
-
     _iteratePropsInNewEntry(newEntry, keys, result, oldEntry, entity, opts)
-
     resultsArray.push(result)
   }
 

package/libx/_runtime/cds-services/services/utils/differ.js

@@ -37,16 +37,14 @@ module.exports = class Differ {
     return columns
   }
 
-  _diffDelete(req) {
+  async _diffDelete(req) {
     const { DELETE } = cds.env.fiori.lean_draft ? req.query : (req._ && req._.query) || req.query
     const target = DELETE._transitions?.[DELETE._transitions.length - 1]?.target || req.target
     const query = SELECT.from(DELETE.from).columns(this._createSelectColumnsForDelete(target))
     if (DELETE.where) query.where(DELETE.where)
-
-    return cds
-      .tx(req)
-      .run(query)
-      .then(dbState => compareJson(undefined, dbState, req.target, { ignoreDraftColumns: true }))
+    const dbState = await cds.tx(req).run(query)
+    const diff = compareJson(undefined, dbState, req.target, { ignoreDraftColumns: true })
+    return diff
   }
 
   async _addPartialPersistentState(req) {
@@ -62,7 +60,8 @@ module.exports = class Differ {
     enrichDataWithKeysFromWhere(combinedData, req, this._srv)
     const lastTransition = newQuery.UPDATE._transitions[newQuery.UPDATE._transitions.length - 1]
     const revertedPersistent = revertData(req._.partialPersistentState, lastTransition, this._srv)
-    return compareJson(combinedData, revertedPersistent, req.target, { ignoreDraftColumns: true })
+    const diff = compareJson(combinedData, revertedPersistent, req.target, { ignoreDraftColumns: true })
+    return diff
   }
 
   async _diffPatch(req, providedData) {
@@ -87,10 +86,9 @@ module.exports = class Differ {
       providedData || (req.query.INSERT.entries && req.query.INSERT.entries.length === 1)
         ? req.query.INSERT.entries[0]
         : req.query.INSERT.entries
-
     enrichDataWithKeysFromWhere(originalData, req, this._srv)
-
-    return compareJson(originalData, undefined, req.target, { ignoreDraftColumns: true })
+    const diff = compareJson(originalData, undefined, req.target, { ignoreDraftColumns: true })
+    return diff
   }
 
   async calculate(req, providedData) {

package/libx/_runtime/common/composition/data.js

@@ -133,7 +133,7 @@ const _subData = (data, prop) =>
   data.reduce((result, entry) => {
     if (prop in entry) {
       const elementValue = ctUtils.val(entry[prop])
-      result.push(...ctUtils.array(elementValue))
+      for (const val of ctUtils.array(elementValue)) result.push(val)
     }
     return result
   }, [])
@@ -196,7 +196,8 @@ const _mergeResults = (result, selectData, root, model, compositionTree, entityN
       if (newData[0]) selectEntry[compositionTree.name] = Object.assign(selectEntry[compositionTree.name], newData[0])
       else selectEntry[compositionTree.name] = null
     } else if (assoc.is2many) {
-      selectEntry[compositionTree.name].push(...newData)
+      const entry = selectEntry[compositionTree.name]
+      for (const val of newData) entry.push(val)
     }
 
     return selectEntry
@@ -263,13 +264,13 @@ const _selectDeepUpdateData = async args => {
       }
       const _args = { ...args, where: [keys, 'in', values], parentKeys: undefined }
       const selectCQN = _select(_args)
-      result.push(...(await tx.run(selectCQN)))
+      result = result.concat(await tx.run(selectCQN))
     }
   } else if (where && !Array.isArray(where)) {
     for (let w of Object.values(where)) {
       const _args = { ...args, where: w }
       const selectCQN = _select(_args)
-      result.push(...(await tx.run(selectCQN)))
+      result = result.concat(await tx.run(selectCQN))
     }
   } else {
     const selectCQN = _select(args)

package/libx/_runtime/common/composition/insert.js

@@ -32,8 +32,9 @@ const _addSubDeepInsertCQN = (model, compositionTree, data, cqns, draft) => {
           const subData = ctUtils.array(elementValue).filter(ele => Object.keys(ele).length > 0)
           if (subData.length > 0) {
             // REVISIT: this can make problems
-            insertCQN.INSERT.entries.push(...ctUtils.cleanDeepData(subEntity, subData))
-            result.push(...subData)
+            const entries = insertCQN.INSERT.entries
+            for (const data of ctUtils.cleanDeepData(subEntity, subData)) entries.push(data)
+            for (const data of subData) result.push(data)
           }
         }
       }

package/libx/_runtime/common/composition/update.js

@@ -144,7 +144,8 @@ function _addSubDeepUpdateCQNForUpdateInsert({ entity, entityName, data, selectD
 async function _addSubDeepUpdateCQNCollect(model, cqns, updateCQNs, insertCQN, deleteCQNs, req) {
   if (updateCQNs.length > 0) {
     cqns[0] = cqns[0] || []
-    cqns[0].push(...updateCQNs)
+    const cqn = cqns[0]
+    for (const updateCQN of updateCQNs) cqn.push(updateCQN)
   }
 
   if (insertCQN.INSERT.entries.length > 0) {
@@ -157,7 +158,8 @@ async function _addSubDeepUpdateCQNCollect(model, cqns, updateCQNs, insertCQN, d
       if (!intoCQN) {
         cqns[0].push(insertCQN)
       } else {
-        intoCQN.INSERT.entries.push(...insertCQN.INSERT.entries)
+        const intoCQNEntries = intoCQN.INSERT.entries
+        for (const entry of insertCQN.INSERT.entries) intoCQNEntries.push(entry)
       }
     })
   }
@@ -182,7 +184,7 @@ const _addToData = (subData, entity, element, entry) => {
   const value = ctUtils.val(entry[element.name])
   const subDataEntries = ctUtils.array(value)
   const unwrappedSubData = subDataEntries.map(entry => _unwrapIfNotArray(entry))
-  subData.push(...unwrappedSubData)
+  for (const val of unwrappedSubData) subData.push(val)
 }
 
 async function _addSubDeepUpdateCQNRecursion({ model, compositionTree, entity, data, selectData, cqns, draft, req }) {
@@ -310,7 +312,7 @@ const getDeepUpdateCQNs = async (model, req, selectData) => {
   })
   subCQNs.forEach((subCQNs, index) => {
     cqns[index] = cqns[index] || []
-    cqns[index].push(...subCQNs)
+    for (const cqn of subCQNs) cqns[index].push(cqn)
   })
 
   // remove empty updates and inserts

package/libx/_runtime/common/generic/auth/restrict.js

@@ -121,7 +121,7 @@ const _addWheresToRef = (ref, model, resolvedApplicables) => {
         newIdentifier.where = [{ xpr: newIdentifier.where }, 'and']
       }
 
-      newIdentifier.where.push(..._getMergedWhere(applicablesForEntity))
+      for (const val of _getMergedWhere(applicablesForEntity)) newIdentifier.where.push(val)
     }
 
     newRef.push(newIdentifier)

package/libx/_runtime/db/utils/coloredTxCommands.js

@@ -1,5 +1,7 @@
+const COLORS = !!process.stdout.isTTY && !!process.stderr.isTTY && !process.env.NO_COLOR
+
 module.exports = {
-  BEGIN: '\x1b[1m\x1b[33mBEGIN\x1b[0m',
-  COMMIT: '\x1b[1m\x1b[32mCOMMIT\x1b[0m',
-  ROLLBACK: '\x1b[1m\x1b[91mROLLBACK\x1b[0m'
+  BEGIN: COLORS ? '\x1b[1m\x1b[33mBEGIN\x1b[0m' : 'BEGIN',
+  COMMIT: COLORS ? '\x1b[1m\x1b[32mCOMMIT\x1b[0m' : 'COMMIT',
+  ROLLBACK: COLORS ? '\x1b[1m\x1b[91mROLLBACK\x1b[0m' : 'ROLLBACK'
 }

package/libx/_runtime/fiori/lean-draft.js

@@ -286,9 +286,13 @@ cds.ApplicationService.prototype.handle = async function (req) {
   if (req.target.actions?.[req.event] && draftParams.IsActiveEntity === false) {
     if (query.SELECT?.from?.ref) query.SELECT.from.ref = _redirectRefToDrafts(query.SELECT.from.ref, this.model)
     const rootQuery = query.clone()
-    rootQuery.SELECT.columns = [{ ref: ['DraftAdministrativeData'], expand: [{ ref: ['InProcessByUser'] }] }]
+    const columns = Object_keys(query._target.keys)
+      .filter(k => k !== 'IsActiveEntity')
+      .map(k => ({ ref: [k] }))
+    columns.push({ ref: ['DraftAdministrativeData'], expand: [{ ref: ['InProcessByUser'] }] })
+    rootQuery.SELECT.columns = columns
     rootQuery.SELECT.one = true
-    const root = await rootQuery
+    const root = await cds.run(rootQuery)
     if (!root) req.reject(404)
     if (root.DraftAdministrativeData?.InProcessByUser !== cds.context.user.id) req.reject(403)
     const _req = _newReq(req, query, draftParams, { event: req.event })
@@ -450,6 +454,7 @@ const Read = {
   },
   all: async function (run, query) {
     LOG.debug('List Editing Status: All')
+    if (!query._drafts) return []
     query._drafts.SELECT.count = false
     query._drafts.SELECT.limit = undefined // We need all entries for the keys to properly select actives (count)
     const isCount = _isCount(query._drafts)
@@ -567,21 +572,17 @@ const Read = {
     if (!actives.length) return []
     const drafts = cds.ql.clone(query._drafts)
     drafts.SELECT.where = Read.whereIn(query._target, actives)
-    if (drafts.SELECT.columns?.some(c => c === '*')) {
-      drafts.SELECT.columns = drafts.SELECT.columns.filter(c => c !== '*')
-      if (!drafts.SELECT.columns.some(c => c.ref?.[0] === 'DraftAdministrativeData_DraftUUID')) {
-        drafts.SELECT.columns.push({ ref: ['DraftAdministrativeData_DraftUUID'] })
-      }
-    }
-    const relevantColumns = ['DraftAdministrativeData', 'DraftAdministrativeData_DraftUUID']
-    drafts.SELECT.columns = (
-      drafts.SELECT.columns?.filter(c => c.ref && relevantColumns.includes(c.ref[0])) ||
-      relevantColumns.map(k => ({ ref: [k] }))
-    ).concat(
-      Object_keys(query._target.keys)
-        .filter(k => k !== 'IsActiveEntity')
-        .map(k => ({ ref: [k] }))
+    const newColumns = Object_keys(query._target.keys)
+      .filter(k => k !== 'IsActiveEntity')
+      .map(k => ({ ref: [k] }))
+    if (
+      !drafts.SELECT.columns ||
+      drafts.SELECT.columns.some(c => c === '*' || c.ref?.[0] === 'DraftAdministrativeData_DraftUUID')
     )
+      newColumns.push({ ref: ['DraftAdministrativeData_DraftUUID'] })
+    const draftAdmin = drafts.SELECT.columns?.find(c => c.ref?.[0] === 'DraftAdministrativeData')
+    if (draftAdmin) newColumns.push(draftAdmin)
+    drafts.SELECT.columns = newColumns
     drafts.SELECT.count = undefined
     drafts.SELECT.search = undefined
     drafts.SELECT.one = undefined
@@ -662,6 +663,7 @@ function _cleansed(query, model) {
       draftsQuery._target = undefined
       const [root, ...tail] = draftsQuery.SELECT.from.ref
       const draft = model.definitions[root.id || root].drafts
+      if (!draft) return
       draftsQuery.SELECT.from = {
         ref: [root.id ? { ...root, id: draft.name } : draft.name, ...tail]
       }

package/libx/_runtime/hana/pool.js

@@ -15,18 +15,20 @@ const _getMassagedCreds = function (creds) {
   return creds
 }
 
-// NOTE: disableCache: true means "force fetch credentials from service manager"
-async function credentials4(tenant, { disableCache = false }) {
-  const { credentials } = cds.env.requires.db
+// `disableCache: true` means to force fetch credentials from service manager
+async function credentials4(tenant, db) {
+  const { disableCache = false, options } = db
+  const credentials = options?.credentials ?? cds.env.requires.db?.credentials
   if (!credentials) throw new Error('No database credentials provided')
+
   if (cds.requires.multitenancy) {
     // eslint-disable-next-line cds/no-missing-dependencies
     const res = await require('@sap/cds-mtxs/lib').xt.serviceManager.get(tenant, { disableCache })
     return _getMassagedCreds(res.credentials)
-  } else {
-    if (typeof credentials !== 'object' || !credentials.host) throw new Error('Malformed database credentials provided')
-    return _getMassagedCreds(credentials)
   }
+
+  if (typeof credentials !== 'object' || !credentials.host) throw new Error('Malformed database credentials provided')
+  return _getMassagedCreds(credentials)
 }
 
 function factory4(creds, tenant) {
@@ -89,55 +91,48 @@ const pools = new Map()
 
 async function pool4(tenant, db) {
   if (!pools.get(tenant)) {
-    pools.set(
-      tenant,
-      new Promise((resolve, reject) => {
-        credentials4(tenant, db)
-          .then(creds => {
-            const config = _getPoolConfig()
-            LOG._info && LOG.info('effective pool configuration:', config)
-            const p = pool.createPool(factory4(creds, tenant), config)
-
-            const INVALID_CREDENTIALS_WARNING = `Could not establish connection for tenant "${tenant}". Existing pool will be drained.`
-            const INVALID_CREDENTIALS_ERROR = new Error(
-              `Create is blocked for tenant "${tenant}" due to invalid credentials.`
-            )
-
-            /*
-             * The error listener for "factoryCreateError" is registered to find out failed connection attempts.
-             * If it fails due to invalid credentials, we delete the current pool from the pools map and overwrite the
-             * pool factory create function.
-             * Background is that generic-pool will continue to try to open a connection by calling the factory create
-             * function until the "acquireTimeoutMillis" is reached.
-             * This ends up in many connection attempts for one request even though the credentials are invalid.
-             * Because of the deletion in the map, subsequent requests will fetch the credentials again.
-             */
-            p.on('factoryCreateError', async function (err) {
-              if (err._connectError) {
-                LOG._warn && LOG.warn(INVALID_CREDENTIALS_WARNING)
-                pools.delete(tenant)
-                if (p._factory && p._factory.create) {
-                  // reject after 100 ms to not block CPU completely
-                  p._factory.create = () =>
-                    new Promise((resolve, reject) => setTimeout(() => reject(INVALID_CREDENTIALS_ERROR), 100))
-                }
-                await p.drain()
-                await p.clear()
-              }
-            })
+    const poolPromise = new Promise((resolve, reject) => {
+      credentials4(tenant, db)
+        .then(creds => {
+          const config = _getPoolConfig()
+          LOG._info && LOG.info('effective pool configuration:', config)
+          const p = pool.createPool(factory4(creds, tenant), config)
+          const INVALID_CREDENTIALS_WARNING = `Could not establish connection for tenant "${tenant}". Existing pool will be drained.`
+          const INVALID_CREDENTIALS_ERROR = new Error(
+            `Create is blocked for tenant "${tenant}" due to invalid credentials.`
+          )
 
-            resolve(p)
-          })
-          .catch(e => {
-            // delete pools entry if fetching credentials failed
-            pools.delete(tenant)
-            reject(e)
+          // The error listener for `factoryCreateError` is registered to detect failed connection attempts.
+          // If it fails due to invalid credentials, we delete the current pool from the pools map and overwrite the
+          // pool factory create function.
+          // The background is that the generic pool will keep trying to establish a connection by invoking the factory
+          // create function until the `acquireTimeoutMillis` is reached.
+          // This leads to numerous connection attempts for a single request, even when the credentials are invalid.
+          // Due to the deletion in the map, subsequent requests will retrieve the credentials again.
+          p.on('factoryCreateError', async function (err) {
+            if (err._connectError) {
+              LOG._warn && LOG.warn(INVALID_CREDENTIALS_WARNING)
+              pools.delete(tenant)
+              if (p._factory && p._factory.create) {
+                // reject after 100 ms to not block CPU completely
+                p._factory.create = () =>
+                  new Promise((resolve, reject) => setTimeout(() => reject(INVALID_CREDENTIALS_ERROR), 100))
+              }
+              await p.drain()
+              await p.clear()
+            }
           })
-      }).then(p => {
-        pools.set(tenant, p)
-        return p
-      })
-    )
+
+          resolve(p)
+        })
+        .catch(e => {
+          // delete pools entry if fetching credentials failed
+          pools.delete(tenant)
+          reject(e)
+        })
+    })
+
+    pools.set(tenant, poolPromise)
   }
 
   if ('then' in pools.get(tenant)) {
@@ -150,9 +145,10 @@ async function pool4(tenant, db) {
 async function resilientAcquire(pool, attempts = 1) {
   // max 3 attempts
   attempts = Math.min(attempts, 3)
-  let client
-  let err
-  let attempt = 0
+  let client,
+    err,
+    attempt = 0
+
   while (!client && attempt < attempts) {
     try {
       client = await pool.acquire()

package/libx/odata/afterburner.js

@@ -28,8 +28,8 @@ const _addKeysDeep = (keys, keysCollector, ignoreManagedBacklinks) => {
 }
 
 function _keysOf(entity, ignoreManagedBacklinks) {
-  if (!entity || !entity.keys) return
   const keysCollector = []
+  if (!entity || !entity.keys) return keysCollector
   _addKeysDeep(entity.keys, keysCollector, ignoreManagedBacklinks)
   return keysCollector
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds",
-  "version": "7.1.1",
+  "version": "7.1.2",
   "description": "SAP Cloud Application Programming Model - CDS for Node.js",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [