Fix[bmqio]: return peerUri by value to eliminate data race

Signed-off-by: Srinath Satuluri <satulurisrinath@gmail.com>

Author: SrinathhSatuluri

src/groups/bmq/bmqio/bmqio_channel.h

@@ -219,7 +219,7 @@ class Channel {
 
     /// Return the URI of the "remote" end of this channel.  It is up to the
     /// underlying implementation to define the format of the returned URI.
-    virtual const bsl::string& peerUri() const = 0;
+    virtual bsl::string peerUri() const = 0;
 
     /// Return a reference providing modifiable access to the properties of
     /// this Channel.

src/groups/bmq/bmqio/bmqio_decoratingchannelpartialimp.h

@@ -100,7 +100,7 @@ class DecoratingChannelPartialImp : public Channel {
     Channel* base() const;
 
     // Channel
-    const bsl::string& peerUri() const BSLS_KEYWORD_OVERRIDE;
+    bsl::string peerUri() const BSLS_KEYWORD_OVERRIDE;
 
     /// Forward to the underlying base `Channel`.
     const bmqvt::PropertyBag& properties() const BSLS_KEYWORD_OVERRIDE;
@@ -177,7 +177,7 @@ inline Channel* DecoratingChannelPartialImp::base() const
     return d_base.get();
 }
 
-inline const bsl::string& DecoratingChannelPartialImp::peerUri() const
+inline bsl::string DecoratingChannelPartialImp::peerUri() const
 {
     return d_base->peerUri();
 }

src/groups/bmq/bmqio/bmqio_ntcchannel.cpp

@@ -1342,8 +1342,9 @@ ntsa::Endpoint NtcChannel::sourceEndpoint() const
                              : ntsa::Endpoint();
 }
 
-const bsl::string& NtcChannel::peerUri() const
+bsl::string NtcChannel::peerUri() const
 {
+    bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
     return d_peerUri;
 }
 

src/groups/bmq/bmqio/bmqio_ntcchannel.h

@@ -423,7 +423,7 @@ class NtcChannel : public bmqio::Channel,
 
     /// Return the URI of the "remote" end of this channel.  It is up to the
     /// underlying implementation to define the format of the returned URI.
-    const bsl::string& peerUri() const BSLS_KEYWORD_OVERRIDE;
+    bsl::string peerUri() const BSLS_KEYWORD_OVERRIDE;
 
     /// Return a reference providing modifiable access to the properties of
     /// this Channel.

src/groups/bmq/bmqio/bmqio_ntcchannel.t.cpp

@@ -88,7 +88,7 @@ void executeOnClosedChannelFunc(bmqio::NtcChannel*              channel,
     BSLA_MAYBE_UNUSED ntsa::Endpoint peerEndpoint = channel->peerEndpoint();
     BSLA_MAYBE_UNUSED ntsa::Endpoint sourceEndpoint =
         channel->sourceEndpoint();
-    BSLA_MAYBE_UNUSED const bsl::string& peerUri     = channel->peerUri();
+    BSLA_MAYBE_UNUSED bsl::string peerUri            = channel->peerUri();
     BSLA_MAYBE_UNUSED bmqvt::PropertyBag& properties = channel->properties();
 
     channel->setChannelId(id);

src/groups/bmq/bmqio/bmqio_ntcchannelfactory.t.cpp

@@ -1051,7 +1051,7 @@ void Tester::checkChannelUri(int                      line,
         return;  // RETURN
     }
 
-    bslstl::StringRef uri = info.d_channel->peerUri();
+    bsl::string uri = info.d_channel->peerUri();
     BMQTST_ASSERT_EQ_D(line,
                        uri.data(),
                        bdlb::StringRefUtil::strstr(uri, prefix).data());

src/groups/bmq/bmqio/bmqio_resolvingchannelfactory.cpp

@@ -95,12 +95,13 @@ ResolvingChannelFactory_Channel::ResolvingChannelFactory_Channel(
     bslma::Allocator*               basicAllocator)
 : DecoratingChannelPartialImp(channel, basicAllocator)
 , d_resolvedPeerUri(basicAllocator)
+, d_basePeerUri(channel->peerUri(), basicAllocator)
 , d_peerUri()
 {
     // PRECONDITIONS
     BSLS_ASSERT(channel);
 
-    d_peerUri = &channel->peerUri();
+    d_peerUri = &d_basePeerUri;
 }
 
 // MANIPULATORS
@@ -117,7 +118,7 @@ void ResolvingChannelFactory_Channel::updatePeerUri()
 }
 
 // ACCESSORS
-const bsl::string& ResolvingChannelFactory_Channel::peerUri() const
+bsl::string ResolvingChannelFactory_Channel::peerUri() const
 {
     return *d_peerUri;
 }
@@ -235,7 +236,7 @@ void ResolvingChannelFactoryUtil::defaultResolutionFn(
     const ResolveFn& resolveFn,
     bool             verbose)
 {
-    bslstl::StringRef peerUri = baseChannel.peerUri();
+    bsl::string       peerUri = baseChannel.peerUri();
     bslstl::StringRef colon   = bdlb::StringRefUtil::strstr(peerUri, ":");
     if (colon.length() == 0) {
         if (verbose) {
@@ -248,7 +249,7 @@ void ResolvingChannelFactoryUtil::defaultResolutionFn(
 
     bdlma::LocalSequentialAllocator<128> arena;
 
-    bsl::string     ipAddrStr(peerUri.data(), colon.data(), &arena);
+    bsl::string     ipAddrStr(peerUri.c_str(), colon.data(), &arena);
     ntsa::IpAddress ipAddr;
 
     if (!ipAddr.parse(ipAddrStr)) {
@@ -277,7 +278,7 @@ void ResolvingChannelFactoryUtil::defaultResolutionFn(
     resolvedUri->append(ipAddrStr);
     resolvedUri->append(1, '~');
     resolvedUri->append(resolvedName);
-    resolvedUri->append(colon.data(), peerUri.end());
+    resolvedUri->append(colon.data(), peerUri.c_str() + peerUri.length());
 }
 
 }  // close package namespace

src/groups/bmq/bmqio/bmqio_resolvingchannelfactory.h

@@ -140,6 +140,8 @@ class ResolvingChannelFactory_Channel : public DecoratingChannelPartialImp {
     // PRIVATE DATA
     bsl::string d_resolvedPeerUri;
 
+    bsl::string d_basePeerUri;
+
     bsls::AtomicPointer<const bsl::string> d_peerUri;
 
   private:
@@ -177,7 +179,7 @@ class ResolvingChannelFactory_Channel : public DecoratingChannelPartialImp {
 
     /// Return our base Channel's peerUri until our resolution is done, and
     /// start returning the resolved peerUri after that.
-    const bsl::string& peerUri() const BSLS_KEYWORD_OVERRIDE;
+    bsl::string peerUri() const BSLS_KEYWORD_OVERRIDE;
 };
 
 // =============================

src/groups/bmq/bmqio/bmqio_testchannel.cpp

@@ -163,7 +163,7 @@ bmqvt::PropertyBag& TestChannel::properties()
     return d_properties;
 }
 
-const bsl::string& TestChannel::peerUri() const
+bsl::string TestChannel::peerUri() const
 {
     return d_peerUri;
 }

src/groups/bmq/bmqio/bmqio_testchannel.h

@@ -308,7 +308,7 @@ class TestChannel : public Channel {
 
     // ACCESSORS
     // Channel
-    const bsl::string&        peerUri() const BSLS_KEYWORD_OVERRIDE;
+    bsl::string               peerUri() const BSLS_KEYWORD_OVERRIDE;
     const bmqvt::PropertyBag& properties() const BSLS_KEYWORD_OVERRIDE;
 };