Improve nullable annotation on CancelInvocationMessage.InvocationId #63083
Conversation
AArnott
force-pushed
the
AArnott-patch-1
branch
3 times, most recently
from
aa49469 to
abdf55c
Compare
This declares a `new` property for `string InvocationId { get; }` so that the compiler sees it as non-nullable, consistent with the constructor declared on the same type.
AArnott
force-pushed
the
AArnott-patch-1
branch
from
abdf55c to
e373af8
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR improves nullable reference type annotations for the CancelInvocationMessage.InvocationId property by declaring a new property that explicitly returns a non-nullable string, consistent with the class constructor that requires a non-null invocation ID parameter.
- Adds a
newproperty declaration that overrides the base property with non-nullable annotation - Updates public API documentation across multiple target frameworks to reflect the API change
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/SignalR/common/SignalR.Common/src/Protocol/CancelInvocationMessage.cs | Adds new non-nullable InvocationId property override |
| src/SignalR/common/SignalR.Common/src/PublicAPI/netstandard2.0/PublicAPI.Unshipped.txt | Documents API change for .NET Standard 2.0 |
| src/SignalR/common/SignalR.Common/src/PublicAPI/net462/PublicAPI.Unshipped.txt | Documents API change for .NET Framework 4.6.2 |
| src/SignalR/common/SignalR.Common/src/PublicAPI/net10.0/PublicAPI.Unshipped.txt | Documents API change for .NET 10.0 |
| @@ -17,4 +17,7 @@ public class CancelInvocationMessage : HubInvocationMessage | |||
| public CancelInvocationMessage(string invocationId) : base(invocationId) | |||
| { | |||
| } | |||
|
|
|||
| /// <inheritdoc cref="HubInvocationMessage.InvocationId" /> | |||
| public new string InvocationId => base.InvocationId!; | |||
There was a problem hiding this comment.
The XML documentation comment should be more descriptive than just inheriting from the base class. Since this property provides stronger null safety guarantees than the base property, the documentation should explain this improvement and include proper XML doc tags like <summary> instead of just <inheritdoc cref="..."/>.
Copilot uses AI. Check for mistakes.
This declares a
newproperty forstring InvocationId { get; }so that the compiler sees it as non-nullable, consistent with the constructor declared on the same type.