Files
ersatztv/ErsatzTV.Application/Scheduling/Commands/UpdateDecoHandler.cs
T
timothyandClaude Opus 4.8 216130b4d7 fix(#172): API hardening — null-name 500s, duplicate template items, unreachable 404
Clears the still-live findings from #172 (verified against main; #2/#4/#7 and the
auth/search/Trakt tail were already deliberate-documented or fixed since 2026-07-07).

- Null/empty Name → 500 (10 create/replace handlers). Block/Template/DecoTemplate/Deco
  Create+Replace/Update + UpdateFFmpegProfile did `request.Name.Length > 50` on a
  client-nullable string → unhandled NullReferenceException → HTTP 500 (no global
  exception filter). Now `string.IsNullOrWhiteSpace(request.Name) || .Length > 50` →
  422; also rejects empty/whitespace names, matching the group-create handlers'
  NotEmpty behavior. CreatePlaylist coalesces null→"" at the DTO so it was an
  empty-name persist, not a 500; guarded the same way.
- ReplaceTemplateItems overlap validation iterated with an `item == otherItem`
  record value-equality skip, so two exact-duplicate items were value-equal and
  bypassed the intersection check (both persisted). Now index-based (i != j) so
  duplicates register as a self-intersection and are rejected 422.
- Trimmed the unreachable 404 ProducesResponseType from POST /api/blocks/groups and
  POST /api/templates/groups (a create has no parent lookup that can 404); v1.json
  regenerated.
- Regression tests: all 10 name-guard paths + the duplicate-items path (19 cases).
- Docs: decisions.md entry + api-conventions.md §3b null-safe-validation bullet.

fixes #172

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-13 01:16:52 +02:00

329 lines
14 KiB
C#

using System.Threading.Channels;
using ErsatzTV.Application.Playouts;
using ErsatzTV.Core;
using ErsatzTV.Core.Domain;
using ErsatzTV.Core.Domain.Scheduling;
using ErsatzTV.Core.Scheduling;
using ErsatzTV.Infrastructure.Data;
using ErsatzTV.Infrastructure.Extensions;
using Microsoft.EntityFrameworkCore;
namespace ErsatzTV.Application.Scheduling;
public class UpdateDecoHandler(
IDbContextFactory<TvContext> dbContextFactory,
ChannelWriter<IBackgroundServiceRequest> channel)
: IRequestHandler<UpdateDeco, Either<BaseError, Unit>>
{
public async Task<Either<BaseError, Unit>> Handle(UpdateDeco request, CancellationToken cancellationToken)
{
await using TvContext dbContext = await dbContextFactory.CreateDbContextAsync(cancellationToken);
Validation<BaseError, Deco> validation = await Validate(dbContext, request, cancellationToken);
return await validation.Apply(ps => ApplyUpdateRequest(dbContext, ps, request, cancellationToken));
}
private async Task<Unit> ApplyUpdateRequest(
TvContext dbContext,
Deco existing,
UpdateDeco request,
CancellationToken cancellationToken)
{
existing.Name = request.Name;
// watermark
bool hasWatermark = request.WatermarkMode is (DecoMode.Override or DecoMode.Merge);
existing.WatermarkMode = request.WatermarkMode;
existing.UseWatermarkDuringFiller = hasWatermark && request.UseWatermarkDuringFiller;
if (hasWatermark)
{
// this is different than schedule item/playout item because we have to merge watermark ids
IEnumerable<int> toAdd =
request.WatermarkIds.Where(id => existing.DecoWatermarks.All(wm => wm.WatermarkId != id));
IEnumerable<DecoWatermark> toRemove =
existing.DecoWatermarks.Where(wm => !request.WatermarkIds.Contains(wm.WatermarkId));
existing.DecoWatermarks.RemoveAll(toRemove.Contains);
foreach (int watermarkId in toAdd)
{
existing.DecoWatermarks.Add(
new DecoWatermark
{
DecoId = existing.Id,
WatermarkId = watermarkId
});
}
}
else
{
existing.DecoWatermarks.Clear();
}
// graphics elements
bool hasGraphicsElements = request.GraphicsElementsMode is (DecoMode.Override or DecoMode.Merge);
existing.GraphicsElementsMode = request.GraphicsElementsMode;
existing.UseGraphicsElementsDuringFiller = hasGraphicsElements && request.UseGraphicsElementsDuringFiller;
if (hasGraphicsElements)
{
// this is different than schedule item/playout item because we have to merge graphics element ids
IEnumerable<int> toAdd =
request.GraphicsElementIds.Where(id => existing.DecoGraphicsElements.All(ge => ge.GraphicsElementId != id));
IEnumerable<DecoGraphicsElement> toRemove =
existing.DecoGraphicsElements.Where(ge => !request.GraphicsElementIds.Contains(ge.GraphicsElementId));
existing.DecoGraphicsElements.RemoveAll(toRemove.Contains);
foreach (int graphicsElementId in toAdd)
{
existing.DecoGraphicsElements.Add(
new DecoGraphicsElement
{
DecoId = existing.Id,
GraphicsElementId = graphicsElementId
});
}
}
else
{
existing.DecoGraphicsElements.Clear();
}
// break content
existing.BreakContentMode = request.BreakContentMode;
var breakContentToAdd =
request.BreakContent.Where(bc => existing.BreakContent.All(b => b.Id != bc.Id)).ToList();
IEnumerable<DecoBreakContent> breakContentToRemove =
existing.BreakContent.Where(bc => !request.BreakContent.Map(b => b.Id).Contains(bc.Id));
var breakContentToUpdate = request.BreakContent.Except(breakContentToAdd).ToList();
existing.BreakContent.RemoveAll(breakContentToRemove.Contains);
foreach (var toUpdate in breakContentToUpdate)
{
foreach (var ex in Optional(existing.BreakContent.FirstOrDefault(b => b.Id == toUpdate.Id)))
{
ex.CollectionType = toUpdate.CollectionType;
ex.CollectionId = toUpdate.CollectionId;
ex.MediaItemId = toUpdate.MediaItemId;
ex.MultiCollectionId = toUpdate.MultiCollectionId;
ex.SmartCollectionId = toUpdate.SmartCollectionId;
ex.PlaylistId = toUpdate.PlaylistId;
ex.Placement = toUpdate.Placement;
}
}
foreach (var add in breakContentToAdd)
{
existing.BreakContent.Add(new DecoBreakContent
{
DecoId = existing.Id,
CollectionType = add.CollectionType,
CollectionId = add.CollectionId,
MediaItemId = add.MediaItemId,
MultiCollectionId = add.MultiCollectionId,
SmartCollectionId = add.SmartCollectionId,
PlaylistId = add.PlaylistId,
Placement = add.Placement
});
}
// default filler
existing.DefaultFillerMode = request.DefaultFillerMode;
existing.DefaultFillerCollectionType = request.DefaultFillerCollectionType;
existing.DefaultFillerCollectionId = null;
existing.DefaultFillerMediaItemId = null;
existing.DefaultFillerMultiCollectionId = null;
existing.DefaultFillerSmartCollectionId = null;
if (request.DefaultFillerMode is DecoMode.Override)
{
switch (request.DefaultFillerCollectionType)
{
case CollectionType.Collection:
existing.DefaultFillerCollectionId = request.DefaultFillerCollectionId;
break;
case CollectionType.MultiCollection:
existing.DefaultFillerMultiCollectionId = request.DefaultFillerMultiCollectionId;
break;
case CollectionType.SmartCollection:
existing.DefaultFillerSmartCollectionId = request.DefaultFillerSmartCollectionId;
break;
default:
existing.DefaultFillerMediaItemId = request.DefaultFillerMediaItemId;
break;
}
}
existing.DefaultFillerTrimToFit = request.DefaultFillerTrimToFit;
// dead air fallback
existing.DeadAirFallbackMode = request.DeadAirFallbackMode;
existing.DeadAirFallbackCollectionType = request.DeadAirFallbackCollectionType;
existing.DeadAirFallbackCollectionId = null;
existing.DeadAirFallbackMediaItemId = null;
existing.DeadAirFallbackMultiCollectionId = null;
existing.DeadAirFallbackSmartCollectionId = null;
if (request.DeadAirFallbackMode is DecoMode.Override)
{
switch (request.DeadAirFallbackCollectionType)
{
case CollectionType.Collection:
existing.DeadAirFallbackCollectionId = request.DeadAirFallbackCollectionId;
break;
case CollectionType.MultiCollection:
existing.DeadAirFallbackMultiCollectionId = request.DeadAirFallbackMultiCollectionId;
break;
case CollectionType.SmartCollection:
existing.DeadAirFallbackSmartCollectionId = request.DeadAirFallbackSmartCollectionId;
break;
default:
existing.DeadAirFallbackMediaItemId = request.DeadAirFallbackMediaItemId;
break;
}
}
await dbContext.SaveChangesAsync(cancellationToken);
// Deco content (break/default filler/etc.) is only (re)applied during a Reset build, and BlockKey
// change-detection has no deco dimension, so editing a deco left already-built filler/break content
// stale until a manual Reset (#251). Enqueue a Reset for every playout that references this deco —
// directly (Playout.DecoId) or through a deco template that includes it. This whole post-commit
// invalidation runs with CancellationToken.None (audit #22 policy): once the edit is committed, a
// late request cancellation must not be able to abort either the affected-playout queries OR the
// enqueue and leave content stale — the entire side effect has to complete.
List<int> directPlayoutIds = await dbContext.Playouts
.Where(p => p.DecoId == request.DecoId)
.Select(p => p.Id)
.ToListAsync(CancellationToken.None);
List<int> decoTemplateIds = await dbContext.DecoTemplateItems
.Where(i => i.DecoId == request.DecoId)
.Select(i => i.DecoTemplateId)
.Distinct()
.ToListAsync(CancellationToken.None);
List<int> templatePlayoutIds = await dbContext.PlayoutTemplates
.Where(pt => pt.DecoTemplateId.HasValue && decoTemplateIds.Contains(pt.DecoTemplateId.Value))
.Select(pt => pt.PlayoutId)
.ToListAsync(CancellationToken.None);
foreach (int playoutId in directPlayoutIds.Concat(templatePlayoutIds).Distinct())
{
await channel.WriteAsync(new BuildPlayout(playoutId, PlayoutBuildMode.Reset), CancellationToken.None);
}
return Unit.Default;
}
private static async Task<Validation<BaseError, Deco>> Validate(
TvContext dbContext,
UpdateDeco request,
CancellationToken cancellationToken) =>
(await DecoMustExist(dbContext, request, cancellationToken), await ValidateDecoName(dbContext, request),
ValidateBreakContent(request))
.Apply((deco, _, _) => deco);
private static Task<Validation<BaseError, Deco>> DecoMustExist(
TvContext dbContext,
UpdateDeco request,
CancellationToken cancellationToken) =>
dbContext.Decos
.Include(d => d.BreakContent)
.Include(d => d.DecoWatermarks)
.Include(d => d.DecoGraphicsElements)
.SelectOneAsync(d => d.Id, d => d.Id == request.DecoId, cancellationToken)
.Map(o => o.ToValidation<BaseError>("Deco does not exist"));
private static async Task<Validation<BaseError, string>> ValidateDecoName(
TvContext dbContext,
UpdateDeco request)
{
if (string.IsNullOrWhiteSpace(request.Name) || request.Name.Length > 50)
{
return BaseError.New($"Deco name \"{request.Name}\" is invalid");
}
bool duplicateName = await dbContext.Decos
.AnyAsync(d => d.Id != request.DecoId && d.DecoGroupId == request.DecoGroupId && d.Name == request.Name);
return duplicateName
? BaseError.New($"A deco named \"{request.Name}\" already exists in that deco group")
: Success<BaseError, string>(request.Name);
}
private static Validation<BaseError, Unit> ValidateBreakContent(UpdateDeco request)
{
int startCount = request.BreakContent.Count(bc => bc.Placement is DecoBreakPlacement.BlockStart);
if (startCount > 1)
{
return BaseError.New("Deco may only contain one [Block Start] break content");
}
int betweenCount = request.BreakContent.Count(bc => bc.Placement is DecoBreakPlacement.BetweenBlockItems);
if (betweenCount > 1)
{
return BaseError.New("Deco may only contain one [Between Block Items] break content");
}
int chapterCount = request.BreakContent.Count(bc => bc.Placement is DecoBreakPlacement.ChapterMarkers);
if (chapterCount > 1)
{
return BaseError.New("Deco may only contain one [At Chapter Markers] break content");
}
int finishCount = request.BreakContent.Count(bc => bc.Placement is DecoBreakPlacement.BlockFinish);
if (finishCount > 1)
{
return BaseError.New("Deco may only contain one [Block Finish] break content");
}
foreach (var breakContent in request.BreakContent)
{
switch (breakContent.CollectionType)
{
case CollectionType.Collection:
if (breakContent.CollectionId is null)
{
return BaseError.New("Break content must have valid collection");
}
break;
case CollectionType.MultiCollection:
if (breakContent.MultiCollectionId is null)
{
return BaseError.New("Break content must have valid multi collection");
}
break;
case CollectionType.SmartCollection:
if (breakContent.SmartCollectionId is null)
{
return BaseError.New("Break content must have valid smart collection");
}
break;
case CollectionType.TelevisionShow:
case CollectionType.TelevisionSeason:
case CollectionType.Artist:
if (breakContent.MediaItemId is null)
{
return BaseError.New("Break content must have valid media item");
}
break;
case CollectionType.Playlist:
if (breakContent.PlaylistId is null)
{
return BaseError.New("Break content must have valid playlist");
}
break;
}
}
return Unit.Default;
}
}