oracledb 2.2.0 → 2.3.0

package/package/MAKEPKG.BAT

@@ -26,7 +26,8 @@ REM ****************************************************************************
 
 REM
 REM usage: MAKEPKG.BAT [<cmd>]
-REM      : Possible values for <cmd> are: CLEANUP and CREATEBINARY
+REM      : Possible values for <cmd> are: CLEANUP, CREATEBINARY
+REM        and CREATESTAGEBINARY
 REM
 REM expected to run this batch file from package sub-directory,
 REM where a fresh clone is created.
@@ -38,6 +39,7 @@ if "%1" == "" GOTO usage
 REM jump to appropriate sections based on <cmd>
 if "%1" == "CLEANUP"  GOTO cleanup
 if "%1" == "CREATEBINARY"  GOTO createbinary
+if "%1" == "CREATESTAGEBINARY"  GOTO createstagebinary
 goto usage
 
 REM cleanup section, remove file(s) created by this batch file
@@ -47,6 +49,67 @@ del ..\package-lock.json
 del SHASUMS256.txt oracledb-v*-node-*.gz
 goto exit
 
+
+REM compile, package to gz file
+:createstagebinary
+echo "createstagebinary section"
+
+REM Append SHA to LICENSE.MD
+git checkout ..\LICENSE.md
+setlocal enabledelayedexpansion
+REM compose a string with commands to execute one by one
+
+REM start with empty string
+set CONCAT_STR=
+REM capture SHA
+FOR /F "tokens=* USEBACKQ" %%F IN (`git --git-dir=..\.git rev-parse HEAD`) DO (
+SET CONCAT_STR=%%F
+)
+
+set DATE_STR=
+FOR /F "tokens=* USEBACKQ" %%F IN (`DATE /T`) DO ( SET DATE_STR=%%F )
+
+REM append output of other commands
+set CMD_STR="git --git-dir=..\odpi\.git rev-parse HEAD && node --version"
+for /f %%i in ('%CMD_STR%') do set "CONCAT_STR=!CONCAT_STR! %%i"
+set CONCAT_STR=!CONCAT_STR! !DATE_STR!
+echo !CONCAT_STR! >> ..\LICENSE.MD
+
+REM Compile node-oracledb
+cd ..
+CALL npm install
+echo "NODE oracledb compiled"
+cd package
+echo "==> Staging Binary package created for Node.js "
+
+Set "hostname=%NODE_ORACLEDB_PACKAGE_HOSTNAME%"
+Set "pathname=%NODE_ORACLEDB_PACKAGE_URL_PATH%"
+Set "newname=%NODE_PKG_HOSTNAME%"
+echo ON
+echo %hostname%
+echo %pathname%
+echo %newname%
+
+sed  "s/github.com/%hostname%/g" oracledbinstall.js
+sed  "s/oracle\/node-oracledb\/releases\/download\//%pathname%/g" oracledbinstall.js
+
+del /S *.gz
+
+node createpackage.js
+xcopy /Y "package.json" "../package.json"
+npm pack
+Setlocal enabledelayedexpansion
+
+Set "Pattern=oracledb"
+Set "Replace=oracledb-staging"
+
+For %%a in (*.gz) Do (
+    Set "File=%%~a"
+    Ren "%%a" "!File:%Pattern%=%Replace%!"
+)
+
+goto exit
+
 REM compile, package to gz file
 :createbinary
 echo "createbinary section"

package/package/README.md

@@ -76,7 +76,7 @@ Installation is described in [INSTALL](https://oracle.github.io/node-oracledb/IN
     before running `make`.
 
   - `oracledb-src-X.Y.Z.tgz` which is the complete source code, mainly
-    created because older npm's (e.g. with Node 4) do not download the
+    created because older npm's (e.g. with Node.js 4) do not download the
     opdi submodule code when installing from a GitHub tag or branch.
 
 - The`staging-oracledb-X.Y.Z.tgz` package can be used to host binaries
@@ -98,6 +98,9 @@ Installation is described in [INSTALL](https://oracle.github.io/node-oracledb/IN
   Remember to do `npm config delete strict-ssl` and unset the
   environment variable when not testing.
 
+- On Windows, MAKEPKG.BAT has command options to create binaries, and
+  also to create staged binaries and the main packages.
+
 - At install time, setting the environment variable
   `NODE_ORACLEDB_TRACE_INSTALL` to `TRUE` will cause `npm install` to
   display more tracing information.
@@ -108,4 +111,5 @@ Installation is described in [INSTALL](https://oracle.github.io/node-oracledb/IN
 - TODO
 
   - oracledbinstall.js should cache SHASUMS256.txt so it doesn't have to be fetched twice.
+  - Add support for proxies that require authentication
   - Improve oracledbinstall.js `no_proxy` support for domain names and wildcards.

package/package/oracledbinstall.js

@@ -343,7 +343,7 @@ function done(err, alreadyInstalled) {
       packageUtil.error('Pre-built binary packages are not available for platform="' + process.platform + '"');
     } else if (process.arch !== 'x64') {
       packageUtil.error('Pre-built binary packages are not available for architecture="' + process.arch + '"');
-    } else if (['46', '48', '57', '59'].indexOf(process.versions.modules) < 0) {
+    } else if (['48', '57', '64'].indexOf(process.versions.modules) < 0) {
       packageUtil.error('Pre-built binary packages are not available for this version of Node.js (NODE_MODULE_VERSION="' + process.versions.modules + '")');
     }
     packageUtil.error('Failed to install binary package ' + packageUtil.dynamicProps.PACKAGE_FILE_NAME);

package/package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oracledb",
-  "version": "2.2.0",
-  "description": "Oracle Database driver by Oracle Corp.",
+  "version": "2.3.0",
+  "description": "A Node.js module for Oracle Database access",
   "license": "Apache-2.0",
   "homepage": "http://oracle.github.io/node-oracledb/",
   "keywords": [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oracledb",
-  "version": "2.2.0",
-  "description": "Oracle Database driver by Oracle Corp.",
+  "version": "2.3.0",
+  "description": "A Node.js module for Oracle Database access",
   "license": "Apache-2.0",
   "homepage": "http://oracle.github.io/node-oracledb/",
   "keywords": [

package/src/njsCommon.cpp

@@ -52,6 +52,7 @@
 #include "njsCommon.h"
 #include "njsOracle.h"
 #include "njsIntLob.h"
+#include "njsSubscription.h"
 
 using namespace node;
 using namespace std;
@@ -193,6 +194,7 @@ njsBaton::~njsBaton()
     jsCallback.Reset();
     jsCallingObj.Reset();
     jsOracledb.Reset();
+    jsSubscription.Reset();
     jsBuffer.Reset();
     ClearAsyncData();
 }
@@ -209,7 +211,7 @@ void njsBaton::CheckJSException(Nan::TryCatch *tryCatch)
 {
     if (tryCatch->HasCaught()) {
         Local<String> message = tryCatch->Message()->Get();
-        v8::String::Utf8Value v8str(message->ToString());
+        Nan::Utf8String v8str(message->ToString());
         error = std::string(*v8str, static_cast<size_t>(v8str.length()));
         tryCatch->Reset();
     }
@@ -239,6 +241,10 @@ void njsBaton::ClearAsyncData()
         dpiLob_release(dpiLobHandle);
         dpiLobHandle = NULL;
     }
+    if (dpiSubscrHandle) {
+        dpiSubscr_release(dpiSubscrHandle);
+        dpiSubscrHandle = NULL;
+    }
     if (bindVars) {
         delete [] bindVars;
         bindVars = NULL;
@@ -357,8 +363,11 @@ void njsBaton::AsyncAfterWorkCallback(uv_work_t *req, int status)
     delete baton;
 
     // make JS callback
-    Nan::MakeCallback(Nan::GetCurrentContext()->Global(), callback,
-                      static_cast<int>(numCallbackArgs), callbackArgs);
+    Nan::AsyncResource *asyncResource =
+            new Nan::AsyncResource("node-oracledb");
+    asyncResource->runInAsyncScope(Nan::GetCurrentContext()->Global(),
+            callback, static_cast<int>(numCallbackArgs), callbackArgs);
+    delete asyncResource;
 
     // we no longer need the callback args
     delete [] callbackArgs;
@@ -440,6 +449,19 @@ void njsBaton::SetDPILobHandle(dpiLob *handle)
 }
 
 
+//-----------------------------------------------------------------------------
+// njsBaton::SetDPISubscrHandle()
+//   Set the DPI subscription handle. This adds a reference to the DPI
+// subscription which will be released in the destructor.
+//-----------------------------------------------------------------------------
+void njsBaton::SetDPISubscrHandle(dpiSubscr *handle)
+{
+    if (dpiSubscr_addRef(handle) < 0)
+        GetDPIError();
+    else dpiSubscrHandle = handle;
+}
+
+
 //-----------------------------------------------------------------------------
 // njsBaton::GetBoolFromJSON()
 //   Gets a boolean value from the JSON object for the given key, if possible.
@@ -479,6 +501,34 @@ bool njsBaton::GetBoolFromJSON(Local<Object> obj, const char *key, int index,
 }
 
 
+//-----------------------------------------------------------------------------
+// njsBaton::GetFunctionFromJSON()
+//   Gets a function from the JSON object for the given key, if possible. If
+// undefined, leave value alone and do not set error; otherwise, set error.
+// Index is the argument index in the caller.
+//-----------------------------------------------------------------------------
+bool njsBaton::GetFunctionFromJSON(Local<Object> obj, const char *key,
+        int index, Local<Function> *value)
+{
+    Nan::EscapableHandleScope scope;
+    Local<Value> jsValue;
+
+    if (!error.empty())
+        return false;
+    MaybeLocal<Value> mval = Nan::Get(obj, Nan::New(key).ToLocalChecked());
+    if (!mval.ToLocal(&jsValue))
+        return false;
+    if (jsValue->IsFunction()) {
+        *value = scope.Escape(jsValue.As<Function>());
+        return true;
+    } else if (jsValue->IsUndefined()) {
+        return true;
+    }
+    error = njsMessages::Get(errInvalidPropertyTypeInParam, key, index + 1);
+    return false;
+}
+
+
 //-----------------------------------------------------------------------------
 // njsBaton::GetIntFromJSON()
 //   Gets a signed integer value from the JSON object for the given key, if
@@ -557,7 +607,7 @@ bool njsBaton::GetStringFromJSON(Local<Object> obj, const char *key, int index,
         return false;
 
     if (jsValue->IsString()) {
-        v8::String::Utf8Value utf8str(jsValue->ToString());
+        Nan::Utf8String utf8str(jsValue->ToString());
         value = std::string(*utf8str, static_cast<size_t>(utf8str.length()));
         return true;
     } else if (jsValue->IsUndefined()) {
@@ -711,7 +761,7 @@ bool njsCommon::GetStringArg(Nan::NAN_METHOD_ARGS_TYPE args,
         Nan::ThrowError(errMsg.c_str());
         return false;
     }
-    v8::String::Utf8Value utf8str(args[index]->ToString());
+    Nan::Utf8String utf8str(args[index]->ToString());
     value = std::string(*utf8str, static_cast<size_t>(utf8str.length()));
     return true;
 }
@@ -806,7 +856,7 @@ bool njsCommon::SetPropString(Local<Value> value, std::string *valuePtr,
         Nan::ThrowError(errMsg.c_str());
         return false;
     }
-    v8::String::Utf8Value utfstr(value->ToString());
+    Nan::Utf8String utfstr(value->ToString());
     *valuePtr = std::string(*utfstr, static_cast<size_t>(utfstr.length()));
     return true;
 }

package/src/njsCommon.h

@@ -72,6 +72,7 @@ using namespace node;
 class njsBaton;
 class njsOracledb;
 class njsProtoILob;
+class njsSubscription;
 
 //-----------------------------------------------------------------------------
 // njsBindDir
@@ -267,6 +268,8 @@ public:
     std::string connectString;
     std::string connClass;
     std::string edition;
+    std::string ipAddress;
+    std::string name;
     uint32_t poolMin;
     uint32_t poolMax;
     uint32_t poolIncrement;
@@ -276,6 +279,7 @@ public:
     dpiConn *dpiConnHandle;
     dpiStmt *dpiStmtHandle;
     dpiLob *dpiLobHandle;
+    dpiSubscr *dpiSubscrHandle;
     dpiStmtInfo stmtInfo;
     uint32_t stmtCacheSize;
     uint32_t lobPrefetchSize;
@@ -299,6 +303,7 @@ public:
     njsDataType *fetchAsBufferTypes;
     njsProtoILob *protoILob;
     bool externalAuth;
+    bool homogeneous;                 // True: one user, false: multiple user
     bool getRS;
     bool autoCommit;
     bool extendedMetaData;
@@ -313,32 +318,44 @@ public:
     uint64_t lobAmount;
     uint32_t numRowCounts;
     uint64_t *rowCounts;
+    uint32_t timeout;
+    uint32_t qos;
+    uint32_t operations;
     uint32_t numBatchErrorInfos;
     dpiErrorInfo *batchErrorInfos;
     dpiErrorInfo errorInfo;
     bool dpiError;
+    uint32_t portNumber;
+    uint32_t subscrGroupingClass;
+    uint32_t subscrGroupingValue;
+    uint32_t subscrGroupingType;
+    njsSubscription *subscription;
     njsCommon *callingObj;
     Nan::Persistent<Object> jsCallingObj;
     Nan::Persistent<Object> jsOracledb;
     Nan::Persistent<Object> jsBuffer;
+    Nan::Persistent<Object> jsSubscription;
     Nan::Persistent<Function> jsCallback;
 
     njsBaton(Local<Function> callback, Local<Object> callingObj) :
             poolMin(0), poolMax(0), poolIncrement(0), poolTimeout(0),
             poolPingInterval(0), dpiPoolHandle(NULL), dpiConnHandle(NULL),
-            dpiStmtHandle(NULL), dpiLobHandle(NULL), stmtCacheSize(0),
-            lobPrefetchSize(0), maxRows(0), bindArraySize(1),
+            dpiStmtHandle(NULL), dpiLobHandle(NULL), dpiSubscrHandle(NULL),
+            stmtCacheSize(0), lobPrefetchSize(0), maxRows(0), bindArraySize(1),
             fetchArraySize(0), privilege(0), rowsFetched(0), bufferRowIndex(0),
             rowsAffected(0), outFormat(0), numQueryVars(0), queryVars(NULL),
             numBindVars(0), bindVars(NULL), numFetchInfo(0), fetchInfo(NULL),
             numFetchAsStringTypes(0), fetchAsStringTypes(NULL),
             numFetchAsBufferTypes(0), fetchAsBufferTypes(NULL),
-            protoILob(NULL), externalAuth(false), getRS(false),
-            autoCommit(false), extendedMetaData(false), isReturning(false),
-            isPLSQL(false), events(false), batchErrors(false),
-            dmlRowCounts(false), bufferSize(0), bufferPtr(NULL), lobOffset(0),
-            lobAmount(0), numRowCounts(0), rowCounts(NULL),
-            numBatchErrorInfos(0), batchErrorInfos(NULL), dpiError(false) {
+            protoILob(NULL), externalAuth(false), homogeneous(true),
+            getRS(false), autoCommit(false), extendedMetaData(false),
+            isReturning(false), isPLSQL(false), events(false),
+            batchErrors(false), dmlRowCounts(false), bufferSize(0),
+            bufferPtr(NULL), lobOffset(0), lobAmount(0), numRowCounts(0),
+            rowCounts(NULL), timeout(0), qos(0), operations(0),
+            numBatchErrorInfos(0), batchErrorInfos(NULL), dpiError(false),
+            portNumber(0), subscrGroupingClass(0), subscrGroupingValue(0),
+            subscrGroupingType(0), subscription(NULL) {
         this->jsCallback.Reset(callback);
         this->jsCallingObj.Reset(callingObj);
         this->callingObj = Nan::ObjectWrap::Unwrap<njsCommon>(callingObj);
@@ -363,10 +380,13 @@ public:
     void SetDPIPoolHandle(dpiPool *handle);
     void SetDPIStmtHandle(dpiStmt *handle);
     void SetDPILobHandle(dpiLob *handle);
+    void SetDPISubscrHandle(dpiSubscr *handle);
 
     // methods for getting values from JSON
     bool GetBoolFromJSON(Local<Object> obj, const char *key, int index,
             bool *value);
+    bool GetFunctionFromJSON(Local<Object> obj, const char *key, int index,
+            Local<Function> *value);
     bool GetStringFromJSON(Local<Object> obj, const char *key, int index,
             string &value);
     bool GetPositiveIntFromJSON(Local<Object> obj, const char *key, int index,