refactor: Remove usage of gRPC defined ResultStatus in internal inter…

…faces
aneoconsulting · Sep 26, 2023 · b8eb8a9 · b8eb8a9
1 parent a0a62ef
commit b8eb8a9
Show file tree

Hide file tree

Showing 29 changed files with 161 additions and 66 deletions.
diff --git a/Adaptors/Memory/src/ResultTable.cs b/Adaptors/Memory/src/ResultTable.cs
@@ -24,7 +24,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 
-using ArmoniK.Api.gRPC.V1;
 using ArmoniK.Core.Base.DataStructures;
 using ArmoniK.Core.Common.Exceptions;
 using ArmoniK.Core.Common.Storage;

diff --git a/Adaptors/MongoDB/src/ResultTable.cs b/Adaptors/MongoDB/src/ResultTable.cs
@@ -24,7 +24,6 @@
 using System.Threading.Tasks;
 
 using ArmoniK.Api.Common.Utils;
-using ArmoniK.Api.gRPC.V1;
 using ArmoniK.Core.Adapters.MongoDB.Common;
 using ArmoniK.Core.Adapters.MongoDB.Table.DataModel;
 using ArmoniK.Core.Base.DataStructures;

diff --git a/Adaptors/MongoDB/tests/BsonSerializerTest.cs b/Adaptors/MongoDB/tests/BsonSerializerTest.cs
@@ -31,6 +31,7 @@
 using NUnit.Framework;
 
 using Output = ArmoniK.Core.Common.Storage.Output;
+using ResultStatus = ArmoniK.Core.Common.Storage.ResultStatus;
 using TaskOptions = ArmoniK.Core.Base.DataStructures.TaskOptions;
 using TaskStatus = ArmoniK.Core.Common.Storage.TaskStatus;
 

diff --git a/Common/src/Storage/Events/NewResult.cs b/Common/src/Storage/Events/NewResult.cs
@@ -15,8 +15,6 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-using ArmoniK.Api.gRPC.V1;
-
 namespace ArmoniK.Core.Common.Storage.Events;
 
 /// <summary>

diff --git a/Common/src/Storage/Events/ResultStatusUpdate.cs b/Common/src/Storage/Events/ResultStatusUpdate.cs
@@ -15,8 +15,6 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-using ArmoniK.Api.gRPC.V1;
-
 namespace ArmoniK.Core.Common.Storage.Events;
 
 /// <summary>

diff --git a/Common/src/Storage/Result.cs b/Common/src/Storage/Result.cs
@@ -18,8 +18,8 @@
 using System;
 using System.Collections.Generic;
 
-using ArmoniK.Api.gRPC.V1;
 using ArmoniK.Api.gRPC.V1.Results;
+using ArmoniK.Core.Common.gRPC.Convertors;
 
 using static Google.Protobuf.WellKnownTypes.Timestamp;
 
@@ -55,7 +55,7 @@ public static implicit operator ResultRaw(Result result)
     => new()
        {
          SessionId   = result.SessionId,
-         Status      = result.Status,
+         Status      = result.Status.ToGrpcStatus(),
          CreatedAt   = FromDateTime(result.CreationDate),
          Name        = result.Name,
          OwnerTaskId = result.OwnerTaskId,

diff --git a/Common/src/Storage/ResultIdStatus.cs b/Common/src/Storage/ResultIdStatus.cs
@@ -0,0 +1,28 @@
+// This file is part of the ArmoniK project
+// 
+// Copyright (C) ANEO, 2021-2023. All rights reserved.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published
+// by the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY, without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// 
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace ArmoniK.Core.Common.Storage;
+
+/// <summary>
+///   Holds result Id and status
+/// </summary>
+/// <param name="ResultId">Result Id</param>
+/// <param name="Status">Result status</param>
+public record ResultIdStatus(string       ResultId,
+                             ResultStatus Status)
+{
+}
diff --git a/Common/src/Storage/ResultLifeCycleHelper.cs b/Common/src/Storage/ResultLifeCycleHelper.cs
@@ -20,8 +20,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 
-using ArmoniK.Api.gRPC.V1;
-
 using Microsoft.Extensions.Logging;
 
 namespace ArmoniK.Core.Common.Storage;

diff --git a/Common/src/Storage/ResultStatus.cs b/Common/src/Storage/ResultStatus.cs
@@ -0,0 +1,33 @@
+// This file is part of the ArmoniK project
+// 
+// Copyright (C) ANEO, 2021-2023. All rights reserved.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published
+// by the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY, without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// 
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace ArmoniK.Core.Common.Storage;
+
+public enum ResultStatus
+{
+  /// <summary>Result is in an unspecified state.</summary>
+  Unspecified,
+
+  /// <summary>Result is created and task is created, submitted or dispatched.</summary>
+  Created,
+
+  /// <summary>Result is completed with a completed task.</summary>
+  Completed,
+
+  /// <summary>Result is aborted.</summary>
+  Aborted,
+}
diff --git a/Common/src/Storage/ResultStatusCount.cs b/Common/src/Storage/ResultStatusCount.cs
@@ -15,8 +15,6 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-using ArmoniK.Api.gRPC.V1;
-
 namespace ArmoniK.Core.Common.Storage;
 
 public record ResultStatusCount(ResultStatus Status,

diff --git a/Common/src/Storage/ResultTableExtensions.cs b/Common/src/Storage/ResultTableExtensions.cs
@@ -21,7 +21,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 
-using ArmoniK.Api.gRPC.V1.Submitter;
 using ArmoniK.Core.Common.Exceptions;
 
 namespace ArmoniK.Core.Common.Storage;
@@ -87,16 +86,13 @@ public static async Task<IEnumerable<string>> GetDependents(this IResultTable re
   /// <returns>
   ///   A map between the ids of the results found and their status
   /// </returns>
-  public static async Task<IEnumerable<GetResultStatusReply.Types.IdStatus>> GetResultStatus(this IResultTable   resultTable,
-                                                                                             IEnumerable<string> ids,
-                                                                                             string              sessionId,
-                                                                                             CancellationToken   cancellationToken = default)
+  public static async Task<IEnumerable<ResultIdStatus>> GetResultStatus(this IResultTable   resultTable,
+                                                                        IEnumerable<string> ids,
+                                                                        string              sessionId,
+                                                                        CancellationToken   cancellationToken = default)
     => await resultTable.GetResults(result => ids.Contains(result.ResultId),
-                                    result => new GetResultStatusReply.Types.IdStatus
-                                              {
-                                                ResultId = result.ResultId,
-                                                Status   = result.Status,
-                                              },
+                                    result => new ResultIdStatus(result.ResultId,
+                                                                 result.Status),
                                     cancellationToken)
                         .ToListAsync(cancellationToken)
                         .ConfigureAwait(false);

diff --git a/Common/src/gRPC/Convertors/ResultStatusExt.cs b/Common/src/gRPC/Convertors/ResultStatusExt.cs
@@ -0,0 +1,50 @@
+// This file is part of the ArmoniK project
+// 
+// Copyright (C) ANEO, 2021-2023. All rights reserved.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published
+// by the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY, without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// 
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+using System;
+
+using ArmoniK.Api.gRPC.V1;
+
+namespace ArmoniK.Core.Common.gRPC.Convertors;
+
+public static class ResultStatusExt
+{
+  public static ResultStatus ToGrpcStatus(this Storage.ResultStatus status)
+    => status switch
+       {
+         Storage.ResultStatus.Unspecified => ResultStatus.Unspecified,
+         Storage.ResultStatus.Created     => ResultStatus.Created,
+         Storage.ResultStatus.Completed   => ResultStatus.Completed,
+         Storage.ResultStatus.Aborted     => ResultStatus.Aborted,
+         _ => throw new ArgumentOutOfRangeException(nameof(status),
+                                                    status,
+                                                    null),
+       };
+
+  public static Storage.ResultStatus ToInternalStatus(this ResultStatus status)
+    => status switch
+       {
+         ResultStatus.Unspecified => Storage.ResultStatus.Unspecified,
+         ResultStatus.Created     => Storage.ResultStatus.Created,
+         ResultStatus.Completed   => Storage.ResultStatus.Completed,
+         ResultStatus.Aborted     => Storage.ResultStatus.Aborted,
+         ResultStatus.Notfound    => Storage.ResultStatus.Unspecified,
+         _ => throw new ArgumentOutOfRangeException(nameof(status),
+                                                    status,
+                                                    null),
+       };
+}
diff --git a/Common/src/gRPC/Services/Agent.cs b/Common/src/gRPC/Services/Agent.cs
@@ -29,6 +29,7 @@
 using ArmoniK.Api.gRPC.V1.Agent;
 using ArmoniK.Core.Base;
 using ArmoniK.Core.Common.Exceptions;
+using ArmoniK.Core.Common.gRPC.Convertors;
 using ArmoniK.Core.Common.StateMachines;
 using ArmoniK.Core.Common.Storage;
 using ArmoniK.Utils;
@@ -39,6 +40,7 @@
 
 using static Google.Protobuf.WellKnownTypes.Timestamp;
 
+using ResultStatus = ArmoniK.Core.Common.Storage.ResultStatus;
 using TaskOptions = ArmoniK.Core.Base.DataStructures.TaskOptions;
 
 namespace ArmoniK.Core.Common.gRPC.Services;
@@ -329,7 +331,7 @@ await resultTable_.Create(results,
                                           CreatedAt = FromDateTime(result.CreationDate),
                                           Name      = result.Name,
                                           SessionId = result.SessionId,
-                                          Status    = result.Status,
+                                          Status    = result.Status.ToGrpcStatus(),
                                           ResultId  = result.ResultId,
                                         }),
              },
@@ -431,7 +433,7 @@ await resultTable_.Create(results,
              {
                results.Select(r => new ResultMetaData
                                    {
-                                     Status    = r.Status,
+                                     Status    = r.Status.ToGrpcStatus(),
                                      CreatedAt = FromDateTime(r.CreationDate),
                                      Name      = r.Name,
                                      ResultId  = r.ResultId,

diff --git a/Common/src/gRPC/Services/GrpcResultsService.cs b/Common/src/gRPC/Services/GrpcResultsService.cs
@@ -38,6 +38,8 @@
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.Extensions.Logging;
 
+using ResultStatus = ArmoniK.Core.Common.Storage.ResultStatus;
+
 namespace ArmoniK.Core.Common.gRPC.Services;
 
 [Authorize(AuthenticationSchemes = Authenticator.SchemeName)]

diff --git a/Common/src/gRPC/Services/GrpcSubmitterService.cs b/Common/src/gRPC/Services/GrpcSubmitterService.cs
@@ -598,10 +598,14 @@ public override async Task<GetResultStatusReply> GetResultStatus(GetResultStatus
              {
                IdStatuses =
                {
-                 await resultTable_.GetResultStatus(request.ResultIds,
-                                                    request.SessionId,
-                                                    context.CancellationToken)
-                                   .ConfigureAwait(false),
+                 (await resultTable_.GetResultStatus(request.ResultIds,
+                                                     request.SessionId,
+                                                     context.CancellationToken)
+                                    .ConfigureAwait(false)).Select(status => new GetResultStatusReply.Types.IdStatus
+                                                                             {
+                                                                               ResultId = status.ResultId,
+                                                                               Status   = status.Status.ToGrpcStatus(),
+                                                                             }),
                },
              };
     }

diff --git a/Common/src/gRPC/Services/Submitter.cs b/Common/src/gRPC/Services/Submitter.cs
@@ -41,6 +41,7 @@
 using Microsoft.Extensions.Logging;
 
 using Output = ArmoniK.Api.gRPC.V1.Output;
+using ResultStatus = ArmoniK.Core.Common.Storage.ResultStatus;
 using TaskOptions = ArmoniK.Core.Base.DataStructures.TaskOptions;
 using TaskStatus = ArmoniK.Core.Common.Storage.TaskStatus;
 
@@ -474,7 +475,6 @@ public async Task<AvailabilityReply> WaitForAvailabilityAsync(ResultRequest
                            },
                  };
         case ResultStatus.Unspecified:
-        case ResultStatus.Notfound: // TODO: define a specific error type ?
         default:
           throw new ArgumentOutOfRangeException(nameof(result.Status));
       }

diff --git a/Common/src/gRPC/Services/WatchToGrpc.cs b/Common/src/gRPC/Services/WatchToGrpc.cs
@@ -187,7 +187,7 @@ await Task.Factory.StartNew(async () =>
                                                                                                                   NewResult =
                                                                                                                     new EventSubscriptionResponse.Types.NewResult
                                                                                                                     {
-                                                                                                                      Status   = cur.Status,
+                                                                                                                      Status   = cur.Status.ToGrpcStatus(),
                                                                                                                       OwnerId  = cur.OwnerId,
                                                                                                                       ResultId = cur.ResultId,
                                                                                                                     },
@@ -221,7 +221,7 @@ await Task.Factory.StartNew(async () =>
                                                                                                                     ResultStatusUpdate
                                                                                                                     {
                                                                                                                       ResultId = cur.ResultId,
-                                                                                                                      Status   = cur.Status,
+                                                                                                                      Status   = cur.Status.ToGrpcStatus(),
                                                                                                                     },
                                                                                                                   SessionId = cur.SessionId,
                                                                                                                 });
@@ -327,7 +327,7 @@ await Task.Factory.StartNew(async () =>
                                                                                              {
                                                                                                NewResult = new EventSubscriptionResponse.Types.NewResult
                                                                                                            {
-                                                                                                             Status   = cur.Status,
+                                                                                                             Status   = cur.Status.ToGrpcStatus(),
                                                                                                              OwnerId  = cur.OwnerTaskId,
                                                                                                              ResultId = cur.ResultId,
                                                                                                            },

diff --git a/Common/tests/Helpers/SimpleResultTable.cs b/Common/tests/Helpers/SimpleResultTable.cs
@@ -22,7 +22,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 
-using ArmoniK.Api.gRPC.V1;
 using ArmoniK.Core.Base.DataStructures;
 using ArmoniK.Core.Common.Storage;
 

diff --git a/Common/tests/Helpers/SimpleResultWatcher.cs b/Common/tests/Helpers/SimpleResultWatcher.cs
@@ -22,7 +22,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 
-using ArmoniK.Api.gRPC.V1;
 using ArmoniK.Core.Base.DataStructures;
 using ArmoniK.Core.Common.Storage;
 using ArmoniK.Core.Common.Storage.Events;

diff --git a/Common/tests/ListResultsRequestExt/ToResultFieldTest.cs b/Common/tests/ListResultsRequestExt/ToResultFieldTest.cs
@@ -18,7 +18,6 @@
 using System;
 using System.Collections.Generic;
 
-using ArmoniK.Api.gRPC.V1;
 using ArmoniK.Api.gRPC.V1.Results;
 using ArmoniK.Api.gRPC.V1.SortDirection;
 using ArmoniK.Core.Common.gRPC;

diff --git a/Common/tests/ListResultsRequestExt/ToResultFilterTest.cs b/Common/tests/ListResultsRequestExt/ToResultFilterTest.cs
@@ -26,6 +26,8 @@
 
 using NUnit.Framework;
 
+using ResultStatus = ArmoniK.Core.Common.Storage.ResultStatus;
+
 namespace ArmoniK.Core.Common.Tests.ListResultsRequestExt;
 
 [TestFixture(TestOf = typeof(ToResultFilterTest))]
@@ -90,13 +92,13 @@ TestCaseData CaseFalse(FilterField filterField)
 
     yield return CaseTrue(ListResultsHelper.CreateListResultsFilterStatus(ResultRawEnumField.Status,
                                                                           FilterStatusOperator.Equal,
-                                                                          ResultStatus.Created));
+                                                                          Api.gRPC.V1.ResultStatus.Created));
     yield return CaseFalse(ListResultsHelper.CreateListResultsFilterStatus(ResultRawEnumField.Status,
                                                                            FilterStatusOperator.Equal,
-                                                                           ResultStatus.Aborted));
+                                                                           Api.gRPC.V1.ResultStatus.Aborted));
     yield return CaseTrue(ListResultsHelper.CreateListResultsFilterStatus(ResultRawEnumField.Status,
                                                                           FilterStatusOperator.NotEqual,
-                                                                          ResultStatus.Aborted));
+                                                                          Api.gRPC.V1.ResultStatus.Aborted));
 
     yield return CaseTrue(ListResultsHelper.CreateListResultsFilterString(ResultRawEnumField.SessionId,
                                                                           FilterStringOperator.Equal,

diff --git a/Common/tests/Pollster/AgentTest.cs b/Common/tests/Pollster/AgentTest.cs
@@ -45,6 +45,7 @@
 using NUnit.Framework;
 
 using Agent = ArmoniK.Core.Common.gRPC.Services.Agent;
+using ResultStatus = ArmoniK.Core.Common.Storage.ResultStatus;
 using TaskOptions = ArmoniK.Api.gRPC.V1.TaskOptions;
 using TaskRequest = ArmoniK.Core.Common.gRPC.Services.TaskRequest;
 using TaskStatus = ArmoniK.Core.Common.Storage.TaskStatus;

diff --git a/Common/tests/Pollster/PollsterTest.cs b/Common/tests/Pollster/PollsterTest.cs
@@ -42,6 +42,7 @@
 using NUnit.Framework;
 
 using Output = ArmoniK.Api.gRPC.V1.Output;
+using ResultStatus = ArmoniK.Core.Common.Storage.ResultStatus;
 using TaskOptions = ArmoniK.Core.Base.DataStructures.TaskOptions;
 using TaskRequest = ArmoniK.Core.Common.gRPC.Services.TaskRequest;
 using TaskStatus = ArmoniK.Core.Common.Storage.TaskStatus;