Skip to content

fix: forward template cancellation tokens#468

Merged
JerrettDavis merged 1 commit into
mainfrom
coverage/harden-generator-gaps-413-d
May 31, 2026
Merged

fix: forward template cancellation tokens#468
JerrettDavis merged 1 commit into
mainfrom
coverage/harden-generator-gaps-413-d

Conversation

@JerrettDavis

@JerrettDavis JerrettDavis commented May 31, 2026

Copy link
Copy Markdown
Owner

Refs #413.

Summary

  • forward CancellationToken parameters for synchronous Template steps and hooks when async wrapper generation is inferred
  • add TinyBDD coverage for sync Template members that accept CancellationToken across before/step/after/error paths
  • add TinyBDD coverage for Template steps missing a context parameter

Validation

  • dotnet test test\PatternKit.Generators.Tests\PatternKit.Generators.Tests.csproj --configuration Release -p:TestTfmsInParallel=false --filter "FullyQualifiedName~TemplateGeneratorTests"
  • dotnet test test\PatternKit.Generators.Tests\PatternKit.Generators.Tests.csproj --configuration Release -p:TestTfmsInParallel=false --collect:"XPlat Code Coverage" --results-directory TestResults-generators-current -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=cobertura

Copilot AI review requested due to automatic review settings May 31, 2026 04:05
@github-actions

github-actions Bot commented May 31, 2026

Copy link
Copy Markdown
Contributor

⚠️ Deprecation Warning: The deny-licenses option is deprecated for possible removal in the next major release. For more information, see issue 997.

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Template source generator to correctly forward CancellationToken to synchronous hooks/steps when an async wrapper (ExecuteAsync) is generated, and adds TinyBDD scenarios to cover the new emission paths and a missing-context diagnostic (per #413 coverage goals).

Changes:

  • Forward CancellationToken to sync template hooks/steps inside the generated async wrapper when the target member declares a CancellationToken parameter.
  • Add generator tests ensuring forwarding occurs across before/step/after/on-error paths.
  • Add generator test coverage for a step method that lacks a required context parameter (PKTMP004).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/PatternKit.Generators/TemplateGenerator.cs Updates async wrapper emission to pass ct to sync hooks/steps when applicable.
test/PatternKit.Generators.Tests/TemplateGeneratorTests.cs Adds TinyBDD scenarios covering cancellation token forwarding and missing-context diagnostics.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +569 to +571
var hasCt = hook.Method.Parameters.Any(IsCancellationToken);
var args = hasCt ? "ctx, ct" : "ctx";
sb.AppendLine($" {hook.Method.Name}({args});");
@github-actions

github-actions Bot commented May 31, 2026

Copy link
Copy Markdown
Contributor

Test Results

    12 files      12 suites   10m 48s ⏱️
 3 982 tests  3 982 ✅ 0 💤 0 ❌
12 377 runs  12 377 ✅ 0 💤 0 ❌

Results for commit 92984d5.

♻️ This comment has been updated with latest results.

@codecov

codecov Bot commented May 31, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.17%. Comparing base (b4c0e50) to head (92984d5).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #468      +/-   ##
==========================================
+ Coverage   97.03%   97.17%   +0.13%     
==========================================
  Files         579      579              
  Lines       47168    47180      +12     
  Branches     3088     6768    +3680     
==========================================
+ Hits        45768    45845      +77     
+ Misses       1400     1335      -65     
Flag Coverage Δ
unittests 97.17% <100.00%> (+0.13%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions

github-actions Bot commented May 31, 2026

Copy link
Copy Markdown
Contributor

🔍 PR Validation Results

Version: ``

✅ Validation Steps

  • Build solution
  • Run tests
  • Build documentation
  • Dry-run NuGet packaging

📊 Artifacts

Dry-run artifacts have been uploaded and will be available for 7 days.


This comment was automatically generated by the PR validation workflow.

@JerrettDavis
JerrettDavis force-pushed the coverage/harden-generator-gaps-413-d branch from 4c7dbbd to 92984d5 Compare May 31, 2026 04:21
@github-actions

Copy link
Copy Markdown
Contributor

Code Coverage

Summary
  Generated on: 05/31/2026 - 04:30:00
  Coverage date: 05/31/2026 - 04:27:15 - 05/31/2026 - 04:29:48
  Parser: MultiReport (12x Cobertura)
  Assemblies: 5
  Classes: 1715
  Files: 579
  Line coverage: 97%
  Covered lines: 45789
  Uncovered lines: 1391
  Coverable lines: 47180
  Total lines: 100741
  Branch coverage: 82.8% (14308 of 17260)
  Covered branches: 14308
  Total branches: 17260
  Method coverage: 97.2% (8967 of 9224)
  Full method coverage: 91.2% (8417 of 9224)
  Covered methods: 8967
  Fully covered methods: 8417
  Total methods: 9224

PatternKit.Core                                                                                                       96%
  PatternKit.Application.ActivityTracking.ActivityGateState                                                          100%
  PatternKit.Application.ActivityTracking.ActivityLease                                                              100%
  PatternKit.Application.ActivityTracking.ActivityRecord                                                             100%
  PatternKit.Application.ActivityTracking.ActivityTracker                                                            100%
  PatternKit.Application.Aggregates.AggregateCommandHandler<T1, T2, T3>                                              100%
  PatternKit.Application.Aggregates.AggregateCommandResult<T>                                                        100%
  PatternKit.Application.Aggregates.AggregateRoot<T1, T2>                                                            100%
  PatternKit.Application.AntiCorruption.AntiCorruptionLayer<T1, T2>                                                 90.4%
  PatternKit.Application.AntiCorruption.AntiCorruptionResult<T>                                                      100%
  PatternKit.Application.AuditLog.AuditLogAppendResult<T>                                                           85.7%
  PatternKit.Application.AuditLog.InMemoryAuditLog<T1, T2>                                                          95.4%
  PatternKit.Application.BoundedContexts.BoundedContextAdapter                                                       100%
  PatternKit.Application.BoundedContexts.BoundedContextCapability                                                   83.3%
  PatternKit.Application.BoundedContexts.BoundedContextDescriptor                                                   95.4%
  PatternKit.Application.ContextMaps.ContextMapDescriptor                                                           96.8%
  PatternKit.Application.ContextMaps.ContextMapRelationship                                                          100%
  PatternKit.Application.DataMapping.DataMapper<T1, T2>                                                             94.6%
  PatternKit.Application.DataMapping.DataMapperError                                                                  90%
  PatternKit.Application.DataMapping.DataMapperResult<T>                                                            84.6%
  PatternKit.Application.DomainEvents.DomainEventDispatcher<T>                                                      95.4%
  PatternKit.Application.DomainEvents.DomainEventDispatchResult                                                      100%
  PatternKit.Application.DomainServices.DomainServiceOperation<T1, T2>                                               100%
  PatternKit.Application.DomainServices.DomainServiceRegistry<T1, T2>                                                100%
  PatternKit.Application.EventSourcing.EventStoreAppendResult                                                        100%
  PatternKit.Application.EventSourcing.InMemoryEventStore<T1, T2>                                                   97.9%
  PatternKit.Application.EventSourcing.StoredEvent<T1, T2>                                                            80%
  PatternKit.Application.EventualConsistency.EventualConsistencyEvaluation<T>                                       92.3%
  PatternKit.Application.EventualConsistency.EventualConsistencyMonitor<T>                                          97.2%
  PatternKit.Application.EventualConsistency.EventualConsistencyMonitorState<T>                                      100%
  PatternKit.Application.EventualConsistency.EventualConsistencyWatermarks<T>                                       96.7%
  PatternKit.Application.FeatureToggles.FeatureToggleDecision                                                       87.5%
  PatternKit.Application.FeatureToggles.FeatureToggleRule<T>                                                         100%
  PatternKit.Application.FeatureToggles.FeatureToggleSet<T>                                                         96.9%
  PatternKit.Application.IdentityMap.IdentityMap<T1, T2>                                                             100%
  PatternKit.Application.IdentityMap.IdentityMapResult<T>                                                           92.8%
  PatternKit.Application.ManualTaskGates.ManualTaskGate<T>                                                          98.5%
  PatternKit.Application.ManualTaskGates.ManualTaskGateState<T>                                                      100%
  PatternKit.Application.ManualTaskGates.ManualTaskRecord<T>                                                        96.9%

@JerrettDavis
JerrettDavis merged commit 167bee2 into main May 31, 2026
12 checks passed
@JerrettDavis
JerrettDavis deleted the coverage/harden-generator-gaps-413-d branch May 31, 2026 04:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants