chore: clean up build warnings #7522

Aaronontheweb · 2025-03-13T21:52:07Z

Changes

c;leaning up various build warnings

Checklist

For significant changes, please ensure that the following have been completed (delete if not relevant):

This change follows the Akka.NET API Compatibility Guidelines.
This change follows the Akka.NET Wire Compatibility Guidelines.

… warnings

…ess xUnit1030 warnings

…ss xUnit1030 warnings

…lAsync

removed tons of useless XML-DOCs too

Fix CS0659 and CS0420 warnings in core Akka libraries This commit addresses two types of build warnings: 1. CS0659: Missing GetHashCode implementation - Added GetHashCode implementations to classes in EventSequences.cs - Converted test classes in AtLeastOnceDeliverySpec.cs to C# records 2. CS0420: Volatile field access warning - Removed redundant 'volatile' keyword from _statusDotNotCallMeDirectly field in Mailbox.cs - Kept explicit Volatile.Read/Write method calls for proper memory barriers These changes maintain the original behavior while eliminating the warnings, improving code quality and maintainability.

This commit addresses the CS8632 warnings that occur when nullable reference type annotations (like string?) are used in files with #nullable enable directives but in projects where nullable reference types are not enabled at the project level. Changes: 1. Added CS8632 to the NoWarn property in src/Directory.Build.props to suppress these warnings during build 2. Created a GlobalSuppressions.cs file with a SuppressMessage attribute for CS8632 with a clear justification This approach preserves the intent of the code by keeping the #nullable enable directives and nullable annotations intact, while eliminating the build warnings. It also maintains forward compatibility if the project later decides to fully enable nullable reference types across all projects.

Aaronontheweb

Detailed my changes

Aaronontheweb · 2025-03-18T15:27:00Z

src/Directory.Build.props

      and make everything fully async in the future 
    -->
-    <NoWarn>$(NoWarn);CS1591;xUnit1013;xUnit1031</NoWarn>
+    <NoWarn>$(NoWarn);CS1591;xUnit1013;xUnit1031;CS8632</NoWarn>


Disables https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/nullable-warnings#configure-nullable-context - which is basically a warning that we have some non-nullable code calling code with nullable attributes. We're naturally going to encounter that since we're gradually moving code over to using nullable - so this cuts down on a fairly large and growing number of warnings.

Aaronontheweb · 2025-03-18T15:27:21Z

src/GlobalSuppressions.cs

+using System.Diagnostics.CodeAnalysis;
+
+// Suppress CS8632 warnings about nullable reference type annotations
+[assembly: SuppressMessage("Style", "CS8632:The annotation for nullable reference types should only be used in code within a '#nullable' annotations context.", Justification = "Files with #nullable enable directives use nullable annotations correctly")] 


Globally suppresses https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/nullable-warnings#configure-nullable-context

Aaronontheweb · 2025-03-18T15:27:31Z

src/contrib/testkits/Akka.TestKit.Xunit/XunitAssertions.cs

        public void Fail(string format = "", params object[] args)
        {
-            Assert.True(false, string.Format(format, args));
+            Assert.Fail(string.Format(format, args));


Cleans up an xUnit warning

Aaronontheweb · 2025-03-18T15:27:50Z

src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCoordination.DotNet.verified.txt

    {
        public LeaseTimeoutException(string message) { }
        public LeaseTimeoutException(string message, System.Exception innerEx) { }
-        protected LeaseTimeoutException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }


No inheritors for this class, so this eliminates that warning

Aaronontheweb · 2025-03-18T15:29:34Z

src/core/Akka.Persistence.Tests/AtLeastOnceDeliverySpec.cs

 using Xunit;
 using Xunit.Abstractions;
 using FluentAssertions;
-#pragma warning disable CS0659 // Type overrides Object.Equals(object o) but does not override Object.GetHashCode()


Got rid of the warning and fixed the problems instead. These are all related to the test messages themselves so no real impact on Akka.NET.

Aaronontheweb · 2025-03-18T15:32:35Z

src/core/Akka/Actor/ChildrenContainer/Internal/NormalChildrenContainer.cs

            if (numberOfChildren > 20) return numberOfChildren + " children";
            var sb = new StringBuilder();

-            sb.Append("Children:\n    ").AppendJoin("\n    ", InternalChildren, ChildStatsAppender);


So something that is pretty funny: we've had our own AppendJoin function for years, going back to 2014. At some point in the future .NET added one, officially, to StingBuilder and now our extension method conflicts with this - resulting in us ToString()-ing a delegate rather than actually emitting the data we expect.

ChildStatsAppender was the delegate getting stringified

Aaronontheweb · 2025-03-18T15:33:37Z

src/core/Akka/Actor/ChildrenContainer/Internal/TerminatingChildrenContainer.cs

            if (numberOfChildren > 10)
                sb.Append(numberOfChildren).Append(" children\n");
            else
-                sb.Append("Children:\n    ").AppendJoin("\n    ", InternalChildren, ChildStatsAppender).Append('\n');


Fixed the same stringification of delegate warning

Aaronontheweb · 2025-03-18T15:34:20Z

src/core/Akka/Dispatch/Mailbox.cs

         */
        private volatile ActorCell _actor = null;
        private volatile SystemMessage _systemQueueDoNotCallMeDirectly = null; // null by default
-        private volatile int _statusDotNotCallMeDirectly; //0 by default


Either use the volatile keyword or use Volatile.Read / Volatile.Write consistently, but don't do both.

Aaronontheweb · 2025-03-18T15:34:59Z

src/core/Akka/Pattern/BackoffSupervisor.cs

        /// </summary>
        [Serializable]
-        public sealed class Reset
+        public new sealed class Reset


Poor naming choices here, but hiding the APIs doesn't hurt anything in our tests or the accessibility of the underlying class. This is pure compiler ceremony.

Aaronontheweb · 2025-03-18T15:35:09Z

src/core/Akka/Routing/RouterConfig.cs


        public override bool Equals(object obj) => Equals(obj as RouterConfig);
+
+        public override int GetHashCode()


Needed to override GetHashCode

Arkatufus

LGTM

Aaronontheweb · 2025-03-18T15:42:39Z

Current `dev`

482 build warnings

This PR

414 warnings

fix: replace Assert.True(false) with Assert.Fail to address xUnit2020…

07afe8c

… warnings

Aaronontheweb added tests akka-testkit Akka.NET Testkit issues labels Mar 13, 2025

Aaronontheweb added 5 commits March 13, 2025 16:53

fix: add ConfigureAwait(false) to async calls in LazySinkSpec to addr…

ad7d2f4

…ess xUnit1030 warnings

fix: add ConfigureAwait(false) to async calls in FlowZipSpec to addre…

5e1cfaa

…ss xUnit1030 warnings

remove configure await calls

fba25bd

remove obsolete member

ebb957a

fix RouterConfig warning

6e36e31

Aaronontheweb enabled auto-merge (squash) March 13, 2025 22:36

Aaronontheweb added 10 commits March 13, 2025 18:15

Merge branch 'dev' into fix-build-warnings

7ef6944

Fix AK1006 warnings by replacing PersistAsync in loops with PersistAl…

b2f09a6

…lAsync

API approvals

053ebd9

used new keyword to avoid API hiding warning

32dc3a5

fixed build warnings with ChildrenContainer

90f0548

removed tons of useless XML-DOCs too

fixed Volatile.Read warnings in Mailbox

9618426

fixed Akka.Coordination API warning

d87d40b

added API approvals

0103247

Aaronontheweb commented Mar 18, 2025

View reviewed changes

Arkatufus approved these changes Mar 18, 2025

View reviewed changes

Merge branch 'dev' into fix-build-warnings

5f2a8fa

Aaronontheweb modified the milestone: 1.5.40 Mar 18, 2025

Aaronontheweb disabled auto-merge March 18, 2025 16:14

Aaronontheweb merged commit 5793a6b into akkadotnet:dev Mar 18, 2025
7 of 12 checks passed

Aaronontheweb deleted the fix-build-warnings branch March 18, 2025 16:14

This was referenced Mar 21, 2025

Update RELEASE_NOTES.md for 1.5.40 release #7558

Merged

Update 1.5.40 release notes #7576

Merged


		public override bool Equals(object obj) => Equals(obj as RouterConfig);

		public override int GetHashCode()

chore: clean up build warnings #7522

chore: clean up build warnings #7522

Uh oh!

Conversation

Aaronontheweb commented Mar 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Checklist

Uh oh!

Aaronontheweb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Arkatufus left a comment

Choose a reason for hiding this comment

Uh oh!

Aaronontheweb commented Mar 18, 2025

Current dev

This PR

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Aaronontheweb commented Mar 13, 2025 •

edited

Loading

Current `dev`