Improve lyrics match with scored searches

src/main/features/core/lyrics/genius.ts

@@ -1,69 +1,103 @@
 import axios, { AxiosResponse } from 'axios';
 import { load } from 'cheerio';
-import type {
+import {
+  LyricSource,
   InternetProviderLyricResponse,
   InternetProviderLyricSearchResponse,
   LyricSearchQuery,
-} from '/@/renderer/api/types';
-import { LyricSource } from '../../../../renderer/api/types';
+} from '../../../../renderer/api/types';
+import { orderSearchResults } from './shared';
 
 const SEARCH_URL = 'https://genius.com/api/search/song';
 
 // Adapted from https://github.com/NyaomiDEV/Sunamu/blob/master/src/main/lyricproviders/genius.ts
 
-interface GeniusResponse {
-  artist: string;
-  name: string;
+export interface GeniusResponse {
+  meta: Meta;
+  response: Response;
+}
+
+export interface Meta {
+  status: number;
+}
+
+export interface Response {
+  next_page: number;
+  sections: Section[];
+}
+
+export interface Section {
+  hits: Hit[];
+  type: string;
+}
+
+export interface Hit {
+  highlights: any[];
+  index: string;
+  result: Result;
+  type: string;
+}
+
+export interface Result {
+  _type: string;
+  annotation_count: number;
+  api_path: string;
+  artist_names: string;
+  featured_artists: any[];
+  full_title: string;
+  header_image_thumbnail_url: string;
+  header_image_url: string;
+  id: number;
+  instrumental: boolean;
+  language: string;
+  lyrics_owner_id: number;
+  lyrics_state: string;
+  lyrics_updated_at: number;
+  path: string;
+  primary_artist: PrimaryArtist;
+  pyongs_count: null;
+  relationships_index_url: string;
+  release_date_components: ReleaseDateComponents;
+  release_date_for_display: string;
+  release_date_with_abbreviated_month_for_display: string;
+  song_art_image_thumbnail_url: string;
+  song_art_image_url: string;
+  stats: Stats;
+  title: string;
+  title_with_featured: string;
+  updated_by_human_at: number;
   url: string;
 }
 
-interface GeniusSearchResponse {
-  response: {
-    sections: {
-      hits: {
-        highlights: any[];
-        index: string;
-        result: {
-          _type: string;
-          annotation_count: number;
-          api_path: string;
-          artist_names: string;
-          featured_artits: any[];
-          full_title: string;
-          header_image_thumbnail_url: string;
-          header_image_url: string;
-          id: number;
-          instrumental: boolean;
-          language: string;
-          lyrics_owner_id: number;
-          lyrics_state: string;
-          lyrics_updated_at: number;
-          path: string;
-          primary_artist: Record<any, any>;
-          pyongs_count: number;
-          relationships_index_url: string;
-          release_date_components: Record<any, any>;
-          release_date_for_display: string;
-          release_date_with_abbreviated_month_for_display: string;
-          song_art_image_thumbnail_url: string;
-          song_art_image_url: string;
-          stats: Record<any, any>;
-          title: string;
-          title_with_featured: string;
-          updated_by_human_at: number;
-          url: string;
-        };
-        type: string;
-      }[];
-      type: string;
-    }[];
-  };
+export interface PrimaryArtist {
+  _type: string;
+  api_path: string;
+  header_image_url: string;
+  id: number;
+  image_url: string;
+  index_character: string;
+  is_meme_verified: boolean;
+  is_verified: boolean;
+  name: string;
+  slug: string;
+  url: string;
+}
+
+export interface ReleaseDateComponents {
+  day: number;
+  month: number;
+  year: number;
+}
+
+export interface Stats {
+  hot: boolean;
+  unreviewed_annotations: number;
 }
 
 export async function getSearchResults(
   params: LyricSearchQuery,
 ): Promise<InternetProviderLyricSearchResponse[] | null> {
-  let result: AxiosResponse<GeniusSearchResponse>;
+  let result: AxiosResponse<GeniusResponse>;
 
   const searchQuery = [params.artist, params.name].join(' ');
 
@@ -83,11 +117,11 @@ export async function getSearchResults(
     return null;
   }
 
-  const songs = result.data.response?.sections?.[0]?.hits?.map((hit) => hit.result);
+  const rawSongsResult = result.data.response?.sections?.[0]?.hits?.map((hit) => hit.result);
 
-  if (!songs) return null;
+  if (!rawSongsResult) return null;
 
-  return songs.map((song: any) => {
+  const songResults: InternetProviderLyricSearchResponse[] = rawSongsResult.map((song: any) => {
     return {
       artist: song.artist_names,
       id: song.url,
@@ -95,10 +129,14 @@ export async function getSearchResults(
       source: LyricSource.GENIUS,
     };
   });
+
+  return orderSearchResults({ params, results: songResults });
 }
 
-async function getSongURL(params: LyricSearchQuery): Promise<GeniusResponse | undefined> {
-  let result: AxiosResponse<GeniusSearchResponse>;
+async function getSongId(
+  params: LyricSearchQuery,
+): Promise<Omit<InternetProviderLyricResponse, 'lyrics'> | null> {
+  let result: AxiosResponse<GeniusResponse>;
   try {
     result = await axios.get(SEARCH_URL, {
       params: {
@@ -108,23 +146,24 @@ async function getSongURL(params: LyricSearchQuery): Promise<GeniusResponse | un
     });
   } catch (e) {
     console.error('Genius search request got an error!', e);
-    return undefined;
+    return null;
   }
 
   const hit = result.data.response?.sections?.[0]?.hits?.[0]?.result;
 
   if (!hit) {
-    return undefined;
+    return null;
   }
 
   return {
     artist: hit.artist_names,
+    id: hit.url,
     name: hit.full_title,
-    url: hit.url,
+    source: LyricSource.GENIUS,
   };
 }
 
-export async function getLyricsByURL(url: string): Promise<string | null> {
+export async function getLyricsBySongId(url: string): Promise<string | null> {
   let result: AxiosResponse<string, any>;
   try {
     result = await axios.get<string>(url, { responseType: 'text' });
@@ -148,13 +187,13 @@ export async function getLyricsByURL(url: string): Promise<string | null> {
 export async function query(
   params: LyricSearchQuery,
 ): Promise<InternetProviderLyricResponse | null> {
-  const response = await getSongURL(params);
+  const response = await getSongId(params);
   if (!response) {
     console.error('Could not find the song on Genius!');
     return null;
   }
 
-  const lyrics = await getLyricsByURL(response.url);
+  const lyrics = await getLyricsBySongId(response.id);
   if (!lyrics) {
     console.error('Could not get lyrics on Genius!');
     return null;
@@ -162,6 +201,7 @@ export async function query(
 
   return {
     artist: response.artist,
+    id: response.id,
     lyrics,
     name: response.name,
     source: LyricSource.GENIUS,

src/main/features/core/lyrics/index.ts

@@ -1,3 +1,4 @@
+import { ipcMain } from 'electron';
 import {
   InternetProviderLyricResponse,
   InternetProviderLyricSearchResponse,
@@ -5,19 +6,18 @@ import {
   QueueSong,
   LyricGetQuery,
   LyricSource,
-} from '/@/renderer/api/types';
+} from '../../../../renderer/api/types';
+import { store } from '../settings/index';
 import {
   query as queryGenius,
   getSearchResults as searchGenius,
-  getLyricsByURL as getGenius,
+  getLyricsBySongId as getGenius,
 } from './genius';
 import {
   query as queryNetease,
   getSearchResults as searchNetease,
   getLyricsBySongId as getNetease,
 } from './netease';
-import { ipcMain } from 'electron';
-import { store } from '../settings/index';
 
 type SongFetcher = (params: LyricSearchQuery) => Promise<InternetProviderLyricResponse | null>;
 type SearchFetcher = (

src/main/features/core/lyrics/netease.ts

@@ -1,5 +1,6 @@
 import axios, { AxiosResponse } from 'axios';
 import { LyricSource } from '../../../../renderer/api/types';
+import { orderSearchResults } from './shared';
 import type {
   InternetProviderLyricResponse,
   InternetProviderLyricSearchResponse,
@@ -11,16 +12,65 @@ const LYRICS_URL = 'https://music.163.com/api/song/lyric';
 
 // Adapted from https://github.com/NyaomiDEV/Sunamu/blob/master/src/main/lyricproviders/netease.ts
 
-interface NetEaseResponse {
-  artist: string;
-  id: string;
+export interface NetEaseResponse {
+  code: number;
+  result: Result;
+}
+
+export interface Result {
+  hasMore: boolean;
+  songCount: number;
+  songs: Song[];
+}
+
+export interface Song {
+  album: Album;
+  alias: string[];
+  artists: Artist[];
+  copyrightId: number;
+  duration: number;
+  fee: number;
+  ftype: number;
+  id: number;
+  mark: number;
+  mvid: number;
   name: string;
+  rUrl: null;
+  rtype: number;
+  status: number;
+  transNames?: string[];
+}
+
+export interface Album {
+  artist: Artist;
+  copyrightId: number;
+  id: number;
+  mark: number;
+  name: string;
+  picId: number;
+  publishTime: number;
+  size: number;
+  status: number;
+  transNames?: string[];
+}
+
+export interface Artist {
+  albumSize: number;
+  alias: any[];
+  fansGroup: null;
+  id: number;
+  img1v1: number;
+  img1v1Url: string;
+  name: string;
+  picId: number;
+  picUrl: null;
+  trans: null;
 }
 
 export async function getSearchResults(
   params: LyricSearchQuery,
 ): Promise<InternetProviderLyricSearchResponse[] | null> {
-  let result: AxiosResponse<any, any>;
+  let result: AxiosResponse<NetEaseResponse>;
 
   const searchQuery = [params.artist, params.name].join(' ');
 
@@ -42,11 +92,11 @@ export async function getSearchResults(
     return null;
   }
 
-  const songs = result?.data.result?.songs;
+  const rawSongsResult = result?.data.result?.songs;
 
-  if (!songs) return null;
+  if (!rawSongsResult) return null;
 
-  return songs.map((song: any) => {
+  const songResults: InternetProviderLyricSearchResponse[] = rawSongsResult.map((song: any) => {
     const artist = song.artists ? song.artists.map((artist: any) => artist.name).join(', ') : '';
 
     return {
@@ -56,19 +106,24 @@ export async function getSearchResults(
       source: LyricSource.NETEASE,
     };
   });
+
+  return orderSearchResults({ params, results: songResults });
 }
 
-async function getSongId(params: LyricSearchQuery): Promise<NetEaseResponse | undefined> {
+async function getMatchedLyrics(
+  params: LyricSearchQuery,
+): Promise<Omit<InternetProviderLyricResponse, 'lyrics'> | null> {
   const results = await getSearchResults(params);
-  const song = results?.[0];
 
-  if (!song) return undefined;
+  console.log('results', results);
 
-  return {
-    artist: song.artist,
-    id: song.id,
-    name: song.name,
-  };
+  const firstMatch = results?.[0];
+
+  if (!firstMatch || (firstMatch?.score && firstMatch.score > 0.5)) {
+    return null;
+  }
+
+  return firstMatch;
 }
 
 export async function getLyricsBySongId(songId: string): Promise<string | null> {
@@ -92,22 +147,23 @@ export async function getLyricsBySongId(songId: string): Promise<string | null>
 export async function query(
   params: LyricSearchQuery,
 ): Promise<InternetProviderLyricResponse | null> {
-  const response = await getSongId(params);
-  if (!response) {
+  const lyricsMatch = await getMatchedLyrics(params);
+  if (!lyricsMatch) {
     console.error('Could not find the song on NetEase!');
     return null;
   }
 
-  const lyrics = await getLyricsBySongId(response.id);
+  const lyrics = await getLyricsBySongId(lyricsMatch.id);
   if (!lyrics) {
     console.error('Could not get lyrics on NetEase!');
     return null;
   }
 
   return {
-    artist: response.artist,
+    artist: lyricsMatch.artist,
+    id: lyricsMatch.id,
     lyrics,
-    name: response.name,
+    name: lyricsMatch.name,
     source: LyricSource.NETEASE,
   };
 }

src/main/features/core/lyrics/shared.ts

@@ -0,0 +1,34 @@
+import Fuse from 'fuse.js';
+import {
+  InternetProviderLyricSearchResponse,
+  LyricSearchQuery,
+} from '../../../../renderer/api/types';
+
+export const orderSearchResults = (args: {
+  params: LyricSearchQuery;
+  results: InternetProviderLyricSearchResponse[];
+}) => {
+  const { params, results } = args;
+
+  const options: Fuse.IFuseOptions<InternetProviderLyricSearchResponse> = {
+    fieldNormWeight: 1,
+    includeScore: true,
+    keys: [
+      { getFn: (song) => song.name, name: 'name', weight: 3 },
+      { getFn: (song) => song.artist, name: 'artist' },
+    ],
+    threshold: 1.0,
+  };
+
+  const fuse = new Fuse(results, options);
+
+  const searchResults = fuse.search<InternetProviderLyricSearchResponse>({
+    ...(params.artist && { artist: params.artist }),
+    ...(params.name && { name: params.name }),
+  });
+
+  return searchResults.map((result) => ({
+    ...result.item,
+    score: result.score,
+  }));
+};