Add Oracle Database Error Help Portal URL to ORA error messages

Author: sharadraju

doc/src/release_notes.rst

@@ -66,6 +66,10 @@ Thin Mode Changes
     in Thin mode instead of throwing an error. `Issue #1582
     <https://github.com/oracle/node-oracledb/issues/1582>`__.
 
+#) Added support to expose database error cause/action URL in error messages.
+   For ORA errors etc., the ERROR cause/action URL for that error code will
+   be provided along with error message.
+
 Thick Mode Changes
 ++++++++++++++++++
 

lib/errors.js

@@ -608,6 +608,15 @@ function transformErr(err, fnOpt) {
     const pos = err.message.indexOf(":");
     if (pos > 0) {
       err.code = err.message.substr(0, pos);
+      /* add Oracle Database Error Help Portal URL for database error
+         messages, but only in thin mode since this is done
+         automatically in thick mode with Oracle Client 23c and higher
+      */
+      const settings = require('./settings.js');
+      if (err.errorNum && settings.thin) {
+        err.message += '\n' + 'Help: https://docs.oracle.com/error-help/db/ora-' +
+          `${err.errorNum.toString().padStart(5, '0')}/`;
+      }
       if (adjustErrorXref.has(err.code)) {
         let args = [];
         let driverErrorNum;

test/errorUrl.js

@@ -0,0 +1,64 @@
+/* Copyright (c) 2023, Oracle and/or its affiliates. */
+
+/******************************************************************************
+ *
+ * This software is dual-licensed to you under the Universal Permissive License
+ * (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+ * 2.0 as shown at https://www.apache.org/licenses/LICENSE-2.0. You may choose
+ * either license.
+ *
+ * If you elect to accept the software under the Apache License, Version 2.0,
+ * the following applies:
+ *
+ * Licensed under the Apache License, Version 2.0 (the `License`);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://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
+ *   284. errorUrl.js
+ *
+ * DESCRIPTION
+ *   This test verifies enhancement to expose error portal URL in error message
+ *
+ *****************************************************************************/
+'use strict';
+
+const oracledb = require('oracledb');
+const assert   = require('assert');
+const dbConfig = require('./dbconfig.js');
+const testsUtil = require('./testsUtil.js');
+
+describe('284. errorUrl.js', function() {
+
+  let conn;
+  before(async function() {
+    conn = await oracledb.getConnection(dbConfig);
+    if (testsUtil.getClientVersion() < 2301000000) {
+      this.skip();
+    }
+  });
+
+  after(async () => {
+    await conn.close();
+  });
+
+  it('284.1 checks for error URL in ORA error message', async () => {
+    const url = /https:\/\/docs.oracle.com\/error-help\/db\/ora-01476\//;
+    await assert.rejects(
+      async () => await conn.execute(`SELECT 1/0 FROM DUAL`),
+      (err) => {
+        assert.match(err.message, url);
+        return true;
+      }
+    );
+  }); // 284.1
+
+});

test/list.txt

@@ -5485,3 +5485,6 @@ oracledb.OUT_FORMAT_OBJECT and resultSet =  true
 
 283.aq5.js
     283.1 subscribe dequeue messages
+
+284. errorUrl.js
+    284.1 checks for error URL in ORA error message

test/opts/.mocharc.yaml

@@ -265,3 +265,5 @@ spec:
   - test/pipelinedTables.js
   - test/aq6.js
   - test/aq7.js
+  - test/aq5.js
+  - test/errorUrl.js