CUB-37: implement cost-per-print calculation service
This commit is contained in:
108
backend/API/Controllers/CostAnalysisController.cs
Normal file
108
backend/API/Controllers/CostAnalysisController.cs
Normal file
@@ -0,0 +1,108 @@
|
||||
using Extrudex.API.DTOs.PrintJobs;
|
||||
using Extrudex.Domain.Interfaces;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
|
||||
namespace Extrudex.API.Controllers;
|
||||
|
||||
/// <summary>
|
||||
/// Controller for cost analysis endpoints. Provides spool-level
|
||||
/// cost breakdowns and aggregated COGS reporting.
|
||||
/// </summary>
|
||||
[ApiController]
|
||||
[Route("api/cost-analysis")]
|
||||
public class CostAnalysisController : ControllerBase
|
||||
{
|
||||
private readonly ICostPerPrintService _costService;
|
||||
private readonly ILogger<CostAnalysisController> _logger;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="CostAnalysisController"/> class.
|
||||
/// </summary>
|
||||
/// <param name="costService">The cost-per-print calculation service.</param>
|
||||
/// <param name="logger">The logger for diagnostic output.</param>
|
||||
public CostAnalysisController(
|
||||
ICostPerPrintService costService,
|
||||
ILogger<CostAnalysisController> logger)
|
||||
{
|
||||
_costService = costService;
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
// ── POST /api/cost-analysis/spool ────────────────────────────
|
||||
|
||||
/// <summary>
|
||||
/// Calculates cost breakdowns for all print jobs associated with a specific spool.
|
||||
/// Returns per-job costs plus an aggregated total. Jobs with missing cost data
|
||||
/// include warnings and null cost fields — the endpoint never throws for missing data.
|
||||
/// </summary>
|
||||
/// <param name="request">The request containing the spool identifier.</param>
|
||||
/// <returns>A spool-level cost summary with per-job breakdowns.</returns>
|
||||
/// <response code="200">Returns the spool cost breakdown with per-job details.</response>
|
||||
/// <response code="404">If the spool has no print jobs.</response>
|
||||
[HttpPost("spool")]
|
||||
[ProducesResponseType(typeof(SpoolCostResponse), StatusCodes.Status200OK)]
|
||||
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
||||
public async Task<ActionResult<SpoolCostResponse>> CalculateSpoolCost([FromBody] SpoolCostRequest request)
|
||||
{
|
||||
_logger.LogDebug("Calculating cost breakdown for spool {SpoolId}", request.SpoolId);
|
||||
|
||||
var results = await _costService.CalculateBySpoolAsync(request.SpoolId);
|
||||
|
||||
if (results.Count == 0)
|
||||
{
|
||||
return NotFound(new { error = $"No print jobs found for spool with ID '{request.SpoolId}'." });
|
||||
}
|
||||
|
||||
// Build the spool-level summary
|
||||
var firstResult = results[0];
|
||||
var jobResponses = results.Select(MapCostToResponse).ToList();
|
||||
|
||||
// Aggregate total cost and grams — only include jobs that have a valid cost
|
||||
var calculableJobs = results.Where(r => r.CostPerPrint.HasValue).ToList();
|
||||
var totalCost = calculableJobs.Count == results.Count
|
||||
? Math.Round(calculableJobs.Sum(r => r.CostPerPrint!.Value), 4)
|
||||
: (decimal?)null;
|
||||
|
||||
var aggregateWarnings = new List<string>();
|
||||
if (calculableJobs.Count < results.Count)
|
||||
{
|
||||
aggregateWarnings.Add(
|
||||
$"{results.Count - calculableJobs.Count} of {results.Count} print jobs have missing cost data. " +
|
||||
"Total cost reflects only jobs with complete data.");
|
||||
}
|
||||
|
||||
var response = new SpoolCostResponse
|
||||
{
|
||||
SpoolId = request.SpoolId,
|
||||
SpoolSerial = firstResult.SpoolSerial,
|
||||
PurchasePrice = firstResult.PurchasePrice,
|
||||
WeightTotalGrams = firstResult.WeightTotalGrams,
|
||||
CostPerGram = firstResult.CostPerGram,
|
||||
TotalGramsConsumed = results.Sum(r => r.GramsDerived),
|
||||
TotalCost = totalCost,
|
||||
JobCount = results.Count,
|
||||
Jobs = jobResponses,
|
||||
Warnings = aggregateWarnings
|
||||
};
|
||||
|
||||
return Ok(response);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Maps a domain CostPerPrintResult to an API CostPerPrintResponse DTO.
|
||||
/// </summary>
|
||||
private static CostPerPrintResponse MapCostToResponse(CostPerPrintResult r) => new()
|
||||
{
|
||||
PrintJobId = r.PrintJobId,
|
||||
PrintName = r.PrintName,
|
||||
SpoolId = r.SpoolId,
|
||||
SpoolSerial = r.SpoolSerial,
|
||||
MmExtruded = r.MmExtruded,
|
||||
GramsDerived = r.GramsDerived,
|
||||
PurchasePrice = r.PurchasePrice,
|
||||
WeightTotalGrams = r.WeightTotalGrams,
|
||||
CostPerGram = r.CostPerGram,
|
||||
CostPerPrint = r.CostPerPrint,
|
||||
Warnings = r.Warnings
|
||||
};
|
||||
}
|
||||
@@ -2,6 +2,7 @@ using Extrudex.API.DTOs;
|
||||
using Extrudex.API.DTOs.PrintJobs;
|
||||
using Extrudex.Domain.Entities;
|
||||
using Extrudex.Domain.Enums;
|
||||
using Extrudex.Domain.Interfaces;
|
||||
using Extrudex.Infrastructure.Data;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.EntityFrameworkCore;
|
||||
@@ -19,16 +20,22 @@ namespace Extrudex.API.Controllers;
|
||||
public class PrintJobsController : ControllerBase
|
||||
{
|
||||
private readonly ExtrudexDbContext _dbContext;
|
||||
private readonly ICostPerPrintService _costService;
|
||||
private readonly ILogger<PrintJobsController> _logger;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="PrintJobsController"/> class.
|
||||
/// </summary>
|
||||
/// <param name="dbContext">The database context for data access.</param>
|
||||
/// <param name="costService">The cost-per-print calculation service.</param>
|
||||
/// <param name="logger">The logger for diagnostic output.</param>
|
||||
public PrintJobsController(ExtrudexDbContext dbContext, ILogger<PrintJobsController> logger)
|
||||
public PrintJobsController(
|
||||
ExtrudexDbContext dbContext,
|
||||
ICostPerPrintService costService,
|
||||
ILogger<PrintJobsController> logger)
|
||||
{
|
||||
_dbContext = dbContext;
|
||||
_costService = costService;
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
@@ -413,6 +420,34 @@ public class PrintJobsController : ControllerBase
|
||||
return NoContent();
|
||||
}
|
||||
|
||||
// ── POST /api/printjobs/{id}/cost ─────────────────────────────
|
||||
|
||||
/// <summary>
|
||||
/// Calculates the cost of goods sold (COGS) for a specific print job.
|
||||
/// Uses the spool’s purchase price and the print job’s derived grams consumed
|
||||
/// to produce a cost breakdown. Returns warnings instead of errors when
|
||||
/// cost data is missing or incomplete.
|
||||
/// </summary>
|
||||
/// <param name="id">The unique identifier of the print job.</param>
|
||||
/// <returns>A cost breakdown with warnings if data is incomplete.</returns>
|
||||
/// <response code="200">Returns the cost breakdown for the print job.</response>
|
||||
/// <response code="404">If the print job with the given ID is not found.</response>
|
||||
[HttpPost("{id:guid}/cost")]
|
||||
[ProducesResponseType(typeof(CostPerPrintResponse), StatusCodes.Status200OK)]
|
||||
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
||||
public async Task<ActionResult<CostPerPrintResponse>> CalculateCost(Guid id)
|
||||
{
|
||||
_logger.LogDebug("Calculating cost for print job {Id}", id);
|
||||
|
||||
var result = await _costService.CalculateAsync(id);
|
||||
|
||||
// If the job was not found, return 404
|
||||
if (result.Warnings.Any(w => w.Contains("not found")))
|
||||
return NotFound(new { error = $"Print job with ID '{id}' not found." });
|
||||
|
||||
return Ok(MapCostToResponse(result));
|
||||
}
|
||||
|
||||
// ── Gram Derivation Formula ────────────────────────────────────
|
||||
|
||||
/// <summary>
|
||||
@@ -509,4 +544,22 @@ public class PrintJobsController : ControllerBase
|
||||
CreatedAt = j.CreatedAt,
|
||||
UpdatedAt = j.UpdatedAt
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// Maps a domain CostPerPrintResult to an API CostPerPrintResponse DTO.
|
||||
/// </summary>
|
||||
private static CostPerPrintResponse MapCostToResponse(CostPerPrintResult r) => new()
|
||||
{
|
||||
PrintJobId = r.PrintJobId,
|
||||
PrintName = r.PrintName,
|
||||
SpoolId = r.SpoolId,
|
||||
SpoolSerial = r.SpoolSerial,
|
||||
MmExtruded = r.MmExtruded,
|
||||
GramsDerived = r.GramsDerived,
|
||||
PurchasePrice = r.PurchasePrice,
|
||||
WeightTotalGrams = r.WeightTotalGrams,
|
||||
CostPerGram = r.CostPerGram,
|
||||
CostPerPrint = r.CostPerPrint,
|
||||
Warnings = r.Warnings
|
||||
};
|
||||
}
|
||||
99
backend/API/DTOs/PrintJobs/CostPerPrintDtos.cs
Normal file
99
backend/API/DTOs/PrintJobs/CostPerPrintDtos.cs
Normal file
@@ -0,0 +1,99 @@
|
||||
using System.ComponentModel.DataAnnotations;
|
||||
|
||||
namespace Extrudex.API.DTOs.PrintJobs;
|
||||
|
||||
/// <summary>
|
||||
/// Response DTO for cost-per-print calculation. Contains the full cost
|
||||
/// breakdown and any warnings about missing or incomplete data.
|
||||
/// </summary>
|
||||
public class CostPerPrintResponse
|
||||
{
|
||||
/// <summary>The print job identifier this result belongs to.</summary>
|
||||
public Guid PrintJobId { get; set; }
|
||||
|
||||
/// <summary>Human-readable name of the print job.</summary>
|
||||
public string PrintName { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>The spool identifier that provided filament.</summary>
|
||||
public Guid SpoolId { get; set; }
|
||||
|
||||
/// <summary>Serial number of the spool.</summary>
|
||||
public string SpoolSerial { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>Total millimeters of filament extruded.</summary>
|
||||
public decimal MmExtruded { get; set; }
|
||||
|
||||
/// <summary>Derived grams consumed for this print.</summary>
|
||||
public decimal GramsDerived { get; set; }
|
||||
|
||||
/// <summary>The spool's purchase price. Null if not recorded.</summary>
|
||||
public decimal? PurchasePrice { get; set; }
|
||||
|
||||
/// <summary>The spool's total weight in grams when full.</summary>
|
||||
public decimal? WeightTotalGrams { get; set; }
|
||||
|
||||
/// <summary>Cost per gram of filament. Null if purchase price or total weight is missing.</summary>
|
||||
public decimal? CostPerGram { get; set; }
|
||||
|
||||
/// <summary>Calculated cost of this print job. Null if cost data is incomplete.</summary>
|
||||
public decimal? CostPerPrint { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Warnings about missing or incomplete data. Empty when all data is available
|
||||
/// and the calculation succeeded.
|
||||
/// </summary>
|
||||
public List<string> Warnings { get; set; } = new();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Request DTO for batch cost calculation by spool. Returns cost breakdowns
|
||||
/// for all print jobs associated with the specified spool.
|
||||
/// </summary>
|
||||
public class SpoolCostRequest
|
||||
{
|
||||
/// <summary>The unique identifier of the spool to calculate costs for.</summary>
|
||||
[Required(ErrorMessage = "SpoolId is required.")]
|
||||
public Guid SpoolId { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Response DTO for spool-level cost calculation. Contains cost breakdowns
|
||||
/// for all print jobs on the spool, plus a total cost summary.
|
||||
/// </summary>
|
||||
public class SpoolCostResponse
|
||||
{
|
||||
/// <summary>The spool identifier.</summary>
|
||||
public Guid SpoolId { get; set; }
|
||||
|
||||
/// <summary>Serial number of the spool.</summary>
|
||||
public string SpoolSerial { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>The spool's purchase price. Null if not recorded.</summary>
|
||||
public decimal? PurchasePrice { get; set; }
|
||||
|
||||
/// <summary>The spool's total weight in grams when full.</summary>
|
||||
public decimal? WeightTotalGrams { get; set; }
|
||||
|
||||
/// <summary>Cost per gram of filament. Null if cost data is incomplete.</summary>
|
||||
public decimal? CostPerGram { get; set; }
|
||||
|
||||
/// <summary>Total grams consumed across all print jobs on this spool.</summary>
|
||||
public decimal TotalGramsConsumed { get; set; }
|
||||
|
||||
/// <summary>Total calculated cost across all print jobs. Null if any job has missing data.</summary>
|
||||
public decimal? TotalCost { get; set; }
|
||||
|
||||
/// <summary>Number of print jobs included in this calculation.</summary>
|
||||
public int JobCount { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Individual cost breakdowns per print job. Jobs with missing data
|
||||
/// will have null cost fields and populated warnings.
|
||||
/// </summary>
|
||||
public List<CostPerPrintResponse> Jobs { get; set; } = new();
|
||||
|
||||
/// <summary>
|
||||
/// Aggregate warnings about missing data across all jobs.
|
||||
/// </summary>
|
||||
public List<string> Warnings { get; set; } = new();
|
||||
}
|
||||
Reference in New Issue
Block a user