[OS-1068] Provide a timeout to the Http class

debian/changelog

@@ -3,6 +3,7 @@ mercury (4.3.3-0) unstable; urgency=low
   * Compiling project with C++14 standard
   * Fixed issue with KanoWorld, KESDLT, KESMP clients when ran
     under sudo
+  * Added a timeout capability to HTTP class
 
  -- Team Kano <dev@kano.me>  Fri, 3 Oct 2019 14:25:00 +0100
 

include/mercury/http/http_client.h

@@ -21,17 +21,19 @@
 
 #include "mercury/http/http_client_interface.h"
 
-
 namespace Mercury {
 namespace HTTP {
 
+#define DEFAULT_HTTP_CLIENT_TIMEOUT    15 // seconds
+
 /**
  * \class HTTPClient
  * \brief Simple implementation of IHTTPClient
  */
 class HTTPClient : public IHTTPClient {
  public:
     HTTPClient();
+    HTTPClient(int timeout_secs);
     std::shared_ptr<JSON_Value> POST(
         const std::string& url,
         const std::string& body,
@@ -50,6 +52,9 @@ class HTTPClient : public IHTTPClient {
         const std::string& url,
         const std::string& path) override;
 
+    void set_http_client_timeout(int seconds);
+    int get_http_client_timeout();
+
  protected:
     /**
      * \brief Builds and sends a request to a server
@@ -69,6 +74,8 @@ class HTTPClient : public IHTTPClient {
         const std::map<std::string, std::string>& headers =
             std::map<std::string, std::string>(),
         const std::string& body = "");
+
+    int http_client_timeout;
 };
 
 }  // namespace HTTP

src/http/http_client.cpp

@@ -48,10 +48,13 @@ using Poco::Net::SSLManager;
 using Mercury::HTTP::HTTPClient;
 
 
-HTTPClient::HTTPClient() {
+HTTPClient::HTTPClient(int timeout_secs = DEFAULT_HTTP_CLIENT_TIMEOUT) {
     HTTPSessionInstantiator::registerInstantiator();
     HTTPSSessionInstantiator::registerInstantiator();
 
+    // set a default timeout, can be overriden after class instantiation
+    set_http_client_timeout(timeout_secs);
+
     // Prepare for SSLManager
     Poco::SharedPtr<AcceptCertificateHandler> cert =
         new AcceptCertificateHandler(false);
@@ -62,6 +65,18 @@ HTTPClient::HTTPClient() {
 }
 
 
+void HTTPClient::set_http_client_timeout(int seconds)
+{
+    http_client_timeout = seconds;
+}
+
+
+int HTTPClient::get_http_client_timeout()
+{
+    return http_client_timeout;
+}
+
+
 std::shared_ptr<JSON_Value> HTTPClient::send_request(
     const std::string& method,
     const std::string& url,
@@ -89,6 +104,8 @@ std::shared_ptr<JSON_Value> HTTPClient::send_request(
         request.set(header.first, header.second);
     }
 
+    session->setTimeout(Poco::Timespan(this->get_http_client_timeout(), 0));
+
     std::ostream& os = session->sendRequest(request);
 
     if (!body.empty()) {

test/kw/kw_apis.h

@@ -193,6 +193,9 @@ TEST_P(ParentalConsentAPI, TestAccountVerification)
 }
 
 
+/* TODO: Implement tests for HTTP class with a timeout */
+
+
 /**
  * KanoWorld::refresh_account_verified() should return false when the
  * HTTPClient throws an exception (for example, when there is a server error)