@sap/cds 5.4.3 → 5.5.0

package/libx/_runtime/messaging/enterprise-messaging.js

@@ -18,11 +18,11 @@ const BASE_PATH = '/messaging/enterprise-messaging'
 const _checkAppURL = appURL => {
   if (!appURL)
     throw new Error(
-      'Enterprise Messaging: You need to provide an HTTPS endpoint to your application.\n\nHint: You can set the application URI in environment variable `VCAP_APPLICATION.application_uris[0]`. This is needed because incoming messages are delivered through HTTP via webhooks.\nExample: `{ ..., "VCAP_APPLICATION": { "application_uris": ["my-app.com"] } }`\nIn case you want to use Enterprise Messaging in shared (that means single-tenant) mode, you can use kind `enterprise-messaging-shared`.'
+      'Enterprise Messaging: You need to provide an HTTPS endpoint to your application.\n\nHint: You can set the application URI in environment variable `VCAP_APPLICATION.application_uris[0]`. This is needed because incoming messages are delivered through HTTP via webhooks.\nExample: `{ ..., "VCAP_APPLICATION": { "application_uris": ["my-app.com"] } }`\nIn case you want to use Enterprise Messaging in shared (that means single-tenant) mode, you can use kind `enterprise-messaging-amqp`.'
     )
   if (appURL.startsWith('https://localhost'))
     throw new Error(
-      'The endpoint of your application is local and cannot be reached from Enterprise Messaging.\n\nHint: For local development you can set up a tunnel to your local endpoint and enter its public https endpoint in `VCAP_APPLICATION.application_uris[0]`.\nIn case you want to use Enterprise Messaging in shared (that means single-tenant) mode, you can use kind `enterprise-messaging-shared`.'
+      'The endpoint of your application is local and cannot be reached from Enterprise Messaging.\n\nHint: For local development you can set up a tunnel to your local endpoint and enter its public https endpoint in `VCAP_APPLICATION.application_uris[0]`.\nIn case you want to use Enterprise Messaging in shared (that means single-tenant) mode, you can use kind `enterprise-messaging-amqp`.'
     )
 }
 
@@ -78,8 +78,10 @@ class EnterpriseMessaging extends AMQPWebhookMessaging {
   }
 
   startListening() {
-    super.startListening()
-    if (this.subscribedTopics.size) {
+    const doNotDeploy = cds._mtxEnabled && !this.options.deployForProvider
+    if (doNotDeploy) LOG._info && LOG.info('Skipping deployment of messaging artifacts for provider account')
+    super.startListening({ doNotDeploy })
+    if (!doNotDeploy && this.subscribedTopics.size) {
       const management = this.getManagement()
       // Webhooks will perform an OPTIONS call on creation to check the availability of the app.
       // On systems like Cloud Foundry the app URL will only be advertised once

package/libx/_runtime/messaging/service.js

@@ -62,7 +62,7 @@ class MessagingService extends cds.Service {
       const { emit } = this
       this.emit = function (...args) {
         const context = this.context || cds.context
-        if (context)
+        if (context && typeof context.on === 'function')
           return context.on('succeeded', () =>
             emit.call(this, ...args).catch(e => {
               LOG._error && LOG.error(e)
@@ -95,8 +95,8 @@ class MessagingService extends cds.Service {
   }
 
   prepareTopic(topic, _inbound) {
-    // In local-messaging there's a 'short curcuit' so we must not modify the topic
-    if (this.options.kind === 'local-messaging') return topic
+    // In local messaging there's a 'short curcuit' so we must not modify the topic
+    if (this.options.local) return topic
     let res = topic
     if (!_inbound && this.options.publishPrefix) res = this.options.publishPrefix + res
     if (_inbound && this.options.subscribePrefix) res = this.options.subscribePrefix + res
@@ -123,10 +123,11 @@ class MessagingService extends cds.Service {
       this.prepareHeaders(msg.headers, msg.event)
       msg.event = this.prepareTopic(msg.event, false)
     } else if (this.subscribedTopics) {
-      msg.event =
+      const subscribedEvent =
         this.subscribedTopics.get(msg.event) ||
-        (this.wildcarded && this.subscribedTopics.get(this.wildcarded(msg.event))) ||
-        msg.event
+        (this.wildcarded && this.subscribedTopics.get(this.wildcarded(msg.event)))
+      if (!subscribedEvent) throw new Error(`No handler for incoming message with topic '${msg.event}' found.`)
+      msg.event = subscribedEvent
     }
     return msg
   }

package/libx/_runtime/odata/cqn2odata.js

@@ -18,7 +18,9 @@ const getSafeNumber = str => {
 const needArrayProps = Object.fromEntries(
   ['where', 'search', 'xpr', 'columns', 'expand', 'orderBy', 'ref', 'args'].map(propName => [
     propName,
-    cur => Array.isArray(cur) && (cur.length !== 0 || propName === 'expand' || propName === 'ref')
+    cur =>
+      (Array.isArray(cur) && (cur.length !== 0 || propName === 'expand' || propName === 'ref')) ||
+      (propName === 'expand' && cur === '*')
   ])
 )
 
@@ -111,6 +113,7 @@ function getProp(obj, propName) {
   if (isValid) {
     return obj[propName]
   }
+
   throw new Error(`Invalid property '${propName}' provided`)
 }
 
@@ -118,10 +121,12 @@ function hasValidProps(obj, ...names) {
   for (const propName of names) {
     const validate = validators[propName]
     const isValid = validate && validate(obj[propName])
+
     if (!isValid) {
       return false
     }
   }
+
   return true
 }
 
@@ -133,16 +138,20 @@ function _args(args) {
       res.push(cur)
       continue
     }
+
     if (hasValidProps(cur, 'func', 'args')) {
       res.push(`${cur.func}(${_args(cur.args)})`)
     }
+
     if (hasValidProps(cur, 'ref')) {
       res.push(cur.ref.join('/'))
     }
+
     if (hasValidProps(cur, 'val')) {
       res.push(formatVal(cur.val))
     }
   }
+
   return res.join(',')
 }
 
@@ -169,17 +178,20 @@ const _format = (cur, element, target, kind, isLambda) => {
 const _isLambda = (cur, next) => {
   if (cur !== 'exists') return
   const last = Array.isArray(next.ref) && next.ref.slice(-1)[0]
-  return last && hasValidProps(last, 'id') && Object.prototype.hasOwnProperty.call(last, 'where')
+  return last && hasValidProps(last, 'id')
 }
 
 function _xpr(expr, target, kind, isLambda) {
   const res = []
   const openBrackets = []
+
   for (let i = 0; i < expr.length; i++) {
     const cur = expr[i]
+
     if (typeof cur === 'string') {
       // REVISIT: will it be fixed with a new odata2cqn and follow-ups?
       const isOrIsNotValue = cur.match(/^is\s(not)?\s*(.+)$/)
+
       if (cur === '(') {
         openBrackets.push(res.length)
         continue
@@ -221,6 +233,7 @@ function _xpr(expr, target, kind, isLambda) {
       if (formatted !== undefined) res.push(formatted)
     }
   }
+
   return res.join(' ')
 }
 
@@ -229,7 +242,6 @@ const _keysOfWhere = (where, kind, target) => {
 
   if (kind === 'rest') {
     const keys = where.length === 1 ? getProp(where[0], 'val') : getProp(where[2], 'val')
-
     return `/${keys}`
   }
 
@@ -247,6 +259,7 @@ const _keysOfWhere = (where, kind, target) => {
       res.push(cur)
     }
   }
+
   return `(${res.join('')})`
 }
 
@@ -274,6 +287,7 @@ function _from(from, kind, model) {
 
   const path = []
   let queryTarget
+
   for (const curRef of ref) {
     if (hasValidProps(curRef, 'where', 'id')) {
       const { where, id } = curRef
@@ -285,6 +299,7 @@ function _from(from, kind, model) {
       path.push(curRef)
     }
   }
+
   return { url: _entityUrl(path.join('/')), queryTarget }
 }
 
@@ -292,62 +307,83 @@ const _parseColumnsV2 = (columns, prefix = []) => {
   const select = []
   const expand = []
 
-  for (const col of columns) {
-    if (hasValidProps(col, 'ref')) {
-      const ref = [...prefix, ...col.ref].join('/')
-      if (hasValidProps(col, 'expand')) {
-        const parsed = _parseColumnsV2(col.expand, [ref])
-        expand.push(ref, ...parsed.expand)
+  for (const column of columns) {
+    if (hasValidProps(column, 'ref')) {
+      const refName = [...prefix, ...column.ref].join('/')
+
+      if (hasValidProps(column, 'expand')) {
+        const parsed = _parseColumnsV2(column.expand, [refName])
+        expand.push(refName, ...parsed.expand)
         select.push(...parsed.select)
       } else {
-        select.push(ref)
+        select.push(refName)
       }
     }
-    if (col === '*') {
+
+    if (column === '*') {
       select.push(`${prefix.join('/')}/*`)
     }
   }
+
   return { select, expand }
 }
 
-const _parseColumns = columns => {
+const _parseColumns = (columns, options) => {
+  const isExpand = options.expand
   const select = []
   const expand = []
 
-  for (const col of columns) {
-    if (hasValidProps(col, 'ref')) {
-      let ref = col.ref.join('/')
-      if (hasValidProps(col, 'expand')) {
-        const curOptions = getOptions(col).join(';')
-        ref += curOptions ? `(${curOptions})` : ''
-        expand.push(ref)
+  if (columns === '*') {
+    return { select, expand }
+  }
+
+  const isSelectAll = select =>
+    select.length === 1 && (select[0] === '*' || (select[0].ref && select[0].ref[0] === '*'))
+
+  for (const column of columns) {
+    if (hasValidProps(column, 'ref')) {
+      const refName = column.ref.join('/')
+      let refNameWithOptions = refName
+
+      if (hasValidProps(column, 'expand')) {
+        const curOptions = getOptions(column).join(';')
+        refNameWithOptions += curOptions ? `(${curOptions})` : ''
+        expand.push(refNameWithOptions)
+        if (!isSelectAll(select) && !isExpand) select.push(refName)
         // REVISIT: expand to one & limit in options
-        // > const expanded = $expand(col.expand)
-        // > expand.push(expanded ? `${ref}(${expanded})` : ref)
+        // > const expanded = $expand(column.expand)
+        // > expand.push(expanded ? `${refNameWithOptions}(${expanded})` : ref)
         // see xtest('READ with expand'... in custom handler test
       } else {
-        select.push(ref)
+        select.push(refNameWithOptions)
       }
     }
-    if (col === '*') {
-      select.push('*')
+
+    if (column === '*') {
+      select.push(column)
     }
   }
-  // omit '$select' option if contains only '*'
-  if (select.length === 1 && (select[0] === '*' || (select[0].ref && select[0].ref[0] === '*'))) {
+
+  // omit $select query option if it only contains '*'
+  if (isSelectAll(select)) {
     select.pop()
   }
-  return { select, expand }
+
+  const uniqueSelect = [...new Set(select)]
+  return { select: uniqueSelect, expand }
 }
 
-function $select(columns, kind, separator = '&') {
-  const { select, expand } = kind === 'odata-v2' ? _parseColumnsV2(columns) : _parseColumns(columns)
+function $select(columns, kind, separator = '&', isExpand = false) {
+  const { select, expand } =
+    kind === 'odata-v2' ? _parseColumnsV2(columns) : _parseColumns(columns, { expand: isExpand })
+
   const res = []
   if (expand.length) res.unshift('$expand=' + expand.join(','))
   if (select.length) res.unshift('$select=' + select.join(','))
   return res.join(separator)
 }
-const $expand = columns => $select(columns, 'odata', ';')
+
+const $expand = columns => $select(columns, 'odata', ';', true)
 
 function $count(count, kind) {
   if (count !== true) return ''
@@ -357,26 +393,32 @@ function $count(count, kind) {
 
 function $limit(limit) {
   const res = []
+
   if (hasValidProps(limit, 'rows')) {
     res.push('$top=' + getProp(limit.rows, 'val'))
   }
+
   if (hasValidProps(limit, 'offset')) {
     res.push('$skip=' + getProp(limit.offset, 'val'))
   }
+
   return res
 }
 
 function $orderBy(orderBy) {
   const res = []
+
   for (const cur of orderBy) {
     if (hasValidProps(cur, 'ref', 'sort')) {
       res.push(cur.ref.join('/') + ' ' + cur.sort)
       continue
     }
+
     if (hasValidProps(cur, 'ref')) {
       res.push(cur.ref.join('/'))
     }
   }
+
   return '$orderby=' + res.join(',')
 }
 
@@ -388,17 +430,21 @@ function parseSearch(search) {
       // search term must not be formatted
       res.push('(', ...parseSearch(cur.xpr), ')')
     }
+
     if (hasValidProps(cur, 'val')) {
       // search term must not be formatted
       res.push(`"${cur.val}"`)
     }
+
     if (typeof cur === 'string') {
       const upperCur = cur.toUpperCase()
+
       if (upperCur === 'OR' || upperCur === 'AND' || upperCur === 'NOT') {
         res.push(upperCur)
       }
     }
   }
+
   return res
 }
 
@@ -428,33 +474,48 @@ function $one(one, url, kind) {
 const _isOdataUrlWithKeys = (url, kind) => kind !== 'rest' && /^[\w\.]+\(.*\)/.test(url)
 
 const parsers = {
-  columns: (cqnPart, url, kind) => $select(cqnPart, kind),
-  expand: (cqnPart, url, kind) => $expand(cqnPart),
-  where: (cqnPart, url, kind, target) => $where(cqnPart, target, kind),
-  search: (cqnPart, url, kind) => $search(cqnPart, kind),
-  orderBy: cqnPart => $orderBy(cqnPart),
-  count: (cqnPart, url, kind) => $count(cqnPart, kind),
-  limit: cqnPart => $limit(cqnPart),
-  one: (cqnPart, url, kind) => $one(cqnPart, url, kind)
+  columns: (cqnPart, url, kind, target, isCount) => !isCount && $select(cqnPart, kind),
+  expand: (cqnPart, url, kind, target, isCount) => !isCount && $expand(cqnPart),
+  where: (cqnPart, url, kind, target, isCount) => $where(cqnPart, target, kind),
+  search: (cqnPart, url, kind, target, isCount) => $search(cqnPart, kind),
+  orderBy: (cqnPart, url, kind, target, isCount) => !isCount && $orderBy(cqnPart),
+  count: (cqnPart, url, kind, target, isCount) => !isCount && $count(cqnPart, kind),
+  limit: (cqnPart, url, kind, target, isCount) => !isCount && $limit(cqnPart),
+  one: (cqnPart, url, kind, target, isCount) => !isCount && $one(cqnPart, url, kind)
 }
 
-function getOptions(cqnPart, url, kind, target) {
+function getOptions(cqnPart, url, kind, target, isCount) {
   const options = []
+
   for (const opt in cqnPart) {
-    if (cqnPart[opt] === undefined) continue
+    const cqnPartOpt = cqnPart[opt]
+    if (cqnPartOpt === undefined) continue
     if (!hasValidProps(cqnPart, opt)) throw new Error(`Feature not supported: SELECT statement with .${opt}`)
-    const parsed = parsers[opt] && parsers[opt](cqnPart[opt], url, kind, target)
+    const parser = parsers[opt]
+    const parsed = parser && parser(cqnPartOpt, url, kind, target, isCount)
     const parsedOpts = (Array.isArray(parsed) && parsed) || (parsed && [parsed]) || []
     options.push(...parsedOpts)
   }
+
   return options
 }
 
+const _isCount = SELECT => {
+  if (SELECT.columns) {
+    const columns = getProp(SELECT, 'columns')
+    return columns.some(
+      c => c.func === 'count' && c.as === '$count' && c.args && c.args.length === 1 && c.args[0] === '*'
+    )
+  }
+  return false
+}
+
 const _select = (cqn, kind, model) => {
   const SELECT = getProp(cqn, 'SELECT')
   const { url, queryTarget } = _from(getProp(SELECT, 'from'), kind, model)
-  const queryOptions = getOptions(SELECT, url, kind, queryTarget).join('&')
-  const path = queryOptions ? `${url}?${queryOptions}` : `${url}`
+  const isCount = _isCount(SELECT)
+  const queryOptions = getOptions(SELECT, url, kind, queryTarget, isCount).join('&')
+  const path = `${url}${isCount ? '/$count' : ''}${queryOptions ? `?${queryOptions}` : ''}`
   return { method: 'GET', path }
 }
 
@@ -474,6 +535,7 @@ const _copyData = data => {
         ? data[property].val
         : data[property]
   }
+
   return copied
 }
 
@@ -481,12 +543,14 @@ const _update = (cqn, kind, model) => {
   const UPDATE = getProp(cqn, 'UPDATE')
   const { url, queryTarget } = _from(getProp(UPDATE, 'entity'), kind, model)
   let keys = ''
+
   if (UPDATE.where) {
     if (_isOdataUrlWithKeys(url, kind)) {
       throw new Error('Cannot generate URL for UPDATE CQN. Conflicting .from and .where')
     }
     keys = _keysOfWhere(getProp(UPDATE, 'where'), kind, queryTarget)
   }
+
   // TODO: support for .set as well
   const body = _copyData(UPDATE.data)
   return { method: 'PATCH', path: `${url}${keys}`, body }
@@ -496,12 +560,15 @@ const _delete = (cqn, kind, model) => {
   const DELETE = getProp(cqn, 'DELETE')
   const { url, queryTarget } = _from(getProp(DELETE, 'from'), kind, model)
   let keys = ''
+
   if (DELETE.where) {
     if (_isOdataUrlWithKeys(url, kind)) {
       throw new Error('Cannot generate URL for DELETE CQN. Conflicting .from and .where')
     }
+
     keys = _keysOfWhere(getProp(DELETE, 'where'), kind, queryTarget)
   }
+
   return { method: 'DELETE', path: `${url}${keys}` }
 }
 

package/libx/_runtime/odata/index.js

@@ -1,40 +1,4 @@
-const cds = require('../cds')
-const LOG = cds.log('odata')
-
-const fs = require('fs')
-const path = require('path')
-const odataPegGrammarPath = path.join(__dirname, '../../../.internal/odata2cqn/odata2cqn.pegjs')
-let odataParser, peg
-
-const _pegjsExists = () => {
-  try {
-    peg = require('pegjs')
-    return true
-  } catch (e) {
-    return false
-  }
-}
-
-// generate parser if grammar and pegjs are available
-if (fs.existsSync(odataPegGrammarPath) && _pegjsExists() && !process.env.TRAVIS_PULL_REQUEST) {
-  const odataPegGrammar = fs.readFileSync(odataPegGrammarPath, { encoding: 'utf8' })
-
-  // generate parser object
-  odataParser = peg.generate(odataPegGrammar)
-
-  // generate parser string and asynchronously write to file
-  const parserString = peg.generate(odataPegGrammar, { output: 'source', format: 'commonjs' })
-  fs.writeFile(path.join(__dirname, 'odata2cqn.js'), parserString, err => {
-    if (err && LOG._warn) {
-      err.message = 'Unable to store generated odata2cqn grammar: ' + err.message
-      LOG.warn(err)
-    }
-  })
-} else {
-  odataParser = require('./odata2cqn')
-}
-
-const { cqn2odata, getSafeNumber } = require('./cqn2odata')
+const { cqn2odata, getSafeNumber: safeNumber } = require('./cqn2odata')
 
 const strict = {
   functions: {
@@ -59,19 +23,33 @@ const strict = {
   }
 }
 
-const odata = (module.exports = {
+let parser = require('./odata2cqn')
+const odata = {
   parse: {
-    url: (url, o) => {
-      const options = { safeNumber: getSafeNumber }
-      if (o === 'strict' || (o && o.strict)) options.strict = strict
-      return odataParser.parse(decodeURIComponent(url), options)
-    },
-    cqn: (cqn, kind, model) => {
-      return cqn2odata(cqn, kind, model)
+    url(url, o = {}) {
+      o = o === 'strict' ? { strict } : o.strict ? { ...o, strict } : o
+
+      const uri = decodeURIComponent(url)
+      let parsed = parser.parse(uri, { ...o, safeNumber })
+
+      if (typeof o.afterburner === 'function') parsed = o.afterburner(parsed)
+      return parsed
     }
   },
+
+  urlify: cqn2odata,
+
   to: {
-    cqn: (url, o) => odata.parse.url(url, o),
-    url: (cqn, kind, model) => odata.parse.cqn(cqn, kind, model)
+    cqn: (url, o) => odata.parse(url, o),
+    url: (cqn, kind, model) => odata.urlify(cqn, kind, model)
+  },
+
+  genParser() {
+    const source = __filename.replace('index.js', 'odata2cqn.pegjs')
+    const grammar = require('fs').readFileSync(source, 'utf8')
+    parser = require('pegjs').generate(grammar)
+    return parser
   }
-})
+}
+
+module.exports = odata