Merge pull request #9 from mbaraa/refactor/rename-and-docs

Refactor: pretend to refactor and rename 💀

Author: mbaraa

cmd/server/server.go

@@ -9,22 +9,23 @@ import (
 	"dankmuzikk/models"
 	"dankmuzikk/services/jwt"
 	"dankmuzikk/services/login"
-	"dankmuzikk/services/youtube"
 	"dankmuzikk/services/youtube/download"
+	"dankmuzikk/services/youtube/search"
 	"embed"
 	"net/http"
 )
 
 func StartServer(staticFS embed.FS) error {
 	dbConn, err := db.Connector()
 	if err != nil {
-		log.Fatalln(log.ErrorLevel, err)
+		return err
 	}
 
 	accountRepo := db.NewBaseDB[models.Account](dbConn)
 	profileRepo := db.NewBaseDB[models.Profile](dbConn)
 	otpRepo := db.NewBaseDB[models.EmailVerificationCode](dbConn)
 	songRepo := db.NewBaseDB[models.Song](dbConn)
+	// playlistRepo := db.NewBaseDB[models.Playlist](dbConn)
 
 	jwtUtil := jwt.NewJWTImpl()
 
@@ -41,13 +42,13 @@ func StartServer(staticFS embed.FS) error {
 	pagesHandler.HandleFunc("/about", pagesRouter.Handler(pagesRouter.HandleAboutPage))
 	pagesHandler.HandleFunc("/playlists", pagesRouter.AuthHandler(pagesRouter.HandlePlaylistsPage))
 	pagesHandler.HandleFunc("/privacy", pagesRouter.Handler(pagesRouter.HandlePrivacyPage))
-	pagesHandler.HandleFunc("/search", pagesRouter.Handler(pagesRouter.HandleSearchResultsPage(&youtube.YouTubeScraperSearch{})))
+	pagesHandler.HandleFunc("/search", pagesRouter.Handler(pagesRouter.HandleSearchResultsPage(&search.ScraperSearch{})))
 
 	///////////// APIs /////////////
 
 	emailLoginApi := apis.NewEmailLoginApi(login.NewEmailLoginService(accountRepo, profileRepo, otpRepo, jwtUtil))
 	googleLoginApi := apis.NewGoogleLoginApi(login.NewGoogleLoginService(accountRepo, profileRepo, otpRepo, jwtUtil))
-	songDownloadApi := apis.NewDownloadHandler(*download.NewDownloadService(songRepo))
+	songDownloadApi := apis.NewDownloadHandler(*download.New(songRepo))
 
 	apisHandler := http.NewServeMux()
 	apisHandler.HandleFunc("POST /login/email", emailLoginApi.HandleEmailLogin)
@@ -57,7 +58,7 @@ func StartServer(staticFS embed.FS) error {
 	apisHandler.HandleFunc("GET /signup/google", googleLoginApi.HandleGoogleOAuthLogin)
 	apisHandler.HandleFunc("/login/google/callback", googleLoginApi.HandleGoogleOAuthLoginCallback)
 	apisHandler.HandleFunc("GET /logout", apis.HandleLogout)
-	apisHandler.HandleFunc("GET /search-suggession", apis.HandleSearchSugessions)
+	apisHandler.HandleFunc("GET /search-suggestion", apis.HandleSearchSuggestions)
 	apisHandler.HandleFunc("GET /song/download", songDownloadApi.HandleDownloadSong)
 
 	applicationHandler := http.NewServeMux()

handlers/apis/play_song.go

@@ -8,10 +8,10 @@ import (
 )
 
 type songDownloadHandler struct {
-	service download.DownloadService
+	service download.Service
 }
 
-func NewDownloadHandler(service download.DownloadService) *songDownloadHandler {
+func NewDownloadHandler(service download.Service) *songDownloadHandler {
 	return &songDownloadHandler{service}
 }
 

handlers/apis/search_suggestions.go

@@ -3,26 +3,31 @@ package apis
 import (
 	"context"
 	"dankmuzikk/log"
-	"dankmuzikk/services/youtube"
+	"dankmuzikk/services/youtube/search/suggestions"
 	"dankmuzikk/views/components/search"
 	"net/http"
 )
 
-func HandleSearchSugessions(w http.ResponseWriter, r *http.Request) {
+func HandleSearchSuggestions(w http.ResponseWriter, r *http.Request) {
 	q := r.URL.Query().Get("query")
 	if q == "" {
-		w.Write(nil)
+		_, _ = w.Write(nil)
 		return
 	}
 
-	suggessions, err := youtube.SearchSuggestions(q)
+	sug, err := suggestions.SearchSuggestions(q)
 	if err != nil {
 		log.Warningln(err)
 		w.WriteHeader(http.StatusBadRequest)
 		return
 	}
 
-	err = search.SearchSuggestions(suggessions, q).Render(context.Background(), w)
+	if len(sug) == 0 {
+		_, _ = w.Write(nil)
+		return
+	}
+
+	err = search.SearchSuggestions(sug, q).Render(context.Background(), w)
 	if err != nil {
 		log.Warningln(err)
 		w.WriteHeader(http.StatusInternalServerError)

handlers/pages/pages.go

@@ -9,7 +9,7 @@ import (
 	"dankmuzikk/log"
 	"dankmuzikk/models"
 	"dankmuzikk/services/jwt"
-	"dankmuzikk/services/youtube"
+	"dankmuzikk/services/youtube/search"
 	"dankmuzikk/views/pages"
 	"net/http"
 	"slices"
@@ -117,7 +117,7 @@ func (p *pagesHandler) HandleProfilePage(w http.ResponseWriter, r *http.Request)
 	pages.Profile(p.isMobile(r), p.getTheme(r), profile).Render(context.Background(), w)
 }
 
-func (p *pagesHandler) HandleSearchResultsPage(ytSearch youtube.YouTubeSearcher) http.HandlerFunc {
+func (p *pagesHandler) HandleSearchResultsPage(ytSearch search.Service) http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		query := r.URL.Query().Get("query")
 		results, err := ytSearch.Search(query)

services/youtube/download/download.go

@@ -12,18 +12,21 @@ import (
 	"os"
 )
 
-type DownloadService struct {
+// Service represents the YouTube downloader service.
+type Service struct {
 	repo db.CreatorRepo[models.Song]
 }
 
-func NewDownloadService(repo db.CRUDRepo[models.Song]) *DownloadService {
-	return &DownloadService{repo}
+// New accepts a models.Song creator repo to store songs' meta-data,
+// and returns a new instance of the YouTube downloader service.
+func New(repo db.CreatorRepo[models.Song]) *Service {
+	return &Service{repo}
 }
 
-// DownloadYoutubeVideo downloads a youtube music file into the path specified by the environment variable
+// DownloadYoutubeSong downloads a YouTube music file into the path specified by the environment variable
 // YOUTUBE_MUSIC_DOWNLOAD_PATH, where the file name will be <video_id.mp3> to be served under /music/{id}
-// and retuens an occurring error
-func (d *DownloadService) DownloadYoutubeSong(req entities.SongDownloadRequest) error {
+// and returns an occurring error
+func (d *Service) DownloadYoutubeSong(req entities.SongDownloadRequest) error {
 	path := fmt.Sprintf("%s/%s.mp3", config.Env().YouTube.MusicDir, req.Id)
 	if _, err := os.Stat(path); err == nil {
 		log.Infof("The song with id %s is already downloaded\n", req.Id)

services/youtube/search/search_api.go

@@ -0,0 +1,87 @@
+package search
+
+import (
+	"context"
+	"dankmuzikk/log"
+	"encoding/json"
+
+	"google.golang.org/api/youtube/v3"
+)
+
+type apiSearchResult struct {
+	Items []struct {
+		Id      string `json:"id"`
+		Kind    string `json:"kind"`
+		Snippet struct {
+			Title        string `json:"title"`
+			ChannelTitle string `json:"channelTitle"`
+			Description  string `json:"description"`
+			Thumbnails   struct {
+				Default struct {
+					Url string `json:"url"`
+				} `json:"medium"`
+			} `json:"thumbnails"`
+		} `json:"snippet"`
+		ContentDetails struct {
+			Duration string `json:"duration"`
+		} `json:"contentDetails"`
+	} `json:"items"`
+}
+
+// ApiSearch is a YouTube enabled YouTube search, using the official YouTube API.
+type ApiSearch struct{}
+
+func (y *ApiSearch) Search(query string) (results []Result, err error) {
+	ctx := context.Background()
+	youtubeService, err := youtube.NewService(ctx)
+	if err != nil {
+		return
+	}
+
+	response, err := youtubeService.Search.
+		List([]string{"id"}).
+		Q(query).
+		MaxResults(maxSearchResults).Do()
+	if err != nil {
+		return
+	}
+
+	for _, item := range response.Items {
+		vid, err := youtubeService.Videos.
+			List([]string{"snippet", "contentDetails"}).
+			Id(item.Id.VideoId).
+			Do()
+		if err != nil {
+			log.Warningf("[YOUTUBE SERVICE] Fething search results: %s\n", err.Error())
+			continue
+		}
+
+		var responseObj apiSearchResult
+		resJson, _ := vid.MarshalJSON()
+		err = json.Unmarshal(resJson, &responseObj)
+		if err != nil {
+			log.Warningf("[YOUTUBE SERVICE] Unmarshelling the response: %s\n", err.Error())
+			continue
+		}
+
+		if len(responseObj.Items) == 0 || responseObj.Items[0].Kind != "youtube#video" {
+			continue
+		}
+		duration, err := getTime(responseObj.Items[0].ContentDetails.Duration)
+		if err != nil {
+			log.Warningf("[YOUTUBE SERVICE] Parsing ISO duration: %s\n", err.Error())
+			continue
+		}
+
+		results = append(results, Result{
+			Title:        responseObj.Items[0].Snippet.Title,
+			ChannelTitle: responseObj.Items[0].Snippet.ChannelTitle,
+			Description:  responseObj.Items[0].Snippet.Description,
+			Id:           responseObj.Items[0].Id,
+			ThumbnailUrl: responseObj.Items[0].Snippet.Thumbnails.Default.Url,
+			Duration:     duration,
+		})
+	}
+
+	return
+}

services/youtube/search_scraper.go renamed to services/youtube/search/search_scraper.go

@@ -1,4 +1,4 @@
-package youtube
+package search
 
 import (
 	"dankmuzikk/config"
@@ -25,9 +25,10 @@ type scrapSearchResult struct {
 	} `json:"results"`
 }
 
-type YouTubeScraperSearch struct{}
+// ScraperSearch is a scrapper enabled YouTube search, using the search service under ~/ytscraper
+type ScraperSearch struct{}
 
-func (y *YouTubeScraperSearch) Search(query string) (results []SearchResult, err error) {
+func (y *ScraperSearch) Search(query string) (results []Result, err error) {
 	// TODO: write a proper scraper instead of this hacky node js api
 	resp, err := http.Get(fmt.Sprintf("%s/api/search?q=%s", config.Env().YouTube.ScraperUrl, url.QueryEscape(query)))
 	if err != nil {
@@ -49,7 +50,7 @@ func (y *YouTubeScraperSearch) Search(query string) (results []SearchResult, err
 			duration[0] = "0" + duration[0]
 		}
 
-		results = append(results, SearchResult{
+		results = append(results, Result{
 			Id:           res.Video.Id,
 			Title:        res.Video.Title,
 			ChannelTitle: res.Uploader.Username,

services/youtube/search_suggestion.go renamed to services/youtube/search/suggestions/search_suggestion.go

@@ -1,13 +1,13 @@
-package youtube
+package suggestions
 
 import (
 	"encoding/json"
 	"net/http"
 	"net/url"
 )
 
-func SearchSuggestions(query string) (sugesstions []string, err error) {
-	resp, err := http.Get("http://suggestqueries.google.com/complete/search?client=firefox&ds=yt&q=" +
+func SearchSuggestions(query string) (suggestions []string, err error) {
+	resp, err := http.Get("https://suggestqueries.google.com/complete/search?client=firefox&ds=yt&q=" +
 		url.QueryEscape(query))
 	if err != nil {
 		panic(err)
@@ -23,7 +23,7 @@ func SearchSuggestions(query string) (sugesstions []string, err error) {
 		if i >= 9 { // max displayed suggestions is 10
 			break
 		}
-		sugesstions = append(sugesstions, res.(string))
+		suggestions = append(suggestions, res.(string))
 	}
 
 	return

services/youtube/youtube.go renamed to services/youtube/search/youtube.go

@@ -1,4 +1,4 @@
-package youtube
+package search
 
 import (
 	"fmt"
@@ -11,7 +11,8 @@ const (
 	maxSearchResults = 7
 )
 
-type SearchResult struct {
+// Result represents a common search result object.
+type Result struct {
 	Id           string
 	Title        string
 	ChannelTitle string // or artist idk
@@ -20,11 +21,11 @@ type SearchResult struct {
 	Duration     string
 }
 
-// YouTubeSearcher is an interface that represents a youtube search behavior.
-type YouTubeSearcher interface {
-	// Search searches youtube for the given query,
+// Service is an interface that represents a YouTube search behavior.
+type Service interface {
+	// Search searches YouTube for the given query,
 	// and returns a SearchResult slice, and an occurring error.
-	Search(query string) (results []SearchResult, err error)
+	Search(query string) (results []Result, err error)
 }
 
 func getTime(isoDuration string) (string, error) {
@@ -40,7 +41,7 @@ func getTime(isoDuration string) (string, error) {
 		return "", err
 	}
 	days, hours, mins, secs :=
-		duration/(time.Hour*24), (duration / time.Hour), duration/time.Minute, duration/time.Second
+		duration/(time.Hour*24), duration/time.Hour, duration/time.Minute, duration/time.Second
 
 	builder := strings.Builder{}
 	if days > 0 {

services/youtube/search_api.go

@@ -1,29 +1,30 @@
 "use strict";
 
 const searchFormEl = document.getElementById("search-form"),
-  searchInputEl = document.getElementById("search-input");
+  searchInputEl = document.getElementById("search-input"),
+    searchSugEl = document.getElementById("search-suggestions-container");
 
 let focusedSuggestionIndex = 0;
 
-function searchNoRealod(searchQuery) {
+function searchNoReload(searchQuery) {
   searchFormEl.blur();
   searchInputEl.blur();
   const query = encodeURIComponent(searchQuery);
-  document.getElementById("search-suggestions").style.display = "none";
   const prevPath = window.location.href.substring(
     (window.location.protocol + "//" + window.location.host).length,
   );
   window.location.prevPath = prevPath;
   window.history.pushState({}, "", `/search?query=${query}`);
+  searchSugEl.innerText = "";
 }
 
 searchFormEl.addEventListener("submit", (e) => {
   e.preventDefault();
-  searchNoRealod(e.target.query.value);
+  searchNoReload(e.target.query.value);
 });
 
 document.getElementById("search-icon").addEventListener("click", () => {
-  searchNoRealod(searchFormEl.query.value);
+  searchNoReload(searchFormEl.query.value);
 });
 
 searchInputEl.addEventListener("keydown", (e) => {
@@ -71,5 +72,5 @@ function moveToSuggestions() {
 }
 
 window.Search = {
-  searchNoRealod: searchNoRealod,
+  searchNoReload,
 };

static/js/search.js

@@ -22,7 +22,7 @@ templ Search() {
 					autofocus
 					autocomplete="off"
 					placeholder="Search for some tunes"
-					hx-get="/api/search-suggession"
+					hx-get="/api/search-suggestion"
 					hx-swap="innerHTML"
 					hx-target="#search-suggestions-container"
 					hx-trigger="keyup"

views/components/search/search.templ

@@ -35,5 +35,5 @@ templ SearchSuggestions(suggestions []string, originalQuery string) {
 }
 
 script searchNoRealod(searchQuery string) {
-    window.Search.searchNoRealod(searchQuery);
+    window.Search.searchNoReload(searchQuery);
 }