escape the browser wip

* converting from Svelte to Mithril
* convertnig from WebExtension to Electron

Author: soapdog

app.js

@@ -0,0 +1,56 @@
+const { app, BrowserWindow } = require("electron")
+const path = require("path")
+
+// Live Reload
+require("electron-reload")(__dirname, {
+  electron: path.join(__dirname, "node_modules", ".bin", "electron"),
+  awaitWriteFinish: true
+})
+
+const createWindow = () => {
+  // Create the browser window.
+  const mainWindow = new BrowserWindow({
+    width: 800,
+    height: 600,
+    webPreferences: {
+      nodeIntegration: true,
+      contextIsolation: false
+    }
+  })
+
+  // and load the index.html of the app.
+  mainWindow.loadFile(path.join(__dirname, "ui/index.html"))
+
+  // Open the DevTools.
+  mainWindow.webContents.openDevTools()
+
+  mainWindow.webContents.setWindowOpenHandler(details => {
+    console.log("cd", details)
+    return { action: "allow" }
+  })
+}
+
+// This method will be called when Electron has finished
+// initialization and is ready to create browser windows.
+// Some APIs can only be used after this event occurs.
+app.on("ready", createWindow)
+
+// Quit when all windows are closed.
+app.on("window-all-closed", () => {
+  // On OS X it is common for applications and their menu bar
+  // to stay active until the user quits explicitly with Cmd + Q
+  if (process.platform !== "darwin") {
+    app.quit()
+  }
+})
+
+app.on("activate", () => {
+  // On OS X it"s common to re-create a window in the app when the
+  // dock icon is clicked and there are no other windows open.
+  if (BrowserWindow.getAllWindows().length === 0) {
+    createWindow()
+  }
+})
+
+// In this file you can include the rest of your app"s specific main process
+// code. You can also put them in separate files and import them here.

desktop/.gitignore

@@ -0,0 +1,8 @@
+main.bundle.js
+package-lock.json
+electron-builder.env
+
+builder/node_modules
+builder/package-lock.json
+installers
+node_modules

desktop/.noderifyrc

@@ -0,0 +1,8 @@
+{
+  "filter": [
+    "electron",
+    "fs/promises"
+  ],
+  "ignoreMissing": true,
+  "verbose": true
+}

desktop/builder/build-icons.js

@@ -0,0 +1,55 @@
+const fs = require('fs')
+const path = require('path')
+const sharp = require('sharp')
+const toIco = require('to-ico')
+const { convert: icnsConvert } = require('@fiahfy/icns-convert')
+
+// TODO: replace with svg, using this for now as the icon
+// on mac comes out pixelated with the .svg
+const image = sharp(path.resolve(__dirname, 'icon.png'))
+const setupImage = sharp(path.resolve(__dirname, 'setup-icon.svg'))
+
+const sizes = [16, 24, 32, 48, 64, 96, 128, 256]
+
+console.log('Building Desktop Icons:')
+
+// windows icons
+buildIcons(image, sizes, createIco, 'icon')
+buildIcons(setupImage, sizes, createIco, 'setup-icon')
+
+// mac icons
+buildIcons(image, [...sizes, 512, 1024], createIcns, 'icon')
+buildIcons(setupImage, [...sizes, 512, 1024], createIcns, 'dmg-icon')
+
+function makeIcon (size, image) {
+  return image
+    .resize(size, size)
+    .png()
+    .toBuffer()
+}
+
+async function buildIcons (image, sizes, createIcon, fileName) {
+  await Promise
+    .all(sizes.map(size => makeIcon(size, image)))
+    .then(bufs => {
+      createIcon(bufs, fileName)
+      console.log(`- ${fileName}`)
+    })
+    .catch(err => console.error('Error building icons', err))
+}
+
+function createIco (bufs, fileName) {
+  toIco(bufs)
+    .then(buf => {
+      fs.writeFileSync(path.join(__dirname, `win/${fileName}.ico`), buf)
+    })
+    .catch(err => console.error('createIco error:', err))
+}
+
+function createIcns (bufs, fileName) {
+  icnsConvert(bufs)
+    .then(data => {
+      fs.writeFileSync(path.join(__dirname, `mac/${fileName}.icns`), data)
+    })
+    .catch(err => console.error('createIcns error: ', err))
+}

desktop/builder/config.js

@@ -0,0 +1,129 @@
+// see https://www.electron.build/configuration/configuration
+
+// NOTE
+// - this is a more optimized config which prunes un-needed files
+// - see config.simple.js for something easier, but makes things a few MB bigger
+
+const fs = require("fs")
+const path = require("path")
+
+module.exports = {
+  appId: "org.patchfox.desktop",
+  directories: {
+    output: "installers"
+  },
+
+  /* ADVANDCED SECTION: */
+
+  /* Only include needed files */
+  // this is enabled by our noderify bundling
+  files: [
+    "!builder",
+    "!installers",
+    "!node_modules",
+
+    /* electron main process */
+    "main.bundle.js",
+
+    /* UI files (referenced by main.bundle.js) */
+    "../dist",
+
+    /* native bindings  (dependencies of main.bundle.js) */
+    "node_modules/node-gyp-build/index.js",
+
+    "node_modules/sodium-chloride/index.js",
+    "node_modules/sodium-native/index.js",
+    "node_modules/sodium-native/prebuilds/${platform}-${arch}/*", // eslint-disable-line
+
+    "node_modules/leveldown/index.js",
+    "node_modules/leveldown/prebuilds/${platform}-${arch}/*", // eslint-disable-line
+
+    /* ssb-ahoy ui-window dependency */
+    "node_modules/ssb-ahoy/electron/preload.js"
+  ],
+
+  // NOTE how to figure out what"s needed:
+  //   1. run `npm run dist`
+  //   2. try to launch the output (see dist/installers/*.AppImage etc)
+  //   3. read the errors about what"s missing and add it above
+  //
+  // NOTE that we have to include ! (not) rules in files, otherwise
+  // electron-builder auto-adds **/*  (add everything!)
+
+  /* delete files from the pack! */
+  afterPack (context) {
+    fs.rmSync(path.join(context.appOutDir, "LICENSE.electron.txt"))
+    fs.rmSync(path.join(context.appOutDir, "LICENSES.chromium.html"))
+    // const ls = fs.readdirSync(context.appOutDir)
+    // console.log(ls)
+  },
+
+  publish: [{
+    provider: "github",
+    owner: "soapdog",
+    repo: "patchfox",
+    releaseType: "release"
+  }],
+
+  ...windows(),
+  ...linux(),
+  ...mac()
+}
+
+function windows () {
+  return {
+    win: {
+      icon: "builder/win/icon.ico"
+
+      /* Code Signing */
+      // publisherName: ["Āhau NZ Limited"],
+      // WARNING - this name must *exactly* match the subject/ "issued to" field on the Signing Certificate
+      // otherwise in future if this name changes, auto-updating will fail D:
+
+      // certificateSubjectName: "Āhau NZ Limited", // The name of the subject of the signing certificate
+      // NOTE - this field worked for code signing certificate, but not the EV signing
+      // certificateSha1: "A5F49ED3D5EBBCA6EE093BF2A8AA93DA36BDBF56"
+      // This is a way to be VERY specific about the exact certificate used. This worked well with EV signing cert.
+    },
+    nsis: {
+      artifactName: "${name}-Windows-${version}.${ext}", // eslint-disable-line
+      installerIcon: "builder/win/setup-icon.ico",
+      include: "builder/win/add-missing-dll.nsh" // fixes missing VCRUNTIME140.dll
+      // source: https://github.com/sodium-friends/sodium-native/issues/100
+    }
+  }
+}
+
+function mac () {
+  // N = this settings requires for Apple notarization
+  // https://kilianvalkhof.com/2019/electron/notarizing-your-electron-application/
+
+  return {
+    mac: {
+      category: "public.app-category.social-networking",
+      icon: "builder/mac/icon.icns",
+      hardenedRuntime: true, // N
+      gatekeeperAssess: false // N
+    },
+    dmg: {
+      artifactName: "${name}-Mac-${version}.${ext}", // eslint-disable-line
+      background: "builder/mac/background.png",
+      icon: "builder/mac/dmg-icon.icns",
+      sign: false // N
+    },
+    /* Code Signing */
+    afterSign: "builder/mac/notarize.js" // N
+  }
+}
+
+function linux () {
+  return {
+    linux: {
+      category: "Network",
+      target: "AppImage"
+    },
+    appImage: {
+      artifactName: "${name}-Linux-${version}-${arch}.${ext}" // eslint-disable-line
+    }
+  }
+}

desktop/builder/icon.png

@@ -0,0 +1,23 @@
+const { notarize } = require('electron-notarize')
+const { appId } = require('../config.js')
+
+const appleId = process.env.APPLE_ID
+
+exports.default = async function notarizing (context) {
+  const { electronPlatformName, appOutDir } = context
+  if (electronPlatformName !== 'darwin') return
+
+  if (!appleId) throw new Error('electron builder require env APPLE_ID')
+
+  const appName = context.packager.appInfo.productFilename
+
+  console.log('Starting notarization...')
+
+  return await notarize({ // eslint-disable-line
+    appBundleId: appId,
+    appPath: `${appOutDir}/${appName}.app`,
+    appleId,
+    // appleIdPassword: `@keychain:"Application Loader: ${appleId}"`
+    appleIdPassword: process.env.APPLE_ID_PASS
+  })
+}

desktop/builder/icon.svg

@@ -0,0 +1,13 @@
+{
+  "name": "builder-tools",
+  "version": "1.0.0",
+  "description": "this is just here for building icons",
+  "scripts": {
+    "build:icons": "node build-icons.js"
+  },
+  "devDependencies": {
+    "@fiahfy/icns-convert": "0.0.8",
+    "sharp": "^0.23.4",
+    "to-ico": "^1.1.5"
+  }
+}

desktop/builder/mac/background.png

@@ -0,0 +1,35 @@
+!macro customInstall
+
+!define REDIST_NAME "$\"Microsoft Visual C++ 2015-2019 Redistributable (x64) 14.26.28720.03$\""
+!define REDIST_SETUP_URL "https://download.visualstudio.microsoft.com/download/pr/d60aa805-26e9-47df-b4e3-cd6fcc392333/7D7105C52FCD6766BEEE1AE162AA81E278686122C1E44890712326634D0B055E/VC_redist.x64.exe"
+!define REDIST_SETUP_FILE "$TEMP\vcredist140-x64-installer.exe"
+
+ClearErrors
+
+ReadRegDword $R0 HKLM "SOFTWARE\Wow6432Node\Microsoft\VisualStudio\14.0\VC\Runtimes\X64" "Installed"
+IfErrors 0 +2
+DetailPrint "Installing ${REDIST_NAME}..."
+StrCmp $R0 "1" 0 +3
+  DetailPrint "${REDIST_NAME} is already installed. Skipping."
+  Goto End
+
+DetailPrint "Downloading ${REDIST_NAME} Setup (from ${REDIST_SETUP_URL} to ${REDIST_SETUP_FILE}) ..."
+NSISdl::download /TIMEOUT=30000 "${REDIST_SETUP_URL}" "${REDIST_SETUP_FILE}"
+
+Pop $R0 ; get the return value
+StrCmp $R0 "success" OnSuccessDownload
+
+Pop $R0 ; get the return value
+StrCmp $R0 "success" +2
+  MessageBox MB_OK "Could not download ${REDIST_NAME} (from ${REDIST_SETUP_URL} to ${REDIST_SETUP_FILE}). Please install it manually."
+  Goto End
+
+OnSuccessDownload:
+  DetailPrint "Running ${REDIST_NAME} Setup (${REDIST_SETUP_FILE} executable)..."
+  ExecWait '"${REDIST_SETUP_FILE}" /norestart'
+  DetailPrint "Finished ${REDIST_NAME} Setup"
+  Delete "${REDIST_SETUP_FILE}"
+
+End:
+
+!macroend

desktop/builder/mac/[email protected]

@@ -0,0 +1,7 @@
+[email protected]
+APPLE_ID_PASS=asdl-tyan-osla-ttyb
+
+CSC_LINK=build/win/csc.pfx
+CSC_KEY_PASSWORD=anliushfdxbaejhbrsajxhelaser
+
+GH_TOKEN=sadsdfsadfsdfsdfsdfsdfsdfsdf