mirror of
https://github.com/Sea-Haven-Industries/shoc-backend.git
synced 2026-09-30 13:03:12 +00:00
* refactor(api): enforce service and data-service boundaries * refactor(api): complete feature service boundaries * refactor(identity): enforce service and data boundaries * refactor(vendors): enforce service and data boundaries * refactor(workorders): enforce service and data boundaries * refactor(backend): enforce architecture and optimize dispatch * style(backend): format changed architecture files * fix(architecture): address backend review follow-ups * fix(backend): sanitize exception disclosure in changed API endpoints Replace raw exception-message disclosure (ex.Message) returned to API callers with a stable sanitized public message plus correlated structured internal logging, across the endpoints changed in this PR. - Add SanitizedErrors helper: logs the original exception at Error with a generated correlation id and returns a stable public message referencing it so support can trace without exposing internals. - Inject ILogger<T> into the 14 changed controllers and route every ex.Message/dbex.Message disclosure through the helper, preserving status codes, response shapes, and business data (e.g. OpenWorkOrders). - Leave FluentValidation (vex.Errors) and existing fixed-message catches untouched; out-of-scope controllers (Account/Contact/Employee/Asset/ PMSchedule) are unchanged. - Add focused tests proving internal exception text is not returned and that Error logging carrying the original exception is invoked. * fix(architecture): abstract job run state access * style: format board update service * test: use collection assertion idiom
85 lines
3.7 KiB
C#
85 lines
3.7 KiB
C#
using Data.SeaHavenIndustries;
|
|
using SeaHaven.DataServices.Models;
|
|
|
|
namespace SeaHaven.DataServices.Interfaces
|
|
{
|
|
public interface IWorkOrderDataService
|
|
{
|
|
// Query operations
|
|
Task<WorkOrder?> GetByIdAsync(int id);
|
|
Task<WorkOrder?> GetByIdWithDetailsAsync(int id);
|
|
Task<WorkOrder?> GetByInternalNumberAsync(string internalNumber);
|
|
Task<IEnumerable<WorkOrder>> GetAllAsync();
|
|
Task<IEnumerable<WorkOrder>> GetByLocationIdAsync(int locationId);
|
|
Task<IEnumerable<WorkOrder>> GetByAssigneeAsync(string assigneeId);
|
|
Task<IEnumerable<WorkOrder>> GetByStatusAsync(string status);
|
|
Task<IEnumerable<WorkOrder>> GetByPriorityAsync(string priority);
|
|
|
|
// Paged results
|
|
Task<(IEnumerable<WorkOrder> Items, int TotalCount)> GetPagedAsync(
|
|
int page,
|
|
int pageSize,
|
|
string? search = null,
|
|
string? status = null,
|
|
string? priority = null);
|
|
|
|
// Paged list with detailed information (for GetWorkOrderList endpoint)
|
|
Task<(IEnumerable<WorkOrderListItemReadModel> Items, int TotalCount)> GetWorkOrderListPagedAsync(
|
|
int page,
|
|
int pageSize,
|
|
string? search = null,
|
|
string? status = null,
|
|
string? assignee = null,
|
|
int? locationId = null,
|
|
string? sortBy = "lastUpdated",
|
|
string? sortDir = "desc");
|
|
|
|
// Command operations
|
|
Task<WorkOrder> AddAsync(WorkOrder workOrder);
|
|
Task UpdateAsync(WorkOrder workOrder);
|
|
Task DeleteAsync(int id);
|
|
|
|
// Related entities - Read
|
|
Task<IEnumerable<WorkOrderContacts>> GetWorkOrderContactsAsync(int workOrderId);
|
|
Task<IEnumerable<WorkOrderCategories>> GetWorkOrderCategoriesAsync(int workOrderId);
|
|
Task<IEnumerable<WorkOrderAttachments>> GetWorkOrderAttachmentsAsync(int workOrderId);
|
|
Task<IEnumerable<Comments>> GetWorkOrderCommentsAsync(int workOrderId);
|
|
Task<IEnumerable<WorkOrderAuditLog>> GetWorkOrderAuditLogsAsync(int workOrderId);
|
|
|
|
// Related entities - Write
|
|
Task AddWorkOrderContactsAsync(int workOrderId, IEnumerable<int> contactIds);
|
|
Task AddWorkOrderCategoriesAsync(int workOrderId, IEnumerable<int> categoryIds);
|
|
Task AddWorkOrderAttachmentAsync(WorkOrderAttachments attachment);
|
|
Task AddAuditLogAsync(WorkOrderAuditLog auditLog);
|
|
Task AddAuditLogsAsync(IReadOnlyCollection<WorkOrderAuditLog> auditLogs);
|
|
|
|
// Related entities - Delete
|
|
Task DeleteWorkOrderContactsAsync(int workOrderId);
|
|
Task DeleteWorkOrderCategoriesAsync(int workOrderId);
|
|
Task DeleteWorkOrderAttachmentsAsync(int workOrderId);
|
|
|
|
// Validation
|
|
Task<bool> ExistsAsync(int id);
|
|
Task<bool> InternalNumberExistsAsync(string internalNumber, int? excludeId = null);
|
|
|
|
// Internal number generation
|
|
Task<string> GenerateNextInternalWONumberAsync();
|
|
|
|
// Statistics
|
|
Task<int> CountAsync();
|
|
Task<int> CountByStatusAsync(string status);
|
|
Task<int> CountByPriorityAsync(string priority);
|
|
Task<int> CountByLocationAsync(int locationId);
|
|
Task<IEnumerable<WorkOrder>> GetAllWithDetailsAsync();
|
|
|
|
// Batched lookup: server-filters the distinct requested ids, excludes templates,
|
|
// eagerly loads the location detail, deduplicates, and returns results in input order.
|
|
Task<IReadOnlyList<WorkOrder>> GetByRequestedIdsWithDetailsAsync(
|
|
IReadOnlyCollection<int> ids,
|
|
CancellationToken cancellationToken);
|
|
|
|
// Complex read models
|
|
Task<WorkOrderDetailReadModel?> GetWorkOrderDetailAsync(int id);
|
|
Task<List<WorkOrder>> GetNonTemplateWorkOrdersWithLocationsAsync();
|
|
}
|
|
}
|