feat: User agent data simulator

14 files changed, 380 insertions, 78 deletions

diff --git a/package.json b/package.json
index b03bdd4..5ea6ecb 100644
--- a/package.json
+++ b/package.json
@@ -25,6 +25,7 @@
     "main": "yarn workspace @sophie/main",
     "preload": "yarn workspace @sophie/preload",
     "renderer": "yarn workspace @sophie/renderer",
+    "service-inject": "yarn workspace @sophie/service-inject",
     "service-preload": "yarn workspace @sophie/service-preload",
     "service-shared": "yarn workspace @sophie/service-shared",
     "shared": "yarn workspace @sophie/shared"
@@ -33,6 +34,7 @@
     "packages/main",
     "packages/preload",
     "packages/renderer",
+    "packages/service-inject",
     "packages/service-preload",
     "packages/service-shared",
     "packages/shared"
diff --git a/packages/main/src/index.ts b/packages/main/src/index.ts
index b6df67b..70acb15 100644
--- a/packages/main/src/index.ts
+++ b/packages/main/src/index.ts
@@ -19,6 +19,7 @@
  */
 
 import { app, BrowserView, BrowserWindow } from 'electron';
+import { readFile, readFileSync } from 'fs';
 import { autorun } from 'mobx';
 import { getSnapshot, onPatch } from 'mobx-state-tree';
 import { join } from 'path';
@@ -39,7 +40,6 @@ import {
   openDevToolsWhenReady,
 } from './devTools';
 import { createRootStore } from './stores/RootStore';
-import { reduceUserAgent } from './userAgent';
 
 const isDevelopment = import.meta.env.MODE === 'development';
 
@@ -67,12 +67,33 @@ app.commandLine.appendSwitch(
 
 // Remove sophie and electron from the user-agent string to avoid detection.
 const originalUserAgent = app.userAgentFallback;
-const userAgent = reduceUserAgent(originalUserAgent);
+const userAgent = originalUserAgent.replaceAll(/\s(sophie|Electron)\/\S+/g, '');
+const platformInUa = userAgent.match(/\((Win|Mac|X11; L)/);
+let platform = 'Unknown';
+if (platformInUa !== null) {
+  switch (platformInUa[1]) {
+    case 'Win':
+      platform = 'Windows';
+      break;
+    case 'Mac':
+      platform = 'macOS';
+      break;
+    case 'X11; L':
+      platform = 'Linux';
+      break;
+  }
+}
+const chromiumVersion = process.versions.chrome.split('.')[0];
 // Removing the electron version breaks redux devtools, so we only do this in production.
 if (!isDevelopment) {
   app.userAgentFallback = userAgent;
 }
 
+let serviceInjectRelativePath = '../../service-inject/dist/index.cjs';
+let serviceInjectPath = join(__dirname, serviceInjectRelativePath);
+let serviceInjectUrl = new URL(serviceInjectRelativePath, `file://${__dirname}`).toString();
+let serviceInject: string = readFileSync(serviceInjectPath, 'utf8');
+
 if (isDevelopment) {
   installDevToolsExtensions(app);
 }
@@ -92,7 +113,7 @@ function createWindow(): Promise<unknown> {
   });
 
   if (isDevelopment) {
-    openDevToolsWhenReady(mainWindow);
+    //openDevToolsWhenReady(mainWindow);
   }
 
   mainWindow.on('ready-to-show', () => {
@@ -131,7 +152,14 @@ function createWindow(): Promise<unknown> {
           store.setPaletteMode(paletteMode.parse(args[0]))
           break;
         case RendererToMainIpcMessage.ReloadAllServices:
-          browserView.webContents.reload();
+          readFile(serviceInjectPath, 'utf8', (err, data) => {
+            if (err === null) {
+              serviceInject = data;
+            } else {
+              console.error('Error while reloading', serviceInjectPath, err);
+            }
+            browserView.webContents.reload();
+          });
           break;
         default:
           console.error('Unknown IPC message:', channel, args);
@@ -149,6 +177,16 @@ function createWindow(): Promise<unknown> {
   browserView.webContents.on('ipc-message', (_event, channel, ...args) => {
     try {
       switch (channel) {
+        case ServiceToMainIpcMessage.ApiExposedInMainWorld:
+          browserView.webContents.executeJavaScriptInIsolatedWorld(0, [
+            {
+              code: serviceInject,
+              url: serviceInjectUrl,
+            }
+          ]).catch((err) => {
+            console.error('Cannot inject script:', err);
+          });
+          break;
         case ServiceToMainIpcMessage.SetUnreadCount:
           console.log('Unread count:', unreadCount.parse(args[0]));
           break;
@@ -172,13 +210,21 @@ function createWindow(): Promise<unknown> {
     );
   });
 
+  browserView.webContents.session.webRequest.onBeforeSendHeaders(({ requestHeaders }, callback) => {
+    requestHeaders['User-Agent'] = userAgent;
+    requestHeaders['Sec-CH-UA'] = `" Not A;Brand";v="99", "Chromium";v="${chromiumVersion}"`;
+    requestHeaders['Sec-CH-UA-Mobile'] = '?0';
+    requestHeaders['Sec-CH-UA-Platform'] = platform;
+    callback({ requestHeaders });
+  });
+
   const pageUrl = (isDevelopment && import.meta.env.VITE_DEV_SERVER_URL !== undefined)
     ? import.meta.env.VITE_DEV_SERVER_URL
     : new URL('../renderer/dist/index.html', `file://${__dirname}`).toString();
 
   return Promise.all([
     mainWindow.loadURL(pageUrl),
-    browserView.webContents.loadURL('https://git.marussy.com/sophie/about'),
+    browserView.webContents.loadURL('https://gmail.com').then(() => browserView.webContents.openDevTools()),
   ]);
 }
 
diff --git a/packages/main/src/userAgent.ts b/packages/main/src/userAgent.ts
deleted file mode 100644
index 298e565..0000000
--- a/packages/main/src/userAgent.ts
+++ /dev/null
@@ -1,61 +0,0 @@
-/*
- * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
- *
- * This file is part of Sophie.
- *
- * Sophie is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- *
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-
-/**
- * @file Based on the javascript code snippet available at
- * https://github.com/GoogleChrome/developer.chrome.com/blob/c33f7f4f2964e7deb28aee44de745c3725b70063/site/en/docs/privacy-sandbox/user-agent/snippets/index.md
- *
- * Used under the Apache 2.0 license according to
- * https://github.com/GoogleChrome/developer.chrome.com/blob/c33f7f4f2964e7deb28aee44de745c3725b70063/LICENSE
- */
-
-const electronUAParts = / (sophie|Electron)\/[^\s]+/g;
-const chromeUAs = /^Mozilla\/5\.0 \(((?<platform>Lin|Win|Mac|X11; C|X11; L)+[^\)]+)\) AppleWebKit\/537.36 \(KHTML, like Gecko\) Chrome\/(?<major>\d+)[\d\.]+(?<mobile>[ Mobile]*) Safari\/537\.36$/;
-const unifiedPlatform = {
-  'Lin': 'Linux; Android 10; K',
-  'Win': 'Windows NT 10.0; Win64; x64',
-  'Mac': 'Macintosh; Intel Mac OS X 10_15_7',
-  'X11; C': 'X11; CrOS x86_64',
-  'X11; L': 'X11; Linux x86_64',
-};
-
-/**
- * Reduces the information exposed in the user-agent string.
- *
- * @param userAgent The original user-agent string.
- * @returns The reduces user-agent string.
- * @see https://developer.chrome.com/docs/privacy-sandbox/user-agent/
- */
-export function reduceUserAgent(userAgent: string): string {
-  const userAgentWithoutElectron = userAgent.replaceAll(electronUAParts, '');
-  const matched = chromeUAs.exec(userAgentWithoutElectron) as unknown as {
-    groups: {
-      platform: 'Lin' | 'Win' | 'Mac' | 'X11; C' | 'X11; L',
-      major: string,
-      mobile: string,
-    }
-  };
-  if (matched) {
-    return `Mozilla/5.0 (${unifiedPlatform[matched.groups.platform]}) ` +
-      `AppleWebKit/537.36 (KHTML, like Gecko) ` +
-      `Chrome/${matched.groups.major}.0.0.0${matched.groups.mobile} Safari/537.36`
-  }
-  return userAgentWithoutElectron;
-}
diff --git a/packages/service-inject/package.json b/packages/service-inject/package.json
new file mode 100644
index 0000000..e2d03bf
--- /dev/null
+++ b/packages/service-inject/package.json
@@ -0,0 +1,21 @@
+{
+  "name": "@sophie/service-inject",
+  "version": "0.1.0",
+  "private": true,
+  "sideEffects": false,
+  "main": "dist/index.cjs",
+  "types": "dist-types/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist dist-types tsconfig.tsbuildinfo",
+    "build": "vite build",
+    "typecheck": "tsc"
+  },
+  "dependencies": {
+    "@sophie/service-shared": "workspace:*"
+  },
+  "devDependencies": {
+    "rimraf": "^3.0.2",
+    "typescript": "^4.5.4",
+    "vite": "^2.7.6"
+  }
+}
diff --git a/packages/service-inject/src/index.ts b/packages/service-inject/src/index.ts
new file mode 100644
index 0000000..7f48fdf
--- /dev/null
+++ b/packages/service-inject/src/index.ts
@@ -0,0 +1,27 @@
+/*
+ * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
+ *
+ * This file is part of Sophie.
+ *
+ * Sophie is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+import { shimUserAgentData } from './shims/userAgentData';
+
+try {
+  shimUserAgentData();
+} catch (err) {
+  console.log('Failed to execute injected script:', err);
+}
diff --git a/packages/service-inject/src/shims/userAgentData.ts b/packages/service-inject/src/shims/userAgentData.ts
new file mode 100644
index 0000000..be43823
--- /dev/null
+++ b/packages/service-inject/src/shims/userAgentData.ts
@@ -0,0 +1,102 @@
+/*
+ * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
+ *
+ * This file is part of Sophie.
+ *
+ * Sophie is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+import {
+  defineProtoProperty,
+  deleteProtoProperty,
+  simulateNativeClass,
+  simulateNativeFunction,
+} from '../utils';
+
+export function shimUserAgentData(): void {
+  const brands = [
+    {
+      brand: ' Not A; Brand',
+      version: '99',
+    },
+    {
+      brand: 'Chromium',
+      version: '96',
+    }
+  ];
+  const mobile = false;
+  const platform = 'Linux';
+
+  const simulatedNavigatorUa = simulateNativeClass('NavigatorUAData', function NavigatorUAData() {
+    // Nothing to initiailize.
+  }, {
+    brands: {
+      configurable: true,
+      enumerable: true,
+      get: simulateNativeFunction('brands', () => brands),
+    },
+    mobile: {
+      configurable: true,
+      enumerable: true,
+      get: simulateNativeFunction('mobile', () => mobile),
+    },
+    platform: {
+      configurable: true,
+      enumerable: true,
+      get: simulateNativeFunction('platform', () => platform),
+    },
+    getHighEntropyValues: {
+      configurable: true,
+      enumerable: false,
+      value: simulateNativeFunction('getHighEntropyValues', (...args: unknown[]) => {
+        if (args.length == 0) {
+          throw new TypeError("Failed to execute 'getHighEntropyValues' on 'NavigatorUAData': 1 argument required, but only 0 present.");
+        }
+        const hints = Array.from(args[0] as Iterable<string>);
+        if (hints.length === 0) {
+          return {};
+        }
+        const data: Record<string, unknown> = {
+          brands,
+          mobile,
+        }
+        if (hints.includes('platform')) {
+          data['platform'] = platform;
+        }
+        return Promise.resolve(data);
+      })
+    },
+    toJSON: {
+      configurable: true,
+      enumerable: false,
+      value: simulateNativeFunction('toJSON', () => ({
+        brands,
+        mobile,
+      })),
+      writable: false,
+    },
+  });
+
+  const simulatedUserAgentData = Reflect.construct(simulatedNavigatorUa, []);
+  defineProtoProperty(window.navigator, 'userAgentData', {
+    configurable: true,
+    enumerable: true,
+    get: simulateNativeFunction('userAgentData', () => simulatedUserAgentData),
+  });
+}
+
+export function deleteUserAgentData(): void {
+  deleteProtoProperty(window.navigator, 'userAgentData');
+}
diff --git a/packages/service-inject/src/utils.ts b/packages/service-inject/src/utils.ts
new file mode 100644
index 0000000..4bb3fba
--- /dev/null
+++ b/packages/service-inject/src/utils.ts
@@ -0,0 +1,104 @@
+/*
+ * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
+ *
+ * This file is part of Sophie.
+ *
+ * Sophie is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+/**
+ * Simulates a function defined in native code, i.e., one with
+ * `[native code]` in its `toString`.
+ *
+ * @param name The name of the function.
+ * @param f The function to transform.
+ * @return The transformed function.
+ */
+export function simulateNativeFunction<T, P extends unknown[]>(
+  name: string,
+  f: (this: null, ...args: P) => T,
+): (...args: P) => T {
+  // Bound functions say `[native code]`, but unfortunately they omit the function name:
+  // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/toString#description
+  // The type of `f` contains type variables, so we need some magic type casting.
+  const boundFunc = f.bind(null as ThisParameterType<typeof f>);
+  Object.defineProperty(boundFunc, 'name', {
+    configurable: true,
+    enumerable: false,
+    value: name,
+    writable: false,
+  });
+  return boundFunc;
+}
+
+/**
+ * Simulates a native class available on `globalThis`.
+ *
+ * @param name The name of the class.
+ * @param constructor The constructor function. Must already be a constructor (a named `function`).
+ * @param properties The properties to define on the prototype.
+ */
+export function simulateNativeClass(
+  name: string,
+  constructor: () => void,
+  properties: PropertyDescriptorMap,
+) {
+  Object.defineProperties(constructor.prototype, {
+    [Symbol.toStringTag]: {
+      configurable: true,
+      enumerable: false,
+      value: name,
+      writable: false,
+    },
+    ...properties,
+  });
+  const simulatedConstructor = simulateNativeFunction(name, constructor);
+  Object.defineProperty(globalThis, name, {
+    configurable: true,
+    enumerable: true,
+    value: simulatedConstructor,
+    writable: true,
+  });
+  return simulatedConstructor;
+}
+
+/**
+ * Defines a property on the prototype of an object.
+ *
+ * Only use this with singleton objects, e.g., `window.navigator`.
+ *
+ * @param o The object to modify. Must be a singleton.
+ * @param property The key of the property being defined or modified.
+ * @param attributes The descriptor of the property being defined or modified.
+ */
+export function defineProtoProperty(
+  o: object,
+  property: PropertyKey,
+  attributes: PropertyDescriptor,
+): void {
+  Object.defineProperty(Object.getPrototypeOf(o), property, attributes);
+}
+
+/**
+ * Deletes a property from the prototype of an object.
+ *
+ * Only use this with singleton objects, e.g., `window.navigator`.
+ *
+ * @param o The object to modify. Must be a singleton.
+ * @param property The key of the property being deleted.
+ */
+export function deleteProtoProperty(o: object, property: PropertyKey): void {
+  Reflect.deleteProperty(Object.getPrototypeOf(o), property);
+}
diff --git a/packages/service-inject/tsconfig.json b/packages/service-inject/tsconfig.json
new file mode 100644
index 0000000..4007f60
--- /dev/null
+++ b/packages/service-inject/tsconfig.json
@@ -0,0 +1,22 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "declarationDir": "dist-types",
+    "emitDeclarationOnly": true,
+    "rootDir": "src",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ]
+  },
+  "references": [
+    {
+      "path": "../service-shared"
+    }
+  ],
+  "include": [
+    "src/**/*.ts"
+  ]
+}
diff --git a/packages/service-inject/vite.config.js b/packages/service-inject/vite.config.js
new file mode 100644
index 0000000..9c65c15
--- /dev/null
+++ b/packages/service-inject/vite.config.js
@@ -0,0 +1,28 @@
+// @ts-check
+
+import { builtinModules } from 'module';
+
+import { chrome, makeConfig } from '../../config/vite-common';
+
+/** @type {string} */
+const PACKAGE_ROOT = __dirname;
+
+/**
+ * @type {import('vite').UserConfig}
+ * @see https://vitejs.dev/config/
+ */
+const config = makeConfig({
+  root: PACKAGE_ROOT,
+  build: {
+    target: chrome,
+    lib: {
+      entry: 'src/index.ts',
+      formats: ['cjs'],
+    },
+    rollupOptions: {
+      external: builtinModules,
+    },
+  },
+});
+
+export default config;
diff --git a/packages/service-preload/package.json b/packages/service-preload/package.json
index 1296cda..e6358a0 100644
--- a/packages/service-preload/package.json
+++ b/packages/service-preload/package.json
@@ -2,7 +2,6 @@
   "name": "@sophie/service-preload",
   "version": "0.1.0",
   "private": true,
-  "sideEffects": false,
   "main": "dist/index.cjs",
   "types": "dist-types/index.d.ts",
   "scripts": {
diff --git a/packages/service-preload/src/index.ts b/packages/service-preload/src/index.ts
index 4e93a07..3f54c0b 100644
--- a/packages/service-preload/src/index.ts
+++ b/packages/service-preload/src/index.ts
@@ -21,9 +21,4 @@
 import { ipcRenderer } from 'electron';
 import { ServiceToMainIpcMessage } from '@sophie/service-shared';
 
-let i = 1;
-
-setInterval(() => {
-  ipcRenderer.send(ServiceToMainIpcMessage.SetUnreadCount, { direct: i });
-  i += 1;
-}, 1000);
+ipcRenderer.send(ServiceToMainIpcMessage.ApiExposedInMainWorld);
diff --git a/packages/service-shared/src/ipc.ts b/packages/service-shared/src/ipc.ts
index ad2ceca..4f991c5 100644
--- a/packages/service-shared/src/ipc.ts
+++ b/packages/service-shared/src/ipc.ts
@@ -19,5 +19,6 @@
  */
 
 export enum ServiceToMainIpcMessage {
+  ApiExposedInMainWorld = 'sophie-service-to-main:api-exposed-in-main-world',
   SetUnreadCount = 'sophie-service-to-main:set-unread-count',
 }
diff --git a/scripts/watch.js b/scripts/watch.js
index 243710c..82dc01e 100644
--- a/scripts/watch.js
+++ b/scripts/watch.js
@@ -131,12 +131,13 @@ function setupPreloadPackageWatcher(viteDevServer) {
  * Reload services when source files are changed.
  *
  * @param {import('vite').ViteDevServer} viteDevServer
+ * @param {string} packageName The name of the package to watch.
  * @returns {Promise<unknown>}
  */
-function setupServicePreloadPackageWatcher(viteDevServer) {
+function setupServicePreloadPackageWatcher(viteDevServer, packageName) {
   return getWatcher({
-    name: 'reload-services-on-service-preload-package-change',
-    configFile: 'packages/service-preload/vite.config.js',
+    name: `reload-services-on-${packageName}-package-change`,
+    configFile: `packages/${packageName}/vite.config.js`,
     writeBundle() {
       console.log('wrote');
       viteDevServer.ws.send({
@@ -164,6 +165,8 @@ function setupSharedPackageWatcher(packageName) {
  * @returns {Promise<unknown>}
  */
 async function setupDevEnvironment() {
+  const serviceSharedWatcher = setupSharedPackageWatcher('service-shared');
+
   await setupSharedPackageWatcher('shared');
 
   const viteDevServer = await createServer({
@@ -174,8 +177,10 @@ async function setupDevEnvironment() {
 
   await Promise.all([
     setupPreloadPackageWatcher(viteDevServer),
-    setupServicePreloadPackageWatcher(viteDevServer),
-    setupSharedPackageWatcher('shared'),
+    serviceSharedWatcher.then(() => Promise.all([
+      setupServicePreloadPackageWatcher(viteDevServer, 'service-inject'),
+      setupServicePreloadPackageWatcher(viteDevServer, 'service-preload'),
+    ])),
   ]);
 
   return setupMainPackageWatcher(viteDevServer);
diff --git a/yarn.lock b/yarn.lock
index ef16435..4f98c8e 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -878,6 +878,17 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@sophie/service-inject@workspace:packages/service-inject":
+  version: 0.0.0-use.local
+  resolution: "@sophie/service-inject@workspace:packages/service-inject"
+  dependencies:
+    "@sophie/service-shared": "workspace:*"
+    rimraf: ^3.0.2
+    typescript: ^4.5.4
+    vite: ^2.7.6
+  languageName: unknown
+  linkType: soft
+
 "@sophie/service-preload@workspace:packages/service-preload":
   version: 0.0.0-use.local
   resolution: "@sophie/service-preload@workspace:packages/service-preload"