Non blocking http (#87)

* namespace added on countly classes

* request logic added

* remote config send http handled.

* code styling

* changes,

* Update CHANGELOG.md

* - return -> break
- typo fixed
- methods comments added

* sdk version updated

* warning added

* - remote config exta function removed
- remote config helper function renamed

Co-authored-by: ArtursKadikis <[email protected]>

Author: ZahidZafar

CHANGELOG.md

@@ -2,6 +2,7 @@
 * !! Major breaking change !! We are adding the 'cly' namespace on 'Countly' class which will change how that class can be referenced. 'Countly::' will not work, you will have to use 'cly::Countly::' instead.
 * !! Major breaking change !! We are extracting the 'Event' class out of the 'Countly' class which will change how that class can be referenced. 'Countly::Event' will not work, you will have to use 'cly::Event' instead.
 * !! Major breaking change !! Increased the compiler version required to compile the SDK. It's increased from version C++11 to C++14.
+* Making network requests has been reworked. They will now be sent on a separate thread. Requests will also be added in an internal queue and will be sent one at a time.
 
 22.02.0
 * Added 10-second time-outs for all windows HTTP transactions.

include/countly.hpp

@@ -212,6 +212,16 @@ class Countly : public cly::CountlyDelegates {
   void _sendIndependantLocationRequest();
   void log(LogLevel level, const std::string &message);
 
+  /**
+   * Helper methods to fetch remote config from the server.
+   */
+#pragma region  Remote_Config_Helper_Methods
+  void _fetchRemoteConfig(std::map<std::string, std::string> &data);
+  void _updateRemoteConfigWithSpecificValues(std::map<std::string, std::string> &data);
+#pragma endregion Remote_Config_Helper_Methods
+
+  void processRequestQueue();
+  void addToRequestQueue(std::string &data);
   HTTPResponse sendHTTP(std::string path, std::string data);
 
   void _changeDeviceIdWithMerge(const std::string &value);
@@ -248,12 +258,14 @@ class Countly : public cly::CountlyDelegates {
   std::shared_ptr<cly::LoggerModule> logger;
 
   std::mutex mutex;
+  bool enable_automatic_session = false;
   bool stop_thread = false;
   bool running = false;
   size_t wait_milliseconds = COUNTLY_KEEPALIVE_INTERVAL;
   unsigned short _auto_session_update_interval = 60; // value is in seconds;
 
   size_t max_events = COUNTLY_MAX_EVENTS_DEFAULT;
+  std::deque<std::string> request_queue;
 #ifndef COUNTLY_USE_SQLITE
   std::deque<std::string> event_queue;
 #else

include/countly/constants.hpp

@@ -12,7 +12,7 @@
 
 #define COUNTLY_SDK_NAME "cpp-native-unknown"
 #define COUNTLY_SDK_VERSION "0.1.0"
-#define COUNTLY_API_VERSION "22.02.0"
+#define COUNTLY_API_VERSION "22.06.0"
 #define COUNTLY_POST_THRESHOLD 2000
 #define COUNTLY_KEEPALIVE_INTERVAL 3000
 #define COUNTLY_MAX_EVENTS_DEFAULT 200

src/countly.cpp

@@ -136,7 +136,7 @@ void Countly::setUserDetails(const std::map<std::string, std::string> &value) {
 
   std::map<std::string, std::string> data = {{"app_key", session_params["app_key"].get<std::string>()}, {"device_id", session_params["device_id"].get<std::string>()}, {"user_details", session_params["user_details"].dump()}};
 
-  sendHTTP("/i", Countly::serializeForm(data));
+  addToRequestQueue(Countly::serializeForm(data));
   mutex.unlock();
 }
 
@@ -152,7 +152,7 @@ void Countly::setCustomUserDetails(const std::map<std::string, std::string> &val
 
   std::map<std::string, std::string> data = {{"app_key", session_params["app_key"].get<std::string>()}, {"device_id", session_params["device_id"].get<std::string>()}, {"user_details", session_params["user_details"].dump()}};
 
-  sendHTTP("/i", Countly::serializeForm(data));
+  addToRequestQueue(Countly::serializeForm(data));
   mutex.unlock();
 }
 
@@ -229,7 +229,7 @@ void Countly::_sendIndependantLocationRequest() {
     data["app_key"] = session_params["app_key"].get<std::string>();
     data["device_id"] = session_params["device_id"].get<std::string>();
     data["timestamp"] = std::to_string(timestamp.count());
-    sendHTTP("/i", Countly::serializeForm(data));
+    addToRequestQueue(Countly::serializeForm(data));
   }
 
   mutex.unlock();
@@ -285,7 +285,7 @@ void Countly::_changeDeviceIdWithMerge(const std::string &value) {
       {"old_device_id", session_params["old_device_id"].get<std::string>()},
       {"timestamp", std::to_string(timestamp.count())},
   };
-  sendHTTP("/i", Countly::serializeForm(data));
+  addToRequestQueue(Countly::serializeForm(data));
 
   session_params.erase("old_device_id");
   mutex.unlock();
@@ -313,6 +313,8 @@ void Countly::_changeDeviceIdWithoutMerge(const std::string &value) {
 
 void Countly::start(const std::string &app_key, const std::string &host, int port, bool start_thread) {
   mutex.lock();
+  enable_automatic_session = start_thread;
+  start_thread = true;
   log(Countly::LogLevel::INFO, "[Countly][start]");
   this->host = host;
   if (host.find("http://") == 0) {
@@ -552,19 +554,15 @@ bool Countly::beginSession() {
     data["metrics"] = session_params["metrics"].dump();
   }
 
-  if (sendHTTP("/i", Countly::serializeForm(data)).success) {
-    session_params.erase("user_details");
-    last_sent_session_request = Countly::getTimestamp();
-    began_session = true;
-  }
+  addToRequestQueue(Countly::serializeForm(data));
+  session_params.erase("user_details");
+  last_sent_session_request = Countly::getTimestamp();
+  began_session = true;
+  mutex.unlock();
 
   if (remote_config_enabled) {
-    mutex.unlock();
     updateRemoteConfig();
-  } else {
-    mutex.unlock();
   }
-
   return began_session;
 }
 
@@ -639,10 +637,7 @@ bool Countly::updateSession() {
   if (duration.count() >= _auto_session_update_interval) {
     log(Countly::LogLevel::DEBUG, "[Countly][updateSession] sending session update.");
     std::map<std::string, std::string> data = {{"app_key", session_params["app_key"].get<std::string>()}, {"device_id", session_params["device_id"].get<std::string>()}, {"session_duration", std::to_string(duration.count())}};
-    if (!sendHTTP("/i", Countly::serializeForm(data)).success) {
-      mutex.unlock();
-      return false;
-    }
+    addToRequestQueue(Countly::serializeForm(data));
 
     last_sent_session_request += duration;
   }
@@ -651,10 +646,7 @@ bool Countly::updateSession() {
     log(Countly::LogLevel::DEBUG, "[Countly][updateSession] sending event.");
     std::map<std::string, std::string> data = {{"app_key", session_params["app_key"].get<std::string>()}, {"device_id", session_params["device_id"].get<std::string>()}, {"events", events.dump()}};
 
-    if (!sendHTTP("/i", Countly::serializeForm(data)).success) {
-      mutex.unlock();
-      return false;
-    }
+    addToRequestQueue(Countly::serializeForm(data));
   }
 
 #ifndef COUNTLY_USE_SQLITE
@@ -697,15 +689,12 @@ bool Countly::endSession() {
     return false;
   }
 
-  if (sendHTTP("/i", Countly::serializeForm(data)).success) {
-    last_sent_session_request = now;
-    began_session = false;
-    mutex.unlock();
-    return true;
-  }
+  addToRequestQueue(Countly::serializeForm(data));
 
+  last_sent_session_request = now;
+  began_session = false;
   mutex.unlock();
-  return false;
+  return true;
 }
 
 std::chrono::system_clock::time_point Countly::getTimestamp() { return std::chrono::system_clock::now(); }
@@ -798,6 +787,32 @@ std::string Countly::calculateChecksum(const std::string &salt, const std::strin
 #endif
 }
 
+void Countly::processRequestQueue() {
+
+  while (!request_queue.empty()) {
+    mutex.lock();
+    std::string data = request_queue.front();
+    HTTPResponse response = sendHTTP("/i", data);
+
+    if (!response.success) {
+      mutex.unlock();
+      break;
+    }
+
+    request_queue.pop_front();
+    mutex.unlock();
+  }
+}
+
+void Countly::addToRequestQueue(std::string &data) {
+  if (request_queue.size() >= 1000) {
+    log(Countly::LogLevel::WARNING, "[Countly][addToRequestQueue] Request Queue is full. Dropping the oldest request.");
+    request_queue.pop_front();
+  }
+
+  request_queue.push_back(data);
+}
+
 Countly::HTTPResponse Countly::sendHTTP(std::string path, std::string data) {
   bool use_post = always_use_post || (data.size() > COUNTLY_POST_THRESHOLD);
   log(Countly::LogLevel::DEBUG, "[Countly][sendHTTP] data: " + data);
@@ -996,7 +1011,11 @@ void Countly::updateLoop() {
     size_t last_wait_milliseconds = wait_milliseconds;
     mutex.unlock();
     std::this_thread::sleep_for(std::chrono::milliseconds(last_wait_milliseconds));
-    updateSession();
+    if (enable_automatic_session) {
+      updateSession();
+    }
+
+    processRequestQueue();
   }
   mutex.lock();
   running = false;
@@ -1009,20 +1028,29 @@ void Countly::enableRemoteConfig() {
   mutex.unlock();
 }
 
+void Countly::_fetchRemoteConfig(std::map<std::string, std::string> &data) {
+  mutex.lock();
+  HTTPResponse response = sendHTTP("/o/sdk", serializeForm(data));
+  if (response.success) {
+    remote_config = response.data;
+  }
+  mutex.unlock();
+}
+
 void Countly::updateRemoteConfig() {
+  mutex.lock();
   if (!session_params["app_key"].is_string() || !session_params["device_id"].is_string()) {
     log(Countly::LogLevel::ERROR, "Error updating remote config, app key or device id is missing");
+    mutex.unlock();
     return;
   }
-
   std::map<std::string, std::string> data = {{"method", "fetch_remote_config"}, {"app_key", session_params["app_key"].get<std::string>()}, {"device_id", session_params["device_id"].get<std::string>()}};
 
-  HTTPResponse response = sendHTTP("/o/sdk", serializeForm(data));
-  if (response.success) {
-    mutex.lock();
-    remote_config = response.data;
-    mutex.unlock();
-  }
+  mutex.unlock();
+
+  // Fetch remote config asynchronously
+  std::thread _thread(&Countly::_fetchRemoteConfig, this, data);
+  _thread.detach();
 }
 
 nlohmann::json Countly::getRemoteConfigValue(const std::string &key) {
@@ -1032,7 +1060,19 @@ nlohmann::json Countly::getRemoteConfigValue(const std::string &key) {
   return value;
 }
 
+void Countly::_updateRemoteConfigWithSpecificValues(std::map<std::string, std::string> &data) {
+  mutex.lock();
+  HTTPResponse response = sendHTTP("/o/sdk", serializeForm(data));
+  if (response.success) {
+    for (auto it = response.data.begin(); it != response.data.end(); ++it) {
+      remote_config[it.key()] = it.value();
+    }
+  }
+  mutex.unlock();
+}
+
 void Countly::updateRemoteConfigFor(std::string *keys, size_t key_count) {
+  mutex.lock();
   std::map<std::string, std::string> data = {{"method", "fetch_remote_config"}, {"app_key", session_params["app_key"].get<std::string>()}, {"device_id", session_params["device_id"].get<std::string>()}};
 
   {
@@ -1042,18 +1082,15 @@ void Countly::updateRemoteConfigFor(std::string *keys, size_t key_count) {
     }
     data["keys"] = keys_json.dump();
   }
+  mutex.unlock();
 
-  HTTPResponse response = sendHTTP("/o/sdk", serializeForm(data));
-  if (response.success) {
-    mutex.lock();
-    for (auto it = response.data.begin(); it != response.data.end(); ++it) {
-      remote_config[it.key()] = it.value();
-    }
-    mutex.unlock();
-  }
+  // Fetch remote config asynchronously
+  std::thread _thread(&Countly::_updateRemoteConfigWithSpecificValues, this, data);
+  _thread.detach();
 }
 
 void Countly::updateRemoteConfigExcept(std::string *keys, size_t key_count) {
+  mutex.lock();
   std::map<std::string, std::string> data = {{"method", "fetch_remote_config"}, {"app_key", session_params["app_key"].get<std::string>()}, {"device_id", session_params["device_id"].get<std::string>()}};
 
   {
@@ -1063,14 +1100,10 @@ void Countly::updateRemoteConfigExcept(std::string *keys, size_t key_count) {
     }
     data["omit_keys"] = keys_json.dump();
   }
+  mutex.unlock();
 
-  HTTPResponse response = sendHTTP("/o/sdk", serializeForm(data));
-  if (response.success) {
-    mutex.lock();
-    for (auto it = response.data.begin(); it != response.data.end(); ++it) {
-      remote_config[it.key()] = it.value();
-    }
-    mutex.unlock();
-  }
+  // Fetch remote config asynchronously
+  std::thread _thread(&Countly::_updateRemoteConfigWithSpecificValues, this, data);
+  _thread.detach();
 }
 } // namespace cly