Migrate to manifest v3

.github/workflows/tests.yml

@@ -17,6 +17,10 @@ on:
 env:
   APP_NAME: bookmarks
 
+concurrency:
+  group: floccus-tests-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
 jobs:
   php:
     runs-on: ubuntu-latest
@@ -26,7 +30,6 @@ jobs:
       TEST_HOST: nextcloud
       SERVER_BRANCH: ${{ matrix.server-version }}
       NC_APP_VERSION: ${{ matrix.app-version }}
-      SELENIUM_VERSION: 3
       MYSQL_PASSWORD: root
 
     strategy:
@@ -35,9 +38,8 @@ jobs:
       matrix:
         node-version: [14.x]
         npm-version: [7.x]
-        server-version: ['26']
-        app-version: ['stable']
-        selenium-version: ['3']
+        server-version: ['25']
+        app-version: ['stable12']
         floccus-adapter:
           - fake
           - nextcloud-bookmarks
@@ -51,10 +53,12 @@ jobs:
         test-name:
           - test
           - benchmark root
-        browsers: ['firefox']
+        browsers:
+          - firefox
+          - chrome
         include:
-          - app-version: stable12
-            server-version: 25
+          - app-version: stable
+            server-version: 26
             floccus-adapter: nextcloud-bookmarks
             test-name: test
             browsers: firefox
@@ -93,20 +97,25 @@ jobs:
 
     services:
       hub:
-        image: selenium/hub:3
+        image: selenium/hub:4.11.0-20230801
         ports:
+          - 4442:4442
+          - 4443:4443
           - 4444:4444
       firefox:
-        image: selenium/node-firefox:3
+        image: selenium/node-firefox:4.11.0-20230801
+
         env:
-          HUB_HOST: hub
-          HUB_PORT: 4444
+          SE_EVENT_BUS_HOST: hub
+          SE_EVENT_BUS_PUBLISH_PORT: 4442
+          SE_EVENT_BUS_SUBSCRIBE_PORT: 4443
         options: --shm-size="2g"
       chrome:
-        image: selenium/node-chrome:3
+        image: selenium/node-chrome:4.11.0-20230801
         env:
-          HUB_HOST: hub
-          HUB_PORT: 4444
+          SE_EVENT_BUS_HOST: hub
+          SE_EVENT_BUS_PUBLISH_PORT: 4442
+          SE_EVENT_BUS_SUBSCRIBE_PORT: 4443
         options: --shm-size="2g"
       nextcloud:
         image: nextcloud:${{ matrix.server-version }}
@@ -193,6 +202,17 @@ jobs:
           npm ci
           npm run build-release --if-present
 
+      - name: Wait for Selenium
+        run: |
+          sudo apt install -y jq
+          while ! curl -sSL "http://localhost:4444/wd/hub/status" 2>&1 \
+                | jq -r '.value.ready' 2>&1 | grep "true" >/dev/null; do
+            echo 'Waiting for the Grid'
+            sleep 1
+          done
+
+          echo "Selenium Grid is up - executing tests"
+
       - name: Run tests
         working-directory: floccus
         env:

_locales/en/messages.json

@@ -104,6 +104,9 @@
   "Error035": {
     "message": "E035: Failed to create the following bookmark on the server: {0}"
   },
+  "Error036": {
+    "message": "E036: Missing permissions to access the sync server"
+  },
   "LabelWebdavurl": {
     "message": "WebDAV URL"
   },
@@ -263,12 +266,6 @@
   "LabelAddaccount": {
     "message": "Add account"
   },
-  "LabelSecurecredentials": {
-    "message": "Secure your credentials"
-  },
-  "LabelSecuredcredentials": {
-    "message": "Your credentials are secure"
-  },
   "LabelOpenintab": {
     "message": "Open in tab"
   },
@@ -287,12 +284,6 @@
   "LabelUntitledfolder": {
     "message": "Untitled folder"
   },
-  "LabelSetkey": {
-    "message": "Set a passphrase for floccus"
-  },
-  "DescriptionSetkey": {
-    "message": "When you set a passphrase you will have to enter this pass phrase everytime you start your browser if you want to access and synchronize your bookmarks, change your settings or do anything else with floccus."
-  },
   "LabelSetkeybutton": {
     "message": "Set passphrase"
   },

gulpfile.js

@@ -44,6 +44,7 @@ const paths = {
     '!key.pem',
     '!android/**',
     '!ios/**',
+    '!manifest*.json'
   ],
   views: './html/*.html',
   nativeHTML: './html/index.html',
@@ -53,6 +54,10 @@ const paths = {
   icons: 'icons/*',
   dist: './dist/**'
 }
+
+paths.chromeZip = [...paths.zip, 'manifest.chrome.json']
+paths.firefoxZip = [...paths.zip, 'manifest.firefox.json']
+
 const WEBSTORE_ID = 'fnaicdffflnofjppbagibeoednhnbjhg'
 
 let WEBSTORE_CREDENTIALS
@@ -120,36 +125,58 @@ const build = gulp.parallel(assets, js)
 
 const main = gulp.series(build, native)
 
-const zip = function() {
+const chromeZip = function() {
   return gulp
-    .src(paths.zip, { buffer: false })
-    .pipe(gulpZip(`floccus-build-v${VERSION}.zip`))
+    .src(paths.chromeZip, { buffer: false })
+    .pipe(rename((path) => {
+      if (path.basename.startsWith('manifest') && path.extname === '.json') {
+        path.basename = 'manifest'
+      }
+    }))
+    .pipe(gulpZip(`floccus-build-v${VERSION}-chrome.zip`))
+    .pipe(gulp.dest(paths.builds))
+}
+
+const firefoxZip = function() {
+  return gulp
+    .src(paths.firefoxZip, { buffer: false })
+    .pipe(rename((path) => {
+      if (path.basename.startsWith('manifest') && path.extname === '.json') {
+        path.basename = 'manifest'
+      }
+    }))
+    .pipe(gulpZip(`floccus-build-v${VERSION}-firefox.zip`))
     .pipe(gulp.dest(paths.builds))
 }
 
 const xpi = function() {
   return gulp
-    .src(paths.zip, { buffer: false })
+    .src(paths.firefoxZip, { buffer: false })
+    .pipe(rename((path) => {
+      if (path.basename.startsWith('manifest') && path.extname === '.json') {
+        path.basename = 'manifest'
+      }
+    }))
     .pipe(gulpZip(`floccus-build-v${VERSION}.xpi`))
     .pipe(gulp.dest(paths.builds))
 }
 
 const crx = function() {
   return crx3(
-    fs.createReadStream(`${paths.builds}/floccus-build-v${VERSION}.zip`),
+    fs.createReadStream(`${paths.builds}/floccus-build-v${VERSION}-chrome.zip`),
     {
       keyPath: 'key.pem',
       crxPath: `${paths.builds}/floccus-build-v${VERSION}.crx`,
     }
   )
 }
 
-const release = gulp.series(main, gulp.parallel(zip, xpi), crx)
+const release = gulp.series(main, gulp.parallel(firefoxZip, chromeZip, xpi), crx)
 
-const publish = gulp.series(main, zip, function() {
+const publish = gulp.series(main, chromeZip, function() {
   return webstore
     .uploadExisting(
-      fs.createReadStream(`${paths.builds}floccus-build-v${VERSION}.zip`)
+      fs.createReadStream(`${paths.builds}floccus-build-v${VERSION}-chrome.zip`)
     )
     .then(function() {
       return webstore.publish('default')

html/options.html

@@ -23,7 +23,6 @@
   </head>
   <body>
     <div id="app"></div>
-    <script src="../../lib/chrome-promise.js"></script>
     <script src="../js/options.js"></script>
   </body>
 </html>

html/test.html

@@ -8,7 +8,6 @@
   <div id="mocha"></div>
 
   <script src="../js/mocha.js"></script>
-  <script src="../../lib/chrome-promise.js"></script>
   <script src="../js/test.js"></script>
 </body>
 </html>

manifest.chrome.json

@@ -0,0 +1,40 @@
+{
+  "manifest_version": 3,
+  "name": "floccus bookmarks sync",
+  "short_name": "floccus",
+  "version": "5.0.0",
+  "description": "__MSG_DescriptionExtension__",
+  "icons": {
+    "48": "icons/logo.png",
+    "64": "icons/logo_64.png",
+    "128": "icons/logo_128.png"
+  },
+
+  "default_locale": "en",
+
+  "permissions": ["alarms", "bookmarks", "storage", "unlimitedStorage", "tabs", "identity"],
+  "host_permissions": [
+    "*://*/*"
+  ],
+  "content_security_policy": {
+    "extension_pages": "script-src 'self'; object-src 'self';"
+  },
+
+  "options_ui": {
+    "page": "dist/html/options.html",
+    "browser_style": false
+  },
+
+  "action": {
+    "browser_style": false,
+    "default_icon": {
+      "48": "icons/logo.png"
+    },
+    "default_title": "Open Floccus options",
+    "default_popup": "dist/html/options.html"
+  },
+
+  "background": {
+    "service_worker": "dist/js/background-script.js"
+  }
+}