@sap/cds 6.0.2 → 6.1.0

package/libx/odata/grammar.pegjs

@@ -27,6 +27,7 @@
 //
 // ---------- JavaScript Helpers -------------
   {
+
     const $ = Object.assign
     const { strict, minimal } = options
     const stack = []
@@ -243,7 +244,7 @@
 
   ODataRelativeURI // Note: case-sensitive!
     = '/'? (p:path { SELECT = p })
-    ( o"?"o QueryOption ( o'&'o QueryOption )* )? o "?"? o {
+    ( o"?"o (QueryOption ( o'&'o QueryOption )*)? )? o {
       if (count) {
         // columns set because of $count: ignore $select, $expand, $top, $skip, $orderby
         // REVISIT: don't ignore query options but throw bad request (as okra did)?
@@ -334,46 +335,39 @@
   QueryOption = option:ExpandOption { if(option && option.apply) SELECT.apply = option.apply} /
     "$skiptoken="   o skiptoken /
     format /
-    custom
+    custom /
+    aliasedParamEqualsVal
   // @OData spec for $expand:
   // "Allowed system query options are $filter, $select, $orderby, $skip, $top, $count, $search, $expand and $apply (http://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/cs02/odata-data-aggregation-ext-v4.0-cs02.html#_The_expand_Transformation)."
   ExpandOption =
     "$select="      o select ( COMMA select )* /
-    "$expand="      o expand ( COMMA expand )* /
-    "$filter="      o f:filter{SELECT.where = f} /
+    "$expand="      o expand ( COMMA expand )* expandCount? /
+    "$filter="      o f:filter { SELECT.where = f } /
     "$orderby="     o o:orderby ( COMMA o2:orderby{_setOrderBy(o2)} )* {_setOrderBy(o,true)} /
-    "$top="         o val:top{(SELECT.limit || (SELECT.limit={})).rows = {val}} /
-    "$skip="        o val:skip{_setLimitOffset(val)} /
-    "$search="      o s:search {if (s) SELECT.search = s} /
+    "$top="         o val:top { (SELECT.limit || (SELECT.limit={})).rows = {val} } /
+    "$skip="        o val:skip { _setLimitOffset(val) } /
+    "$search="      o s:search { if (s) SELECT.search = s } /
     "$count="       o count /
-    "$apply="       o trafos:transformations {return trafos}
+    "$apply="       o trafos:transformations { return trafos }
 
 
   select
-    = col:('*'/ref) {
+    = col:('*' / ref) {
       SELECT.columns = Array.isArray(SELECT.columns) ? SELECT.columns : []
       if (!SELECT.columns.find(_compareRefs(col))) SELECT.columns.push(col)
       return col
     }
 
-//REVISIT: per OData spec $apply should be also supported inside of $expand
-  expand =
-    (
-      c:('*'/ref) {
-        const col = c === '*' ? {} : c
-        col.expand = '*'
-        if (!Array.isArray(SELECT.expand)) SELECT.expand = []
-        if (!SELECT.expand.find(_compareRefs(col))) SELECT.expand.push(col)
-        return col
-      }
-    )
-    ( // --- nested query options, if any
-      (OPEN {
-        stack.push (SELECT)
-        SELECT = SELECT.expand[SELECT.expand.length-1]
-        SELECT.expand = '*' // by default expand everything
-      })(
-      expandOptions:( o ";"? o option:ExpandOption{return option})*
+  expandCount 
+    = "/$count" {
+      const err = new Error("EXPAND_COUNT_UNSUPPORTED");
+      err.statusCode=501;
+      throw err;
+    }
+
+  expandQueryOptions
+   = (
+      expandOptions:(option:ExpandOption o ";"? { return option })*
       {
       	if (expandOptions.find(option => option && option.apply !== undefined)) {
         	const err = new Error("EXPAND_APPLY_UNSUPPORTED");
@@ -390,29 +384,50 @@
           if (Array.isArray(SELECT.expand) && SELECT.expand.indexOf('*') === -1) SELECT.expand.unshift('*')
         }
       }
-      )(CLOSE {
+      )
+
+  expandQueryOption
+   = (OPEN {
+        stack.push (SELECT)
+        SELECT = SELECT.expand[SELECT.expand.length-1]
+        SELECT.expand = '*' // by default expand everything
+      }) 
+      expandQueryOptions? 
+      (CLOSE {
         SELECT = stack.pop()
       })
-    )? // --- end of nested query options
-    ( COMMA expand )?
-    ("/$count" {
-      const err = new Error("EXPAND_COUNT_UNSUPPORTED");
-      err.statusCode=501;
-      throw err;
-    })?
+    
+
+//REVISIT: per OData spec $apply should be also supported inside of $expand
+  expand
+  = (
+      c:('*' / ref) {
+        const col = c === '*' ? {} : c
+        col.expand = '*'
+        if (!Array.isArray(SELECT.expand)) SELECT.expand = []
+        if (!SELECT.expand.find(_compareRefs(col))) SELECT.expand.push(col)
+        return col
+      }
+    )
+    expandQueryOption?
+
   top
-    = val:integer {return val}
+    = val:integer { return val }
+
   skiptoken
     = val:integer? skiptoken:skiptokenChars? {
       // REVISIT ignore non-numeric $skiptoken as not supported by CQN
       if (skiptoken) return
       _setLimitOffset(val)
     }
+
   skip
-    = val:integer {return val}
+    = val:integer { return val }
+
   search
     = p:search_clause {return p}
       / o // Do not add search property for space only
+
   search_clause
     = p:( n:NOT? {return n?[n]:[]} )(
       OPEN xpr:search_clause CLOSE {p.push({xpr})}
@@ -422,9 +437,11 @@
           val:word {p.push({val})}
         )
     )( ao:(AND/OR/AND_SPACE) more:search_clause {p.push(ao,...more)} )*
-    {return p}
+    { return p }
+
   filter
     = p:where_clause { return p }
+
   where_clause = p:( n:NOT? {return n?[n]:[]} )(
       OPEN xpr:where_clause CLOSE {p.push({xpr})}
       / comp:comparison {p.push(...comp)}
@@ -437,8 +454,10 @@
       }
       / func:boolish {p.push(func)}
       / val:bool {p.push({val})}
+      / list:listFilter {p.push(...list)}
     )( ao:(AND/OR) more:where_clause {p.push(ao,...more)} )*
-    {return p}
+    { return p }
+
   lambda =
     nav:( n:identifier {return[n]} ) '/' ( n:identifier '/' {nav.push(n)} )*
     xpr:(
@@ -467,28 +486,48 @@
       }
     )
     { return xpr }
+
   inner_lambda =
     p:( n:NOT? { return n ? [n] : [] } )(
       OPEN xpr:inner_lambda CLOSE { p.push('(', ...xpr, ')') }
       / comp:comparison { p.push(...comp) }
       / func:function { p.push(func) }
       / lambda:lambda { p.push(...lambda)}
+      / list:listFilter {p.push(...list)}
     )
     ( ao:(AND/OR) more:inner_lambda { p.push(ao, ...more) } )*
     { return p }
-  lambda_clause = prefix:identifier ":" inner:inner_lambda {
-    return _removeLambdaPrefix(prefix, inner)
-  }
-  any = "any" OPEN p:lambda_clause? CLOSE { return p }
-  all = "all" OPEN p:lambda_clause CLOSE { return p }
+
+  lambda_clause =
+    prefix:identifier ":" inner:inner_lambda {
+      return _removeLambdaPrefix(prefix, inner)
+    }
+
+  any =
+   "any" OPEN p:lambda_clause? CLOSE { return p }
+
+  all =
+   "all" OPEN p:lambda_clause CLOSE { return p }
+
   orderby
-    = ref:(lambda{const err = new Error("ORDERBY_LAMBDA_UNSUPPORTED");err.statusCode=501;throw err;}/function/ref) sort:( _ s:$("asc"/"desc") {return s})? {
+    = ref:(
+        lambda {
+          const err = new Error("ORDERBY_LAMBDA_UNSUPPORTED");
+          err.statusCode=501;
+          throw err;
+        } /
+        function /
+        ref
+      ) 
+      sort:( _ s:$("asc" / "desc") { return s })? {
         // TODO: Lambda support
         const appendObj = $(ref, sort && {sort});
         return appendObj;
     }
+
   count
     = val:bool { if(val) SELECT.count = true }
+
   transformations
     = mainTransformation:trafo additionalTransformation:("/" t2:trafo {
       return t2
@@ -520,7 +559,12 @@
       }
       return {apply: mainTransformation}
     }
-  custom = [a-zA-Z] [a-zA-Z0-9-]* "=" [^&]*
+
+  custom
+    = [a-zA-Z0-9-_.~]+ "=" [^&]*
+  aliasedParam "an aliased parameter (@param)" = "@" i:identifier { return "@" + i }
+  aliasedParamEqualsVal "@alias=value" = a:aliasedParam "=" v:([^&]*) {return a + "=" + v} 
+
   format = "$format=" f:$([^&]*) {
     if (f.toLowerCase() !== "json") {
       const err = new Error("ONLY_QUERY_PARAM_FORMAT_JSON_ALLOWED")
@@ -528,17 +572,25 @@
       throw err;
     }
   }
+
 //
 // ---------- Expressions ------------
-  comparison "a comparison"
-    = a:operand _ o:$("eq"/"ne"/"lt"/"gt"/"le"/"ge") _ b:operand {
-      const op = { eq:'=', ne:'!=', lt:'<', gt:'>', le:'<=', ge:'>=' }[o]||o
+  comparison
+    = a:operand _ o:$("eq" / "ne" / "lt" / "gt" / "le" / "ge") _ b:operand {
+      const op = { eq:'=', ne:'!=', lt:'<', gt:'>', le:'<=', ge:'>=' }[o] || o
       return [ a, op, b ]
     }
+
+  listFilter
+    = a:operand _ "in" _ b:listRoundBrackets {
+      return [ a, "in", b ]
+    }
   mathCalc
     = operand (_ ("add" / "sub" / "mul" / "div" / "mod") _ operand)*
-  operand "an operand"
+  
+  operand
     = navigationCount / function / val / ref / jsonObject / jsonArray / list
+  
   navigationCount "navigation with $count"
   = navigationPath:(head:identifier key:(OPEN keyArgs:args CLOSE {return keyArgs;})? '/' {
     if (key) {
@@ -548,6 +600,7 @@
     return head;
   })+ count: '$count'
     { return {func: 'count', as: '$count', args: [{ref: navigationPath}]} }
+  
   ref "a reference"
     = head:identifier tail:( '/' n:identifier {return n})*
     {
@@ -556,34 +609,56 @@
       }
       return { ref:[ head, ...tail ] }
     }
+
   val
     = val:(bool / date) {return {val}}
     / val:guid {return {val}}
     / val:number {return typeof val === 'number' ? {val} : { val, literal:'number' }}
     / val:string {return {val}}
     / val:binary {return {val}}
-  jsonObject = val:$("{" (jsonObject / [^}])* "}") {return {val}}
-  jsonArray = val:$("[" o "]" / "[" o "{" (jsonArray / [^\]])* "]") {return {val}}
-
-  list
+    / val:aliasedParam {return {val}}
+    / null
+
+  null "null" =  "null" {return {val: null }}
+  
+  jsonObject "a json object"
+    = val:$("{" (jsonObject / [^}])* "}") {return {val}}
+  
+  jsonArray "a json array"
+    = val:$("[" o "]" / "[" o "{" (jsonArray / [^\]])* "]") {return {val}}
+
+  list "a list"
     = "[" any:$([^\]])* "]" // > needs improvment
     { return { list: any.replace(/"/g,'').split(',').map(ele => ({ val: ele })) } }
 
-  function "a function call"
-    = func:$[a-zA-Z]+ OPEN a:operand more:( COMMA o:operand {return o} )* CLOSE {
+  listRoundBrackets "a list"
+    = OPEN list:(val1:val val2:("," v:val { return v })* { return [val1, ...val2] }) CLOSE // > needs improvment
+    { 
+      return { list }
+    }
+
+  
+  functionName "a function name"
+  = $[a-zA-Z]+
+
+  function 
+    = func:functionName OPEN fnArgs:functionArgs CLOSE {
       if (strict && !(func.toLowerCase() in strict.functions)) {
         throw Object.assign(new Error(`"${func}" is an unknown function in OData URL spec (strict mode)`), { statusCode: 400 })
       }
-      return { func: func.toLowerCase(), args:[a,...more] }
+      return { func: func.toLowerCase(), args:[fnArgs.a,...fnArgs.more] }
     }
 
-  boolish "a boolean function"
+  functionArgs
+    = a:operand more:( COMMA o:operand {return o} )* {return { a, more }}
+
+  boolish
     = func:("contains"i/"endswith"i/"startswith"i) OPEN a:operand COMMA b:operand CLOSE
     { return { func: func.toLowerCase(), args:[a,b] }}
 
   NOT = o "NOT"i _ {return 'not'}
   AND = _ "AND"i _ {return 'and'}
-  AND_SPACE =   _ {return 'and'}
+  AND_SPACE =    _ {return 'and'}
   OR  = _  "OR"i _ {return 'or'}
 
 
@@ -619,7 +694,7 @@
         }        
         return {aggregate: [{ func, args }]}
       } /
-      identity: identityTrafo{return identity}
+      identity: identityTrafo {return identity}
       // customFunction
     )
 
@@ -660,7 +735,11 @@
   groupByElem
     = c:(rollupSpec / ref) { return c }
   rollupSpec // TODO fix this + add CAP support
-    = rollup:("rollup" OPEN o ('$all' / ref) (o COMMA ref)+ o CLOSE) {const err = new Error("Rollup in groupby is not supported yet.");err.statusCode=501;throw err;}
+    = rollup:("rollup" OPEN o ('$all' / ref) (o COMMA ref)+ o CLOSE) {
+        const err = new Error("Rollup in groupby is not supported yet.");
+        err.statusCode=501;
+        throw err;
+      }
 
   filterTrafo = OPEN o where:(where:filter{
     return where
@@ -704,20 +783,21 @@
 //
 // ---------- Literals -----------
 
-  bool = b:("true" / "false") { return b === 'true'}
+  bool "a boolean"
+    = b:("true" / "false") { return b === 'true'}
 
-  string "Edm.String"
-    = "'" s:$("''"/[^'])* "'"
+  string "a single quoted string" // "Edm.String"
+    = "'" s:$("''" / [^'])* "'" // 'A user''s story'
     {return s.replace(/''/g,"'")}
 
-  doubleQuotedString
+  doubleQuotedString "a doubled quoted string"
     = '"' s:$('\\"'/[^"])* '"'
     {return s.replace(/\\\\/g,"\\").replace(/\\"/g,'"')}
 
-  word
+  word "a string"
     = $([^ \t\n()"&;]+)
 
-  date
+  date "a date"
     = s:$( [0-9]+"-"[0-9][0-9]"-"[0-9][0-9] // date
       ( "T"[0-9][0-9]":"[0-9][0-9](":"[0-9][0-9]("."[0-9]+)?)? // time
       ( "Z" / (("+" / "-")[0-9][0-9]":"[0-9][0-9]) )? // timezone (Z or +-hh:mm)
@@ -727,19 +807,23 @@
       return s
     }
 
-  number
-    = s:$( [+-]? [0-9]+ ("."[0-9]+)? ("e"[0-9]+)? ) { return safeNumber(s) }
+  // to avoid 123-123-123 being matched as number and showing error for "-123-123"
+  endsWithMinus
+    = [0-9]+ "-"
+
+  number "a number"
+    = !endsWithMinus s:$( [+-]? [0-9]+ ("."[0-9]+)? ("e"[0-9]+)? ) { return safeNumber(s) }
 
-  integer
+  integer "an integer"
     = s:$( [+-]? [0-9]+ ) { return parseInt(s) }
 
-  identifier
+  identifier "an identifier"
     = !bool !guid s:$([_a-zA-Z][_a-zA-Z0-9"."]*) { return s }
 
-  guid
+  guid "a guid"
     = $( hex16 hex16 "-"? hex16 "-"? hex16 "-"? hex16 "-"? hex16 hex16 hex16 )
 
-  hex16
+  hex16 "a hex value"
     = $( [0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F] )
 
   segment // > everything except / and ?
@@ -748,7 +832,7 @@
   skiptokenChars
     = $( [a-zA-Z0-9-"."_~!$'()*+,;=:@"/""?"]+ )
 
-  binary // > url-safe base64
+  binary "a binary" // > url-safe base64
     = "binary'" s:$([a-zA-Z0-9-_]+ ("=="/"=")?) "'" { return standardBase64(s) }
 
 //
@@ -763,8 +847,8 @@
 //
 // ---------- Whitespaces -----------
 
-  o "optional whitespaces" = $[ \t\n]*
-  _ "mandatory whitespaces" = $[ \t\n]+
+  o "an optional whitespace" = $[ \t\n]*
+  _ "a whitespace" = $[ \t\n]+
 
 //
-// ------------------------------------
+// ------------------------------------

package/libx/odata/index.js

@@ -74,12 +74,18 @@ module.exports = {
     try {
       cqn = odata2cqn(url, options)
     } catch (err) {
-      if (err.message === 'EXPAND_COUNT_UNSUPPORTED' || err.message === 'ORDERBY_LAMBDA_UNSUPPORTED') {
-        throw getError(err.statusCode || 400, err.message)
+      if (err.statusCode === 501) {
+        throw getError(err.statusCode, err.message)
+      }
+
+      let offset = err.location && err.location.start.offset
+      if (options.baseUrl) {
+        // we need to add the number of chars from base url to the offset
+        offset += options.baseUrl.length
       }
 
       // TODO adjust this to behave like above
-      err.message = 'Parsing URL failed with error: ' + err.message
+      err.message = `Parsing URL failed at position ${offset}: ${err.message}`
       err.statusCode = err.statusCode || 400
       throw err
     }