prepare 2.4.5 release (#46)

LaunchDarklyReleaseBot · web-flow · commit 55fd20c6d3ea · 2022-01-20T17:40:37.000-05:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,26 +1,29 @@
 version: 2.1
 
 orbs:
-   win: circleci/windows@1.0.0
+  win: circleci/windows@1.0.0
 
 workflows:
   version: 2
   build_and_test_all:
     jobs:
-      - build-test-linux
       - build-test-linux-clang11
       - build-test-linux-optimized
+      - build-test-linux-valgrind:
+          requires:
+            - build-test-linux-optimized
+      - build-test-linux-helgrind:
+          requires:
+            - build-test-linux-optimized
       - build-test-linux-32bit
       - build-test-osx
       - build-test-windows
 
 jobs:
-  build-test-linux:
+  build-test-linux-valgrind:
     docker:
       - image: ldcircleci/ld-c-sdk-ubuntu  # defined in sdks-ci-docker project
       - image: redis
-    environment:
-      CTEST_OUTPUT_ON_FAILURE: 1
     steps:
       - checkout
       - run:
@@ -34,12 +37,32 @@ jobs:
             cmake -D REDIS_STORE=ON ..
             cmake --build .
       - run:
-          name: Unit test with memcheck
+          name: Unit test with valgrind
           command: |
             cd build
-            GTEST_OUTPUT="xml:$(pwd)/../reports/" ctest -T memcheck
-      - store_test_results:
-          path: reports
+            valgrind --error-exitcode=100 --leak-check=full ./tests/google_tests
+
+  build-test-linux-helgrind:
+    docker:
+      - image: ldcircleci/ld-c-sdk-ubuntu  # defined in sdks-ci-docker project
+      - image: redis
+    steps:
+      - checkout
+      - run:
+          name: Install dependencies
+          command: |
+            apt-get update -y && apt-get install -y git
+      - run:
+          name: Build
+          command: |
+            mkdir build && cd build
+            cmake -D REDIS_STORE=ON ..
+            cmake --build .
+      - run:
+          name: Unit test with helgrind
+          command: |
+            cd build
+            valgrind --tool=helgrind --suppressions=../valgrind-suppressions.supp --error-exitcode=100 ./tests/google_tests
 
   build-test-linux-optimized:
     docker:
@@ -50,9 +73,9 @@ jobs:
     steps:
       - checkout
       - run:
-            name: Install dependencies
-            command: |
-              apt-get update -y && apt-get install -y git
+          name: Install dependencies
+          command: |
+            apt-get update -y && apt-get install -y git
       - run:
           name: Build
           command: |
@@ -161,8 +184,8 @@ jobs:
       - run:
           name: Test
           command: |
-           cd build
-           GTEST_OUTPUT="xml:$(pwd)/../reports/" make test
+            cd build
+            GTEST_OUTPUT="xml:$(pwd)/../reports/" make test
       - store_test_results:
           path: reports
 
diff --git a/c-sdk-common/include/launchdarkly/json.h b/c-sdk-common/include/launchdarkly/json.h
@@ -1,6 +1,6 @@
 /*!
  * @file json.h
- * @brief Public API Interface for JSON usage
+ * @brief Public API for JSON usage
  */
 
 #pragma once
diff --git a/c-sdk-common/include/launchdarkly/logging.h b/c-sdk-common/include/launchdarkly/logging.h
@@ -1,6 +1,6 @@
 /*!
  * @file logging.h
- * @brief Public API Interface for Logging.
+ * @brief Public API for Logging.
  */
 
 #pragma once
diff --git a/c-sdk-common/include/launchdarkly/user.h b/c-sdk-common/include/launchdarkly/user.h
@@ -1,6 +1,6 @@
 /*!
  * @file user.h
- * @brief Public API Interface for User construction
+ * @brief Public API for User construction
  */
 
 #pragma once
diff --git a/include/launchdarkly/client.h b/include/launchdarkly/client.h
@@ -1,6 +1,6 @@
 /*!
  * @file client.h
- * @brief Public API Interface for Client operations
+ * @brief Public API for Client operations
  */
 
 #pragma once
diff --git a/include/launchdarkly/config.h b/include/launchdarkly/config.h
@@ -1,6 +1,6 @@
 /*!
  * @file config.h
- * @brief Public API Interface for Configuration
+ * @brief Public API for Configuration
  */
 
 #pragma once
diff --git a/include/launchdarkly/store.h b/include/launchdarkly/store.h
@@ -1,6 +1,6 @@
 /*!
  * @file store.h
- * @brief Public API Interface for Store implementations
+ * @brief Public API for Store implementations
  */
 
 #pragma once
diff --git a/include/launchdarkly/variations.h b/include/launchdarkly/variations.h
@@ -1,6 +1,6 @@
 /*!
  * @file variations.h
- * @brief Public API Interface for evaluation variations
+ * @brief Public API for evaluation variations
  */
 
 #pragma once
diff --git a/src/json_internal_helpers.c b/src/json_internal_helpers.c
@@ -0,0 +1,212 @@
+#include "assertion.h"
+#include "json_internal_helpers.h"
+#include "cJSON.h"
+
+LDBoolean
+LDObjectSetString(struct LDJSON *const rawObject, const char *const key, const char *const value) {
+    cJSON *const object = (cJSON *)rawObject;
+
+    LD_ASSERT_API(object);
+    LD_ASSERT_API(cJSON_IsObject(object));
+    LD_ASSERT_API(key);
+    LD_ASSERT_API(value);
+
+#ifdef LAUNCHDARKLY_DEFENSIVE
+    if (object == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetString NULL object");
+
+        return LDBooleanFalse;
+    }
+
+    if (cJSON_IsObject(object) == LDBooleanFalse) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetString not object");
+
+        return LDBooleanFalse;
+    }
+
+    if (key == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetString NULL key");
+
+        return LDBooleanFalse;
+    }
+
+    if (value == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetString NULL value");
+
+        return LDBooleanFalse;
+    }
+#endif
+
+    cJSON_DeleteItemFromObjectCaseSensitive(object, key);
+
+    if (!cJSON_AddStringToObject(object, key, value)) {
+        LD_LOG(LD_LOG_ERROR, "LDObjectSetString failed to set value");
+
+        return LDBooleanFalse;
+    }
+
+    return LDBooleanTrue;
+}
+
+LDBoolean
+LDObjectSetBool(struct LDJSON *rawObject, const char *const key, LDBoolean value) {
+    cJSON *const object = (cJSON *)rawObject;
+
+    LD_ASSERT_API(object);
+    LD_ASSERT_API(cJSON_IsObject(object));
+    LD_ASSERT_API(key);
+
+#ifdef LAUNCHDARKLY_DEFENSIVE
+    if (object == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetBool NULL object");
+
+        return LDBooleanFalse;
+    }
+
+    if (cJSON_IsObject(object) == LDBooleanFalse) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetBool not object");
+
+        return LDBooleanFalse;
+    }
+
+    if (key == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetBool NULL key");
+
+        return LDBooleanFalse;
+    }
+
+#endif
+
+    cJSON_DeleteItemFromObjectCaseSensitive(object, key);
+
+    if (!cJSON_AddBoolToObject(object, key, value)) {
+        LD_LOG(LD_LOG_ERROR, "LDObjectSetBool failed to set value");
+
+        return LDBooleanFalse;
+    }
+
+    return LDBooleanTrue;
+}
+
+struct LDJSON *
+LDObjectNewChild(struct LDJSON *rawObject, const char *const key) {
+    cJSON *const object = (cJSON *)rawObject;
+    cJSON *child = NULL;
+
+    LD_ASSERT_API(object);
+    LD_ASSERT_API(cJSON_IsObject(object));
+    LD_ASSERT_API(key);
+
+#ifdef LAUNCHDARKLY_DEFENSIVE
+    if (object == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectNewChild NULL object");
+
+        return NULL;
+    }
+
+    if (cJSON_IsObject(object) == LDBooleanFalse) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectNewChild not object");
+
+        return NULL;
+    }
+
+    if (key == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectNewChild NULL key");
+
+        return NULL;
+    }
+
+#endif
+
+    cJSON_DeleteItemFromObjectCaseSensitive(object, key);
+
+    if (!(child = cJSON_AddObjectToObject(object, key))) {
+        LD_LOG(LD_LOG_ERROR, "LDObjectNewChild failed to create child object");
+
+        return NULL;
+    }
+
+    return (struct LDJSON*) child;
+}
+
+LDBoolean
+LDObjectSetNumber(struct LDJSON *rawObject, const char *const key, const double number) {
+    cJSON *const object = (cJSON *)rawObject;
+
+    LD_ASSERT_API(object);
+    LD_ASSERT_API(cJSON_IsObject(object));
+    LD_ASSERT_API(key);
+
+#ifdef LAUNCHDARKLY_DEFENSIVE
+    if (object == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetNumber NULL object");
+
+        return LDBooleanFalse;
+    }
+
+    if (cJSON_IsObject(object) == LDBooleanFalse) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetNumber not object");
+
+        return LDBooleanFalse;
+    }
+
+    if (key == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetNumber NULL key");
+
+        return LDBooleanFalse;
+    }
+
+#endif
+
+    cJSON_DeleteItemFromObjectCaseSensitive(object, key);
+
+    if (!cJSON_AddNumberToObject(object, key, number)) {
+        LD_LOG(LD_LOG_ERROR, "LDObjectSetNumber failed to set value");
+
+        return LDBooleanFalse;
+    }
+
+    return LDBooleanTrue;
+}
+
+
+LDBoolean
+LDObjectSetReference(struct LDJSON *const rawObject, const char *const key, struct LDJSON *const item)
+{
+    cJSON *const object = (cJSON *)rawObject;
+
+    LD_ASSERT_API(object);
+    LD_ASSERT_API(cJSON_IsObject(object));
+    LD_ASSERT_API(key);
+    LD_ASSERT_API(item);
+
+#ifdef LAUNCHDARKLY_DEFENSIVE
+    if (object == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetReference NULL object");
+
+        return LDBooleanFalse;
+    }
+
+    if (cJSON_IsObject(object) == LDBooleanFalse) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetReference not object");
+
+        return LDBooleanFalse;
+    }
+
+    if (key == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetReference NULL key");
+
+        return LDBooleanFalse;
+    }
+
+    if (item == NULL) {
+        LD_LOG(LD_LOG_WARNING, "LDObjectSetReference NULL item");
+
+        return LDBooleanFalse;
+    }
+#endif
+
+    cJSON_AddItemReferenceToObject(object, key, (cJSON *)item);
+
+    return LDBooleanTrue;
+}
diff --git a/src/json_internal_helpers.h b/src/json_internal_helpers.h
diff --git a/tests/test-json.cpp b/tests/test-json.cpp
diff --git a/valgrind-suppressions.supp b/valgrind-suppressions.supp
