ClientModel: Make message.Apply(options) take nullable options (#43212)

* Make message.Apply(options) take nullable options * add test coverage
Azure · Apr 4, 2024 · b87f7ad · b87f7ad
1 parent 4b9a46f
commit b87f7ad
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 8 deletions.
diff --git a/sdk/core/System.ClientModel/CHANGELOG.md b/sdk/core/System.ClientModel/CHANGELOG.md
@@ -10,6 +10,7 @@
 
 - Removed `[Serializable]` attribute and serialization constructor from `ClientResultException`.
 - Made `value` parameter nullable in `PipelineMessage.SetProperty` method.
+- Made `options` parameter to `PipelineMessage.Apply` nullable.
 
 ### Bugs Fixed
 

diff --git a/sdk/core/System.ClientModel/api/System.ClientModel.net6.0.cs b/sdk/core/System.ClientModel/api/System.ClientModel.net6.0.cs
@@ -148,7 +148,7 @@ protected internal PipelineMessage(System.ClientModel.Primitives.PipelineRequest
         public System.ClientModel.Primitives.PipelineRequest Request { get { throw null; } }
         public System.ClientModel.Primitives.PipelineResponse? Response { get { throw null; } protected internal set { } }
         public System.ClientModel.Primitives.PipelineMessageClassifier ResponseClassifier { get { throw null; } set { } }
-        public void Apply(System.ClientModel.Primitives.RequestOptions options) { }
+        public void Apply(System.ClientModel.Primitives.RequestOptions? options) { }
         public void Dispose() { }
         protected virtual void Dispose(bool disposing) { }
         public System.ClientModel.Primitives.PipelineResponse? ExtractResponse() { throw null; }

diff --git a/sdk/core/System.ClientModel/api/System.ClientModel.netstandard2.0.cs b/sdk/core/System.ClientModel/api/System.ClientModel.netstandard2.0.cs
@@ -147,7 +147,7 @@ protected internal PipelineMessage(System.ClientModel.Primitives.PipelineRequest
         public System.ClientModel.Primitives.PipelineRequest Request { get { throw null; } }
         public System.ClientModel.Primitives.PipelineResponse? Response { get { throw null; } protected internal set { } }
         public System.ClientModel.Primitives.PipelineMessageClassifier ResponseClassifier { get { throw null; } set { } }
-        public void Apply(System.ClientModel.Primitives.RequestOptions options) { }
+        public void Apply(System.ClientModel.Primitives.RequestOptions? options) { }
         public void Dispose() { }
         protected virtual void Dispose(bool disposing) { }
         public System.ClientModel.Primitives.PipelineResponse? ExtractResponse() { throw null; }

diff --git a/sdk/core/System.ClientModel/src/Message/PipelineMessage.cs b/sdk/core/System.ClientModel/src/Message/PipelineMessage.cs
@@ -107,20 +107,20 @@ public CancellationToken CancellationToken
     /// this <see cref="PipelineMessage"/> instance.
     /// </summary>
     /// <param name="options">The <see cref="RequestOptions"/> to apply to this
-    /// <see cref="PipelineMessage"/> instance.</param>
+    /// <see cref="PipelineMessage"/> instance.  If <c>null</c> is passed,
+    /// no changes will be made to this message instance.</param>
     /// <remarks> This method is intended to be called after the creation of
     /// the <see cref="PipelineMessage"/> and its <see cref="Request"/> is
     /// complete, and prior to the call to
     /// <see cref="ClientPipeline.Send(PipelineMessage)"/>.
     /// </remarks>
-    public void Apply(RequestOptions options)
+    public void Apply(RequestOptions? options)
     {
-        Argument.AssertNotNull(options, nameof(options));
-
         // This design moves the client-author API (options.Apply) off the
         // client-user type RequestOptions. Its only purpose is to call through to
-        // the internal options.Apply method.
-        options.Apply(this);
+        // the internal options.Apply method.  If null options are passed this
+        // method is a no-op.
+        options?.Apply(this);
     }
 
     /// <summary>

diff --git a/sdk/core/System.ClientModel/tests/Message/PipelineMessageTests.cs b/sdk/core/System.ClientModel/tests/Message/PipelineMessageTests.cs
@@ -52,6 +52,14 @@ public void ApplySetsCancellationToken()
         Assert.IsTrue(message.CancellationToken.IsCancellationRequested);
     }
 
+    [Test]
+    public void NullOptionsIsNoOp()
+    {
+        ClientPipeline pipeline = ClientPipeline.Create();
+        PipelineMessage message = pipeline.CreateMessage();
+        Assert.DoesNotThrow(() => message.Apply(null));
+    }
+
     [Test]
     public void CanSetAndGetMessageProperties()
     {