Merge pull request #304 from neuroglia-io/schedules-feat

Added application and user interfaces to manage Schedules

Author: JBBianchi

src/apis/management/Synapse.Apis.Management.Core/Services/ISynapseManagementApi.cs

@@ -19,6 +19,7 @@
 using Synapse.Integration.Commands.Correlations;
 using Synapse.Integration.Commands.EventDefinitionCollections;
 using Synapse.Integration.Commands.FunctionDefinitionCollections;
+using Synapse.Integration.Commands.Schedules;
 using Synapse.Integration.Commands.WorkflowInstances;
 using Synapse.Integration.Commands.Workflows;
 using Synapse.Integration.Models;
@@ -401,6 +402,100 @@ public interface ISynapseManagementApi
 
         #endregion
 
+        #region Schedules
+
+        /// <summary>
+        /// Creates a new <see cref="V1Schedule"/>
+        /// </summary>
+        /// <param name="command">The object that describes the command to execute</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>The newly created <see cref="V1Schedule"/></returns>
+        [OperationContract]
+        Task<V1Schedule> CreateScheduleAsync(V1CreateScheduleCommand command, CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Gets the <see cref="V1Schedule"/> with the specified id
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to get</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>The <see cref="V1Schedule"/> with the specified id</returns>
+
+        [OperationContract]
+        Task<V1Schedule> GetScheduleByIdAsync(string id, CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Lists existing <see cref="V1Schedule"/>s
+        /// </summary>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new <see cref="List{T}"/> containing all existing <see cref="V1Schedule"/>s</returns>
+        [OperationContract]
+        Task<List<V1Schedule>> GetSchedulesAsync(CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Lists existing <see cref="V1Schedule"/>s
+        /// </summary>
+        /// <param name="query">The OData query string</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new <see cref="List{T}"/> containing all existing <see cref="V1Schedule"/>s</returns>
+        [OperationContract]
+        Task<List<V1Schedule>> GetSchedulesAsync(string query, CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Triggers the specified <see cref="V1Schedule"/>
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to trigger</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task TriggerScheduleAsync(string id, CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Suspends the specified <see cref="V1Schedule"/>
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to suspend</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task SuspendScheduleAsync(string id, CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Resumes the specified <see cref="V1Schedule"/>
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to resume</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task ResumeScheduleAsync(string id, CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Retires the specified <see cref="V1Schedule"/>
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to retire</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task RetireScheduleAsync(string id, CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Makes the specified <see cref="V1Schedule"/> obsolete
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to make obsolete</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task MakeScheduleObsoleteAsync(string id, CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Deletes the <see cref="V1Schedule"/> with the specified id
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to delete</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task DeleteScheduleAsync(string id, CancellationToken cancellationToken = default);
+
+        #endregion
+
     }
 
 }

src/apis/management/Synapse.Apis.Management.Grpc.Client/Services/ISynapseGrpcManagementApi.cs

@@ -20,6 +20,7 @@
 using Synapse.Integration.Commands.Correlations;
 using Synapse.Integration.Commands.EventDefinitionCollections;
 using Synapse.Integration.Commands.FunctionDefinitionCollections;
+using Synapse.Integration.Commands.Schedules;
 using Synapse.Integration.Commands.WorkflowInstances;
 using Synapse.Integration.Commands.Workflows;
 
@@ -376,6 +377,92 @@ public interface ISynapseGrpcManagementApi
 
         #endregion
 
+        #region Schedules
+
+        /// <summary>
+        /// Creates a new <see cref="V1Schedule"/>
+        /// </summary>
+        /// <param name="command">The object that describes the command to execute</param>
+        /// <param name="context">The current <see cref="CallContext" /></param>
+        /// <returns>The newly created <see cref="V1Schedule"/></returns>
+        [OperationContract]
+        Task<GrpcApiResult<V1Schedule>> CreateScheduleAsync(V1CreateScheduleCommand command, CallContext context = default);
+
+        /// <summary>
+        /// Gets the <see cref="V1Schedule"/> with the specified id
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to get</param>
+        /// <param name="context">The current <see cref="CallContext" /></param>
+        /// <returns>The <see cref="V1Schedule"/> with the specified id</returns>
+
+        [OperationContract]
+        Task<GrpcApiResult<V1Schedule>> GetScheduleByIdAsync(string id, CallContext context = default);
+
+        /// <summary>
+        /// Lists existing <see cref="V1Schedule"/>s
+        /// </summary>
+        /// <param name="query">The OData query string</param>
+        /// <param name="context">The current <see cref="CallContext" /></param>
+        /// <returns>A new <see cref="List{T}"/> containing all existing <see cref="V1Schedule"/>s</returns>
+        [OperationContract]
+        Task<GrpcApiResult<List<V1Schedule>>> GetSchedulesAsync(string? query = null, CallContext context = default);
+
+        /// <summary>
+        /// Triggers the specified <see cref="V1Schedule"/>
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to trigger</param>
+        /// <param name="context">The current <see cref="CallContext" /></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task<GrpcApiResult> TriggerScheduleAsync(string id, CallContext context = default);
+
+        /// <summary>
+        /// Suspends the specified <see cref="V1Schedule"/>
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to suspend</param>
+        /// <param name="context">The current <see cref="CallContext" /></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task<GrpcApiResult> SuspendScheduleAsync(string id, CallContext context = default);
+
+        /// <summary>
+        /// Resumes the specified <see cref="V1Schedule"/>
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to resume</param>
+        /// <param name="context">The current <see cref="CallContext" /></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task<GrpcApiResult> ResumeScheduleAsync(string id, CallContext context = default);
+
+        /// <summary>
+        /// Retires the specified <see cref="V1Schedule"/>
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to retire</param>
+        /// <param name="context">The current <see cref="CallContext" /></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task<GrpcApiResult> RetireScheduleAsync(string id, CallContext context = default);
+
+        /// <summary>
+        /// Makes the specified <see cref="V1Schedule"/> obsolete
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to make obsolete</param>
+        /// <param name="context">The current <see cref="CallContext" /></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task<GrpcApiResult> MakeScheduleObsoleteAsync(string id, CallContext context = default);
+
+        /// <summary>
+        /// Deletes the <see cref="V1Schedule"/> with the specified id
+        /// </summary>
+        /// <param name="id">The id of the <see cref="V1Schedule"/> to delete</param>
+        /// <param name="context">The current <see cref="CallContext" /></param>
+        /// <returns>A new awaitable <see cref="Task"/></returns>
+        [OperationContract]
+        Task<GrpcApiResult> DeleteScheduleAsync(string id, CallContext context = default);
+
+        #endregion
+
     }
 
 }

src/apis/management/Synapse.Apis.Management.Grpc.Client/Services/SynapseGrpcManagementApiClient.cs

@@ -19,6 +19,7 @@
 using Synapse.Integration.Commands.Correlations;
 using Synapse.Integration.Commands.EventDefinitionCollections;
 using Synapse.Integration.Commands.FunctionDefinitionCollections;
+using Synapse.Integration.Commands.Schedules;
 using Synapse.Integration.Commands.WorkflowInstances;
 using Synapse.Integration.Commands.Workflows;
 
@@ -417,6 +418,79 @@ public virtual async Task<V1OperationalReport> GetOperationalReportAsync(DateTim
 
         #endregion
 
+        #region Schedules
+
+        /// <inheritdoc/>
+        public virtual async Task<V1Schedule> CreateScheduleAsync(V1CreateScheduleCommand command, CancellationToken cancellationToken = default)
+        {
+            var result = await this.Adapter.CreateScheduleAsync(command, cancellationToken);
+            if (!result.Succeeded) throw new SynapseApiException(result);
+            return result.Data!;
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task<V1Schedule> GetScheduleByIdAsync(string id, CancellationToken cancellationToken = default)
+        {
+            var result = await this.Adapter.GetScheduleByIdAsync(id, cancellationToken);
+            if (!result.Succeeded) throw new SynapseApiException(result);
+            return result.Data!;
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task<List<V1Schedule>> GetSchedulesAsync(CancellationToken cancellationToken = default) => await this.GetSchedulesAsync(null!, cancellationToken);
+
+        /// <inheritdoc/>
+        public virtual async Task<List<V1Schedule>> GetSchedulesAsync(string query, CancellationToken cancellationToken = default)
+        {
+            var result = await this.Adapter.GetSchedulesAsync(query, cancellationToken);
+            if (!result.Succeeded) throw new SynapseApiException(result);
+            return result.Data!;
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task TriggerScheduleAsync(string id, CancellationToken cancellationToken = default)
+        {
+            var result = await this.Adapter.TriggerScheduleAsync(id, cancellationToken);
+            if (!result.Succeeded) throw new SynapseApiException(result);
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task SuspendScheduleAsync(string id, CancellationToken cancellationToken = default)
+        {
+            var result = await this.Adapter.SuspendScheduleAsync(id, cancellationToken);
+            if (!result.Succeeded) throw new SynapseApiException(result);
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task ResumeScheduleAsync(string id, CancellationToken cancellationToken = default)
+        {
+            var result = await this.Adapter.ResumeScheduleAsync(id, cancellationToken);
+            if (!result.Succeeded) throw new SynapseApiException(result);
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task RetireScheduleAsync(string id, CancellationToken cancellationToken = default)
+        {
+            var result = await this.Adapter.RetireScheduleAsync(id, cancellationToken);
+            if (!result.Succeeded) throw new SynapseApiException(result);
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task MakeScheduleObsoleteAsync(string id, CancellationToken cancellationToken = default)
+        {
+            var result = await this.Adapter.MakeScheduleObsoleteAsync(id, cancellationToken);
+            if (!result.Succeeded) throw new SynapseApiException(result);
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task DeleteScheduleAsync(string id, CancellationToken cancellationToken = default)
+        {
+            var result = await this.Adapter.DeleteScheduleAsync(id, cancellationToken);
+            if (!result.Succeeded) throw new SynapseApiException(result);
+        }
+
+        #endregion
+
     }
 
 }

src/apis/management/Synapse.Apis.Management.Grpc/Services/SynapseGrpcManagementApi.cs

@@ -29,6 +29,7 @@
 using Synapse.Integration.Commands.Correlations;
 using Synapse.Integration.Commands.EventDefinitionCollections;
 using Synapse.Integration.Commands.FunctionDefinitionCollections;
+using Synapse.Integration.Commands.Schedules;
 using Synapse.Integration.Commands.Workflows;
 using Synapse.Integration.Models;
 
@@ -326,6 +327,70 @@ public virtual async Task<GrpcApiResult<V1OperationalReport>> GetOperationalRepo
 
         #endregion
 
+        #region Schedules
+
+        /// <inheritdoc/>
+        public virtual async Task<GrpcApiResult<V1Schedule>> CreateScheduleAsync(V1CreateScheduleCommand command, CallContext context = default)
+        {
+            return GrpcApiResult.CreateFor(await this.Mediator.ExecuteAsync(this.Mapper.Map<Application.Commands.Schedules.V1CreateScheduleCommand>(command), context.CancellationToken));
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task<GrpcApiResult<V1Schedule>> GetScheduleByIdAsync(string id, CallContext context = default)
+        {
+            return GrpcApiResult.CreateFor(await this.Mediator.ExecuteAsync(new V1FindByIdQuery<V1Schedule, string>(id), context.CancellationToken));
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task<GrpcApiResult<List<V1Schedule>>> GetSchedulesAsync(string? query = null, CallContext context = default)
+        {
+            return GrpcApiResult.CreateFor(await this.Mediator.ExecuteAsync(new V1FilterQuery<V1Schedule>(this.QueryOptionsParser.Parse<V1Schedule>(query)), context.CancellationToken));
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task<GrpcApiResult> TriggerScheduleAsync(string id, CallContext context = default)
+        {
+            if (string.IsNullOrWhiteSpace(id)) throw new ArgumentNullException(nameof(id));
+            return GrpcApiResult.CreateFor(await this.Mediator.ExecuteAsync(this.Mapper.Map<Application.Commands.Schedules.V1TriggerScheduleCommand>(id), context.CancellationToken));
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task<GrpcApiResult> SuspendScheduleAsync(string id, CallContext context = default)
+        {
+            if (string.IsNullOrWhiteSpace(id)) throw new ArgumentNullException(nameof(id));
+            return GrpcApiResult.CreateFor(await this.Mediator.ExecuteAsync(this.Mapper.Map<Application.Commands.Schedules.V1SuspendScheduleCommand>(id), context.CancellationToken));
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task<GrpcApiResult> ResumeScheduleAsync(string id, CallContext context = default)
+        {
+            if (string.IsNullOrWhiteSpace(id)) throw new ArgumentNullException(nameof(id));
+            return GrpcApiResult.CreateFor(await this.Mediator.ExecuteAsync(this.Mapper.Map<Application.Commands.Schedules.V1ResumeScheduleCommand>(id), context.CancellationToken));
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task<GrpcApiResult> RetireScheduleAsync(string id, CallContext context = default)
+        {
+            if (string.IsNullOrWhiteSpace(id)) throw new ArgumentNullException(nameof(id));
+            return GrpcApiResult.CreateFor(await this.Mediator.ExecuteAsync(this.Mapper.Map<Application.Commands.Schedules.V1RetireScheduleCommand>(id), context.CancellationToken));
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task<GrpcApiResult> MakeScheduleObsoleteAsync(string id, CallContext context = default)
+        {
+            if (string.IsNullOrWhiteSpace(id)) throw new ArgumentNullException(nameof(id));
+            return GrpcApiResult.CreateFor(await this.Mediator.ExecuteAsync(this.Mapper.Map<Application.Commands.Schedules.V1MakeScheduleObsoleteCommand>(id), context.CancellationToken));
+        }
+
+        /// <inheritdoc/>
+        public virtual async Task<GrpcApiResult> DeleteScheduleAsync(string id, CallContext context = default)
+        {
+            if (string.IsNullOrWhiteSpace(id)) throw new ArgumentNullException(nameof(id));
+            return GrpcApiResult.CreateFor(await this.Mediator.ExecuteAsync(new V1DeleteCommand<Domain.Models.V1Schedule, string>(id), context.CancellationToken));
+        }
+
+        #endregion
+
     }
 
 }