@sap/cds 8.9.3 → 9.0.2

package/libx/_runtime/hana/driver.js

@@ -1,205 +0,0 @@
-const cds = require('../cds')
-const LOG = cds.log('hana|db|sql')
-
-/*
- * dynatrace
- */
-
-const { dynatraceClient, isDynatraceEnabled } = require('./dynatrace')
-
-/*
- * common
- */
-
-const _ensureError = err => (err instanceof Error ? err : Object.assign(new Error(err.message), err))
-
-/*
- * hdb
- */
-const _addCheckServerIdentity = creds => {
-  // REVISIT: copied from old cds-hana
-  if (creds.sslValidateCertificate === false && creds.sslHostNameInCertificate) {
-    const allowedHost = creds.sslHostNameInCertificate
-    creds.checkServerIdentity = host => {
-      if (host !== allowedHost) {
-        throw new Error(
-          `The name on the security certificate "${allowedHost}" is invalid or does not match the name of the site "${host}".`
-        )
-      }
-    }
-  }
-}
-
-function _connectHdb(creds, tenant) {
-  _addCheckServerIdentity(creds)
-
-  return new Promise((resolve, reject) => {
-    // tls keep alive
-    if (process.env.HDB_TCP_KEEP_ALIVE_IDLE) {
-      const num = Number(process.env.HDB_TCP_KEEP_ALIVE_IDLE)
-      creds.tcpKeepAliveIdle = Number.isNaN(num) ? false : num
-    }
-
-    const hdbClient = this.createClient(creds)
-    hdbClient.name = this.name // TODO find better way?
-
-    const client = isDynatraceEnabled() ? dynatraceClient(hdbClient, creds, tenant) : hdbClient
-
-    const start = LOG._debug && Date.now()
-    client.connect(err => {
-      if (err) {
-        err = _ensureError(err)
-        err.message = `Could not establish connection for tenant "${tenant}" due to error: ` + err.message
-        LOG.error(err)
-
-        // error on .connect shall lead to pool drain
-        err._connectError = true
-
-        reject(err)
-      } else {
-        if (creds.schema) {
-          client.exec(`SET SCHEMA ${creds.schema}`, err => {
-            if (err) {
-              err.message = `Could not set schema "${creds.schema}" due to error: ` + err.message
-              reject(err)
-            } else {
-              LOG._debug && LOG.debug(`Elapsed time to create new database connection: ${Date.now() - start}ms`)
-              resolve(client)
-            }
-          })
-        } else {
-          LOG._debug && LOG.debug(`Elapsed time to create new database connection: ${Date.now() - start}ms`)
-          resolve(client)
-        }
-
-        client.once('error', err => {
-          client.hadError = true
-          if (LOG._warn) {
-            err.message = 'Client error: ' + err.message
-            LOG.warn(err)
-          }
-        })
-      }
-    })
-  })
-}
-
-/*
- * hana-client
- */
-
-function _connectHanaClient(creds, tenant) {
-  return new Promise((resolve, reject) => {
-    const hanaClient = this.createConnection()
-
-    hanaClient.name = this.name // TODO find better way?
-    // ugly, but we need it for the hana-client streaming extension.
-    // "client" does not contain the credentials in case of hana-client.
-    hanaClient._creds = creds
-
-    const client = isDynatraceEnabled() ? dynatraceClient(hanaClient, creds, tenant) : hanaClient
-
-    if (creds.schema) {
-      // REVISIT
-      creds.CURRENTSCHEMA = creds.schema
-    }
-
-    const start = LOG._debug && Date.now()
-    client.connect(creds, err => {
-      if (err) {
-        err = _ensureError(err)
-        err.message = `Could not establish connection for tenant "${tenant}" due to error: ` + err.message
-        LOG.error(err)
-
-        // error on .connect shall lead to pool drain
-        err._connectError = true
-
-        reject(err)
-      } else {
-        LOG._debug && LOG.debug(`Elapsed time to create new database connection: ${Date.now() - start}ms`)
-        resolve(client)
-      }
-    })
-  })
-}
-
-/*
- * facade
- */
-
-let driver
-
-const _getHanaDriver = name => {
-  if (driver) return driver
-
-  let isConfigured = false
-  if (!name) {
-    let packageJson
-    try {
-      packageJson = require(cds.root + '/package.json')
-    } catch {
-      LOG._debug && LOG.debug(`Could not find package.json. Trying to lookup hana driver automatically.`)
-      name = 'hdb'
-    }
-
-    if (packageJson?.dependencies?.hdb) {
-      LOG._debug && LOG.debug(`"hdb" found in dependencies of "${cds.root}".`)
-      name = 'hdb'
-      isConfigured = true
-    } else if (packageJson?.dependencies?.['@sap/hana-client']) {
-      LOG._debug && LOG.debug(`"@sap/hana-client" found in dependencies of "${cds.root}".`)
-      name = '@sap/hana-client'
-      isConfigured = true
-    } else if (!name) {
-      LOG._debug &&
-        LOG.debug(
-          `Neither "hdb" nor "@sap/hana-client" found in dependencies of "${cds.root}". Trying to lookup hana driver automatically.`
-        )
-      // fallback to hdb in case both are not provided, which will fallback to @sap/hana-client if hdb is not installed
-      name = 'hdb'
-    }
-  }
-
-  try {
-    driver = Object.assign({ name }, require(name))
-
-    driver.__connect = (...args) =>
-      name === 'hdb' ? _connectHdb.call(driver, ...args) : _connectHanaClient.call(driver, ...args)
-    driver.__disconnect = client => {
-      return new Promise(resolve => {
-        client.disconnect(err => {
-          // REVISIT: what to do? ignore? crash app?
-          if (err) {
-            if (LOG._warn) {
-              err.message = 'Could not disconnect due to error: ' + err.message
-              LOG.warn(err)
-            }
-            resolve()
-          } else resolve()
-        })
-      })
-    }
-    driver.__isConnected = client => {
-      if (name === 'hdb') {
-        return !client.hadError && client.readyState === 'connected'
-      }
-
-      return client.state() === 'connected'
-    }
-
-    if (LOG._debug) LOG.debug(`Using "${driver.name}"`)
-
-    return driver
-  } catch (e) {
-    if (name === 'hdb' && !isConfigured) {
-      LOG._debug && LOG.debug(`Failed to require "hdb" with error "${e.message}". Trying "@sap/hana-client" next.`)
-      return _getHanaDriver('@sap/hana-client')
-    } else if (isConfigured) {
-      throw new Error(`"${name}" could not be found. Please make sure it is installed.`)
-    } else {
-      throw new Error('Neither "hdb" nor "@sap/hana-client" could be found. Please make sure one of them is installed.')
-    }
-  }
-}
-
-module.exports = _getHanaDriver()

package/libx/_runtime/hana/dynatrace.js

@@ -1,130 +0,0 @@
-const dynatrace = {}
-try {
-  dynatrace.sdk = require('@dynatrace/oneagent-sdk')
-  dynatrace.api = dynatrace.sdk.createInstance()
-} catch {
-  // If module was not required, do not do anything
-}
-
-const isDynatraceEnabled = () => {
-  return dynatrace.sdk !== undefined && !process.env.CDS_SKIP_DYNATRACE
-}
-
-const _dynatraceResultCallback = function (tracer, cb) {
-  return function (err, ...args) {
-    const results = args.shift()
-    if (err) {
-      tracer.error(err)
-    } else {
-      tracer.setResultData({
-        rowsReturned: (results && results.length) || results
-      })
-    }
-    tracer.end(cb, err, results, ...args)
-  }
-}
-
-const _execUsingDynatrace = (client, execFn, dbInfo) => {
-  // args = [sql, options, callback] --> options is optional
-  return function (...args) {
-    const cb = args[args.length - 1]
-
-    const tracer = dynatrace.api.traceSQLDatabaseRequest(dbInfo, {
-      statement: args[0]
-    })
-
-    tracer.startWithContext(execFn, client, ...args.slice(0, args.length - 1), _dynatraceResultCallback(tracer, cb))
-  }
-}
-
-const _preparedStmtUsingDynatrace = function (client, prepareFn, dbInfo) {
-  // args = [sql, options, callback] --> options is optional
-  return function (...args) {
-    const cb = args[args.length - 1]
-
-    const tracer = dynatrace.api.traceSQLDatabaseRequest(dbInfo, {
-      statement: args[0]
-    })
-
-    tracer.startWithContext(prepareFn, client, ...args.slice(0, args.length - 1), (err, stmt) => {
-      if (err) {
-        tracer.error(err)
-        tracer.end(cb, err)
-      } else {
-        // same here. hana-client does not like decorating
-        const originalExecFn = stmt.exec
-        stmt.exec = function (...args) {
-          const stmtCb = args[args.length - 1]
-          originalExecFn.call(stmt, ...args.slice(0, args.length - 1), _dynatraceResultCallback(tracer, stmtCb))
-        }
-        cb(null, stmt)
-      }
-    })
-  }
-}
-
-const dynatraceClient = (client, credentials, tenant) => {
-  const dbInfo = {
-    name: `SAPHANA${tenant ? `-${tenant}` : ''}`,
-    vendor: dynatrace.sdk.DatabaseVendor.HANADB,
-    host: credentials.host,
-    port: Number(credentials.port)
-  }
-
-  // hana-client does not like decorating.
-  // because of that, we need to override the fn and pass the original fn for execution
-  const originalExecFn = client.exec
-  client.exec = _execUsingDynatrace(client, originalExecFn, dbInfo)
-  const originalPrepareFn = client.prepare
-  if (client.name === '@sap/hana-client') {
-    // client.prepare = ... doesn't work for hana-client
-    Object.defineProperty(client, 'prepare', { value: _preparedStmtUsingDynatrace(client, originalPrepareFn, dbInfo) })
-  } else {
-    client.prepare = _preparedStmtUsingDynatrace(client, originalPrepareFn, dbInfo)
-  }
-
-  return client
-}
-
-const _createHanaClientStreamingStatement = function (extension, createStmtFn) {
-  // args = [sql, options, callback] --> options is optional
-  return function (dbc, sql, cb) {
-    const dbInfo = {
-      name: `SAPHANA${dbc._tenant ? `-${dbc._tenant}` : ''}`,
-      vendor: dynatrace.sdk.DatabaseVendor.HANADB,
-      host: dbc._creds.host,
-      port: Number(dbc._creds.port)
-    }
-
-    const tracer = dynatrace.api.traceSQLDatabaseRequest(dbInfo, {
-      statement: sql
-    })
-
-    tracer.startWithContext(createStmtFn, extension, dbc, sql, (err, stmt) => {
-      if (err) {
-        tracer.error(err)
-        tracer.end(cb, err)
-      } else {
-        // same here. hana-client does not like decorating
-        const originalExecFn = stmt.stmt.exec
-        stmt.stmt.exec = function (...args) {
-          const stmtCb = args[args.length - 1]
-          originalExecFn.call(stmt.stmt, ...args.slice(0, args.length - 1), _dynatraceResultCallback(tracer, stmtCb))
-        }
-        cb(null, stmt)
-      }
-    })
-  }
-}
-
-const dynatraceStreamingExtension = extension => {
-  const originalCreateStmtFn = extension.createStatement
-  const decorator = {}
-  Object.setPrototypeOf(decorator, extension)
-  // ensure that dynatrace calls the original function of the extension
-  decorator.createStatement = _createHanaClientStreamingStatement(extension, originalCreateStmtFn)
-
-  return decorator
-}
-
-module.exports = { dynatraceClient, dynatraceStreamingExtension, isDynatraceEnabled }