Added changes to verify payload type against queue type

Author: sharadraju

doc/src/release_notes.rst

@@ -29,9 +29,12 @@ Common Changes
 #)  Fixed bug that threw empty error message when NaN values were used
     in JSON binds.
 
-#) Added support for :attr:`deqOptions.deliveryMode` in
+#)  Added support for :attr:`deqOptions.deliveryMode` in
     :ref:`Advanced Queuing <aq>`.
 
+#)  Added error ``NJS-174`` which is thrown if payload type does not match the
+    queue type in :ref:`Advanced Queuing <aq>`.
+
 Thin Mode Changes
 +++++++++++++++++
 

lib/aqDeqOptions.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2019, 2023, Oracle and/or its affiliates.
+// Copyright (c) 2019, 2025, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //

lib/aqQueue.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2019, 2024, Oracle and/or its affiliates.
+// Copyright (c) 2019, 2025, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -87,17 +87,20 @@ class AqQueue {
       }
     }
 
-    // validate payload
+    // validate payload/queue type compatibility
     if (this._isJson) {
       message.payload = transformer.transformJsonValue(payload);
-    } else if (typeof payload === 'string') {
+    } else if (typeof payload === 'string' || Buffer.isBuffer(payload)) {
       message.payload = Buffer.from(payload);
-    } else if (Buffer.isBuffer(payload)) {
-      message.payload = payload;
-    } else {
+    } else if (this._payloadType == types.DB_TYPE_OBJECT) {
+      if (!(payload instanceof BaseDbObject))
+        errors.throwErr(errors.ERR_PAYLOAD_CANNOT_BE_ENQUEUED);
       message.payload = payload._impl;
+    } else {
+      errors.throwErr(errors.ERR_PAYLOAD_CANNOT_BE_ENQUEUED);
     }
 
+
     // validate options, if applicable
     if (message.correlation !== undefined) {
       errors.assertParamPropValue(typeof message.correlation === 'string', 1,

lib/errors.js

@@ -179,6 +179,7 @@ const ERR_SESSIONLESS_DIFFERING_METHODS = 170;
 const ERR_SESSIONLESS_ALREADY_ACTIVE = 171;
 const ERR_SESSIONLESS_INACTIVE = 172;
 const ERR_INVALID_SERVER_RESPONSE = 173;
+const ERR_PAYLOAD_CANNOT_BE_ENQUEUED = 174;
 
 // Oracle Net layer errors start from 500
 const ERR_CONNECTION_CLOSED = 500;
@@ -261,6 +262,7 @@ adjustErrorXref.set("ORA-24344", WRN_COMPILATION_CREATE);
 adjustErrorXref.set("ORA-26202", ERR_SESSIONLESS_INACTIVE);
 adjustErrorXref.set("ORA-26211", ERR_SESSIONLESS_DIFFERING_METHODS);
 adjustErrorXref.set("ORA-26216", ERR_SESSIONLESS_ALREADY_ACTIVE);
+adjustErrorXref.set("DPI-1071", ERR_PAYLOAD_CANNOT_BE_ENQUEUED);
 
 // define mapping for error messages
 const messages = new Map();
@@ -542,6 +544,9 @@ messages.set(ERR_SESSIONLESS_INACTIVE,                  //NJS-172
   'No sessionless transaction is active');
 messages.set(ERR_INVALID_SERVER_RESPONSE,               //NJS-173
   'Invalid server response to connection request');
+messages.set(ERR_PAYLOAD_CANNOT_BE_ENQUEUED,            // NJS-174
+  "Payload cannot be enqueued since it does not match the payload type supported by the queue");
+
 
 // Oracle Net layer errors
 
@@ -1003,6 +1008,7 @@ module.exports = {
   ERR_SESSIONLESS_ALREADY_ACTIVE,
   ERR_SESSIONLESS_INACTIVE,
   ERR_INVALID_SERVER_RESPONSE,
+  ERR_PAYLOAD_CANNOT_BE_ENQUEUED,
   ERR_CONNECTION_CLOSED_CODE: `${ERR_PREFIX}-${ERR_CONNECTION_CLOSED}`,
   ERR_OPERATION_NOT_SUPPORTED_ON_BFILE,
   ERR_OPERATION_ONLY_SUPPORTED_ON_BFILE,

src/njsAqDeqOptions.c

@@ -1,4 +1,4 @@
-// Copyright (c) 2019, 2022, Oracle and/or its affiliates.
+// Copyright (c) 2019, 2025, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //

test/aq2.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2024, Oracle and/or its affiliates. */
+/* Copyright (c) 2024, 2025, Oracle and/or its affiliates. */
 
 /******************************************************************************
  *
@@ -172,10 +172,10 @@ describe('218. aq2.js', function() {
         const message = new objClass(addrData);
         await queue1.enqOne(message);
       },
-      /DPI-1071/
+      /NJS-174/
     );
-    // DPI-1071: payload type in message properties must match
-    // the payload type of the queue
+    /* NJS-174: Payload cannot be enqueued since it does not match the payload
+    type supported by the queue */
   }); // 218.4
 
   it('218.5 Enqueue a DB object as payload attribute', async () => {