test: move BrowserView specs to main process (#19409)

spec-main/api-browser-view-spec.ts

@@ -0,0 +1,240 @@
+import { expect } from 'chai'
+import * as ChildProcess from 'child_process'
+import * as path from 'path'
+import { emittedOnce } from './events-helpers'
+import { BrowserView, BrowserWindow } from 'electron'
+import { closeWindow } from './window-helpers';
+
+describe('BrowserView module', () => {
+  const fixtures = path.resolve(__dirname, '..', 'spec', 'fixtures')
+
+  let w: BrowserWindow
+  let view: BrowserView
+
+  beforeEach(() => {
+    w = new BrowserWindow({
+      show: false,
+      width: 400,
+      height: 400,
+      webPreferences: {
+        backgroundThrottling: false
+      }
+    })
+  })
+
+  afterEach(async () => {
+    if (view) {
+      view.destroy()
+    }
+
+    await closeWindow(w)
+  })
+
+  describe('BrowserView.destroy()', () => {
+    it('does not throw', () => {
+      view = new BrowserView()
+      view.destroy()
+    })
+  })
+
+  describe('BrowserView.isDestroyed()', () => {
+    it('returns correct value', () => {
+      view = new BrowserView()
+      expect(view.isDestroyed()).to.be.false('view is destroyed')
+      view.destroy()
+      expect(view.isDestroyed()).to.be.true('view is destroyed')
+    })
+  })
+
+  describe('BrowserView.setBackgroundColor()', () => {
+    it('does not throw for valid args', () => {
+      view = new BrowserView()
+      view.setBackgroundColor('#000')
+    })
+
+    it('throws for invalid args', () => {
+      view = new BrowserView()
+      expect(() => {
+        view.setBackgroundColor(null as any)
+      }).to.throw(/conversion failure/)
+    })
+  })
+
+  describe('BrowserView.setAutoResize()', () => {
+    it('does not throw for valid args', () => {
+      view = new BrowserView()
+      view.setAutoResize({})
+      view.setAutoResize({ width: true, height: false })
+    })
+
+    it('throws for invalid args', () => {
+      view = new BrowserView()
+      expect(() => {
+        view.setAutoResize(null as any)
+      }).to.throw(/conversion failure/)
+    })
+  })
+
+  describe('BrowserView.setBounds()', () => {
+    it('does not throw for valid args', () => {
+      view = new BrowserView()
+      view.setBounds({ x: 0, y: 0, width: 1, height: 1 })
+    })
+
+    it('throws for invalid args', () => {
+      view = new BrowserView()
+      expect(() => {
+        view.setBounds(null as any)
+      }).to.throw(/conversion failure/)
+      expect(() => {
+        view.setBounds({} as any)
+      }).to.throw(/conversion failure/)
+    })
+  })
+
+  describe('BrowserWindow.setBrowserView()', () => {
+    it('does not throw for valid args', () => {
+      view = new BrowserView()
+      w.setBrowserView(view)
+    })
+
+    it('does not throw if called multiple times with same view', () => {
+      view = new BrowserView()
+      w.setBrowserView(view)
+      w.setBrowserView(view)
+      w.setBrowserView(view)
+    })
+  })
+
+  describe('BrowserWindow.getBrowserView()', () => {
+    it('returns the set view', () => {
+      view = new BrowserView()
+      w.setBrowserView(view)
+      expect(view.id).to.not.be.null('view id')
+
+      const view2 = w.getBrowserView()
+      expect(view2!.webContents.id).to.equal(view.webContents.id)
+    })
+
+    it('returns null if none is set', () => {
+      const view = w.getBrowserView()
+      expect(view).to.be.null('view')
+    })
+  })
+
+  describe('BrowserWindow.addBrowserView()', () => {
+    it('does not throw for valid args', () => {
+      const view1 = new BrowserView()
+      w.addBrowserView(view1)
+      const view2 = new BrowserView()
+      w.addBrowserView(view2)
+      view1.destroy()
+      view2.destroy()
+    })
+    it('does not throw if called multiple times with same view', () => {
+      view = new BrowserView()
+      w.addBrowserView(view)
+      w.addBrowserView(view)
+      w.addBrowserView(view)
+    })
+  })
+
+  describe('BrowserWindow.removeBrowserView()', () => {
+    it('does not throw if called multiple times with same view', () => {
+      view = new BrowserView()
+      w.addBrowserView(view)
+      w.removeBrowserView(view)
+      w.removeBrowserView(view)
+    })
+  })
+
+  describe('BrowserWindow.getBrowserViews()', () => {
+    it('returns same views as was added', () => {
+      const view1 = new BrowserView()
+      w.addBrowserView(view1)
+      const view2 = new BrowserView()
+      w.addBrowserView(view2)
+
+      expect(view1.id).to.be.not.null('view id')
+      const views = w.getBrowserViews()
+      expect(views).to.have.lengthOf(2)
+      expect(views[0].webContents.id).to.equal(view1.webContents.id)
+      expect(views[1].webContents.id).to.equal(view2.webContents.id)
+
+      view1.destroy()
+      view2.destroy()
+    })
+  })
+
+  describe('BrowserView.webContents.getOwnerBrowserWindow()', () => {
+    it('points to owning window', () => {
+      view = new BrowserView()
+      expect(view.webContents.getOwnerBrowserWindow()).to.be.null('owner browser window')
+
+      w.setBrowserView(view)
+      expect(view.webContents.getOwnerBrowserWindow()).to.equal(w)
+
+      w.setBrowserView(null)
+      expect(view.webContents.getOwnerBrowserWindow()).to.be.null('owner browser window')
+    })
+  })
+
+  describe('BrowserView.fromId()', () => {
+    it('returns the view with given id', () => {
+      view = new BrowserView()
+      w.setBrowserView(view)
+      expect(view.id).to.not.be.null('view id')
+
+      const view2 = BrowserView.fromId(view.id)
+      expect(view2.webContents.id).to.equal(view.webContents.id)
+    })
+  })
+
+  describe('BrowserView.fromWebContents()', () => {
+    it('returns the view with given id', () => {
+      view = new BrowserView()
+      w.setBrowserView(view)
+      expect(view.id).to.not.be.null('view id')
+
+      const view2 = BrowserView.fromWebContents(view.webContents)
+      expect(view2!.webContents.id).to.equal(view.webContents.id)
+    })
+  })
+
+  describe('BrowserView.getAllViews()', () => {
+    it('returns all views', () => {
+      view = new BrowserView()
+      w.setBrowserView(view)
+      expect(view.id).to.not.be.null('view id')
+
+      const views = BrowserView.getAllViews()
+      expect(views).to.be.an('array').that.has.lengthOf(1)
+      expect(views[0].webContents.id).to.equal(view.webContents.id)
+    })
+  })
+
+  describe('new BrowserView()', () => {
+    it('does not crash on exit', async () => {
+      const appPath = path.join(fixtures, 'api', 'leak-exit-browserview.js')
+      const electronPath = process.execPath
+      const appProcess = ChildProcess.spawn(electronPath, [appPath])
+      const [code] = await emittedOnce(appProcess, 'close')
+      expect(code).to.equal(0)
+    })
+  })
+
+  describe('window.open()', () => {
+    it('works in BrowserView', (done) => {
+      view = new BrowserView()
+      w.setBrowserView(view)
+      view.webContents.once('new-window', (e, url, frameName, disposition, options, additionalFeatures) => {
+        e.preventDefault()
+        expect(url).to.equal('http://host/')
+        expect(frameName).to.equal('host')
+        expect(additionalFeatures[0]).to.equal('this-is-not-a-standard-feature')
+        done()
+      })
+      view.webContents.loadFile(path.join(fixtures, 'pages', 'window-open.html'))
+    })
+  })
+})