XiHan.Framework.Workflow.Conformance 5.0.0-preview.1

Prefix Reserved
This is a prerelease version of XiHan.Framework.Workflow.Conformance.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package XiHan.Framework.Workflow.Conformance --version 5.0.0-preview.1
                    
NuGet\Install-Package XiHan.Framework.Workflow.Conformance -Version 5.0.0-preview.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="XiHan.Framework.Workflow.Conformance" Version="5.0.0-preview.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="XiHan.Framework.Workflow.Conformance" Version="5.0.0-preview.1" />
                    
Directory.Packages.props
<PackageReference Include="XiHan.Framework.Workflow.Conformance" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add XiHan.Framework.Workflow.Conformance --version 5.0.0-preview.1
                    
#r "nuget: XiHan.Framework.Workflow.Conformance, 5.0.0-preview.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package XiHan.Framework.Workflow.Conformance@5.0.0-preview.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=XiHan.Framework.Workflow.Conformance&version=5.0.0-preview.1&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=XiHan.Framework.Workflow.Conformance&version=5.0.0-preview.1&prerelease
                    
Install as a Cake Tool

XiHan.Framework.Workflow.Conformance

工作流一致性套件(工具链,RFC-0021):Provider 继承三个抽象测试类并实现夹具,通过全部用例。存储是作用域服务,用例在夹具开的调用里使用它们(WorkflowStoreHost.InPartitionAsync);不加入调用方事务的 Provider(内存实现)覆写 JoinsCallerTransaction => false,事务相关的用例照实断言;只读调用的用例(30)两种 Provider 同一断言:写入在执行活动之前以 PERSISTENCE_UNEXPECTED_001 拒绝、调用本身成功(ADR-0099)。

类型 用途
WorkflowStoreConformance + WorkflowStoreHost 三个存储与实例锁:按 ID / 名字 / 版本 / 最新已发布查、列表排序与过滤、批量写与删、级联、快照语义、到期 / 种类与键 / 信号查询、可领取书签按到期时刻限量查询、待办查询的过滤 / 升降序 / 分页 / 计数且随实例状态进出、定义查询的过滤 / 分页 / 计数与关键字按字面且不跨字段匹配、实例列表的关联 ID 集合 / 只取顶层 / 关键字(标题或关联 ID)、定义查询的创建时间区间与每个排序字段的升降序、实例列表每个排序字段的升降序(次序键补成全序、标题按前 256 个字符、可空时间只比较有值的行,ADR-0102;状态按生命周期、状态变了位置随之变化,ADR-0103)、多字段排序(主次字段的组合、升降混合、含状态、分页稳定、空列表等于缺省,ADR-0104)、待办的关键字(任务标题、实例标题、定义名或关联 ID)、按分区的名字空间、分区互不可见、写入别的分区的记录即抛出、锁的互斥与超时(锁等待上限配置在 1 秒以内)
WorkflowEngineConformance + WorkflowEngineHost 装配了 Provider 的宿主上跑引擎:顺序流与事件、决策与默认出边、并行与汇合、用户任务 Any / All / Sequential、转办与加签、延时与超时(PollAsync 轮询一次)、信号、子流程与 ForEach、重试与继续、挂起 / 恢复 / 取消 / 终止与补偿、定义生命周期与结果处理器、死循环保护、分区隔离(平台与租户对等:任务、信号、定义的名字空间与实例的控制和查询)、并发的拒绝重复启动只建一个实例、业务回滚丢弃引擎写入、办理任务随业务提交或回滚、实例锁持有到调用结束、只读调用在执行活动之前拒绝写入、轮询覆盖平台与每个启用的租户、实例查询的分页与清理的条数越界是校验错误(WORKFLOW_VALIDATION_002)、目录的定义查询(摘要的一页与总数、分页越界)、实例查询只取顶层与一组关联 ID(子流程继承发起人与关联 ID、集合越界与空集合)、按实例列出全部等待点(全部书签种类、分区隔离)、目录与实例查询的排序经引擎下推且排序项越界——字段不在白名单、重复、超过上限——是校验错误(ADR-0102、ADR-0104)、按状态排序是生命周期的先后且经目录与引擎改了状态之后位置随之变化(ADR-0103)、故障存消息键与参数并按调用方的区域本地化——发起即故障、完成任务之后活动失败、子流程故障(子实例的故障是内层原因),经存储与事件往返之后仍在——以及返回的校验错误只带消息键与参数(ADR-0105)、设计期诊断与活动描述符、lastError、表达式的运行期错误、子流程被取消与状态不允许操作都按调用方的区域渲染(ADR-0106)、宿主里别的发布端的消息照常确认且不当工作流事件解析(ADR-0096 修订);AsTenantAsync 以租户开一次调用(可选回滚),PublishManyAsync 在一个分区里批量发布
WorkflowTaskConformance + WorkflowEngineHost 用户任务增强与外部任务(StartAsync 同 WorkflowEngineConformance):会签阈值(按人数或百分比)、认领与释放、退回与历史、催办事件、条件查询的分页结果与总数(越界是校验错误、挂起的实例的任务不出现)、任务元数据(优先级、到期、表单键)与周期提醒、外部任务的领取 / 完成 / 失败 / 锁、按创建先后限量领取与条数上限
ConformanceLog、RecordActivity、RecordingOutcomeHandler 套件登记进容器的记录器(兼消息代理:送达的工作流事件记进 Events,别的发布端的消息只记主题进 OtherTopics)、活动与结果处理器

并发启动用例给实例存储与实例锁套装饰器,把两个启动的交错固定下来:Provider 要以具体类型登记存储与锁(AddScoped<MyInstanceStore>()、AddSingleton<MyInstanceLock>()),再以 TryAdd 把接口转给具体类型,套件先登记的接口才能让位给装饰器(存储的装饰器按作用域)。

事件在代理一侧记录(ADR-0096 第六节):Register 把 ConformanceLog 登记成 IMessageBroker——消息 Provider 以 TryAdd 登记代理与直接发布者(框架的内存、RabbitMQ、Kafka 都是),先登记的记录器不被顶替;没装消息 Provider 的宿主由套件补上 DirectPublisher。宿主装了发件箱(OutboxFeature)也照常:事件随事务写进发件箱,夹具的 InScopeAsync、AsTenantAsync 在操作结束之后、PollAsync 在轮询之后调 WorkflowEngineHost.DrainOutboxAsync,把已提交的事件立即投递给记录器,回滚的不送达;同一信封按 ID 只记一次。所以应用可以在自己装着发件箱的真实宿主上跑这两个套件,不用另起不装发件箱的宿主。记录器只把工作流事件(信封来源是 WorkflowTopics.Source,即 /workflow)解析进 Events;宿主里别的发布端(调度的作业事件、应用自己的消息)送来的照常确认成功、不解析,主题按送达顺序记进 OtherTopics(ADR-0096 修订)——调度等发布端不会因套件记告警,发件箱的投递轮次也不会因别的主题失败。记录器只记录、不消费:套件运行时宿主别的消息订阅仍收不到消息。在夹具之外操作引擎后要读事件,先调 DrainOutboxAsync。

租户相关的用例经 ITenantStore 取租户:套件以 TryAdd 登记一份固定的租户目录(t1、t2、t-other 启用,t-off 停用),夹具不必装配多租户。

延时启动与外部任务的锁到期、重试时刻由用例推进时钟判定:configure 里登记手动推进的 TimeProvider,Provider 的引擎、存储与轮询器须从容器取时钟,不读墙钟。

public sealed class InMemoryWorkflowEngineConformanceTests : WorkflowEngineConformance
{
    protected override async Task<WorkflowEngineHost> StartAsync(Action<IServiceCollection> configure, IEnumerable<KeyValuePair<string, string?>>? configuration = null)
    {
        var host = await TestHost.StartAsync(static b => b.UseFeature<InMemoryWorkflowFeature>(), configuration, configure);
        var poller = host.Services.GetRequiredService<DueBookmarkPoller>();
        return new WorkflowEngineHost(host.Services, ct => poller.PollOnceAsync(100, ct), host);
    }
}

夹具的释放句柄先停宿主、再删库:TestHost / WebApplication 的停止让应用排空,数据库工作流的轮询器在排空中释放领导权、等循环退出(ADR-0087),之后删库没有任何告警;先删库再停,还在服务的宿主会如实报 WORKFLOW_UNAVAILABLE_001。

依赖方向

依赖 XiHan.Framework.Workflow.Abstractions 与 xUnit v3。被各 Provider 的测试项目引用。

状态

P0:可用(Preview)。

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
5.0.0-preview.2 45 11/6/2026
5.0.0-preview.1 44 11/4/2026