001 generator reliability hardening #21

aabs · 2025-12-05T23:07:44Z

No description provided.

…ability hardening - Introduced a comprehensive feature specification document outlining user scenarios, requirements, success criteria, and edge cases for hardening the ActorSrcGen source generator. - Created a detailed task list organized by phases and user stories, including setup, foundation, and implementation of determinism, thread safety, and comprehensive testing. - Established clear acceptance criteria and measurable outcomes for each user story to ensure reliability and testability of the generator.

…nd enhance tests - Introduced a new diagnostics class with rules for actor definitions, including checks for step methods and entry points. - Created a coverage workflow in GitHub Actions to ensure code quality and coverage reporting. - Added helper classes for compilation and snapshot testing to streamline test setup. - Implemented integration tests for actor generation, ensuring deterministic outputs across multiple runs and varying input orders. - Developed unit tests for ActorNode and BlockNode, verifying their properties and behaviors. - Enhanced diagnostic message tests to validate expected outputs for various actor configurations. - Added generated code snapshots for various actor patterns to ensure consistency in generated outputs.

…ead safety improvements

… safety, enhance stress testing capabilities

…or and BlockGraph functionalities

- Implemented various integration tests for actor patterns, including single-step, multi-input, and ingest methods. - Added attribute validation tests to ensure correct usage of actor attributes. - Created diagnostic snapshot tests to verify proper diagnostic messages for invalid actor configurations. - Enhanced existing unit tests for cancellation handling in generator methods. - Updated generator context creation to support cancellation tokens. - Introduced new test cases for invalid ingest methods and multiple step definitions. - Verified generated code against expected outputs for various actor configurations.

…rence, and TDD workflow

Copilot

Pull request overview

This pull request implements comprehensive reliability hardening for the ActorSrcGen source generator, transforming it from minimal test coverage (~0-20%) to enterprise-grade quality with 85%+ overall coverage and 100% critical path coverage. The PR follows a Test-Driven Development approach and addresses constitutional violations around immutability, testability, and diagnostic reporting.

Key Changes

Test Infrastructure Expansion: Added comprehensive test suite with 50+ unit tests, 20+ integration tests, and snapshot testing infrastructure using xUnit and Verify
Domain Model Refactoring: Introduced immutable VisitorResult record to enable pure functional visitor design
Test Coverage: Achieved comprehensive coverage of Generator, ActorVisitor, ActorGenerator, and helper utilities through unit and integration tests

Reviewed changes

Copilot reviewed 93 out of 96 changed files in this pull request and generated 49 comments.

Show a summary per file

File	Description
tests/ActorSrcGen.Tests/Usings.cs	Added global usings for System.Collections.Immutable, VerifyTests, and VerifyXunit to support new test infrastructure
tests/ActorSrcGen.Tests/Unit/*.cs	Comprehensive unit test suite covering TypeHelpers, RoslynExtensions, ActorVisitor, Generator, BlockNode, ActorNode, and Diagnostics with 100% critical path coverage
tests/ActorSrcGen.Tests/Integration/*.cs	Integration tests for snapshot patterns, stress testing, thread safety, cancellation, determinism, and diagnostic reporting
tests/ActorSrcGen.Tests/Snapshots/*/.verified.cs	Snapshot test verified outputs for various actor patterns (SimpleActor, PipelineActor, MultiInputActor, IngestActor, ReceiverActor, ComplexActor, etc.)
tests/ActorSrcGen.Tests/Helpers/*.cs	Test helper utilities for compilation setup, snapshot verification, and test actor factory patterns
ActorSrcGen/Model/VisitorResult.cs	New immutable record encapsulating visitor results (actors + diagnostics) to enable pure functional design
ActorSrcGen/Helpers/TypeHelpers.cs	Enhanced null safety with nullable annotations, improved IsCollection to recognize ImmutableArray types, defensive null checks
ActorSrcGen/Templates/Actor.tt	Added null/empty handler body fallback to prevent template crashes when HandlerBody is empty
ActorSrcGen/Properties/AssemblyInfo.cs	Added InternalsVisibleTo for test project access to internal types
ActorSrcGen/IsExternalInit.cs	Shim for C# 9 record support on netstandard2.0 target
tests/ActorSrcGen.Tests/ActorSrcGen.Tests.csproj	Updated test project with Verify.Xunit 24.0.0, coverage configuration (85% threshold), and proper analyzer reference pattern
ReadMe.md	Added Testing and Diagnostics sections with coverage commands and diagnostic reference links
doc/DIAGNOSTICS.md	New diagnostic reference documentation for ASG0001-ASG0003 with remediation guidance
Contributions.md	Added TDD workflow requirements and coverage threshold expectations (85% overall, 100% critical)
Directory.Build.props	Updated Microsoft.SourceLink.GitHub from 1.0.111 to 1.1.1
specs/001-generator-reliability-hardening/*.md	Comprehensive specification, research, data model, quick start guide, plan, tasks, and requirements checklist documentation
tmp-lines.ps1	Utility script for line numbering (appears to be development tooling, not production code)

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

Copilot · 2025-12-05T23:13:06Z

ActorSrcGen/Model/ActorVisitor.cs

+        foreach (var ingest in ingesters)
        {
-            Method = method,
-            NodeType = NodeType.TransformMany,
-            HandlerBody = $$"""
-                            async ({{inputTypeName}} x) => {
-                                try
-                                {
-                                    return await {{method.Name}}(x);
-                                }
-                                catch(Exception e)
-                                {
-                                    LogMessage(LogLevel.Error, $"Error in {{method.Name}}: {e.Message}\nStack Trace: {e.StackTrace}");
-                                    return default;
-                                }
-                            }
-                            """
-        };
+            var method = ingest.Method;
+            var returnsTask = string.Equals(method.ReturnType.Name, "Task", StringComparison.Ordinal) || method.ReturnType.Name.Contains("AsyncEnumerable", StringComparison.Ordinal);
+            if (!method.IsStatic || !returnsTask)
+            {
+                builder.Add(ActorSrcGen.Diagnostics.Diagnostics.CreateDiagnostic(ActorSrcGen.Diagnostics.Diagnostics.ASG0003, method.Locations.FirstOrDefault() ?? Location.None, method.Name));
+            }
+        }


This foreach loop immediately maps its iteration variable to another variable - consider mapping the sequence explicitly using '.Select(...)'.

Copilot · 2025-12-05T23:13:07Z

ActorSrcGen.Playground/Program.cs

+		Console.WriteLine("Called Synchronously");

-    var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
+	var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));


Disposable 'CancellationTokenSource' is created but not disposed.

Suggested change

var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));

using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));

Copilot · 2025-12-05T23:13:07Z

tests/ActorSrcGen.Tests/Unit/ActorGeneratorTests.cs

+        var result = visitor.VisitActor(syntaxAndSymbol);
+        var actor = Assert.Single(result.Actors);
+
+        var diagnostics = new List<Diagnostic>();


The contents of this container are never accessed.

Copilot · 2025-12-05T23:13:07Z

ActorSrcGen/Helpers/TypeHelpers.cs

        }

-        return t.ToDisplayString(SymbolDisplayFormat.MinimallyQualifiedFormat);
+        return t?.ToDisplayString(SymbolDisplayFormat.MinimallyQualifiedFormat) ?? string.Empty;


Condition is always not null because of ... is ....

Suggested change

return t?.ToDisplayString(SymbolDisplayFormat.MinimallyQualifiedFormat) ?? string.Empty;

return t.ToDisplayString(SymbolDisplayFormat.MinimallyQualifiedFormat);

Copilot · 2025-12-05T23:13:08Z

tests/ActorSrcGen.Tests/Integration/ActorPatternTests.cs

+        var src = BuildSingleStep("SingleStepActor1", "input");
+        var output = Generate(src);
+
+        Assert.True(output.ContainsKey("SingleStepActor1.generated.cs"));


Inefficient use of 'ContainsKey' and indexer.

Copilot · 2025-12-05T23:13:18Z

tests/ActorSrcGen.Tests/Snapshots/GeneratedCode/SingleInputOutput.verified.cs

+
+    TransformBlock<string,string> _Process;
+
+    TransformBlock<string,string> _Start;


Field '_Start' can be 'readonly'.

Copilot · 2025-12-05T23:13:18Z

tests/ActorSrcGen.Tests/Snapshots/GeneratedCode/IngestReceiverPattern.verified.cs

+        _Start.LinkTo(_Process, new DataflowLinkOptions { PropagateCompletion = true });
+    }
+
+    TransformBlock<string,string> _Finish;


Field '_Finish' can be 'readonly'.

Copilot · 2025-12-05T23:13:18Z

tests/ActorSrcGen.Tests/Snapshots/GeneratedCode/SingleInputOutput.verified.cs

+        _Start.LinkTo(_Process, new DataflowLinkOptions { PropagateCompletion = true });
+    }
+
+    TransformBlock<string,string> _Process;


Field '_Process' can be 'readonly'.

Copilot · 2025-12-05T23:13:18Z

tests/ActorSrcGen.Tests/Snapshots/GeneratedCode/TransformManyPattern.verified.cs

+        _Start.LinkTo(_Finish, new DataflowLinkOptions { PropagateCompletion = true });
+    }
+
+    TransformBlock<string,string> _Finish;


Field '_Finish' can be 'readonly'.

Copilot · 2025-12-05T23:13:18Z

tests/ActorSrcGen.Tests/Snapshots/GeneratedCode/TransformManyPattern.verified.cs

+
+    TransformBlock<string,string> _Finish;
+
+    TransformManyBlock<string,string> _Start;


Field '_Start' can be 'readonly'.

…CI workflow

… artifacts; modify coverage.yml for improved coverage report generation

…aintainability

…lts directory and format

…ect report paths

mattana added 9 commits December 5, 2025 09:49

Add comprehensive GitHub Copilot instructions and blueprint generator

07ef769

US1

cdf6e3b

feat: Enhance generator reliability with cancellation support and thr…

0ba465b

…ead safety improvements

feat: Add comprehensive integration tests for cancellation and thread…

1d17193

… safety, enhance stress testing capabilities

feat: Enhance TypeHelpers and add extensive unit tests for ActorVisit…

25d74db

…or and BlockGraph functionalities

feat: Enhance documentation with testing guidelines, diagnostics refe…

e39c886

…rence, and TDD workflow

Copilot AI review requested due to automatic review settings December 5, 2025 23:07

Copilot started reviewing on behalf of aabs December 5, 2025 23:08 View session

aabs and others added 2 commits December 6, 2025 10:09

bump version number

9d8efc0

fix: Update coverage report format and paths in CI workflow

2ffba05

Copilot AI reviewed Dec 5, 2025

View reviewed changes

mattana and others added 13 commits December 6, 2025 10:13

fix: Correct coverage report paths in CI workflow

17e4daf

fix: Update coverage testing commands and report generation paths in …

7252dd7

…CI workflow

fix: Update .dockerignore and .gitignore to exclude test and coverage…

fc409d8

… artifacts; modify coverage.yml for improved coverage report generation

fix: Refactor coverage testing command for improved readability and m…

26c6599

…aintainability

fix: Simplify coverage testing setup and adjust report generation paths

1887436

wip

75fed34

fix: Enhance coverage testing command by refining parameters for resu…

b529324

…lts directory and format

fix: Update coverage testing command to specify project file and corr…

4efb0e0

…ect report paths

wip

9d016d3

wip

832f058

fix: Add continue-on-error for coverage report generation step

a009908

Merge branch 'master' into 001-generator-reliability-hardening

f1ac1a2

Increment Version

7f743a6

aabs merged commit 8ab6509 into master Dec 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

001 generator reliability hardening #21

001 generator reliability hardening #21

Uh oh!

aabs commented Dec 5, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
	using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));

	return t?.ToDisplayString(SymbolDisplayFormat.MinimallyQualifiedFormat) ?? string.Empty;
	return t.ToDisplayString(SymbolDisplayFormat.MinimallyQualifiedFormat);


		TransformBlock<string,string> _Process;

		TransformBlock<string,string> _Start;


		TransformBlock<string,string> _Finish;

		TransformManyBlock<string,string> _Start;

001 generator reliability hardening #21

001 generator reliability hardening #21

Uh oh!

Conversation

aabs commented Dec 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants