Compare commits

...

76 Commits

Author SHA1 Message Date
eec6993b95 Merge pull request #31 from th-ch/dependabot/npm_and_yarn/electron-8.2.4
Bump electron from 8.2.1 to 8.2.4
2020-07-12 21:13:56 +02:00
eb8e0a37d6 Bump electron from 8.2.1 to 8.2.4
Bumps [electron](https://github.com/electron/electron) from 8.2.1 to 8.2.4.
- [Release notes](https://github.com/electron/electron/releases)
- [Changelog](https://github.com/electron/electron/blob/master/docs/breaking-changes.md)
- [Commits](https://github.com/electron/electron/compare/v8.2.1...v8.2.4)

Signed-off-by: dependabot[bot] <support@github.com>
2020-07-07 02:01:10 +00:00
TC
2a915f4fae Fix electron deprecation warnings 2020-07-05 15:57:25 +02:00
TC
26994000d7 readme: yarn run build -> `yarn build 2020-07-05 15:44:26 +02:00
78f143ea10 Merge pull request #30 from th-ch/snyk-upgrade-3427638aafd84464f9f38998c7e3bc6f
[Snyk] Upgrade electron-store from 5.1.1 to 5.2.0
2020-07-05 15:43:02 +02:00
684a369fed fix: upgrade electron-store from 5.1.1 to 5.2.0
Snyk has created this PR to upgrade electron-store from 5.1.1 to 5.2.0.

See this package in NPM:
https://www.npmjs.com/package/electron-store

See this project in Snyk:
https://app.snyk.io/org/th-ch/project/81809c53-bb7b-46b9-a0d7-806d45d74ac6?utm_source=github&utm_medium=upgrade-pr
2020-06-28 02:19:06 +00:00
b19470ad0b Merge pull request #29 from th-ch/snyk-upgrade-a4c19e5e6b1b92c533cd6d3ed8538fa2
[Snyk] Upgrade @cliqz/adblocker-electron from 1.14.4 to 1.15.0
2020-06-14 22:40:24 +02:00
6691cbf8c0 Merge pull request #28 from th-ch/snyk-upgrade-54c1400dcbff5fcbde1071153f1be456
[Snyk] Upgrade electron-debug from 3.0.1 to 3.1.0
2020-06-14 22:39:18 +02:00
7ac98cf024 fix: upgrade @cliqz/adblocker-electron from 1.14.4 to 1.15.0
Snyk has created this PR to upgrade @cliqz/adblocker-electron from 1.14.4 to 1.15.0.

See this package in NPM:
https://www.npmjs.com/package/@cliqz/adblocker-electron

See this project in Snyk:
https://app.snyk.io/org/th-ch/project/81809c53-bb7b-46b9-a0d7-806d45d74ac6?utm_source=github&utm_medium=upgrade-pr
2020-06-14 02:19:04 +00:00
3d835fbeaa fix: upgrade electron-debug from 3.0.1 to 3.1.0
Snyk has created this PR to upgrade electron-debug from 3.0.1 to 3.1.0.

See this package in NPM:
https://www.npmjs.com/package/electron-debug

See this project in Snyk:
https://app.snyk.io/org/th-ch/project/81809c53-bb7b-46b9-a0d7-806d45d74ac6?utm_source=github&utm_medium=upgrade-pr
2020-06-13 02:19:27 +00:00
d0824f52ea Merge pull request #27 from th-ch/snyk-upgrade-9a04364d99d1aed92239f3dd981f3d67
[Snyk] Upgrade electron-updater from 4.3.1 to 4.3.2
2020-06-05 22:48:14 +02:00
8c945100e2 fix: upgrade electron-updater from 4.3.1 to 4.3.2
Snyk has created this PR to upgrade electron-updater from 4.3.1 to 4.3.2.

See this package in NPM:
https://www.npmjs.com/package/electron-updater

See this project in Snyk:
https://app.snyk.io/org/th-ch/project/81809c53-bb7b-46b9-a0d7-806d45d74ac6?utm_source=github&utm_medium=upgrade-pr
2020-06-05 02:19:01 +00:00
68801c8e2b Merge pull request #26 from th-ch/snyk-upgrade-107ef53d6b16bb061dc783179b8991a7
[Snyk] Upgrade electron-updater from 4.3.0 to 4.3.1
2020-05-29 21:32:29 +02:00
a06eece4a0 fix: upgrade electron-updater from 4.3.0 to 4.3.1
Snyk has created this PR to upgrade electron-updater from 4.3.0 to 4.3.1.

See this package in NPM:
https://www.npmjs.com/package/electron-updater

See this project in Snyk:
https://app.snyk.io/org/th-ch/project/81809c53-bb7b-46b9-a0d7-806d45d74ac6?utm_source=github&utm_medium=upgrade-pr
2020-05-19 04:19:35 +02:00
873e093ff0 fix: upgrade electron-updater from 4.3.0 to 4.3.1
Snyk has created this PR to upgrade electron-updater from 4.3.0 to 4.3.1.

See this package in NPM:
https://www.npmjs.com/package/electron-updater

See this project in Snyk:
https://app.snyk.io/org/th-ch/project/81809c53-bb7b-46b9-a0d7-806d45d74ac6?utm_source=github&utm_medium=upgrade-pr
2020-05-19 04:19:34 +02:00
9c343d58ef Merge pull request #25 from th-ch/snyk-upgrade-86a869f28fc1113ae78c2dcd1eea4b90
[Snyk] Upgrade @cliqz/adblocker-electron from 1.14.1 to 1.14.2
2020-05-14 22:14:50 +02:00
fed7a1df17 fix: upgrade @cliqz/adblocker-electron from 1.14.1 to 1.14.2
Snyk has created this PR to upgrade @cliqz/adblocker-electron from 1.14.1 to 1.14.2.

See this package in NPM:
https://www.npmjs.com/package/@cliqz/adblocker-electron

See this project in Snyk:
https://app.snyk.io/org/th-ch/project/81809c53-bb7b-46b9-a0d7-806d45d74ac6?utm_source=github&utm_medium=upgrade-pr
2020-05-14 04:19:22 +02:00
89d8907bc6 fix: upgrade @cliqz/adblocker-electron from 1.14.1 to 1.14.2
Snyk has created this PR to upgrade @cliqz/adblocker-electron from 1.14.1 to 1.14.2.

See this package in NPM:
https://www.npmjs.com/package/@cliqz/adblocker-electron

See this project in Snyk:
https://app.snyk.io/org/th-ch/project/81809c53-bb7b-46b9-a0d7-806d45d74ac6?utm_source=github&utm_medium=upgrade-pr
2020-05-14 04:19:21 +02:00
08d145b6fc Merge pull request #24 from th-ch/tests
[Tests] Add integration tests
2020-05-03 13:35:41 +02:00
TC
57d3545701 Launch tests in CI 2020-05-03 12:58:28 +02:00
TC
08710558f5 Add tests section to readme 2020-05-03 11:44:23 +02:00
TC
b80007bbd5 Tests: only stop if running (in case of error when launching app) 2020-05-03 11:44:00 +02:00
TC
ab0c93d443 Test script in package.json 2020-05-01 18:59:00 +02:00
TC
e84f045201 Add simple test to ensure app launches properly 2020-05-01 18:58:08 +02:00
TC
692b6b22aa Enable nodeIntegration in test env (required by Spectron) 2020-05-01 18:34:23 +02:00
TC
954a58bcf5 Add util to detect test env 2020-05-01 18:34:01 +02:00
TC
bce5b7d8eb Add jest config and test environment to launch app 2020-05-01 18:33:43 +02:00
TC
736a706801 Add jest, spectron and getPort util for tests 2020-05-01 18:33:02 +02:00
TC
37cac19d9c Bump version to 1.3.3 2020-04-29 22:08:22 +02:00
TC
4824dda5d5 Move tray click callback in setUpTray 2020-04-27 12:25:24 +02:00
TC
3fa3c3ab9e Bump version to 1.3.2 2020-04-26 16:25:56 +02:00
TC
058371ace8 Show/hide window when clicking on tray 2020-04-26 16:25:37 +02:00
TC
430687f4d6 Hide the app (no quit) on close if tray enabled 2020-04-26 16:10:13 +02:00
TC
45f4b3bc28 Use is.macOS shortcut 2020-04-26 15:47:55 +02:00
7c12344d05 Merge pull request #22 from th-ch/snyk-upgrade-2844f3669e30ddb5a4f23b0caf25ece1
[Snyk] Upgrade electron-updater from 4.2.5 to 4.3.0
2020-04-26 14:51:47 +02:00
98213005d0 fix: upgrade electron-updater from 4.2.5 to 4.3.0
Snyk has created this PR to upgrade electron-updater from 4.2.5 to 4.3.0.

See this package in NPM:
https://www.npmjs.com/package/electron-updater

See this project in Snyk:
https://app.snyk.io/org/th-ch/project/81809c53-bb7b-46b9-a0d7-806d45d74ac6?utm_source=github&utm_medium=upgrade-pr
2020-04-24 04:19:57 +02:00
db61589735 fix: upgrade electron-updater from 4.2.5 to 4.3.0
Snyk has created this PR to upgrade electron-updater from 4.2.5 to 4.3.0.

See this package in NPM:
https://www.npmjs.com/package/electron-updater

See this project in Snyk:
https://app.snyk.io/org/th-ch/project/81809c53-bb7b-46b9-a0d7-806d45d74ac6?utm_source=github&utm_medium=upgrade-pr
2020-04-24 04:19:56 +02:00
TC
26dd7c5f71 Format blocker file + use window session in adblocker 2020-04-12 21:57:13 +02:00
TC
3bbab525c6 Only set user-agent on accounts.google.com (affects preload scripts otherwise) 2020-04-12 21:54:35 +02:00
TC
d42b7bc559 Bump version to 1.3.1 2020-04-12 20:35:44 +02:00
TC
69f88ed840 Force user agent for Google OAuth to work 2020-04-12 19:33:45 +02:00
eb10bf2b34 Merge pull request #21 from th-ch/add-options-and-tray
Add options and tray
2020-04-12 19:32:42 +02:00
TC
e051c4a9a2 Only checked for updates if configured in options 2020-04-12 19:00:06 +02:00
TC
477202bf24 Setup tray (based on options) 2020-04-12 19:00:06 +02:00
TC
876e52bb01 Tray lib 2020-04-12 19:00:06 +02:00
TC
edfd5be6a2 Add youtube-music util to interact with the window 2020-04-12 19:00:06 +02:00
TC
baa4f17276 Add tray icon in assets 2020-04-12 19:00:06 +02:00
TC
1de6f3e2ed Add options to menu, export menu config 2020-04-12 19:00:06 +02:00
TC
1c56e7fea6 Add options in store (tray, app visible, auto-update) 2020-04-12 19:00:06 +02:00
TC
4c46bceb7d Formatting 2020-04-12 19:00:05 +02:00
TC
7098cd7602 Update build command in readme 2020-04-12 16:55:25 +02:00
210418e5d3 Merge pull request #20 from th-ch/upgrade-outdated-dependencies
Upgrade outdated dependencies
2020-04-12 16:29:35 +02:00
TC
297de08278 Upgrade xo 2020-04-12 15:38:43 +02:00
TC
050bdd3c02 Upgrade rimraf 2020-04-12 15:35:59 +02:00
TC
3edc6e9b37 Upgrade electron-store 2020-04-12 15:33:33 +02:00
TC
2e721c942f Upgrade electron-devtools-installer 2020-04-12 15:30:56 +02:00
TC
8d375070ac Upgrade electron-debug 2020-04-12 15:29:36 +02:00
387a6d9f16 Merge pull request #19 from th-ch/migrate-to-adblock-rs
[Plugins] Migrate ad blocker
2020-04-12 15:20:51 +02:00
TC
3999b991fa Bump minor version (for this PR and new features to come) 2020-04-12 15:11:47 +02:00
TC
3d9e59dc90 Bump electron-builder (needed after electron upgrade) 2020-04-12 15:01:03 +02:00
TC
f25eb48f79 Generate the adblocker engine only once (by using built-in caching) 2020-04-12 14:17:38 +02:00
TC
6e45e7b2cb No rust/cargo install in build workers (not needed anymore) 2020-04-12 13:28:49 +02:00
TC
59bba8e590 Disable RDP access to AppVeyor build workers 2020-04-12 13:24:40 +02:00
TC
422c3fc28d Migrate from adblock-rs to cliqz 2020-04-12 13:23:35 +02:00
TC
6fb251f00f Enable RDP to the build worker 2020-04-12 11:43:38 +02:00
TC
1cb876da55 Update travis config 2020-04-12 00:07:51 +02:00
TC
c5021d5ca2 30 min timeout in Travis 2020-04-11 22:43:06 +02:00
TC
359360b058 Use VS 2019 to build on Windows 2020-04-11 21:55:28 +02:00
TC
80da3feb01 Upgrade extract-path and minimist to fix vuln 2020-04-11 21:28:55 +02:00
TC
ff074c10a6 Install rust/cargo for CI builds 2020-04-11 15:47:58 +02:00
TC
098776e31a Bump electron to last version 2020-04-11 14:00:12 +02:00
TC
d702321969 Postinstall scripts per plugin 2020-04-11 13:37:22 +02:00
TC
4748cf92bb Remove electron-rebuild 2020-04-11 13:36:56 +02:00
TC
5e3b7c0db7 Migrate adblock plugin to adblock-rs 2020-04-11 12:43:33 +02:00
TC
4648854a04 Remove adblock, install adblock-rs 2020-04-11 12:42:31 +02:00
0dc28064db Add badge for downloads 2020-03-15 21:45:36 +01:00
20 changed files with 4658 additions and 1476 deletions

View File

@ -1,16 +1,16 @@
matrix:
language: node_js
node_js: "10"
env:
- ELECTRON_CACHE=$HOME/.cache/electron ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
jobs:
include:
- os: osx
osx_image: xcode9.4
language: node_js
node_js: "10"
env:
- ELECTRON_CACHE=$HOME/.cache/electron
- ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
osx_image: xcode11.3
- os: linux
services: docker
language: generic
dist: xenial
services:
- xvfb
cache:
yarn: false
@ -20,25 +20,18 @@ cache:
script:
- |
yarn test
if [ "$TRAVIS_OS_NAME" == "linux" ]; then
docker run --rm \
$(env | \
grep -Eo '^[^\s=]*(DEBUG|NODE_|ELECTRON_|YARN_|NPM_|CI|CIRCLE|TRAVIS|APPVEYOR_|CSC_|_TOKEN|_KEY|AWS_|STRIP|BUILD_)[^\s=]*' | \
sed '/^$/d;s/^/-e /' | \
paste -sd ' ' \
) \
-v ${PWD}:/project \
-v ~/.cache/electron:/root/.cache/electron \
-v ~/.cache/electron-builder:/root/.cache/electron-builder \
electronuserland/builder:10 \
/bin/bash -c "yarn && npm run release:linux"
yarn run release:linux
else
npm run release:mac
yarn run release:mac
fi
before_cache:
- rm -rf $HOME/.cache/electron-builder
before_install:
- rm -rf node_modules
# Install dependencies
- travis_wait 30 yarn --frozen-lockfile
branches:
except:

View File

@ -1,4 +1,4 @@
image: Visual Studio 2017
image: Visual Studio 2019
platform:
- x64
@ -11,8 +11,20 @@ init:
- git config --global core.autocrlf input
install:
# Install node
- ps: Install-Product node 10 x64
- yarn
# Install dependencies
- yarn --frozen-lockfile
# on_finish:
# # Enable RDP to the build worker (using APPVEYOR_RDP_PASSWORD env var)
# # https://www.appveyor.com/docs/how-to/rdp-to-build-worker/
# - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
# @FIXME: tests disabled because app fails to launch on AppVeyor/Windows
# os: unstable # https://github.com/electron-userland/spectron#on-appveyor
# test_script:
# - yarn test
build_script:
- yarn run release:win

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.3 KiB

View File

@ -1,15 +1,24 @@
"use strict";
const path = require("path");
const electron = require("electron");
const is = require("electron-is");
const electron = require("electron");
const is = require("electron-is");
const { autoUpdater } = require("electron-updater");
const { setApplicationMenu } = require("./menu");
const { getEnabledPlugins, store } = require("./store");
const { fileExists, injectCSS } = require("./plugins/utils");
const { setApplicationMenu } = require("./menu");
const {
autoUpdate,
getEnabledPlugins,
isAppVisible,
isTrayEnabled,
store,
} = require("./store");
const { fileExists, injectCSS } = require("./plugins/utils");
const { isTesting } = require("./utils/testing");
const { setUpTray } = require("./tray");
const app = electron.app;
app.allowRendererProcessReuse = true; // https://github.com/electron/electron/issues/18397
// Adds debug features like hotkeys for triggering dev tools and reload
require("electron-debug")();
@ -32,23 +41,23 @@ function onClosed() {
}
function createMainWindow() {
const windowSize = store.get("window-size");
const windowSize = store.get("window-size");
const windowMaximized = store.get("window-maximized");
const win = new electron.BrowserWindow({
icon : icon,
width : windowSize.width,
height : windowSize.height,
icon: icon,
width: windowSize.width,
height: windowSize.height,
backgroundColor: "#000",
show : false,
webPreferences : {
nodeIntegration : false,
preload : path.join(__dirname, "preload.js"),
nativeWindowOpen: true, // window.open return Window object(like in regular browsers), not BrowserWindowProxy
affinity : "main-window" // main window, and addition windows should work in one process
show: false,
webPreferences: {
nodeIntegration: isTesting(), // Only necessary when testing with Spectron
preload: path.join(__dirname, "preload.js"),
nativeWindowOpen: true, // window.open return Window object(like in regular browsers), not BrowserWindowProxy
affinity: "main-window", // main window, and addition windows should work in one process
},
frame : !is.macOS(),
titleBarStyle: is.macOS() ? "hiddenInset": "default"
frame: !is.macOS(),
titleBarStyle: is.macOS() ? "hiddenInset" : "default",
});
if (windowMaximized) {
win.maximize();
@ -65,7 +74,7 @@ function createMainWindow() {
}
});
getEnabledPlugins().forEach(plugin => {
getEnabledPlugins().forEach((plugin) => {
console.log("Loaded plugin - " + plugin);
const pluginPath = path.join(__dirname, "plugins", plugin, "back.js");
fileExists(pluginPath, () => {
@ -88,6 +97,21 @@ function createMainWindow() {
}
});
win.webContents.on("will-navigate", (_, url) => {
if (url.startsWith("https://accounts.google.com")) {
// Force user-agent "Firefox Windows" for Google OAuth to work
// From https://github.com/firebase/firebase-js-sdk/issues/2478#issuecomment-571356751
// Only set on accounts.google.com, otherwise querySelectors in preload scripts fail (?)
const userAgent =
"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:70.0) Gecko/20100101 Firefox/70.0";
win.webContents.session.webRequest.onBeforeSendHeaders((details, cb) => {
details.requestHeaders["User-Agent"] = userAgent;
cb({ requestHeaders: details.requestHeaders });
});
}
});
win.webContents.on(
"new-window",
(e, url, frameName, disposition, options) => {
@ -114,7 +138,9 @@ function createMainWindow() {
});
win.once("ready-to-show", () => {
win.show();
if (isAppVisible()) {
win.show();
}
});
return win;
@ -142,28 +168,38 @@ app.on("activate", () => {
app.on("ready", () => {
setApplicationMenu();
mainWindow = createMainWindow();
if (!is.dev()) {
setUpTray(app, mainWindow);
if (!is.dev() && autoUpdate()) {
autoUpdater.checkForUpdatesAndNotify();
autoUpdater.on("update-available", () => {
const dialogOpts = {
type : "info",
type: "info",
buttons: ["OK"],
title : "Application Update",
title: "Application Update",
message: "A new version is available",
detail :
"A new version is available and can be downloaded at https://github.com/th-ch/youtube-music/releases/latest"
detail:
"A new version is available and can be downloaded at https://github.com/th-ch/youtube-music/releases/latest",
};
electron.dialog.showMessageBox(dialogOpts);
});
}
// Optimized for Mac OS X
if (process.platform === "darwin") {
var forceQuit = false;
app.on("before-quit", () => {
forceQuit = true;
});
mainWindow.on("close", event => {
if (is.macOS()) {
if (!isAppVisible()) {
app.dock.hide();
}
}
var forceQuit = false;
app.on("before-quit", () => {
forceQuit = true;
});
if (is.macOS() || isTrayEnabled()) {
mainWindow.on("close", (event) => {
// Hide the window instead of quitting (quit is available in tray options)
if (!forceQuit) {
event.preventDefault();
mainWindow.hide();

7
jest.config.js Normal file
View File

@ -0,0 +1,7 @@
module.exports = {
globals: {
__APP__: undefined, // A different app will be launched in each test environment
},
testEnvironment: "./tests/environment",
testTimeout: 30000, // 30s
};

100
menu.js
View File

@ -1,33 +1,79 @@
const { app, Menu } = require("electron");
const { getAllPlugins } = require("./plugins/utils");
const { isPluginEnabled, enablePlugin, disablePlugin } = require("./store");
const { getAllPlugins } = require("./plugins/utils");
const {
isPluginEnabled,
enablePlugin,
disablePlugin,
autoUpdate,
isAppVisible,
isTrayEnabled,
setOptions,
} = require("./store");
module.exports.setApplicationMenu = () => {
const menuTemplate = [
{
label : "Plugins",
submenu: getAllPlugins().map(plugin => {
return {
label : plugin,
type : "checkbox",
checked: isPluginEnabled(plugin),
click : item => {
if (item.checked) {
enablePlugin(plugin);
} else {
disablePlugin(plugin);
}
const mainMenuTemplate = [
{
label: "Plugins",
submenu: getAllPlugins().map((plugin) => {
return {
label: plugin,
type: "checkbox",
checked: isPluginEnabled(plugin),
click: (item) => {
if (item.checked) {
enablePlugin(plugin);
} else {
disablePlugin(plugin);
}
};
})
}
];
},
};
}),
},
{
label: "Options",
submenu: [
{
label: "Auto-update",
type: "checkbox",
checked: autoUpdate(),
click: (item) => {
setOptions({ autoUpdates: item.checked });
},
},
{
label: "Tray",
submenu: [
{
label: "Disabled",
type: "radio",
checked: !isTrayEnabled(),
click: () => setOptions({ tray: false, appVisible: true }),
},
{
label: "Enabled + app visible",
type: "radio",
checked: isTrayEnabled() && isAppVisible(),
click: () => setOptions({ tray: true, appVisible: true }),
},
{
label: "Enabled + app hidden",
type: "radio",
checked: isTrayEnabled() && !isAppVisible(),
click: () => setOptions({ tray: true, appVisible: false }),
},
],
},
],
},
];
module.exports.mainMenuTemplate = mainMenuTemplate;
module.exports.setApplicationMenu = () => {
const menuTemplate = [...mainMenuTemplate];
if (process.platform === "darwin") {
const name = app.getName();
const name = app.name;
menuTemplate.unshift({
label : name,
label: name,
submenu: [
{ role: "about" },
{ type: "separator" },
@ -36,9 +82,9 @@ module.exports.setApplicationMenu = () => {
{ role: "unhide" },
{ type: "separator" },
{
label : "Select All",
label: "Select All",
accelerator: "CmdOrCtrl+A",
selector : "selectAll:"
selector: "selectAll:",
},
{ label: "Cut", accelerator: "CmdOrCtrl+X", selector: "cut:" },
{ label: "Copy", accelerator: "CmdOrCtrl+C", selector: "copy:" },
@ -46,8 +92,8 @@ module.exports.setApplicationMenu = () => {
{ type: "separator" },
{ role: "minimize" },
{ role: "close" },
{ role: "quit" }
]
{ role: "quit" },
],
});
}

View File

@ -1,7 +1,7 @@
{
"name": "youtube-music",
"productName": "YouTube Music",
"version": "1.2.0",
"version": "1.3.3",
"description": "YouTube Music Desktop App - including custom plugins",
"license": "MIT",
"repository": "th-ch/youtube-music",
@ -26,40 +26,46 @@
}
},
"scripts": {
"test": "xo",
"test": "jest",
"start": "electron .",
"icon": "rimraf assets/generated && electron-icon-maker --input=assets/youtube-music.png --output=assets/generated",
"generate:package": "node utils/generate-package-json.js",
"postinstall": "yarn run generate:package YoutubeNonStop && yarn run icon && npm rebuild && node plugins/adblocker/generator.js && electron-rebuild",
"postinstall": "yarn run icon && yarn run plugins",
"clean": "rimraf dist",
"build": "yarn run clean && build --win --mac --linux",
"build:mac": "yarn run clean && build --mac",
"build:win": "yarn run clean && build --win",
"release:linux": "yarn run clean && build --linux -p always",
"release:mac": "yarn run clean && build --mac -p always",
"release:win": "yarn run clean && build --win -p always"
"build": "yarn run clean && electron-builder --win --mac --linux",
"build:mac": "yarn run clean && electron-builder --mac",
"build:win": "yarn run clean && electron-builder --win",
"plugins": "yarn run plugin:adblocker && yarn run plugin:autoconfirm",
"plugin:adblocker": "rimraf plugins/adblocker/ad-blocker-engine.bin && node plugins/adblocker/blocker.js",
"plugin:autoconfirm": "yarn run generate:package YoutubeNonStop",
"release:linux": "yarn run clean && electron-builder --linux -p always -c.snap.publish=github",
"release:mac": "yarn run clean && electron-builder --mac -p always",
"release:win": "yarn run clean && electron-builder --win -p always"
},
"engines": {
"npm": "Please use yarn and not npm"
},
"dependencies": {
"@cliqz/adblocker-electron": "^1.15.0",
"YoutubeNonStop": "git://github.com/lawfx/YoutubeNonStop.git#v0.7.1",
"ad-block": "^4.1.3",
"electron-debug": "^2.2.0",
"electron-debug": "^3.1.0",
"electron-is": "^3.0.0",
"electron-localshortcut": "^3.2.1",
"electron-store": "^3.1.0",
"electron-updater": "^4.2.2"
"electron-store": "^5.2.0",
"electron-updater": "^4.3.2",
"node-fetch": "^2.6.0"
},
"devDependencies": {
"devtron": "^1.4.0",
"electron": "^4.0.8",
"electron-builder": "^20.40.2",
"electron-devtools-installer": "^2.2.4",
"electron": "^8.2.4",
"electron-builder": "^22.4.1",
"electron-devtools-installer": "^3.0.0",
"electron-icon-maker": "0.0.4",
"electron-rebuild": "^1.8.4",
"rimraf": "^2.6.3",
"xo": "^0.24.0"
"get-port": "^5.1.1",
"jest": "^25.5.1",
"rimraf": "^3.0.2",
"spectron": "^10.0.1",
"xo": "^0.29.0"
},
"xo": {
"envs": [

View File

@ -1 +1 @@
detector.buffer
/ad-blocker-engine.bin

View File

@ -1,3 +1,2 @@
const { blockWindowAds } = require("./blocker");
module.exports = win => blockWindowAds(win.webContents);
const { loadAdBlockerEngine } = require("./blocker");
module.exports = (win) => loadAdBlockerEngine(win.webContents.session);

View File

@ -1,12 +1,34 @@
const { initialize, containsAds } = require("./contains-ads");
const { promises } = require("fs"); // used for caching
const path = require("path");
module.exports.blockWindowAds = webContents => {
initialize();
webContents.session.webRequest.onBeforeRequest(
["*://*./*"],
(details, cb) => {
const shouldBeBlocked = containsAds(details.url);
cb({ cancel: shouldBeBlocked });
const { ElectronBlocker } = require("@cliqz/adblocker-electron");
const fetch = require("node-fetch");
const SOURCES = [
"https://raw.githubusercontent.com/kbinani/adblock-youtube-ads/master/signed.txt",
];
const loadAdBlockerEngine = (session = undefined) =>
ElectronBlocker.fromLists(
fetch,
SOURCES,
{},
{
path: path.resolve(__dirname, "ad-blocker-engine.bin"),
read: promises.readFile,
write: promises.writeFile,
}
);
};
)
.then((blocker) => {
if (session) {
blocker.enableBlockingInSession(session);
} else {
console.log("Successfully generated adBlocker engine.");
}
})
.catch((err) => console.log("Error loading adBlocker engine", err));
module.exports = { loadAdBlockerEngine };
if (require.main === module) {
loadAdBlockerEngine(); // Generate the engine without enabling it
}

View File

@ -1,24 +0,0 @@
const fs = require("fs");
const path = require("path");
const Blocker = require("ad-block");
const client = new Blocker.AdBlockClient();
const file = path.resolve(__dirname, "detector.buffer");
module.exports.client = client;
module.exports.initialize = () =>
new Promise((resolve, reject) => {
fs.readFile(file, (err, buffer) => {
if (err) {
return reject(err);
}
client.deserialize(buffer);
return resolve();
});
});
const none = Blocker.FilterOptions.noFilterOption;
const isAd = (req, base) => client.matches(req, none, base);
module.exports.containsAds = (req, base) => isAd(req, base);
module.exports.isAd = isAd;

View File

@ -1,67 +0,0 @@
// This file generates the detector buffer
const fs = require("fs");
const path = require("path");
const Blocker = require("ad-block");
const https = require("https");
const SOURCES = [
"https://raw.githubusercontent.com/kbinani/adblock-youtube-ads/master/signed.txt"
];
function parseAdblockList(client, adblockList) {
const urls = adblockList.split("\n");
const totalSize = urls.length;
console.log(
"Parsing " + totalSize + " urls (this can take a couple minutes)."
);
urls.map(line => client.parse(line));
console.log("Created buffer.");
}
function writeBuffer(client) {
const output = path.resolve(__dirname, "detector.buffer");
fs.writeFile(output, client.serialize(64), err => {
if (err) {
console.error(err);
return;
}
console.log("Wrote buffer to detector.buffer!");
});
}
function generateDetectorBuffer() {
const client = new Blocker.AdBlockClient();
let nbSourcesFetched = 0;
// fetch updated versions
SOURCES.forEach(source => {
console.log("Downloading " + source);
https
.get(source, resp => {
let data = "";
// A chunk of data has been recieved.
resp.on("data", chunk => {
data += chunk;
});
// The whole response has been received. Print out the result.
resp.on("end", () => {
parseAdblockList(client, data);
nbSourcesFetched++;
if (nbSourcesFetched === SOURCES.length) {
writeBuffer(client);
}
});
})
.on("error", err => {
console.log("Error: " + err.message);
});
});
}
module.exports = generateDetectorBuffer;
if (require.main === module) {
generateDetectorBuffer();
}

View File

@ -6,6 +6,7 @@
[![Build status](https://ci.appveyor.com/api/projects/status/tgre12r150ynvwl2?svg=true)](https://ci.appveyor.com/project/th-ch/youtube-music)
[![Build Status](https://travis-ci.org/th-ch/youtube-music.svg?branch=master)](https://travis-ci.org/th-ch/youtube-music)
[![Known Vulnerabilities](https://snyk.io/test/github/th-ch/youtube-music/badge.svg)](https://snyk.io/test/github/th-ch/youtube-music)
![GitHub All Releases](https://img.shields.io/github/downloads/th-ch/youtube-music/total)
![Screenshot](screenshot.jpg "Screenshot")
@ -92,11 +93,19 @@ module.exports = () => {
## Build
```sh
npm run build
yarn build
```
Builds the app for macOS, Linux, and Windows, using [electron-builder](https://github.com/electron-userland/electron-builder).
## Tests
```sh
yarn test
```
Uses [Spectron](https://www.electronjs.org/spectron) to test the app.
## License
MIT © [th-ch](https://github.com/th-ch/youtube-music)

View File

@ -4,18 +4,30 @@ const plugins = require("./plugins");
const store = new Store({
defaults: {
"window-size": {
width : 1100,
width: 1100,
height: 550
},
url : "https://music.youtube.com",
plugins: ["navigation", "shortcuts", "adblocker"]
url: "https://music.youtube.com",
plugins: ["navigation", "shortcuts", "adblocker"],
options: {
tray: false,
appVisible: true,
autoUpdates: true
}
}
});
module.exports = {
store : store,
isPluginEnabled : plugin => plugins.isEnabled(store, plugin),
store: store,
// Plugins
isPluginEnabled: plugin => plugins.isEnabled(store, plugin),
getEnabledPlugins: () => plugins.getEnabledPlugins(store),
enablePlugin : plugin => plugins.enablePlugin(store, plugin),
disablePlugin : plugin => plugins.disablePlugin(store, plugin)
enablePlugin: plugin => plugins.enablePlugin(store, plugin),
disablePlugin: plugin => plugins.disablePlugin(store, plugin),
// Options
setOptions: options =>
store.set("options", { ...store.get("options"), ...options }),
isTrayEnabled: () => store.get("options.tray"),
isAppVisible: () => store.get("options.appVisible"),
autoUpdate: () => store.get("options.autoUpdates")
};

47
tests/environment.js Normal file
View File

@ -0,0 +1,47 @@
const path = require("path");
const getPort = require("get-port");
const NodeEnvironment = require("jest-environment-node");
const { Application } = require("spectron");
class TestEnvironment extends NodeEnvironment {
constructor(config) {
super(config);
}
async setup() {
await super.setup();
const electronPath = path.resolve(
__dirname,
"..",
"node_modules",
".bin",
"electron"
);
const appPath = path.resolve(__dirname, "..");
const port = await getPort();
this.global.__APP__ = new Application({
path: electronPath,
args: [appPath],
port,
});
await this.global.__APP__.start();
const { client } = this.global.__APP__;
await client.waitUntilWindowLoaded();
}
async teardown() {
if (this.global.__APP__.isRunning()) {
await this.global.__APP__.stop();
}
await super.teardown();
}
runScript(script) {
return super.runScript(script);
}
}
module.exports = TestEnvironment;

20
tests/index.test.js Normal file
View File

@ -0,0 +1,20 @@
describe("YouTube Music App", () => {
const app = global.__APP__;
test("With default settings, app is launched and visible", async () => {
expect(app.isRunning()).toBe(true);
const win = app.browserWindow;
const isVisible = await win.isVisible();
expect(isVisible).toBe(true);
const { width, height } = await win.getBounds();
expect(width).toBeGreaterThan(0);
expect(height).toBeGreaterThan(0);
const { client } = app;
const title = await client.getTitle();
expect(title).toEqual("YouTube Music");
});
});

73
tray.js Normal file
View File

@ -0,0 +1,73 @@
const path = require("path");
const { Menu, nativeImage, Tray } = require("electron");
const { mainMenuTemplate } = require("./menu");
const { isTrayEnabled } = require("./store");
const { clickInYoutubeMusic } = require("./utils/youtube-music");
// Prevent tray being garbage collected
let tray;
module.exports.setUpTray = (app, win) => {
if (!isTrayEnabled()) {
tray = undefined;
return;
}
const iconPath = path.join(__dirname, "assets", "youtube-music-tray.png");
let trayIcon = nativeImage.createFromPath(iconPath).resize({
width: 16,
height: 16,
});
tray = new Tray(trayIcon);
tray.setToolTip("Youtube Music");
tray.setIgnoreDoubleClickEvents(true);
tray.on("click", () => {
win.isVisible() ? win.hide() : win.show();
});
const trayMenu = Menu.buildFromTemplate([
{
label: "Play/Pause",
click: () => {
clickInYoutubeMusic(
win,
"#left-controls > div > paper-icon-button.play-pause-button.style-scope.ytmusic-player-bar"
);
},
},
{
label: "Next",
click: () => {
clickInYoutubeMusic(
win,
"#left-controls > div > paper-icon-button.next-button.style-scope.ytmusic-player-bar"
);
},
},
{
label: "Previous",
click: () => {
clickInYoutubeMusic(
win,
"#left-controls > div > paper-icon-button.previous-button.style-scope.ytmusic-player-bar"
);
},
},
{
label: "Show",
click: () => {
win.show();
},
},
...mainMenuTemplate,
{
label: "Quit",
click: () => {
app.quit();
},
},
]);
tray.setContextMenu(trayMenu);
};

3
utils/testing.js Normal file
View File

@ -0,0 +1,3 @@
const isTesting = () => process.env.NODE_ENV === "test";
module.exports = { isTesting };

8
utils/youtube-music.js Normal file
View File

@ -0,0 +1,8 @@
const clickInYoutubeMusic = (win, selector) => {
win.webContents.executeJavaScript(
`document.querySelector("${selector}").click();`,
true
);
};
module.exports = { clickInYoutubeMusic };

5506
yarn.lock

File diff suppressed because it is too large Load Diff