# IdempotencyStoreContract
> Tracon documentation. Tracon is a .NET package family that adds a control
> plane on Microsoft Agent Framework, published as NuGet packages that run
> inside your own ASP.NET Core application.
>
> Page: https://tracon.dev/api/tracon.testing.contracts.storage.idempotencystorecontract/
> Summary: IdempotencyStoreContract: Behavior tests for the IIdempotencyStore contract.
Namespace Tracon.Testing.Contracts.Storage ยท Assembly Tracon.Testing.Contracts.Xunit.dll
Behavior tests for the [IIdempotencyStore](/api/tracon.iidempotencystore/) contract.
```csharp
public abstract class IdempotencyStoreContract : StoreCancellationContract, IAsyncLifetime, IAsyncDisposable
```
- Inheritance
- object โ StoreCancellationContract<IIdempotencyStore> โ IdempotencyStoreContract
- Implements
- IAsyncLifetime, IAsyncDisposable
- Inherited Members
- StoreCancellationContract<IIdempotencyStore>.CreateStoreAsync(), StoreCancellationContract<IIdempotencyStore>.InitializeAsync(), StoreCancellationContract<IIdempotencyStore>.DisposeAsync(), StoreCancellationContract<IIdempotencyStore>.OnDisposeAsync(), StoreCancellationContract<IIdempotencyStore>.CancellableReadAsync(CancellationToken), StoreCancellationContract<IIdempotencyStore>.CancellableWriteAsync(CancellationToken), StoreCancellationContract<IIdempotencyStore>.WroteAnythingAsync(), StoreCancellationContract<IIdempotencyStore>.Canceled_token_throws_on_read(), StoreCancellationContract<IIdempotencyStore>.The_write_this_contract_checks_can_be_read_back(), StoreCancellationContract<IIdempotencyStore>.Canceled_token_throws_on_write_and_leaves_no_trace(), StoreCancellationContract<IIdempotencyStore>.Store, object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
## Remarks
The in-memory store and the three SQL providers must pass the same
scenarios.
The tenant id is passed *explicitly* to every call (not through
the ambient [ITenantContext](/api/tracon.itenantcontext/)) โ the contract therefore does
not rely on the generic CRUD shape of
[Storage.TenantIsolationContract](/api/tracon.testing.contracts.storage/) and derives from
[Storage.StoreCancellationContract](/api/tracon.testing.contracts.storage/) directly; the same pattern
as `SingletonLeaseStoreContract`.
## Constructors
### IdempotencyStoreContract\(\)
```csharp
protected IdempotencyStoreContract()
```
## Methods
### CancellableReadAsync\(CancellationToken\)
Calls one **read** method of the store with the given
token.
```csharp
protected override ValueTask CancellableReadAsync(CancellationToken cancellationToken)
```
#### Parameters
`cancellationToken` [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken)
The token the store must observe.
#### Returns
[ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask)
The completion task; any result is discarded.
#### Remarks
A reservation for a key that already exists is the read path: it
reports the stored state instead of opening a new slot.
### CancellableWriteAsync\(CancellationToken\)
Calls one **write** method of the store with the given
token.
```csharp
protected override ValueTask CancellableWriteAsync(CancellationToken cancellationToken)
```
#### Parameters
`cancellationToken` [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken)
The token the store must observe.
#### Returns
[ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask)
The completion task.
#### Remarks
The write must be one [StoreCancellationContract.WroteAnythingAsync](/api/tracon.testing.contracts.storage/) can see. A write
this contract cannot read back proves nothing about side effects, which
is why [StoreCancellationContract.The_write_this_contract_checks_can_be_read_back](/api/tracon.testing.contracts.storage/)
runs the same pair with a live token and requires the read to find it.
### Completed\_key\_also\_returns\_the\_stored\_HTTP\_headers\(\)
```csharp
[Fact]
public Task Completed_key_also_returns_the_stored_HTTP_headers()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Completed\_key\_returns\_an\_empty\_dictionary\_when\_there\_are\_NO\_headers\(\)
```csharp
[Fact]
public Task Completed_key_returns_an_empty_dictionary_when_there_are_NO_headers()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Completed\_key\_returns\_the\_stored\_response\_with\_the\_same\_fingerprint\(\)
```csharp
[Fact]
public Task Completed_key_returns_the_stored_response_with_the_same_fingerprint()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Completed\_key\_with\_a\_DIFFERENT\_fingerprint\_returns\_FingerprintMismatch\(\)
```csharp
[Fact]
public Task Completed_key_with_a_DIFFERENT_fingerprint_returns_FingerprintMismatch()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Completed\_record\_does\_NOT\_affect\_another\_tenant\(\)
```csharp
[Fact]
public Task Completed_record_does_NOT_affect_another_tenant()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Concurrent\_reservation\_of\_the\_same\_key\_only\_one\_gets\_Reserved\(\)
```csharp
[Fact]
public Task Concurrent_reservation_of_the_same_key_only_one_gets_Reserved()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Key\_in\_progress\_returns\_InProgress\_on\_second\_reservation\(\)
```csharp
[Fact]
public Task Key_in_progress_returns_InProgress_on_second_reservation()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### New\_key\_returns\_Reserved\(\)
```csharp
[Fact]
public Task New_key_returns_Reserved()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Released\_key\_can\_be\_reserved\_again\(\)
```csharp
[Fact]
public Task Released_key_can_be_reserved_again()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Same\_key\_lives\_independently\_in\_two\_tenants\(\)
```csharp
[Fact]
public Task Same_key_lives_independently_in_two_tenants()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### WroteAnythingAsync\(\)
Reports whether [StoreCancellationContract.CancellableWriteAsync](/api/tracon.testing.contracts.storage/) left anything
behind.
```csharp
protected override ValueTask WroteAnythingAsync()
```
#### Returns
[ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[bool](https://learn.microsoft.com/dotnet/api/system.boolean)\>
[true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the store holds any record the write would have created.
#### Remarks
A key nothing ever reserved comes back [IdempotencyState.Reserved](/api/tracon.idempotencystate/)
-- a fresh slot. Any other state means the cancelled call wrote a row.