NotS1mp/Musify
0
0
Fork 0
Code Issues 23 Pull Requests Actions Packages Projects Releases Wiki Activity

Split TrackApplicationResponse into a Local/External hierarchy

Browse Source 
Same treatment as AlbumApplicationResponse, but Track is the cleaner
case: OwnerUserId (local-only) and ExternalId (external-only) are
both genuinely exclusive to one side, so the base carries neither and
is abstract — every real value is one of the two derived types.

    TrackApplicationResponse (abstract, shared fields + FromEntity dispatch)
      LocalTrackApplicationResponse    (+ OwnerUserId)
      ExternalTrackApplicationResponse (+ ExternalId)

Hit a real gotcha along the way: the response already had an explicit
Source property, which collides with the "source" discriminator STJ's
polymorphism support injects ("contains property 'source' that
conflicts with an existing metadata property name" — only surfaced at
runtime in the Api integration tests, not at build time). Fixed by
dropping the now-redundant explicit Source field entirely; the
discriminator already serializes the identical "Local"/"YouTube"
value under the same name, so the wire contract is unchanged. Updated
the two call sites that read .Source directly (TrackSearchItemResponse
and a playlist track filter that needed flatMap instead of
filter().map() to keep the narrowing across the chain).
This commit is contained in:
Admin
2026-09-10 19:19:59 +02:00
parent 7ae6c0a7a2
commit 10766bbb47
9 changed files with 144 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
backend/Core/Musify.Application/Tracks/Responses/ExternalTrackApplicationResponse.cs
+30
View File
@@ -0,0 +1,30 @@
using Musify.Domain.Entities;
using Musify.Domain.ValueObjects;
namespace Musify.Application.Tracks.Responses
{
public record ExternalTrackApplicationResponse(
Guid Id,
string Title,
string? Artist,
ProcessingStatus AudioStatus,
double Duration,
int ListensCount,
DateTime CreatedAt,
DateTime UpdatedAt,
string ExternalId)
: TrackApplicationResponse(Id, Title, Artist, AudioStatus, Duration, ListensCount, CreatedAt, UpdatedAt)
{
public static ExternalTrackApplicationResponse FromEntity(ExternalTrack track, int listensCount) =>
new(
track.Id,
track.Title,
FormatArtist(track),
track.Audio.TranscodeStatus,
track.DurationSeconds,
listensCount,
track.CreatedAt,
track.UpdatedAt,
track.ExternalId);
}
}
backend/Core/Musify.Application/Tracks/Responses/LocalTrackApplicationResponse.cs
+30
View File
@@ -0,0 +1,30 @@
using Musify.Domain.Entities;
using Musify.Domain.ValueObjects;
namespace Musify.Application.Tracks.Responses
{
public record LocalTrackApplicationResponse(
Guid Id,
string Title,
string? Artist,
ProcessingStatus AudioStatus,
double Duration,
int ListensCount,
DateTime CreatedAt,
DateTime UpdatedAt,
long OwnerUserId)
: TrackApplicationResponse(Id, Title, Artist, AudioStatus, Duration, ListensCount, CreatedAt, UpdatedAt)
{
public static LocalTrackApplicationResponse FromEntity(LocalTrack track, int listensCount) =>
new(
track.Id,
track.Title,
FormatArtist(track),
track.Audio.TranscodeStatus,
track.DurationSeconds,
listensCount,
track.CreatedAt,
track.UpdatedAt,
track.OwnerUserId);
}
}
backend/Core/Musify.Application/Tracks/Responses/TrackApplicationResponse.cs
+23 -17
View File
@@ -1,36 +1,42 @@
using System.Text.Json.Serialization;
using Musify.Domain.Entities;
using Musify.Domain.ValueObjects;
namespace Musify.Application.Tracks.Responses
{
public record TrackApplicationResponse(
// See AlbumApplicationResponse for why [JsonPolymorphic]/[JsonDerivedType] are required
// (not optional) whenever a base type carries subtype-only data across the wire. Track is a
// cleaner case than Album: both OwnerUserId (local-only) and ExternalId (external-only) are
// genuinely exclusive to one side, so the base has no "meaningless sentinel" field at all —
// every real value is one of the two derived types, hence base is abstract.
//
// No explicit Source property here (unlike the domain entities): STJ's polymorphism support
// already injects a "source" discriminator property with the same "Local"/"YouTube" values a
// hand-written TrackSource field would have, and a real property with that exact name would
// collide with it ("contains property 'source' that conflicts with an existing metadata
// property name"). Use the discriminator (or a type check) instead of a Source field.
[JsonPolymorphic(TypeDiscriminatorPropertyName = "source")]
[JsonDerivedType(typeof(LocalTrackApplicationResponse), typeDiscriminator: "Local")]
[JsonDerivedType(typeof(ExternalTrackApplicationResponse), typeDiscriminator: "YouTube")]
public abstract record TrackApplicationResponse(
Guid Id,
string Title,
string? Artist,
TrackSource Source,
string? ExternalId,
ProcessingStatus AudioStatus,
double Duration,
int ListensCount,
long? OwnerUserId,
DateTime CreatedAt,
DateTime UpdatedAt)
{
public static TrackApplicationResponse FromEntity(Track track, int listensCount) =>
new(
track.Id,
track.Title,
FormatArtist(track),
track is ExternalTrack external ? external.Source : TrackSource.Local,
(track as ExternalTrack)?.ExternalId,
track.Audio.TranscodeStatus,
track.DurationSeconds,
listensCount,
(track as LocalTrack)?.OwnerUserId,
track.CreatedAt,
track.UpdatedAt);
track switch
{
LocalTrack local => LocalTrackApplicationResponse.FromEntity(local, listensCount),
ExternalTrack external => ExternalTrackApplicationResponse.FromEntity(external, listensCount),
_ => throw new NotSupportedException($"Unsupported track entity type '{track.GetType().Name}'.")
};
private static string? FormatArtist(Track track) => track switch
protected static string? FormatArtist(Track track) => track switch
{
LocalTrack local => local.Owner.Name,
ExternalTrack { TrackArtists.Count: > 0 } external =>
backend/Core/Musify.Application/Tracks/Responses/TrackSearchItemResponse.cs
+1 -1
View File
@@ -14,7 +14,7 @@ namespace Musify.Application.Tracks.Responses
YouTubeSongResult? YouTubeSong)
{
public static TrackSearchItemResponse FromTrack(TrackApplicationResponse track) =>
new(track.Source, track, null);
new(track is ExternalTrackApplicationResponse ? TrackSource.YouTube : TrackSource.Local, track, null);
public static TrackSearchItemResponse FromYouTubeSong(YouTubeSongResult song) =>
new(TrackSource.YouTube, null, song);
backend/Tests/Musify.Application.Tests/Shared/TrackApplicationResponseTests.cs
+2 -4
View File
@@ -1,7 +1,6 @@
using Musify.Application.Tests.TestSupport;
using Musify.Application.Tracks.Responses;
using Musify.Domain.Entities;
using Musify.Domain.ValueObjects;
using Xunit;
namespace Musify.Application.Tests.Shared
@@ -14,10 +13,9 @@ namespace Musify.Application.Tests.Shared
var owner = TestEntities.User(1, "The Owner");
var track = TestEntities.LocalTrack(owner);
var response = TrackApplicationResponse.FromEntity(track, listensCount: 3);
var response = Assert.IsType<LocalTrackApplicationResponse>(TrackApplicationResponse.FromEntity(track, listensCount: 3));
Assert.Equal("The Owner", response.Artist);
Assert.Equal(TrackSource.Local, response.Source);
Assert.Equal(owner.Id, response.OwnerUserId);
Assert.Equal(3, response.ListensCount);
}
@@ -34,7 +32,7 @@ namespace Musify.Application.Tests.Shared
new TrackArtist { TrackId = track.Id, ArtistId = first.Id, Position = 0, Artist = first, Track = track }
];
var response = TrackApplicationResponse.FromEntity(track, listensCount: 0);
var response = Assert.IsType<ExternalTrackApplicationResponse>(TrackApplicationResponse.FromEntity(track, listensCount: 0));
Assert.Equal("First Artist, Second Artist", response.Artist);
Assert.Equal(track.ExternalId, response.ExternalId);
backend/Tests/Musify.Application.Tests/Tracks/CreateTrackCommandHandlerTests.cs
+3 -1
View File
@@ -3,6 +3,7 @@ using Musify.Application.Contracts;
using Musify.Application.Services;
using Musify.Application.Tests.TestSupport;
using Musify.Application.Tracks;
using Musify.Application.Tracks.Responses;
using Musify.Domain.ValueObjects;
using NSubstitute;
using Xunit;
@@ -47,7 +48,8 @@ namespace Musify.Application.Tests.Tracks
Assert.False(result.IsError);
Assert.Equal("My Song", result.Value.Title);
Assert.Equal(user.Id, result.Value.OwnerUserId);
var localResponse = Assert.IsType<LocalTrackApplicationResponse>(result.Value);
Assert.Equal(user.Id, localResponse.OwnerUserId);
await eventBus.Received(1).PublishAsync(Arg.Any<Musify.Application.Events.CreateTrackResourcesEvent>(), Arg.Any<CancellationToken>());
var stored = await Database.LocalTracks.FindAsync([result.Value.Id], TestContext.Current.CancellationToken);
backend/Tests/Musify.Application.Tests/Tracks/GetTrackByIdQueryHandlerTests.cs
+3 -1
View File
@@ -1,6 +1,7 @@
using ErrorOr;
using Musify.Application.Tests.TestSupport;
using Musify.Application.Tracks;
using Musify.Application.Tracks.Responses;
using Xunit;
namespace Musify.Application.Tests.Tracks
@@ -21,7 +22,8 @@ namespace Musify.Application.Tests.Tracks
Assert.False(result.IsError);
Assert.Equal("My Song", result.Value.Title);
Assert.Equal(owner.Name, result.Value.Artist);
Assert.Equal(owner.Id, result.Value.OwnerUserId);
var localResponse = Assert.IsType<LocalTrackApplicationResponse>(result.Value);
Assert.Equal(owner.Id, localResponse.OwnerUserId);
}
[Fact]
web-player/src/lib/api/schema.d.ts
Vendored
+51 -7
View File
@@ -549,7 +549,34 @@ export interface components {
source: null | components["schemas"]["TrackSource"];
externalId: null | string;
};
AlbumApplicationResponse: {
AlbumApplicationResponse: components["schemas"]["AlbumApplicationResponseAlbumApplicationResponse"] | components["schemas"]["AlbumApplicationResponseExternalAlbumApplicationResponse"];
AlbumApplicationResponseAlbumApplicationResponse: {
/** @enum {string} */
source?: "Local";
/** Format: uuid */
id: string;
title: string;
description: null | string;
/** Format: int32 */
releaseYear: null | number | string;
/** Format: int64 */
ownerUserId: number | string;
/** Format: int32 */
trackCount: number | string;
smallImageKeyName: null | string;
mediumImageKeyName: null | string;
largeImageKeyName: null | string;
/** Format: date-time */
createdAt: string;
/** Format: date-time */
updatedAt: string;
coverTrackIds: string[];
};
AlbumApplicationResponseExternalAlbumApplicationResponse: {
/** @enum {string} */
source?: "YouTube";
externalId: string;
thumbnailUrl: null | string;
/** Format: uuid */
id: string;
title: string;
@@ -568,8 +595,6 @@ export interface components {
/** Format: date-time */
updatedAt: string;
coverTrackIds: string[];
youTubeAlbumId?: null | string;
thumbnailUrl?: null | string;
};
AlbumPictureUploadResponse: {
/** Format: uuid */
@@ -766,20 +791,39 @@ export interface components {
/** Format: int64 */
expectedAudioSizeBytes?: null | number | string;
};
TrackApplicationResponse: {
TrackApplicationResponse: components["schemas"]["TrackApplicationResponseLocalTrackApplicationResponse"] | components["schemas"]["TrackApplicationResponseExternalTrackApplicationResponse"];
TrackApplicationResponseExternalTrackApplicationResponse: {
/** @enum {string} */
source?: "YouTube";
externalId: string;
/** Format: uuid */
id: string;
title: string;
artist: null | string;
source: components["schemas"]["TrackSource"];
externalId: null | string;
audioStatus: components["schemas"]["ProcessingStatus"];
/** Format: double */
duration: number | string;
/** Format: int32 */
listensCount: number | string;
/** Format: date-time */
createdAt: string;
/** Format: date-time */
updatedAt: string;
};
TrackApplicationResponseLocalTrackApplicationResponse: {
/** @enum {string} */
source?: "Local";
/** Format: int64 */
ownerUserId: null | number | string;
ownerUserId: number | string;
/** Format: uuid */
id: string;
title: string;
artist: null | string;
audioStatus: components["schemas"]["ProcessingStatus"];
/** Format: double */
duration: number | string;
/** Format: int32 */
listensCount: number | string;
/** Format: date-time */
createdAt: string;
/** Format: date-time */
web-player/src/routes/(app)/playlists/[id]/+page.server.ts
+1 -1
View File
@@ -40,7 +40,7 @@ export const load: PageServerLoad = async ({ params, locals, url, fetch }) => {
const library = (libraryRes.data?.items ?? []).filter((t) => !inPlaylist.has(t.id));
const alreadyLinked = new Set(
tracks.filter((t) => t.source === 'YouTube' && t.externalId).map((t) => t.externalId)
tracks.flatMap((t) => (t.source === 'YouTube' && t.externalId ? [t.externalId] : []))
);
const seeds = [...new Set(tracks.map((t) => t.artist).filter((a): a is string => !!a))];
const seed = seeds.length > 0 ? shuffle(seeds)[0] : undefined;