Fix assertion poolIndex < count_ after JsonDocument::clear()

Fixes #2034

CHANGELOG.md

@@ -1,6 +1,11 @@
 ArduinoJson: change log
 =======================
 
+HEAD
+----
+
+* Fix assertion `poolIndex < count_` after `JsonDocument::clear()` (issue #2034)
+
 v7.0.1 (2024-01-10)
 ------
 

extras/tests/JsonDocument/CMakeLists.txt

@@ -6,6 +6,7 @@ add_executable(JsonDocumentTests
 	add.cpp
 	assignment.cpp
 	cast.cpp
+	clear.cpp
 	compare.cpp
 	constructor.cpp
 	containsKey.cpp

extras/tests/JsonDocument/clear.cpp

@@ -0,0 +1,47 @@
+// ArduinoJson - https://arduinojson.org
+// Copyright © 2014-2024, Benoit BLANCHON
+// MIT License
+
+#include <ArduinoJson.h>
+#include <catch.hpp>
+
+#include <stdlib.h>  // malloc, free
+#include <string>
+
+#include "Allocators.hpp"
+
+TEST_CASE("JsonDocument::clear()") {
+  SpyingAllocator spy;
+  JsonDocument doc(&spy);
+
+  SECTION("null") {
+    doc.clear();
+
+    REQUIRE(doc.isNull());
+    REQUIRE(spy.log() == AllocatorLog{});
+  }
+
+  SECTION("releases resources") {
+    doc[std::string("hello")] = std::string("world");
+    spy.clearLog();
+
+    doc.clear();
+
+    REQUIRE(doc.isNull());
+    REQUIRE(spy.log() == AllocatorLog{
+                             Deallocate(sizeofPool()),
+                             Deallocate(sizeofString("hello")),
+                             Deallocate(sizeofString("world")),
+                         });
+  }
+
+  SECTION("clear free list") {  // issue #2034
+    JsonObject obj = doc.to<JsonObject>();
+    obj["a"] = 1;
+    obj.clear();  // puts the slot in the free list
+
+    doc.clear();
+
+    doc["b"] = 2;  // will it pick from the free list?
+  }
+}

src/ArduinoJson/Memory/VariantPoolList.hpp

@@ -103,6 +103,7 @@ class VariantPoolList {
     for (PoolCount i = 0; i < count_; i++)
       pools_[i].destroy(allocator);
     count_ = 0;
+    freeList_ = NULL_SLOT;
     if (pools_ != preallocatedPools_) {
       allocator->deallocate(pools_);
       pools_ = preallocatedPools_;