Capture the error stack

Author: cjbj

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 **This release is under development and information may be incomplete**
 
+- Added code to capture the error stack. PR#1467 (Slawomir Osoba)
+
 - Added code to keep the method name in internally bound functions.
   PR #1466 (Slawomir Osoba)
 

lib/util.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved
 
 //-----------------------------------------------------------------------------
 //
@@ -175,7 +175,10 @@ function callbackify(func) {
     // if last argument is not a function, simply invoke the function as usual
     // and a promise will be returned
     if (typeof arguments[arguments.length - 1] !== 'function') {
-      return func.apply(this, arguments);
+      return func.apply(this, arguments).catch(function stackCapture(e) {
+        Error.captureStackTrace(e, stackCapture);
+        throw e;
+      });
     }
 
     // otherwise, resolve or reject the promise and invoke the callback

test/asyncStack.js

@@ -0,0 +1,89 @@
+/* Copyright (c) 2022, Oracle and/or its affiliates. */
+
+/******************************************************************************
+ *
+ * You may not use the identified files except in compliance with the Apache
+ * License, Version 2.0 (the "License.")
+ *
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * NAME
+ *   263. asyncStack.js
+ *
+ * DESCRIPTION
+ *   Test keeping a stacktrace in asynchronous methods.
+ *
+ *****************************************************************************/
+'use strict';
+
+const oracledb = require('oracledb');
+const assert = require('assert');
+
+
+
+const asyncMiddleware = async () => {
+  await oracledb.getConnection({connectString: 'doesnotexist.oracle.com'});
+};
+
+describe('263. asyncStack.js', () => {
+
+  it('263.1 stack on error in getConnection', async () => {
+    try {
+      await asyncMiddleware();
+    } catch (e) {
+      assert.strictEqual(e.errorNum, 12154); // TNS:could not resolve the connect identifier specified
+      assert.ok(e.stack.includes('asyncStack.js:33:'), e.stack);
+      assert.ok(e.stack.includes('asyncStack.js:40:'), e.stack);
+    }
+  });
+
+  it('263.2 stack on error in createPool', async () => {
+    let pool = null;
+    const dbconfig =  {
+      user          : "asterix",
+      password      : "oblix",
+      connectString : 'doesnotexist.oracle.com',
+      poolMin       : 1,
+      poolMax       : 50,
+      poolIncrement :  5
+    };
+
+    try {
+      pool = await oracledb.createPool(dbconfig);
+    } catch (e) {
+      assert.strictEqual(e.errorNum, 12154);
+      assert.ok(e.stack.includes('asyncStack.js:60:'), e.stack);
+    } finally {
+      if (pool) {
+        await pool.close ();
+      }
+    }
+
+  });
+
+  it('263.3 stack on error in execute', async () => {
+    const dbconfig = {
+      user          : process.env.NODE_ORACLEDB_USER,
+      password      : process.env.NODE_ORACLEDB_PASSWORD,
+      connectString : process.env.NODE_ORACLEDB_CONNECTIONSTRING
+    };
+
+    try {
+      const conn = await oracledb.getConnection(dbconfig);
+      await conn.execute("SELECT * FROM NON_EXISTENT_TABLE");
+    } catch (e)  {
+      assert.strictEqual(e.errorNum, 942);
+      assert.ok(e.stack.includes('asyncStack.js:81:'), e.stack);
+    }
+
+  });
+
+});

test/list.txt

@@ -5300,6 +5300,10 @@ oracledb.OUT_FORMAT_OBJECT and resultSet =  true
 262. dbObjectOutBind.js
     262.1 call procedure with 2 OUT binds of DbObject
 
+263. asyncStack.js
+    263.1 stack on error in getConnection
+    263.2 stack on error in createPool
+    263.3 stack on error in execute
 
 264. methodName.js
     264.1 check for methodName getConnection

test/opts/.mocharc.yaml

@@ -249,4 +249,5 @@ spec:
   - test/tpcResume.js
   - test/connHealthy.js
   - test/dbObjectOutBind.js
+  - test/asyncStack.js
   - test/methodName.js