Feat[BMQT]: better verbosity for bmqt::QueueId::isValid [180624984] (#913)

Signed-off-by: Evgeny Malygin <[email protected]>
Signed-off-by: Evgenii Malygin <[email protected]>

Author: 678098

src/groups/bmq/bmqa/bmqa_queueid.cpp

@@ -126,12 +126,12 @@ const bmqt::QueueOptions& QueueId::options() const
     return d_impl_sp->options();
 }
 
-bool QueueId::isValid() const
+bool QueueId::isValid(bsl::ostream* reason_p) const
 {
     // PRECONDITIONS
     BSLS_ASSERT_SAFE(d_impl_sp);
 
-    return d_impl_sp->isValid();
+    return d_impl_sp->isValid(reason_p);
 }
 
 bsl::ostream&

src/groups/bmq/bmqa/bmqa_queueid.h

@@ -128,9 +128,12 @@ class QueueId {
     /// Return the options used when opening this queue.
     const bmqt::QueueOptions& options() const;
 
-    /// Return whether this QueueId is valid, i.e., is associated to an
-    /// opened queue.
-    bool isValid() const;
+    /// @brief Return whether this QueueId is valid, i.e., is associated to an
+    ///        opened queue.
+    /// @param reason_p The optionally specified stream that is used to report
+    ///                 the reason why this QueueId is not valid.
+    /// @return bool True if this QueueId is valid, false otherwise.
+    bool isValid(bsl::ostream* reason_p = 0) const;
 
     /// Format this object to the specified output `stream` at the (absolute
     /// value of) the optionally specified indentation `level` and return a

src/groups/bmq/bmqa/bmqa_queueid.t.cpp

@@ -24,6 +24,7 @@
 #include <bmqt_queueoptions.h>
 #include <bmqt_resultcode.h>
 #include <bmqt_uri.h>
+#include <bmqu_memoutstream.h>
 
 // BDE
 #include <bsl_memory.h>
@@ -64,7 +65,9 @@ static void test1_breathingTest()
     PV("Default Constructor");
     {
         bmqa::QueueId obj(bmqtst::TestHelperUtil::allocator());
-        BMQTST_ASSERT_EQ(obj.isValid(), false);
+        bmqu::MemOutStream reason(bmqtst::TestHelperUtil::allocator());
+        BMQTST_ASSERT_EQ(obj.isValid(&reason), false);
+        BMQTST_ASSERT_EQ(reason.str(), "Invalid QueueId: 4294967295");
     }
 
     PV("Valued Constructor - correlationId");

src/groups/bmq/bmqa/bmqa_session.cpp

@@ -582,8 +582,7 @@ SessionUtil::validateAndSetConfigureQueueParameters(
     }
 
     // Make sure the provided QueueId is valid
-    if (!queueId->isValid()) {
-        (*errorDescription) << "Invalid QueueId";
+    if (!queueId->isValid(errorDescription)) {
         return bmqt::ConfigureQueueResult::e_INVALID_QUEUE;  // RETURN
     }
 
@@ -618,8 +617,7 @@ bmqt::CloseQueueResult::Enum SessionUtil::validateAndSetCloseQueueParameters(
     }
 
     // Make sure the provided QueueId is valid
-    if (!queueId->isValid()) {
-        (*errorDescription) << "Invalid QueueId";
+    if (!queueId->isValid(errorDescription)) {
         return bmqt::CloseQueueResult::e_INVALID_QUEUE;  // RETURN
     }
 

src/groups/bmq/bmqimp/bmqimp_queue.h

@@ -381,9 +381,12 @@ class Queue {
 
     bmqp::SchemaGenerator& schemaGenerator();
 
-    /// Return whether this Queue is valid, i.e., is associated to an
-    /// initialized queue.
-    bool isValid() const;
+    /// @brief Return whether this Queue is valid, i.e., is associated to an
+    ///        opened queue.
+    /// @param reason_p The optionally specified stream that is used to report
+    ///                 the reason why this Queue is not valid.
+    /// @return bool True if this Queue is valid, false otherwise.
+    bool isValid(bsl::ostream* reason_p = 0) const;
 
     /// Return whether this Queue is valid, i.e., is associated to an opened
     /// queue.
@@ -677,15 +680,26 @@ inline bmqp::SchemaGenerator& Queue::schemaGenerator()
     return d_schemaGenerator;
 }
 
-inline bool Queue::isValid() const
+inline bool Queue::isValid(bsl::ostream* reason_p) const
 {
     const QueueState::Enum queueState = state();
-    return ((d_handleParameters.qId() !=
-             static_cast<unsigned int>(k_INVALID_QUEUE_ID)) &&
-            (queueState == QueueState::e_OPENED ||
-             queueState == QueueState::e_PENDING ||
-             queueState == QueueState::e_REOPENING_OPN ||
-             queueState == QueueState::e_REOPENING_CFG));
+    if (d_handleParameters.qId() ==
+        static_cast<unsigned int>(k_INVALID_QUEUE_ID)) {
+        if (reason_p) {
+            (*reason_p) << "Invalid QueueId: " << d_handleParameters.qId();
+        }
+        return false;  // RETURN
+    }
+    const bool queueStateIsValid = (queueState == QueueState::e_OPENED ||
+                                    queueState == QueueState::e_PENDING ||
+                                    queueState ==
+                                        QueueState::e_REOPENING_OPN ||
+                                    queueState == QueueState::e_REOPENING_CFG);
+
+    if (!queueStateIsValid && reason_p) {
+        (*reason_p) << "Invalid queue state: " << queueState;
+    }
+    return queueStateIsValid;
 }
 
 inline bool Queue::isOpened() const