feat: add ISRC track search for YouTube (#2594)

* Add ISRC track search for YouTube

* Do not probe Song.Link when ISRC results are valid, fix rate limit

lib/collections/fake.dart

@@ -94,6 +94,7 @@ abstract class FakeData {
     ..trackNumber = 1
     ..type = "type"
     ..uri = "uri"
+    ..externalIds = externalIds
     ..isPlayable = true
     ..explicit = false
     ..linkedFrom = trackLink;

lib/extensions/track.dart

@@ -4,7 +4,9 @@ import 'dart:typed_data';
 import 'package:metadata_god/metadata_god.dart';
 import 'package:path/path.dart';
 import 'package:spotify/spotify.dart';
+import 'package:spotube/provider/spotify/spotify.dart';
 import 'package:spotube/services/audio_player/audio_player.dart';
+import 'package:spotube/services/logger/logger.dart';
 
 extension TrackExtensions on Track {
   Track fromFile(
@@ -67,27 +69,40 @@ extension TrackExtensions on Track {
   }
 }
 
-extension TrackSimpleExtensions on TrackSimple {
+extension IterableTrackSimpleExtensions on Iterable<TrackSimple> {
-  Track asTrack(AlbumSimple album) {
+  Future<List<Track>> asTracks(AlbumSimple album, ref) async {
-    Track track = Track();
+    try {
-    track.name = name;
+      final spotify = ref.read(spotifyProvider);
-    track.album = album;
+      final tracks = await spotify.invoke(
-    track.artists = artists;
+        (api) => api.tracks.list(map((trackSimple) => trackSimple.id!).toList()));
-    track.availableMarkets = availableMarkets;
+      return tracks.toList();
-    track.discNumber = discNumber;
+    } catch (e, stack) {
-    track.durationMs = durationMs;
+      // Ignore errors and create the track locally
-    track.explicit = explicit;
+      AppLogger.reportError(e, stack);
-    track.externalUrls = externalUrls;
+
-    track.href = href;
+      List<Track> tracks = [];
-    track.id = id;
+      for (final trackSimple in this) {
-    track.isPlayable = isPlayable;
+        Track track = Track();
-    track.linkedFrom = linkedFrom;
+        track.album = album;
-    track.name = name;
+        track.name = trackSimple.name;
-    track.previewUrl = previewUrl;
+        track.artists = trackSimple.artists;
-    track.trackNumber = trackNumber;
+        track.availableMarkets = trackSimple.availableMarkets;
-    track.type = type;
+        track.discNumber = trackSimple.discNumber;
-    track.uri = uri;
+        track.durationMs = trackSimple.durationMs;
-    return track;
+        track.explicit = trackSimple.explicit;
+        track.externalUrls = trackSimple.externalUrls;
+        track.href = trackSimple.href;
+        track.id = trackSimple.id;
+        track.isPlayable = trackSimple.isPlayable;
+        track.linkedFrom = trackSimple.linkedFrom;
+        track.previewUrl = trackSimple.previewUrl;
+        track.trackNumber = trackSimple.trackNumber;
+        track.type = trackSimple.type;
+        track.uri = trackSimple.uri;
+        tracks.add(track);
+      }
+      return tracks;
+    }
   }
 }
 

lib/modules/album/album_card.dart

@@ -54,7 +54,7 @@ class AlbumCard extends HookConsumerWidget {
 
     Future<List<Track>> fetchAllTrack() async {
       if (album.tracks != null && album.tracks!.isNotEmpty) {
-        return album.tracks!.map((track) => track.asTrack(album)).toList();
+        return album.tracks!.asTracks(album, ref);
       }
       await ref.read(albumTracksProvider(album).future);
       return ref.read(albumTracksProvider(album).notifier).fetchAll();

lib/provider/spotify/album/tracks.dart

@@ -33,7 +33,7 @@ class AlbumTracksNotifier extends AutoDisposeFamilyPaginatedAsyncNotifier<Track,
     final tracks = await spotify.invoke(
       (api) => api.albums.tracks(arg.id!).getPage(limit, offset),
     );
-    final items = tracks.items?.map((e) => e.asTrack(arg)).toList() ?? [];
+    final items = await tracks.items!.asTracks(arg, ref);
 
     return (
       items: items,

lib/services/sourced_track/sources/youtube.dart

@@ -236,29 +236,67 @@ class YoutubeSourcedTrack extends SourcedTrack {
         .toList();
   }
 
+  static Future<List<YoutubeVideoInfo>> fetchFromIsrc({
+    required Track track,
+    required Provider provider,
+    required Ref ref,
+  }) async {
+    final isrcResults = <YoutubeVideoInfo>[];
+    final isrc = track.externalIds?.isrc;
+    if (isrc != null && isrc.isNotEmpty) {
+      final searchedVideos = await ref
+          .read(provider)
+          .searchVideos(isrc.toString());
+      if (searchedVideos.isNotEmpty) {
+        isrcResults.addAll(searchedVideos
+            .map<YoutubeVideoInfo>(YoutubeVideoInfo.fromVideo)
+            .map((YoutubeVideoInfo videoInfo) {
+              final ytWords =
+                  videoInfo.title
+                      .toLowerCase()
+                      .replaceAll(RegExp(r'[^a-zA-Z0-9\s]+'), '')
+                      .split(RegExp(r'\s+'))
+                      .where((item) => item.isNotEmpty);
+              final spWords =
+                  track.name!
+                      .toLowerCase()
+                      .replaceAll(RegExp(r'\((.*)\)'), '')
+                      .replaceAll(RegExp(r'[^a-zA-Z0-9\s]+'), '')
+                      .split(RegExp(r'\s+'))
+                      .where((item) => item.isNotEmpty);
+              // Word match to filter out unrelated results
+              final matchCount =
+                  ytWords.where((word) => spWords.contains(word)).length;
+              if (matchCount > spWords.length ~/ 2) {
+                return videoInfo;
+              }
+              return null;
+            }
+        ).whereType<YoutubeVideoInfo>().toList());
+      }
+    }
+    return isrcResults;
+  }
+
   static Future<List<SiblingType>> fetchSiblings({
     required Track track,
     required Ref ref,
   }) async {
+    final videoResults = <YoutubeVideoInfo>[];
+
+    final isrcResults = await fetchFromIsrc(track: track, provider: youtubeEngineProvider, ref: ref);
+    videoResults.addAll(isrcResults);
+
     final links = await SongLinkService.links(track.id!);
     final ytLink = links.firstWhereOrNull((link) => link.platform == "youtube");
 
-    if (ytLink?.url != null
+    if (isrcResults.isEmpty && ytLink?.url != null) {
-        // allows to fetch siblings more results for already sourced track
-        &&
-        track is! SourcedTrack) {
       try {
-        return [
+        videoResults.add(
-          await toSiblingType(
-            0,
             YoutubeVideoInfo.fromVideo(
-              await ref.read(youtubeEngineProvider).getVideo(
+                await ref.read(youtubeEngineProvider)
-                    Uri.parse(ytLink!.url!).queryParameters["v"]!,
+                    .getVideo(Uri.parse(ytLink!.url!).queryParameters["v"]!)
-                  ),
+        ));
-            ),
-            ref,
-          )
-        ];
       } on VideoUnplayableException catch (e, stack) {
         // Ignore this error and continue with the search
         AppLogger.reportError(e, stack);
@@ -271,20 +309,28 @@ class YoutubeSourcedTrack extends SourcedTrack {
         await ref.read(youtubeEngineProvider).searchVideos(query);
 
     if (ServiceUtils.onlyContainsEnglish(query)) {
-      return await Future.wait(searchResults
+      videoResults.addAll(
-          .map(YoutubeVideoInfo.fromVideo)
+          searchResults.map(YoutubeVideoInfo.fromVideo).toList()
-          .mapIndexed((index, info) => toSiblingType(index, info, ref)));
+      );
+    } else {
+      videoResults.addAll(rankResults(
+          searchResults.map(YoutubeVideoInfo.fromVideo).toList(),
+          track,
+      ));
     }
 
-    final rankedSiblings = rankResults(
+    final seenIds = <String>{};
-      searchResults.map(YoutubeVideoInfo.fromVideo).toList(),
+    int index = 0;
-      track,
-    );
-
     return await Future.wait(
-      rankedSiblings
+      videoResults.map((videoResult) async {
-          .mapIndexed((index, info) => toSiblingType(index, info, ref)),
+        // Deduplicate results
-    );
+        if (!seenIds.contains(videoResult.id)) {
+          seenIds.add(videoResult.id);
+          return await toSiblingType(index++, videoResult, ref);
+        }
+        return null;
+      }),
+    ).then((s) => s.whereType<SiblingType>().toList());
   }
 
   @override