Relax error to warning for "getting the Oracle Client version" for Knex

[robmcguinness]

First, thanks for thin client. Really improves the developer experience when leveraging node-oracledb in Nodejs.

Problem Statement

Trying to leverage node-oracledb thin mode with knex and running into issues with migrations. Knex makes a clone of the Oracle client during the migration initialization phase which leverages lodash merge underneath. Lodash merge iterates through the Oracle client properties which eventually triggers a call to the getter for oracleClientVersion

node-oracledb/lib/oracledb.js

Line 1055 in eadafe2

get oracleClientVersion() {

Feature Request

Can this error be converted to a warning instead for lib compatibility? Knex is one of the few query builders in the Nodejs ecosystem that supports Oracle. Fixing the upstream lib would take more work.

Commenting lines below resolves issue with Knex migrations.

get oracleClientVersion() {
  if (_initOracleClientArgs === undefined) {
    // errors.throwNotImplemented("getting the Oracle Client version");
  }
  return settings.oracleClientVersion;
},

get oracleClientVersionString() {
  if (_initOracleClientArgs === undefined) {
    // errors.throwNotImplemented("getting the Oracle Client version");
  }
  return settings.oracleClientVersionString;
},

Besides this issue, thin mode appears to work with current version of Knex. For reference, Knex feature request for node-oracledb v6.0 compatibility knex/knex#5615

[cjbj]

Thanks for your comments.

What exact behavior do you suggest? Can you submit a PR?

[robmcguinness]

I used pnpm to patch oracledb and simply used console.warn as a workaround.

   get oracleClientVersion() {
     if (_initOracleClientArgs === undefined) {
-      errors.throwNotImplemented("getting the Oracle Client version");
+      console.warn('node-oracledb: getting the Oracle Client version is not supported in thin mode');
+      return undefined;
     }
     return settings.oracleClientVersion;
   },
 
   get oracleClientVersionString() {
     if (_initOracleClientArgs === undefined) {
-      errors.throwNotImplemented("getting the Oracle Client version");
+      console.warn('node-oracledb: getting the Oracle Client version is not supported in thin mode');
+      return undefined;
     }
     return settings.oracleClientVersionString;
   },

I didn't see any methods to emit warnings from this lib. I could submit a PR if the above workaround is sufficient.

[cjbj]

We use errors.throwNotImplemented() in a lot of places, but being inconsistent for oracleClientVersion() does have merit. We'll have to analyze all the pros & cons to check the impacts - and determine what version such a change could land in.

[sosoba]

These functions should return thin string, not an exception

[anthony-tuininga]

Or just the value undefined in both cases? The string thin would make sense for the second case but not the first one! Whereas undefined makes sense in both cases.

[sharadraju]

This enhancement has been added to the 6.1 release.