[FR] Fix PercentageCompleted bug (Azure#24569)

Author: maririos

sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md

@@ -7,6 +7,7 @@
 ### Breaking Changes
 
 ### Bugs Fixed
+- `BuildModelOperation` and `CopyModelOperation` correctly populate the `PercentCompleted` property, instead of always having a value of `0`. 
 
 ### Other Changes
 

sdk/formrecognizer/Azure.AI.FormRecognizer/api/Azure.AI.FormRecognizer.netstandard2.0.cs

@@ -294,7 +294,7 @@ public BuildModelOperation(string operationId, Azure.AI.FormRecognizer.DocumentA
         public override bool HasCompleted { get { throw null; } }
         public override bool HasValue { get { throw null; } }
         public override string Id { get { throw null; } }
-        public int PercentCompleted { get { throw null; } }
+        public virtual int PercentCompleted { get { throw null; } }
         public override Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModel Value { get { throw null; } }
         public override Azure.Response GetRawResponse() { throw null; }
         public override Azure.Response UpdateStatus(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
@@ -323,7 +323,7 @@ public CopyModelOperation(string operationId, Azure.AI.FormRecognizer.DocumentAn
         public override bool HasCompleted { get { throw null; } }
         public override bool HasValue { get { throw null; } }
         public override string Id { get { throw null; } }
-        public int PercentCompleted { get { throw null; } }
+        public virtual int PercentCompleted { get { throw null; } }
         public override Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModel Value { get { throw null; } }
         public override Azure.Response GetRawResponse() { throw null; }
         public override Azure.Response UpdateStatus(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }

sdk/formrecognizer/Azure.AI.FormRecognizer/src/BuildModelOperation.cs

@@ -35,7 +35,7 @@ public class BuildModelOperation : Operation<DocumentModel>, IOperation<Document
         /// <summary>
         /// Gets the operation progress. Value is from [0-100].
         /// </summary>
-        public int PercentCompleted => _percentCompleted;
+        public virtual int PercentCompleted => _percentCompleted;
 
         /// <summary>
         /// Final result of the long-running operation.

sdk/formrecognizer/Azure.AI.FormRecognizer/src/CopyModelOperation.cs

@@ -35,7 +35,7 @@ public class CopyModelOperation : Operation<DocumentModel>, IOperation<DocumentM
         /// <summary>
         /// Gets the operation progress. Value is from [0-100].
         /// </summary>
-        public int PercentCompleted => _percentCompleted;
+        public virtual int PercentCompleted => _percentCompleted;
 
         /// <summary>
         /// Final result of the long-running operation.

sdk/formrecognizer/Azure.AI.FormRecognizer/tests/DocumentAnalysisModels/OperationsLiveTests.cs

@@ -62,6 +62,22 @@ public async Task BuildModelOperationCanPollFromNewObject()
             Assert.AreEqual(modelId, sameOperation.Value.ModelId);
         }
 
+        [RecordedTest]
+        public async Task BuildModelOperationPercentageCompletedValue()
+        {
+            var client = CreateDocumentModelAdministrationClient(out var nonInstrumentedClient);
+            var trainingFilesUri = new Uri(TestEnvironment.BlobContainerSasUrl);
+            var modelId = Recording.GenerateId();
+
+            var operation = await client.StartBuildModelAsync(trainingFilesUri, modelId);
+            Assert.AreEqual(0, operation.PercentCompleted);
+
+            await operation.WaitForCompletionAsync();
+
+            Assert.IsTrue(operation.HasValue);
+            Assert.AreEqual(100, operation.PercentCompleted);
+        }
+
         [RecordedTest]
         public async Task CopyModelOperationCanPollFromNewObject()
         {
@@ -81,5 +97,25 @@ public async Task CopyModelOperationCanPollFromNewObject()
             Assert.IsTrue(sameOperation.HasValue);
             Assert.AreEqual(targetModelId, sameOperation.Value.ModelId);
         }
+
+        [RecordedTest]
+        public async Task CopyModelOperationPercentageCompletedValue()
+        {
+            var client = CreateDocumentModelAdministrationClient(out var nonInstrumentedClient);
+            var modelId = Recording.GenerateId();
+
+            await using var trainedModel = await CreateDisposableBuildModelAsync(modelId);
+
+            var targetModelId = Recording.GenerateId();
+            CopyAuthorization targetAuth = await client.GetCopyAuthorizationAsync(targetModelId);
+
+            var operation = await client.StartCopyModelAsync(trainedModel.ModelId, targetAuth);
+            Assert.AreEqual(0, operation.PercentCompleted);
+
+            await operation.WaitForCompletionAsync();
+
+            Assert.IsTrue(operation.HasValue);
+            Assert.AreEqual(100, operation.PercentCompleted);
+        }
     }
 }