Skip to content

Change Feed Processor: Fixes duplicate lease docs by using id as partition-key value #5799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
NaluTripician wants to merge 1 commit into from
Closed

Change Feed Processor: Fixes duplicate lease docs by using id as partition-key value #5799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions ...Azure.Cosmos/src/ChangeFeedProcessor/LeaseManagement/DocumentServiceLeaseManagerCosmos.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,11 @@ public override Task<DocumentServiceLease> CreateLeaseIfNotExistAsync(
Mode = this.GetChangeFeedMode()
};

this.requestOptionsFactory.AddPartitionKeyIfNeeded((string pk) => documentServiceLease.LeasePartitionKey = pk, Guid.NewGuid().ToString());
// Use the lease document id as the partition-key value so that retries / concurrent
// creates for the same lease resolve to the same (id, partitionKey) tuple. This lets the
// Cosmos per-partition-key id-uniqueness check turn duplicates into a 409 Conflict
// instead of silently persisting cross-partition-key duplicates.
this.requestOptionsFactory.AddPartitionKeyIfNeeded((string pk) => documentServiceLease.LeasePartitionKey = pk, leaseDocId);

return this.TryCreateDocumentServiceLeaseAsync(documentServiceLease);
}
Expand All @@ -153,7 +157,11 @@ public override Task<DocumentServiceLease> CreateLeaseIfNotExistAsync(
Mode = this.GetChangeFeedMode()
};

this.requestOptionsFactory.AddPartitionKeyIfNeeded((string pk) => documentServiceLease.LeasePartitionKey = pk, Guid.NewGuid().ToString());
// Use the lease document id as the partition-key value so that retries / concurrent
// creates for the same lease resolve to the same (id, partitionKey) tuple. This lets the
// Cosmos per-partition-key id-uniqueness check turn duplicates into a 409 Conflict
// instead of silently persisting cross-partition-key duplicates.
this.requestOptionsFactory.AddPartitionKeyIfNeeded((string pk) => documentServiceLease.LeasePartitionKey = pk, leaseDocId);

return this.TryCreateDocumentServiceLeaseAsync(documentServiceLease);
}
Expand Down
7 changes: 7 additions & 0 deletions ...s/tests/Microsoft.Azure.Cosmos.Tests/ChangeFeed/DocumentServiceLeaseManagerCosmosTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,13 @@ private static void ValidateRequestOptionsFactory(RequestOptionsFactory requestO
else if (requestOptionsFactory is PartitionedByPartitionKeyCollectionRequestOptionsFactory)
{
Assert.IsNotNull(lease.PartitionKey);

// The lease's partition-key value must equal its id so that concurrent/retry creates
// for the same lease resolve to the same (id, partitionKey) tuple and Cosmos's per-
// partition-key id-uniqueness check turns duplicates into a 409 Conflict. Using a
// random Guid here would silently persist cross-partition-key duplicates and stall
// the change feed load balancer. See DocumentServiceLeaseManagerCosmos.CreateLeaseIfNotExistAsync.
Assert.AreEqual(lease.Id, lease.PartitionKey);
}
else
{
Expand Down
Loading