tauri-plugin-cef-webview 0.3.1

Embed CEF child webviews in a Tauri frontend with a <webview> element
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
// Injected into the pages of the Tauri application by the cef-webview plugin.
//
// It installs the Electron-compatible `<webview>` element API. Page scripts do
// not import anything: the element gains the methods and properties as soon as
// this script runs.
(() => {
  'use strict'

  if (window.__cefWebviewInstalled)
    return
  if (!window.__TAURI_INTERNALS__)
    return

  window.__cefWebviewInstalled = true

  // `createElement` runs synchronously while the observer runs on a microtask,
  // so programmatic elements must be enhanced here to be usable right away.
  const createElement = document.createElement.bind(document)
  document.createElement = function (name, options) {
    const element = createElement(name, options)
    if (typeof name === 'string' && name.toLowerCase() === 'webview')
      enhance(element)
    return element
  }

  const PLUGIN = 'cef-webview'
  const EVENT = 'cef-webview://event'
  const BOOLEAN_ATTRIBUTES = [
    'nodeintegration',
    'nodeintegrationinsubframes',
    'plugins',
    'disablewebsecurity',
    'allowpopups',
  ]
  const STRING_ATTRIBUTES = [
    'preload',
    'httpreferrer',
    'useragent',
    'partition',
    'webpreferences',
    'enableblinkfeatures',
    'disableblinkfeatures',
  ]
  const UNSUPPORTED_ATTRIBUTES = [
    'nodeintegration',
    'nodeintegrationinsubframes',
    'plugins',
    'httpreferrer',
    'disablewebsecurity',
    'partition',
    'webpreferences',
    'enableblinkfeatures',
    'disableblinkfeatures',
  ]
  const IMMUTABLE_ATTRIBUTES = new Set(['partition', 'disablewebsecurity'])

  const internals = window.__TAURI_INTERNALS__
  const controllers = new Set()
  const mounted = new WeakMap()
  const byLabel = new Map()
  let sequence = 0
  let frame = 0

  function command(name) {
    return `plugin:${PLUGIN}|${name}`
  }

  function invoke(name, args) {
    return internals.invoke(command(name), args)
  }

  function noop() {}

  function isTauri() {
    return typeof window !== 'undefined' && '__TAURI_INTERNALS__' in window
  }

  function nearlyEqual(a, b) {
    return (
      Math.abs(a.x - b.x) < 0.5
      && Math.abs(a.y - b.y) < 0.5
      && Math.abs(a.width - b.width) < 0.5
      && Math.abs(a.height - b.height) < 0.5
    )
  }

  function defaultState() {
    return {
      url: '',
      title: '',
      loading: false,
      waitingForResponse: false,
      canGoBack: false,
      canGoForward: false,
      historyIndex: 0,
      crashed: false,
      audioMuted: false,
      audible: false,
      userAgent: '',
      zoomFactor: 1,
      zoomLevel: 0,
      webContentsId: 0,
    }
  }

  function schedule() {
    if (frame || controllers.size === 0)
      return
    frame = requestAnimationFrame(() => {
      frame = 0
      for (const controller of controllers)
        controller.sync()
    })
  }

  function subscribe() {
    const id = internals.transformCallback((event) => {
      const payload = event && event.payload
      if (!payload)
        return
      const controller = byLabel.get(payload.label)
      if (controller)
        controller.receive(payload.event, payload.args || {})
    })

    internals.invoke('plugin:event|listen', {
      event: EVENT,
      target: { kind: 'Any' },
      handler: id,
    }).catch((error) => {
      console.error('[cef-webview] failed to listen for webview events', error)
    })
  }

  function createEvent(type, args) {
    const event = new Event(type)
    for (const key of Object.keys(args)) {
      Object.defineProperty(event, key, {
        value: args[key],
        enumerable: true,
        configurable: true,
      })
    }
    return event
  }

  function parseJson(value) {
    if (typeof value !== 'string')
      return value
    try {
      return JSON.parse(value)
    }
    catch {
      return value
    }
  }

  class Controller {
    constructor(element, label) {
      this.element = element
      this.label = label
      this.state = defaultState()
      this.queue = Promise.resolve()
      this.rect = null
      this.visible = true
      this.intersecting = true
      this.destroyed = false
      this.devToolsOpen = false
      this.executeSequence = 0
      this.findSequence = 0
      this.pending = new Map()

      const src = element.getAttribute('src')
      if (!src)
        throw new Error('<webview> requires a `src` attribute')

      this.warnUnsupported()
      const js = element.getAttribute('js')
      const css = element.getAttribute('css')
      const rect = this.measure()

      this.queue = invoke('create', {
        label,
        url: new URL(src, document.baseURI).href,
        x: rect.x,
        y: rect.y,
        width: Math.max(rect.width, 1),
        height: Math.max(rect.height, 1),
        js: js ? [js] : [],
        css: css ? [css] : [],
        options: this.createOptions(),
      }).then((state) => {
        this.applyState(state)
      })
      this.queue.catch((error) => {
        console.error(`[cef-webview] failed to create webview "${label}"`, error)
      })

      this.ready = this.queue.then(() => element)

      this.resizeObserver = new ResizeObserver(() => schedule())
      this.resizeObserver.observe(element)

      this.intersectionObserver = new IntersectionObserver(([entry]) => {
        this.intersecting = entry.isIntersecting
        schedule()
      })
      this.intersectionObserver.observe(element)

      schedule()
    }

    receive(event, args) {
      if (event === 'state') {
        this.applyState(args)
        return
      }

      if (event === 'execute-javascript') {
        const id = Number(args.id)
        const pending = this.pending.get(id)
        if (!pending)
          return
        this.pending.delete(id)
        if (typeof args.error === 'string')
          pending.reject(new Error(args.error))
        else
          pending.resolve(parseJson(args.value))
        return
      }

      this.element.dispatchEvent(createEvent(event, args))
    }

    sync() {
      if (this.destroyed || !this.element.isConnected)
        return

      const next = this.measure()
      const empty = next.width <= 0 || next.height <= 0

      this.applyVisible(!empty && this.intersecting)
      if (empty)
        return

      const previous = this.rect
      this.rect = next
      if (previous && nearlyEqual(previous, next))
        return

      this.run(() => invoke('set_rect', { label: this.label, ...next })).catch(noop)
    }

    call(method, args) {
      return invoke('call', {
        label: this.label,
        method,
        args: { label: this.label, ...(args || {}) },
      })
    }

    fire(method, args) {
      this.call(method, args).catch(noop)
    }

    loadURL(url, options) {
      return this.call('loadURL', { url, options: options || null })
    }

    navigate(url) {
      return this.loadURL(url)
    }

    setUserAgent(userAgent) {
      this.call('setUserAgent', { userAgent }).catch((error) => {
        console.warn(`[cef-webview] ${error}`)
      })
    }

    executeJavaScript(code, userGesture) {
      const id = ++this.executeSequence
      return new Promise((resolve, reject) => {
        this.pending.set(id, { resolve, reject })
        this.call('executeJavaScript', { id, code, userGesture: !!userGesture }).catch((error) => {
          this.pending.delete(id)
          reject(error)
        })
      })
    }

    openDevTools() {
      this.devToolsOpen = true
      this.fire('openDevTools')
    }

    closeDevTools() {
      this.devToolsOpen = false
      this.fire('closeDevTools')
    }

    setAudioMuted(muted) {
      this.state.audioMuted = muted
      this.fire('setAudioMuted', { muted })
    }

    edit(command, value) {
      this.fire('edit', { command, value: value === undefined ? null : value })
    }

    findInPage(text, options) {
      const requestId = ++this.findSequence
      this.fire('findInPage', { requestId, text, options: options || {} })
      return requestId
    }

    setZoomFactor(factor) {
      this.state.zoomFactor = factor
      this.state.zoomLevel = Math.log(factor) / Math.log(1.2)
      this.fire('setZoomFactor', { factor })
    }

    setZoomLevel(level, scale) {
      const factor = (scale || 1.2) ** level
      this.state.zoomFactor = factor
      this.state.zoomLevel = level
      this.fire('setZoomLevel', { level, scale: scale || 1.2 })
    }

    getWebContentsId() {
      return this.state.webContentsId
    }

    getState() {
      return this.state
    }

    destroy() {
      if (this.destroyed)
        return
      this.destroyed = true
      controllers.delete(this)
      mounted.delete(this.element)
      byLabel.delete(this.label)
      this.resizeObserver.disconnect()
      this.intersectionObserver.disconnect()
      this.element.dispatchEvent(createEvent('destroyed', {}))
      for (const pending of this.pending.values())
        pending.reject(new Error('webview was destroyed'))
      this.pending.clear()
      this.run(() => invoke('destroy', { label: this.label })).catch(noop)
    }

    createOptions() {
      const options = {}
      const userAgent = this.element.getAttribute('useragent')
      if (userAgent)
        options.userAgent = userAgent
      const preload = this.element.getAttribute('preload')
      if (preload)
        options.preload = preload
      if (this.element.hasAttribute('allowpopups'))
        options.allowPopups = true
      return options
    }

    warnUnsupported() {
      for (const name of UNSUPPORTED_ATTRIBUTES) {
        if (this.element.getAttribute(name) === null)
          continue
        console.warn(
          `[cef-webview] the \`${name}\` attribute is not supported by the CEF runtime and is ignored`,
        )
      }
    }

    applyState(state) {
      this.state = { ...this.state, ...state }
    }

    measure() {
      const box = this.element.getBoundingClientRect()
      return {
        x: box.left,
        y: box.top,
        width: box.width,
        height: box.height,
      }
    }

    applyVisible(visible) {
      if (visible === this.visible)
        return
      this.visible = visible
      this.run(() => invoke('set_visible', { label: this.label, visible })).catch(noop)
    }

    run(task) {
      const result = this.queue.then(task)
      this.queue = result.catch(noop)
      return result
    }
  }

  function defineAttribute(element, controller, name, boolean) {
    Object.defineProperty(element, name, {
      configurable: true,
      enumerable: true,
      get: () => {
        if (!boolean)
          return element.getAttribute(name) || ''
        return element.hasAttribute(name)
      },
      set: (value) => {
        if (IMMUTABLE_ATTRIBUTES.has(name) && controller.getState().webContentsId !== 0) {
          throw new DOMException(
            `<webview> \`${name}\` cannot be changed after the webview is attached`,
            'InvalidStateError',
          )
        }
        if (boolean) {
          if (value)
            element.setAttribute(name, '')
          else
            element.removeAttribute(name)
        }
        else {
          element.setAttribute(name, String(value))
        }
      },
    })
  }

  function enhance(element) {
    if (mounted.has(element))
      return element

    const label = element.id || `cef-webview-${++sequence}`
    const controller = new Controller(element, label)
    mounted.set(element, controller)
    controllers.add(controller)
    byLabel.set(label, controller)

    const state = () => controller.getState()

    Object.defineProperties(element, {
      label: { get: () => label, configurable: true },
      ready: { get: () => controller.ready, configurable: true },
      src: {
        configurable: true,
        enumerable: true,
        get: () => element.getAttribute('src') || '',
        set: (value) => {
          const previous = element.getAttribute('src')
          element.setAttribute('src', value)
          if (controller.getState().webContentsId === 0)
            return
          if (previous === value)
            controller.fire('reload')
          else
            controller.navigate(value).catch(noop)
        },
      },
    })

    for (const name of BOOLEAN_ATTRIBUTES)
      defineAttribute(element, controller, name, true)
    for (const name of STRING_ATTRIBUTES)
      defineAttribute(element, controller, name, false)

    element.loadURL = (url, options) => controller.loadURL(url, options)
    element.downloadURL = (url, options) => controller.fire('downloadURL', { url, options: options || null })
    element.getURL = () => state().url
    element.getTitle = () => state().title
    element.isLoading = () => state().loading
    element.isLoadingMainFrame = () => state().loading
    element.isWaitingForResponse = () => state().waitingForResponse
    element.stop = () => controller.fire('stop')
    element.reload = () => controller.fire('reload')
    element.reloadIgnoringCache = () => controller.fire('reloadIgnoringCache')
    element.canGoBack = () => state().canGoBack
    element.canGoForward = () => state().canGoForward
    element.canGoToOffset = offset => offset < 0
      ? state().canGoBack
      : offset > 0
        ? state().canGoForward
        : true
    element.clearHistory = () => controller.fire('clearHistory')
    element.goBack = () => controller.fire('goBack')
    element.goForward = () => controller.fire('goForward')
    element.goToIndex = index => controller.fire('goToIndex', { index })
    element.goToOffset = offset => controller.fire('goToOffset', { offset })
    element.isCrashed = () => state().crashed
    element.setUserAgent = userAgent => controller.setUserAgent(userAgent)
    element.getUserAgent = () => state().userAgent
    element.insertCSS = css => controller.call('insertCSS', { css })
    element.removeInsertedCSS = key => controller.call('removeInsertedCSS', { key })
    element.executeJavaScript = (code, userGesture) => controller.executeJavaScript(code, userGesture)
    element.openDevTools = () => controller.openDevTools()
    element.closeDevTools = () => controller.closeDevTools()
    element.isDevToolsOpened = () => controller.devToolsOpen
    element.isDevToolsFocused = () => false
    element.inspectElement = (x, y) => {
      controller.devToolsOpen = true
      controller.fire('inspectElement', { x, y })
    }
    element.inspectSharedWorker = () => controller.fire('inspectSharedWorker')
    element.inspectServiceWorker = () => controller.fire('inspectServiceWorker')
    element.setAudioMuted = muted => controller.setAudioMuted(muted)
    element.isAudioMuted = () => state().audioMuted
    element.isCurrentlyAudible = () => state().audible

    element.undo = () => controller.edit('undo')
    element.redo = () => controller.edit('redo')
    element.cut = () => controller.edit('cut')
    element.copy = () => controller.edit('copy')
    element.centerSelection = () => controller.edit('centerSelection')
    element.paste = () => controller.edit('paste')
    element.pasteAndMatchStyle = () => controller.edit('pasteAndMatchStyle')
    element.delete = () => controller.edit('delete')
    element.selectAll = () => controller.edit('selectAll')
    element.unselect = () => controller.edit('unselect')
    element.scrollToTop = () => controller.edit('scrollToTop')
    element.scrollToBottom = () => controller.edit('scrollToBottom')
    element.adjustSelection = options => controller.edit('adjustSelection', options)
    element.replace = text => controller.edit('replace', text)
    element.replaceMisspelling = text => controller.edit('replaceMisspelling', text)
    element.insertText = text => controller.edit('insertText', text)

    element.findInPage = (text, options) => controller.findInPage(text, options)
    element.stopFindInPage = action => controller.fire('stopFindInPage', { action })
    element.print = options => controller.call('print', { options: options || null })
    element.printToPDF = options => controller.call('printToPDF', { options: options || null })
    element.capturePage = rect => controller.call('capturePage', { rect: rect || null })
    element.send = (channel, ...args) => controller.call('send', { channel, args })
    element.sendToFrame = (frameId, channel, ...args) => controller.call('sendToFrame', { frameId, channel, args })
    element.sendInputEvent = event => controller.call('sendInputEvent', { event })
    element.setZoomFactor = factor => controller.setZoomFactor(factor)
    element.setZoomLevel = (level, scale) => controller.setZoomLevel(level, scale)
    element.getZoomFactor = () => state().zoomFactor
    element.getZoomLevel = () => state().zoomLevel
    element.setVisualZoomLevelLimits = (min, max) => controller.call('setVisualZoomLevelLimits', { min, max })
    element.showDefinitionForSelection = () => controller.fire('showDefinitionForSelection')
    element.getWebContentsId = () => controller.getWebContentsId()

    element.navigate = url => controller.navigate(url)
    element.eval = js => controller.executeJavaScript(js).then(noop)
    element.openDevtools = () => controller.openDevTools()

    return element
  }

  function scan(root) {
    if (root instanceof HTMLElement && root.localName === 'webview') {
      try {
        enhance(root)
      }
      catch (error) {
        console.error('[cef-webview] failed to enhance <webview>', error)
      }
    }

    if (!(root instanceof Document) && !(root instanceof Element))
      return

    for (const element of root.querySelectorAll('webview')) {
      if (element instanceof HTMLElement) {
        try {
          enhance(element)
        }
        catch (error) {
          console.error('[cef-webview] failed to enhance <webview>', error)
        }
      }
    }
  }

  function scanRemoved(root) {
    if (!(root instanceof Element))
      return

    const destroy = (element) => {
      if (!(element instanceof HTMLElement))
        return
      const controller = mounted.get(element)
      if (!controller)
        return
      queueMicrotask(() => {
        if (!element.isConnected)
          controller.destroy()
      })
    }

    destroy(root)
    for (const element of root.querySelectorAll('webview'))
      destroy(element)
  }

  function start() {
    subscribe()
    scan(document)

    const observer = new MutationObserver((records) => {
      for (const record of records) {
        for (const node of record.addedNodes)
          scan(node)
        for (const node of record.removedNodes)
          scanRemoved(node)
      }
    })
    observer.observe(document.documentElement, { childList: true, subtree: true })

    window.addEventListener('scroll', schedule, { capture: true, passive: true })
    window.addEventListener('resize', schedule, { passive: true })
  }

  if (!isTauri())
    return

  if (document.readyState === 'loading')
    document.addEventListener('DOMContentLoaded', start, { once: true })
  else
    start()
})()