Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Events API client extension method to wait for results completion #417

Merged
merged 3 commits into from
Sep 25, 2023
Merged

feat: Events API client extension method to wait for results completion #417

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
568fed4
feat: Events API client extension method to wait for results completion
aneojgurhem Sep 25, 2023
5abcce1
fix: use while instead of gRPC foreach
aneojgurhem Sep 25, 2023
0b9e044
refactor: use HashSet instead of Dictionary
aneojgurhem Sep 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 149 additions & 0 deletions packages/csharp/ArmoniK.Api.Client/EventsClientExt.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
// This file is part of the ArmoniK project
//
// Copyright (C) ANEO, 2021-2023. All rights reserved.
// W. Kirschenmann <[email protected]>
// J. Gurhem <[email protected]>
// D. Dubuc <[email protected]>
// L. Ziane Khodja <[email protected]>
// F. Lemaitre <[email protected]>
// S. Djebbar <[email protected]>
// J. Fonseca <[email protected]>
//
// 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 System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

using ArmoniK.Api.gRPC.V1;
using ArmoniK.Api.gRPC.V1.Events;
using ArmoniK.Api.gRPC.V1.Results;

using Grpc.Core.Utils;

using JetBrains.Annotations;

namespace ArmoniK.Api.Client
{
/// <summary>
/// <see cref="Events.EventsClient" /> extensions methods
/// </summary>
[PublicAPI]
public static class EventsClientExt
{
private static FiltersAnd ResultsFilter(string resultId)
=> new()
{
And =
{
new FilterField
{
Field = new ResultField
{
ResultRawField = new ResultRawField
{
Field = ResultRawEnumField.ResultId,
},
},
FilterString = new FilterString
{
Operator = FilterStringOperator.Equal,
Value = resultId,
},
},
},
};

/// <summary>
/// Wait until the given results are completed
/// </summary>
/// <param name="client">gRPC result client</param>
/// <param name="sessionId">The session ID in which the results are located</param>
/// <param name="resultIds">A collection of results to wait for</param>
/// <param name="cancellationToken">Token used to cancel the execution of the method</param>
/// <exception cref="Exception">if a result is aborted</exception>
[PublicAPI]
public static async Task WaitForResultsAsync(this Events.EventsClient client,
string sessionId,
ICollection<string> resultIds,
CancellationToken cancellationToken)
{
var resultsNotFound = resultIds.ToDictionary(id => id,
_ => true);
dbrasseur-aneo marked this conversation as resolved.
Show resolved Hide resolved

using var streamingCall = client.GetEvents(new EventSubscriptionRequest
{
SessionId = sessionId,
ReturnedEvents =
{
EventsEnum.ResultStatusUpdate,
EventsEnum.NewResult,
},
ResultsFilters = new Filters
{
Or =
{
resultIds.Select(ResultsFilter),
},
},
});


await streamingCall.ResponseStream.ForEachAsync(resp =>
{
cancellationToken.ThrowIfCancellationRequested();
if (resp.UpdateCase == EventSubscriptionResponse.UpdateOneofCase.ResultStatusUpdate &&
resultsNotFound.ContainsKey(resp.ResultStatusUpdate.ResultId))
{
if (resp.ResultStatusUpdate.Status == ResultStatus.Completed)
{
resultsNotFound.Remove(resp.ResultStatusUpdate.ResultId);
if (!resultsNotFound.Any())
{
return Task.CompletedTask;
}
}

if (resp.ResultStatusUpdate.Status == ResultStatus.Aborted)
{
throw new Exception($"Result {resp.ResultStatusUpdate.ResultId} has been aborted");
}
}

if (resp.UpdateCase == EventSubscriptionResponse.UpdateOneofCase.NewResult &&
resultsNotFound.ContainsKey(resp.NewResult.ResultId))
{
if (resp.NewResult.Status == ResultStatus.Completed)
{
resultsNotFound.Remove(resp.NewResult.ResultId);
if (!resultsNotFound.Any())
{
return Task.CompletedTask;
}
}

if (resp.NewResult.Status == ResultStatus.Aborted)
{
throw new Exception($"Result {resp.NewResult.ResultId} has been aborted");
}
}

return Task.CompletedTask;
})
.ConfigureAwait(false);
}
}
}
Loading