Add user agent to each request header.

This way we can gather statistics about usage of Enginio api.

Change-Id: I09dd735abe1090c31998e4f6c97aa49a26285730
Reviewed-by: Richard J. Moore <rich@kde.org>
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>

5 files changed, 37 insertions, 0 deletions

diff --git a/src/enginio_client/enginio_client.pro b/src/enginio_client/enginio_client.pro
index 3680f53..ef3f868 100644
--- a/src/enginio_client/enginio_client.pro
+++ b/src/enginio_client/enginio_client.pro
@@ -43,3 +43,5 @@ HEADERS += \
     enginiooauth2authentication.h \
     enginioreplystate.h
 
+
+DEFINES +=  "ENGINIO_VERSION=\\\"$$MODULE_VERSION\\\""
diff --git a/src/enginio_client/enginioclient.cpp b/src/enginio_client/enginioclient.cpp
index 68a46fb..65bae2c 100644
--- a/src/enginio_client/enginioclient.cpp
+++ b/src/enginio_client/enginioclient.cpp
@@ -285,6 +285,8 @@ void EnginioClientConnectionPrivate::init()
     QObject::connect(static_cast<EnginioClient*>(q_ptr), &EnginioClient::sessionTerminated, AuthenticationStateTrackerFunctor(this));
     QObject::connect(static_cast<EnginioClient*>(q_ptr), &EnginioClient::sessionAuthenticated, AuthenticationStateTrackerFunctor(this, Enginio::Authenticated));
     QObject::connect(static_cast<EnginioClient*>(q_ptr), &EnginioClient::sessionAuthenticationError, AuthenticationStateTrackerFunctor(this, Enginio::AuthenticationFailure));
+    _request.setHeader(QNetworkRequest::UserAgentHeader,
+                          QByteArrayLiteral("Qt:" QT_VERSION_STR " Enginio:" ENGINIO_VERSION " Language:C++"));
 }
 
 void EnginioClientConnectionPrivate::replyFinished(QNetworkReply *nreply)
diff --git a/src/enginio_plugin/enginio_plugin.pro b/src/enginio_plugin/enginio_plugin.pro
index ac108ea..eef4dfb 100644
--- a/src/enginio_plugin/enginio_plugin.pro
+++ b/src/enginio_plugin/enginio_plugin.pro
@@ -41,3 +41,5 @@ copy2build.commands = $$QMAKE_COPY ${QMAKE_FILE_IN} ${QMAKE_FILE_OUT}
 copy2build.name = COPY ${QMAKE_FILE_IN}
 copy2build.CONFIG += no_link
 force_independent: QMAKE_EXTRA_COMPILERS += copy2build
+
+DEFINES +=  "ENGINIO_VERSION=\\\"$$MODULE_VERSION\\\""
diff --git a/src/enginio_plugin/enginioqmlclient.cpp b/src/enginio_plugin/enginioqmlclient.cpp
index 7c29cd2..9e97e3f 100644
--- a/src/enginio_plugin/enginioqmlclient.cpp
+++ b/src/enginio_plugin/enginioqmlclient.cpp
@@ -284,6 +284,8 @@ void EnginioQmlClientPrivate::init()
     QObject::connect(q, &EnginioQmlClient::sessionTerminated, AuthenticationStateTrackerFunctor(this));
     QObject::connect(q, &EnginioQmlClient::sessionAuthenticated, AuthenticationStateTrackerFunctor(this, Enginio::Authenticated));
     QObject::connect(q, &EnginioQmlClient::sessionAuthenticationError, AuthenticationStateTrackerFunctor(this, Enginio::AuthenticationFailure));
+    _request.setHeader(QNetworkRequest::UserAgentHeader,
+                          QByteArrayLiteral("Qt:" QT_VERSION_STR " Enginio:" ENGINIO_VERSION " Language:QML"));
 }
 
 EnginioQmlReply *EnginioQmlClient::fullTextSearch(const QJSValue &query)
diff --git a/tests/auto/enginioclient/tst_enginioclient.cpp b/tests/auto/enginioclient/tst_enginioclient.cpp
index b9941fc..aafebbe 100644
--- a/tests/auto/enginioclient/tst_enginioclient.cpp
+++ b/tests/auto/enginioclient/tst_enginioclient.cpp
@@ -98,6 +98,7 @@ private slots:
     void lifeTimeOfNetworkManager();
     void fullTextSearch();
     void assignUserToGroup();
+    void userAgent();
 
 private:
     QString usergroupId(EnginioClient *client)
@@ -798,6 +799,34 @@ void tst_EnginioClient::assignUserToGroup()
     }
 }
 
+static void checkUserAgent(QNetworkReply *reply)
+{
+    QNetworkRequest request = reply->request();
+    QVERIFY(request.rawHeaderList().contains("User-Agent"));
+    QByteArray agent = request.rawHeader("User-Agent");
+    QVERIFY(!agent.isEmpty());
+    QVERIFY(agent.contains("Qt:"));
+    QVERIFY(agent.contains("Enginio:"));
+    QVERIFY(agent.contains("Language:"));
+}
+
+void tst_EnginioClient::userAgent()
+{
+    EnginioClient client;
+    client.setBackendId(_backendId);
+    client.setServiceUrl(EnginioTests::TESTAPP_URL);
+
+    QNetworkAccessManager *qnam = client.networkManager();
+    QObject::connect(qnam, &QNetworkAccessManager::finished, &client, checkUserAgent);
+
+    QVector<EnginioReply *> replies;
+    replies.append(client.query(QJsonObject(), Enginio::UserOperation));
+    replies.append(client.create(QJsonObject(), Enginio::UserOperation));
+
+    foreach (EnginioReply *reply, replies)
+        QTRY_VERIFY(reply->isFinished());
+}
+
 struct DeleteReplyCountHelper
 {
     QSet<QString> &requests;