oracledb 2.1.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

@@ -2,9 +2,9 @@
 
 This directory contains scripts for building, extracting and
 installing binary packages of node-oracledb.  Most users do not need
-to use anything in this directory (the exception is when doing a
-[manual
-install](https://github.com/oracle/node-oracledb/blob/master/INSTALL.md#offline)
+to use anything in this directory (the exceptions are when building
+packages for self-hosting, or when doing a [manual
+install](https://oracle.github.io/node-oracledb/INSTALL.html#manualextraction)
 instead of using `npm`).
 
 The binary install process requires two kinds of package:
@@ -35,7 +35,7 @@ binary.
 If a suitable binary package is not available, users must compile
 source code by installing from GitHub.
 
-Installation is described in [INSTALL](../INSTALL.md).
+Installation is described in [INSTALL](https://oracle.github.io/node-oracledb/INSTALL.html).
 
 # Maintainers
 
@@ -76,7 +76,7 @@ Installation is described in [INSTALL](../INSTALL.md).
     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](../INSTALL.md).
   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](../INSTALL.md).
 - 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/createpackage.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -180,7 +180,7 @@ function createPackage() {
     })
     .catch(err => {
       console.log('Error creating package', err);
-    })
+    });
 }
 
 createPackage();

package/package/extractpackage.js

@@ -20,7 +20,8 @@
  *
  * DESCRIPTION
  *   This script is a command-line interface to extract node-oracledb
- *   binaries from an available binary package, see INSTALL.md.
+ *   binaries from an available binary package, see
+ *   https://oracle.github.io/node-oracledb/INSTALL.html
  *
  * USAGE
  *   Run this script like:

package/package/oracledbinstall.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -38,8 +38,6 @@ const http = require('http'); // Fails in old Node.js. Use Node 4+
 const https = require('https');
 const fs = require('fs');
 const url = require('url');
-const stream = require('stream');
-const zlib = require('zlib');
 const packageUtil = require('./util.js');
 
 packageUtil.initDynamicProps();
@@ -124,8 +122,6 @@ function verifyBinary() {
     packageUtil.log('Verifying installation');
 
     if (!fs.existsSync(packageUtil.BINARY_PATH_LOCAL)) {
-      packageUtil.log('Binary not found');
-
       resolve(false);
       return;
     }
@@ -181,7 +177,7 @@ function getRemoteFileReadStream(hostname, path) {
   const proxyConfig = getProxyConfig(hostname);
 
   if (proxyConfig.useProxy) {
-    return getFileReadStreamByProxy(hostname, path, proxyConfig.hostname, proxyConfig.port)
+    return getFileReadStreamByProxy(hostname, path, proxyConfig.hostname, proxyConfig.port);
   } else {
     return getFileReadStreamBase(hostname, path);
   }
@@ -200,7 +196,7 @@ function getFileReadStreamByProxy(hostname, path, proxyHostname, proxyPort) {
       method: 'CONNECT',
       path: hostname + ':' + PORT,
       headers: {
-        'host': hostname + PORT,
+        'host': hostname + ':' + PORT,
       }
     });
 
@@ -211,12 +207,12 @@ function getFileReadStreamByProxy(hostname, path, proxyHostname, proxyPort) {
 
     req.on('connect', function(res, socket) {
       if (res.statusCode >= 300 && res.statusCode < 400) {  // warning: proxy redirection code is untested
-       const redirectUrl = url.parse(res.headers.location);
+        const redirectUrl = url.parse(res.headers.location);
 
-       proxyHostname = redirectUrl.hostname;
-       proxyPort  = redirectUrl.port;
+        proxyHostname = redirectUrl.hostname;
+        proxyPort  = redirectUrl.port;
 
-       return getFileReadStreamByProxy(hostname, path, proxyHostname, proxyPort);
+        return getFileReadStreamByProxy(hostname, path, proxyHostname, proxyPort);
       } else if (res.statusCode !== 200) {
         reject(new Error('Error: HTTP proxy request for ' + hostname + path + ' failed with code ' + res.statusCode));
         return;
@@ -339,16 +335,20 @@ function installBinary() {
 
 // The done function is used to print concluding messages and quit.
 function done(err, alreadyInstalled) {
-  const installUrl = 'https://github.com/oracle/node-oracledb/blob/master/INSTALL.md';
+  const installUrl = 'https://oracle.github.io/node-oracledb/INSTALL.html';
 
   if (err) {
-    packageUtil.error('NJS-054: Binary build/Release/oracledb.node was not installed from ' + packageUtil.dynamicProps.PACKAGE_FILE_NAME);
+    packageUtil.error('NJS-054: Binary build/Release/oracledb.node was not installed.');
+    if (['darwin', 'win32', 'linux'].indexOf(process.platform) < 0) {
+      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 (['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);
     packageUtil.error(err.message);
-    packageUtil.error('If the error is not network or filesystem related, then review ');
-    packageUtil.error('the Python 2.7 and compiler prerequisites in the installation instructions and');
-    packageUtil.error('then install from source code with: npm install oracle/node-oracledb.git#' + packageUtil.dynamicProps.GITHUB_TAG);
-    packageUtil.error('See ' + installUrl, '\n');
-
+    packageUtil.error('For help see ' + installUrl + '#troubleshooting\n');
     process.exit(87);
   } else {
     let arch;
@@ -436,7 +436,7 @@ function install() {
         return new Promise((resolve, reject) => {
           installBinary()
             .then(() => {
-              packageUtil.log('Oracledb installed');
+              packageUtil.log('Oracledb downloaded');
 
               return verifyBinary();
             })

package/package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "oracledb",
-  "version": "2.1.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://www.oracle.com/technetwork/database/database-technologies/scripting-languages/node_js/",
+  "homepage": "http://oracle.github.io/node-oracledb/",
   "keywords": [
     "Oracle",
     "Database",
@@ -36,7 +36,7 @@
   "scripts": {
     "install": "node package/oracledbinstall.js",
     "test": "mocha --opts test/opts/mocha.opts",
-    "posttest": "node examples/version.js"
+    "posttest": "node test/opts/version.js"
   },
   "engines": {
     "node": ">=4"

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "oracledb",
-  "version": "2.1.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://www.oracle.com/technetwork/database/database-technologies/scripting-languages/node_js/",
+  "homepage": "http://oracle.github.io/node-oracledb/",
   "keywords": [
     "Oracle",
     "Database",
@@ -36,7 +36,7 @@
   "scripts": {
     "install": "node package/oracledbinstall.js",
     "test": "mocha --opts test/opts/mocha.opts",
-    "posttest": "node examples/version.js"
+    "posttest": "node test/opts/version.js"
   },
   "engines": {
     "node": ">=4"

package/src/njsCommon.cpp

@@ -52,11 +52,26 @@
 #include "njsCommon.h"
 #include "njsOracle.h"
 #include "njsIntLob.h"
+#include "njsSubscription.h"
 
 using namespace node;
 using namespace std;
 using namespace v8;
 
+//-----------------------------------------------------------------------------
+// njsVariableBuffer::~njsVariableBuffer()
+//   Destructor.
+//-----------------------------------------------------------------------------
+njsVariableBuffer::~njsVariableBuffer()
+{
+    if (lobs) {
+        delete [] lobs;
+        lobs = NULL;
+    }
+    dpiVarData = NULL;
+}
+
+
 //-----------------------------------------------------------------------------
 // njsVariable::~njsVariable()
 //   Destructor.
@@ -66,11 +81,10 @@ njsVariable::~njsVariable()
     if (dpiVarHandle) {
         dpiVar_release(dpiVarHandle);
         dpiVarHandle = NULL;
-        dpiVarData = NULL;
     }
-    if (lobs) {
-        delete [] lobs;
-        lobs = NULL;
+    if (dmlReturningBuffers) {
+        delete [] dmlReturningBuffers;
+        dmlReturningBuffers = NULL;
     }
     if (queryVars) {
         delete [] queryVars;
@@ -180,6 +194,7 @@ njsBaton::~njsBaton()
     jsCallback.Reset();
     jsCallingObj.Reset();
     jsOracledb.Reset();
+    jsSubscription.Reset();
     jsBuffer.Reset();
     ClearAsyncData();
 }
@@ -196,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();
     }
@@ -226,6 +241,10 @@ void njsBaton::ClearAsyncData()
         dpiLob_release(dpiLobHandle);
         dpiLobHandle = NULL;
     }
+    if (dpiSubscrHandle) {
+        dpiSubscr_release(dpiSubscrHandle);
+        dpiSubscrHandle = NULL;
+    }
     if (bindVars) {
         delete [] bindVars;
         bindVars = NULL;
@@ -255,6 +274,11 @@ void njsBaton::ClearAsyncData()
         fetchAsBufferTypes = NULL;
         numFetchAsBufferTypes = 0;
     }
+    if (batchErrorInfos) {
+        delete [] batchErrorInfos;
+        batchErrorInfos = NULL;
+        numBatchErrorInfos = 0;
+    }
 }
 
 
@@ -339,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;
@@ -422,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.
@@ -461,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
@@ -539,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()) {
@@ -591,6 +659,22 @@ bool njsBaton::GetUnsignedIntFromJSON(Local<Object> obj, const char *key,
 }
 
 
+//-----------------------------------------------------------------------------
+// njsBaton::GetNumOutBinds()
+//   Return the number of in/out and out binds created by the baton.
+//-----------------------------------------------------------------------------
+uint32_t njsBaton::GetNumOutBinds()
+{
+    uint32_t numOutBinds = 0;
+
+    for (uint32_t i = 0; i < numBindVars; i++) {
+        if (bindVars[i].bindDir != NJS_BIND_IN)
+            numOutBinds++;
+    }
+    return numOutBinds;
+}
+
+
 //-----------------------------------------------------------------------------
 // njsBaton::QueueWork()
 //   Queue work on a separate thread. The baton is passed as context. If an
@@ -677,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;
 }
@@ -772,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;
 }