[Enhancement] Use cookies on a per-source basis (#354)

* Added 'use_cookies' column to source

* Added cookies to the source form

* Updated every command to optionally include cookies

* LOTS of tests

* Made YT cookies off by default

test/pinchflat/metadata/metadata_file_helpers_test.exs

@@ -2,11 +2,12 @@ defmodule Pinchflat.Metadata.MetadataFileHelpersTest do
   use Pinchflat.DataCase
 
   import Pinchflat.MediaFixtures
+  import Pinchflat.SourcesFixtures
 
   alias Pinchflat.Metadata.MetadataFileHelpers, as: Helpers
 
   setup do
-    media_item = media_item_fixture()
+    media_item = Repo.preload(media_item_fixture(), :source)
 
     {:ok, %{media_item: media_item}}
   end
@@ -61,7 +62,7 @@ defmodule Pinchflat.Metadata.MetadataFileHelpersTest do
 
   describe "download_and_store_thumbnail_for/2" do
     test "returns the filepath", %{media_item: media_item} do
-      stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot -> {:ok, ""} end)
+      stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot, _addl -> {:ok, ""} end)
 
       filepath = Helpers.download_and_store_thumbnail_for(media_item)
 
@@ -69,7 +70,7 @@ defmodule Pinchflat.Metadata.MetadataFileHelpersTest do
     end
 
     test "calls yt-dlp with the expected options", %{media_item: media_item} do
-      expect(YtDlpRunnerMock, :run, fn url, opts, ot ->
+      expect(YtDlpRunnerMock, :run, fn url, opts, ot, _addl ->
         assert url == media_item.original_url
         assert ot == "after_move:%()j"
 
@@ -87,8 +88,32 @@ defmodule Pinchflat.Metadata.MetadataFileHelpersTest do
       Helpers.download_and_store_thumbnail_for(media_item)
     end
 
+    test "sets use_cookies if the source uses cookies" do
+      expect(YtDlpRunnerMock, :run, fn _url, _opts, _ot, addl ->
+        assert {:use_cookies, true} in addl
+        {:ok, ""}
+      end)
+
+      source = source_fixture(%{use_cookies: true})
+      media_item = Repo.preload(media_item_fixture(%{source_id: source.id}), :source)
+
+      Helpers.download_and_store_thumbnail_for(media_item)
+    end
+
+    test "does not set use_cookies if the source does not use cookies" do
+      expect(YtDlpRunnerMock, :run, fn _url, _opts, _ot, addl ->
+        assert {:use_cookies, false} in addl
+        {:ok, ""}
+      end)
+
+      source = source_fixture(%{use_cookies: false})
+      media_item = Repo.preload(media_item_fixture(%{source_id: source.id}), :source)
+
+      Helpers.download_and_store_thumbnail_for(media_item)
+    end
+
     test "returns nil if yt-dlp fails", %{media_item: media_item} do
-      stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot -> {:error, "error"} end)
+      stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot, _addl -> {:error, "error"} end)
 
       filepath = Helpers.download_and_store_thumbnail_for(media_item)
 

test/pinchflat/metadata/source_metadata_storage_worker_test.exs

@@ -32,8 +32,8 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
   describe "perform/1" do
     test "won't call itself in an infinite loop" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
-        _url, _opts, ot when ot == @metadata_ot -> {:ok, "{}"}
+        _url, _opts, ot, _addl when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
+        _url, _opts, ot, _addl when ot == @metadata_ot -> {:ok, "{}"}
       end)
 
       source = source_fixture()
@@ -51,8 +51,8 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
   describe "perform/1 when testing attribute updates" do
     test "the source description is saved" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
-        _url, _opts, ot when ot == @metadata_ot -> {:ok, render_metadata(:channel_source_metadata)}
+        _url, _opts, ot, _addl when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
+        _url, _opts, ot, _addl when ot == @metadata_ot -> {:ok, render_metadata(:channel_source_metadata)}
       end)
 
       source = source_fixture(%{description: nil})
@@ -68,8 +68,8 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
   describe "perform/1 when testing metadata storage" do
     test "sets metadata location for source" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
-        _url, _opts, ot when ot == @metadata_ot -> {:ok, "{}"}
+        _url, _opts, ot, _addl when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
+        _url, _opts, ot, _addl when ot == @metadata_ot -> {:ok, "{}"}
       end)
 
       source = Repo.preload(source_fixture(), :metadata)
@@ -87,8 +87,8 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
       file_contents = Phoenix.json_library().encode!(%{"title" => "test"})
 
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
-        _url, _opts, ot when ot == @metadata_ot -> {:ok, file_contents}
+        _url, _opts, ot, _addl when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
+        _url, _opts, ot, _addl when ot == @metadata_ot -> {:ok, file_contents}
       end)
 
       perform_job(SourceMetadataStorageWorker, %{id: source.id})
@@ -100,8 +100,8 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
     test "sets metadata image location for source" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
-        _url, _opts, ot when ot == @metadata_ot -> {:ok, render_metadata(:channel_source_metadata)}
+        _url, _opts, ot, _addl when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
+        _url, _opts, ot, _addl when ot == @metadata_ot -> {:ok, render_metadata(:channel_source_metadata)}
       end)
 
       source = source_fixture()
@@ -118,8 +118,8 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
     test "stores metadata images for source" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
-        _url, _opts, ot when ot == @metadata_ot -> {:ok, render_metadata(:channel_source_metadata)}
+        _url, _opts, ot, _addl when ot == @source_details_ot -> {:ok, source_details_return_fixture()}
+        _url, _opts, ot, _addl when ot == @metadata_ot -> {:ok, render_metadata(:channel_source_metadata)}
       end)
 
       source = source_fixture()
@@ -138,12 +138,12 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
   describe "perform/1 when testing source image downloading" do
     test "downloads and stores source images" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot ->
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
           filename = Path.join([Application.get_env(:pinchflat, :media_directory), "Season 1", "bar.mp4"])
 
           {:ok, source_details_return_fixture(%{filename: filename})}
 
-        _url, opts, ot when ot == @metadata_ot ->
+        _url, opts, ot, _addl when ot == @metadata_ot ->
           assert {:convert_thumbnails, "jpg"} in opts
 
           {:ok, render_metadata(:channel_source_metadata)}
@@ -168,10 +168,10 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
     test "calls one set of yt-dlp metadata opts for channels" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot ->
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
           {:ok, source_details_return_fixture()}
 
-        _url, opts, ot when ot == @metadata_ot ->
+        _url, opts, ot, _addl when ot == @metadata_ot ->
           assert {:playlist_items, 0} in opts
           assert :write_all_thumbnails in opts
 
@@ -186,10 +186,10 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
     test "calls another set of yt-dlp metadata opts for playlists" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot ->
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
           {:ok, source_details_return_fixture()}
 
-        _url, opts, ot when ot == @metadata_ot ->
+        _url, opts, ot, _addl when ot == @metadata_ot ->
           assert {:playlist_items, 1} in opts
           assert :write_thumbnail in opts
 
@@ -204,12 +204,12 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
     test "does not store source images if the profile is not set to" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot ->
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
           filename = Path.join([Application.get_env(:pinchflat, :media_directory), "Season 1", "bar.mp4"])
 
           {:ok, source_details_return_fixture(%{filename: filename})}
 
-        _url, _opts, ot when ot == @metadata_ot ->
+        _url, _opts, ot, _addl when ot == @metadata_ot ->
           {:ok, render_metadata(:channel_source_metadata)}
       end)
 
@@ -226,12 +226,12 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
     test "does not store source images if the series directory cannot be determined" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot ->
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
           filename = Path.join([Application.get_env(:pinchflat, :media_directory), "foo", "bar.mp4"])
 
           {:ok, source_details_return_fixture(%{filename: filename})}
 
-        _url, _opts, ot when ot == @metadata_ot ->
+        _url, _opts, ot, _addl when ot == @metadata_ot ->
           {:ok, render_metadata(:channel_source_metadata)}
       end)
 
@@ -245,17 +245,49 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
       refute source.poster_filepath
       refute source.banner_filepath
     end
+
+    test "sets use_cookies if the source uses cookies" do
+      expect(YtDlpRunnerMock, :run, 2, fn
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
+          {:ok, source_details_return_fixture()}
+
+        _url, _opts, ot, addl when ot == @metadata_ot ->
+          assert {:use_cookies, true} in addl
+          {:ok, render_metadata(:channel_source_metadata)}
+      end)
+
+      profile = media_profile_fixture(%{download_source_images: true})
+      source = source_fixture(media_profile_id: profile.id, use_cookies: true)
+
+      perform_job(SourceMetadataStorageWorker, %{id: source.id})
+    end
+
+    test "does not set use_cookies if the source does not use cookies" do
+      expect(YtDlpRunnerMock, :run, 2, fn
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
+          {:ok, source_details_return_fixture()}
+
+        _url, _opts, ot, addl when ot == @metadata_ot ->
+          assert {:use_cookies, false} in addl
+          {:ok, render_metadata(:channel_source_metadata)}
+      end)
+
+      profile = media_profile_fixture(%{download_source_images: true})
+      source = source_fixture(media_profile_id: profile.id, use_cookies: false)
+
+      perform_job(SourceMetadataStorageWorker, %{id: source.id})
+    end
   end
 
   describe "perform/1 when determining the series_directory" do
     test "sets the series directory based on the returned media filepath" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot ->
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
           filename = Path.join([Application.get_env(:pinchflat, :media_directory), "Season 1", "bar.mp4"])
 
           {:ok, source_details_return_fixture(%{filename: filename})}
 
-        _url, _opts, ot when ot == @metadata_ot ->
+        _url, _opts, ot, _addl when ot == @metadata_ot ->
           {:ok, "{}"}
       end)
 
@@ -268,12 +300,12 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
     test "does not set the series directory if it cannot be determined" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot ->
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
           filename = Path.join([Application.get_env(:pinchflat, :media_directory), "foo", "bar.mp4"])
 
           {:ok, source_details_return_fixture(%{filename: filename})}
 
-        _url, _opts, ot when ot == @metadata_ot ->
+        _url, _opts, ot, _addl when ot == @metadata_ot ->
           {:ok, "{}"}
       end)
 
@@ -283,17 +315,45 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
       refute source.series_directory
     end
+
+    test "sets use_cookies if the source is set to use cookies" do
+      expect(YtDlpRunnerMock, :run, 2, fn
+        _url, _opts, ot, addl when ot == @source_details_ot ->
+          assert {:use_cookies, true} in addl
+          {:ok, source_details_return_fixture()}
+
+        _url, _opts, ot, _addl when ot == @metadata_ot ->
+          {:ok, "{}"}
+      end)
+
+      source = source_fixture(%{series_directory: nil, use_cookies: true})
+      perform_job(SourceMetadataStorageWorker, %{id: source.id})
+    end
+
+    test "does not set use_cookies if the source is not set to use cookies" do
+      expect(YtDlpRunnerMock, :run, 2, fn
+        _url, _opts, ot, addl when ot == @source_details_ot ->
+          assert {:use_cookies, false} in addl
+          {:ok, source_details_return_fixture()}
+
+        _url, _opts, ot, _addl when ot == @metadata_ot ->
+          {:ok, "{}"}
+      end)
+
+      source = source_fixture(%{series_directory: nil, use_cookies: false})
+      perform_job(SourceMetadataStorageWorker, %{id: source.id})
+    end
   end
 
   describe "perform/1 when storing the series NFO" do
     test "stores the NFO if specified" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot ->
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
           filename = Path.join([Application.get_env(:pinchflat, :media_directory), "Season 1", "bar.mp4"])
 
           {:ok, source_details_return_fixture(%{filename: filename})}
 
-        _url, _opts, ot when ot == @metadata_ot ->
+        _url, _opts, ot, _addl when ot == @metadata_ot ->
           {:ok, "{}"}
       end)
 
@@ -311,12 +371,12 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
     test "does not store the NFO if not specified" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot ->
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
           filename = Path.join([Application.get_env(:pinchflat, :media_directory), "Season 1", "bar.mp4"])
 
           {:ok, source_details_return_fixture(%{filename: filename})}
 
-        _url, _opts, ot when ot == @metadata_ot ->
+        _url, _opts, ot, _addl when ot == @metadata_ot ->
           {:ok, "{}"}
       end)
 
@@ -330,12 +390,12 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
     test "does not store the NFO if the series directory cannot be determined" do
       stub(YtDlpRunnerMock, :run, fn
-        _url, _opts, ot when ot == @source_details_ot ->
+        _url, _opts, ot, _addl when ot == @source_details_ot ->
           filename = Path.join([Application.get_env(:pinchflat, :media_directory), "foo", "bar.mp4"])
 
           {:ok, source_details_return_fixture(%{filename: filename})}
 
-        _url, _opts, ot when ot == @metadata_ot ->
+        _url, _opts, ot, _addl when ot == @metadata_ot ->
           {:ok, "{}"}
       end)