diff --git a/static/manifest.json b/static/manifest.json
index d9922177..e8aef0c7 100644
--- a/static/manifest.json
+++ b/static/manifest.json
@@ -1,11 +1,8 @@
{
"name": "Random YouTube Video",
"description": "Play a random video uploaded on the current YouTube channel.",
- "version": "2.0.0",
+ "version": "2.1.0",
"manifest_version": 3,
- "background": {
- "service_worker": "background.js"
- },
"content_scripts": [
{
"js": [
diff --git a/test/chromeStorage.test.js b/test/chromeStorage.test.js
index 105616a7..e0414eaa 100644
--- a/test/chromeStorage.test.js
+++ b/test/chromeStorage.test.js
@@ -1,10 +1,33 @@
import expect from 'expect.js';
import { configSync, setSyncStorageValue, getUserQuotaRemainingToday } from '../src/chromeStorage.js';
+import { configSyncDefaults } from '../src/config.js';
describe('chromeStorage', function () {
context('configSync', function () {
+ // This test *must* be the very first one, as otherwise number of set calls will be different, and we can only get the validation run once at import time
+ it('should correctly remove and add keys when validating', async function () {
+ try {
+ const setArgs = chrome.storage.sync.set.args;
+ const removeArgs = chrome.storage.sync.remove.args;
+ const clearArgs = chrome.storage.sync.clear.args;
+
+ expect(setArgs.length).to.be(2 + Object.keys(configSyncDefaults).length);
+ expect(setArgs[0]).to.eql([{ 'thisKeyShouldBeRemoved': 'thisValueShouldBeRemoved' }]);
+ for (let i = 0; i < Object.keys(configSyncDefaults).length; i++) {
+ expect(setArgs[i + 1]).to.eql([{ [Object.keys(configSyncDefaults)[i]]: Object.values(configSyncDefaults)[i] }]);
+ }
+ expect(setArgs[setArgs.length - 1]).to.eql([configSyncDefaults]);
+
+ expect(removeArgs).to.eql([["thisKeyShouldBeRemoved"]]);
+
+ expect(clearArgs).to.eql([]);
+ } catch (e) {
+ e.message = 'As this test failed, it either did not run as the first test, or the testSetup was changed\n\t' + e.message;
+ throw e;
+ }
+ });
it('should be an object', function () {
expect(configSync).to.be.an('object');
diff --git a/test/shuffleVideo.test.js b/test/shuffleVideo.test.js
index 87a30dae..af7d5e91 100644
--- a/test/shuffleVideo.test.js
+++ b/test/shuffleVideo.test.js
@@ -244,13 +244,14 @@ describe('shuffleVideo', function () {
const commands = chrome.runtime.sendMessage.args.map(arg => arg[0].command);
- // callCount is 2 if we didn't choose a deleted video, 3 else
- expect(chrome.runtime.sendMessage.callCount).to.be.within(2, 3);
+ // callCount is 3 if we didn't choose a deleted video, 4 else
+ expect(chrome.runtime.sendMessage.callCount).to.be.within(3, 4);
+ expect(commands).to.contain('connectionTest');
expect(commands).to.contain('getAllYouTubeTabs');
expect(commands).to.contain('getCurrentTabId');
- if (chrome.runtime.sendMessage.callCount === 3) {
+ if (chrome.runtime.sendMessage.callCount === 4) {
expect(commands).to.contain('overwritePlaylistInfoInDB');
}
@@ -263,11 +264,12 @@ describe('shuffleVideo', function () {
const commands = chrome.runtime.sendMessage.args.map(arg => arg[0].command);
if (needsYTAPIInteraction(input)) {
- expect(chrome.runtime.sendMessage.callCount).to.be(5);
+ expect(chrome.runtime.sendMessage.callCount).to.be(6);
} else {
- expect(chrome.runtime.sendMessage.callCount).to.be.within(3, 4);
+ expect(chrome.runtime.sendMessage.callCount).to.be.within(4, 5);
}
+ expect(commands).to.contain('connectionTest');
expect(commands).to.contain('getPlaylistFromDB');
expect(commands).to.contain('getAllYouTubeTabs');
expect(commands).to.contain('getCurrentTabId');
@@ -276,18 +278,18 @@ describe('shuffleVideo', function () {
const numDeletedVideosAfter = Object.keys(playlistInfoAfter.videos).filter(videoId => videoId.includes('DEL')).length;
// Callcount:
- // 5 if we need to fetch from the YT API, with update or overwrite depending on if a video was deleted
- // 4 if we don't need to fetch from the YT API, but need to overwrite the playlist in the DB
- // 3 if we dont need to overwrite the playlist in the DB
+ // 6 if we need to fetch from the YT API, with update or overwrite depending on if a video was deleted
+ // 5 if we don't need to fetch from the YT API, but need to overwrite the playlist in the DB
+ // 4 if we dont need to overwrite the playlist in the DB
switch (chrome.runtime.sendMessage.callCount) {
- case 3:
+ case 4:
expect(numDeletedVideosBefore).to.be(numDeletedVideosAfter);
break;
- case 4:
+ case 5:
expect(commands).to.contain('overwritePlaylistInfoInDB');
expect(numDeletedVideosBefore).to.be.greaterThan(numDeletedVideosAfter);
break;
- case 5:
+ case 6:
expect(commands).to.contain('getAPIKey');
if (numDeletedVideosBefore > numDeletedVideosAfter) {
expect(commands).to.contain('overwritePlaylistInfoInDB');
@@ -306,21 +308,22 @@ describe('shuffleVideo', function () {
const commands = chrome.runtime.sendMessage.args.map(arg => arg[0].command);
+ expect(commands).to.contain('connectionTest');
+ expect(commands).to.contain('getPlaylistFromDB');
+ expect(commands).to.contain('getAllYouTubeTabs');
+ expect(commands).to.contain('getCurrentTabId');
+
// Callcount:
- // 5 if we need to fetch from the YT API, we consequently need to update the DB
- // 3 if we dont need to fetch from the YT API
+ // 6 if we need to fetch from the YT API, we consequently need to update the DB
+ // 4 if we dont need to fetch from the YT API
if (needsYTAPIInteraction(input)) {
- expect(chrome.runtime.sendMessage.callCount).to.be(5);
+ expect(chrome.runtime.sendMessage.callCount).to.be(6);
expect(commands).to.contain('getAPIKey');
expect(commands).to.contain('updatePlaylistInfoInDB');
} else {
- expect(chrome.runtime.sendMessage.callCount).to.be(3);
+ expect(chrome.runtime.sendMessage.callCount).to.be(4);
}
- expect(commands).to.contain('getPlaylistFromDB');
- expect(commands).to.contain('getAllYouTubeTabs');
- expect(commands).to.contain('getCurrentTabId');
-
const numDeletedVideosAfter = Object.keys(playlistInfoAfter.videos).filter(videoId => videoId.includes('DEL')).length;
expect(numDeletedVideosAfter).to.be(0);
@@ -331,9 +334,10 @@ describe('shuffleVideo', function () {
const commands = chrome.runtime.sendMessage.args.map(arg => arg[0].command);
- // 3 because we only need to fetch from the DB
- expect(chrome.runtime.sendMessage.callCount).to.be(3);
+ // 4 because we only need to fetch from the DB
+ expect(chrome.runtime.sendMessage.callCount).to.be(4);
+ expect(commands).to.contain('connectionTest');
expect(commands).to.contain('getPlaylistFromDB');
expect(commands).to.contain('getAllYouTubeTabs');
expect(commands).to.contain('getCurrentTabId');
@@ -345,9 +349,10 @@ describe('shuffleVideo', function () {
const commands = chrome.runtime.sendMessage.args.map(arg => arg[0].command);
- // 5 because we need to fetch from the DB, fetch from the YT API, and update the DB
- expect(chrome.runtime.sendMessage.callCount).to.be(5);
+ // 6 because we need to fetch from the DB, fetch from the YT API, and update the DB
+ expect(chrome.runtime.sendMessage.callCount).to.be(6);
+ expect(commands).to.contain('connectionTest');
expect(commands).to.contain('getPlaylistFromDB');
expect(commands).to.contain('getAllYouTubeTabs');
expect(commands).to.contain('getCurrentTabId');
diff --git a/test/testSetup.js b/test/testSetup.js
index 913bee92..0e011283 100644
--- a/test/testSetup.js
+++ b/test/testSetup.js
@@ -15,6 +15,10 @@ chrome.storage.sync.set.callsFake((obj) => {
Object.assign(mockedConfigSync, obj);
return Promise.resolve();
});
+chrome.storage.sync.remove.callsFake((key) => {
+ delete mockedConfigSync[key];
+ return Promise.resolve();
+});
chrome.storage.sync.clear.callsFake(() => {
for (const key in mockedConfigSync) {
delete mockedConfigSync[key];
@@ -42,6 +46,9 @@ chrome.storage.local.clear.callsFake(() => {
// ---------- Chrome runtime message listener ----------
chrome.runtime.sendMessage.callsFake((request) => {
switch (request.command) {
+ case "connectionTest":
+ return Promise.resolve("Connection test successful.");
+
case 'getPlaylistFromDB':
// Return a playlist from the database
return Promise.resolve(mockedDatabase[request.data] ?? null);
@@ -92,6 +99,11 @@ function clearMockedDatabase() {
}
// ---------- Test setup and teardown ----------
+// Setup before the import of configSync in the first test
+// To pass the first test, this needs to be done outside any before hooks
+// The first test will check that this key was removed during validation
+chrome.storage.sync.set({ "thisKeyShouldBeRemoved": "thisValueShouldBeRemoved" });
+
beforeEach(() => {
chrome.storage.sync.set(deepCopy(configSyncDefaults));
chrome.storage.local.set(deepCopy(localPlaylistPermutations));
diff --git a/webpack.common.cjs b/webpack.common.cjs
index 7b8adbfc..c2f7d594 100644
--- a/webpack.common.cjs
+++ b/webpack.common.cjs
@@ -1,48 +1,60 @@
const path = require('path');
+const BuildManifest = require('./webpack.manifest.cjs');
const ESLintPlugin = require('eslint-webpack-plugin');
const CopyPlugin = require('copy-webpack-plugin');
-module.exports = {
- entry: {
- // JS
- background: './src/background.js',
- buildShuffleButton: './src/buildShuffleButton.js',
- content: './src/content.js',
- shuffleVideo: './src/shuffleVideo.js',
- utils: './src/utils.js',
- chromeStorage: './src/chromeStorage.js',
- // HTML
- changelog: './src/html/changelog.js',
- htmlUtils: './src/html/htmlUtils.js',
- shufflingPage: './src/html/shufflingPage.js',
- // POPUP
- popup: './src/html/popup/popup.js',
- popupUtils: './src/html/popup/popupUtils.js',
- },
- module: {
- rules: [
- {
- test: /\.(js|ts)x?$/,
- use: ['babel-loader'],
- exclude: /node_modules/,
- },
+module.exports = env => {
+ return {
+ entry: {
+ // JS
+ background: './src/background.js',
+ buildShuffleButton: './src/buildShuffleButton.js',
+ content: './src/content.js',
+ shuffleVideo: './src/shuffleVideo.js',
+ utils: './src/utils.js',
+ chromeStorage: './src/chromeStorage.js',
+ // HTML
+ changelog: './src/html/changelog.js',
+ htmlUtils: './src/html/htmlUtils.js',
+ shufflingPage: './src/html/shufflingPage.js',
+ // POPUP
+ popup: './src/html/popup/popup.js',
+ popupUtils: './src/html/popup/popupUtils.js',
+ },
+ module: {
+ rules: [
+ {
+ test: /\.(js|ts)x?$/,
+ use: ['babel-loader'],
+ exclude: /node_modules/,
+ },
+ ],
+ },
+ resolve: {
+ extensions: ['.ts', '.js'],
+ },
+ output: {
+ path: path.resolve(__dirname, 'dist', env.browser)
+ },
+ plugins: [
+ new ESLintPlugin({
+ extensions: ['js', 'ts'],
+ overrideConfigFile: path.resolve(__dirname, '.eslintrc'),
+ }),
+ new CopyPlugin({
+ patterns: [
+ {
+ from: 'static',
+ globOptions: {
+ ignore: ['**/*manifest*.json'],
+ },
+ },
+ ],
+ }),
+ new BuildManifest({
+ browser: env.browser
+ }),
],
- },
- resolve: {
- extensions: ['.ts', '.js'],
- },
- output: {
- path: path.resolve(__dirname, 'dist'),
- clean: true,
- },
- plugins: [
- new ESLintPlugin({
- extensions: ['js', 'ts'],
- overrideConfigFile: path.resolve(__dirname, '.eslintrc'),
- }),
- new CopyPlugin({
- patterns: [{ from: 'static' }],
- }),
- ],
+ };
};
diff --git a/webpack.dev.cjs b/webpack.dev.cjs
index 2ad133d7..480a802e 100644
--- a/webpack.dev.cjs
+++ b/webpack.dev.cjs
@@ -1,10 +1,20 @@
const { merge } = require('webpack-merge');
const common = require('./webpack.common.cjs');
-module.exports = merge(common, {
- mode: 'development',
- devtool: 'inline-source-map',
- optimization: {
+module.exports = env => {
+ let mode = "development";
+ let devtool = 'inline-source-map';
+ let optimization = {
minimize: false
- },
-});
\ No newline at end of file
+ };
+
+ env.mode = mode;
+ env.devtool = devtool;
+ env.optimization = optimization;
+
+ return merge(common(env), {
+ mode,
+ devtool,
+ optimization
+ });
+};
\ No newline at end of file
diff --git a/webpack.manifest.cjs b/webpack.manifest.cjs
new file mode 100644
index 00000000..a3a174e1
--- /dev/null
+++ b/webpack.manifest.cjs
@@ -0,0 +1,48 @@
+// Adapted from https://github.com/ajayyy/SponsorBlock/blob/d5d766b429fb08802aabc72d187259d8db1e3a79/webpack/webpack.manifest.js
+const path = require('path');
+const fs = require('fs');
+
+const manifest = require("./static/manifest.json");
+const firefoxManifestExtra = require("./static/firefox-manifest-extra.json");
+const chromiumManifestExtra = require("./static/chromium-manifest-extra.json");
+
+class BuildManifest {
+ constructor(options = {}) {
+ this.options = options;
+ }
+
+ apply() {
+ const distFolder = path.resolve(__dirname, 'dist', this.options.browser);
+ const distManifestFile = path.resolve(distFolder, "manifest.json");
+
+ // Add missing manifest elements
+ if (this.options.browser.toLowerCase() === "firefox") {
+ mergeObjects(manifest, firefoxManifestExtra);
+ } else if (this.options.browser.toLowerCase() === "chromium") {
+ mergeObjects(manifest, chromiumManifestExtra);
+ }
+
+ let result = JSON.stringify(manifest, null, 2);
+
+ fs.mkdirSync(distFolder, { recursive: true });
+ fs.writeFileSync(distManifestFile, result);
+ }
+}
+
+function mergeObjects(object1, object2) {
+ for (const key in object2) {
+ if (key in object1) {
+ if (Array.isArray(object1[key])) {
+ object1[key] = object1[key].concat(object2[key]);
+ } else if (typeof object1[key] == 'object') {
+ mergeObjects(object1[key], object2[key]);
+ } else {
+ object1[key] = object2[key];
+ }
+ } else {
+ object1[key] = object2[key];
+ }
+ }
+}
+
+module.exports = BuildManifest;
\ No newline at end of file
diff --git a/webpack.prod.cjs b/webpack.prod.cjs
index 731312dc..3e45ed5c 100644
--- a/webpack.prod.cjs
+++ b/webpack.prod.cjs
@@ -1,7 +1,11 @@
const { merge } = require('webpack-merge');
const common = require('./webpack.common.cjs');
-module.exports = merge(common, {
- mode: 'production',
- devtool: 'source-map',
-});
\ No newline at end of file
+module.exports = env => {
+ let mode = "production";
+ env.mode = mode;
+
+ return merge(common(env), {
+ mode
+ });
+};
\ No newline at end of file
+