Add improved browser detection

The goal is to move away from browser detection for features. Specific browser will be used only for things like advertisement or special rendering. Feature differentiation should be based on API availability as much as possible instead. This could create problems if someone tries to manually install the wrong version of the extension or if they install it from the wrong store (Ex: install the extension from chrome web store on opera).
Moustachauve · Aug 20, 2023 · fc1cbb7 · fc1cbb7
1 parent 7b9db6e
commit fc1cbb7
Show file tree

Hide file tree

Showing 16 changed files with 1,170 additions and 593 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -114,6 +114,44 @@ module.exports = function(grunt) {
             },
 
         },
+        replace: {
+            options: {
+              patterns: [
+                {
+                  match: 'browser_name',
+                  replacement: '<%= grunt.task.current.target %>'
+                }
+              ]
+            },
+            firefox: {
+                files: [
+                    {
+                    expand: true, flatten: true, src: ['interface/lib/env.js'], dest: 'build/<%= grunt.task.current.target %>/interface/lib/'
+                    }
+                ]
+            },
+            chrome: {
+                files: [
+                    {
+                    expand: true, flatten: true, src: ['interface/lib/env.js'], dest: 'build/<%= grunt.task.current.target %>/interface/lib/'
+                    }
+                ]
+            },
+            edge: {
+                files: [
+                    {
+                    expand: true, flatten: true, src: ['interface/lib/env.js'], dest: 'build/<%= grunt.task.current.target %>/interface/lib/'
+                    }
+                ]
+            },
+            opera: {
+                files: [
+                    {
+                    expand: true, flatten: true, src: ['interface/lib/env.js'], dest: 'build/<%= grunt.task.current.target %>/interface/lib/'
+                    }
+                ]
+            }
+        },
         removelogging: {
             dist: {
                 src: "build/**/*.js"
@@ -159,10 +197,11 @@ module.exports = function(grunt) {
     grunt.loadNpmTasks('grunt-contrib-jshint');
     grunt.loadNpmTasks('grunt-contrib-clean');
     grunt.loadNpmTasks('grunt-contrib-copy');
+    grunt.loadNpmTasks('grunt-replace');
     grunt.loadNpmTasks("grunt-remove-logging");
     grunt.loadNpmTasks('grunt-contrib-compress');
 
     // Default task(s).
-    grunt.registerTask('default', ['json-replace', 'jshint', 'clean', 'copy', 'removelogging', 'compress']);
+    grunt.registerTask('default', ['json-replace', 'jshint', 'clean', 'copy', 'replace', 'removelogging', 'compress']);
 
 };
diff --git a/cookie-editor.js b/cookie-editor.js
@@ -1,4 +1,5 @@
 if (typeof importScripts === 'function') {
+    importScripts('interface/lib/env.js');
     importScripts('interface/lib/browserDetector.js');
 }
 
@@ -33,6 +34,12 @@ if (typeof importScripts === 'function') {
         }
     });
 
+    if (browserDetector.supportsSidePanel()) {
+        browserDetector.getApi().sidePanel
+            .setPanelBehavior({ openPanelOnActionClick: false })
+            .catch((error) => console.error(error));
+    }
+
     function handleMessage(request, sender, sendResponse) {
         console.log('message received: ' + (request.type || 'unknown'));
         switch (request.type) {

diff --git a/interface/devtools/cookie-list.html b/interface/devtools/cookie-list.html
@@ -110,6 +110,7 @@ <h1 class="container">Cookie Editor</h1>
 
 <script src="../lib/animate.js"></script>
 <script src="../lib/event.js"></script>
+<script src="../lib/env.js"></script>
 <script src="../lib/browserDetector.js"></script>
 <script src="../lib/cookie.js"></script>
 <script src="../lib/genericCookieHandler.js"></script>

diff --git a/interface/devtools/devtool.html b/interface/devtools/devtool.html
@@ -2,6 +2,7 @@
 <html>
 <head>
 	<meta charset="utf-8">
+	<script src="../lib/env.js"></script>
 	<script src="../lib/browserDetector.js"></script>
 	<script src="devtools.js"></script>
 </head>

diff --git a/interface/lib/browserDetector.js b/interface/lib/browserDetector.js
@@ -1,61 +1,42 @@
 function BrowserDetector() {
     'use strict';
+    const env = new Env();
     let namespace = chrome || window.browser || window.chrome;
-    let browserName;
     let doesSupportSameSiteCookie = null;
     let isIos = false;
     let supportPromises = false;
-
-    try {
-        supportPromises = namespace.runtime.getPlatformInfo() instanceof Promise;
-    }
-    catch (e) {
-    }
-
-    if (namespace === chrome || namespace === window.chrome) {
-        if (supportPromises) {
-            browserName = 'safari';
-        }
-        else {
-            browserName = 'chrome';
-        }
-    } else if (namespace === window.browser) {
-        if (supportPromises) {
-            browserName = 'firefox';
-        }
-        else {
-            browserName = 'edge';
-        }
-    }
-
-    console.log(browserName);
+    let supportSidePanel = false;
 
     this.getApi = function () {
         return namespace;
     };
 
     this.isFirefox = function () {
-        return browserName === 'firefox';
+        return env.browserName === 'firefox';
     };
 
     this.isChrome = function () {
-        return browserName === 'chrome';
+        return env.browserName === 'chrome';
     };
 
     this.isEdge = function () {
-        return browserName === 'edge';
+        return env.browserName === 'edge';
     };
 
     this.isSafari = function () {
-        return browserName === 'safari';
+        return env.browserName === 'safari';
     };
 
     this.supportsPromises = function () {
         return this.supportPromises;
     }
 
+    this.supportsSidePanel = function () {
+        return this.supportSidePanel;
+    }
+
     this.getBrowserName = function () {
-        return browserName;
+        return env.browserName;
     }
 
     this.supportSameSiteCookie = function () {
@@ -96,6 +77,28 @@ function BrowserDetector() {
         return doesSupportSameSiteCookie;
     }
 
+    try {
+        supportPromises = namespace.runtime.getPlatformInfo() instanceof Promise;
+        console.info('Promises support: ', supportPromises);
+    }
+    catch (e) {
+    }
+
+    try {
+        supportSidePanel = typeof this.getApi().sidePanel !== "undefined";
+        console.info('SidePanel support: ', supportSidePanel);
+    }
+    catch (e) {
+    }
+
+    if (env.browserName === "@@browser_name") {
+        env.browserName = "chrome";
+        console.warn("undefined browser name, using chrome as fallback");
+    }
+
+    console.log(env.browserName);
+
+
     // We call it right away to make sure the value of doesSupportSameSiteCookie is initialized
     this.supportSameSiteCookie();
 }
diff --git a/interface/lib/env.js b/interface/lib/env.js
@@ -0,0 +1,3 @@
+function Env() {
+    this.browserName = "@@browser_name";
+}
diff --git a/interface/popup-android/cookie-list.html b/interface/popup-android/cookie-list.html
@@ -112,6 +112,7 @@ <h2></h2>
 
     <script src="../lib/animate.js"></script>
     <script src="../lib/event.js"></script>
+    <script src="../lib/env.js"></script>
     <script src="../lib/browserDetector.js"></script>
     <script src="../lib/cookie.js"></script>
     <script src="../lib/genericCookieHandler.js"></script>

diff --git a/interface/popup-ios/cookie-list.html b/interface/popup-ios/cookie-list.html
@@ -112,6 +112,7 @@ <h2></h2>
 
     <script src="../lib/animate.js"></script>
     <script src="../lib/event.js"></script>
+    <script src="../lib/env.js"></script>
     <script src="../lib/browserDetector.js"></script>
     <script src="../lib/cookie.js"></script>
     <script src="../lib/genericCookieHandler.js"></script>

diff --git a/interface/popup/cookie-list.html b/interface/popup/cookie-list.html
@@ -110,6 +110,7 @@ <h1 class="container">Cookie Editor</h1>
     <script src="../lib/isPopup.js"></script>
     <script src="../lib/animate.js"></script>
     <script src="../lib/event.js"></script>
+    <script src="../lib/env.js"></script>
     <script src="../lib/browserDetector.js"></script>
     <script src="../lib/cookie.js"></script>
     <script src="../lib/genericCookieHandler.js"></script>

diff --git a/manifest.chrome.json b/manifest.chrome.json
@@ -1,7 +1,7 @@
 {
 	"manifest_version": 3,
 	"name": "Cookie-Editor",
-	"version": "1.11.0",
+	"version": "1.12.0",
 	"author": "Moustachauve",
 	"description": "Simple yet powerful Cookie Editor that allow you to quickly create, edit and delete cookies without leaving your tab.",
 	"offline_enabled": true,
@@ -19,11 +19,15 @@
 		"default_title": "Cookie-Editor",
 		"default_popup": "interface/popup/cookie-list.html"
 	},
+	"side_panel": {
+		"default_path": "interface/popup/cookie-list.html"
+	},
 	"devtools_page": "interface/devtools/devtool.html",
 	"permissions": [
 		"cookies",
 		"tabs",
-		"storage"
+		"storage",
+		"sidePanel"
 	],
 	"host_permissions": [
 		"<all_urls>"

diff --git a/manifest.edge.json b/manifest.edge.json
@@ -1,7 +1,7 @@
 {
 	"manifest_version": 3,
 	"name": "Cookie-Editor",
-	"version": "1.11.0",
+	"version": "1.12.0",
 	"author": "Moustachauve",
 	"description": "Simple yet powerful Cookie Editor that allow you to quickly create, edit and delete cookies without leaving your tab.",
 	"offline_enabled": true,
@@ -18,11 +18,15 @@
 		"default_title": "Cookie-Editor",
 		"default_popup": "interface/popup/cookie-list.html"
 	},
+	"side_panel": {
+		"default_path": "interface/popup/cookie-list.html"
+	},
 	"devtools_page": "interface/devtools/devtool.html",
 	"permissions": [
 		"cookies",
 		"tabs",
-		"storage"
+		"storage",
+		"sidePanel"
 	],
 	"host_permissions": [
 		"<all_urls>"

diff --git a/manifest.firefox.json b/manifest.firefox.json
@@ -1,7 +1,7 @@
 {
 	"manifest_version": 2,
 	"name": "Cookie-Editor",
-	"version": "1.11.0",
+	"version": "1.12.0",
 	"description": "Simple yet powerful Cookie Editor that allow you to quickly create, edit and delete cookies without leaving your tab.",
 	"background": {
 		"scripts": [
@@ -36,6 +36,14 @@
 		"default_title": "Cookie-Editor",
 		"default_popup": "interface/popup/cookie-list.html"
 	},
+	"sidebar_action": {
+		"default_icon": {
+			"16": "icons/cookie-filled-small.svg",
+			"32": "icons/cookie-filled-small.svg"
+		},
+		"default_title": "Cookie-Editor",
+		"default_panel": "interface/popup/cookie-list.html"
+	},
 	"devtools_page": "interface/devtools/devtool.html",
 	"permissions": [
 		"cookies",

diff --git a/manifest.opera.json b/manifest.opera.json
@@ -1,7 +1,7 @@
 {
 	"manifest_version": 2,
 	"name": "Cookie-Editor",
-	"version": "1.11.0",
+	"version": "1.12.0",
 	"author": "Moustachauve",
 	"description": "Simple yet powerful Cookie Editor that allow you to quickly create, edit and delete cookies without leaving your tab.",
 	"offline_enabled": true,

diff --git a/manifest.safari.json b/manifest.safari.json
@@ -1,7 +1,7 @@
 {
 	"manifest_version": 3,
 	"name": "Cookie-Editor",
-	"version": "1.11.0",
+	"version": "1.12.0",
 	"author": "Moustachauve",
 	"description": "Simple yet powerful Cookie Editor that allow you to quickly create, edit and delete cookies without leaving your tab.",
 	"offline_enabled": true,