Merge branch 'main' into users/pahallis/sdk-emitter-pipelines

hallipr · web-flow · commit 5e4c0bdec970 · 2024-10-16T15:10:33.000-07:00
diff --git a/eng/common/pipelines/templates/archetype-typespec-emitter.yml b/eng/common/pipelines/templates/archetype-typespec-emitter.yml
@@ -66,7 +66,6 @@ extends:
   template: /eng/pipelines/templates/stages/1es-redirect.yml
   parameters:
     stages:
-
     # Build stage
     # Responsible for building the autorest generator and typespec emitter packages
     # Produces the artifact `build_artifacts` which contains the following:
diff --git a/sdk/core/Azure.Core/CHANGELOG.md b/sdk/core/Azure.Core/CHANGELOG.md
@@ -10,6 +10,8 @@
 
 ### Other Changes
 
+- Use `BinaryData.Empty` for `PipelineResponse.Content` when HTTP message has no content.
+
 ## 1.44.1 (2024-10-09)
 
 ### Other Changes
diff --git a/sdk/core/Azure.Core/src/Response.cs b/sdk/core/Azure.Core/src/Response.cs
@@ -41,9 +41,6 @@ public abstract class Response : IDisposable
         /// </summary>
         public virtual ResponseHeaders Headers => new ResponseHeaders(this);
 
-        // TODO(matell): The .NET Framework team plans to add BinaryData.Empty in dotnet/runtime#49670, and we can use it then.
-        private static readonly BinaryData s_EmptyBinaryData = new BinaryData(Array.Empty<byte>());
-
         /// <summary>
         /// Gets the contents of HTTP response, if it is available.
         /// </summary>
@@ -56,7 +53,7 @@ public virtual BinaryData Content
             {
                 if (ContentStream == null)
                 {
-                    return s_EmptyBinaryData;
+                    return BinaryData.Empty;
                 }
 
                 MemoryStream? memoryContent = ContentStream as MemoryStream;
diff --git a/sdk/core/System.ClientModel/CHANGELOG.md b/sdk/core/System.ClientModel/CHANGELOG.md
@@ -10,6 +10,8 @@
 
 ### Other Changes
 
+- Use `BinaryData.Empty` for `PipelineResponse.Content` when HTTP message has no content ([#46669](https://github.com/Azure/azure-sdk-for-net/pull/46669)).
+
 ## 1.2.1 (2024-10-09)
 
 ### Bugs Fixed
diff --git a/sdk/core/System.ClientModel/src/Message/PipelineResponse.cs b/sdk/core/System.ClientModel/src/Message/PipelineResponse.cs
@@ -12,9 +12,6 @@ namespace System.ClientModel.Primitives;
 /// </summary>
 public abstract class PipelineResponse : IDisposable
 {
-    // TODO(matell): The .NET Framework team plans to add BinaryData.Empty in dotnet/runtime#49670, and we can use it then.
-    internal static readonly BinaryData s_EmptyBinaryData = new(Array.Empty<byte>());
-
     /// <summary>
     /// Gets the status code of the HTTP response.
     /// </summary>
diff --git a/sdk/core/System.ClientModel/src/Pipeline/HttpClientPipelineTransport.Response.cs b/sdk/core/System.ClientModel/src/Pipeline/HttpClientPipelineTransport.Response.cs
@@ -100,7 +100,7 @@ private async ValueTask<BinaryData> BufferContentSyncOrAsync(CancellationToken c
             {
                 // Content is not buffered but there is no source stream.
                 // Our contract from Azure.Core is to return BinaryData.Empty in this case.
-                _bufferedContent = s_EmptyBinaryData;
+                _bufferedContent = BinaryData.Empty;
                 return _bufferedContent;
             }
 
diff --git a/sdk/iothub/Azure.ResourceManager.IotHub/CHANGELOG.md b/sdk/iothub/Azure.ResourceManager.IotHub/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Release History
 
+## 1.2.0-beta.2 (Unreleased)
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
+
 ## 1.2.0-beta.1 (2024-10-15)
 
 ### Features Added
diff --git a/sdk/iothub/Azure.ResourceManager.IotHub/src/Azure.ResourceManager.IotHub.csproj b/sdk/iothub/Azure.ResourceManager.IotHub/src/Azure.ResourceManager.IotHub.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <Version>1.2.0-beta.1</Version>
+    <Version>1.2.0-beta.2</Version>
     <!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
     <ApiCompatVersion>1.1.1</ApiCompatVersion>
     <PackageId>Azure.ResourceManager.IotHub</PackageId>
diff --git a/sdk/logic/Azure.ResourceManager.Logic/CHANGELOG.md b/sdk/logic/Azure.ResourceManager.Logic/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Release History
 
+## 1.2.0-beta.2 (Unreleased)
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
+
 ## 1.2.0-beta.1 (2024-10-15)
 
 ### Features Added
diff --git a/sdk/logic/Azure.ResourceManager.Logic/src/Azure.ResourceManager.Logic.csproj b/sdk/logic/Azure.ResourceManager.Logic/src/Azure.ResourceManager.Logic.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <Version>1.2.0-beta.1</Version>
+    <Version>1.2.0-beta.2</Version>
     <!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
     <ApiCompatVersion>1.1.0</ApiCompatVersion>
     <PackageId>Azure.ResourceManager.Logic</PackageId>
diff --git a/sdk/operationalinsights/Azure.ResourceManager.OperationalInsights/CHANGELOG.md b/sdk/operationalinsights/Azure.ResourceManager.OperationalInsights/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Release History
 
+## 1.3.0-beta.2 (Unreleased)
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
+
 ## 1.3.0-beta.1 (2024-10-15)
 
 ### Features Added
diff --git a/sdk/operationalinsights/Azure.ResourceManager.OperationalInsights/src/Azure.ResourceManager.OperationalInsights.csproj b/sdk/operationalinsights/Azure.ResourceManager.OperationalInsights/src/Azure.ResourceManager.OperationalInsights.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <Version>1.3.0-beta.1</Version>
+    <Version>1.3.0-beta.2</Version>
     <!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
     <ApiCompatVersion>1.2.2</ApiCompatVersion>
     <PackageId>Azure.ResourceManager.OperationalInsights</PackageId>
diff --git a/sdk/recoveryservices/Azure.ResourceManager.RecoveryServices/CHANGELOG.md b/sdk/recoveryservices/Azure.ResourceManager.RecoveryServices/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Release History
 
+## 1.2.0-beta.2 (Unreleased)
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
+
 ## 1.2.0-beta.1 (2024-10-15)
 
 ### Features Added
diff --git a/sdk/recoveryservices/Azure.ResourceManager.RecoveryServices/src/Azure.ResourceManager.RecoveryServices.csproj b/sdk/recoveryservices/Azure.ResourceManager.RecoveryServices/src/Azure.ResourceManager.RecoveryServices.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <Version>1.2.0-beta.1</Version>
+    <Version>1.2.0-beta.2</Version>
     <!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
     <ApiCompatVersion>1.1.1</ApiCompatVersion>
     <PackageId>Azure.ResourceManager.RecoveryServices</PackageId>
diff --git a/sdk/storage/Azure.Storage.DataMovement/src/DataTransferInternalState.cs b/sdk/storage/Azure.Storage.DataMovement/src/DataTransferInternalState.cs
@@ -86,10 +86,10 @@ public DataTransferStatus GetTransferStatus()
         /// Sets the completion status
         /// </summary>
         /// <param name="state"></param>
-        /// <returns>Returns whether or not the status has been changed/set</returns>
-        public bool TrySetTransferState(DataTransferState state)
+        /// <returns>Returns whether or not the status has been changed from its original state.</returns>
+        public bool SetTransferState(DataTransferState state)
         {
-            if (_status.TrySetTransferStateChange(state))
+            if (_status.SetTransferStateChange(state))
             {
                 if (DataTransferState.Completed == _status.State ||
                     DataTransferState.Paused == _status.State)
@@ -104,9 +104,9 @@ public bool TrySetTransferState(DataTransferState state)
             return false;
         }
 
-        public bool TrySetFailedItemsState() => _status.TrySetFailedItem();
+        public bool SetFailedItemsState() => _status.SetFailedItem();
 
-        public bool TrySetSkippedItemsState() => _status.TrySetSkippedItem();
+        public bool SetSkippedItemsState() => _status.SetSkippedItem();
 
         internal bool CanPause()
             => DataTransferState.InProgress == _status.State;
@@ -119,7 +119,7 @@ public async Task PauseIfRunningAsync(CancellationToken cancellationToken)
             }
             CancellationHelper.ThrowIfCancellationRequested(cancellationToken);
             // Call the inner cancellation token to stop the transfer job
-            TrySetTransferState(DataTransferState.Pausing);
+            SetTransferState(DataTransferState.Pausing);
             if (TriggerCancellation())
             {
                 // Wait until full pause has completed.
diff --git a/sdk/storage/Azure.Storage.DataMovement/src/DataTransferStatus.cs b/sdk/storage/Azure.Storage.DataMovement/src/DataTransferStatus.cs
@@ -75,8 +75,8 @@ protected internal DataTransferStatus(DataTransferState state, bool hasFailureIt
         ///
         /// This should only be triggered when a failed item has been seen.
         /// </summary>
-        /// <returns>True if <see cref="HasFailedItems"/> was updated. False otherwise.</returns>
-        internal bool TrySetFailedItem()
+        /// <returns>True if this was the first time <see cref="HasFailedItems"/> was updated. False otherwise.</returns>
+        internal bool SetFailedItem()
         {
             return Interlocked.Exchange(ref _hasFailedItemValue, 1) != 1;
         }
@@ -86,8 +86,8 @@ internal bool TrySetFailedItem()
         ///
         /// This should only be triggered when a skipped item has been seen.
         /// </summary>
-        /// /// <returns>True if <see cref="HasSkippedItems"/> was updated. False otherwise.</returns>
-        internal bool TrySetSkippedItem()
+        /// /// <returns>True if this was the first time <see cref="HasSkippedItems"/> was updated. False otherwise.</returns>
+        internal bool SetSkippedItem()
         {
             return Interlocked.Exchange(ref _hasSkippedItemValue, 1) != 1;
         }
@@ -98,8 +98,8 @@ internal bool TrySetSkippedItem()
         ///
         /// This should only be triggered when the state updates.
         /// </summary>
-        /// <returns>True if <see cref="State"/> was updated. False otherwise.</returns>
-        internal bool TrySetTransferStateChange(DataTransferState state)
+        /// <returns>True if <see cref="State"/> was changed from its original state. False otherwise.</returns>
+        internal bool SetTransferStateChange(DataTransferState state)
         {
             return Interlocked.Exchange(ref _stateValue, (int)state) != (int)state;
         }
diff --git a/sdk/storage/Azure.Storage.DataMovement/src/JobPartInternal.cs b/sdk/storage/Azure.Storage.DataMovement/src/JobPartInternal.cs
@@ -275,7 +275,7 @@ internal async Task TriggerCancellationAsync()
         /// <param name="transferState"></param>
         internal async Task OnTransferStateChangedAsync(DataTransferState transferState)
         {
-            if (JobPartStatus.TrySetTransferStateChange(transferState))
+            if (JobPartStatus.SetTransferStateChange(transferState))
             {
                 // Progress tracking, do before invoking the event below
                 if (transferState == DataTransferState.InProgress)
@@ -355,7 +355,7 @@ await TransferSkippedEventHandler.RaiseAsync(
 
             // Update the JobPartStatus. If was already updated (e.g. there was a failed item before)
             // then don't raise the PartTransferStatusEventHandler
-            if (JobPartStatus.TrySetSkippedItem())
+            if (JobPartStatus.SetSkippedItem())
             {
                 await PartTransferStatusEventHandler.RaiseAsync(
                     new TransferStatusEventArgs(
@@ -409,7 +409,7 @@ await TransferFailedEventHandler.RaiseAsync(
 
                 // Update the JobPartStatus. If was already updated (e.g. there was a failed item before)
                 // then don't raise the PartTransferStatusEventHandler
-                if (JobPartStatus.TrySetFailedItem())
+                if (JobPartStatus.SetFailedItem())
                 {
                     await PartTransferStatusEventHandler.RaiseAsync(
                         new TransferStatusEventArgs(
diff --git a/sdk/storage/Azure.Storage.DataMovement/src/ServiceToServiceTransferJob.cs b/sdk/storage/Azure.Storage.DataMovement/src/ServiceToServiceTransferJob.cs
@@ -105,7 +105,7 @@ public override async IAsyncEnumerable<JobPartInternal> ProcessJobToJobPartAsync
                 {
                     if (!part.JobPartStatus.HasCompletedSuccessfully)
                     {
-                        part.JobPartStatus.TrySetTransferStateChange(DataTransferState.Queued);
+                        part.JobPartStatus.SetTransferStateChange(DataTransferState.Queued);
                         yield return part;
                     }
                 }
diff --git a/sdk/storage/Azure.Storage.DataMovement/src/StreamToUriTransferJob.cs b/sdk/storage/Azure.Storage.DataMovement/src/StreamToUriTransferJob.cs
@@ -103,7 +103,7 @@ public override async IAsyncEnumerable<JobPartInternal> ProcessJobToJobPartAsync
                 {
                     if (!part.JobPartStatus.HasCompletedSuccessfully)
                     {
-                        part.JobPartStatus.TrySetTransferStateChange(DataTransferState.Queued);
+                        part.JobPartStatus.SetTransferStateChange(DataTransferState.Queued);
                         yield return part;
                     }
                 }
diff --git a/sdk/storage/Azure.Storage.DataMovement/src/TransferJobInternal.cs b/sdk/storage/Azure.Storage.DataMovement/src/TransferJobInternal.cs
@@ -150,7 +150,7 @@ private TransferJobInternal(
             Argument.AssertNotNull(clientDiagnostics, nameof(clientDiagnostics));
 
             _dataTransfer = dataTransfer ?? throw Errors.ArgumentNull(nameof(dataTransfer));
-            _dataTransfer.TransferStatus.TrySetTransferStateChange(DataTransferState.Queued);
+            _dataTransfer.TransferStatus.SetTransferStateChange(DataTransferState.Queued);
             _checkpointer = checkPointer;
             _arrayPool = arrayPool;
             _jobParts = new List<JobPartInternal>();
@@ -344,15 +344,15 @@ public async Task JobPartEvent(TransferStatusEventArgs args)
             }
             else if (jobPartStatus.HasFailedItems)
             {
-                if (_dataTransfer._state.TrySetFailedItemsState())
+                if (_dataTransfer._state.SetFailedItemsState())
                 {
                     await SetCheckpointerStatus().ConfigureAwait(false);
                     await OnJobPartStatusChangedAsync().ConfigureAwait(false);
                 }
             }
             else if (jobPartStatus.HasSkippedItems)
             {
-                if (_dataTransfer._state.TrySetSkippedItemsState())
+                if (_dataTransfer._state.SetSkippedItemsState())
                 {
                     await SetCheckpointerStatus().ConfigureAwait(false);
                     await OnJobPartStatusChangedAsync().ConfigureAwait(false);
@@ -387,7 +387,7 @@ public async Task JobPartEvent(TransferStatusEventArgs args)
 
         public async Task OnJobStateChangedAsync(DataTransferState state)
         {
-            if (_dataTransfer._state.TrySetTransferState(state))
+            if (_dataTransfer._state.SetTransferState(state))
             {
                 // If we are in a final state, dispose the JobPartEvent handlers
                 if (state == DataTransferState.Completed ||
diff --git a/sdk/storage/Azure.Storage.DataMovement/src/UriToStreamTransferJob.cs b/sdk/storage/Azure.Storage.DataMovement/src/UriToStreamTransferJob.cs
@@ -103,7 +103,7 @@ public override async IAsyncEnumerable<JobPartInternal> ProcessJobToJobPartAsync
                 {
                     if (!part.JobPartStatus.HasCompletedSuccessfully)
                     {
-                        part.JobPartStatus.TrySetTransferStateChange(DataTransferState.Queued);
+                        part.JobPartStatus.SetTransferStateChange(DataTransferState.Queued);
                         yield return part;
                     }
                 }
diff --git a/sdk/storage/Azure.Storage.DataMovement/tests/DataTransferTests.cs b/sdk/storage/Azure.Storage.DataMovement/tests/DataTransferTests.cs
@@ -161,10 +161,7 @@ public async Task TryPauseAsync()
             Assert.AreEqual(DataTransferState.Pausing, transfer.TransferStatus.State);
 
             // Assert
-            if (!transfer._state.TrySetTransferState(DataTransferState.Paused))
-            {
-                Assert.Fail("Unable to set the transfer status internally to the DataTransfer.");
-            }
+            Assert.IsTrue(transfer._state.SetTransferState(DataTransferState.Paused));
 
             await pauseTask;
 

Original file line number	Diff line number	Diff line change
`@@ -41,9 +41,6 @@ public abstract class Response : IDisposable`
`41`	`41`	`/// </summary>`
`42`	`42`	`public virtual ResponseHeaders Headers => new ResponseHeaders(this);`
`43`	`43`
`44`		`- // TODO(matell): The .NET Framework team plans to add BinaryData.Empty in dotnet/runtime#49670, and we can use it then.`
`45`		`- private static readonly BinaryData s_EmptyBinaryData = new BinaryData(Array.Empty<byte>());`
`46`		`-`
`47`	`44`	`/// <summary>`
`48`	`45`	`/// Gets the contents of HTTP response, if it is available.`
`49`	`46`	`/// </summary>`
`@@ -56,7 +53,7 @@ public virtual BinaryData Content`
`56`	`53`	`{`
`57`	`54`	`if (ContentStream == null)`
`58`	`55`	`{`
`59`		`- return s_EmptyBinaryData;`
	`56`	`+ return BinaryData.Empty;`
`60`	`57`	`}`
`61`	`58`
`62`	`59`	`MemoryStream? memoryContent = ContentStream as MemoryStream;`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ private async ValueTask<BinaryData> BufferContentSyncOrAsync(CancellationToken c`
`100`	`100`	`{`
`101`	`101`	`// Content is not buffered but there is no source stream.`
`102`	`102`	`// Our contract from Azure.Core is to return BinaryData.Empty in this case.`
`103`		`- _bufferedContent = s_EmptyBinaryData;`
	`103`	`+ _bufferedContent = BinaryData.Empty;`
`104`	`104`	`return _bufferedContent;`
`105`	`105`	`}`
`106`	`106`