Fix stale hash/idempotency regressions and add sync-loop regression coverage by Copilot · Pull Request #80 · PTCInc/Kepware-ConfigAPI-SDK-dotnet

Copilot · 2026-04-11T06:15:34Z

This PR resolves the stale-hash and idempotency issues behind the repeated sync-loop behavior reported in #78 and adds the regression coverage requested in #79.

What changed

preserved the hash cache for performance
fixed stale hash invalidation when entity state changes
updated project compare/apply to use effective property diffs instead of raw hash mismatch alone
added regression tests for:
- stale cached hash after mutation
- project compare/apply reporting no changes when no effective diff exists
- idempotent sync/roundtrip behavior already covered in this branch

Issue coverage

Fixes Continuous/Infinite Sync Loop when using KepwareToDiskAndSecondary direction #78 by preventing false-positive change detection that could re-trigger sync work
Addresses Add idempotency regression tests for disk/API sync flow #79 by adding regression protection around hash/idempotency behavior and no-op compare/apply flows

Agent-Logs-Url: https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/sessions/86ad7ece-bec0-429d-a50a-3d4ff8092bde Co-authored-by: BoBiene <23037659+BoBiene@users.noreply.github.com>

Agent-Logs-Url: https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/sessions/2878be68-07b9-4a1d-aaf9-3e5d60bebeb2 Co-authored-by: BoBiene <23037659+BoBiene@users.noreply.github.com>

Agent-Logs-Url: https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/sessions/5052719e-3481-45f1-807f-a4a9760b84f4 Co-authored-by: BoBiene <23037659+BoBiene@users.noreply.github.com>

Copilot

Pull request overview

Fixes stale-hash/idempotency regressions that could cause repeated sync-loop behavior (#78) and adds regression coverage to prevent reintroductions (#79).

Changes:

Invalidate cached entity hashes on state mutation and normalize nested dynamic properties before hashing/diffing.
Update project compare/apply to trigger project-property updates based on effective property diffs (not raw hash mismatch alone).
Add serializer/storage/sync-loop idempotency regression tests (YAML/CSV roundtrip, compare/apply no-op, sync loop protection).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
KepwareSync.Service/Kepware.SyncService.csproj	Exposes internals to the test assembly to enable sync-service regression tests.
Kepware.Api/Model/BaseEntity.cs	Adds hash invalidation on key mutations and ensures normalization occurs before hash/diff operations.
Kepware.Api/ClientHandler/ProjectApiHandler.cs	Switches project-property update decision from hash mismatch to effective diff presence.
Kepware.Api.Test/Util/EntityCompareTests.cs	Adds regression test for stale cached hash after entity mutation.
Kepware.Api.Test/Sync/SyncIdempotencyTests.cs	Adds sync-loop/idempotency regression tests (net10-only).
Kepware.Api.Test/Serializer/RoundtripIdempotencyTests.cs	Adds YAML/CSV roundtrip idempotency tests to ensure stable hashes/output.
Kepware.Api.Test/Kepware.Api.Test.csproj	Adds net10-only reference to SyncService project for the new sync tests.

Copilot · 2026-04-11T07:57:55Z

Kepware.Api.Test/Sync/SyncIdempotencyTests.cs

+                var targetProject = await roundtrippedProject.CloneAsync();
+                AssignOwners(targetProject);
+
+                var sourceTag = roundtrippedProject.Channels![0].Devices![0].Tags![0];


sourceTag is declared but never used. With warnings treated as errors in Kepware.Api.Test.csproj, this will fail the build (CS0219). Remove the variable or use it (e.g., to derive the endpoint/expected diff).

Suggested change

var sourceTag = roundtrippedProject.Channels![0].Devices![0].Tags![0];

Copilot · 2026-04-11T07:57:56Z

Kepware.Api/Model/BaseEntity.cs

        /// Dynamic properties associated with the entity.
        /// </summary>
        [JsonExtensionData]
-        public Dictionary<string, JsonElement> DynamicProperties { get; set; } = new();
+        public Dictionary<string, JsonElement> DynamicProperties
+        {
+            get => _dynamicProperties;
+            set
+            {
+                _dynamicProperties = value ?? [];
+                _dynamicPropertiesNormalized = false;
+                InvalidateHash();
+            }
+        }


DynamicProperties exposes a mutable Dictionary. If a caller mutates it directly (e.g., entity.DynamicProperties["k"] = ... / .Remove(...)) after Hash has been computed, the cached hash will not be invalidated, which can reintroduce stale-hash/idempotency issues. Consider returning an IReadOnlyDictionary (and mutating only through SetDynamicProperty/helpers) or wrapping mutations so they always call InvalidateHash().

Copilot · 2026-04-11T07:57:56Z

Kepware.Api/ClientHandler/ProjectApiHandler.cs

            var result = new ProjectCompareAndApplyResult();
+            var projectPropertyDiff = sourceProject.GetUpdateDiff(projectFromApi);

-            if (sourceProject.Hash != projectFromApi.Hash)
+            if (projectPropertyDiff.Count > 0)
            {
                m_logger.LogInformation("Project properties has changed. Updating project properties...");
                var projectPropertyFailure = await SetProjectPropertiesDetailedAsync(sourceProject, cancellationToken: cancellationToken).ConfigureAwait(false);


projectPropertyDiff is computed here but then SetProjectPropertiesDetailedAsync reloads the current project from the API and recomputes a diff again. Since you already have projectFromApi and the computed diff, consider avoiding the duplicate diff computation and extra GET by adding an overload that accepts the already-loaded current project (and/or the precomputed diff).

Copilot · 2026-04-11T07:57:56Z

Kepware.Api/ClientHandler/ProjectApiHandler.cs

-            if (sourceProject.Hash != projectFromApi.Hash)
+            if (projectPropertyDiff.Count > 0)
            {
                m_logger.LogInformation("Project properties has changed. Updating project properties...");


Log message grammar: "Project properties has changed" should be "Project properties have changed" (or "Project properties changed") for clarity/searchability.

Suggested change

m_logger.LogInformation("Project properties has changed. Updating project properties...");

m_logger.LogInformation("Project properties have changed. Updating project properties...");

Copilot · 2026-04-11T07:57:56Z

Kepware.Api.Test/Sync/SyncIdempotencyTests.cs

+        public async Task CompareAndApply_ProjectHashMismatchWithoutProjectPropertyDiff_ShouldReportNoChanges()
+        {
+            ConfigureConnectedClient();
+
+            var sourceProject = CreateProjectPropertiesOnly(string.Empty);
+            sourceProject.Description = "Transient description";
+            _ = sourceProject.Hash;
+            sourceProject.Description = string.Empty;
+


This test name implies it is exercising a "hash mismatch without effective diff" scenario, but the current arrange code doesn’t assert (or reliably create) a hash mismatch anymore now that Description mutations invalidate the cached hash. Either rename the test to reflect what it actually verifies (no-op compare/apply when there’s no effective diff), or adjust the setup to force a hash mismatch without an effective diff so the regression is truly covered.

Initial plan

4365c8e

Copilot AI assigned Copilot and BoBiene Apr 11, 2026

Copilot started work on behalf of BoBiene April 11, 2026 06:15 View session

Copilot AI linked an issue Apr 11, 2026 that may be closed by this pull request

Add idempotency regression tests for disk/API sync flow #79

Open

5 tasks

test: add sync idempotency regression coverage

9150740

Agent-Logs-Url: https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/sessions/86ad7ece-bec0-429d-a50a-3d4ff8092bde Co-authored-by: BoBiene <23037659+BoBiene@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add idempotency regression tests for disk/API sync flow~~ Add idempotency regression coverage for YAML/CSV roundtrips and disk/API sync flow Apr 11, 2026

Copilot AI requested a review from BoBiene April 11, 2026 06:36

Copilot finished work on behalf of BoBiene April 11, 2026 06:36

Copilot started work on behalf of BoBiene April 11, 2026 07:03 View session

Copilot finished work on behalf of BoBiene April 11, 2026 07:06

Copilot started work on behalf of BoBiene April 11, 2026 07:07 View session

Copilot finished work on behalf of BoBiene April 11, 2026 07:10

Copilot started work on behalf of BoBiene April 11, 2026 07:22 View session

test: add stale hash regression coverage

9c04cd1

Agent-Logs-Url: https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/sessions/2878be68-07b9-4a1d-aaf9-3e5d60bebeb2 Co-authored-by: BoBiene <23037659+BoBiene@users.noreply.github.com>

Copilot finished work on behalf of BoBiene April 11, 2026 07:30

Copilot started work on behalf of BoBiene April 11, 2026 07:34 View session

Copilot AI and others added 2 commits April 11, 2026 07:36

fix: address stale hash comparisons

5bd842d

Agent-Logs-Url: https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/sessions/5052719e-3481-45f1-807f-a4a9760b84f4 Co-authored-by: BoBiene <23037659+BoBiene@users.noreply.github.com>

fix: preserve hash cache with invalidation

603d0d6

Agent-Logs-Url: https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/sessions/5052719e-3481-45f1-807f-a4a9760b84f4 Co-authored-by: BoBiene <23037659+BoBiene@users.noreply.github.com>

Copilot finished work on behalf of BoBiene April 11, 2026 07:43

Copilot started work on behalf of BoBiene April 11, 2026 07:47 View session

BoBiene changed the title ~~Add idempotency regression coverage for YAML/CSV roundtrips and disk/API sync flow~~ Fix stale hash/idempotency regressions and add sync-loop regression coverage Apr 11, 2026

Copilot finished work on behalf of BoBiene April 11, 2026 07:50

BoBiene requested review from Copilot and rlabbeptc April 11, 2026 07:50

Copilot started reviewing on behalf of BoBiene April 11, 2026 07:51 View session

BoBiene marked this pull request as ready for review April 11, 2026 07:51

BoBiene approved these changes Apr 11, 2026

View reviewed changes

Copilot AI reviewed Apr 11, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix stale hash/idempotency regressions and add sync-loop regression coverage#80

Fix stale hash/idempotency regressions and add sync-loop regression coverage#80
Copilot wants to merge 5 commits intomainfrom
copilot/add-idempotency-regression-tests

Copilot AI commented Apr 11, 2026 •

edited by BoBiene

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 11, 2026

Uh oh!

Copilot AI Apr 11, 2026

Uh oh!

Copilot AI Apr 11, 2026

Uh oh!

Copilot AI Apr 11, 2026

Uh oh!

Copilot AI Apr 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	m_logger.LogInformation("Project properties has changed. Updating project properties...");
	m_logger.LogInformation("Project properties have changed. Updating project properties...");

Conversation

Copilot AI commented Apr 11, 2026 • edited by BoBiene Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changed

Issue coverage

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Apr 11, 2026 •

edited by BoBiene

Loading