# RetentionStoreContract
> 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.retentionstorecontract/
> Summary: RetentionStoreContract: Behavior and tenant isolation tests for the IRetentionStore data plane.
Namespace Tracon.Testing.Contracts.Storage · Assembly Tracon.Testing.Contracts.Xunit.dll
Behavior and tenant isolation tests for the [IRetentionStore](/api/tracon.iretentionstore/)
data plane.
```csharp
public abstract class RetentionStoreContract : StoreCancellationContract, IAsyncLifetime, IAsyncDisposable
```
- Inheritance
- object ← StoreCancellationContract<IRetentionStore> ← RetentionStoreContract
- Implements
- IAsyncLifetime, IAsyncDisposable
- Inherited Members
- StoreCancellationContract<IRetentionStore>.CreateStoreAsync(), StoreCancellationContract<IRetentionStore>.InitializeAsync(), StoreCancellationContract<IRetentionStore>.DisposeAsync(), StoreCancellationContract<IRetentionStore>.OnDisposeAsync(), StoreCancellationContract<IRetentionStore>.CancellableReadAsync(CancellationToken), StoreCancellationContract<IRetentionStore>.CancellableWriteAsync(CancellationToken), StoreCancellationContract<IRetentionStore>.WroteAnythingAsync(), StoreCancellationContract<IRetentionStore>.Canceled_token_throws_on_read(), StoreCancellationContract<IRetentionStore>.The_write_this_contract_checks_can_be_read_back(), StoreCancellationContract<IRetentionStore>.Canceled_token_throws_on_write_and_leaves_no_trace(), StoreCancellationContract<IRetentionStore>.Store, object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
## Remarks
This contract guards against a **security
defect**: a data plane with no tenant filter, where one
tenant's retention policy could delete *all* tenants' rows.
The contract does not derive from [Storage.TenantIsolationContract](/api/tracon.testing.contracts.storage/):
the data plane has no concept of a "record" (there is no write side),
seeding goes through the target table's own store. Isolation is tested
directly here, on top of
[Storage.StoreCancellationContract](/api/tracon.testing.contracts.storage/).
## Constructors
### RetentionStoreContract\(\)
```csharp
protected RetentionStoreContract()
```
## Fields
### TenantA
The tenant that writes the data.
```csharp
protected const string TenantA = "tenant-a"
```
#### Field Value
[string](https://learn.microsoft.com/dotnet/api/system.string)
### TenantB
The tenant whose data must be preserved.
```csharp
protected const string TenantB = "tenant-b"
```
#### Field Value
[string](https://learn.microsoft.com/dotnet/api/system.string)
## Methods
### A\_failed\_archive\_write\_deletes\_nothing\(\)
```csharp
[Fact]
public Task A_failed_archive_write_deletes_nothing()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Archive\_batches\_delete\_only\_the\_rows\_they\_archived\(\)
```csharp
[Fact]
public Task Archive_batches_delete_only_the_rows_they_archived()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Archive\_read\_returns\_only\_the\_given\_tenant\(\)
```csharp
[Fact]
public Task Archive_read_returns_only_the_given_tenant()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### 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.
### 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.
### Count\_covers\_only\_the\_given\_tenant\(\)
```csharp
[Fact]
public Task Count_covers_only_the_given_tenant()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Delete\_does\_NOT\_touch\_the\_others\_data\(\)
```csharp
[Fact]
public Task Delete_does_NOT_touch_the_others_data()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### Row\_limit\_threshold\_counts\_only\_the\_given\_tenant\(\)
```csharp
[Fact]
public Task Row_limit_threshold_counts_only_the_given_tenant()
```
#### Returns
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
### SeedOldRowAsync\(string\)
Writes a row for the given tenant, older than the cutoff date, that
falls under the [RetentionTargets.VoiceSessions](/api/tracon.retentiontargets/#Tracon_RetentionTargets_VoiceSessions) target.
```csharp
protected abstract ValueTask SeedOldRowAsync(string tenantId)
```
#### Parameters
`tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string)
The tenant that owns the row.
#### Returns
[ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask)
The completion task.
### SeedOldRowAsync\(string, DateTimeOffset\)
Writes a row like [RetentionStoreContract.SeedOldRowAsync](/api/tracon.testing.contracts.storage.retentionstorecontract/) that started at
`startedAt`.
```csharp
protected virtual ValueTask SeedOldRowAsync(string tenantId, DateTimeOffset startedAt)
```
#### Parameters
`tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string)
The tenant that owns the row.
`startedAt` [DateTimeOffset](https://learn.microsoft.com/dotnet/api/system.datetimeoffset)
When the row started; older than the cutoff date.
#### Returns
[ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask)
The completion task.
#### Remarks
The default ignores `startedAt` and calls
[RetentionStoreContract.SeedOldRowAsync](/api/tracon.testing.contracts.storage.retentionstorecontract/). Override it: the archive case
writes rows whose time order is the reverse of their write order, and
that is the order that shows a delete which does not follow the archive.
### Unknown\_target\_throws\(\)
```csharp
[Fact]
public Task Unknown_target_throws()
```
#### 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
The seeded row must still be there. A sweep that threw but deleted
anyway is exactly the defect this case exists for.