Merge pull request #139 from phyzical/hotfix/fix-episode-type

flag for manual logic option
SwapnilSoni1999 · Oct 16, 2021 · 5aafb69 · 5aafb69
2 parents b651262 + 9689e17
commit 5aafb69
Show file tree

Hide file tree

Showing 7 changed files with 75 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -71,26 +71,30 @@ $ spotifydl https://open.spotify.com/track/xyz
 ```
 
 #### Options
-| Flag  | Long Flag         | Usage                                                                 |
-| ----- | ----------------- | --------------------------------------------------------------------- |
-| --o   | --output          | takes valid output path argument                                      |
-| --es  | --extra-search    | takes extra search string/term to be used for youtube search          |
-| --oo  | --output-only     | enforces all downloaded songs in the output dir                       |
-| --st  | --saved-tracks    | download spotify saved tracks                                         |
-| --ss  | --saved-songs     | download spotify saved shows                                          |
-| --sp  | --saved-playlists | download spotify saved playlists                                      |
-| --sa  | --saved-albums    | download spotify saved albums                                         |
-| --u   | --username        | spotify username (only needed in non tty)                             |
-| --p   | --password        | spotify password (only needed in non tty)                             |
-| --cf  | --cache-file      | takes valid output file name path argument                            |
-| --dr  | --download-report | output a download report of what files failed                         |
-| --cof | --cookie-file     | takes valid file name path argument to a txt file for youtube cookies |
-| --v   | --version         | returns current version                                               |
-| --h   | --help            | outputs help text                                                     |
+| Flag  | Long Flag         | Usage                                                                   |
+| ----- | ----------------- | ----------------------------------------------------------------------- |
+| --o   | --output          | takes valid output path argument                                        |
+| --es  | --extra-search    | takes extra search string/term to be used for youtube search            |
+| --oo  | --output-only     | enforces all downloaded songs in the output dir                         |
+| --st  | --saved-tracks    | download spotify saved tracks                                           |
+| --ss  | --saved-songs     | download spotify saved shows                                            |
+| --sp  | --saved-playlists | download spotify saved playlists                                        |
+| --sa  | --saved-albums    | download spotify saved albums                                           |
+| --l   | --login           | Requests a login in an external window (non tty should use --u and --p) |
+| --u   | --username        | spotify username for headless long                                      |
+| --p   | --password        | spotify password                                                        |
+| --cf  | --cache-file      | takes valid output file name path argument                              |
+| --dr  | --download-report | output a download report of what files failed                           |
+| --cof | --cookie-file     | takes valid file name path argument to a txt file for youtube cookies   |
+| --v   | --version         | returns current version                                                 |
+| --h   | --help            | outputs help text                                                       |
 <hr>
 
 ## Notes
 
+if you receive 'Got a spotify api error WebapiRegularError: An error occurred while communicating with Spotify's Web API
+Details: non existing id'  you may need to provide auth either use `--l` for manual login prompt or `--u username --p password` for headless login
+
 If you receive a 429 error please provide a cookies file given the `--cof` flag, to generate a cookies file please refer to [Chrome](https://chrome.google.com/webstore/detail/njabckikapfpffapmjgojcnbfjonfjfg) or [Firefox](https://github.com/rotemdan/ExportCookies)
 
 ## Docker

diff --git a/config.js b/config.js
@@ -8,6 +8,7 @@ export default {
     downloadReport: true,
     output: process.cwd(),
     extraSearch: '',
+    login: false,
     password: '',
     username: '',
     savedAlbums: false,
@@ -16,4 +17,9 @@ export default {
     savedShows: false,
     outputOnly: false,
   },
+  spotifyApi: {
+    clientId: 'acc6302297e040aeb6e4ac1fbdfd62c3',
+    clientSecret: '0e8439a1280a43aba9a5bc0a16f3f009',
+  },
+  isTTY: process.stdout.isTTY,
 };
diff --git a/lib/api.js b/lib/api.js
@@ -3,9 +3,17 @@ import open from 'open';
 import express from 'express';
 import puppeteer from 'puppeteer';
 import { cliInputs } from './setup.js';
+import Config from '../config.js';
 import Constants from '../util/constants.js';
 import { logInfo, logFailure } from '../util/log-helper.js';
 
+const {
+  spotifyApi: {
+    clientId,
+    clientSecret,
+  },
+} = Config;
+
 const {
   AUTH: {
     SCOPES: {
@@ -21,8 +29,8 @@ const {
 } = Constants;
 
 const spotifyApi = new SpotifyWebApi({
-  clientId: 'acc6302297e040aeb6e4ac1fbdfd62c3',
-  clientSecret: '0e8439a1280a43aba9a5bc0a16f3f009',
+  clientId,
+  clientSecret,
   redirectUri: `http://${HOST}:${PORT}${CALLBACK_URI}`,
 });
 
@@ -62,6 +70,7 @@ const checkCredentials = async () => {
       inputs,
       username,
       password,
+      login,
     } = cliInputs();
 
     const requiresLogin = inputs.find(input =>
@@ -71,7 +80,7 @@ const checkCredentials = async () => {
       input.type == INPUT_TYPES.EPISODE.SAVED_SHOWS,
     );
 
-    const requestingLogin = username && password;
+    const requestingLogin = (username && password) || login;
 
     if (requiresLogin || requestingLogin) {
       await requestAuthorizedTokens();
@@ -106,6 +115,10 @@ const requestAuthorizedTokens = async () => {
 
   let browser = null;
 
+  logInfo(
+    'Performing Spotify Auth Please Wait...',
+  );
+
   if (autoLogin) {
     browser = await puppeteer.launch({
       headless: true,
@@ -344,6 +357,7 @@ export async function extractEpisodes(episodeIds) {
         chunkedEpisodes[x],
       )).body.episodes,
     );
+    episodesResult = episodesResult.filter(episode => episode);
     episodes.push(...episodesResult);
   }
   return episodes.map(episode => parseEpisode(episode));

diff --git a/lib/downloader.js b/lib/downloader.js
@@ -10,6 +10,7 @@ import {
   logStart, updateSpinner, logInfo, logSuccess,
 } from '../util/log-helper.js';
 
+const { youtubeDLConfig, isTTY } = Config;
 const sponsorBlock = new SponsorBlock(1234);
 const {
   SPONSOR_BLOCK: {
@@ -75,15 +76,13 @@ const sponsorComplexFilter = async link => {
 const progressFunction = (_, downloaded, total) => {
   const downloadedMb = (downloaded / 1024 / 1024).toFixed(2);
   const toBeDownloadedMb = (total / 1024 / 1024).toFixed(2);
-  const isTTY = process.stdout.isTTY;
   const downloadText = `Downloaded ${downloadedMb}/${toBeDownloadedMb} MB`;
   if (isTTY || (downloadedMb % 1 == 0 || toBeDownloadedMb == downloadedMb)) {
     updateSpinner(downloadText);
   }
 };
 
 const getYoutubeDLConfig = () => {
-  const config = Config.youtubeDLConfig;
   const { cookieFile } = cliInputs();
   if (fs.existsSync(cookieFile)) {
     const cookieFileContents = fs
@@ -97,13 +96,13 @@ const getYoutubeDLConfig = () => {
         return cookie;
       }, '')
       .trim();
-    config.requestOptions = {
+    youtubeDLConfig.requestOptions = {
       headers: {
         Cookie: cookieFileContents,
       },
     };
   }
-  return config;
+  return youtubeDLConfig;
 };
 
 /**

diff --git a/lib/setup.js b/lib/setup.js
@@ -63,7 +63,7 @@ export function cliInputs() {
     if ((flags.savedAlbums ||
       flags.savedPlaylists ||
       flags.savedShows ||
-      flags.savedSongs) && !process.stdout.isTTY
+      flags.savedSongs) && !Config.isTTY
     ) {
       return true;
     }
@@ -145,6 +145,17 @@ export function cliInputs() {
         'eg. $ spotifydl <url> --extra-search "lyrics"',
       ],
     },
+    login: {
+      alias: 'l',
+      type: 'boolean',
+      default: flagsConfig.login,
+      helpText: [
+        '--login or -l',
+        '* will perform a spotify login in an external window for permission',
+        '* allows spotify premium access restricted things',
+        'eg. $ spotifydl --l',
+      ],
+    },
     username: {
       alias: 'u',
       type: 'string',
@@ -302,6 +313,7 @@ export function cliInputs() {
     cookieFile: inputFlags.cookieFile,
     downloadReport: inputFlags.downloadReport,
     outputOnly: inputFlags.outputOnly,
+    login: inputFlags.login,
     username: inputFlags.username,
     password: inputFlags.password,
   };

diff --git a/util/log-helper.js b/util/log-helper.js
@@ -1,4 +1,5 @@
 import ora from 'ora';
+import Config from '../config.js';
 
 const spinner = ora('Searching… Please be patient :)\n').start();
 
@@ -19,7 +20,7 @@ export function logFailure(message) {
 }
 
 export function updateSpinner(message) {
-  if (process.stdout.isTTY) {
+  if (Config.isTTY) {
     spinner.text = message;
   } else {
     spinner.info(message);

diff --git a/util/runner.js b/util/runner.js
@@ -158,13 +158,20 @@ const run = async () => {
       }
       case INPUT_TYPES.EPISODE.EPISODE: {
         const episode = await getEpisode(URL);
-        lists.push({
-          items: [
-            episode,
-          ],
-          name: `${episode.name} ${episode.album_name}`,
-          type: input.type,
-        });
+        if (episode) {
+          lists.push({
+            items: [
+              episode,
+            ],
+            name: `${episode.name} ${episode.album_name}`,
+            type: input.type,
+          });
+        } else {
+          logFailure(
+            'Failed to find episode, you may need to use auth',
+          );
+        }
+
         break;
       }
       case INPUT_TYPES.EPISODE.SHOW: {