1.0.0 beta.2 (#3)

Author: hroederld

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to the LaunchDarkly C server-side SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [1.0.0-beta.2] - 2019-04-05
+### Added
+- Windows support
+- Networking retry timing jitter
+- Analytics `debugEventsUntilDate` support
+
 ## [1.0.0-beta.1] - 2019-03-27
 ### Added
 - Initial public API

CMakeLists.txt

@@ -1,18 +1,30 @@
 cmake_minimum_required(VERSION 2.8)
-find_package(CURL REQUIRED)
 
 enable_testing() # CTEST_OUTPUT_ON_FAILURE=1 make test
 
-set(CMAKE_C_FLAGS "-D__USE_XOPEN -D_GNU_SOURCE -Wall -Wextra -g3 -fno-omit-frame-pointer -Wno-pointer-to-int-cast -Wdeclaration-after-statement")
+if(MSVC)
+    set(CMAKE_C_FLAGS "-D CURL_STATICLIB -D PCRE_STATIC -MD")
+    set(CURL_LIBRARIES ../curl-7.59.0/builds/libcurl-vc-x64-release-static-ipv6-sspi-winssl/lib/libcurl_a)
+    set(CURL_INCLUDE_DIR curl-7.59.0/builds/libcurl-vc-x64-release-static-ipv6-sspi-winssl/include)
+    set(PCRE_LIBRARIES ../pcre-8.43/build/Debug/pcred)
+    set(PCRE_INCLUDE_DIR pcre-8.43/build)
+else()
+    find_package(CURL REQUIRED)
+    set(CMAKE_C_FLAGS "-D__USE_XOPEN -D_GNU_SOURCE -g3 -fno-omit-frame-pointer -fvisibility=hidden")
+    set(PCRE_LIBRARIES pcre)
+    set(LD_LIBRARIES pthread m)
+endif(MSVC)
 
-include_directories("include" "third-party/include" ${CURL_INCLUDE_DIR})
+include_directories("include" "third-party/include" ${CURL_INCLUDE_DIR} ${PCRE_INCLUDE_DIR})
 file(GLOB SOURCES "src/*" "third-party/src/*")
 
+set(LD_LIBRARIES ${LD_LIBRARIES} ${CURL_LIBRARIES} ${PCRE_LIBRARIES})
+
 add_library(ldserverapi STATIC ${SOURCES})
-target_link_libraries(ldserverapi ${CURL_LIBRARIES} pthread pcre m gmp)
+target_link_libraries(ldserverapi ${LD_LIBRARIES})
 
 add_library(ldserverapidynamic SHARED ${SOURCES})
-target_link_libraries(ldserverapidynamic ${CURL_LIBRARIES} pthread pcre m gmp)
+target_link_libraries(ldserverapidynamic ${LD_LIBRARIES})
 
 file(GLOB TESTS "tests/*")
 foreach(testsource ${TESTS})

README.md

@@ -10,14 +10,14 @@ For using LaunchDarkly in C / C++ client-side applications, refer to our [C / C+
 Quick setup (POSIX)
 -------------------
 
-The C / C++ SDK requires a POSIX environment, and assumes that `libcurl`, `libpthread`, `libpcre`, and `libgmp` are installed.
+The C / C++ SDK requires a POSIX environment, and assumes that `libcurl`, `libpthread`, and `libpcre` are installed.
 
 Unlike other LaunchDarkly SDKs, the C SDK has no installation steps. To get started, clone [this repository](https://github.com/launchdarkly/c-client-server-side) or download a release archive from the [GitHub Releases](https://github.com/launchdarkly/c-client-server-side/releases) page. You can use the `Makefile` in this repository as a starting point for integrating this SDK into your application.
 
 You can get the required dependencies on Ubuntu Linux with:
 
 ```
-sudo apt-get update && sudo apt-get install build-essential libcurl4-openssl-dev libpcre3-dev libgmp-dev
+sudo apt-get update && sudo apt-get install build-essential libcurl4-openssl-dev libpcre3-dev
 ```
 
 Getting started

azure-pipelines.yml

@@ -0,0 +1,95 @@
+variables:
+  ld_tool_chain: 'call "C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise\Common7\Tools\VsDevCmd.bat" -host_arch=amd64 -arch=amd64'
+
+jobs:
+  - job: build
+    pool:
+      vmImage: 'vs2017-win2016'
+    steps:
+      - task: PowerShell@2
+        displayName: 'Fetch Curl'
+        inputs:
+          targetType: inline
+          script: iwr -outf curl.zip https://curl.haxx.se/download/curl-7.59.0.zip
+      - task: ExtractFiles@1
+        displayName: 'Extract Curl'
+        inputs:
+          archiveFilePatterns: curl.zip
+          cleanDestinationFolder: false
+      - task: CmdLine@2
+        displayName: 'Build Curl'
+        inputs:
+          script: |
+            %ld_tool_chain%
+            cd curl-7.59.0/winbuild
+            nmake /f Makefile.vc mode=static
+
+      - task: PowerShell@2
+        displayName: 'Fetch PCRE'
+        inputs:
+          targetType: inline
+          script: iwr -outf pcre.zip https://ftp.pcre.org/pub/pcre/pcre-8.43.zip
+      - task: ExtractFiles@1
+        displayName: 'Extract PCRE'
+        inputs:
+          archiveFilePatterns: pcre.zip
+          cleanDestinationFolder: false
+      - task: CmdLine@2
+        displayName: 'Build PCRE'
+        inputs:
+          script: |
+            %ld_tool_chain%
+            cd pcre-8.43
+            mkdir build
+            cd build
+            cmake -G "Visual Studio 15 2017 Win64" ..
+            cmake --build .
+
+      - task: CmdLine@2
+        displayName: 'Build SDK'
+        inputs:
+          script: |
+            %ld_tool_chain%
+            mkdir build
+            cd build
+            cmake -G "Visual Studio 15 2017 Win64" ..
+            cmake --build .
+
+      - task: CmdLine@2
+        displayName: 'Test SDK'
+        inputs:
+          script: |
+            %ld_tool_chain%
+            cd build
+            cmake --build . --target RUN_TESTS
+
+      - task: CopyFiles@2
+        inputs:
+          targetFolder: $(Build.ArtifactStagingDirectory)
+          sourceFolder: $(System.DefaultWorkingDirectory)/build/Debug
+          contents: 'ldserverapidynamic.dll'
+      - task: CopyFiles@2
+        inputs:
+          targetFolder: $(Build.ArtifactStagingDirectory)
+          sourceFolder: $(System.DefaultWorkingDirectory)/build/Debug
+          contents: 'ldserverapidynamic.lib'
+      - task: CopyFiles@2
+        inputs:
+          targetFolder: $(Build.ArtifactStagingDirectory)
+          sourceFolder: $(System.DefaultWorkingDirectory)/build/Debug
+          contents: 'ldserverapi.lib'
+
+      - task: PowerShell@2
+        inputs:
+          targetType: inline
+          script: |
+            Rename-Item -Path "ldserverapidynamic.dll" -NewName "windows-vs-64bit-ldserverapi-dynamic.dll"
+            Rename-Item -Path "ldserverapidynamic.lib" -NewName "windows-vs-64bit-ldserverapi-dynamic.lib"
+            Rename-Item -Path "ldserverapi.lib" -NewName "windows-vs-64bit-ldserverapi-static.lib"
+          workingDirectory: '$(Build.ArtifactStagingDirectory)'
+        displayName: 'Rename Artifacts'
+
+      - task: PublishBuildArtifacts@1
+        inputs:
+          pathtoPublish: '$(Build.ArtifactStagingDirectory)'
+          artifactName: library

include/ldapi.h

@@ -5,12 +5,7 @@
 
 #pragma once
 
-#ifdef __cplusplus
-
-extern "C" {
-#endif
-
-#define LD_SDK_VERSION "1.0.0-beta.1"
+#define LD_SDK_VERSION "1.0.0-beta.2"
 
 #include <stdbool.h>
 #include <stddef.h>
@@ -22,7 +17,3 @@ extern "C" {
 #include "ldclient.h"
 #include "ldvariations.h"
 #include "ldmemory.h"
-
-#ifdef __cplusplus
-}
-#endif

include/ldclient.h

@@ -10,21 +10,22 @@
 
 #include "ldjson.h"
 #include "lduser.h"
+#include "ldexport.h"
 
-struct LDClient *LDClientInit(struct LDConfig *const config,
+LD_EXPORT(struct LDClient *) LDClientInit(struct LDConfig *const config,
     const unsigned int maxwaitmilli);
 
-void LDClientClose(struct LDClient *const client);
+LD_EXPORT(void) LDClientClose(struct LDClient *const client);
 
-bool LDClientIsInitialized(struct LDClient *const client);
+LD_EXPORT(bool) LDClientIsInitialized(struct LDClient *const client);
 
-bool LDClientTrack(struct LDClient *const client,
+LD_EXPORT(bool) LDClientTrack(struct LDClient *const client,
     const char *const key, const struct LDUser *const user,
     struct LDJSON *const data);
 
-bool LDClientIdentify(struct LDClient *const client,
+LD_EXPORT(bool) LDClientIdentify(struct LDClient *const client,
     const struct LDUser *const user);
 
-bool LDClientIsOffline(struct LDClient *const client);
+LD_EXPORT(bool) LDClientIsOffline(struct LDClient *const client);
 
-void LDClientFlush(struct LDClient *const client);
+LD_EXPORT(void) LDClientFlush(struct LDClient *const client);

include/ldconfig.h

@@ -8,6 +8,8 @@
 #include <stdbool.h>
 #include <stddef.h>
 
+#include "ldexport.h"
+
 /* **** Forward Declarations **** */
 
 struct LDStore; struct LDConfig;
@@ -18,14 +20,14 @@ struct LDStore; struct LDConfig;
  * it should no longer be modified.
  * @return NULL on failure.
  */
-struct LDConfig *LDConfigNew(const char *const key);
+LD_EXPORT(struct LDConfig *) LDConfigNew(const char *const key);
 
 /**
  * @brief Destroy a config not associated with a client instance.
  * @param[in] config May be NULL.
  * @return Void.
  */
-void LDConfigFree(struct LDConfig *const config);
+LD_EXPORT(void) LDConfigFree(struct LDConfig *const config);
 
 /**
  * @brief Set the base URI for connecting to LaunchDarkly. You probably don't
@@ -35,7 +37,7 @@ void LDConfigFree(struct LDConfig *const config);
  * @param[in] baseURI The new base URI to use. May not be NULL (assert).
  * @return True on success, False on failure
  */
-bool LDConfigSetBaseURI(struct LDConfig *const config,
+LD_EXPORT(bool) LDConfigSetBaseURI(struct LDConfig *const config,
     const char *const baseURI);
 
 /**
@@ -46,7 +48,7 @@ bool LDConfigSetBaseURI(struct LDConfig *const config,
  * @param[in] streamURI The new stream URI to use. May not be NULL (assert).
  * @return True on success, False on failure
  */
-bool LDConfigSetStreamURI(struct LDConfig *const config,
+LD_EXPORT(bool) LDConfigSetStreamURI(struct LDConfig *const config,
     const char *const streamURI);
 
 /**
@@ -57,7 +59,7 @@ bool LDConfigSetStreamURI(struct LDConfig *const config,
  * @param[in] eventsURI The new events URI to use. May not be NULL (assert).
  * @return True on success, False on failure
  */
-bool LDConfigSetEventsURI(struct LDConfig *const config,
+LD_EXPORT(bool) LDConfigSetEventsURI(struct LDConfig *const config,
     const char *const eventsURI);
 
 /**
@@ -69,7 +71,8 @@ bool LDConfigSetEventsURI(struct LDConfig *const config,
  * @param[in] stream True for streaming, False for polling.
  * @return Void.
  */
-void LDConfigSetStream(struct LDConfig *const config, const bool stream);
+LD_EXPORT(void) LDConfigSetStream(struct LDConfig *const config,
+    const bool stream);
 
 /**
  * @brief Sets whether to send analytics events back to LaunchDarkly. By
@@ -79,7 +82,7 @@ void LDConfigSetStream(struct LDConfig *const config, const bool stream);
  * @param[in] sendEvents
  * @return Void.
  */
-void LDConfigSetSendEvents(struct LDConfig *const config,
+LD_EXPORT(void) LDConfigSetSendEvents(struct LDConfig *const config,
     const bool sendEvents);
 
 /**
@@ -90,7 +93,7 @@ void LDConfigSetSendEvents(struct LDConfig *const config,
  * @param[in] eventsCapacity
  * @return Void.
  */
-void LDConfigSetEventsCapacity(struct LDConfig *const config,
+LD_EXPORT(void) LDConfigSetEventsCapacity(struct LDConfig *const config,
     const unsigned int eventsCapacity);
 
 /**
@@ -99,7 +102,7 @@ void LDConfigSetEventsCapacity(struct LDConfig *const config,
  * @param[in] milliseconds
  * @return Void.
  */
-void LDConfigSetTimeout(struct LDConfig *const config,
+LD_EXPORT(void) LDConfigSetTimeout(struct LDConfig *const config,
     const unsigned int milliseconds);
 
 /**
@@ -108,7 +111,7 @@ void LDConfigSetTimeout(struct LDConfig *const config,
  * @param[in] milliseconds
  * @return Void.
  */
-void LDConfigSetFlushInterval(struct LDConfig *const config,
+LD_EXPORT(void) LDConfigSetFlushInterval(struct LDConfig *const config,
     const unsigned int milliseconds);
 
 /**
@@ -117,7 +120,7 @@ void LDConfigSetFlushInterval(struct LDConfig *const config,
  * @param[in] milliseconds
  * @return Void.
  */
-void LDConfigSetPollInterval(struct LDConfig *const config,
+LD_EXPORT(void) LDConfigSetPollInterval(struct LDConfig *const config,
     const unsigned int milliseconds);
 
 /**
@@ -128,7 +131,8 @@ void LDConfigSetPollInterval(struct LDConfig *const config,
  * @param[in] offline
  * @return Void.
  */
-void LDConfigSetOffline(struct LDConfig *const config, const bool offline);
+LD_EXPORT(void) LDConfigSetOffline(struct LDConfig *const config,
+    const bool offline);
 
 /**
  * @brief Sets whether this client should use the LaunchDarkly relay
@@ -138,7 +142,8 @@ void LDConfigSetOffline(struct LDConfig *const config, const bool offline);
  * @param[in] useLDD
  * @return Void.
  */
-void LDConfigSetUseLDD(struct LDConfig *const config, const bool useLDD);
+LD_EXPORT(void) LDConfigSetUseLDD(struct LDConfig *const config,
+    const bool useLDD);
 
 /**
  * @brief Sets whether or not all user attributes (other than the key) should be
@@ -148,7 +153,7 @@ void LDConfigSetUseLDD(struct LDConfig *const config, const bool useLDD);
  * @param[in] allAttributesPrivate
  * @return Void.
  */
-void LDConfigSetAllAttributesPrivate(struct LDConfig *const config,
+LD_EXPORT(void) LDConfigSetAllAttributesPrivate(struct LDConfig *const config,
     const bool allAttributesPrivate);
 
 /**
@@ -158,7 +163,7 @@ void LDConfigSetAllAttributesPrivate(struct LDConfig *const config,
  * @param[in] userKeysCapacity
  * @return Void
  */
-void LDConfigSetUserKeysCapacity(struct LDConfig *const config,
+LD_EXPORT(void) LDConfigSetUserKeysCapacity(struct LDConfig *const config,
     const unsigned int userKeysCapacity);
 
 /**
@@ -168,7 +173,7 @@ void LDConfigSetUserKeysCapacity(struct LDConfig *const config,
  * @param[in] userKeysFlushInterval
  * @return Void
  */
-void LDConfigSetUserKeysFlushInterval(struct LDConfig *const config,
+LD_EXPORT(void) LDConfigSetUserKeysFlushInterval(struct LDConfig *const config,
     const unsigned int userKeysFlushInterval);
 
 /**
@@ -179,7 +184,7 @@ void LDConfigSetUserKeysFlushInterval(struct LDConfig *const config,
  * @param[in] attribute May not be NULL (assert).
  * @return NULL on failure.
  */
-bool LDConfigAddPrivateAttribute(struct LDConfig *const config,
+LD_EXPORT(bool) LDConfigAddPrivateAttribute(struct LDConfig *const config,
     const char *const attribute);
 
 /**
@@ -189,5 +194,5 @@ bool LDConfigAddPrivateAttribute(struct LDConfig *const config,
  * @param[in] store. May not be NULL (assert).
  * @return NULL on failure.
  */
-void LDConfigSetFeatureStore(struct LDConfig *const config,
+LD_EXPORT(void) LDConfigSetFeatureStore(struct LDConfig *const config,
     struct LDStore *const store);