1.0.0 GA (#8)

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] - 2019-07-05
+### Added
+- LRU caching to prevent users being indexed multiple times
+### Fixed
+- The server HTTP response time parsing logic
+
 ## [1.0.0-beta.4] - 2019-06-11
 ### Fixed
 - Memory leak when evaluating flags with prerequisites

CMakeLists.txt

@@ -29,7 +29,7 @@ add_library(ldserverapidynamic SHARED ${SOURCES})
 set_property(TARGET ldserverapidynamic PROPERTY C_VISIBILITY_PRESET hidden)
 target_link_libraries(ldserverapidynamic ${LD_LIBRARIES})
 
-file(GLOB TESTS "tests/*")
+file(GLOB TESTS "tests/test-*")
 foreach(testsource ${TESTS})
     get_filename_component(testsourceleaf ${testsource} NAME)
     string(REPLACE ".c" "" testexe ${testsourceleaf})

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to the LaunchDarkly Server-side SDK for C/C++
+# Contributing to the LaunchDarkly Server-Side SDK for C/C++
 
 LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.
 

README.md

@@ -1,39 +1,39 @@
-# LaunchDarkly Server-side SDK for C/C++
+# LaunchDarkly Server-Side SDK for C/C++
 
-The LaunchDarkly Server-side SDK for C/C++ is designed primarily for use in multi-user systems such as web servers and applications. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.
+[![CircleCI](https://circleci.com/gh/launchdarkly/c-server-sdk.svg?style=svg)](https://circleci.com/gh/launchdarkly/c-server-sdk)
 
-For using LaunchDarkly in _client-side_ C/C++ applications, refer to our [Client-side C/C++ SDK](https://github.com/launchdarkly/c-client-sdk).
+The LaunchDarkly Server-Side SDK for C/C++ is designed primarily for use in multi-user systems such as web servers and applications. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.
 
-*This version of the SDK is a **beta** version and should not be considered ready for production use while this message is visible.*
+For using LaunchDarkly in _client-side_ C/C++ applications, refer to our [client-side C/C++ SDK](https://github.com/launchdarkly/c-client-sdk).
 
 ## LaunchDarkly overview
 
 [LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/docs/getting-started) using LaunchDarkly today!
- 
+
 [![Twitter Follow](https://img.shields.io/twitter/follow/launchdarkly.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/intent/follow?screen_name=launchdarkly)
- 
+
 ## Compatibility
- 
+
 This version of the LaunchDarkly SDK is compatible with POSIX environments (Linux, OS X, BSD) and Windows.
- 
+
 ## Getting started
 
 Download a release archive from the [GitHub Releases](https://github.com/launchdarkly/c-server-sdk/releases) for use in your project. Refer to the [SDK documentation](https://docs.launchdarkly.com/docs/c-server-sdk-reference#section-getting-started) for complete instructions on getting started with using the SDK.
- 
+
 ## Learn more
 
 Check out our [documentation](https://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](https://docs.launchdarkly.com/docs/c-server-sdk-reference).
- 
+
 ## Testing
- 
+
 We run integration tests for all our SDKs using a centralized test harness. This approach gives us the ability to test for consistency across SDKs, as well as test networking behavior in a long-running application. These tests cover each method in the SDK, and verify that event sending, flag evaluation, stream reconnection, and other aspects of the SDK all behave correctly.
- 
+
 ## Contributing
- 
+
 We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.
- 
+
 ## About LaunchDarkly
- 
+
 * LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard.  With LaunchDarkly, you can:
     * Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
     * Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
@@ -45,4 +45,4 @@ We encourage pull requests and other contributions from the community. Check out
     * [docs.launchdarkly.com](https://docs.launchdarkly.com/  "LaunchDarkly Documentation") for our documentation and SDK reference guides
     * [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/  "LaunchDarkly API Documentation") for our API documentation
     * [blog.launchdarkly.com](https://blog.launchdarkly.com/  "LaunchDarkly Blog Documentation") for the latest product updates
-    * [Feature Flagging Guide](https://github.com/launchdarkly/featureflags/  "Feature Flagging Guide") for best practices and strategies
+    * [Feature Flagging Guide](https://github.com/launchdarkly/featureflags/  "Feature Flagging Guide") for best practices and strategies

include/launchdarkly/api.h

@@ -8,7 +8,7 @@
 /** @brief The current SDK version string. This value adheres to semantic
  * versioning and is included in the HTTP user agent sent to LaunchDarkly.
  */
-#define LD_SDK_VERSION "1.0.0-beta.4"
+#define LD_SDK_VERSION "1.0.0"
 
 #ifdef __cplusplus
 extern "C" {

include/launchdarkly/config.h

@@ -157,9 +157,19 @@ LD_EXPORT(void) LDConfigSetUseLDD(struct LDConfig *const config,
 LD_EXPORT(void) LDConfigSetAllAttributesPrivate(struct LDConfig *const config,
     const bool allAttributesPrivate);
 
+/**
+ * @brief Set to true if you need to see the full user details in every
+ * analytics event.
+ * @param[in] config The configuration to modify. May not be `NULL` (assert).
+ * @param[in] inlineUsersInEvents
+ * @return Void
+ */
+LD_EXPORT(void) LDConfigInlineUsersInEvents(struct LDConfig *const config,
+    const bool inlineUsersInEvents);
+
 /**
  * @brief The number of user keys that the event processor can remember at an
- * one time, so that duplicate user details will not be sent in analytics..
+ * one time, so that duplicate user details will not be sent in analytics.
  * @param[in] config The configuration to modify. May not be `NULL` (assert).
  * @param[in] userKeysCapacity
  * @return Void
@@ -175,7 +185,7 @@ LD_EXPORT(void) LDConfigSetUserKeysCapacity(struct LDConfig *const config,
  * @return Void
  */
 LD_EXPORT(void) LDConfigSetUserKeysFlushInterval(struct LDConfig *const config,
-    const unsigned int userKeysFlushInterval);
+    const unsigned int milliseconds);
 
 /**
  * @brief Marks a set of user attribute names private. Any users sent to

include/launchdarkly/memory.h

@@ -7,6 +7,8 @@
 
 #include <launchdarkly/export.h>
 
+#include <stddef.h>
+
 /** @brief Equivalent to `malloc` */
 LD_EXPORT(void *) LDAlloc(const size_t bytes);
 /** @brief Equivalent to `free` */

include/launchdarkly/variations.h

@@ -56,7 +56,9 @@ enum LDEvalErrorKind {
     LD_MALFORMED_FLAG,
     /** @brief Indicates that the result value was not of the requested type,
      * e.g. you called `LDBoolVariation` but the value was an integer. */
-    LD_WRONG_TYPE
+    LD_WRONG_TYPE,
+    /** @brief Evaluation failed because the client ran out of memory */
+    LD_OOM
 };
 
 /** @brief Indicates which rule matched a user */

src/client.c

@@ -9,6 +9,7 @@
 #include "client.h"
 #include "config.h"
 #include "misc.h"
+#include "user.h"
 
 struct LDClient *
 LDClientInit(struct LDConfig *const config, const unsigned int maxwaitmilli)
@@ -41,6 +42,8 @@ LDClientInit(struct LDConfig *const config, const unsigned int maxwaitmilli)
     client->summaryStart   = 0;
     client->lastServerTime = 0;
 
+    LD_ASSERT(LDi_getMonotonicMilliseconds(&client->lastUserKeyFlush));
+
     if (!LDi_rwlockinit(&client->lock)) {
         goto error;
     }
@@ -53,6 +56,10 @@ LDClientInit(struct LDConfig *const config, const unsigned int maxwaitmilli)
         goto error;
     }
 
+    if (!(client->userKeys = LDLRUInit(config->userKeysCapacity))) {
+        goto error;
+    }
+
     if (!LDi_createthread(&client->thread, LDi_networkthread, client)) {
         goto error;
     }
@@ -86,6 +93,7 @@ LDClientInit(struct LDConfig *const config, const unsigned int maxwaitmilli)
 
     LDJSONFree(client->events);
     LDJSONFree(client->summaryCounters);
+    LDLRUFree(client->userKeys);
 
     LDFree(client);
 
@@ -108,6 +116,7 @@ LDClientClose(struct LDClient *const client)
         LD_ASSERT(LDi_rwlockdestroy(&client->lock));
         LDJSONFree(client->events);
         LDJSONFree(client->summaryCounters);
+        LDLRUFree(client->userKeys);
 
         if (client->config->defaultStore) {
             LDStoreDestroy(client->config->store);
@@ -129,25 +138,36 @@ LDClientIsInitialized(struct LDClient *const client)
     return LDStoreInitialized(client->config->store);
 }
 
-
 bool
 LDClientTrack(struct LDClient *const client, const char *const key,
     const struct LDUser *const user, struct LDJSON *const data)
 {
-    struct LDJSON *event;
+    struct LDJSON *event, *indexEvent;
 
     LD_ASSERT(client);
-    LD_ASSERT(user);
+    LD_ASSERT(LDUserValidate(user));
     LD_ASSERT(key);
 
+    if (!LDi_maybeMakeIndexEvent(client, user, &indexEvent)) {
+        LD_LOG(LD_LOG_ERROR, "failed to construct index event");
+
+        return false;
+    }
+
     if (!(event = LDi_newCustomEvent(client, user, key, data))) {
         LD_LOG(LD_LOG_ERROR, "failed to construct custom event");
 
+        LDJSONFree(indexEvent);
+
         return false;
     }
 
     LDi_addEvent(client, event);
 
+    if (indexEvent) {
+        LDi_addEvent(client, indexEvent);
+    }
+
     return true;
 }
 
@@ -157,7 +177,7 @@ LDClientIdentify(struct LDClient *const client, const struct LDUser *const user)
     struct LDJSON *event;
 
     LD_ASSERT(client);
-    LD_ASSERT(user);
+    LD_ASSERT(LDUserValidate(user));
 
     if (!(event = newIdentifyEvent(client, user))) {
         LD_LOG(LD_LOG_ERROR, "failed to construct identify event");

src/client.h

@@ -3,6 +3,7 @@
 #include <launchdarkly/api.h>
 
 #include "misc.h"
+#include "lru.h"
 
 struct LDClient {
     bool initialized;
@@ -15,4 +16,6 @@ struct LDClient {
     unsigned long summaryStart;
     bool shouldFlush;
     unsigned long long lastServerTime;
+    struct LDLRU *userKeys;
+    unsigned long lastUserKeyFlush;
 };