|
| 1 | +// Copyright (c) Microsoft Corporation. |
| 2 | +// Licensed under the MIT License. |
| 3 | + |
| 4 | +using Microsoft.AspNetCore.Mvc; |
| 5 | +using Microsoft.DurableTask.Client; |
| 6 | +using Microsoft.DurableTask.ExportHistory; |
| 7 | +using ExportHistoryWebApp.Models; |
| 8 | + |
| 9 | +namespace ExportHistoryWebApp.Controllers; |
| 10 | + |
| 11 | +/// <summary> |
| 12 | +/// Controller for managing export history jobs through a REST API. |
| 13 | +/// Provides endpoints for creating, reading, listing, and deleting export jobs. |
| 14 | +/// </summary> |
| 15 | +[ApiController] |
| 16 | +[Route("export-jobs")] |
| 17 | +public class ExportJobController : ControllerBase |
| 18 | +{ |
| 19 | + readonly ExportHistoryClient exportHistoryClient; |
| 20 | + readonly ILogger<ExportJobController> logger; |
| 21 | + |
| 22 | + /// <summary> |
| 23 | + /// Initializes a new instance of the <see cref="ExportJobController"/> class. |
| 24 | + /// </summary> |
| 25 | + /// <param name="exportHistoryClient">Client for managing export history jobs.</param> |
| 26 | + /// <param name="logger">Logger for recording controller operations.</param> |
| 27 | + public ExportJobController( |
| 28 | + ExportHistoryClient exportHistoryClient, |
| 29 | + ILogger<ExportJobController> logger) |
| 30 | + { |
| 31 | + this.exportHistoryClient = exportHistoryClient ?? throw new ArgumentNullException(nameof(exportHistoryClient)); |
| 32 | + this.logger = logger ?? throw new ArgumentNullException(nameof(logger)); |
| 33 | + } |
| 34 | + |
| 35 | + /// <summary> |
| 36 | + /// Creates a new export job based on the provided configuration. |
| 37 | + /// </summary> |
| 38 | + /// <param name="request">The export job creation request.</param> |
| 39 | + /// <returns>The created export job description.</returns> |
| 40 | + [HttpPost] |
| 41 | + public async Task<ActionResult<ExportJobDescription>> CreateExportJob([FromBody] CreateExportJobRequest request) |
| 42 | + { |
| 43 | + if (request == null) |
| 44 | + { |
| 45 | + return this.BadRequest("createExportJobRequest cannot be null"); |
| 46 | + } |
| 47 | + |
| 48 | + try |
| 49 | + { |
| 50 | + ExportDestination? destination = null; |
| 51 | + if (!string.IsNullOrEmpty(request.ContainerName)) |
| 52 | + { |
| 53 | + destination = new ExportDestination(request.ContainerName) |
| 54 | + { |
| 55 | + Prefix = request.Prefix, |
| 56 | + }; |
| 57 | + } |
| 58 | + |
| 59 | + ExportJobCreationOptions creationOptions = new ExportJobCreationOptions( |
| 60 | + mode: request.Mode, |
| 61 | + createdTimeFrom: request.CreatedTimeFrom, |
| 62 | + createdTimeTo: request.CreatedTimeTo, |
| 63 | + destination: destination, |
| 64 | + jobId: request.JobId, |
| 65 | + format: request.Format, |
| 66 | + runtimeStatus: request.RuntimeStatus, |
| 67 | + maxInstancesPerBatch: request.MaxInstancesPerBatch); |
| 68 | + |
| 69 | + ExportHistoryJobClient jobClient = await this.exportHistoryClient.CreateJobAsync(creationOptions); |
| 70 | + ExportJobDescription description = await jobClient.DescribeAsync(); |
| 71 | + |
| 72 | + this.logger.LogInformation("Created new export job with ID: {JobId}", description.JobId); |
| 73 | + |
| 74 | + return this.CreatedAtAction(nameof(GetExportJob), new { id = description.JobId }, description); |
| 75 | + } |
| 76 | + catch (ArgumentException ex) |
| 77 | + { |
| 78 | + this.logger.LogError(ex, "Validation failed while creating export job {JobId}", request.JobId); |
| 79 | + return this.BadRequest(ex.Message); |
| 80 | + } |
| 81 | + catch (Exception ex) |
| 82 | + { |
| 83 | + this.logger.LogError(ex, "Error creating export job {JobId}", request.JobId); |
| 84 | + return this.StatusCode(500, "An error occurred while creating the export job"); |
| 85 | + } |
| 86 | + } |
| 87 | + |
| 88 | + /// <summary> |
| 89 | + /// Retrieves a specific export job by its ID. |
| 90 | + /// </summary> |
| 91 | + /// <param name="id">The ID of the export job to retrieve.</param> |
| 92 | + /// <returns>The export job description if found.</returns> |
| 93 | + [HttpGet("{id}")] |
| 94 | + public async Task<ActionResult<ExportJobDescription>> GetExportJob(string id) |
| 95 | + { |
| 96 | + try |
| 97 | + { |
| 98 | + ExportJobDescription? job = await this.exportHistoryClient.GetJobAsync(id); |
| 99 | + return this.Ok(job); |
| 100 | + } |
| 101 | + catch (ExportJobNotFoundException) |
| 102 | + { |
| 103 | + return this.NotFound(); |
| 104 | + } |
| 105 | + catch (Exception ex) |
| 106 | + { |
| 107 | + this.logger.LogError(ex, "Error retrieving export job {JobId}", id); |
| 108 | + return this.StatusCode(500, "An error occurred while retrieving the export job"); |
| 109 | + } |
| 110 | + } |
| 111 | + |
| 112 | + /// <summary> |
| 113 | + /// Lists all export jobs, optionally filtered by query parameters. |
| 114 | + /// </summary> |
| 115 | + /// <param name="status">Optional filter by job status.</param> |
| 116 | + /// <param name="jobIdPrefix">Optional filter by job ID prefix.</param> |
| 117 | + /// <param name="createdFrom">Optional filter for jobs created after this time.</param> |
| 118 | + /// <param name="createdTo">Optional filter for jobs created before this time.</param> |
| 119 | + /// <param name="pageSize">Optional page size for pagination.</param> |
| 120 | + /// <param name="continuationToken">Optional continuation token for pagination.</param> |
| 121 | + /// <returns>A collection of export job descriptions.</returns> |
| 122 | + [HttpGet("list")] |
| 123 | + public async Task<ActionResult<IEnumerable<ExportJobDescription>>> ListExportJobs( |
| 124 | + [FromQuery] ExportJobStatus? status = null, |
| 125 | + [FromQuery] string? jobIdPrefix = null, |
| 126 | + [FromQuery] DateTimeOffset? createdFrom = null, |
| 127 | + [FromQuery] DateTimeOffset? createdTo = null, |
| 128 | + [FromQuery] int? pageSize = null, |
| 129 | + [FromQuery] string? continuationToken = null) |
| 130 | + { |
| 131 | + try |
| 132 | + { |
| 133 | + ExportJobQuery? query = null; |
| 134 | + if (status.HasValue || !string.IsNullOrEmpty(jobIdPrefix) || createdFrom.HasValue || createdTo.HasValue || pageSize.HasValue || !string.IsNullOrEmpty(continuationToken)) |
| 135 | + { |
| 136 | + query = new ExportJobQuery |
| 137 | + { |
| 138 | + Status = status, |
| 139 | + JobIdPrefix = jobIdPrefix, |
| 140 | + CreatedFrom = createdFrom, |
| 141 | + CreatedTo = createdTo, |
| 142 | + PageSize = pageSize, |
| 143 | + ContinuationToken = continuationToken, |
| 144 | + }; |
| 145 | + } |
| 146 | + |
| 147 | + AsyncPageable<ExportJobDescription> jobs = this.exportHistoryClient.ListJobsAsync(query); |
| 148 | + |
| 149 | + // Collect all jobs from the async pageable |
| 150 | + List<ExportJobDescription> jobList = new List<ExportJobDescription>(); |
| 151 | + await foreach (ExportJobDescription job in jobs) |
| 152 | + { |
| 153 | + jobList.Add(job); |
| 154 | + } |
| 155 | + |
| 156 | + return this.Ok(jobList); |
| 157 | + } |
| 158 | + catch (Exception ex) |
| 159 | + { |
| 160 | + this.logger.LogError(ex, "Error retrieving export jobs"); |
| 161 | + return this.StatusCode(500, "An error occurred while retrieving export jobs"); |
| 162 | + } |
| 163 | + } |
| 164 | + |
| 165 | + /// <summary> |
| 166 | + /// Deletes an export job by its ID. |
| 167 | + /// </summary> |
| 168 | + /// <param name="id">The ID of the export job to delete.</param> |
| 169 | + /// <returns>No content if successful.</returns> |
| 170 | + [HttpDelete("{id}")] |
| 171 | + public async Task<IActionResult> DeleteExportJob(string id) |
| 172 | + { |
| 173 | + try |
| 174 | + { |
| 175 | + ExportHistoryJobClient jobClient = this.exportHistoryClient.GetJobClient(id); |
| 176 | + await jobClient.DeleteAsync(); |
| 177 | + return this.NoContent(); |
| 178 | + } |
| 179 | + catch (ExportJobNotFoundException) |
| 180 | + { |
| 181 | + return this.NotFound(); |
| 182 | + } |
| 183 | + catch (Exception ex) |
| 184 | + { |
| 185 | + this.logger.LogError(ex, "Error deleting export job {JobId}", id); |
| 186 | + return this.StatusCode(500, "An error occurred while deleting the export job"); |
| 187 | + } |
| 188 | + } |
| 189 | +} |
| 190 | + |
0 commit comments