pear-electron 0.2.4 → 0.2.6

package/README.md

@@ -19,12 +19,11 @@ import Runtime from 'pear-electron'
 import Bridge from 'pear-bridge'
 
 const runtime = new Runtime()
-await runtime.ready()
 
 const bridge = new Bridge()
 await bridge.ready()
 
-const pipe = runtime.start(bridge.info())
+const pipe = runtime.start({ bridge })
 Pear.teardown(() => pipe.end())
 ```
 
@@ -40,11 +39,13 @@ Create the runtime instances with `new Runtime()`.
 
 Prepare the runtime, runtime binaries for the runtime version may be bootstrapped peer-to-peer at this point. This only runs once per version and any prior bootstraps can be reused for subsequent versions where state hasn't changed. In a production scenario any bootstrapping would be performed in advance by the application distributable.
 
-### `runtime.start(info <String>)`
+### `runtime.start(opts)`
 
-Opens the UI. The `info` string is passed as a `--runtime-info` flag to the UI executable. The `pear-api/state` integration library then includes this flag value as `state.runtimeInfo` which can then be used by `pear-electron`. The `info` string by convention is a JSON string, with the shape, `{ type, data }`.
+Opens the UI. 
 
-In the usage example, `bridge.info()` is passed to `runtime.start()`, `pear-electron` later uses this to determine the bridge localhost address to load with electron.
+#### Options
+
+* `bridge` - An instance of `pear-bridge`.
 
 ## User-Interface API
 

package/boot.js

@@ -3,14 +3,12 @@
 const { isElectron, isElectronRenderer, isElectronWorker, isWindows } = require('which-runtime')
 const BOOT_ELECTRON_MAIN = 1
 const BOOT_ELECTRON_PRELOAD = 2
-const rtix = process.argv.indexOf('--runtime-info')
-const rti = rtix > -1 && process.argv[rtix + 1]
-const state = rti ? null : JSON.parse(process.argv.slice(isWindows ? -2 : -1)[0])
-const RUNTIME_INFO = rti ? JSON.parse(rti) : state.runtimeInfo
+const rtiFlagIx = process.argv.indexOf('--rti')
+const RTI = rtiFlagIx > -1 && process.argv[rtiFlagIx + 1]
+const state = RTI ? null : JSON.parse(process.argv.slice(isWindows ? -2 : -1)[0])
 
 class API {
-  static CHECKOUT = RUNTIME_INFO.checkout
-  static MOUNT = RUNTIME_INFO.mount
+  static RTI = RTI ? JSON.parse(RTI) : state.rti
   static get CONSTANTS () { return require('pear-api/constants') }
   config = {}
 }

package/electron-main.js

@@ -20,6 +20,7 @@ run.running?.catch(console.error)
 
 async function electronMain (cmd) {
   const state = new State({
+    dir: global.Pear.constructor.RTI.dir,
     link: cmd.args.link.replace('_||', '://'), // for Windows
     flags: cmd.flags,
     args: cmd.rest

package/gui/gui.js

@@ -806,8 +806,8 @@ class GuiCtrl {
     this.parentId = parentId
     this.closed = true
     this.id = null
-    this.runtimeInfo = this.state.runtimeInfo
-    this.bridge = this.runtimeInfo?.bridge ?? null
+    this.rti = this.state.rti
+    this.bridge = this.rti?.bridge ?? null
     this.entry = this.bridge === null ? entry : `${this.bridge}${entry}`
     this.sessname = sessname
     this.appkin = appkin
@@ -1020,7 +1020,7 @@ class Window extends GuiCtrl {
         preload: require.main.filename,
         ...(decal === false ? { session } : {}),
         partition: 'persist:pear',
-        additionalArguments: [JSON.stringify({ ...this.state.config, runtimeInfo: this.runtimeInfo, isDecal: true })],
+        additionalArguments: [JSON.stringify({ ...this.state.config, rti: this.rti, isDecal: true })],
         autoHideMenuBar: true,
         experimentalFeatures: true,
         nodeIntegration: true,
@@ -1119,7 +1119,7 @@ class Window extends GuiCtrl {
       webPreferences: {
         preload: require.main.filename,
         session,
-        additionalArguments: [JSON.stringify({ ...this.state.config, runtimeInfo: this.runtimeInfo, parentWcId: this.win.webContents.id, decalled: true })],
+        additionalArguments: [JSON.stringify({ ...this.state.config, rti: this.rti, parentWcId: this.win.webContents.id, decalled: true })],
         autoHideMenuBar: true,
         experimentalFeatures: true,
         nodeIntegration: true,
@@ -1134,6 +1134,7 @@ class Window extends GuiCtrl {
 
     if (options.afterNativeViewCreated) options.afterNativeViewCreated(this)
     this.view.setBounds({ x: 0, y: 0, width, height })
+
     const viewLoading = this.view.webContents.loadURL(this.entry)
     viewInitialized()
     this.view.webContents.once('did-finish-load', () => { viewLoaded() })
@@ -1322,7 +1323,7 @@ class View extends GuiCtrl {
       webPreferences: {
         preload: require.main.filename,
         session,
-        additionalArguments: [JSON.stringify({ ...this.state.config, ...(options?.view?.config || options.config || {}), runtimeInfo: this.runtimeInfo, parentWcId: this.win.webContents.id })],
+        additionalArguments: [JSON.stringify({ ...this.state.config, ...(options?.view?.config || options.config || {}), rti: this.rti, parentWcId: this.win.webContents.id })],
         autoHideMenuBar: true,
         experimentalFeatures: true,
         nodeIntegration: true,
@@ -1574,6 +1575,7 @@ class PearGUI extends ReadyResource {
   }
 
   static async ctrl (type, entry, { state, parentId = 0, ua, sessname = null, appkin }, options = {}, openOptions = {}) {
+    entry = entry || '/'
     ;[entry] = entry.split('+')
     if (entry.slice(0, 2) === './') entry = entry.slice(1)
     if (entry[0] !== '/') entry = `/~${entry}`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pear-electron",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "Pear User-Interface Library for Electron",
   "main": "index.js",
   "bin": "bin.js",

package/preload.js

@@ -9,7 +9,7 @@ module.exports = (state) => {
   const { isMac, isWindows, platform } = require('which-runtime')
   const API = require('pear-api')
   const GUI = require('./gui')
-  const { parentWcId, env, id, runtimeInfo, ...config } = state
+  const { parentWcId, env, id, rti, ...config } = state
   const isDecal = state.isDecal || false
   if (config.key?.type === 'Buffer') config.key = Buffer.from(config.key.data)
   const dir = config.dir
@@ -43,6 +43,76 @@ module.exports = (state) => {
     })
   }
 
+  const { warn } = console
+  console.warn = (msg, ...args) => {
+    // if (/Insecure Content-Security-Policy/.test(msg)) return.
+    warn.call(console, msg, ...args)
+  }
+
+  if (location.hostname === 'localhost' && location.port) {
+    const gunk = require('pear-api/gunk')
+    const runtime = require('script-linker/runtime')
+
+    // platform runtime:
+    const pltsl = runtime({
+      builtins: gunk.builtins,
+      map: gunk.platform.map,
+      mapImport: gunk.platform.mapImport,
+      symbol: gunk.platform.symbol,
+      protocol: gunk.platform.protocol,
+      getSync (url) {
+        const xhr = new XMLHttpRequest()
+        xhr.open('GET', url, false)
+        xhr.send(null)
+        return xhr.responseText
+      },
+      resolveSync (req, dirname, { isImport }) {
+        const xhr = new XMLHttpRequest()
+        const type = isImport ? 'esm' : 'cjs'
+        const url = `${dirname}/~${req}+platform-resolve+${type}`
+        xhr.open('GET', url, false)
+        xhr.send(null)
+        return xhr.responseText
+      }
+    })
+
+    // app runtime:
+    const appsl = runtime({
+      builtins: gunk.builtins,
+      map: gunk.app.map,
+      mapImport: gunk.app.mapImport,
+      symbol: gunk.app.symbol,
+      protocol: gunk.app.protocol,
+      getSync (url) {
+        const xhr = new XMLHttpRequest()
+        xhr.open('GET', url, false)
+        xhr.send(null)
+        return xhr.responseText
+      },
+      resolveSync (req, dirname, { isImport }) {
+        const xhr = new XMLHttpRequest()
+        const type = isImport ? 'esm' : 'cjs'
+        const url = `${dirname}/~${req}+resolve+${type}`
+        xhr.open('GET', url, false)
+        xhr.send(null)
+        if (xhr.status !== 200) throw new Error(`${xhr.status} ${xhr.responseText}`)
+        return xhr.responseText
+      }
+    })
+
+    async function warm () {
+      for await (const { batch, protocol } of Pear[Pear.constructor.UI].warming()) {
+        let sl = null
+        if (protocol === 'pear' || protocol === 'holepunch') sl = pltsl
+        if (protocol === 'app') sl = appsl
+        if (sl === null) continue
+        for (const { filename, source } of batch) sl.sources.set(filename, source)
+      }
+    }
+
+    if (Pear.config.isDecal === false) warm().catch(console.error)
+  }
+
   function descopeGlobals () {
     delete global.require
     delete global.module
@@ -50,21 +120,7 @@ module.exports = (state) => {
     delete global.__filename
   }
 
-  const { warn } = console
-  console.warn = (msg, ...args) => {
-    if (/Insecure Content-Security-Policy/.test(msg)) return
-    warn.call(console, msg, ...args)
-  }
-
-  if (Pear.config.options.gui?.preload) {
-    const run = require('node-bare-bundle')
-    const key = Pear.config.options.gui.preload
-    Pear.get(key, { bundle: true }).then((preload) => {
-      run(preload, { mount: '/', entrypoint: key })
-    }, console.error).finally(descopeGlobals)
-  } else {
-    descopeGlobals()
-  }
+  descopeGlobals()
 
   customElements.define('pear-ctrl', class extends HTMLElement {
     #onfocus = null

package/runtime.js

@@ -8,11 +8,11 @@ const Pipe = require('bare-pipe')
 const { spawn } = require('bare-subprocess')
 const env = require('bare-env')
 const { command } = require('paparam')
-const { isLinux, isWindows } = require('which-runtime')
+const { isLinux, isWindows, isMac } = require('which-runtime')
 const { pathToFileURL, fileURLToPath } = require('url-file-url')
 const constants = require('pear-api/constants')
 const parseLink = require('pear-api/parse-link')
-const { ERR_INVALID_INPUT } = require('pear-api/errors')
+const { ERR_INVALID_INPUT, ERR_INVALID_APPLING } = require('pear-api/errors')
 const run = require('pear-api/cmd/run')
 const pear = require('pear-api/cmd')
 const EXEC = isWindows
@@ -43,8 +43,7 @@ class PearElectron {
     const isFile = link.startsWith('file://')
     const isPath = isPear === false && isFile === false
 
-    let cwd = os.cwd()
-    const originalCwd = cwd
+    const cwd = os.cwd()
     let dir = cwd
     let base = null
     if (key === null) {
@@ -53,12 +52,7 @@ class PearElectron {
       } catch { /* ignore */ }
       base = project(dir, pathname, cwd)
       dir = base.dir
-      if (dir !== cwd) {
-        global.Bare.on('exit', () => os.chdir(originalCwd)) // TODO: remove this once Pear.shutdown is used to close
-        Pear.teardown(() => os.chdir(originalCwd))
-        os.chdir(dir)
-        cwd = dir
-      }
+      if (dir.length > 1 && dir.endsWith('/')) dir = dir.slice(0, -1)
       if (isPath) {
         link = pathToFileURL(path.join(dir, base.entrypoint || '/')).pathname
       }
@@ -66,20 +60,35 @@ class PearElectron {
 
     if (isPath) argv[indices.args.link] = 'file://' + (base.entrypoint || '/')
     argv[indices.args.link] = argv[indices.args.link].replace('://', '_||') // for Windows
+
     if ((isLinux || isWindows) && !flags.sandbox) argv.splice(indices.args.link, 0, '--no-sandbox')
     const info = JSON.stringify({
       checkout: constants.CHECKOUT,
       mount: constants.MOUNT,
-      bridge: opts.bridge?.addr ?? undefined
+      bridge: opts.bridge?.addr ?? undefined,
+      dir
     })
-    argv = [BOOT, '--runtime-info', info, ...argv]
+    argv = [BOOT, '--rti', info, ...argv]
     const stdio = args.detach ? 'ignore' : ['ignore', 'inherit', 'pipe', 'pipe']
-    const sp = spawn(this.bin, argv, {
+    const options = {
       stdio,
       cwd,
       windowsHide: true,
       ...{ env: { ...env, NODE_PRESERVE_SYMLINKS: 1 } }
-    })
+    }
+
+    const sp = spawn(this.bin, argv, options)
+    if (args.appling) {
+      const { appling } = args
+      const applingApp = isMac ? appling.split('.app')[0] + '.app' : appling
+      try {
+        fs.statSync(applingApp)
+      } catch {
+        throw ERR_INVALID_APPLING('Appling does not exist')
+      }
+      if (isMac) spawn('open', [applingApp, '--args', ...argv], options).unref()
+      else spawn(applingApp, argv, options).unref()
+    }
     if (args.detach) return null
     const pipe = sp.stdio[3]
     sp.on('exit', (code) => { Pear.exit(code) })