Skip to content

Improve the pretty print for operator<<Frame, operator<<Payload#504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
phoad merged 11 commits into from
Jun 17, 2017
Merged

Improve the pretty print for operator<<Frame, operator<<Payload #504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d4b2215
Ability to pretty print in/out frames in rsocket-cpp
Jun 5, 2017
85cec0c
Make operator<<(Frame), operator<<(Payload) to write prettier output
Jun 6, 2017
b1699e4
Improve the pretty print for operator<<Frame, operator<<Payload
Jun 6, 2017
acbebdc
Merge branch 'master' into frameprint
Jun 8, 2017
2f6dd35
Improve the pretty print for operator<<Frame, operator<<Payload
Jun 8, 2017
d98aaa9
Merge branch 'master' into frameprint
Jun 8, 2017
2440b09
clang-format Payload.cpp and Frame.cpp
Jun 9, 2017
c96002c
Merge branch 'master' into frameprint
Jun 12, 2017
14a0532
Updates, related to Alex's comments
Jun 14, 2017
1766274
Merge branch 'master' into frameprint
Jun 14, 2017
36f0218
convert std::unordered_map to std::map, as std::hash<FrameType> doesn…
Jun 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions src/Payload.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,23 +24,29 @@ void Payload::checkFlags(FrameFlags flags) const {
}

std::ostream& operator<<(std::ostream& os, const Payload& payload) {
return os
<< "[Metadata("
return os << "[Metadata("
<< (payload.metadata
? folly::to<std::string>(
payload.metadata->computeChainDataLength())
: "0")
<< (payload.metadata
? "): '" + payload.metadata->cloneAsValue().moveToFbString().substr(0, 80).toStdString() + "'"
: "): <nullptr>")
<< (payload.metadata ? "): '" +
payload.metadata->cloneAsValue()
.moveToFbString()
.substr(0, 40)
.toStdString() +
"'"
: "): <nullptr>")
<< ", Data("
<< (payload.data
? folly::to<std::string>(
payload.data->computeChainDataLength())
: "0")
<< (payload.data
? "): '" + payload.data->cloneAsValue().moveToFbString().substr(0, 80).toStdString() + "'"
: "): <nullptr>")
<< (payload.data ? folly::to<std::string>(
payload.data->computeChainDataLength())
: "0")
<< (payload.data ? "): '" +
payload.data->cloneAsValue()
.moveToFbString()
.substr(0, 40)
.toStdString() +
"'"
: "): <nullptr>")
<< "]";
}

Expand DownExpand Up@@ -79,4 +85,4 @@ FrameFlags Payload::getFlags() const {
return (metadata != nullptr ? FrameFlags::METADATA : FrameFlags::EMPTY);
}

} // reactivesocket
} // namespace rsocket
117 changes: 84 additions & 33 deletions src/framing/Frame.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
// Copyright 2004-present Facebook. All Rights Reserved.

#include "src/framing/Frame.h"
#include <bitset>
#include <sstream>
#include <folly/Memory.h>
#include <folly/Optional.h>
#include <folly/io/Cursor.h>
#include <bitset>
#include <map>
#include <sstream>
#include "src/RSocketParameters.h"

namespace rsocket {
Expand DownExpand Up@@ -95,41 +96,83 @@ std::ostream& operator<<(std::ostream& os, ErrorCode errorCode) {
return os << "ErrorCode(" << static_cast<uint32_t>(errorCode) << ")";
}

std::ostream& operator<<(std::ostream& os, FrameFlags frameFlags) {
// TODO Match the Flag names with the AllowedFlags in the Frame declarations
std::ostream&
writeFlags(std::ostream& os, FrameFlags frameFlags, FrameType frameType) {
constexpr const char* kEmpty = "0x00";
constexpr const char* kMetadata = "METADATA";
constexpr const char* kResumeEnable = "RESUME_ENABLE";
constexpr const char* kLease = "LEASE";
constexpr const char* kKeepAliveRespond = "KEEPALIVE_RESPOND";
constexpr const char* kFollows = "FOLLOWS";
constexpr const char* kComplete = "COMPLETE";
constexpr const char* kNext = "NEXT";

static std::map<FrameType, std::vector<std::pair<FrameFlags, std::string>>>
flagToNameMap{{FrameType::REQUEST_N, {}},
{FrameType::REQUEST_RESPONSE,
{{FrameFlags::METADATA, kMetadata},
{FrameFlags::FOLLOWS, kFollows}}},
{FrameType::REQUEST_FNF,
{{FrameFlags::METADATA, kMetadata},
{FrameFlags::FOLLOWS, kFollows}}},
{FrameType::METADATA_PUSH, {}},
{FrameType::CANCEL, {}},
{FrameType::PAYLOAD,
{{FrameFlags::METADATA, kMetadata},
{FrameFlags::FOLLOWS, kFollows},
{FrameFlags::COMPLETE, kComplete},
{FrameFlags::NEXT, kNext}}},
{FrameType::ERROR, {{FrameFlags::METADATA, kMetadata}}},
{FrameType::KEEPALIVE,
{{FrameFlags::KEEPALIVE_RESPOND, kKeepAliveRespond}}},
{FrameType::SETUP,
{{FrameFlags::METADATA, kMetadata},
{FrameFlags::RESUME_ENABLE, kResumeEnable},
{FrameFlags::LEASE, kLease}}},
{FrameType::LEASE, {{FrameFlags::METADATA, kMetadata}}},
{FrameType::RESUME, {}},
{FrameType::REQUEST_CHANNEL,
{{FrameFlags::METADATA, kMetadata},
{FrameFlags::FOLLOWS, kFollows},
{FrameFlags::COMPLETE, kComplete}}},
{FrameType::REQUEST_STREAM,
{{FrameFlags::METADATA, kMetadata},
{FrameFlags::FOLLOWS, kFollows}}}};

FrameFlags foundFlags = FrameFlags::EMPTY;

// Search the corresponding string value for each flag, insert the missing
// ones as empty
const std::vector<std::pair<FrameFlags, std::string>>& allowedFlags =
flagToNameMap[frameType];

std::stringstream ss;
std::string delimeter = "";
if (!!(frameFlags & FrameFlags::NEXT)) {
ss << "NEXT";
delimeter = "|";
}
if (!!(frameFlags & FrameFlags::COMPLETE)) {
ss << delimeter << "COMPLETE";
delimeter = "|";
for (const auto& pair : allowedFlags) {
if (!!(frameFlags & pair.first)) {
os << delimeter << pair.second;
delimeter = "|";
foundFlags |= pair.first;
}
}
if (!!(frameFlags & FrameFlags::FOLLOWS)) {
ss << delimeter << "FOLLOWS";
delimeter = "|";
}
if (!!(frameFlags & FrameFlags::METADATA)) {
ss << delimeter << "METADATA";
delimeter = "|";
}
if (!!(frameFlags & FrameFlags::IGNORE)) {
ss << delimeter << "IGNORE";
delimeter = "|";
}
if (!delimeter.empty()) {
return os << ss.str();

if (foundFlags != frameFlags) {
os << frameFlags;
} else if (delimeter.empty()) {
os << kEmpty;
}
return os << "EMPTY";
return os;
}

std::ostream& operator<<(std::ostream& os, FrameFlags frameFlags) {
std::bitset<16> flags(static_cast<uint16_t>(frameFlags));
return os << flags;
}

std::ostream& operator<<(std::ostream& os, const FrameHeader& header) {
return os << header.type_ << "[" << header.flags_ << ", " << header.streamId_
<< "]";
os << header.type_ << "[";
return writeFlags(os, header.flags_, header.type_) << ", " << header.streamId_ << "]";
}

/// @}

std::ostream& operator<<(std::ostream& os, const Frame_REQUEST_Base& frame) {
Expand DownExpand Up@@ -211,9 +254,8 @@ std::ostream& operator<<(std::ostream& os, const Frame_KEEPALIVE& frame) {
}

std::ostream& operator<<(std::ostream& os, const Frame_SETUP& frame) {
return os << frame.header_
<< ", Version: " << frame.versionMajor_ << "." << frame.versionMinor_
<< ", (" << frame.payload_;
return os << frame.header_ << ", Version: " << frame.versionMajor_ << "."
<< frame.versionMinor_ << ", (" << frame.payload_;
}

void Frame_SETUP::moveToSetupPayload(SetupParameters& setupPayload) {
Expand DownExpand Up@@ -241,4 +283,13 @@ std::ostream& operator<<(std::ostream& os, const Frame_RESUME& frame) {
std::ostream& operator<<(std::ostream& os, const Frame_RESUME_OK& frame) {
return os << frame.header_ << ", (@" << frame.position_ << ")";
}
} // reactivesocket

std::ostream& operator<<(std::ostream& os, const Frame_REQUEST_CHANNEL& frame) {
return os << frame.header_ << ", " << frame.payload_;
}

std::ostream& operator<<(std::ostream& os, const Frame_REQUEST_STREAM& frame) {
return os << frame.header_ << ", " << frame.payload_;
}

} // namespace rsocket
2 changes: 2 additions & 0 deletions src/framing/Frame.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -254,6 +254,7 @@ class Frame_REQUEST_STREAM : public Frame_REQUEST_Base {
0,
std::move(payload)) {}
};
std::ostream& operator<<(std::ostream& os, const Frame_REQUEST_STREAM& frame);

class Frame_REQUEST_CHANNEL : public Frame_REQUEST_Base {
public:
Expand DownExpand Up@@ -281,6 +282,7 @@ class Frame_REQUEST_CHANNEL : public Frame_REQUEST_Base {
0,
std::move(payload)) {}
};
std::ostream& operator<<(std::ostream&, const Frame_REQUEST_CHANNEL&);

class Frame_REQUEST_RESPONSE {
public:
Expand Down