release 1.7.1

Author: jagt

DataConfig/Source/DataConfigCore/Private/DataConfig/Property/DcPropertyWriteStates.cpp

@@ -628,6 +628,7 @@ FDcResult FDcWriteStateMap::WriteMapRoot(FDcPropertyWriter* Parent)
 	if (State == EState::ExpectRoot)
 	{
 		State = EState::ExpectKeyOrEnd;
+		MapHelper.EmptyValues();
 		return DcOk();
 	}
 	else
@@ -764,6 +765,7 @@ FDcResult FDcWriteStateArray::WriteArrayRoot(FDcPropertyWriter* Parent)
 	if (State == EState::ExpectRoot)
 	{
 		State = EState::ExpectItemOrEnd;
+		ArrayHelper.EmptyValues();
 		return DcOk();
 	}
 	else
@@ -893,6 +895,7 @@ FDcResult FDcWriteStateSet::WriteSetRoot(FDcPropertyWriter* Parent)
 	if (State == EState::ExpectRoot)
 	{
 		State = EState::ExpectItemOrEnd;
+		SetHelper.EmptyElements();
 		return DcOk();
 	}
 	else

DataConfig/Source/DataConfigCore/Public/DataConfig/DcVersion.h

@@ -1,4 +1,4 @@
 #pragma once
 
-#define DATA_CONFIG_CORE_VERSION "1.7.0"
-#define DATA_CONFIG_CORE_VERSION_NUMBER 10700
+#define DATA_CONFIG_CORE_VERSION "1.7.1"
+#define DATA_CONFIG_CORE_VERSION_NUMBER 10701

DataConfig/Source/DataConfigTests/Private/DcTestProperty5.cpp

@@ -0,0 +1,43 @@
+#include "DcTestProperty5.h"
+
+#include "DataConfig/Automation/DcAutomation.h"
+#include "DataConfig/Automation/DcAutomationUtils.h"
+#include "DataConfig/Extra/Misc/DcTestCommon.h"
+#include "DataConfig/Json/DcJsonReader.h"
+
+DC_TEST("DataConfig.Core.Property.Defaults")
+{
+	FString Str = TEXT(R"(
+		{
+			"StrFieldWithDefault" : "Bar",
+			"IntFieldWithDefault" : 123,
+
+			"StrArrFieldWithDefault" : ["One", "Two", "Three", "Four"],
+			"StrSetFieldWithDefault" : ["Foo", "Bar"],
+			"StringIntMapFieldWithDefault" : {
+				"Five" : 5,
+				"Ten" : 10
+			}
+		}
+	)");
+
+	FDcJsonReader Reader(Str);
+	FDcTestStructWithDefaults Dest;
+
+	UTEST_OK("Deserialize With Defaults", DcAutomationUtils::DeserializeFrom(&Reader, FDcPropertyDatum(&Dest)));
+
+	FDcTestStructWithDefaults Expect;
+	Expect.StrFieldWithDefault = "Bar";
+	Expect.IntFieldWithDefault = 123;
+
+	Expect.StrArrFieldWithDefault = {"One", "Two", "Three", "Four"};
+	Expect.StrSetFieldWithDefault = {"Foo", "Bar"};
+	Expect.StringIntMapFieldWithDefault = {
+		{"Five", 5},
+		{"Ten", 10},
+	};
+
+	UTEST_OK("Deserialize With Defaults", DcAutomationUtils::TestReadDatumEqual(FDcPropertyDatum(&Dest), FDcPropertyDatum(&Expect)));
+
+	return true;
+}

DataConfig/Source/DataConfigTests/Private/DcTestProperty5.h

@@ -0,0 +1,24 @@
+#pragma once
+
+#include "CoreMinimal.h"
+#include "DcTestProperty5.generated.h"
+
+USTRUCT()
+struct FDcTestStructWithDefaults
+{
+	GENERATED_BODY()
+
+	enum { _DEFAULT_INT = 254 };
+
+	UPROPERTY() FString StrFieldWithDefault = "Foo";
+	UPROPERTY() int IntFieldWithDefault = _DEFAULT_INT;
+
+	UPROPERTY() TArray<FString> StrArrFieldWithDefault = {"Foo", "Bar", "Baz"};
+	UPROPERTY() TSet<FString> StrSetFieldWithDefault = {"One", "Two", "Three"};
+	UPROPERTY() TMap<FString, int> StringIntMapFieldWithDefault = {
+		{"One", 1},
+		{"Two", 2},
+		{"Three", 1+1+1*1},
+	};
+};
+

Misc/Docs/Source/Advanced/Breaking.md

@@ -2,6 +2,24 @@
 
 On this page we'll document breaking changes across versions.
 
+# 1.7.1
+
+- `FDcPropertyWriter` will now empty `TArray/TSet/TMap` on write.
+
+   Previously when running into container property with default values DataConfig will thrash the defaults also leaving the container with incorrect elements count. Now the containers will be properly emptied on write.
+
+   ```c++
+   // Example of TArray property with default values.
+   USTRUCT()
+   struct FDcTestStructWithDefaults
+   {
+       // ...
+       UPROPERTY() TArray<FString> StrArrFieldWithDefault = {"Foo", "Bar", "Baz"};
+   };
+   ```
+
+   Though this is a behavior change but it should have minimal impact. See `DataConfig.Core.Property.Defaults` test for details.
+
 # 1.7.0
 
 - UE 5.5 deprecated `StructUtils` plugin, thus we'll need to setup multiple uplugins for UE5. See: [DataConfigXX.uplugin](../Integration.md#dataconfigxxuplugin)

Misc/Docs/Source/Changes.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.7.1 - 2024-11-20
+
+- **BREAKING** Empty `TArray/TSet/TMap` properties on write.
+    - See: [Breaking - 1.7.1](Advanced/Breaking.md#171)
+
+
 ## 1.7.0 - 2024-10-2
 
 - Initial UE 5.5 support.