Move trackers-preview to the main repository (#1270)

* Move libs to packages

* Move UI to packages

* Add trackers preview to packages

* Move configs

Author: smalluban

extension-manifest-v3/.editorconfig .editorconfig

@@ -13,6 +13,3 @@ block_comment_end = */
 
 [*.md]
 indent_size = 4
-
-[src/_locales/**/*.json]
-indent_style = tab

ui/.eslintrc .eslintrc

@@ -1,10 +1,11 @@
 {
+  "root": true,
   "env": {
     "es2020": true,
     "browser": true,
+    "node": true,
     "serviceworker": true,
-    "webextensions": true,
-    "mocha": true
+    "webextensions": true
   },
   "extends": [
     "eslint:recommended",

.github/workflows/test-libs.yml

@@ -1,4 +1,4 @@
-name: Test UI
+name: Linting & code style in packages
 
 on:
   push:
@@ -9,9 +9,6 @@ on:
 jobs:
   test-ui:
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ui
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
@@ -22,4 +19,12 @@ jobs:
       - name: Install dependencies in repo root
         run: npm ci
         working-directory: .
-      - run: npm run lint
+      - name: packages/libs
+        run: npm test
+        working-directory: packages/libs
+      - name: packages/trackers-preview
+        run: npm test
+        working-directory: packages/trackers-preview
+      - name: packages/ui
+        run: npm test
+        working-directory: packages/ui

.github/workflows/test-ui.yml .github/workflows/test-packages.yml

@@ -12,6 +12,7 @@
  */
 
 module.exports = {
+	root: true,
 	env: {
 		browser: true,
 		jest: true,

extension-manifest-v2/.eslintrc.js

@@ -1,4 +1,4 @@
-import setupTrackersPreview from '@whotracksme/webextension-packages/packages/trackers-preview/src/content_scripts';
+import setupTrackersPreview from '@ghostery/trackers-preview/content_scripts';
 
 setupTrackersPreview(
 	chrome.runtime.getURL('/app/templates/trackers-preview.html'),

extension-manifest-v2/app/content-scripts/trackers-preview.js

@@ -1 +1 @@
-@import "@whotracksme/webextension-packages/packages/trackers-preview/src/content_scripts/styles.css";
+@import "@ghostery/trackers-preview/content_scripts/styles.css";

extension-manifest-v2/app/scss/trackers-preview_content_script.scss

@@ -18,7 +18,7 @@ import {
 	close,
 	disable,
 	updateIframeHeight
-} from '@whotracksme/webextension-packages/packages/trackers-preview/src/page_scripts';
+} from '@ghostery/trackers-preview/page_scripts';
 
 const domain = new URLSearchParams(window.location.search).get('domain');
 const stats = getStats(domain);

extension-manifest-v2/app/trackers-preview/index.js

@@ -25,10 +25,9 @@
     "leet": "node ./tools/leet/leet-en.js",
     "leet.reset": "node ./tools/leet/leet-reset.js",
     "download-trackerdb": "node --input-type=module ./tools/download-trackerdb.js",
-    "locales.wtm": "hybrids extract -c --format=chrome.i18n ../node_modules/@whotracksme/webextension-packages/packages ./_locales/en/messages.json",
     "locales.ui": "hybrids extract -c --format=chrome.i18n ../node_modules/@ghostery/ui ./_locales/en/messages.json",
     "locales.src": "hybrids extract -c --format=chrome.i18n ./app ./_locales/en/messages.json",
-    "locales": "npm run locales.wtm && npm run locales.ui && npm run locales.src"
+    "locales": "npm run locales.ui && npm run locales.src"
   },
   "repository": {
     "type": "git",
@@ -45,9 +44,10 @@
     "@cliqz/url-parser": "^1.1.5",
     "@duckduckgo/autoconsent": "^4.3.3",
     "@ghostery/libs": "^1.0.0",
-    "@ghostery/ui": "^0.3.3",
+    "@ghostery/trackers-preview": "^1.0.0",
+    "@ghostery/ui": "^1.0.0",
     "@sentry/browser": "7.1.1",
-    "@whotracksme/webextension-packages": "^3.0.2",
+    "@whotracksme/webextension-packages": "^4.0.0",
     "classnames": "^2.3.2",
     "d3": "^5.16.0",
     "foundation-sites": "^6.6.2",
@@ -78,7 +78,6 @@
     "enzyme-adapter-react-16": "^1.15.3",
     "esbuild-jest": "^0.5.0",
     "esbuild-loader": "^2.20.0",
-    "eslint": "^8.36.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-import-resolver-webpack": "^0.13.2",
     "eslint-plugin-import": "^2.26.0",

extension-manifest-v2/package.json

@@ -16,7 +16,7 @@
  */
 import { debounce, every, size } from 'underscore';
 import moment from 'moment';
-import { tryWTMReportOnMessageHandler, isDisableWTMReportMessage } from '@whotracksme/webextension-packages/packages/trackers-preview/src/background/index';
+import { tryWTMReportOnMessageHandler, isDisableWTMReportMessage } from '@ghostery/trackers-preview/background';
 import { getBrowserInfo } from '@ghostery/libs';
 import browser from 'webextension-polyfill';
 

extension-manifest-v2/src/background.js

@@ -1,6 +1,6 @@
+import { getCategoryColor } from '@ghostery/ui/categories';
 import { BugDb } from '../../src/classes/BugDb';
 import globals from '../../src/classes/Globals';
-import { getCategoryColor } from '../../../ui/src/utils/categories';
 
 const { CATEGORIES_BLOCKED_BY_DEFAULT } = globals;
 

extension-manifest-v2/test/src/BugDb.test.js

@@ -1,19 +1,4 @@
 {
-  "env": {
-    "es2020": true,
-    "browser": true,
-    "node": true,
-    "serviceworker": true,
-    "webextensions": true
-  },
-  "extends": [
-    "eslint:recommended",
-    "plugin:prettier/recommended"
-  ],
-  "parserOptions": {
-    "ecmaVersion": "latest",
-    "sourceType": "module"
-  },
   "globals": {
     "__PLATFORM__": "readonly"
   }

extension-manifest-v3/.eslintrc

@@ -12,10 +12,9 @@
     "licenses": "node ../tools/licenses.js",
     "lint": "eslint src/",
     "test": "npm run lint",
-    "locales.wtm": "hybrids extract -c --format=chrome.i18n ../node_modules/@whotracksme/webextension-packages/packages ./src/_locales/en/messages.json",
     "locales.ui": "hybrids extract -c --format=chrome.i18n ../node_modules/@ghostery/ui ./src/_locales/en/messages.json",
     "locales.src": "hybrids extract -c --format=chrome.i18n ./src ./src/_locales/en/messages.json",
-    "locales": "npm run locales.wtm && npm run locales.ui && npm run locales.src",
+    "locales": "npm run locales.ui && npm run locales.src",
     "xcode-export-locales": "rm -rf ./xcode/en.xcloc && xcodebuild -exportLocalizations -project ./xcode/Ghostery.xcodeproj -localizationPath ./xcode",
     "release": "./scripts/release.sh"
   },
@@ -26,11 +25,7 @@
   },
   "license": "MPL-2.0",
   "devDependencies": {
-    "eslint": "^8.36.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^4.0.0",
     "node-fetch": "^3.2.3",
-    "prettier": "^2.6.1",
     "shelljs": "^0.8.5",
     "vite": "^4.0.2",
     "web-ext": "^7.6.2"
@@ -40,9 +35,10 @@
     "@cliqz/adblocker-webextension-cosmetics": "^1.26.6",
     "@duckduckgo/autoconsent": "^4.3.3",
     "@ghostery/libs": "^1.0.0",
-    "@ghostery/ui": "^0.3.3",
+    "@ghostery/trackers-preview": "^1.0.0",
+    "@ghostery/ui": "^1.0.0",
     "@github/relative-time-element": "^4.1.5",
-    "@whotracksme/webextension-packages": "^3.0.2",
+    "@whotracksme/webextension-packages": "^4.0.0",
     "hybrids": "^8.2.2",
     "idb": "^7.1.1",
     "jwt-decode": "^3.1.2",

extension-manifest-v3/package.json

@@ -13,7 +13,7 @@ import { store } from 'hybrids';
 import {
   tryWTMReportOnMessageHandler,
   isDisableWTMReportMessage,
-} from '@whotracksme/webextension-packages/packages/trackers-preview/background';
+} from '@ghostery/trackers-preview/background';
 
 import Options from '/store/options.js';
 

extension-manifest-v3/src/background/trackers-preview.js

@@ -9,4 +9,21 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0
  */
 
-import '@whotracksme/webextension-packages/packages/prevent-serp-tracking/src/content_scripts/prevent-serp-tracking.js';
+function safeLinkClick(event) {
+  let el = event.target;
+  while (el && !el.href) el = el.parentElement;
+
+  if (!el) return;
+
+  el.removeAttribute('ping');
+
+  const targetUrl =
+    el.pathname === '/url' && new URL(el.href).searchParams.get('url');
+
+  if (targetUrl) {
+    event.stopImmediatePropagation();
+    el.href = targetUrl;
+  }
+}
+
+document.addEventListener('click', safeLinkClick, true);

extension-manifest-v3/src/content_scripts/prevent-serp-tracking.js

@@ -9,7 +9,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0
  */
 
-import setupTrackersPreview from '@whotracksme/webextension-packages/packages/trackers-preview/content_scripts';
+import setupTrackersPreview from '@ghostery/trackers-preview/content_scripts';
 
 setupTrackersPreview(
   chrome.runtime.getURL('pages/trackers-preview/index.html'),

extension-manifest-v3/src/content_scripts/trackers-preview.js

@@ -496,7 +496,7 @@
       ],
       "run_at": "document_end",
       "css": [
-        "node_modules/@whotracksme/webextension-packages/packages/trackers-preview/src/content_scripts/styles.css"
+        "node_modules/@ghostery/trackers-preview/src/content_scripts/styles.css"
       ],
       "js": [
         "content_scripts/trackers-preview.js"

extension-manifest-v3/src/manifest.chromium.json

@@ -476,7 +476,7 @@
       ],
       "run_at": "document_end",
       "css": [
-        "node_modules/@whotracksme/webextension-packages/packages/trackers-preview/src/content_scripts/styles.css"
+        "node_modules/@ghostery/trackers-preview/src/content_scripts/styles.css"
       ],
       "js": [
         "content_scripts/trackers-preview.js"

extension-manifest-v3/src/manifest.firefox.json

@@ -502,7 +502,7 @@
       ],
       "run_at": "document_end",
       "css": [
-        "node_modules/@whotracksme/webextension-packages/packages/trackers-preview/src/content_scripts/styles.css"
+        "node_modules/@ghostery/trackers-preview/src/content_scripts/styles.css"
       ],
       "js": [
         "content_scripts/trackers-preview.js"

extension-manifest-v3/src/manifest.safari.json

@@ -16,7 +16,7 @@ import {
   close,
   disable,
   updateIframeHeight,
-} from '@whotracksme/webextension-packages/packages/trackers-preview/page_scripts';
+} from '@ghostery/trackers-preview/page_scripts';
 
 const domain = new URLSearchParams(window.location.search).get('domain');
 const stats = getStats(domain);