[Sdk 913] (#81)

* namespace added on countly classes

* CountlyConfiguration model added

* changes

* metrics add in config
metric integrated
metric unit tests added
countly singelton instance code change,

* countlyconfig pointer -> ref

* compile definition issue fixed!

* SDK_API_VERSION removed

* conflict fixed!

* code revert

* clearSDK method added
in unit tests code move inside subcases
struct metrics removed
reset renamed to halt
enablePost renamed to forcePost

* code coment format

* clearSDK function added in tests

* changes

* Test utils added

* code formating

* constructor added for configuration

Author: ZahidZafar

CMakeLists.txt

@@ -46,6 +46,9 @@ find_package(Threads)
 target_link_libraries(countly Threads::Threads)
 
 target_include_directories(countly PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/vendor/json/include)
+if (COUNTLY_BUILD_TESTS)
+  target_compile_definitions(countly PRIVATE COUNTLY_BUILD_TESTS)
+endif()
 
 if (COUNTLY_USE_CUSTOM_SHA256)
   target_compile_definitions(countly PRIVATE COUNTLY_USE_CUSTOM_SHA256)
@@ -78,7 +81,10 @@ if(COUNTLY_BUILD_TESTS)
   add_executable(countly-tests
     ${CMAKE_CURRENT_SOURCE_DIR}/tests/main.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/tests/views.cpp
-    ${CMAKE_CURRENT_SOURCE_DIR}/tests/event.cpp)
+    ${CMAKE_CURRENT_SOURCE_DIR}/tests/event.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/tests/config.cpp)
+
+    target_compile_definitions(countly-tests PRIVATE COUNTLY_BUILD_TESTS)
   if(COUNTLY_USE_SQLITE)
     target_compile_definitions(countly-tests PRIVATE COUNTLY_USE_SQLITE)
     target_include_directories(countly-tests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/vendor/sqlite)
@@ -98,10 +104,7 @@ endif()
 if(COUNTLY_BUILD_SAMPLE)
   add_executable(countly-sample
     ${CMAKE_CURRENT_SOURCE_DIR}/examples/example_integration.cpp)
-  if(COUNTLY_USE_SQLITE)
-    target_compile_definitions(countly-tests PRIVATE COUNTLY_USE_SQLITE)
-    target_include_directories(countly-tests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/vendor/sqlite)
-  endif()
+
   target_include_directories(countly-sample PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/vendor/doctest/doctest)
   target_include_directories(countly-sample PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/vendor/json/include)
   target_link_libraries(countly-sample countly)

include/countly.hpp

@@ -2,6 +2,7 @@
 #define COUNTLY_HPP_
 
 #include "countly/constants.hpp"
+#include "countly/countly_configuration.hpp"
 
 #include <chrono>
 #include <functional>
@@ -43,23 +44,16 @@ class Countly : public cly::CountlyDelegates {
 
   void setLogger(void (*fun)(LogLevel level, const std::string &message));
 
-
-  #ifdef COUNTLY_BUILD_TESTS
+#ifdef COUNTLY_BUILD_TESTS
   /*
   This function should not be used as it will be removed in a future release. It is
   currently added as a temporary workaround.
   */
   inline std::function<void(LogLevel, const std::string &)> getLogger() { return logger->getLogger(); }
-  #endif
-
-  struct HTTPResponse {
-    bool success;
-    nlohmann::json data;
-  };
+#endif
 
   void setSha256(cly::SHA256Function fun);
 
-  using HTTPClientFunction = std::function<HTTPResponse(bool, const std::string &, const std::string &)>;
   void setHTTPClient(HTTPClientFunction fun);
 
   void setMetrics(const std::string &os, const std::string &os_version, const std::string &device, const std::string &resolution, const std::string &carrier, const std::string &app_version);
@@ -193,22 +187,31 @@ class Countly : public cly::CountlyDelegates {
   }
 
   /* Provide 'updateInterval' in seconds. */
-  inline void setAutomaticSessionUpdateInterval(unsigned short updateInterval) { _auto_session_update_interval = updateInterval; }
+  inline void setAutomaticSessionUpdateInterval(unsigned short updateInterval) { configuration->sessionDuration = updateInterval; }
 
   /**
    * Convert event queue into list.
    * Warning: This method is for debugging purposes, and it is going to be removed in the future.
    * You should not be using this method.
    * @return a vector object containing events.
    */
+
+#ifdef COUNTLY_BUILD_TESTS
   const std::vector<std::string> debugReturnStateOfEQ() {
+
 #ifdef COUNTLY_USE_SQLITE
     return {};
-#endif
+#else
     std::vector<std::string> v(event_queue.begin(), event_queue.end());
     return v;
+#endif
   }
 
+  inline const CountlyConfiguration &getConfiguration() { return *configuration.get(); }
+
+  static void halt();
+#endif
+
 private:
   void _deleteThread();
   void _sendIndependantLocationRequest();
@@ -236,14 +239,7 @@ class Countly : public cly::CountlyDelegates {
 
   void updateLoop();
 
-  cly::SHA256Function sha256_function;
-  HTTPClientFunction http_client_function;
-
-  std::string host;
-
-  int port = 0;
   bool use_https = false;
-  bool always_use_post = false;
 
   bool began_session = false;
   bool is_being_disposed = false;
@@ -252,10 +248,10 @@ class Countly : public cly::CountlyDelegates {
   std::chrono::system_clock::time_point last_sent_session_request;
 
   nlohmann::json session_params;
-  std::string salt;
 
   std::unique_ptr<std::thread> thread;
   std::unique_ptr<cly::ViewsModule> views_module;
+  std::shared_ptr<cly::CountlyConfiguration> configuration;
   std::shared_ptr<cly::LoggerModule> logger;
 
   std::mutex mutex;
@@ -265,7 +261,6 @@ class Countly : public cly::CountlyDelegates {
   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;

include/countly/constants.hpp

@@ -9,6 +9,7 @@
 #include <random>
 #include <sstream>
 #include <string>
+#include "nlohmann/json.hpp"
 
 #define COUNTLY_SDK_NAME "cpp-native-unknown"
 #define COUNTLY_SDK_VERSION "22.06.0"
@@ -17,6 +18,12 @@
 #define COUNTLY_MAX_EVENTS_DEFAULT 200
 
 namespace cly {
+struct HTTPResponse {
+  bool success;
+  nlohmann::json data;
+};
+
+using HTTPClientFunction = std::function<HTTPResponse(bool, const std::string &, const std::string &)>;
 using SHA256Function = std::function<std::string(const std::string &)>;
 namespace utils {
 const std::default_random_engine generator(std::chrono::system_clock::now().time_since_epoch().count());

include/countly/countly_configuration.hpp

@@ -0,0 +1,70 @@
+#ifndef COUNTLY_CONFIGURATION_HPP_
+#define COUNTLY_CONFIGURATION_HPP_
+#include "countly/constants.hpp"
+#include <string>
+
+namespace cly {
+struct CountlyConfiguration {
+  /**
+   * URL of the Countly server to submit data to.
+   * Mandatory field.
+   */
+  std::string serverUrl;
+
+  /**
+   * App key for the application being tracked.
+   * Mandatory field.
+   */
+  std::string appKey;
+
+  /**
+   * Unique ID for the device the app is running on.
+   */
+  std::string deviceId;
+
+  /**
+   * Set to prevent parameter tampering.
+   */
+  std::string salt;
+
+  /**
+   * Sets the interval for the automatic update calls
+   * min value 1 (1 second), max value 600 (10 minutes)
+   */
+  unsigned int sessionDuration = 60;
+
+  /**
+   * Set threshold value for the number of events that can be stored locally.
+   */
+  unsigned int eventQueueThreshold = 100;
+
+  /**
+   * Set limit for the number of requests that can be stored locally.
+   */
+  unsigned int requestQueueThreshold = 1000;
+
+  /**
+   * Set the maximum amount of breadcrumbs.
+   */
+  unsigned int breadcrumbsThreshold = 100;
+
+  /**
+   * Set to send all requests made to the Countly server using HTTP POST.
+   */
+  bool forcePost = false;
+
+  unsigned int port = 443;
+
+  SHA256Function sha256_function = nullptr;
+
+  HTTPClientFunction http_client_function = nullptr;
+
+  nlohmann::json metrics;
+
+  CountlyConfiguration(std::string appKey, std::string serverUrl) {
+    this->appKey = appKey;
+    this->serverUrl = serverUrl;
+  }
+};
+} // namespace cly
+#endif