Merge branch 'master' into refactor/1

Signed-off-by: turuslan <[email protected]>

# Conflicts:
#	example/02-kademlia/rendezvous_chat.cpp
#	src/protocol/ping/ping_client_session.cpp
#	src/protocol_muxer/multiselect/multiselect_instance.cpp
#	src/protocol_muxer/multiselect/simple_stream_negotiate.cpp
#	test/libp2p/connection/security_conn/plaintext_connection_test.cpp
#	test/libp2p/transport/tcp/tcp_integration_test.cpp

Author: turuslan

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,55 @@
+name: Bug Report
+description: Create a bug report for cpp-libp2p
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for filing a bug report!
+  - type: textarea
+    attributes:
+      label: Summary
+      description: Please provide a short summary of the bug, along with any information you feel relevant to replicate the bug.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected behavior
+      description: Describe what you expect to happen.    
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Actual behavior
+      description: Describe what actually happens.    
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label:  Possible Solution
+      description: Suggest a fix/reason for the bug, or ideas how to implement the addition or change. 
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Version
+      description: Which version of libp2p are you using? libp2p version (version number, commit, or branch)
+    validations:
+      required: false
+  - type: dropdown
+    attributes:
+      label: Would you like to work on fixing this bug ?
+      description: Any contribution towards fixing the bug is greatly appreciated. We are more than happy to provide help on the process.
+      options:
+        - "Yes"
+        - "No"
+        - Maybe
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Technical Questions
+    url: https://github.com/libp2p/cpp-libp2p/discussions/new?category=q-a
+    about: Please ask technical questions in the cpp-libp2p Github Discussions forum.
+  - name: Community-wide libp2p Discussion
+    url: https://discuss.libp2p.io
+    about: Discussions and questions about the libp2p community.

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -0,0 +1,31 @@
+name: Enhancement
+description: Suggest an improvement to an existing cpp-libp2p feature.
+body:
+  - type: textarea
+    attributes:
+      label: Description
+      description: Describe the enhancement that you are proposing.    
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Motivation
+      description: Explain why this enhancement is beneficial.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Current Implementation
+      description: Describe the current implementation.
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Are you planning to do it yourself in a pull request ?
+      description: Any contribution is greatly appreciated. We are more than happy to provide help on the process.
+      options:
+        - "Yes"
+        - "No"
+        - Maybe
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,42 @@
+name: Feature request
+description: Suggest a new feature in cpp-libp2p
+body:
+  - type: markdown
+    attributes:
+      value: |
+        If you'd like to suggest a feature related to libp2p but not specifically related to the C++ implementation, please file an issue at https://github.com/libp2p/specs instead.
+  - type: textarea
+    attributes:
+      label: Description
+      description: Briefly describe the feature that you are requesting.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Motivation
+      description: Explain why this feature is needed.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Requirements
+      description: Write a list of what you want this feature to do.
+      placeholder: "1." 
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Open questions
+      description: Use this section to ask any questions that are related to the feature.
+    validations:
+      required: false
+  - type: dropdown
+    attributes:
+      label: Are you planning to do it yourself in a pull request ?
+      description: Any contribution is greatly appreciated. We are more than happy to provide help on the process.
+      options:
+        - "Yes"
+        - "No"
+        - Maybe
+    validations:
+      required: true

example/01-echo/libp2p_echo_server.cpp

@@ -195,7 +195,7 @@ dPtse4GVRA2swbXcZX5iFVi/V8poIpdVrgn5iMadkQnYf9APWJuGcebK
     io_context->run();
     std::exit(EXIT_SUCCESS);
   } catch (const boost::system::error_code &ec) {
-    log->error("Server cannot run: {}", ec.message());
+    log->error("Server cannot run: {}", ec);
     std::exit(EXIT_FAILURE);
   } catch (...) {
     log->error("Unknown error happened");

example/02-kademlia/rendezvous_chat.cpp

@@ -11,6 +11,7 @@
 
 #include <boost/beast.hpp>
 
+#include <libp2p/basic/write_return_size.hpp>
 #include <libp2p/common/literals.hpp>
 #include <libp2p/injector/kademlia_injector.hpp>
 #include <libp2p/log/configurator.hpp>
@@ -69,9 +70,9 @@ class Session : public std::enable_shared_from_this<Session> {
       return false;
     }
 
-    stream_->write(
+    libp2p::writeReturnSize(
+        stream_,
         *buffer,
-        buffer->size(),
         [self = shared_from_this(), buffer](outcome::result<size_t> result) {
           if (not result) {
             self->close();

example/03-gossip/console_async_reader.cpp

@@ -21,7 +21,9 @@ namespace libp2p::protocol::example::utility {
   void ConsoleAsyncReader::read() {
     input_.consume(input_.data().size());
     boost::asio::async_read_until(
-        in_, input_, "\n",
+        in_,
+        input_,
+        "\n",
         [this](const boost::system::error_code &e, std::size_t size) {
           onRead(e, size);
         });

example/03-gossip/console_async_reader.hpp

@@ -6,8 +6,8 @@
 
 #pragma once
 
-#include <string>
 #include <functional>
+#include <string>
 
 #include <boost/asio.hpp>
 
@@ -39,4 +39,4 @@ namespace libp2p::protocol::example::utility {
     bool stopped_ = false;
   };
 
-} //namespace libp2p::protocol::example::utility
+}  // namespace libp2p::protocol::example::utility

include/libp2p/basic/varint_prefix_reader.hpp

@@ -42,6 +42,10 @@ namespace libp2p::basic {
       return value_;
     }
 
+    size_t size() const {
+      return got_bytes_;
+    }
+
     /// Resets reader's state
     void reset();
 

include/libp2p/basic/writer.hpp

@@ -19,21 +19,6 @@ namespace libp2p::basic {
 
     virtual ~Writer() = default;
 
-    /**
-     * @brief Write exactly {@code} in.size() {@nocode} bytes.
-     * Won't call \param cb before all are successfully written.
-     * Returns immediately.
-     * @param in data to write.
-     * @param bytes number of bytes to write
-     * @param cb callback with result of operation
-     *
-     * @note caller should maintain validity of an input buffer until callback
-     * is executed. It is usually done with either wrapping buffer as shared
-     * pointer, or having buffer as part of some class/struct, and using
-     * enable_shared_from_this()
-     */
-    virtual void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) = 0;
-
     /**
      * @brief Write up to {@code} in.size() {@nocode} bytes.
      * Calls \param cb after only some bytes has been successfully written,

include/libp2p/connection/loopback_stream.hpp

@@ -44,8 +44,6 @@ namespace libp2p::connection {
 
     void readSome(BytesOut out, size_t bytes, ReadCallbackFunc cb) override;
 
-    void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
-
     void writeSome(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
 
     void deferReadCallback(outcome::result<size_t> res,

include/libp2p/layer/websocket/ssl_connection.hpp

@@ -37,7 +37,6 @@ namespace libp2p::connection {
     void deferReadCallback(outcome::result<size_t> res,
                            ReadCallbackFunc cb) override;
 
-    void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
     void writeSome(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
     void deferWriteCallback(std::error_code ec, WriteCallbackFunc cb) override;
 

include/libp2p/layer/websocket/ws_connection.hpp

@@ -75,8 +75,6 @@ namespace libp2p::connection {
     void deferReadCallback(outcome::result<size_t> res,
                            ReadCallbackFunc cb) override;
 
-    void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
-
     void writeSome(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
 
     void deferWriteCallback(std::error_code ec, WriteCallbackFunc cb) override;

include/libp2p/muxer/mplex/mplex_stream.hpp

@@ -57,8 +57,6 @@ namespace libp2p::connection {
     void deferReadCallback(outcome::result<size_t> res,
                            ReadCallbackFunc cb) override;
 
-    void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
-
     void writeSome(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
 
     void deferWriteCallback(std::error_code ec, WriteCallbackFunc cb) override;

include/libp2p/muxer/mplex/mplexed_connection.hpp

@@ -66,7 +66,6 @@ namespace libp2p::connection {
     /// use stream over this connection instead
     void read(BytesOut out, size_t bytes, ReadCallbackFunc cb) override;
     void readSome(BytesOut out, size_t bytes, ReadCallbackFunc cb) override;
-    void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
     void writeSome(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
 
     void deferReadCallback(outcome::result<size_t> res,

include/libp2p/muxer/yamux/yamux_stream.hpp

@@ -59,8 +59,6 @@ namespace libp2p::connection {
     void deferReadCallback(outcome::result<size_t> res,
                            ReadCallbackFunc cb) override;
 
-    void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
-
     void writeSome(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
 
     void deferWriteCallback(std::error_code ec, WriteCallbackFunc cb) override;

include/libp2p/muxer/yamux/yamuxed_connection.hpp

@@ -113,7 +113,6 @@ namespace libp2p::connection {
     /// use stream over this connection instead
     void read(BytesOut out, size_t bytes, ReadCallbackFunc cb) override;
     void readSome(BytesOut out, size_t bytes, ReadCallbackFunc cb) override;
-    void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
     void writeSome(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
 
     /// Initiates async readSome on connection

include/libp2p/security/noise/noise_connection.hpp

@@ -53,8 +53,6 @@ namespace libp2p::connection {
     void deferReadCallback(outcome::result<size_t> res,
                            ReadCallbackFunc cb) override;
 
-    void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
-
     void writeSome(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
 
     void deferWriteCallback(std::error_code ec, WriteCallbackFunc cb) override;

include/libp2p/security/plaintext/plaintext_connection.hpp

@@ -42,8 +42,6 @@ namespace libp2p::connection {
     void deferReadCallback(outcome::result<size_t> res,
                            ReadCallbackFunc cb) override;
 
-    void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
-
     void writeSome(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
 
     void deferWriteCallback(std::error_code ec, WriteCallbackFunc cb) override;

include/libp2p/security/secio/secio_connection.hpp

@@ -103,8 +103,6 @@ namespace libp2p::connection {
     void deferReadCallback(outcome::result<size_t> res,
                            ReadCallbackFunc cb) override;
 
-    void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
-
     void writeSome(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
 
     void deferWriteCallback(std::error_code ec, WriteCallbackFunc cb) override;

include/libp2p/transport/tcp/tcp_connection.hpp

@@ -95,8 +95,6 @@ namespace libp2p::transport {
     void deferReadCallback(outcome::result<size_t> res,
                            ReadCallbackFunc cb) override;
 
-    void write(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
-
     void writeSome(BytesIn in, size_t bytes, WriteCallbackFunc cb) override;
 
     void deferWriteCallback(std::error_code ec, WriteCallbackFunc cb) override;

src/basic/message_read_writer_bigendian.cpp

@@ -11,6 +11,7 @@
 #include <arpa/inet.h>
 #include <boost/assert.hpp>
 #include <libp2p/basic/message_read_writer_error.hpp>
+#include <libp2p/basic/write_return_size.hpp>
 #include <libp2p/common/byteutil.hpp>
 
 namespace libp2p::basic {
@@ -55,13 +56,14 @@ namespace libp2p::basic {
     raw_buf.reserve(kLenMarkerSize + buffer.size());
     common::putUint32BE(raw_buf, buffer.size());
     raw_buf.insert(raw_buf.end(), buffer.begin(), buffer.end());
-    conn_->write(raw_buf,
-                 raw_buf.size(),
-                 [self{shared_from_this()}, cb{std::move(cb)}](auto &&result) {
-                   if (not result) {
-                     return cb(result.error());
-                   }
-                   cb(result.value() - self->kLenMarkerSize);
-                 });
+    writeReturnSize(
+        conn_,
+        raw_buf,
+        [self{shared_from_this()}, cb{std::move(cb)}](auto &&result) {
+          if (not result) {
+            return cb(result.error());
+          }
+          cb(result.value() - self->kLenMarkerSize);
+        });
   }
 }  // namespace libp2p::basic

src/basic/message_read_writer_uvarint.cpp

@@ -12,6 +12,7 @@
 #include <boost/optional.hpp>
 #include <libp2p/basic/message_read_writer_error.hpp>
 #include <libp2p/basic/varint_reader.hpp>
+#include <libp2p/basic/write_return_size.hpp>
 #include <libp2p/multi/uvarint.hpp>
 
 namespace libp2p::basic {
@@ -59,16 +60,16 @@ namespace libp2p::basic {
                       std::make_move_iterator(varint_len.toVector().end()));
     msg_bytes->insert(msg_bytes->end(), buffer.begin(), buffer.end());
 
-    conn_->write(*msg_bytes,
-                 msg_bytes->size(),
-                 [cb = std::move(cb),
-                  varint_size = varint_len.size(),
-                  msg_bytes](auto &&res) {
-                   if (!res) {
-                     return cb(res.error());
-                   }
-                   // hide a written varint from the user of the method
-                   cb(res.value() - varint_size);
-                 });
+    writeReturnSize(conn_,
+                    *msg_bytes,
+                    [cb = std::move(cb),
+                     varint_size = varint_len.size(),
+                     msg_bytes](auto &&res) {
+                      if (!res) {
+                        return cb(res.error());
+                      }
+                      // hide a written varint from the user of the method
+                      cb(res.value() - varint_size);
+                    });
   }
 }  // namespace libp2p::basic