@itentialopensource/adapter-db_oracle 0.3.3 → 0.3.5

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.3.4 [08-25-2024]
+
+* update dependencies and metadata
+
+See merge request itentialopensource/adapters/adapter-db_oracle!12
+
+---
+
 ## 0.3.3 [08-14-2024]
 
 * Changes made at 2024.08.14_19:29PM

package/TAB2.md

@@ -43,8 +43,8 @@ Sample Properties can be used to help you configure the adapter in the Itential
     "host": "localhost",
     "port": 3306,
     "authentication": {
-      "username": "your username",
-      "password": "your password"
+      "username": "username",
+      "password": "password"
     }
   }
 ```

package/adapter.js

@@ -94,6 +94,25 @@ function formatErrorObject(origin, type, variables, sysCode, sysRes, stack) {
   return errorObject;
 }
 
+/**
+ * @summary Check if connection error
+ *
+ * @function isConnectionError
+ * @param {object} error - error from Oracle
+ *
+ * @return {boolean} - the result of error type checking
+ */
+
+function isConnectionError(error) {
+  return error && (
+    error.code === 'NJS-003'
+    || error.code === 'NJS-500'
+    || error.code === 'NJS-040'
+    || error.code === 'NJS-521'
+    || error.message.includes('connect')
+  );
+}
+
 class Oracle extends EventEmitter {
   constructor(prongid, properties) {
     log.trace('adapter oracle loading');
@@ -136,6 +155,16 @@ class Oracle extends EventEmitter {
       connectString: `${this.props.host}:${this.props.port}/${this.props.database}`
     };
 
+    this.connAttrs = connAttrs;
+
+    if (this.props.databaseConnection === 'connect on request') {
+      return this.emit('ONLINE', {
+        id: this.id
+      });
+    }
+
+    log.debug('Connecting to Oracle Database with provided auth and connectString');
+
     // Get connection
     oracle.getConnection(connAttrs, (error, gotConn) => {
       // Emit online if on stub mode
@@ -269,6 +298,7 @@ class Oracle extends EventEmitter {
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
+    let oracleConnection;
     try {
       // verify the required data has been provided
       if (!sql) {
@@ -277,24 +307,66 @@ class Oracle extends EventEmitter {
         return callback(null, errorObj);
       }
 
-      // query connection
-      this.connection.execute(sql, (error, results) => {
-        // close connection
-        // this.connection.end();
-        log.debug(`result from query: ${JSON.stringify(results)}`);
-
-        if (error) {
-          const errorObj = formatErrorObject(origin, 'Database Error', [error], null, null, null);
-          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-          return callback(null, errorObj);
-        }
-
-        return callback({
-          status: 'success',
-          code: 200,
-          response: results
+      const executeQuery = (connection, retry = false) => {
+        connection.execute(sql, async (exErr, results) => {
+          try {
+            if (connection && this.props.databaseConnection === 'connect on request') {
+              this.alive = false;
+              await connection.close();
+            }
+
+            if (exErr) {
+              // If connect on startup and get connection error, attempt to reconnect to Oracle Database and execute the query again
+              if (retry && isConnectionError(exErr)) {
+                log.warn(`${origin}: Connection error detected, attempting to reconnect to Oracle Database...`);
+                oracle.getConnection(this.connAttrs, (connErr, gotConn) => {
+                  if (connErr) {
+                    const errorObj = formatErrorObject(origin, 'Oracle Database connection failed', null, null, null, null);
+                    log.error(`${origin}: Error connecting to Oracle - ${connErr}`);
+                    return callback(null, errorObj);
+                  }
+                  this.connection = gotConn;
+                  // Only retry once so retry flag is set to false
+                  executeQuery(this.connection);
+                });
+              } else {
+                // If connect on request or connect on startup with nonconnection error, just return the error
+                const errorObj = formatErrorObject(origin, 'Database Error', [exErr], null, null, null);
+                log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+                return callback(null, errorObj);
+              }
+            } else {
+              log.debug(`result from query: ${JSON.stringify(results)}`);
+              return callback({
+                status: 'success',
+                code: 200,
+                response: results
+              });
+            }
+          } catch (e) {
+            const errorObj = formatErrorObject(origin, 'Caught Exception', null, null, null, e);
+            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+            return callback(null, errorObj);
+          }
         });
-      });
+      };
+
+      if (this.props.databaseConnection === 'connect on request') {
+        log.debug(`${origin}: Connecting to Oracle Database`);
+
+        oracle.getConnection(this.connAttrs, (error, gotConn) => {
+          if (error) {
+            const errorObj = formatErrorObject(origin, 'Oracle Database connection failed', null, null, null, null);
+            log.error(`${origin}: Error connecting to Oracle - ${error}`);
+            return callback(null, errorObj);
+          }
+          this.alive = true;
+          oracleConnection = gotConn;
+          executeQuery(oracleConnection);
+        });
+      } else {
+        executeQuery(this.connection, true);
+      }
     } catch (ex) {
       const errorObj = formatErrorObject(origin, 'Caught Exception', null, null, null, ex);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);

package/metadata.json

@@ -1,8 +1,10 @@
 {
   "name": "adapter-db_oracle",
   "webName": "Adapter for Integration to Oracle Database",
+  "supportLevel": "community",
   "vendor": "Oracle",
   "product": "Oracle DB",
+  "techAlliance": false,
   "osVersion": [],
   "apiVersions": [],
   "iapVersions": [
@@ -38,7 +40,7 @@
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-db_oracle",
     "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-db_oracle",
-    "docLink": "",
+    "docLink": "https://gitlab.com/itentialopensource/adapters/adapter-db_oracle/-/blob/master/README.md?ref_type=heads",
     "demoLinks": [],
     "trainingLinks": [
       {
@@ -75,7 +77,5 @@
     "workflowProjects": [],
     "transformationProjects": [],
     "exampleProjects": []
-  },
-  "supportLevel": "community",
-  "techAlliance": false
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-db_oracle",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "Itential adapter to connect to oracle",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
@@ -43,7 +43,7 @@
   "dependencies": {
     "ajv": "^8.17.1",
     "fs-extra": "^11.2.0",
-    "oracledb": "^4.0.1",
+    "oracledb": "6.6.0",
     "readline-sync": "^1.4.10",
     "uuid": "^3.1.0"
   },

package/propertiesSchema.json

@@ -26,6 +26,15 @@
       "minimum": 1,
       "maximum": 65535
     },
+    "databaseConnection": {
+      "type": "string",
+      "description": "Establish single connection to oracle db upon adapter start or new connection to oracle db upon each database request",
+      "default": "connect on startup",
+      "enum": [
+        "connect on startup",
+        "connect on request"
+      ]
+    },
     "authentication": {
       "$ref":"#/definitions/authentication"
     }

package/sampleProperties.json

@@ -6,8 +6,8 @@
     "host": "localhost",
     "port": 3306,
     "authentication": {
-      "username": "your username",
-      "password": "your password"
+      "username": "username",
+      "password": "password"
     }
   },
   "groups": [],

package/test/integration/adapterTestIntegration.js

@@ -25,7 +25,7 @@ const attemptTimeout = 10000;
 // always check these in with bogus data!!!
 const host = 'localhost';
 const username = 'your username';
-const password = 'your password';
+const usepass = 'your password';
 const port = 3306;
 const sslenable = false;
 const sslinvalid = false;
@@ -46,7 +46,7 @@ global.pronghornProps = {
         port,
         authentication: {
           username,
-          password
+          password: usepass
         },
         ssl: {
           enabled: sslenable,

package/compliance-report.json

@@ -1,9 +0,0 @@
-{
-  "ComplianceEntries": [
-    {
-      "name": "Compliance Summary",
-      "numInvalidProjects": 0,
-      "numValidProjects": 0
-    }
-  ]
-}

package/compliance-report.txt

@@ -1,5 +0,0 @@
----------------------------------------------------------------------------------------------
-**** Project Compliance Summary ****
-0 project(s) are not valid
-0 project(s) are valid
----------------------------------------------------------------------------------------------