.editorconfig

@@ -0,0 +1,2 @@
+[*.cs]
+indent_style = tab

.github/workflows/ci.yml

@@ -19,9 +19,10 @@ jobs:
         uses: actions/setup-dotnet@v3
         with:
           dotnet-version: | 
-           3.1.x
-           5.0.x
-           6.0.x
+           6.x
+           7.x
+           8.x
+           9.x
 
       - name: dotnet build
         run: dotnet build

.github/workflows/codeql-analysis.yml

@@ -40,6 +40,15 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v3
 
+    - name: Setup dotnet
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: | 
+         6.x
+         7.x
+         8.x
+         9.x
+           
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v2

CHANGELOG.md

@@ -1,3 +1,48 @@
+## 4.2.0
+
+- Correctly handle key not found exception when applying patch document to dictionary https://github.com/Havunen/SystemTextJsonPatch/pull/40
+- Respect STJ options PropertyNameCaseInsensitive setting https://github.com/Havunen/SystemTextJsonPatch/pull/42
+- Internal dependencies updated
+
+## 4.1.0
+
+- Adds .NET 9 support
+
+## 4.0.0
+
+**BREAKING CHANGE:** SystemTextJsonPatch now supports different property naming policies!
+f.e. `JsonNamingPolicy.SnakeCaseLower`. Fixes https://github.com/Havunen/SystemTextJsonPatch/issues/36
+
+- This means that the **path** and **from** of the system text json patch document needs to match the JSON serializer options property naming policy.
+For example, if the JSON serializer options are set to use camelCase, the patch path should also be in camelCase.
+
+**BREAKING CHANGE:** Exception types have been changed.
+
+- `JsonPatchException` -base exception type now contains `FailedOperation` and `AffectedObject` properties.
+These properties are populated with the failed operation when the operation is available.
+This change is to provide more information about the failed operation and the affected object. Fixes: https://github.com/Havunen/SystemTextJsonPatch/issues/26
+- `NotSupportedException` and `InvalidOperationException` are not thrown anymore. Instead, `JsonPatchException` is thrown with the appropriate message.
+- `JsonPatchTestOperationException` is now thrown only when the test operation fails. Fixes https://github.com/Havunen/SystemTextJsonPatch/issues/22
+
+## 3.3.0
+- Adds support for `DenyPatch` attribute to deny access to annotated property https://github.com/Havunen/SystemTextJsonPatch/pull/34
+- Internal dependencies updated
+
+## 3.2.1
+- Fixes an issue where null and empty string test operation of JsonNode was incorrectly handled https://github.com/Havunen/SystemTextJsonPatch/issues/31
+- Improved performance of JSON patch test operation
+
+## 3.2.0
+- Adds support for dictionary complex types https://github.com/Havunen/SystemTextJsonPatch/pull/29
+- Internal dependencies updated
+
+## 3.1.0
+- Added .NET 8 target framework
+
+## 3.0.1
+- All invalid patch operations now correctly throw JsonPatchTestOperationException and malformed patch documents throw JsonPatchException
+
+
 ## 3.0.0
 - Library runtime performance is improved by using throw helpers for throwing exceptions https://github.com/Havunen/SystemTextJsonPatch/issues/21
 - **Possibly breaking change**: `JsonPatchTestOperationException` type is now thrown for `test` -operation failures https://github.com/Havunen/SystemTextJsonPatch/issues/22

README.md

@@ -21,7 +21,9 @@ Build a patch document on the client.
 You can use the operations as described in the IETF document: Add, Remove, Replace, Copy, Move and Test.
 
 ```cs
-JsonPatchDocument<DTO.Expense> expensePatch = new JsonPatchDocument<DTO.Expense>();
+List<Operation<DTO.Expense>> operations = [];
+JsonSerializerOptions jsonOptions = new JsonSerializerOptions();
+JsonPatchDocument<DTO.Expense> expensePatch = new JsonPatchDocument<DTO.Expense>(operations,  jsonOptions);
 expensePatch.Replace(e => e.Description, expense.Description);
 
 // serialize it to JSON
@@ -49,6 +51,11 @@ public IHttpActionResult Patch(
 }
 ```
 
+## Deny access to properties
+If you need to stop JsonPatch from reading or writing to some properties,
+then you can decorate them with `[DenyPatch]`, if a patch occurs that happens to access the property then a `JsonPatchAccessDeniedException` is thrown.
+
+
 ## Migration from v1
 
 JsonPatchDocumentConverterFactory no longer needs to be set to JsonSerializerOptions.
@@ -60,18 +67,16 @@ This test deserializes a JSON patch document of 8 operations and applies the cha
 
 See [SystemTextJsonPatch.Benchmark](https://github.com/Havunen/SystemTextJsonPatch/tree/main/SystemTextJsonPatch.Benchmark) for more details.
 
-(SystemTextJsonPatch , )
-
-BenchmarkDotNet v0.13.7, Windows 11 (10.0.22621.2134/22H2/2022Update/SunValley2)
+BenchmarkDotNet v0.14.0, Windows 11 (10.0.26100.2605)
 AMD Ryzen 9 5950X, 1 CPU, 32 logical and 16 physical cores
-.NET SDK 8.0.100-preview.7.23376.3
-  [Host]     : .NET 7.0.9 (7.0.923.32018), X64 RyuJIT AVX2
-  Job-TMETTY : .NET 7.0.9 (7.0.923.32018), X64 RyuJIT AVX2
+.NET SDK 9.0.200-preview.0.24575.35
+  [Host]     : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
+  Job-ZCWSQV : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
 
 WarmupCount=2
 
-|              Method |       Mean |      Error |     StdDev |   Gen0 |   Gen1 | Allocated |
+| Method              | Mean       | Error      | StdDev     | Gen0   | Gen1   | Allocated |
 |-------------------- |-----------:|-----------:|-----------:|-------:|-------:|----------:|
-| SystemTextJsonPatch (v3.0.0) |   4.953 us |  0.0277 us |  0.0259 us | 0.2899 |      - |   4.83 KB |
-|     MarvinJsonPatch (v2.2.1) | 909.176 us | 17.4292 us | 18.6490 us | 5.8594 | 3.9063 |  96.14 KB |
-| AspNetCoreJsonPatch (v7.0.10) |  24.742 us |  0.3156 us |  0.2952 us | 2.6550 | 0.0610 |  43.61 KB |
+| SystemTextJsonPatch |   3.909 us |  0.0616 us |  0.0576 us | 0.2747 |      - |   4.63 KB |
+| MarvinJsonPatch     | 741.280 us | 14.2699 us | 11.9160 us | 3.9063 | 1.9531 |  95.09 KB |
+| AspNetCoreJsonPatch |  15.268 us |  0.2227 us |  0.2084 us | 2.6245 | 0.0916 |  43.07 KB |

SystemTextJsonPatch.ApiTest/Controllers/WeatherController.cs

@@ -0,0 +1,62 @@
+using Microsoft.AspNetCore.Mvc;
+using System.ComponentModel.DataAnnotations;
+
+namespace SystemTextJsonPatch.ApiTest.Controllers
+{
+	[Route("api/[controller]")]
+	public class WeatherController : ControllerBase
+	{
+		private readonly WeatherForecast[] _weatherForecasts = new WeatherForecast[]
+		{
+			new WeatherForecast { Date = DateTime.Now, TemperatureC = 25, Summary = "Hot" },
+			new WeatherForecast { Date = DateTime.Now.AddDays(1), TemperatureC = 20, Summary = "Warm" },
+			new WeatherForecast { Date = DateTime.Now.AddDays(2), TemperatureC = 15, Summary = "Cool" },
+			new WeatherForecast { Date = DateTime.Now.AddDays(3), TemperatureC = 10, Summary = "Cold" },
+			new WeatherForecast { Date = DateTime.Now.AddDays(4), TemperatureC = 5, Summary = "Freezing" }
+		};
+
+		[HttpGet]
+		public IActionResult GetWeather()
+		{
+			return Ok(_weatherForecasts);
+		}
+
+		[HttpPost]
+		public ActionResult<WeatherForecast> PostWeather([FromBody, Required] WeatherForecast? weatherForecast)
+		{
+			if (weatherForecast == null || ModelState.IsValid == false)
+			{
+				return ValidationProblem(this.ModelState);
+			}
+
+			return CreatedAtAction(nameof(GetWeather), weatherForecast);
+		}
+
+		[HttpPatch("{id}")]
+		public IActionResult PatchWeather(int id, [FromBody, Required] JsonPatchDocument<WeatherForecast>? patchDoc)
+		{
+			var weatherForecast = _weatherForecasts[id];
+			if (weatherForecast == null)
+			{
+				return NotFound();
+			}
+
+			patchDoc.ApplyTo(weatherForecast);
+			TryValidateModel(weatherForecast);
+			if (ModelState.IsValid == false)
+			{
+				return ValidationProblem(this.ModelState);
+			}
+
+			return Ok();
+		}
+	}
+
+	public class WeatherForecast
+	{
+		public DateTime Date { get; set; }
+		[Required]
+		public int? TemperatureC { get; set; }
+		public string Summary { get; set; }
+	}
+}

SystemTextJsonPatch.ApiTest/Program.cs

@@ -0,0 +1,12 @@
+using Microsoft.AspNetCore.Mvc;
+
+var builder = WebApplication.CreateBuilder(args);
+
+builder.Services.AddControllers();
+
+var app = builder.Build();
+
+app.MapControllers();
+app.UseHttpsRedirection();
+
+app.Run();

SystemTextJsonPatch.ApiTest/Properties/launchSettings.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json.schemastore.org/launchsettings.json",
+  "profiles": {
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "launchUrl": "weatherforecast",
+      "applicationUrl": "http://localhost:5290",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "launchUrl": "weatherforecast",
+      "applicationUrl": "https://localhost:7027;http://localhost:5290",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

SystemTextJsonPatch.ApiTest/SystemTextJsonPatch.ApiTest.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\SystemTextJsonPatch\SystemTextJsonPatch.csproj" />
+  </ItemGroup>
+
+</Project>

SystemTextJsonPatch.ApiTest/appsettings.Development.json

@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}

SystemTextJsonPatch.ApiTest/appsettings.json

@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}

SystemTextJsonPatch.Benchmark/Benchmarks/DeserializeAndApplyToBenchmark.cs

@@ -17,14 +17,18 @@ public void GlobalSetup()
 		};
 	}
 
-	public static string DeserializePatchDocJson = string.Format("[" + "{{\"op\": \"replace\", \"path\": \"number\", \"value\": 86632}}," +
-	                                                             "{{\"op\": \"replace\", \"path\": \"text\", \"value\": \"testing-performance\"}}," +
-	                                                             "{{\"op\": \"add\", \"path\": \"amount\", \"value\": 86632.172712}}," +
-	                                                             "{{\"op\": \"replace\", \"path\": \"amount2\", \"value\": null}}," +
-	                                                             "{{\"op\": \"replace\", \"path\": \"subTestModel\", \"value\": {{\"id\": 91117, \"data\": 78}}}}," +
-	                                                             "{{\"op\": \"test\", \"path\": \"number\", \"value\": 86632}}," +
-	                                                             "{{\"op\": \"copy\", \"path\": \"amount2\", \"from\": \"amount\"}}," +
-	                                                             "{{\"op\": \"remove\", \"path\": \"text\"}}" + "]");
+	public static string DeserializePatchDocJson = string.Format(
+		"[" +
+		"{{\"op\": \"replace\", \"path\": \"Number\", \"value\": 86632}}," +
+		"{{\"op\": \"replace\", \"path\": \"Text\", \"value\": \"testing-performance\"}}," +
+		"{{\"op\": \"add\", \"path\": \"Amount\", \"value\": 86632.172712}}," +
+		"{{\"op\": \"replace\", \"path\": \"Amount2\", \"value\": null}}," +
+		"{{\"op\": \"replace\", \"path\": \"SubTestModel\", \"value\": {{\"Id\": 91117, \"Data\": 78}}}}," +
+		"{{\"op\": \"test\", \"path\": \"Number\", \"value\": 86632}}," +
+		"{{\"op\": \"copy\", \"path\": \"Amount2\", \"from\": \"Amount\"}}," +
+		"{{\"op\": \"remove\", \"path\": \"Text\"}}" +
+		"]"
+	);
 
 
 	[Benchmark]

SystemTextJsonPatch.Benchmark/SystemTextJsonPatch.Benchmark.csproj

@@ -2,17 +2,17 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net9.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>disable</Nullable>
     <IsPackable>false</IsPackable>
     <IsPublishable>false</IsPublishable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="BenchmarkDotNet" Version="0.13.7" />
+    <PackageReference Include="BenchmarkDotNet" Version="0.14.0" />
     <PackageReference Include="Marvin.JsonPatch" Version="2.2.1" />
-    <PackageReference Include="Microsoft.AspNetCore.JsonPatch" Version="7.0.10" />
+    <PackageReference Include="Microsoft.AspNetCore.JsonPatch" Version="9.0.1" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
   </ItemGroup>
 

SystemTextJsonPatch.Console/DeserializeTest.cs

@@ -7,14 +7,14 @@ public class DeserializeTest
 	{
 		public static string DeserializePatchDocJson = string.Format(
 			"[" +
-			"{{\"op\": \"replace\", \"path\": \"number\", \"value\": 86632}}," +
-			"{{\"op\": \"replace\", \"path\": \"text\", \"value\": \"testing-performance\"}}," +
-			"{{\"op\": \"add\", \"path\": \"amount\", \"value\": 86632.172712}}," +
-			"{{\"op\": \"replace\", \"path\": \"amount2\", \"value\": null}}," +
-			"{{\"op\": \"replace\", \"path\": \"subTestModel\", \"value\": {{\"id\": 91117, \"data\": 78}}}}," +
-			"{{\"op\": \"test\", \"path\": \"number\", \"value\": 86632}}," +
-			"{{\"op\": \"copy\", \"path\": \"amount2\", \"from\": \"amount\"}}," +
-			"{{\"op\": \"remove\", \"path\": \"text\"}}" +
+			"{{\"op\": \"replace\", \"path\": \"Number\", \"value\": 86632}}," +
+			"{{\"op\": \"replace\", \"path\": \"Text\", \"value\": \"testing-performance\"}}," +
+			"{{\"op\": \"add\", \"path\": \"Amount\", \"value\": 86632.172712}}," +
+			"{{\"op\": \"replace\", \"path\": \"Amount2\", \"value\": null}}," +
+			"{{\"op\": \"replace\", \"path\": \"SubTestModel\", \"value\": {{\"Id\": 91117, \"Data\": 78}}}}," +
+			"{{\"op\": \"test\", \"path\": \"Number\", \"value\": 86632}}," +
+			"{{\"op\": \"copy\", \"path\": \"Amount2\", \"from\": \"Amount\"}}," +
+			"{{\"op\": \"remove\", \"path\": \"Text\"}}" +
 			"]"
 		);
 

SystemTextJsonPatch.Console/SystemTextJsonPatch.Console.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net9.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <IsPackable>false</IsPackable>
     <IsPublishable>false</IsPublishable>

SystemTextJsonPatch.Tests/ExceptionTests.cs

@@ -0,0 +1,26 @@
+using SystemTextJsonPatch.Exceptions;
+using SystemTextJsonPatch.Tests.TestObjectModels;
+using Xunit;
+
+namespace SystemTextJsonPatch.Tests
+{
+	public class ExceptionTests
+	{
+		[Fact]
+		public void OperationShouldBeAvailableInTheException()
+		{
+			var targetObject = new MyCustomDateOnly(2000, 10, 1);
+
+			var patchDocument = new JsonPatchDocument();
+			patchDocument.Replace("NewInt", 1);
+
+			// Act
+			var exc = Assert.Throws<JsonPatchException>(() => patchDocument.ApplyTo(targetObject));
+
+			Assert.Equal("The target location specified by path segment 'NewInt' was not found.", exc.Message);
+			Assert.NotNull(exc.FailedOperation);
+			Assert.Equal("replace", exc.FailedOperation.Op);
+			Assert.Equal("/NewInt", exc.FailedOperation.Path);
+		}
+	}
+}