Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support driver self-wrapping (for Dynatrace) #974

Merged
merged 2 commits into from
Jan 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions hana/lib/drivers/dynatrace.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ try {
// If module was not required, do not do anything
}

const isDynatraceEnabled = () => {
const _shall_wrap = () => {
return dynatrace.sdk !== undefined && !process.env.CDS_SKIP_DYNATRACE
}

Expand Down Expand Up @@ -65,7 +65,7 @@ const _preparedStmtUsingDynatrace = function (client, prepareFn, dbInfo) {
}
}

const dynatraceClient = (client, credentials, tenant) => {
const _wrapped = (client, credentials, tenant) => {
const dbInfo = {
name: `SAPHANA${tenant ? `-${tenant}` : ''}`,
vendor: dynatrace.sdk.DatabaseVendor.HANADB,
Expand All @@ -88,4 +88,10 @@ const dynatraceClient = (client, credentials, tenant) => {
return client
}

module.exports = { dynatraceClient, isDynatraceEnabled }
module.exports = {
wrap_client: (client, credentials, tenant) => {
if (client.isDynatraceSupported) return client //> client will wrap itself
if (!_shall_wrap()) return client
return _wrapped(client, credentials, tenant)
}
}
4 changes: 2 additions & 2 deletions hana/lib/drivers/hana-client.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ const { Readable, Stream } = require('stream')
const cds = require('@sap/cds')
const hdb = require('@sap/hana-client')
const { driver, prom, handleLevel } = require('./base')
const { isDynatraceEnabled: dt_sdk_is_present, dynatraceClient: wrap_client } = require('./dynatrace')
const { wrap_client } = require('./dynatrace')
const LOG = cds.log('@sap/hana-client')
if (process.env.NODE_ENV === 'production' && !process.env.HDB_NODEJS_THREADPOOL_SIZE && !process.env.UV_THREADPOOL_SIZE) LOG.warn("When using @sap/hana-client, it's strongly recommended to adjust its thread pool size with environment variable `HDB_NODEJS_THREADPOOL_SIZE`, otherwise it might lead to performance issues.\nLearn more: https://help.sap.com/docs/SAP_HANA_CLIENT/f1b440ded6144a54ada97ff95dac7adf/31a8c93a574b4f8fb6a8366d2c758f21.html")

Expand Down Expand Up @@ -44,7 +44,7 @@ class HANAClientDriver extends driver {

super(creds)
this._native = hdb.createConnection(creds)
if (dt_sdk_is_present()) this._native = wrap_client(this._native, creds, creds.tenant)
this._native = wrap_client(this._native, creds, creds.tenant)
this._native.setAutoCommit(false)
}

Expand Down
4 changes: 2 additions & 2 deletions hana/lib/drivers/hdb.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const hdb = require('hdb')
const iconv = require('iconv-lite')

const { driver, prom, handleLevel } = require('./base')
const { isDynatraceEnabled: dt_sdk_is_present, dynatraceClient: wrap_client } = require('./dynatrace')
const { wrap_client } = require('./dynatrace')

if (cds.env.features.sql_simple_queries === 3) {
// Make hdb return true / false
Expand Down Expand Up @@ -44,7 +44,7 @@ class HDBDriver extends driver {

super(creds)
this._native = hdb.createClient(creds)
if (dt_sdk_is_present()) this._native = wrap_client(this._native, creds, creds.tenant)
this._native = wrap_client(this._native, creds, creds.tenant)
this._native.setAutoCommit(false)
this._native.on('close', () => this.destroy?.())

Expand Down
Loading