Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e744e5d713 | ||
|
|
3e96e5fd87 | ||
|
|
bd5742f924 | ||
|
|
69d059b8a5 |
@@ -0,0 +1,24 @@
|
|||||||
|
# Spooty Operations Snapshot
|
||||||
|
|
||||||
|
`GET /api/operations/snapshot` exposes backend-owned operational truth for Workspace and other clients.
|
||||||
|
|
||||||
|
The MVP reports truth Spooty already owns without a schema migration:
|
||||||
|
|
||||||
|
- track state from `TrackEntity.status`
|
||||||
|
- selected YouTube URL from `TrackEntity.youtubeUrl`
|
||||||
|
- selected YouTube candidate title, author, score, and reason from `TrackEntity`
|
||||||
|
- raw failure evidence from `TrackEntity.error`
|
||||||
|
- download retry count from `TrackEntity.downloadAttemptCount`
|
||||||
|
- rejected YouTube candidate explanations from `TrackEntity.rejectedYoutubeCandidatesJson`
|
||||||
|
- legacy rejected YouTube candidate URLs from `TrackEntity.rejectedYoutubeUrls`
|
||||||
|
- playlist and single-song counts from `PlaylistEntity.isTrack`
|
||||||
|
- queue depth and active jobs from BullMQ queues `track-search-processor` and `track-download-processor`
|
||||||
|
- Spotify connection presence from the stored Spotify user token
|
||||||
|
|
||||||
|
The endpoint intentionally does not infer candidate scoring history. Selected candidate metadata is persisted when Spooty chooses a candidate. Rejected candidate metadata is persisted when a selected candidate is rejected by manual retry or download failure. Older rows and URL-only cases fall back to rejected candidate objects containing only `url`.
|
||||||
|
|
||||||
|
Future persistence work is required for:
|
||||||
|
|
||||||
|
- full searched candidate history
|
||||||
|
- structured error class fields stored at write time instead of classified from the persisted raw error string
|
||||||
|
- operation attempt history across search and download phases
|
||||||
@@ -15,6 +15,7 @@ import { APP_GUARD } from '@nestjs/core';
|
|||||||
import { AuthGuard } from './shared/auth.guard';
|
import { AuthGuard } from './shared/auth.guard';
|
||||||
import { ThrottlerGuard, ThrottlerModule } from '@nestjs/throttler';
|
import { ThrottlerGuard, ThrottlerModule } from '@nestjs/throttler';
|
||||||
import { ArchiveModule } from './archive/archive.module';
|
import { ArchiveModule } from './archive/archive.module';
|
||||||
|
import { OperationsModule } from './operations/operations.module';
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
imports: [
|
imports: [
|
||||||
@@ -49,7 +50,7 @@ import { ArchiveModule } from './archive/archive.module';
|
|||||||
ThrottlerModule.forRoot([
|
ThrottlerModule.forRoot([
|
||||||
{
|
{
|
||||||
ttl: 60000,
|
ttl: 60000,
|
||||||
limit: 60,
|
limit: Number(process.env.API_THROTTLE_LIMIT || 600),
|
||||||
},
|
},
|
||||||
]),
|
]),
|
||||||
BullModule.forRootAsync({
|
BullModule.forRootAsync({
|
||||||
@@ -81,6 +82,7 @@ import { ArchiveModule } from './archive/archive.module';
|
|||||||
TrackModule,
|
TrackModule,
|
||||||
PlaylistModule,
|
PlaylistModule,
|
||||||
ArchiveModule,
|
ArchiveModule,
|
||||||
|
OperationsModule,
|
||||||
],
|
],
|
||||||
controllers: [AppController],
|
controllers: [AppController],
|
||||||
providers: [
|
providers: [
|
||||||
|
|||||||
@@ -0,0 +1,13 @@
|
|||||||
|
import { Controller, Get } from '@nestjs/common';
|
||||||
|
import { OperationsService } from './operations.service';
|
||||||
|
import { OperationsSnapshot } from './operations.types';
|
||||||
|
|
||||||
|
@Controller('operations')
|
||||||
|
export class OperationsController {
|
||||||
|
constructor(private readonly operationsService: OperationsService) {}
|
||||||
|
|
||||||
|
@Get('snapshot')
|
||||||
|
getSnapshot(): Promise<OperationsSnapshot> {
|
||||||
|
return this.operationsService.getSnapshot();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
import { Module } from '@nestjs/common';
|
||||||
|
import { BullModule } from '@nestjs/bullmq';
|
||||||
|
import { TypeOrmModule } from '@nestjs/typeorm';
|
||||||
|
import { PlaylistEntity } from '../playlist/playlist.entity';
|
||||||
|
import { SharedModule } from '../shared/shared.module';
|
||||||
|
import { TrackEntity } from '../track/track.entity';
|
||||||
|
import { OperationsController } from './operations.controller';
|
||||||
|
import { OperationsService } from './operations.service';
|
||||||
|
|
||||||
|
@Module({
|
||||||
|
imports: [
|
||||||
|
TypeOrmModule.forFeature([PlaylistEntity, TrackEntity]),
|
||||||
|
BullModule.registerQueue(
|
||||||
|
{ name: 'track-search-processor' },
|
||||||
|
{ name: 'track-download-processor' },
|
||||||
|
),
|
||||||
|
SharedModule,
|
||||||
|
],
|
||||||
|
controllers: [OperationsController],
|
||||||
|
providers: [OperationsService],
|
||||||
|
})
|
||||||
|
export class OperationsModule {}
|
||||||
@@ -0,0 +1,404 @@
|
|||||||
|
import { Injectable } from '@nestjs/common';
|
||||||
|
import { InjectQueue } from '@nestjs/bullmq';
|
||||||
|
import { InjectRepository } from '@nestjs/typeorm';
|
||||||
|
import { Job, Queue } from 'bullmq';
|
||||||
|
import { In, MoreThan, Repository } from 'typeorm';
|
||||||
|
import { PlaylistEntity } from '../playlist/playlist.entity';
|
||||||
|
import { SpotifyApiService } from '../shared/spotify-api.service';
|
||||||
|
import { TrackEntity, TrackStatusEnum } from '../track/track.entity';
|
||||||
|
import {
|
||||||
|
ErrorClass,
|
||||||
|
FailureTruth,
|
||||||
|
OperationsSnapshot,
|
||||||
|
RejectedCandidateTruth,
|
||||||
|
SpootyOperation,
|
||||||
|
TrackTruth,
|
||||||
|
} from './operations.types';
|
||||||
|
|
||||||
|
interface ClassifiedError {
|
||||||
|
errorClass: ErrorClass;
|
||||||
|
errorSummary: string;
|
||||||
|
errorDetail: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Injectable()
|
||||||
|
export class OperationsService {
|
||||||
|
constructor(
|
||||||
|
@InjectRepository(TrackEntity)
|
||||||
|
private readonly trackRepository: Repository<TrackEntity>,
|
||||||
|
@InjectRepository(PlaylistEntity)
|
||||||
|
private readonly playlistRepository: Repository<PlaylistEntity>,
|
||||||
|
@InjectQueue('track-download-processor')
|
||||||
|
private readonly trackDownloadQueue: Queue,
|
||||||
|
@InjectQueue('track-search-processor')
|
||||||
|
private readonly trackSearchQueue: Queue,
|
||||||
|
private readonly spotifyApiService: SpotifyApiService,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
async getSnapshot(): Promise<OperationsSnapshot> {
|
||||||
|
const [
|
||||||
|
spotifyConnected,
|
||||||
|
searchQueueCounts,
|
||||||
|
downloadQueueCounts,
|
||||||
|
activeSearchJobs,
|
||||||
|
activeDownloadJobs,
|
||||||
|
playlists,
|
||||||
|
singleSongs,
|
||||||
|
tracks,
|
||||||
|
active,
|
||||||
|
completed,
|
||||||
|
failed,
|
||||||
|
retries,
|
||||||
|
searchingTracks,
|
||||||
|
downloadingTracks,
|
||||||
|
recentFailures,
|
||||||
|
recentTracks,
|
||||||
|
] = await Promise.all([
|
||||||
|
this.spotifyApiService.hasUserToken(),
|
||||||
|
this.trackSearchQueue.getJobCounts('waiting', 'delayed', 'active'),
|
||||||
|
this.trackDownloadQueue.getJobCounts('waiting', 'delayed', 'active'),
|
||||||
|
this.trackSearchQueue.getJobs('active', 0, 100, true),
|
||||||
|
this.trackDownloadQueue.getJobs('active', 0, 100, true),
|
||||||
|
this.playlistRepository.countBy({ isTrack: false }),
|
||||||
|
this.playlistRepository.countBy({ isTrack: true }),
|
||||||
|
this.trackRepository.count(),
|
||||||
|
this.trackRepository.countBy({
|
||||||
|
status: In([
|
||||||
|
TrackStatusEnum.Searching,
|
||||||
|
TrackStatusEnum.Queued,
|
||||||
|
TrackStatusEnum.Downloading,
|
||||||
|
]),
|
||||||
|
}),
|
||||||
|
this.trackRepository.countBy({ status: TrackStatusEnum.Completed }),
|
||||||
|
this.trackRepository.countBy({ status: TrackStatusEnum.Error }),
|
||||||
|
this.trackRepository.countBy({ downloadAttemptCount: MoreThan(0) }),
|
||||||
|
this.trackRepository.find({
|
||||||
|
where: { status: TrackStatusEnum.Searching },
|
||||||
|
order: { createdAt: 'DESC' },
|
||||||
|
take: 100,
|
||||||
|
}),
|
||||||
|
this.trackRepository.find({
|
||||||
|
where: { status: TrackStatusEnum.Downloading },
|
||||||
|
order: { createdAt: 'DESC' },
|
||||||
|
take: 100,
|
||||||
|
}),
|
||||||
|
this.trackRepository.find({
|
||||||
|
where: { status: TrackStatusEnum.Error },
|
||||||
|
order: { createdAt: 'DESC' },
|
||||||
|
take: 20,
|
||||||
|
}),
|
||||||
|
this.trackRepository.find({
|
||||||
|
order: { createdAt: 'DESC' },
|
||||||
|
take: 20,
|
||||||
|
}),
|
||||||
|
]);
|
||||||
|
|
||||||
|
const activeSearchTracks = await this.mergeTracksFromActiveJobs(
|
||||||
|
searchingTracks,
|
||||||
|
activeSearchJobs,
|
||||||
|
);
|
||||||
|
const activeDownloadTracks = await this.mergeTracksFromActiveJobs(
|
||||||
|
downloadingTracks,
|
||||||
|
activeDownloadJobs,
|
||||||
|
);
|
||||||
|
|
||||||
|
const searchQueueDepth =
|
||||||
|
(searchQueueCounts.waiting || 0) + (searchQueueCounts.delayed || 0);
|
||||||
|
const downloadQueueDepth =
|
||||||
|
(downloadQueueCounts.waiting || 0) + (downloadQueueCounts.delayed || 0);
|
||||||
|
const activeSearches = activeSearchJobs.length;
|
||||||
|
const activeDownloads = activeDownloadJobs.length;
|
||||||
|
|
||||||
|
return {
|
||||||
|
generatedAt: new Date().toISOString(),
|
||||||
|
runtime: {
|
||||||
|
operation: this.getOperation({
|
||||||
|
activeSearches,
|
||||||
|
activeDownloads,
|
||||||
|
searchQueueDepth,
|
||||||
|
downloadQueueDepth,
|
||||||
|
failed,
|
||||||
|
retries,
|
||||||
|
}),
|
||||||
|
spotifyConnected,
|
||||||
|
searchQueueDepth,
|
||||||
|
downloadQueueDepth,
|
||||||
|
activeSearches,
|
||||||
|
activeDownloads,
|
||||||
|
},
|
||||||
|
counters: {
|
||||||
|
playlists,
|
||||||
|
singleSongs,
|
||||||
|
tracks,
|
||||||
|
active,
|
||||||
|
completed,
|
||||||
|
failed,
|
||||||
|
retries,
|
||||||
|
},
|
||||||
|
active: {
|
||||||
|
searching: activeSearchTracks.map((track) => this.toTrackTruth(track)),
|
||||||
|
downloading: activeDownloadTracks.map((track) =>
|
||||||
|
this.toTrackTruth(track),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
recentFailures: recentFailures.map((track) => this.toTrackTruth(track)),
|
||||||
|
recentTracks: recentTracks.map((track) => this.toTrackTruth(track)),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private async mergeTracksFromActiveJobs(
|
||||||
|
tracks: TrackEntity[],
|
||||||
|
jobs: Job[],
|
||||||
|
): Promise<TrackEntity[]> {
|
||||||
|
const knownIds = new Set(tracks.map((track) => track.id).filter(Boolean));
|
||||||
|
const missingIds = jobs
|
||||||
|
.map((job) => Number(job.data?.id))
|
||||||
|
.filter((id) => Number.isInteger(id) && !knownIds.has(id));
|
||||||
|
|
||||||
|
if (!missingIds.length) {
|
||||||
|
return tracks;
|
||||||
|
}
|
||||||
|
|
||||||
|
const activeJobTracks = await this.trackRepository.find({
|
||||||
|
where: { id: In(missingIds) },
|
||||||
|
});
|
||||||
|
|
||||||
|
return [...tracks, ...activeJobTracks];
|
||||||
|
}
|
||||||
|
|
||||||
|
private toTrackTruth(track: TrackEntity): TrackTruth | FailureTruth {
|
||||||
|
const rejectedCandidates = this.parseRejectedCandidates(track);
|
||||||
|
const error = this.classifyError(track.error);
|
||||||
|
|
||||||
|
return {
|
||||||
|
id: track.id,
|
||||||
|
artist: track.artist,
|
||||||
|
name: track.name,
|
||||||
|
status: TrackStatusEnum[track.status] || String(track.status),
|
||||||
|
...(track.spotifyUrl ? { spotifyUrl: track.spotifyUrl } : {}),
|
||||||
|
...(track.youtubeUrl ? { youtubeUrl: track.youtubeUrl } : {}),
|
||||||
|
...(track.youtubeUrl
|
||||||
|
? {
|
||||||
|
selectedCandidate: {
|
||||||
|
url: track.youtubeUrl,
|
||||||
|
...(track.selectedYoutubeTitle
|
||||||
|
? { title: track.selectedYoutubeTitle }
|
||||||
|
: {}),
|
||||||
|
...(track.selectedYoutubeAuthor
|
||||||
|
? { author: track.selectedYoutubeAuthor }
|
||||||
|
: {}),
|
||||||
|
...(typeof track.selectedYoutubeScore === 'number'
|
||||||
|
? { score: track.selectedYoutubeScore }
|
||||||
|
: {}),
|
||||||
|
...(track.selectedYoutubeReason
|
||||||
|
? { reason: track.selectedYoutubeReason }
|
||||||
|
: {}),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
: {}),
|
||||||
|
...(typeof track.downloadAttemptCount === 'number'
|
||||||
|
? { downloadAttemptCount: track.downloadAttemptCount }
|
||||||
|
: {}),
|
||||||
|
...(error || {}),
|
||||||
|
rejectedCandidateCount: rejectedCandidates.length,
|
||||||
|
rejectedCandidates,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private parseRejectedCandidates(
|
||||||
|
track: TrackEntity,
|
||||||
|
): RejectedCandidateTruth[] {
|
||||||
|
const structured = this.parseRejectedCandidateJson(track);
|
||||||
|
|
||||||
|
if (structured.length) {
|
||||||
|
return structured;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!track.rejectedYoutubeUrls) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(track.rejectedYoutubeUrls);
|
||||||
|
return Array.isArray(parsed)
|
||||||
|
? parsed
|
||||||
|
.filter((item) => typeof item === 'string')
|
||||||
|
.map((url) => ({ url }))
|
||||||
|
: [];
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private parseRejectedCandidateJson(
|
||||||
|
track: TrackEntity,
|
||||||
|
): RejectedCandidateTruth[] {
|
||||||
|
if (!track.rejectedYoutubeCandidatesJson) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(track.rejectedYoutubeCandidatesJson);
|
||||||
|
return Array.isArray(parsed)
|
||||||
|
? parsed
|
||||||
|
.filter(
|
||||||
|
(item) =>
|
||||||
|
!!item &&
|
||||||
|
typeof item === 'object' &&
|
||||||
|
typeof item.url === 'string',
|
||||||
|
)
|
||||||
|
.map((item) => ({
|
||||||
|
url: item.url,
|
||||||
|
...(typeof item.title === 'string' ? { title: item.title } : {}),
|
||||||
|
...(typeof item.author === 'string'
|
||||||
|
? { author: item.author }
|
||||||
|
: {}),
|
||||||
|
...(typeof item.score === 'number' ? { score: item.score } : {}),
|
||||||
|
...(typeof item.reason === 'string'
|
||||||
|
? { reason: item.reason }
|
||||||
|
: {}),
|
||||||
|
...(typeof item.rejectionClass === 'string'
|
||||||
|
? { rejectionClass: item.rejectionClass }
|
||||||
|
: {}),
|
||||||
|
...(typeof item.rejectionSummary === 'string'
|
||||||
|
? { rejectionSummary: item.rejectionSummary }
|
||||||
|
: {}),
|
||||||
|
...(typeof item.rejectedAt === 'string'
|
||||||
|
? { rejectedAt: item.rejectedAt }
|
||||||
|
: {}),
|
||||||
|
}))
|
||||||
|
: [];
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private classifyError(error?: string): ClassifiedError | undefined {
|
||||||
|
if (!error) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
const detail = this.trimDetail(error);
|
||||||
|
const normalized = error.toLowerCase();
|
||||||
|
|
||||||
|
if (normalized.includes('no acceptable youtube result found')) {
|
||||||
|
return this.error(
|
||||||
|
'NO_ACCEPTABLE_CANDIDATE',
|
||||||
|
'No acceptable YouTube candidate',
|
||||||
|
detail,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (normalized.includes('sign in to confirm your age')) {
|
||||||
|
return this.error(
|
||||||
|
'YOUTUBE_AGE_GATED',
|
||||||
|
'YouTube video is age-gated',
|
||||||
|
detail,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (normalized.includes('private video')) {
|
||||||
|
return this.error(
|
||||||
|
'YOUTUBE_PRIVATE_VIDEO',
|
||||||
|
'YouTube video is private',
|
||||||
|
detail,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
normalized.includes('only images are available') ||
|
||||||
|
normalized.includes('requested format is not available') ||
|
||||||
|
normalized.includes('no downloadable audio/video formats')
|
||||||
|
) {
|
||||||
|
return this.error(
|
||||||
|
'YOUTUBE_NO_FORMATS',
|
||||||
|
'No downloadable YouTube audio format',
|
||||||
|
detail,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
normalized.includes('video unavailable') ||
|
||||||
|
normalized.includes('this video is not available') ||
|
||||||
|
normalized.includes('selected video unavailable')
|
||||||
|
) {
|
||||||
|
return this.error(
|
||||||
|
'YOUTUBE_VIDEO_UNAVAILABLE',
|
||||||
|
'YouTube video is unavailable',
|
||||||
|
detail,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (normalized.includes('unable to download webpage')) {
|
||||||
|
return this.error(
|
||||||
|
'YOUTUBE_WEBPAGE_UNAVAILABLE',
|
||||||
|
'YouTube webpage is unavailable',
|
||||||
|
detail,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
normalized.includes('failed to parse yt-dlp search output') ||
|
||||||
|
normalized.includes('yt-dlp exited with code') ||
|
||||||
|
normalized.includes('failed to start yt-dlp') ||
|
||||||
|
normalized.includes('yt-dlp exceeded maximum runtime')
|
||||||
|
) {
|
||||||
|
return this.error(
|
||||||
|
'YOUTUBE_EXTRACTION_FAILURE',
|
||||||
|
'YouTube extraction failed',
|
||||||
|
detail,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
normalized.includes('eacces') ||
|
||||||
|
normalized.includes('enoent') ||
|
||||||
|
normalized.includes('failed to write') ||
|
||||||
|
normalized.includes('permission denied')
|
||||||
|
) {
|
||||||
|
return this.error('FILE_WRITE_FAILED', 'File write failed', detail);
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.error(
|
||||||
|
'UNKNOWN_DOWNLOAD_ERROR',
|
||||||
|
'Unknown download error',
|
||||||
|
detail,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
private error(
|
||||||
|
errorClass: ErrorClass,
|
||||||
|
errorSummary: string,
|
||||||
|
errorDetail: string,
|
||||||
|
): ClassifiedError {
|
||||||
|
return { errorClass, errorSummary, errorDetail };
|
||||||
|
}
|
||||||
|
|
||||||
|
private trimDetail(error: string): string {
|
||||||
|
const trimmed = error.trim();
|
||||||
|
return trimmed.length > 1200 ? `${trimmed.slice(0, 1197)}...` : trimmed;
|
||||||
|
}
|
||||||
|
|
||||||
|
private getOperation(input: {
|
||||||
|
activeSearches: number;
|
||||||
|
activeDownloads: number;
|
||||||
|
searchQueueDepth: number;
|
||||||
|
downloadQueueDepth: number;
|
||||||
|
failed: number;
|
||||||
|
retries: number;
|
||||||
|
}): SpootyOperation {
|
||||||
|
if (input.activeDownloads > 0 || input.downloadQueueDepth > 0) {
|
||||||
|
return input.retries > 0 ? 'retrying' : 'downloading';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (input.activeSearches > 0 || input.searchQueueDepth > 0) {
|
||||||
|
return input.retries > 0 ? 'retrying' : 'searching';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (input.failed > 0) {
|
||||||
|
return 'degraded';
|
||||||
|
}
|
||||||
|
|
||||||
|
return 'idle';
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,89 @@
|
|||||||
|
export type SpootyOperation =
|
||||||
|
| 'idle'
|
||||||
|
| 'searching'
|
||||||
|
| 'downloading'
|
||||||
|
| 'retrying'
|
||||||
|
| 'degraded';
|
||||||
|
|
||||||
|
export type ErrorClass =
|
||||||
|
| 'YOUTUBE_VIDEO_UNAVAILABLE'
|
||||||
|
| 'YOUTUBE_AGE_GATED'
|
||||||
|
| 'YOUTUBE_NO_FORMATS'
|
||||||
|
| 'YOUTUBE_PRIVATE_VIDEO'
|
||||||
|
| 'YOUTUBE_WEBPAGE_UNAVAILABLE'
|
||||||
|
| 'YOUTUBE_EXTRACTION_FAILURE'
|
||||||
|
| 'NO_ACCEPTABLE_CANDIDATE'
|
||||||
|
| 'FILE_WRITE_FAILED'
|
||||||
|
| 'UNKNOWN_DOWNLOAD_ERROR';
|
||||||
|
|
||||||
|
export type RejectionClass =
|
||||||
|
| 'DOWNLOAD_FAILED'
|
||||||
|
| 'YOUTUBE_VIDEO_UNAVAILABLE'
|
||||||
|
| 'YOUTUBE_AGE_GATED'
|
||||||
|
| 'YOUTUBE_NO_FORMATS'
|
||||||
|
| 'YOUTUBE_PRIVATE_VIDEO'
|
||||||
|
| 'YOUTUBE_EXTRACTION_FAILURE'
|
||||||
|
| 'UNKNOWN_DOWNLOAD_ERROR'
|
||||||
|
| 'MANUAL_RETRY';
|
||||||
|
|
||||||
|
export interface RejectedCandidateTruth {
|
||||||
|
url: string;
|
||||||
|
title?: string;
|
||||||
|
author?: string;
|
||||||
|
score?: number;
|
||||||
|
reason?: string;
|
||||||
|
rejectionClass?: RejectionClass;
|
||||||
|
rejectionSummary?: string;
|
||||||
|
rejectedAt?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface TrackTruth {
|
||||||
|
id: number;
|
||||||
|
artist: string;
|
||||||
|
name: string;
|
||||||
|
status: string;
|
||||||
|
spotifyUrl?: string;
|
||||||
|
youtubeUrl?: string;
|
||||||
|
selectedCandidate?: {
|
||||||
|
url: string;
|
||||||
|
title?: string;
|
||||||
|
author?: string;
|
||||||
|
score?: number;
|
||||||
|
reason?: string;
|
||||||
|
};
|
||||||
|
downloadAttemptCount?: number;
|
||||||
|
errorClass?: ErrorClass;
|
||||||
|
errorSummary?: string;
|
||||||
|
errorDetail?: string;
|
||||||
|
rejectedCandidateCount: number;
|
||||||
|
rejectedCandidates: RejectedCandidateTruth[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FailureTruth extends TrackTruth {}
|
||||||
|
|
||||||
|
export interface OperationsSnapshot {
|
||||||
|
generatedAt: string;
|
||||||
|
runtime: {
|
||||||
|
operation: SpootyOperation;
|
||||||
|
spotifyConnected: boolean;
|
||||||
|
searchQueueDepth: number;
|
||||||
|
downloadQueueDepth: number;
|
||||||
|
activeSearches: number;
|
||||||
|
activeDownloads: number;
|
||||||
|
};
|
||||||
|
counters: {
|
||||||
|
playlists: number;
|
||||||
|
singleSongs: number;
|
||||||
|
tracks: number;
|
||||||
|
active: number;
|
||||||
|
completed: number;
|
||||||
|
failed: number;
|
||||||
|
retries: number;
|
||||||
|
};
|
||||||
|
active: {
|
||||||
|
searching: TrackTruth[];
|
||||||
|
downloading: TrackTruth[];
|
||||||
|
};
|
||||||
|
recentFailures: FailureTruth[];
|
||||||
|
recentTracks: TrackTruth[];
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
import { IsString, MaxLength } from 'class-validator';
|
||||||
|
|
||||||
|
export class SearchTrackDto {
|
||||||
|
@IsString()
|
||||||
|
@MaxLength(512)
|
||||||
|
artist: string;
|
||||||
|
|
||||||
|
@IsString()
|
||||||
|
@MaxLength(512)
|
||||||
|
title: string;
|
||||||
|
}
|
||||||
@@ -12,6 +12,7 @@ import { PlaylistService } from './playlist.service';
|
|||||||
import { PlaylistEntity } from './playlist.entity';
|
import { PlaylistEntity } from './playlist.entity';
|
||||||
import { CreatePlaylistDto } from './dto/create-playlist.dto';
|
import { CreatePlaylistDto } from './dto/create-playlist.dto';
|
||||||
import { UpdatePlaylistDto } from './dto/update-playlist.dto';
|
import { UpdatePlaylistDto } from './dto/update-playlist.dto';
|
||||||
|
import { SearchTrackDto } from './dto/search-track.dto';
|
||||||
|
|
||||||
@Controller('playlist')
|
@Controller('playlist')
|
||||||
export class PlaylistController {
|
export class PlaylistController {
|
||||||
@@ -27,6 +28,13 @@ export class PlaylistController {
|
|||||||
await this.service.create(playlist as PlaylistEntity);
|
await this.service.create(playlist as PlaylistEntity);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Post('search-track')
|
||||||
|
async searchTrack(
|
||||||
|
@Body() body: SearchTrackDto,
|
||||||
|
): Promise<{ spotifyUrl: string; name: string; artist: string }> {
|
||||||
|
return this.service.createFromSearch(body.artist, body.title);
|
||||||
|
}
|
||||||
|
|
||||||
@Put(':id')
|
@Put(':id')
|
||||||
update(
|
update(
|
||||||
@Param('id', ParseIntPipe) id: number,
|
@Param('id', ParseIntPipe) id: number,
|
||||||
|
|||||||
@@ -48,6 +48,27 @@ export class PlaylistService {
|
|||||||
this.io.emit(WsPlaylistOperation.Delete, { id });
|
this.io.emit(WsPlaylistOperation.Delete, { id });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async createFromSearch(
|
||||||
|
artist: string,
|
||||||
|
title: string,
|
||||||
|
): Promise<{ spotifyUrl: string; name: string; artist: string }> {
|
||||||
|
const track = await this.spotifyService.searchTrack(artist, title);
|
||||||
|
|
||||||
|
await this.create({
|
||||||
|
spotifyUrl: track.spotifyUrl,
|
||||||
|
name: track.name,
|
||||||
|
active: false,
|
||||||
|
isTrack: true,
|
||||||
|
} as PlaylistEntity);
|
||||||
|
|
||||||
|
return {
|
||||||
|
spotifyUrl: track.spotifyUrl,
|
||||||
|
name: track.name,
|
||||||
|
artist: track.artist,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
async create(playlist: PlaylistEntity): Promise<void> {
|
async create(playlist: PlaylistEntity): Promise<void> {
|
||||||
// Detect if URL is for a single track or a playlist and route accordingly
|
// Detect if URL is for a single track or a playlist and route accordingly
|
||||||
const isTrack = this.spotifyService.isTrackUrl(playlist.spotifyUrl);
|
const isTrack = this.spotifyService.isTrackUrl(playlist.spotifyUrl);
|
||||||
@@ -63,7 +84,7 @@ export class PlaylistService {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private async createSingleTrack(playlist: PlaylistEntity): Promise<void> {
|
private async createSingleTrack(playlist: PlaylistEntity): Promise<void> {
|
||||||
let trackDetail: { name: string; artist: string; image: string };
|
let trackDetail: { name: string; artist: string; image: string; durationMs?: number };
|
||||||
let playlist2Save: PlaylistEntity;
|
let playlist2Save: PlaylistEntity;
|
||||||
try {
|
try {
|
||||||
trackDetail = await this.spotifyService.getTrackDetail(
|
trackDetail = await this.spotifyService.getTrackDetail(
|
||||||
@@ -97,6 +118,7 @@ export class PlaylistService {
|
|||||||
name: trackDetail.name,
|
name: trackDetail.name,
|
||||||
spotifyUrl: playlist.spotifyUrl,
|
spotifyUrl: playlist.spotifyUrl,
|
||||||
coverUrl: trackDetail.image,
|
coverUrl: trackDetail.image,
|
||||||
|
durationMs: trackDetail.durationMs,
|
||||||
},
|
},
|
||||||
savedPlaylist,
|
savedPlaylist,
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -12,27 +12,57 @@ export class SpotifyAuthController {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@Get('login')
|
@Get('login')
|
||||||
login(@Res() res: Response): void {
|
login(
|
||||||
res.redirect(this.spotifyApiService.getAuthorizationUrl());
|
@Query('returnTo') returnTo: string | undefined,
|
||||||
|
@Res() res: Response,
|
||||||
|
): void {
|
||||||
|
const state =
|
||||||
|
returnTo && /^https?:\/\/localhost:\d+\/?$/.test(returnTo)
|
||||||
|
? Buffer.from(JSON.stringify({ returnTo }), 'utf8').toString('base64url')
|
||||||
|
: undefined;
|
||||||
|
|
||||||
|
res.redirect(this.spotifyApiService.getAuthorizationUrl(state));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Get('callback')
|
@Get('callback')
|
||||||
async callback(
|
async callback(
|
||||||
@Query('code') code: string | undefined,
|
@Query('code') code: string | undefined,
|
||||||
@Query('error') error: string | undefined,
|
@Query('error') error: string | undefined,
|
||||||
|
@Query('state') state: string | undefined,
|
||||||
@Res() res: Response,
|
@Res() res: Response,
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
|
const returnTo = this.parseReturnTo(state);
|
||||||
|
|
||||||
if (error) {
|
if (error) {
|
||||||
res.redirect(`/?spotify_error=${encodeURIComponent(error)}`);
|
res.redirect(`${returnTo}?spotify_error=${encodeURIComponent(error)}`);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!code) {
|
if (!code) {
|
||||||
res.redirect('/?spotify_error=missing_code');
|
res.redirect(`${returnTo}?spotify_error=missing_code`);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
await this.spotifyApiService.exchangeAuthorizationCode(code);
|
await this.spotifyApiService.exchangeAuthorizationCode(code);
|
||||||
res.redirect('/?spotify=connected');
|
res.redirect(`${returnTo}?spotify=connected`);
|
||||||
|
}
|
||||||
|
|
||||||
|
private parseReturnTo(state: string | undefined): string {
|
||||||
|
if (!state) {
|
||||||
|
return '/';
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(Buffer.from(state, 'base64url').toString('utf8'));
|
||||||
|
const returnTo = parsed?.returnTo;
|
||||||
|
|
||||||
|
if (typeof returnTo === 'string' && /^https?:\/\/localhost:\d+\/?$/.test(returnTo)) {
|
||||||
|
return returnTo;
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
return '/';
|
||||||
|
}
|
||||||
|
|
||||||
|
return '/';
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -151,7 +151,7 @@ export class SpotifyApiService {
|
|||||||
return !!this.readUserToken();
|
return !!this.readUserToken();
|
||||||
}
|
}
|
||||||
|
|
||||||
getAuthorizationUrl(): string {
|
getAuthorizationUrl(state?: string): string {
|
||||||
const url = new URL('https://accounts.spotify.com/authorize');
|
const url = new URL('https://accounts.spotify.com/authorize');
|
||||||
|
|
||||||
url.searchParams.set('response_type', 'code');
|
url.searchParams.set('response_type', 'code');
|
||||||
@@ -167,6 +167,10 @@ export class SpotifyApiService {
|
|||||||
url.searchParams.set('redirect_uri', this.getRedirectUri());
|
url.searchParams.set('redirect_uri', this.getRedirectUri());
|
||||||
url.searchParams.set('show_dialog', 'true');
|
url.searchParams.set('show_dialog', 'true');
|
||||||
|
|
||||||
|
if (state) {
|
||||||
|
url.searchParams.set('state', state);
|
||||||
|
}
|
||||||
|
|
||||||
return url.toString();
|
return url.toString();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -336,6 +340,85 @@ export class SpotifyApiService {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async searchTrack(
|
||||||
|
artist: string,
|
||||||
|
title: string,
|
||||||
|
): Promise<{ spotifyUrl: string; name: string; artist: string; image: string; durationMs?: number }> {
|
||||||
|
const accessToken = await this.getClientCredentialsAccessToken();
|
||||||
|
const plainQuery = `${artist} ${title}`.trim();
|
||||||
|
const structuredQuery = `track:"${title}" artist:"${artist}"`;
|
||||||
|
|
||||||
|
const url = new URL('https://api.spotify.com/v1/search');
|
||||||
|
url.searchParams.set('q', structuredQuery || plainQuery);
|
||||||
|
url.searchParams.set('type', 'track');
|
||||||
|
url.searchParams.set('limit', '10');
|
||||||
|
|
||||||
|
const response = await fetch(url.toString(), {
|
||||||
|
headers: { Authorization: `Bearer ${accessToken}` },
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!response.ok) {
|
||||||
|
const errorText = await response.text();
|
||||||
|
throw new Error(`Spotify track search failed: ${response.status} ${errorText}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const data = await response.json();
|
||||||
|
const tracks = data?.tracks?.items || [];
|
||||||
|
|
||||||
|
if (!tracks.length) {
|
||||||
|
throw new Error(`No Spotify track found for ${artist} - ${title}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const normalize = (value: string) =>
|
||||||
|
(value || '')
|
||||||
|
.toLowerCase()
|
||||||
|
.normalize('NFD')
|
||||||
|
.replace(/[\u0300-\u036f]/g, '')
|
||||||
|
.replace(/[^a-z0-9]+/g, ' ')
|
||||||
|
.replace(/\s+/g, ' ')
|
||||||
|
.trim();
|
||||||
|
|
||||||
|
const wantedArtist = normalize(artist);
|
||||||
|
const wantedTitle = normalize(title);
|
||||||
|
|
||||||
|
const scoreTrack = (track: any): number => {
|
||||||
|
const trackName = normalize(track.name);
|
||||||
|
const artistNames = (track.artists || []).map((item: any) => normalize(item.name));
|
||||||
|
const allArtists = artistNames.join(' ');
|
||||||
|
|
||||||
|
let score = 0;
|
||||||
|
if (trackName === wantedTitle) score += 70;
|
||||||
|
else if (trackName.includes(wantedTitle) || wantedTitle.includes(trackName)) score += 40;
|
||||||
|
|
||||||
|
if (artistNames.some((name: string) => name === wantedArtist)) score += 50;
|
||||||
|
else if (allArtists.includes(wantedArtist) || wantedArtist.includes(allArtists)) score += 25;
|
||||||
|
|
||||||
|
if (track.explicit !== undefined) score += 1;
|
||||||
|
if (track.popularity) score += Math.min(20, Math.floor(track.popularity / 5));
|
||||||
|
|
||||||
|
return score;
|
||||||
|
};
|
||||||
|
|
||||||
|
const ranked = [...tracks]
|
||||||
|
.map((track: any) => ({ track, score: scoreTrack(track) }))
|
||||||
|
.sort((a, b) => b.score - a.score);
|
||||||
|
|
||||||
|
const best = ranked[0]?.track || tracks[0];
|
||||||
|
|
||||||
|
this.logger.debug(
|
||||||
|
`Spotify search "${plainQuery}" selected "${best?.artists?.map((item: any) => item.name).join(', ')} - ${best?.name}" score=${ranked[0]?.score ?? 0}`,
|
||||||
|
);
|
||||||
|
|
||||||
|
return {
|
||||||
|
spotifyUrl: best.external_urls.spotify,
|
||||||
|
name: best.name,
|
||||||
|
artist: (best.artists || []).map((item: any) => item.name).join(', '),
|
||||||
|
image: best.album?.images?.[0]?.url || '',
|
||||||
|
durationMs: best.duration_ms,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
async getAllPlaylistTracks(spotifyUrl: string): Promise<any[]> {
|
async getAllPlaylistTracks(spotifyUrl: string): Promise<any[]> {
|
||||||
try {
|
try {
|
||||||
this.logger.debug(`Getting all tracks for playlist ${spotifyUrl}`);
|
this.logger.debug(`Getting all tracks for playlist ${spotifyUrl}`);
|
||||||
|
|||||||
@@ -72,6 +72,14 @@ export class SpotifyService {
|
|||||||
return this.spotifyApiService.getArtistLibrary(spotifyUrl);
|
return this.spotifyApiService.getArtistLibrary(spotifyUrl);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async searchTrack(
|
||||||
|
artist: string,
|
||||||
|
title: string,
|
||||||
|
): Promise<{ spotifyUrl: string; name: string; artist: string; image: string; durationMs?: number }> {
|
||||||
|
return this.spotifyApiService.searchTrack(artist, title);
|
||||||
|
}
|
||||||
|
|
||||||
async getPlaylistTracks(spotifyUrl: string): Promise<any[]> {
|
async getPlaylistTracks(spotifyUrl: string): Promise<any[]> {
|
||||||
this.logger.debug(`Get playlist ${spotifyUrl} on Spotify`);
|
this.logger.debug(`Get playlist ${spotifyUrl} on Spotify`);
|
||||||
try {
|
try {
|
||||||
|
|||||||
@@ -38,6 +38,19 @@ const BAD_MATCH_TERMS = [
|
|||||||
'reaction',
|
'reaction',
|
||||||
'tutorial',
|
'tutorial',
|
||||||
'instrumental',
|
'instrumental',
|
||||||
|
'reaction',
|
||||||
|
'review',
|
||||||
|
'analysis',
|
||||||
|
'breakdown',
|
||||||
|
'explained',
|
||||||
|
'secret message',
|
||||||
|
'meaning',
|
||||||
|
'interview',
|
||||||
|
'podcast',
|
||||||
|
'news',
|
||||||
|
'documentary',
|
||||||
|
'fifa world cup',
|
||||||
|
'song style',
|
||||||
];
|
];
|
||||||
|
|
||||||
const OFFICIALISH_TERMS = [
|
const OFFICIALISH_TERMS = [
|
||||||
@@ -123,11 +136,12 @@ export class YoutubeService {
|
|||||||
.join(' | '),
|
.join(' | '),
|
||||||
);
|
);
|
||||||
|
|
||||||
const accepted = candidates.find((candidate) => !candidate.rejected);
|
const minimumScore = Number(process.env.YT_MIN_CANDIDATE_SCORE || 60);
|
||||||
|
const accepted = candidates.find((candidate) => !candidate.rejected && candidate.score >= minimumScore);
|
||||||
|
|
||||||
if (!accepted) {
|
if (!accepted) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`No acceptable YouTube result found for: ${query}` +
|
`No acceptable YouTube result found for: ${query} with minimum score ${minimumScore}` +
|
||||||
(excludedUrls.length ? ` after excluding ${excludedUrls.length} failed candidate(s)` : ''),
|
(excludedUrls.length ? ` after excluding ${excludedUrls.length} failed candidate(s)` : ''),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -143,11 +157,12 @@ export class YoutubeService {
|
|||||||
const searchTarget = `ytsearch15:${query}`;
|
const searchTarget = `ytsearch15:${query}`;
|
||||||
const args = [
|
const args = [
|
||||||
'--dump-single-json',
|
'--dump-single-json',
|
||||||
'--flat-playlist',
|
|
||||||
'--skip-download',
|
'--skip-download',
|
||||||
'--no-playlist',
|
'--no-playlist',
|
||||||
'--no-cache-dir',
|
'--no-cache-dir',
|
||||||
'--no-cookies-from-browser',
|
'--no-cookies-from-browser',
|
||||||
|
'--extractor-args',
|
||||||
|
'youtube:player_client=android_vr',
|
||||||
'--add-header',
|
'--add-header',
|
||||||
`User-Agent:${HEADERS['User-Agent']}`,
|
`User-Agent:${HEADERS['User-Agent']}`,
|
||||||
searchTarget,
|
searchTarget,
|
||||||
@@ -198,6 +213,7 @@ export class YoutubeService {
|
|||||||
const author = String(video.author?.name || video.author || '');
|
const author = String(video.author?.name || video.author || '');
|
||||||
const url = String(video.url || '');
|
const url = String(video.url || '');
|
||||||
const seconds = this.getVideoSeconds(video);
|
const seconds = this.getVideoSeconds(video);
|
||||||
|
this.logger.debug(`YT candidate raw duration title="${title}" duration=${video.duration} seconds=${video.seconds} parsed=${seconds}`);
|
||||||
|
|
||||||
const normalizedTitle = this.normalize(title);
|
const normalizedTitle = this.normalize(title);
|
||||||
const normalizedAuthor = this.normalize(author);
|
const normalizedAuthor = this.normalize(author);
|
||||||
@@ -213,14 +229,21 @@ export class YoutubeService {
|
|||||||
reasons.push('title=45');
|
reasons.push('title=45');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let hasArtistSignal = false;
|
||||||
for (const artistPart of this.artistParts(normalizedArtist)) {
|
for (const artistPart of this.artistParts(normalizedArtist)) {
|
||||||
if (artistPart.length >= 3 && (normalizedTitle.includes(artistPart) || normalizedAuthor.includes(artistPart))) {
|
if (artistPart.length >= 3 && (normalizedTitle.includes(artistPart) || normalizedAuthor.includes(artistPart))) {
|
||||||
score += 20;
|
score += 20;
|
||||||
reasons.push(`artist=${artistPart}:20`);
|
reasons.push(`artist=${artistPart}:20`);
|
||||||
|
hasArtistSignal = true;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (!hasArtistSignal) {
|
||||||
|
score -= 35;
|
||||||
|
reasons.push('artist=missing:-35');
|
||||||
|
}
|
||||||
|
|
||||||
const officialish = OFFICIALISH_TERMS.find((term) =>
|
const officialish = OFFICIALISH_TERMS.find((term) =>
|
||||||
`${normalizedTitle} ${normalizedAuthor}`.includes(this.normalize(term)),
|
`${normalizedTitle} ${normalizedAuthor}`.includes(this.normalize(term)),
|
||||||
);
|
);
|
||||||
@@ -233,8 +256,9 @@ export class YoutubeService {
|
|||||||
normalizedTitle.includes(this.normalize(term)),
|
normalizedTitle.includes(this.normalize(term)),
|
||||||
);
|
);
|
||||||
if (badTerm) {
|
if (badTerm) {
|
||||||
score -= 25;
|
score -= 80;
|
||||||
reasons.push(`bad=${badTerm}:-25`);
|
rejected = true;
|
||||||
|
reasons.push(`bad=${badTerm}:-80 reject`);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (durationMs && seconds) {
|
if (durationMs && seconds) {
|
||||||
@@ -380,8 +404,8 @@ export class YoutubeService {
|
|||||||
return 'YouTube unavailable: private video';
|
return 'YouTube unavailable: private video';
|
||||||
}
|
}
|
||||||
|
|
||||||
if (text.includes('Video unavailable')) {
|
if (text.includes('Video unavailable') || text.includes('This video is not available')) {
|
||||||
return 'YouTube unavailable';
|
return 'YouTube unavailable: selected video unavailable';
|
||||||
}
|
}
|
||||||
|
|
||||||
if (text.includes('Unable to download webpage')) {
|
if (text.includes('Unable to download webpage')) {
|
||||||
@@ -495,6 +519,8 @@ export class YoutubeService {
|
|||||||
'--no-playlist',
|
'--no-playlist',
|
||||||
'--no-cache-dir',
|
'--no-cache-dir',
|
||||||
'--no-cookies-from-browser',
|
'--no-cookies-from-browser',
|
||||||
|
'-f',
|
||||||
|
'bestaudio/best',
|
||||||
'--extract-audio',
|
'--extract-audio',
|
||||||
'--audio-format',
|
'--audio-format',
|
||||||
format,
|
format,
|
||||||
|
|||||||
@@ -27,9 +27,24 @@ export class TrackEntity {
|
|||||||
@Column({ nullable: true })
|
@Column({ nullable: true })
|
||||||
youtubeUrl?: string;
|
youtubeUrl?: string;
|
||||||
|
|
||||||
|
@Column({ nullable: true })
|
||||||
|
selectedYoutubeTitle?: string;
|
||||||
|
|
||||||
|
@Column({ nullable: true })
|
||||||
|
selectedYoutubeAuthor?: string;
|
||||||
|
|
||||||
|
@Column({ nullable: true })
|
||||||
|
selectedYoutubeScore?: number;
|
||||||
|
|
||||||
|
@Column({ nullable: true, type: 'text' })
|
||||||
|
selectedYoutubeReason?: string;
|
||||||
|
|
||||||
@Column({ nullable: true, type: 'text' })
|
@Column({ nullable: true, type: 'text' })
|
||||||
rejectedYoutubeUrls?: string;
|
rejectedYoutubeUrls?: string;
|
||||||
|
|
||||||
|
@Column({ nullable: true, type: 'text' })
|
||||||
|
rejectedYoutubeCandidatesJson?: string;
|
||||||
|
|
||||||
@Column({ default: 0 })
|
@Column({ default: 0 })
|
||||||
downloadAttemptCount?: number;
|
downloadAttemptCount?: number;
|
||||||
|
|
||||||
|
|||||||
@@ -24,6 +24,32 @@ type ClientTrack = Omit<Partial<TrackEntity>, 'rejectedYoutubeUrls'> & {
|
|||||||
rejectedYoutubeUrls?: string[];
|
rejectedYoutubeUrls?: string[];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
type RejectionClass =
|
||||||
|
| 'DOWNLOAD_FAILED'
|
||||||
|
| 'YOUTUBE_VIDEO_UNAVAILABLE'
|
||||||
|
| 'YOUTUBE_AGE_GATED'
|
||||||
|
| 'YOUTUBE_NO_FORMATS'
|
||||||
|
| 'YOUTUBE_PRIVATE_VIDEO'
|
||||||
|
| 'YOUTUBE_EXTRACTION_FAILURE'
|
||||||
|
| 'UNKNOWN_DOWNLOAD_ERROR'
|
||||||
|
| 'MANUAL_RETRY';
|
||||||
|
|
||||||
|
interface RejectedYoutubeCandidate {
|
||||||
|
url: string;
|
||||||
|
title?: string;
|
||||||
|
author?: string;
|
||||||
|
score?: number;
|
||||||
|
reason?: string;
|
||||||
|
rejectionClass?: RejectionClass;
|
||||||
|
rejectionSummary?: string;
|
||||||
|
rejectedAt: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface RejectionReason {
|
||||||
|
rejectionClass: RejectionClass;
|
||||||
|
rejectionSummary: string;
|
||||||
|
}
|
||||||
|
|
||||||
@WebSocketGateway()
|
@WebSocketGateway()
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class TrackService {
|
export class TrackService {
|
||||||
@@ -98,7 +124,9 @@ export class TrackService {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
const parsed = JSON.parse(track.rejectedYoutubeUrls);
|
const parsed = JSON.parse(track.rejectedYoutubeUrls);
|
||||||
return Array.isArray(parsed) ? parsed.filter((item) => typeof item === 'string') : [];
|
return Array.isArray(parsed)
|
||||||
|
? parsed.filter((item) => typeof item === 'string')
|
||||||
|
: [];
|
||||||
} catch {
|
} catch {
|
||||||
return [];
|
return [];
|
||||||
}
|
}
|
||||||
@@ -108,6 +136,161 @@ export class TrackService {
|
|||||||
return JSON.stringify([...new Set(urls)].slice(0, 20));
|
return JSON.stringify([...new Set(urls)].slice(0, 20));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private parseRejectedYoutubeCandidates(
|
||||||
|
track: TrackEntity,
|
||||||
|
): RejectedYoutubeCandidate[] {
|
||||||
|
if (!track.rejectedYoutubeCandidatesJson) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(track.rejectedYoutubeCandidatesJson);
|
||||||
|
return Array.isArray(parsed)
|
||||||
|
? parsed.filter(
|
||||||
|
(item): item is RejectedYoutubeCandidate =>
|
||||||
|
!!item &&
|
||||||
|
typeof item === 'object' &&
|
||||||
|
typeof item.url === 'string' &&
|
||||||
|
typeof item.rejectedAt === 'string',
|
||||||
|
)
|
||||||
|
: [];
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private stringifyRejectedYoutubeCandidates(
|
||||||
|
candidates: RejectedYoutubeCandidate[],
|
||||||
|
): string {
|
||||||
|
const byUrl = new Map<string, RejectedYoutubeCandidate>();
|
||||||
|
|
||||||
|
for (const candidate of candidates) {
|
||||||
|
if (candidate.url) {
|
||||||
|
byUrl.set(candidate.url, candidate);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return JSON.stringify([...byUrl.values()].slice(-20));
|
||||||
|
}
|
||||||
|
|
||||||
|
private buildRejectedYoutubeCandidate(
|
||||||
|
track: TrackEntity,
|
||||||
|
reason: RejectionReason,
|
||||||
|
): RejectedYoutubeCandidate | null {
|
||||||
|
if (!track.youtubeUrl) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
url: track.youtubeUrl,
|
||||||
|
...(track.selectedYoutubeTitle
|
||||||
|
? { title: track.selectedYoutubeTitle }
|
||||||
|
: {}),
|
||||||
|
...(track.selectedYoutubeAuthor
|
||||||
|
? { author: track.selectedYoutubeAuthor }
|
||||||
|
: {}),
|
||||||
|
...(typeof track.selectedYoutubeScore === 'number'
|
||||||
|
? { score: track.selectedYoutubeScore }
|
||||||
|
: {}),
|
||||||
|
...(track.selectedYoutubeReason
|
||||||
|
? { reason: track.selectedYoutubeReason }
|
||||||
|
: {}),
|
||||||
|
...reason,
|
||||||
|
rejectedAt: new Date().toISOString(),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private rejectCurrentYoutubeCandidate(
|
||||||
|
track: TrackEntity,
|
||||||
|
reason: RejectionReason,
|
||||||
|
): {
|
||||||
|
rejectedYoutubeUrls: string;
|
||||||
|
rejectedYoutubeCandidatesJson: string;
|
||||||
|
} {
|
||||||
|
const rejectedUrls = this.parseRejectedYoutubeUrls(track);
|
||||||
|
const rejectedCandidates = this.parseRejectedYoutubeCandidates(track);
|
||||||
|
const rejectedCandidate = this.buildRejectedYoutubeCandidate(track, reason);
|
||||||
|
|
||||||
|
if (rejectedCandidate) {
|
||||||
|
if (!rejectedUrls.includes(rejectedCandidate.url)) {
|
||||||
|
rejectedUrls.push(rejectedCandidate.url);
|
||||||
|
}
|
||||||
|
|
||||||
|
rejectedCandidates.push(rejectedCandidate);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
rejectedYoutubeUrls: this.stringifyRejectedYoutubeUrls(rejectedUrls),
|
||||||
|
rejectedYoutubeCandidatesJson:
|
||||||
|
this.stringifyRejectedYoutubeCandidates(rejectedCandidates),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private classifyRejection(error?: string): RejectionReason {
|
||||||
|
if (!error) {
|
||||||
|
return {
|
||||||
|
rejectionClass: 'UNKNOWN_DOWNLOAD_ERROR',
|
||||||
|
rejectionSummary: 'Unknown download error',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const normalized = error.toLowerCase();
|
||||||
|
|
||||||
|
if (normalized.includes('sign in to confirm your age')) {
|
||||||
|
return {
|
||||||
|
rejectionClass: 'YOUTUBE_AGE_GATED',
|
||||||
|
rejectionSummary: 'YouTube video is age-gated',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (normalized.includes('private video')) {
|
||||||
|
return {
|
||||||
|
rejectionClass: 'YOUTUBE_PRIVATE_VIDEO',
|
||||||
|
rejectionSummary: 'YouTube video is private',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
normalized.includes('only images are available') ||
|
||||||
|
normalized.includes('requested format is not available') ||
|
||||||
|
normalized.includes('no downloadable audio/video formats')
|
||||||
|
) {
|
||||||
|
return {
|
||||||
|
rejectionClass: 'YOUTUBE_NO_FORMATS',
|
||||||
|
rejectionSummary: 'No downloadable YouTube audio format',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
normalized.includes('video unavailable') ||
|
||||||
|
normalized.includes('this video is not available') ||
|
||||||
|
normalized.includes('selected video unavailable')
|
||||||
|
) {
|
||||||
|
return {
|
||||||
|
rejectionClass: 'YOUTUBE_VIDEO_UNAVAILABLE',
|
||||||
|
rejectionSummary: 'YouTube video is unavailable',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
normalized.includes('failed to parse yt-dlp search output') ||
|
||||||
|
normalized.includes('yt-dlp exited with code') ||
|
||||||
|
normalized.includes('failed to start yt-dlp') ||
|
||||||
|
normalized.includes('yt-dlp exceeded maximum runtime') ||
|
||||||
|
normalized.includes('unable to download webpage')
|
||||||
|
) {
|
||||||
|
return {
|
||||||
|
rejectionClass: 'YOUTUBE_EXTRACTION_FAILURE',
|
||||||
|
rejectionSummary: 'YouTube extraction failed',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
rejectionClass: 'DOWNLOAD_FAILED',
|
||||||
|
rejectionSummary: 'Download failed',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
async retry(id: number): Promise<void> {
|
async retry(id: number): Promise<void> {
|
||||||
const track = await this.get(id);
|
const track = await this.get(id);
|
||||||
|
|
||||||
@@ -116,16 +299,19 @@ export class TrackService {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const rejectedUrls = this.parseRejectedYoutubeUrls(track);
|
const rejectedCandidateFields = this.rejectCurrentYoutubeCandidate(track, {
|
||||||
|
rejectionClass: 'MANUAL_RETRY',
|
||||||
if (track.youtubeUrl && !rejectedUrls.includes(track.youtubeUrl)) {
|
rejectionSummary: 'Rejected by manual retry',
|
||||||
rejectedUrls.push(track.youtubeUrl);
|
});
|
||||||
}
|
|
||||||
|
|
||||||
await this.update(id, {
|
await this.update(id, {
|
||||||
...track,
|
...track,
|
||||||
youtubeUrl: null,
|
youtubeUrl: null,
|
||||||
rejectedYoutubeUrls: this.stringifyRejectedYoutubeUrls(rejectedUrls),
|
selectedYoutubeTitle: null,
|
||||||
|
selectedYoutubeAuthor: null,
|
||||||
|
selectedYoutubeScore: null,
|
||||||
|
selectedYoutubeReason: null,
|
||||||
|
...rejectedCandidateFields,
|
||||||
downloadAttemptCount: 0,
|
downloadAttemptCount: 0,
|
||||||
error: null,
|
error: null,
|
||||||
status: TrackStatusEnum.New,
|
status: TrackStatusEnum.New,
|
||||||
@@ -161,6 +347,10 @@ export class TrackService {
|
|||||||
updatedTrack = {
|
updatedTrack = {
|
||||||
...track,
|
...track,
|
||||||
youtubeUrl: youtubeMatch.url,
|
youtubeUrl: youtubeMatch.url,
|
||||||
|
selectedYoutubeTitle: youtubeMatch.title,
|
||||||
|
selectedYoutubeAuthor: youtubeMatch.author,
|
||||||
|
selectedYoutubeScore: youtubeMatch.score,
|
||||||
|
selectedYoutubeReason: youtubeMatch.reason,
|
||||||
status: TrackStatusEnum.Queued,
|
status: TrackStatusEnum.Queued,
|
||||||
};
|
};
|
||||||
this.logger.debug(
|
this.logger.debug(
|
||||||
@@ -193,7 +383,9 @@ export class TrackService {
|
|||||||
const existingJob = await this.trackSearchQueue.getJob(jobId);
|
const existingJob = await this.trackSearchQueue.getJob(jobId);
|
||||||
|
|
||||||
if (existingJob) {
|
if (existingJob) {
|
||||||
this.logger.warn(`Removing existing search job for track ${id} before enqueue`);
|
this.logger.warn(
|
||||||
|
`Removing existing search job for track ${id} before enqueue`,
|
||||||
|
);
|
||||||
await existingJob.remove();
|
await existingJob.remove();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -212,7 +404,9 @@ export class TrackService {
|
|||||||
const existingJob = await this.trackDownloadQueue.getJob(jobId);
|
const existingJob = await this.trackDownloadQueue.getJob(jobId);
|
||||||
|
|
||||||
if (existingJob) {
|
if (existingJob) {
|
||||||
this.logger.warn(`Removing existing download job for track ${id} before enqueue`);
|
this.logger.warn(
|
||||||
|
`Removing existing download job for track ${id} before enqueue`,
|
||||||
|
);
|
||||||
await existingJob.remove();
|
await existingJob.remove();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -279,13 +473,17 @@ export class TrackService {
|
|||||||
error = toSafeErrorMessage(err);
|
error = toSafeErrorMessage(err);
|
||||||
}
|
}
|
||||||
|
|
||||||
const rejectedUrls = this.parseRejectedYoutubeUrls(track);
|
|
||||||
const nextAttemptCount = (track.downloadAttemptCount || 0) + 1;
|
const nextAttemptCount = (track.downloadAttemptCount || 0) + 1;
|
||||||
const maxAttempts = this.getMaxDownloadAttempts();
|
const maxAttempts = this.getMaxDownloadAttempts();
|
||||||
|
const rejectedCandidateFields = error
|
||||||
if (error && track.youtubeUrl && !rejectedUrls.includes(track.youtubeUrl)) {
|
? this.rejectCurrentYoutubeCandidate(track, this.classifyRejection(error))
|
||||||
rejectedUrls.push(track.youtubeUrl);
|
: {
|
||||||
}
|
rejectedYoutubeUrls: this.stringifyRejectedYoutubeUrls(
|
||||||
|
this.parseRejectedYoutubeUrls(track),
|
||||||
|
),
|
||||||
|
rejectedYoutubeCandidatesJson:
|
||||||
|
track.rejectedYoutubeCandidatesJson || JSON.stringify([]),
|
||||||
|
};
|
||||||
|
|
||||||
if (error && nextAttemptCount < maxAttempts) {
|
if (error && nextAttemptCount < maxAttempts) {
|
||||||
this.logger.warn(
|
this.logger.warn(
|
||||||
@@ -296,7 +494,11 @@ export class TrackService {
|
|||||||
await this.update(track.id, {
|
await this.update(track.id, {
|
||||||
...track,
|
...track,
|
||||||
youtubeUrl: null,
|
youtubeUrl: null,
|
||||||
rejectedYoutubeUrls: this.stringifyRejectedYoutubeUrls(rejectedUrls),
|
selectedYoutubeTitle: null,
|
||||||
|
selectedYoutubeAuthor: null,
|
||||||
|
selectedYoutubeScore: null,
|
||||||
|
selectedYoutubeReason: null,
|
||||||
|
...rejectedCandidateFields,
|
||||||
downloadAttemptCount: nextAttemptCount,
|
downloadAttemptCount: nextAttemptCount,
|
||||||
error: null,
|
error: null,
|
||||||
status: TrackStatusEnum.New,
|
status: TrackStatusEnum.New,
|
||||||
@@ -309,7 +511,7 @@ export class TrackService {
|
|||||||
const updatedTrack = {
|
const updatedTrack = {
|
||||||
...track,
|
...track,
|
||||||
status: error ? TrackStatusEnum.Error : TrackStatusEnum.Completed,
|
status: error ? TrackStatusEnum.Error : TrackStatusEnum.Completed,
|
||||||
rejectedYoutubeUrls: this.stringifyRejectedYoutubeUrls(rejectedUrls),
|
...rejectedCandidateFields,
|
||||||
downloadAttemptCount: error ? nextAttemptCount : 0,
|
downloadAttemptCount: error ? nextAttemptCount : 0,
|
||||||
...(error ? { error } : { error: null }),
|
...(error ? { error } : { error: null }),
|
||||||
};
|
};
|
||||||
@@ -320,7 +522,9 @@ export class TrackService {
|
|||||||
const safeArtist = track.artist || 'unknown_artist';
|
const safeArtist = track.artist || 'unknown_artist';
|
||||||
const safeName = track.name || 'unknown_track';
|
const safeName = track.name || 'unknown_track';
|
||||||
const fileName = `${safeArtist} - ${safeName}`;
|
const fileName = `${safeArtist} - ${safeName}`;
|
||||||
return `${this.utilsService.stripFileIllegalChars(fileName)}.${this.configService.get<string>(EnvironmentEnum.FORMAT)}`;
|
const format =
|
||||||
|
this.configService.get<string>(EnvironmentEnum.FORMAT) || 'mp3';
|
||||||
|
return `${this.utilsService.stripFileIllegalChars(fileName)}.${format}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
getFolderName(track: TrackEntity, playlist: PlaylistEntity): string {
|
getFolderName(track: TrackEntity, playlist: PlaylistEntity): string {
|
||||||
|
|||||||
Reference in New Issue
Block a user