@sap/cds 8.9.3 → 9.0.2

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

@@ -1,98 +0,0 @@
-const cds = require('../../cds')
-
-const { ensureNoDraftsSuffix } = require('../../common/utils/draft.js')
-const normalizeTimestamp = require('../../common/utils/normalizeTimestamp')
-
-const _convertDateTimeElement = (value, element) => {
-  switch (element._type) {
-    case 'cds.DateTime':
-      return new Date(value).toISOString().replace(/\.\d\d\d/, '')
-    case 'cds.Timestamp':
-      return normalizeTimestamp(value)
-  }
-}
-
-const _isToConvert = type => type === 'cds.DateTime' || type === 'cds.Timestamp'
-
-const _convertDateTimeEntry = (entry, element, model) => {
-  const { name, type, _target } = element
-  if (!(entry[name] == null)) {
-    if (_isToConvert(type) && entry[name] !== '$now') {
-      entry[name] = _convertDateTimeElement(entry[name], element)
-    }
-
-    if (element.isComposition) {
-      _normalize({ target: _target, data: entry[name] }, model)
-    }
-  }
-}
-
-const _convertEntries = (data, elements, model) => {
-  // check all entries
-  for (const entry of data) {
-    for (const column in entry) {
-      // skip unknown columns
-      if (!elements[column]) continue
-      _convertDateTimeEntry(entry, elements[column], model)
-    }
-  }
-}
-
-const _convertColumns = (data, elements, model, queryColumns) => {
-  // check all columns
-  for (let i = 0, length = queryColumns.length; i < length; i++) {
-    const col = queryColumns[i]
-    if (elements[col] && _isToConvert(elements[col]._type)) {
-      const dataArray = Array.isArray(data[0]) ? data : [data]
-      for (const d of dataArray) {
-        const elementValue = d[i]
-        if (elementValue != null && elementValue !== '$now') {
-          d[i] = _convertDateTimeElement(elementValue, elements[col])
-        }
-      }
-    }
-  }
-}
-
-/**
- * This method finds and converts the cds.DateTime and cds.Timestamp types to UTC.
- * HANA stores date time values without timezone.
- * Compiler v2 uses TIMESTAMP_TEXT (instead of TIMESTAMP) on SQLite.
- *
- * @param req - cds.Request
- * @param model
- * @returns {undefined}
- */
-const _normalize = function (req, model) {
-  if (
-    !req.data ||
-    (Array.isArray(req.data) && req.data.length === 0) ||
-    (typeof req.data === 'object' && Object.keys(req.data).length === 0)
-  ) {
-    // > nothing to convert (e.g., in case of insert as select)
-    return
-  }
-
-  // for recursion
-  if (!model) model = this.model
-  if (!model) return
-
-  let elements = req.target.elements
-  if (req.target._unresolved) {
-    const activeName = req.target.name && ensureNoDraftsSuffix(req.target.name)
-    if (!model.definitions[activeName]) return
-
-    elements = model.definitions[activeName].elements
-  }
-
-  const data = Array.isArray(req.data) ? req.data : [req.data]
-  if (req.query && req.query.INSERT && req.query.INSERT.columns) {
-    if (!cds.env.features.preserve_timestamps) {
-      _convertColumns(data, elements, model, req.query.INSERT.columns)
-    }
-  } else {
-    _convertEntries(data, elements, model)
-  }
-}
-
-module.exports = _normalize

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

@@ -1,41 +0,0 @@
-const { Readable } = require('stream')
-
-const _stream = val => {
-  if (val === null) return null
-  return new Readable({
-    read(size) {
-      if (val.length === 0) return this.push(null)
-      const chunk = val.slice(0, size)
-      val = val.slice(size)
-      this.push(chunk)
-    }
-  })
-}
-
-const convertStream = (columns, target, result, one) => {
-  if (!result || !columns || !target) return
-  if (!Array.isArray(result)) result = [result]
-  if (!result.length) return
-
-  for (let col of columns) {
-    let name = col.ref?.[col.ref.length - 1] || (typeof col === 'string' && col)
-    const element = target.elements?.[name]
-    if (!element) continue
-    name = col.as || name
-    if (element.isAssociation) {
-      if (one) convertStream(col.expand, element._target, result[0][name], false)
-      else
-        result.forEach(row => {
-          convertStream(col.expand, element._target, row[name], false)
-        })
-    } else if (element.type === 'cds.LargeBinary') {
-      if (one) result[0][name] = _stream(result[0][name])
-      else
-        result.forEach(row => {
-          row[name] = _stream(row[name])
-        })
-    }
-  }
-}
-
-module.exports = { convertStream }

package/libx/_runtime/hana/Service.js

@@ -1,173 +0,0 @@
-const cds = require('../cds')
-const LOG = cds.log('hana|db|sql')
-const coloredTxCommands = require('../db/utils/coloredTxCommands')
-
-const DatabaseService = require('../db/Service')
-const pool = require('./pool')
-
-/*
- * hana-specific handlers
- */
-const localized = require('./localized')
-const search = require('./search')
-
-/*
- * hana-specific execution
- */
-const execute = require('./execute')
-
-/*
- * helpers
- */
-const _setSessionContext = (dbc, property, value) => {
-  if (dbc._connection) {
-    // Works, but bad practice to access an internal scope
-    dbc._connection.getClientInfo().setProperty(property, value)
-    return
-  }
-
-  dbc.setClientInfo(property, value)
-}
-
-/*
- * the service
- */
-class HanaDatabase extends DatabaseService {
-  constructor(...args) {
-    super(...args)
-
-    // REVISIT: official db api
-    this._execute = execute
-
-    // REVISIT: db api
-    this._insert = this._queries.insert(execute.insert)
-    this._read = this._queries.read(execute.select, execute.stream, execute.convert)
-    this._update = this._queries.update(execute.update, execute.select)
-    this._delete = this._queries.delete(execute.delete, execute.update)
-    this._run = this._queries.run(this._insert, this._read, this._update, this._delete, execute.cqn, execute.sql)
-  }
-
-  init() {
-    this._registerBeforeHandlers()
-    this._registerOnHandlers()
-    this._registerAfterHandlers()
-
-    /*
-     * tx
-     */
-    this.on('BEGIN', function () {
-      LOG._debug && LOG.debug(coloredTxCommands['BEGIN'])
-
-      this.dbc.setAutoCommit(false)
-
-      return 'dummy'
-    })
-
-    this.on(['COMMIT', 'ROLLBACK'], function (req) {
-      LOG._debug && LOG.debug(coloredTxCommands[req.event])
-
-      // REVISIT: better?
-      this.dbc._closed = true
-
-      return new Promise((resolve, reject) => {
-        this.dbc[req.event.toLowerCase()](err => {
-          try {
-            this.dbc.setAutoCommit(true)
-          } catch (e) {
-            // REVISIT: what to do?
-            return reject(e)
-          }
-
-          if (err) return reject(err)
-          resolve('dummy')
-        })
-      })
-    })
-
-    /*
-     * generic
-     */
-    // all others, i.e. CREATE, DROP table, ...
-    this.on('*', function (req) {
-      return this._run(this.model, this.dbc, req.query || req.event, req, req.data)
-    })
-  }
-
-  _registerBeforeHandlers() {
-    this.before(['CREATE', 'UPDATE', 'UPSERT'], '*', this._input) // > has to run before rewrite
-    this.before('READ', '*', search) // > has to run before rewrite
-    this.before(['CREATE', 'READ', 'UPDATE', 'DELETE', 'UPSERT'], '*', this._rewrite)
-
-    this.before('READ', '*', localized) // > has to run after rewrite
-    this.before('READ', '*', this._virtual)
-  }
-
-  _registerOnHandlers() {
-    this.on('CREATE', '*', this._CREATE)
-    this.on('READ', '*', this._READ)
-    this.on('UPDATE', '*', this._UPDATE)
-    this.on('DELETE', '*', this._DELETE)
-  }
-
-  _registerAfterHandlers() {
-    // REVISIT: after phase runs in parallel -> side effects possible!
-    const { effective, features } = cds.env
-
-    if (effective.odata.structs && !features.ucsn_struct_conversion) {
-      // REVISIT: only register for entities that contain structured or navigation to it
-      this.after(['READ'], '*', this._structured)
-    }
-  }
-
-  /*
-   * connection
-   */
-  async acquire(arg) {
-    const tenant = arg && (typeof arg === 'string' ? arg : arg.tenant)
-    const dbc = await pool.acquire(tenant, this)
-
-    if (arg && typeof arg !== 'string') {
-      _setSessionContext(dbc, 'APPLICATIONUSER', arg.user.id || 'ANONYMOUS')
-      _setSessionContext(dbc, 'LOCALE', arg.locale || 'en')
-
-      // REVISIT: stable access
-      const validFrom = (arg.context && arg.context._ && arg.context._['VALID-FROM']) || (arg._ && arg._['VALID-FROM'])
-      const validto = (arg.context && arg.context._ && arg.context._['VALID-TO']) || (arg._ && arg._['VALID-TO'])
-
-      if (validFrom)
-        _setSessionContext(
-          dbc,
-          'VALID-FROM',
-          validFrom instanceof Date ? validFrom.toISOString().replace('T', ' ') : validFrom.replace('T', ' ')
-        )
-
-      if (validto)
-        _setSessionContext(
-          dbc,
-          'VALID-TO',
-          validto instanceof Date ? validto.toISOString().replace('T', ' ') : validto.replace('T', ' ')
-        )
-    }
-
-    dbc._tenant = tenant
-
-    // REVISIT: better?
-    dbc._closed = false
-
-    return dbc
-  }
-
-  release(dbc) {
-    if (dbc) return pool.release(dbc)
-
-    // should not happen, but just in case
-    LOG._warn && LOG.warn(new Error('Release called without client. Please report this warning.'))
-  }
-
-  // REVISIT: should happen automatically after a configurable time
-  async disconnect(tenant) {
-    await pool.drain(tenant)
-  }
-}
-
-module.exports = HanaDatabase

package/libx/_runtime/hana/conversion.js

@@ -1,73 +0,0 @@
-const cds = require('../../../lib')
-const driver = require('./driver')
-const isHdb = driver?.name === 'hdb'
-
-const convertToBoolean = boolean => {
-  if (boolean === null) {
-    return null
-  }
-
-  return Boolean(boolean)
-}
-
-const convertInt64ToString = int64 => {
-  if (int64 === null) {
-    return null
-  }
-
-  return String(int64)
-}
-
-const convertToISO = element => {
-  if (!element) return null
-
-  let dateTime = element.replace(' ', 'T')
-  if (cds.env.features.precise_timestamps) {
-    dateTime = dateTime.slice(0, 19)
-    let millis = element.slice(20)
-    if (millis.at(-1) === 'Z') millis = millis.slice(0, -1)
-    millis = millis.slice(0, 7).padEnd(7, '0')
-    return dateTime + '.' + millis + 'Z'
-  }
-
-  return new Date(dateTime + 'Z').toISOString()
-}
-
-const convertToISONoMillis = element => {
-  if (element) {
-    const dateTime = new Date(element + 'Z').toISOString()
-    return dateTime.slice(0, 19) + dateTime.slice(23)
-  }
-
-  return null
-}
-
-const convertToString = element => {
-  if (element) {
-    if (element instanceof Buffer) {
-      if (isHdb && driver.iconv) {
-        return driver.iconv.decode(element, 'cesu8')
-      }
-
-      return Buffer.from(element, 'base64').toString()
-    }
-
-    return element
-  }
-
-  return null
-}
-
-const HANA_TYPE_CONVERSION_MAP = new Map([
-  ['cds.Boolean', convertToBoolean],
-  ['cds.Integer64', convertInt64ToString],
-  ['cds.Int64', convertInt64ToString],
-  ['cds.DateTime', convertToISONoMillis],
-  ['cds.Timestamp', convertToISO],
-  ['cds.LargeString', convertToString],
-  ['cds.hana.CLOB', convertToString]
-])
-
-module.exports = {
-  HANA_TYPE_CONVERSION_MAP
-}

package/libx/_runtime/hana/customBuilder/CustomCreateBuilder.js

@@ -1,11 +0,0 @@
-const CreateBuilder = require('../../db/sql-builder').CreateBuilder
-
-class CustomCreateBuilder extends CreateBuilder {
-  get SelectBuilder() {
-    const SelectBuilder = require('./CustomSelectBuilder')
-    Object.defineProperty(this, 'SelectBuilder', { value: SelectBuilder })
-    return SelectBuilder
-  }
-}
-
-module.exports = CustomCreateBuilder

package/libx/_runtime/hana/customBuilder/CustomDeleteBuilder.js

@@ -1,17 +0,0 @@
-const DeleteBuilder = require('../../db/sql-builder').DeleteBuilder
-
-class CustomDeleteBuilder extends DeleteBuilder {
-  get ReferenceBuilder() {
-    const ReferenceBuilder = require('./CustomReferenceBuilder')
-    Object.defineProperty(this, 'ReferenceBuilder', { value: ReferenceBuilder })
-    return ReferenceBuilder
-  }
-
-  get ExpressionBuilder() {
-    const ExpressionBuilder = require('./CustomExpressionBuilder')
-    Object.defineProperty(this, 'ExpressionBuilder', { value: ExpressionBuilder })
-    return ExpressionBuilder
-  }
-}
-
-module.exports = CustomDeleteBuilder

package/libx/_runtime/hana/customBuilder/CustomDropBuilder.js

@@ -1,12 +0,0 @@
-const DropBuilder = require('../../db/sql-builder').DropBuilder
-
-class CustomDropBuilder extends DropBuilder {
-  /**
-   * IF EXISTS is not supported by HANA so we need to overwrite this method so it does not return anything.
-   *
-   * @private
-   */
-  _ifExists() {}
-}
-
-module.exports = CustomDropBuilder

package/libx/_runtime/hana/customBuilder/CustomExpressionBuilder.js

@@ -1,23 +0,0 @@
-const ExpressionBuilder = require('../../db/sql-builder').ExpressionBuilder
-
-class CustomExpressionBuilder extends ExpressionBuilder {
-  get FunctionBuilder() {
-    const FunctionBuilder = require('./CustomFunctionBuilder')
-    Object.defineProperty(this, 'FunctionBuilder', { value: FunctionBuilder })
-    return FunctionBuilder
-  }
-
-  get ReferenceBuilder() {
-    const ReferenceBuilder = require('./CustomReferenceBuilder')
-    Object.defineProperty(this, 'ReferenceBuilder', { value: ReferenceBuilder })
-    return ReferenceBuilder
-  }
-
-  get SelectBuilder() {
-    const SelectBuilder = require('./CustomSelectBuilder')
-    Object.defineProperty(this, 'SelectBuilder', { value: SelectBuilder })
-    return SelectBuilder
-  }
-}
-
-module.exports = CustomExpressionBuilder

package/libx/_runtime/hana/customBuilder/CustomFunctionBuilder.js

@@ -1,34 +0,0 @@
-const FunctionBuilder = require('../../db/sql-builder').FunctionBuilder
-
-class CustomFunctionBuilder extends FunctionBuilder {
-  get ReferenceBuilder() {
-    const ReferenceBuilder = require('./CustomReferenceBuilder')
-    Object.defineProperty(this, 'ReferenceBuilder', { value: ReferenceBuilder })
-    return ReferenceBuilder
-  }
-
-  get ExpressionBuilder() {
-    const ExpressionBuilder = require('./CustomExpressionBuilder')
-    Object.defineProperty(this, 'ExpressionBuilder', { value: ExpressionBuilder })
-    return ExpressionBuilder
-  }
-
-  get SelectBuilder() {
-    const SelectBuilder = require('./CustomSelectBuilder')
-    Object.defineProperty(this, 'SelectBuilder', { value: SelectBuilder })
-    return SelectBuilder
-  }
-
-  _handleContains(args) {
-    // fuzzy search has three arguments, must not be converted to like expressions
-    if (args.length > 2 || this._obj.searchUsingContains) {
-      this._outputObj.sql.push('CONTAINS')
-      this._addFunctionArgs(args, true)
-      return
-    }
-
-    super._handleContains(args)
-  }
-}
-
-module.exports = CustomFunctionBuilder

package/libx/_runtime/hana/customBuilder/CustomReferenceBuilder.js

@@ -1,38 +0,0 @@
-const ReferenceBuilder = require('../../db/sql-builder').ReferenceBuilder
-
-class CustomReferenceBuilder extends ReferenceBuilder {
-  get FunctionBuilder() {
-    const FunctionBuilder = require('./CustomFunctionBuilder')
-    Object.defineProperty(this, 'FunctionBuilder', { value: FunctionBuilder })
-    return FunctionBuilder
-  }
-
-  _parseReference(ref) {
-    if (ref[0].id && ref[0].args) {
-      const dbName = this._getDatabaseName(ref[0].id)
-      this._outputObj.sql.push(this._quoteElement(dbName))
-
-      const args = Object.keys(ref[0].args)
-        .map(argKey => {
-          this._outputObj.values.push(ref[0].args[argKey].val)
-          return `${this._quoteElement(argKey)} => ${this._options.placeholder}`
-        })
-        .join(', ')
-
-      this._outputObj.sql.push('(', args, ')')
-    } else {
-      if (this._handleStructuredIfExists(ref)) {
-        return
-      }
-
-      const sql = ref.map(el => this._quoteElement(el)).join('.')
-      this._outputObj.sql.push(sql)
-    }
-  }
-
-  _isToOneManaged() {
-    return false
-  }
-}
-
-module.exports = CustomReferenceBuilder

package/libx/_runtime/hana/customBuilder/CustomSelectBuilder.js

@@ -1,90 +0,0 @@
-const cds = require('../../cds')
-const LOG = cds.log('hana|db|sql')
-
-const SelectBuilder = require('../../db/sql-builder').SelectBuilder
-
-class CustomSelectBuilder extends SelectBuilder {
-  get FunctionBuilder() {
-    const FunctionBuilder = require('./CustomFunctionBuilder')
-    Object.defineProperty(this, 'FunctionBuilder', { value: FunctionBuilder })
-    return FunctionBuilder
-  }
-
-  get ReferenceBuilder() {
-    const ReferenceBuilder = require('./CustomReferenceBuilder')
-    Object.defineProperty(this, 'ReferenceBuilder', { value: ReferenceBuilder })
-    return ReferenceBuilder
-  }
-
-  get ExpressionBuilder() {
-    const ExpressionBuilder = require('./CustomExpressionBuilder')
-    Object.defineProperty(this, 'ExpressionBuilder', { value: ExpressionBuilder })
-    return ExpressionBuilder
-  }
-
-  get SelectBuilder() {
-    const SelectBuilder = require('./CustomSelectBuilder')
-    Object.defineProperty(this, 'SelectBuilder', { value: SelectBuilder })
-    return SelectBuilder
-  }
-
-  _val(obj) {
-    if (typeof obj.val === 'boolean') return { sql: obj.val ? 'true' : 'false', values: [] }
-    return super._val(obj)
-  }
-
-  getParameters() {
-    const { with_parameters: withParameters } = cds.env.features
-    if (withParameters === false || !this._options.locale) return ''
-    if (withParameters === true) return `with parameters ('LOCALE' = '${this._options.locale}')`
-
-    // skip with parameters if all orderby columns are not strings
-    let skip
-    if (this._csn && this._csn.definitions) {
-      // REVISIT: remove try catch with new sql factory
-      try {
-        const select = this._obj.SELECT
-        const entity =
-          select.from.ref &&
-          select.from.ref.length === 1 &&
-          // REVISIT this does not work with join and draft!
-          this._csn.definitions[select.from.ref[0].id || select.from.ref[0]]
-        // TODO FIXME
-        skip =
-          !select.orderBy ||
-          (entity &&
-            select.orderBy.every(o => {
-              const k = o.ref && o.ref.length === 1 && o.ref[0]
-              const element = (k && entity.elements[k]) || {}
-              return element._type !== 'cds.String'
-            }))
-      } catch (e) {
-        if (LOG._warn) {
-          e.message =
-            'Unable to determine whether the "with parameters" clause can be skipped due to error: ' +
-            e.message +
-            '. Please report this warning.'
-          e.query = this._obj
-          LOG.warn(e)
-        }
-      }
-    }
-
-    if (skip) return ''
-    return `with parameters ('LOCALE' = '${this._options.locale}')`
-  }
-}
-
-if (cds.env.sql.names === 'plain') {
-  CustomSelectBuilder.prototype._buildRefElement = function (col, res, noQuoting) {
-    res = new this.ReferenceBuilder(col, this._options, this._csn).build()
-
-    if (!noQuoting && !col.as) {
-      res.sql += ` AS ${this._options.delimiter}${col.ref[col.ref.length - 1]}${this._options.delimiter}`
-    }
-
-    return res
-  }
-}
-
-module.exports = CustomSelectBuilder

package/libx/_runtime/hana/customBuilder/index.js

@@ -1,11 +0,0 @@
-const dependencies = {
-  DeleteBuilder: require('./CustomDeleteBuilder'),
-  CreateBuilder: require('./CustomCreateBuilder'),
-  DropBuilder: require('./CustomDropBuilder'),
-  FunctionBuilder: require('./CustomFunctionBuilder'),
-  ExpressionBuilder: require('./CustomExpressionBuilder'),
-  SelectBuilder: require('./CustomSelectBuilder'),
-  ReferenceBuilder: require('./CustomReferenceBuilder')
-}
-
-module.exports = dependencies