SCRAPER: When scanning series, re-rank IMDB search results so that tv-series are higher than movies when detecting the IMDB entry

  - closes #61

increase version to v1.4.0-b6

Author: theMK2k

DONE.md

@@ -2,17 +2,33 @@
 
 ## next (v1.4.0-b6)
 
-## v1.4.0-b5
+## v1.4.0-b6
 
-## Features
+## IMDB Scraper
+
+- [x] SCRAPER: When scanning series, re-rank IMDB search results so that tv-series are higher than movies when detecting the IMDB entry
+  - closes #61
+
+# Older Releases (click to expand)
+
+<details>
+  <summary>v1.4.0-b5</summary>
+
+## Features (v1.4.0-b5)
 
 - [x] FEAT: do an update check on the beta channel if the build is a beta build
 
 A beta build (like this one) will now do version checks against other beta builds and tell you if a newer beta build is available. The link for downloading is also pointing to the beta releases (and not the Media Hoarder website's download section).
 
 ![image](https://github.com/theMK2k/Media-Hoarder/assets/16878526/63dadfb6-a7cc-4357-b956-91ee852d0226)
 
-# Older Releases (click to expand)
+## Misc (v1.4.0-b5)
+
+- [x] DB Migrations
+  - [x] new table: tbl_DB_Migrations
+  - [x] implement migration runner
+
+</details>
 
 <details>
   <summary>v1.4.0-b4</summary>

TODO.md

@@ -6,11 +6,6 @@
 
 - [ ] cancel loading filters on series -> episodes change
 
-- [ ] DB Migrations
-
-  - [x] new table: tbl_DB_Migrations
-  - [ ] implement migration runner
-
 - [WIP] introduce HDR (detect with color spaces, e.g. <https://www.reddit.com/r/PleX/comments/7kwoy8/is_there_a_way_to_tell_if_a_file_is_hdr_from_the/>)
 
   - "HDR10", "HDR10+", "DV", "HLG"
@@ -63,9 +58,9 @@
 - [ ] rescanHandleDuplicates (also provide snackbar progress for this)
 - [ ] investigate with series-generator: find possible multitudes of episode numbers (also: episode == null)
   - [ ] if this is the case: we need a better getSeriesEpisodeTconstFromCache, possibly by utilizing levenshtein between filename and imdb's episode title
-- #51 Found work around for custom shows and episodes
-- #39 Multipart Episodes
-- #36 Mediainfo always opening
+- [ ] #51 Found work around for custom shows and episodes
+- [ ] #39 Multipart Episodes
+- [ ] #36 Mediainfo always opening
 
 ### Series: Link IMDB Dialog
 
@@ -93,6 +88,7 @@
 - [ ] we apparently do not use the timezone (we store in UTC)
 - [ ] scanErrors:
   - [ ] review how rescan and applyIMDB handle scanErrors (string to object, handle null)
+  - [ ] artificially test graphql not found errors
   - [ ] introduce WARNING vs. ERROR
     - WARNING:
       - imdb implausibility

docs/10-Release-Preparation.md

@@ -8,7 +8,7 @@ This document describes the steps necessary to get a new release done.
 - [ ] Increase Version Number in [../package.json](../package.json)
 - [ ] create `public/history/version-x.y.z.md` from info in [../DONE.md](../DONE.md)
 - [ ] Update history.json (create new entry on top of the others in the array)
-- [ ] Test using `npm start` - it should show the new version incl. history
+- [ ] Test using `npm run dev[:beta]` - it should show the new version incl. history
 - [ ] git push
 
 ## Build Packs

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "media-hoarder",
-  "version": "1.4.0-b5",
+  "version": "1.4.0-b6",
   "private": true,
   "description": "Media Hoarder - THE media frontend for data hoarders and movie lovers",
   "author": "mk2k <[email protected]> (https://media.hoarder.software)",
@@ -9,6 +9,9 @@
     "build": "vue-cli-service build",
     "lint": "vue-cli-service lint",
     "audit": "npm audit --production",
+    "dev:beta": "check-node-version --node ^14.17 && bash ./apply-monkeypatches.sh && vue invoke electron-builder && npx dotenv-cli -e .env.beta vue-cli-service electron:serve",
+    "dev:lite": "check-node-version --node ^14.17 && bash ./apply-monkeypatches.sh && vue-cli-service electron:serve",
+    "dev:stable": "check-node-version --node ^14.17 && bash ./apply-monkeypatches.sh && vue invoke electron-builder && npx dotenv-cli -e .env vue-cli-service electron:serve",
     "electron:build": "vue-cli-service electron:build",
     "electron:build-linux-portable": "check-node-version --node ^14.17 && bash check-killme.sh && bash check-package.json.sh && bash ./apply-monkeypatches.sh && npx mkdirp RELEASE && node set-portable --portable=true && vue-cli-service electron:build --linux && mv dist_electron/linux-unpacked media-hoarder-portable && npx bestzip RELEASE/media-hoarder-VERSION-linux-x64-portable.zip media-hoarder-portable && npx rimraf media-hoarder-portable && node set-portable --portable=false && node set-release-version.js && rimraf dist_electron",
     "electron:build-linux-setup": "check-node-version --node ^14.17 && bash check-killme.sh && bash check-package.json.sh && bash ./apply-monkeypatches.sh && npx mkdirp RELEASE && node set-portable --portable=false && vue-cli-service electron:build --linux deb appimage snap rpm && mv dist_electron/*.deb RELEASE/media-hoarder-VERSION-linux-x64.deb && mv dist_electron/*.AppImage RELEASE/media-hoarder-VERSION-linux-x64.AppImage && mv dist_electron/*.snap RELEASE/media-hoarder-VERSION-linux-x64.snap && mv dist_electron/*.rpm RELEASE/media-hoarder-VERSION-linux-x64.rpm && node set-release-version.js && rimraf dist_electron",
@@ -33,9 +36,6 @@
     "postinstall": "electron-builder install-app-deps",
     "postuninstall": "electron-builder install-app-deps",
     "publish": "vue-cli-service electron:build -p always",
-    "start": "check-node-version --node ^14.17 && bash ./apply-monkeypatches.sh && vue invoke electron-builder && npx dotenv-cli -e .env vue-cli-service electron:serve",
-    "start:beta": "check-node-version --node ^14.17 && bash ./apply-monkeypatches.sh && vue invoke electron-builder && npx dotenv-cli -e .env.beta vue-cli-service electron:serve",
-    "start:lite": "check-node-version --node ^14.17 && bash ./apply-monkeypatches.sh && vue-cli-service electron:serve",
     "test": "jest"
   },
   "main": "background.js",

package.json

@@ -1,6 +1,6 @@
 [
   {
-    "version": "1.4.0-b5",
+    "version": "1.4.0-b6",
     "name": "Jean-Luc Picard",
     "quote": "Make it so.",
     "quoteSource": "Star Trek: The Next Generation (1987-1994)",

public/history/history.json

@@ -79,12 +79,19 @@ export async function findIMDBtconstInNFO(movie) {
 
 /**
  * Find an IMDB tconst based on the movie's name (also checks possible release years contained in the name)
- * @param {Object} movie
+ * @param {Object} mediaItem
  * @param {Object} options
  * @returns {String|Object} with options.returnAnalysisData = true, returns an object with analysis data, else the tconst (or empty string if tconst could't be found)
  */
-export async function findIMDBtconstByFileOrDirname(movie, options) {
-  logger.log("[findIMDBtconstByFileOrDirname] START movie.isDirectoryBased", movie.isDirectoryBased, "movie:", movie);
+export async function findIMDBtconstByFileOrDirname(mediaItem, options) {
+  // TODO: utilize mediaItem.MediaType ("movies" or "series") to rank the IMDB search results
+
+  logger.log(
+    "[findIMDBtconstByFileOrDirname] START mediaItem.isDirectoryBased",
+    mediaItem.isDirectoryBased,
+    "mediaItem:",
+    mediaItem
+  );
 
   if (!options) {
     options = {
@@ -112,18 +119,20 @@ export async function findIMDBtconstByFileOrDirname(movie, options) {
   };
 
   try {
-    logger.log("[findIMDBtconstByFileOrDirname] movie.isDirectoryBased", movie.isDirectoryBased);
-    const arrYears = movie.isDirectoryBased
+    logger.log("[findIMDBtconstByFileOrDirname] movie.isDirectoryBased", mediaItem.isDirectoryBased);
+    const arrYears = mediaItem.isDirectoryBased
       ? helpers.getYearsFromFileName(
-          helpers.getLastDirectoryName(movie.MediaType === "series" ? movie.fullPath : movie.fullDirectory),
+          helpers.getLastDirectoryName(mediaItem.MediaType === "series" ? mediaItem.fullPath : mediaItem.fullDirectory),
           false
         )
-      : helpers.getYearsFromFileName(movie.Filename, false);
+      : helpers.getYearsFromFileName(mediaItem.Filename, false);
 
     const name = (
-      movie.isDirectoryBased
-        ? helpers.getMovieNameFromDirectory(movie.MediaType === "series" ? movie.fullPath : movie.fullDirectory)
-        : helpers.getMovieNameFromFileName(movie.Filename)
+      mediaItem.isDirectoryBased
+        ? helpers.getMovieNameFromDirectory(
+            mediaItem.MediaType === "series" ? mediaItem.fullPath : mediaItem.fullDirectory
+          )
+        : helpers.getMovieNameFromFileName(mediaItem.Filename)
     )
       .replace(/\([^)]*?\)/g, "")
       .replace(/\[[^\]]*?\]/g, "")
@@ -145,6 +154,7 @@ export async function findIMDBtconstByFileOrDirname(movie, options) {
       let results = await scrapeIMDBFindPageSearchV3(searchTerm, options.category === "title" ? "tt" : null);
 
       logger.log(`[findIMDBtconstByFileOrDirname] ${results.length} results found for "${searchTerm}"`);
+      logger.log(`[findIMDBtconstByFileOrDirname] results:`, JSON.parse(JSON.stringify(results)));
       stats.numResults = results.length;
 
       if (results.length === 0) {
@@ -174,6 +184,16 @@ export async function findIMDBtconstByFileOrDirname(movie, options) {
         }
       }
 
+      // When scanning a Series source path, re-rank results so that TV Series are preferred
+      if (mediaItem.MediaType === "series") {
+        logger.log("[findIMDBtconstByFileOrDirname] re-ranking results according to TV Series");
+        results = results.sort((a, b) => {
+          return a.title.includes("(TV Series)") && !b.title.includes("(TV Series)") ? -1 : 0;
+        });
+
+        logger.log("[findIMDBtconstByFileOrDirname] re-ranked results:", results);
+      }
+
       // filter by year match
       if (results.length > 1) {
         // losely year match (+/- 1 year allowed)
@@ -205,7 +225,7 @@ export async function findIMDBtconstByFileOrDirname(movie, options) {
       }
 
       // filter by runtime, but only use the first 10 items due to traffic
-      if (results.length > 1 && movie.MI_Duration_Seconds) {
+      if (results.length > 1 && mediaItem.MI_Duration_Seconds) {
         let counter = 0;
         for (let result of results) {
           counter++;
@@ -219,7 +239,7 @@ export async function findIMDBtconstByFileOrDirname(movie, options) {
           if (imdbData.$IMDB_runtimeMinutes) {
             const runtimeSeconds = imdbData.$IMDB_runtimeMinutes ? parseInt(imdbData.$IMDB_runtimeMinutes) * 60 : null;
 
-            result.runtimeDiff = runtimeSeconds ? Math.abs(movie.MI_Duration_Seconds - runtimeSeconds) : null;
+            result.runtimeDiff = runtimeSeconds ? Math.abs(mediaItem.MI_Duration_Seconds - runtimeSeconds) : null;
 
             if (result.runtimeDiff !== null) {
               stats.runtimematch = true;
@@ -228,7 +248,7 @@ export async function findIMDBtconstByFileOrDirname(movie, options) {
               }
             }
 
-            if (result.runtimeDiff < movie.MI_Duration_Seconds * 0.02) {
+            if (result.runtimeDiff < mediaItem.MI_Duration_Seconds * 0.02) {
               break; // the runtime matches at least to 98%, which is a window of 2 minutes if the movie has a runtime of 100 minutes
             }
           } else {