Add error handling and logging for Youtube-DL (#200)

Co-authored-by: ReenigneArcher <[email protected]>

Contents/Code/youtube_dl_helper.py

@@ -1,5 +1,8 @@
 # -*- coding: utf-8 -*-
 
+# standard imports
+import logging
+
 # plex debugging
 try:
     import plexhints  # noqa: F401
@@ -10,9 +13,13 @@
     from plexhints.prefs_kit import Prefs  # prefs kit
 
 # imports from Libraries\Shared
+from constants import plugin_identifier
 from typing import Optional
 import youtube_dl
 
+# get the plugin logger
+plugin_logger = logging.getLogger(plugin_identifier)
+
 
 def process_youtube(url):
     # type: (str) -> Optional[str]
@@ -35,19 +42,29 @@ def process_youtube(url):
     ...
     """
     youtube_dl_params = dict(
-        outmpl='%(id)s.%(ext)s',
-        youtube_include_dash_manifest=False,
-        username=Prefs['str_youtube_user'] if Prefs['str_youtube_user'] else None,
+        logger=plugin_logger,
+        outtmpl=u'%(id)s.%(ext)s',
         password=Prefs['str_youtube_passwd'] if Prefs['str_youtube_passwd'] else None,
+        socket_timeout=10,
+        username=Prefs['str_youtube_user'] if Prefs['str_youtube_user'] else None,
+        youtube_include_dash_manifest=False,
     )
 
     ydl = youtube_dl.YoutubeDL(params=youtube_dl_params)
 
     with ydl:
-        result = ydl.extract_info(
-            url=url,
-            download=False  # We just want to extract the info
-        )
+        try:
+            result = ydl.extract_info(
+                url=url,
+                download=False  # We just want to extract the info
+            )
+        except Exception as exc:
+            if isinstance(exc, youtube_dl.utils.ExtractorError) and exc.expected:
+                Log.Info('YDL returned YT error while downloading %s: %s' % (url, exc))
+            else:
+                Log.Exception('YDL returned an unexpected error while downloading %s: %s' % (url, exc))
+            return None
+
         if 'entries' in result:
             # Can be a playlist or a list of videos
             video_data = result['entries'][0]

tests/unit/test_youtube_dl_helper.py

@@ -1,8 +1,4 @@
 # -*- coding: utf-8 -*-
-# lib imports
-import pytest
-from youtube_dl import DownloadError
-
 # local imports
 from Code import youtube_dl_helper
 
@@ -26,5 +22,5 @@ def test_process_youtube_invalid():
         'https://blahblahblah',
     ]
     for url in invalid_urls:
-        with pytest.raises(DownloadError):
-            youtube_dl_helper.process_youtube(url=url)
+        audio_url = youtube_dl_helper.process_youtube(url=url)
+        assert audio_url is None