# WorkflowCheckpointStoreContract > 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.workflowcheckpointstorecontract/ > Summary: WorkflowCheckpointStoreContract: Behavior tests for the IWorkflowCheckpointStore contract.
Namespace Tracon.Testing.Contracts.Storage ยท Assembly Tracon.Testing.Contracts.Xunit.dll
Behavior tests for the [IWorkflowCheckpointStore](/api/tracon.iworkflowcheckpointstore/) contract. ```csharp public abstract class WorkflowCheckpointStoreContract : TenantIsolationContract, IAsyncLifetime, IAsyncDisposable ```
Inheritance
object โ† StoreCancellationContract<IWorkflowCheckpointStore> โ† TenantIsolationContract<IWorkflowCheckpointStore> โ† WorkflowCheckpointStoreContract
Implements
IAsyncLifetime, IAsyncDisposable
Inherited Members
TenantIsolationContract<IWorkflowCheckpointStore>.TenantA, TenantIsolationContract<IWorkflowCheckpointStore>.TenantB, TenantIsolationContract<IWorkflowCheckpointStore>.UseAmbientTenant(MutableTenantContext), TenantIsolationContract<IWorkflowCheckpointStore>.SeedAsync(string, string, CancellationToken), TenantIsolationContract<IWorkflowCheckpointStore>.ExistsAsync(string, object), TenantIsolationContract<IWorkflowCheckpointStore>.CountAsync(string, CancellationToken), TenantIsolationContract<IWorkflowCheckpointStore>.TryDeleteAsync(string, object), TenantIsolationContract<IWorkflowCheckpointStore>.TryOverwriteAsync(string, string), TenantIsolationContract<IWorkflowCheckpointStore>.CancellableReadAsync(CancellationToken), TenantIsolationContract<IWorkflowCheckpointStore>.CancellableWriteAsync(CancellationToken), TenantIsolationContract<IWorkflowCheckpointStore>.WroteAnythingAsync(), TenantIsolationContract<IWorkflowCheckpointStore>.Tenant_cannot_read_another_tenants_record(), TenantIsolationContract<IWorkflowCheckpointStore>.Tenant_reads_its_own_record(), TenantIsolationContract<IWorkflowCheckpointStore>.Tenant_does_not_see_another_tenants_record_in_the_list(), TenantIsolationContract<IWorkflowCheckpointStore>.Tenant_cannot_delete_another_tenants_record(), TenantIsolationContract<IWorkflowCheckpointStore>.Same_name_lives_independently_across_two_tenants(), TenantIsolationContract<IWorkflowCheckpointStore>.AmbientTenant, StoreCancellationContract<IWorkflowCheckpointStore>.CreateStoreAsync(), StoreCancellationContract<IWorkflowCheckpointStore>.InitializeAsync(), StoreCancellationContract<IWorkflowCheckpointStore>.DisposeAsync(), StoreCancellationContract<IWorkflowCheckpointStore>.OnDisposeAsync(), StoreCancellationContract<IWorkflowCheckpointStore>.CancellableReadAsync(CancellationToken), StoreCancellationContract<IWorkflowCheckpointStore>.CancellableWriteAsync(CancellationToken), StoreCancellationContract<IWorkflowCheckpointStore>.WroteAnythingAsync(), StoreCancellationContract<IWorkflowCheckpointStore>.Canceled_token_throws_on_read(), StoreCancellationContract<IWorkflowCheckpointStore>.The_write_this_contract_checks_can_be_read_back(), StoreCancellationContract<IWorkflowCheckpointStore>.Canceled_token_throws_on_write_and_leaves_no_trace(), StoreCancellationContract<IWorkflowCheckpointStore>.Store, object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
## Remarks The most critical scenario is reading back a *polymorphic payload without corruption*: the Microsoft Agent Framework checkpoint JSON carries a `$type` discriminator that must be the first property of the object it appears in. A store that reorders object keys on write can silently take the discriminator out of first place, so a compliant implementation must preserve key order. ## Constructors ### WorkflowCheckpointStoreContract\(\) ```csharp protected WorkflowCheckpointStoreContract() ``` ## Methods ### A\_checkpoint\_written\_without\_version\_stamps\_lists\_back\_null\(\) ```csharp [Fact] public Task A_checkpoint_written_without_version_stamps_lists_back_null() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Another\_tenants\_checkpoint\_is\_NOT\_FOUND\(\) ```csharp [Fact] public Task Another_tenants_checkpoint_is_NOT_FOUND() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### CountAsync\(string, CancellationToken\) Reports how many records the given tenant sees through the listing endpoint. ```csharp protected override ValueTask CountAsync(string tenantId, CancellationToken cancellationToken) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The reading tenant. `cancellationToken` [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken) The token every store call inside the hook must be handed; see [TenantIsolationContract.SeedAsync](/api/tracon.testing.contracts.storage/). #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[int](https://learn.microsoft.com/dotnet/api/system.int32)\> The number of records seen. ### Delete\_clears\_the\_entire\_session\(\) ```csharp [Fact] public Task Delete_clears_the_entire_session() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### ExistsAsync\(string, object\) Reports whether the record is visible from the given tenant's viewpoint. ```csharp protected override ValueTask ExistsAsync(string tenantId, object key) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The reading tenant. `key` [object](https://learn.microsoft.com/dotnet/api/system.object) The key returned by [TenantIsolationContract.SeedAsync](/api/tracon.testing.contracts.storage/). #### 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 record is visible. ### Listing\_by\_run\_filters\_correctly\(\) ```csharp [Fact] public Task Listing_by_run_filters_correctly() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Listing\_does\_NOT\_CARRY\_the\_state\_payload\(\) ```csharp [Fact] public Task Listing_does_NOT_CARRY_the_state_payload() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Listing\_preserves\_creation\_order\(\) ```csharp [Fact] public Task Listing_preserves_creation_order() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Nonexistent\_checkpoint\_returns\_null\(\) ```csharp [Fact] public Task Nonexistent_checkpoint_returns_null() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Polymorphic\_payload\_is\_read\_back\_with\_KEY\_ORDER\_PRESERVED\(\) ```csharp [Fact] public Task Polymorphic_payload_is_read_back_with_KEY_ORDER_PRESERVED() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### SeedAsync\(string, string, CancellationToken\) Writes a sample record for the given tenant. ```csharp protected override ValueTask SeedAsync(string tenantId, string name, CancellationToken cancellationToken) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The tenant that owns the record. `name` [string](https://learn.microsoft.com/dotnet/api/system.string) The name distinguishing the record. The same name may be used by two tenants. `cancellationToken` [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken) The token every store call inside the hook must be handed. The cancellation contract calls this hook with a token that is already cancelled, so a hook that drops the token reports a store as sound when it is not. #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[object](https://learn.microsoft.com/dotnet/api/system.object)\> The key to use for reading the record back. ### StateSchemaVersion\_and\_StateMafVersion\_round\_trip\_through\_listing\_metadata\(\) ```csharp [Fact] public Task StateSchemaVersion_and_StateMafVersion_round_trip_through_listing_metadata() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### TryDeleteAsync\(string, object\) Attempts to delete the record on behalf of the given tenant. ```csharp protected override ValueTask TryDeleteAsync(string tenantId, object key) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The tenant attempting the delete. `key` [object](https://learn.microsoft.com/dotnet/api/system.object) The key returned by [TenantIsolationContract.SeedAsync](/api/tracon.testing.contracts.storage/). #### 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 delete succeeded, [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the record was not found; [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) if the store does not offer deletion. ### Written\_checkpoint\_is\_read\_back\(\) ```csharp [Fact] public Task Written_checkpoint_is_read_back() ``` #### 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.