qiurui
/
qtgrpc
mirror of https://github.com/qt/qtgrpc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add JSON serialization support to QGrpcHttp2Channel 

It's now possible to preselect the serialization format when creating
the channel using the 'Content-Type' metadata. Supported values for the
header:
 - application/grpc(default)
 - application/grpc+protobuf
 - application/grpc+json

Note: Not all servers and clients support JSON serialization format.

Task-number: QTBUG-113777
Change-Id: Ia25b3382e3addb2306acce112489ea3427687c0d
Reviewed-by: Tatiana Borisova <tatiana.borisova@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
This commit is contained in:
Alexey Edelev 2023-12-12 14:49:52 +01:00
parent 2bed0bc836
commit 76c05ac9d5
3 changed files with 57 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
src/grpc/qgrpchttp2channel.cpp
View File

@ -10,6 +10,7 @@
#include <QtCore/QMetaObject>
#include <QtCore/QTimer>
#include <QtCore/QUrl>
#include <QtCore/qbytearrayview.h>
#include <QtCore/qendian.h>
#include <QtCore/qiodevice.h>
#include <QtCore/qlist.h>
@ -21,9 +22,11 @@
#if QT_CONFIG(ssl)
# include <QtNetwork/qsslsocket.h>
#endif
#include <QtProtobuf/qprotobufjsonserializer.h>
#include <QtProtobuf/qprotobufserializer.h>
#include <qtgrpcglobal_p.h>
#include <array>
#include <unordered_map>
#include <utility>
#include <vector>
@ -67,6 +70,10 @@ constexpr QByteArrayView GrpcAcceptEncodingHeader("grpc-accept-encoding");
constexpr QByteArrayView GrpcStatusHeader("grpc-status");
constexpr QByteArrayView GrpcStatusMessageHeader("grpc-message");
constexpr qsizetype GrpcMessageSizeHeaderSize = 5;
static constexpr std::array<QByteArrayView, 3> KnownContentTypes{ "application/grpc",
"application/grpc+proto",
"application/grpc+json" };
}
class QGrpcSocketHandler;
@ -78,9 +85,17 @@ struct QGrpcHttp2ChannelPrivate : public QObject
void processOperation(std::shared_ptr<QGrpcChannelOperation> &&channelOperation);
std::shared_ptr<QAbstractProtobufSerializer> serializer;
private:
Q_DISABLE_COPY_MOVE(QGrpcHttp2ChannelPrivate)
enum SerializerTypes {
Default = 0,
Protobuf,
JSON
};
struct ExpectedData
{
qsizetype expectedSize = 0;
@ -161,6 +176,7 @@ private:
std::vector<std::shared_ptr<QGrpcChannelOperation>> m_operations;
QList<Http2Handler *> m_activeHandlers;
bool m_isLocalSocket = false;
QByteArrayView m_contentType;
};
QGrpcHttp2ChannelPrivate::Http2Handler::Http2Handler(QHttp2Stream *_stream)
@ -286,6 +302,25 @@ QGrpcHttp2ChannelPrivate::QGrpcHttp2ChannelPrivate(const QGrpcChannelOptions &op
return true;
}();
if (auto it = m_channelOptions.metadata().find(ContentTypeHeader.toByteArray());
it != m_channelOptions.metadata().end()) {
if (it->second == "application/grpc+json") {
serializer = std::make_shared<QProtobufJsonSerializer>();
m_contentType = KnownContentTypes.at(JSON);
} else if (it->second == "application/grpc+proto" || it->second == "application/grpc") {
serializer = std::make_shared<QProtobufSerializer>();
m_contentType = KnownContentTypes.at(Protobuf);
} else {
qGrpcWarning() << "Cannot choose the serializer for " << ContentTypeHeader << it->second
<< ". Using protobuf format as the default one.";
serializer = std::make_shared<QProtobufSerializer>();
m_contentType = KnownContentTypes.at(Default);
}
} else {
serializer = std::make_shared<QProtobufSerializer>();
m_contentType = KnownContentTypes.at(Default);
}
QUrl url = m_channelOptions.host();
if (url.scheme() == "unix"_L1) {
auto *localSocket = initSocket<QLocalSocket>();
@ -511,7 +546,7 @@ void QGrpcHttp2ChannelPrivate::sendRequest(QGrpcChannelOperation *channelOperati
{ PathHeader.toByteArray(), QByteArray('/' + service + '/' + method) },
{ SchemeHeader.toByteArray(),
m_isLocalSocket ? "http"_ba : m_channelOptions.host().scheme().toLatin1() },
{ ContentTypeHeader.toByteArray(), "application/grpc"_ba },
{ ContentTypeHeader.toByteArray(), m_contentType.toByteArray() },
{ GrpcServiceNameHeader.toByteArray(), { service } },
{ GrpcAcceptEncodingHeader.toByteArray(), "identity,deflate,gzip"_ba },
{ AcceptEncodingHeader.toByteArray(), "identity,gzip"_ba },
@ -524,7 +559,8 @@ void QGrpcHttp2ChannelPrivate::sendRequest(QGrpcChannelOperation *channelOperati
if (lowerKey == AuthorityHeader ||
lowerKey == MethodHeader ||
lowerKey == PathHeader ||
lowerKey == SchemeHeader)
lowerKey == SchemeHeader ||
lowerKey == ContentTypeHeader)
continue;
requestHeaders.push_back({ lowerKey, value });
}
@ -611,8 +647,7 @@ void QGrpcHttp2Channel::startBidirStream(std::shared_ptr<QGrpcChannelOperation>
*/
std::shared_ptr<QAbstractProtobufSerializer> QGrpcHttp2Channel::serializer() const
{
// TODO: make selection based on credentials or channel settings
return std::make_shared<QProtobufSerializer>();
return dPtr->serializer;
}
QT_END_NAMESPACE

17
tests/auto/grpc/client/shared/client_test_common/grpcclienttestbase.cpp
View File

@ -7,6 +7,8 @@
#include <QtNetwork/qtnetwork-config.h>
#include <message_latency_defs.h>
using namespace Qt::Literals::StringLiterals;
void GrpcClientTestBase::initTestCase_data()
{
QTest::addColumn<GrpcClientTestBase::Channels>("type");
@ -25,6 +27,21 @@ void GrpcClientTestBase::initTestCase_data()
#endif
}
if (m_channels.testFlag(Channel::Json)) {
QGrpcMetadata md{ { "content-type"_ba, "application/grpc+json" } };
QTest::newRow("Http2ClientJson")
<< QFlags{ Channel::Qt }
<< std::shared_ptr<QAbstractGrpcChannel>(new QGrpcHttp2Channel(QGrpcChannelOptions{
QUrl("http://localhost:50051", QUrl::StrictMode) }
.withMetadata(md)));
QTest::newRow("Http2ClientJsonUnix")
<< QFlags{ Channel::Qt }
<< std::shared_ptr<QAbstractGrpcChannel>(new QGrpcHttp2Channel(QGrpcChannelOptions{
QUrl("unix:///tmp/qtgrpc_test.sock", QUrl::StrictMode) }
.withMetadata(md)));
}
#if QT_CONFIG(ssl)
if (m_channels.testFlag(Channel::Ssl)) {
QFile caCerificateFile(":/assets/cert.pem");

1
tests/auto/grpc/client/shared/client_test_common/grpcclienttestbase.h
View File

@ -22,6 +22,7 @@ protected:
NoChannels = 0x0,
Qt = 0x1,
Ssl = 0x2,
Json = 0x4,
SslNoCredentials = 0x8,
WithChannelDeadline = 0x10,
};