yt-grabber 1.8.6 → 1.8.7

package/README.md

@@ -28,8 +28,10 @@ Each download can be customized to your needs for easy workflow automation.
 - [Running](#running)
 - [Packaging](#packaging)
 - [Testing](#testing)
+- [Debugging](#debugging)
 - [License](#license)
 - [Legal Disclaimer](#legal-disclaimer)
+- [Support Disclaimer](#support-disclaimer)
 
 
 ## Features
@@ -111,6 +113,12 @@ To execute unit tests run `npm test` or `yarn test` command (unit tests are also
 
 To execute end2end tests run `npm playwright test` or `yarn playwright test` command.
 
+## Debugging
+
+Logs are written to `init.log` and `application.log` files.
+By default only errors are logged.
+To get more detailed logs run the application with `--debug-mode` arguments.
+
 ## License
 
 This project is licensed under the [MIT License](LICENSE).
@@ -118,3 +126,9 @@ This project is licensed under the [MIT License](LICENSE).
 ## Legal Disclaimer
 
 All music files downloaded through this software must be legally owned and purchased by the user. By downloading music via this software, you represent that you have purchased and fully own the rights to any downloaded content or an active subscription to YouTube Music. Downloading or distributing pirated or illegal music copies is strictly prohibited. I claim no ownership rights to any downloaded music files - all such rights remain with the content owner. I accept no liability for the illegal use of any files downloaded through this software.
+
+## Support Disclaimer
+
+In the era of greedy services like Spotify, omnipresent AI slop and other bs it is very difficult, especially for younger, less recognizable creators to make money off of their creations. There are a lot of talented people who struggle with that (and their number is growing).
+If you like certain artists and value their content please show them your support.
+Thank You!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yt-grabber",
-  "version": "1.8.6",
+  "version": "1.8.7",
   "description": "Youtube Grabber - robust desktop application designed to retrieve multimedia from YouTube and YouTube Music services",
   "keywords": [
     "youtube",
@@ -121,6 +121,7 @@
     "react-router-dom": "^7.9.4",
     "usehooks-ts": "^3.1.1",
     "win-version-info": "^6.0.1",
+    "winston": "^3.18.3",
     "yt-dlp-wrap": "^2.3.12"
   },
   "devDependencies": {

package/src/@types/global.d.ts

@@ -1,10 +1,11 @@
 import ElectronStore from "electron-store";
 
+import {ILogger} from "../common/Logger";
 import {IStore} from "../common/Store";
 
 declare global {
     var store: ElectronStore<IStore>;
-
+    var logger: ILogger;
     interface Global {
     [key: string]: any;
   }

package/src/common/Helpers.ts

@@ -1,4 +1,5 @@
-import {groupBy, includes, indexOf, isNumber, keys, map, replace} from "lodash-es";
+import {App} from "electron";
+import {forEach, groupBy, includes, indexOf, isNumber, keys, map, replace} from "lodash-es";
 
 import {VideoType} from "./Media";
 import {TrackInfo, UrlType, YoutubeInfoResult} from "./Youtube";
@@ -11,6 +12,30 @@ type NonDataAttributes<T> = Omit<T, keyof DataAttributes<T>>;
 
 export const isDev = () => process.env.NODE_ENV === "development";
 
+export const isDevApplication = (app: App) => !app.isPackaged;
+
+export const isDebugMode = () => {
+    const args = getProcessArgs();
+    
+    return args["debug-mode"] === true;
+};
+
+export const getProcessArgs = () => {
+    const args = process.argv.slice(1);
+    const filteredArgs: Record<string, string | boolean> = {};
+    
+    forEach(args, (arg) => {
+        if (arg.startsWith("--")) {
+            const argWithoutPrefix = arg.slice(2);
+            const [key, value] = argWithoutPrefix.split("=");
+            
+            filteredArgs[key] = value !== undefined ? value : true;
+        }
+    });
+
+    return filteredArgs;
+};
+
 export const formatFileSize = (sizeInBytes: number, decimals = 2) => {
     if (!isNumber(sizeInBytes)) return "";
     if (sizeInBytes === 0) return "0 Bytes";

package/src/common/Logger.ts

@@ -0,0 +1,73 @@
+import {
+    createLogger as createWinston, format, LeveledLogMethod, Logger, LoggerOptions, transport,
+    transports
+} from "winston";
+
+export interface ILoggerOptions extends LoggerOptions {
+    logFile?: boolean;
+    logFilePath?: string;
+};
+
+export interface ILogger extends Logger {
+    success: LeveledLogMethod;
+};
+
+const levels = {
+    error: 0,
+    warn: 1,
+    success: 1,
+    info: 3,
+    verbose: 4,
+    debug: 5,
+};
+
+const colorizer = format.colorize({
+    colors: {
+        error: "red",
+        warn: "yellow",
+        success: "green",
+        info: "blue",
+        verbose: "grey",
+        debug: "magenta",
+    },
+});
+
+const timeFormat = format.timestamp({format: "HH:mm:ss:SSS"});
+const fileFormat = format.printf(({level, message, timestamp, ...meta}) => {
+    const metaString = Object.keys(meta).length ? ` ${JSON.stringify(meta)}` : "";
+    
+    return `${timestamp} [${level.toUpperCase()}]: ${message} ${metaString}`;
+});
+const consoleFormat = format.printf(({level, message, timestamp, ...meta}) => {
+    const metaString = Object.keys(meta).length ? ` ${JSON.stringify(meta)}` : "";
+    const symbols = Object.getOwnPropertySymbols(meta);
+    const splatSymbol = symbols.find(sym => sym.description === "splat");
+
+    if (splatSymbol && typeof message === "string") {
+        const splat = meta[splatSymbol] as any[];
+
+        for (const item of splat) {
+            message = (message as string).replace(item, (match) => colorizer.colorize("verbose", match));
+        }
+    }
+    
+    return `${timestamp} [${colorizer.colorize(level, level.toUpperCase())}]: ${message}${colorizer.colorize("verbose", metaString)}`;
+});
+
+export const createLogger = (options: ILoggerOptions): ILogger => {
+    const {level = "error", logFile, logFilePath = "log.log"} = options;
+    const transportsArray: transport[] = [
+        new transports.Console({format: format.combine(format.splat(), timeFormat, consoleFormat), level})
+    ];
+
+    if (logFile) {
+        transportsArray.push(new transports.File({filename: logFilePath, level, format: format.combine(format.splat(), timeFormat, fileFormat)}));
+    }
+
+    return createWinston({
+        level,
+        levels,
+        format: format.combine(timeFormat, format.json()),
+        transports: transportsArray,
+    }) as ILogger;
+};

package/src/components/languagePicker/LanguagePicker.tsx

@@ -1,5 +1,5 @@
 import classnames from "classnames";
-import $_ from "lodash";
+import {defaultTo, get, isEqual, map, without} from "lodash-es";
 import moment from "moment";
 import path from "path";
 import React, {HTMLAttributes, useState} from "react";
@@ -38,9 +38,9 @@ export const LanguagePicker = (props: LanguagePickerProps) => {
     const { i18n } = useTranslation();
     const [loading, setLoading] = useState(false);
     const [anchorEl, setAnchorEl] = React.useState<null | HTMLElement>(null);
-    const langs = $_.get(i18n, "options.supportedLngs");
-    const availableLocales: string[] = !langs ? [] : $_.without(langs, "cimode").sort();
-    const displayMode = $_.defaultTo(
+    const langs = get(i18n, "options.supportedLngs");
+    const availableLocales: string[] = !langs ? [] : without(langs, "cimode").sort();
+    const displayMode = defaultTo(
         mode,
         useMediaQuery((theme: Theme) => theme.breakpoints.down("md"))
             ? ComponentDisplayMode.Minimal
@@ -58,7 +58,7 @@ export const LanguagePicker = (props: LanguagePickerProps) => {
     const onTriggerClick = (event: React.MouseEvent<HTMLButtonElement>) => setAnchorEl(event.currentTarget);
 
     const onItemClick = async (lang: string) => {
-        if (!$_.isEqual(lang, i18n.language)) {
+        if (!isEqual(lang, i18n.language)) {
             setLoading(true);
             i18n.changeLanguage(lang, () => setLoading(false));
             moment.locale(lang);
@@ -81,7 +81,7 @@ export const LanguagePicker = (props: LanguagePickerProps) => {
                     open={Boolean(anchorEl)}
                     onClose={onClose}
                 >
-                    {$_.map(availableLocales, (item) => (
+                    {map(availableLocales, (item) => (
                         <LanguagePickerItem
                             key={item}
                             lang={item}

package/src/components/numberField/NumberField.tsx

@@ -1,4 +1,4 @@
-import $_ from "lodash";
+import {defaultTo, isUndefined, max as _max, min as _min, toNumber} from "lodash-es";
 import React, {useEffect, useState} from "react";
 import {NumberFormatValues, NumericFormat, NumericFormatProps} from "react-number-format";
 import {useInterval} from "usehooks-ts";
@@ -53,7 +53,7 @@ export const NumberField = (props: INumberFieldProps) => {
         () => {
             if (decreasePressed) onDecreaseClick();
             if (increasePressed) onIncreaseClick();
-            setDelay($_.max([50, delay - 50]));
+            setDelay(_max([50, delay - 50]));
         },
         decreasePressed || increasePressed ? delay : null,
     );
@@ -63,15 +63,15 @@ export const NumberField = (props: INumberFieldProps) => {
     };
 
     const onDecreaseClick = () => {
-        const predicted = $_.toNumber(value) - $_.toNumber(step);
+        const predicted = toNumber(value) - toNumber(step);
 
-        setText(loop && predicted < min ? max : $_.max([predicted, min]));
+        setText(loop && predicted < min ? max : _max([predicted, min]));
     };
 
     const onIncreaseClick = () => {
-        const predicted = $_.toNumber(value) + $_.toNumber(step);
+        const predicted = toNumber(value) + toNumber(step);
         
-        setText(loop && predicted > max ? min : $_.min([predicted, max]));
+        setText(loop && predicted > max ? min : _min([predicted, max]));
     };
 
     const onDecreaseMouseDown = () => {
@@ -93,7 +93,7 @@ export const NumberField = (props: INumberFieldProps) => {
     };
 
     const isAllowed = (values: NumberFormatValues) => {        
-        if ($_.isUndefined(values.floatValue) && !allowEmpty) {
+        if (isUndefined(values.floatValue) && !allowEmpty) {
             return false;
         };
 
@@ -101,7 +101,7 @@ export const NumberField = (props: INumberFieldProps) => {
     };
 
     useEffect(() => {
-        const value = $_.toNumber(text) ?? 0;
+        const value = toNumber(text) ?? 0;
 
         if (onChange) {
             onChange(value);
@@ -146,7 +146,7 @@ export const NumberField = (props: INumberFieldProps) => {
                     label,
                     style: {textAlign: "center", width},
                 },
-                inputLabel: $_.defaultTo(inputLabelProps, {className: "upperfirst"})
+                inputLabel: defaultTo(inputLabelProps, {className: "upperfirst"})
             }}
             customInput={TextField}
             variant="outlined"

package/src/hooks/useHelp.ts

@@ -40,7 +40,7 @@ const useHelp = () => {
                 try {
                     dest.style[key as any] = computedStyle.getPropertyValue(key);
                 } catch (error) {
-                    console.log(error);
+                    logger.error("Error copying style property '%s': %O", key, error);
                 }
             }
         };

package/src/index.ts

@@ -4,24 +4,32 @@ import electronReload from "electron-reload";
 import Store from "electron-store";
 import path from "path";
 
+import {isDebugMode, isDevApplication} from "./common/Helpers";
+import {createLogger} from "./common/Logger";
 import {MessagingService} from "./messaging/MessagingService";
 
-const isDev = () => !app.isPackaged;
+const logger = createLogger({
+    level: isDebugMode() ? "debug" : "error",
+    logFile: true,
+    logFilePath: "init.log",
+});
 
-if (isDev()) {
+if (isDevApplication(app)) {
     electronReload(__dirname, {
         electron: path.join(__dirname, "..", "node_modules", "electron", "dist", "electron.exe"),
         interval: 2000,
     });
-}
 
-/* Alternative reload using different electron binary */
+    /* Alternative reload using different electron binary */
 
-// require("electron-reload")(__dirname, {
-//     electron: path.join(__dirname, "..", "node_modules", ".bin", "electron.cmd"),
-//     hardReset: true,
-//     livenessThreshold: 2000,
-// });
+    // require("electron-reload")(__dirname, {
+    //     electron: path.join(__dirname, "..", "node_modules", ".bin", "electron.cmd"),
+    //     hardReset: true,
+    //     livenessThreshold: 2000,
+    // });
+
+    logger.debug("Electron reload initialized.");
+}
 
 let mainWindow: BrowserWindow | null;
 
@@ -41,9 +49,11 @@ const createWindow = async () => {
         },
     });
     mainWindow.loadFile(path.join(__dirname, "index.html"));
+    logger.debug("Main window created.");
 
-    if (isDev()) {
-        mainWindow.webContents.openDevTools({mode: "detach",});
+    if (isDevApplication(app)) {
+        mainWindow.webContents.openDevTools({mode: "detach"});
+        logger.debug("DevTools opened.");
     } else {
         mainWindow.removeMenu();
         mainWindow.setMenu(null);
@@ -51,9 +61,12 @@ const createWindow = async () => {
 
     mainWindow.on("closed", () => {
         mainWindow = null;
+        logger.debug("Main window closed.");
     });
     
+
     const messaggingService = new MessagingService(ipcMain, mainWindow);
+    logger.debug("Messaging service initialized.");
 };
 
 app.on("ready", createWindow);
@@ -77,9 +90,9 @@ app.on("before-quit", () => {
 });
 
 app.whenReady().then(() => {
-    if (isDev()) {
+    if (isDevApplication(app)) {
         installExtension(REACT_DEVELOPER_TOOLS)
-            .then((name) => console.log(`Added Extension:  ${name}`))
-            .catch((err) => console.log("An error occurred: ", err));
+            .then((name) => logger.debug("Added extension: %s", name))
+            .catch((err) => logger.error("An error occurred: %s", err));
     }
 });

package/src/renderer.tsx

@@ -3,11 +3,22 @@ import * as React from "react";
 import * as ReactDOM from "react-dom/client";
 
 import {Bootstrap} from "./bootstrap";
+import {getProcessArgs} from "./common/Helpers";
+import {createLogger} from "./common/Logger";
 import schema from "./common/Store";
 
+const args = getProcessArgs();
+
+global.logger = createLogger({
+    level: args["debug"] ? "debug" : "error",
+    logFile: true,
+    logFilePath: "application.log",
+});
 global.store = new Store({ schema, clearInvalidConfig: true });
+logger.debug("Electron store initialized.");
 
 const container = document.getElementById("root");
 const root = ReactDOM.createRoot(container!);
 
 root.render(React.createElement(Bootstrap));
+logger.debug("Application rendered.");

package/src/styles/MaterialThemes.ts

@@ -1,4 +1,4 @@
-import $_ from "lodash";
+import {assign, get} from "lodash-es";
 
 import {Theme} from "@mui/material";
 import {grey} from "@mui/material/colors";
@@ -325,5 +325,5 @@ const themes: Record<string, Partial<Theme | any>> = {
 export const getThemeDefinition = (name: string, mode: "light" | "dark") => {
     const theme = themes[name];
 
-    return $_.assign({}, theme, { palette: $_.get(theme, `palette.${mode}`) });
+    return assign({}, theme, { palette: get(theme, `palette.${mode}`) });
 };