electron/spec/api-browser-window-spec.coffee

assert = require 'assert'
fs     = require 'fs'
path   = require 'path'
http   = require 'http'
url    = require 'url'
os     = require 'os'

{remote, screen} = require 'electron'
{ipcMain, BrowserWindow} = remote.require 'electron'

isCI = remote.getGlobal('isCi')

describe 'browser-window module', ->
  fixtures = path.resolve __dirname, 'fixtures'

  w = null
  beforeEach ->
    w.destroy() if w?
    w = new BrowserWindow(show: false, width: 400, height: 400)
  afterEach ->
    w.destroy() if w?
    w = null

  describe 'BrowserWindow.close()', ->
    it 'should emit unload handler', (done) ->
      w.webContents.on 'did-finish-load', ->
        w.close()
      w.on 'closed', ->
        test = path.join(fixtures, 'api', 'unload')
        content = fs.readFileSync(test)
        fs.unlinkSync(test)
        assert.equal String(content), 'unload'
        done()
      w.loadURL 'file://' + path.join(fixtures, 'api', 'unload.html')

    it 'should emit beforeunload handler', (done) ->
      w.on 'onbeforeunload', ->
        done()
      w.webContents.on 'did-finish-load', ->
        w.close()
      w.loadURL 'file://' + path.join(fixtures, 'api', 'beforeunload-false.html')

  describe 'window.close()', ->
    it 'should emit unload handler', (done) ->
      w.on 'closed', ->
        test = path.join(fixtures, 'api', 'close')
        content = fs.readFileSync(test)
        fs.unlinkSync(test)
        assert.equal String(content), 'close'
        done()
      w.loadURL 'file://' + path.join(fixtures, 'api', 'close.html')

    it 'should emit beforeunload handler', (done) ->
      w.on 'onbeforeunload', ->
        done()
      w.loadURL 'file://' + path.join(fixtures, 'api', 'close-beforeunload-false.html')

  describe 'BrowserWindow.loadURL(url)', ->
    it 'should emit did-start-loading event', (done) ->
      w.webContents.on 'did-start-loading', ->
        done()
      w.loadURL 'about:blank'

    it 'should emit did-fail-load event', (done) ->
      w.webContents.on 'did-fail-load', ->
        done()
      w.loadURL 'file://a.txt'

  describe 'BrowserWindow.show()', ->
    it 'should focus on window', ->
      return if isCI
      w.show()
      assert w.isFocused()

  describe 'BrowserWindow.showInactive()', ->
    it 'should not focus on window', ->
      w.showInactive()
      assert !w.isFocused()

  describe 'BrowserWindow.focus()', ->
    it 'does not make the window become visible', ->
      assert.equal w.isVisible(), false
      w.focus()
      assert.equal w.isVisible(), false

  describe 'BrowserWindow.capturePage(rect, callback)', ->
    it 'calls the callback with a Buffer', (done) ->
      w.capturePage {x: 0, y: 0, width: 100, height: 100}, (image) ->
        assert.equal image.isEmpty(), true
        done()

  describe 'BrowserWindow.setSize(width, height)', ->
    it 'sets the window size', (done) ->
      size = [300, 400]
      w.once 'resize', ->
        newSize = w.getSize()
        assert.equal newSize[0], size[0]
        assert.equal newSize[1], size[1]
        done()
      w.setSize size[0], size[1]

  describe 'BrowserWindow.setPosition(x, y)', ->
    it 'sets the window position', (done) ->
      pos = [10, 10]
      w.once 'move', ->
        newPos = w.getPosition()
        assert.equal newPos[0], pos[0]
        assert.equal newPos[1], pos[1]
        done()
      w.setPosition pos[0], pos[1]

  describe 'BrowserWindow.setContentSize(width, height)', ->
    it 'sets the content size', ->
      size = [400, 400]
      w.setContentSize size[0], size[1]
      after = w.getContentSize()
      assert.equal after[0], size[0]
      assert.equal after[1], size[1]

    it 'works for framless window', ->
      w.destroy()
      w = new BrowserWindow(show: false, frame: false, width: 400, height: 400)
      size = [400, 400]
      w.setContentSize size[0], size[1]
      after = w.getContentSize()
      assert.equal after[0], size[0]
      assert.equal after[1], size[1]

  describe 'BrowserWindow.fromId(id)', ->
    it 'returns the window with id', ->
      assert.equal w.id, BrowserWindow.fromId(w.id).id

  describe 'BrowserWindow.setResizable(resizable)', ->
    it 'does not change window size for frameless window', ->
      w.destroy()
      w = new BrowserWindow(show: true, frame: false)
      s = w.getSize()
      w.setResizable not w.isResizable()
      assert.deepEqual s, w.getSize()

  describe '"useContentSize" option', ->
    it 'make window created with content size when used', ->
      w.destroy()
      w = new BrowserWindow(show: false, width: 400, height: 400, useContentSize: true)
      contentSize = w.getContentSize()
      assert.equal contentSize[0], 400
      assert.equal contentSize[1], 400

    it 'make window created with window size when not used', ->
      size = w.getSize()
      assert.equal size[0], 400
      assert.equal size[1], 400

    it 'works for framless window', ->
      w.destroy()
      w = new BrowserWindow(show: false, frame: false, width: 400, height: 400, useContentSize: true)
      contentSize = w.getContentSize()
      assert.equal contentSize[0], 400
      assert.equal contentSize[1], 400
      size = w.getSize()
      assert.equal size[0], 400
      assert.equal size[1], 400

  describe '"title-bar-style" option', ->
    return if process.platform isnt 'darwin'
    return if parseInt(os.release().split('.')[0]) < 14 # only run these tests on Yosemite or newer

    it 'creates browser window with hidden title bar', ->
      w.destroy()
      w = new BrowserWindow(show: false, width: 400, height: 400, titleBarStyle: 'hidden')
      contentSize = w.getContentSize()
      assert.equal contentSize[1], 400

    it 'creates browser window with hidden inset title bar', ->
      w.destroy()
      w = new BrowserWindow(show: false, width: 400, height: 400, titleBarStyle: 'hidden-inset')
      contentSize = w.getContentSize()
      assert.equal contentSize[1], 400

  describe '"enableLargerThanScreen" option', ->
    return if process.platform is 'linux'

    beforeEach ->
      w.destroy()
      w = new BrowserWindow(show: true, width: 400, height: 400, enableLargerThanScreen: true)

    it 'can move the window out of screen', ->
      w.setPosition -10, -10
      after = w.getPosition()
      assert.equal after[0], -10
      assert.equal after[1], -10

    it 'can set the window larger than screen', ->
      size = screen.getPrimaryDisplay().size
      size.width += 100
      size.height += 100
      w.setSize size.width, size.height
      after = w.getSize()
      assert.equal after[0], size.width
      assert.equal after[1], size.height

  describe '"web-preferences" option', ->
    afterEach ->
      ipcMain.removeAllListeners('answer')

    describe '"preload" option', ->
      it 'loads the script before other scripts in window', (done) ->
        preload = path.join fixtures, 'module', 'set-global.js'
        ipcMain.once 'answer', (event, test) ->
          assert.equal(test, 'preload')
          done()
        w.destroy()
        w = new BrowserWindow
          show: false
          webPreferences:
            preload: preload
        w.loadURL 'file://' + path.join(fixtures, 'api', 'preload.html')

    describe '"node-integration" option', ->
      it 'disables node integration when specified to false', (done) ->
        preload = path.join fixtures, 'module', 'send-later.js'
        ipcMain.once 'answer', (event, test) ->
          assert.equal(test, 'undefined')
          done()
        w.destroy()
        w = new BrowserWindow
          show: false
          webPreferences:
            preload: preload
            nodeIntegration: false
        w.loadURL 'file://' + path.join(fixtures, 'api', 'blank.html')

  describe 'beforeunload handler', ->
    it 'returning true would not prevent close', (done) ->
      w.on 'closed', ->
        done()
      w.loadURL 'file://' + path.join(fixtures, 'api', 'close-beforeunload-true.html')

    it 'returning non-empty string would not prevent close', (done) ->
      w.on 'closed', ->
        done()
      w.loadURL 'file://' + path.join(fixtures, 'api', 'close-beforeunload-string.html')

    it 'returning false would prevent close', (done) ->
      w.on 'onbeforeunload', ->
        done()
      w.loadURL 'file://' + path.join(fixtures, 'api', 'close-beforeunload-false.html')

    it 'returning empty string would prevent close', (done) ->
      w.on 'onbeforeunload', ->
        done()
      w.loadURL 'file://' + path.join(fixtures, 'api', 'close-beforeunload-empty-string.html')

  describe 'new-window event', ->
    return if isCI and process.platform is 'darwin'
    it 'emits when window.open is called', (done) ->
      w.webContents.once 'new-window', (e, url, frameName) ->
        e.preventDefault()
        assert.equal url, 'http://host/'
        assert.equal frameName, 'host'
        done()
      w.loadURL "file://#{fixtures}/pages/window-open.html"

    it 'emits when link with target is called', (done) ->
      @timeout 10000
      w.webContents.once 'new-window', (e, url, frameName) ->
        e.preventDefault()
        assert.equal url, 'http://host/'
        assert.equal frameName, 'target'
        done()
      w.loadURL "file://#{fixtures}/pages/target-name.html"

  describe 'maximize event', ->
    return if isCI
    it 'emits when window is maximized', (done) ->
      @timeout 10000
      w.once 'maximize', -> done()
      w.show()
      w.maximize()

  describe 'unmaximize event', ->
    return if isCI
    it 'emits when window is unmaximized', (done) ->
      @timeout 10000
      w.once 'unmaximize', -> done()
      w.show()
      w.maximize()
      w.unmaximize()

  describe 'minimize event', ->
    return if isCI
    it 'emits when window is minimized', (done) ->
      @timeout 10000
      w.once 'minimize', -> done()
      w.show()
      w.minimize()

  xdescribe 'beginFrameSubscription method', ->
    it 'subscribes frame updates', (done) ->
      w.loadURL "file://#{fixtures}/api/blank.html"
      w.webContents.beginFrameSubscription (data) ->
        assert.notEqual data.length, 0
        w.webContents.endFrameSubscription()
        done()

  describe 'save page', ->
    savePageDir = path.join fixtures, 'save_page'
    savePageHtmlPath = path.join savePageDir, 'save_page.html'
    savePageJsPath = path.join savePageDir, 'save_page_files', 'test.js'
    savePageCssPath = path.join savePageDir, 'save_page_files', 'test.css'
    it 'should save page', (done) ->
      w.webContents.on 'did-finish-load', ->
        w.webContents.savePage savePageHtmlPath, 'HTMLComplete', (error) ->
          assert.equal error, null
          assert fs.existsSync savePageHtmlPath
          assert fs.existsSync savePageJsPath
          assert fs.existsSync savePageCssPath
          fs.unlinkSync savePageCssPath
          fs.unlinkSync savePageJsPath
          fs.unlinkSync savePageHtmlPath
          fs.rmdirSync path.join savePageDir, 'save_page_files'
          fs.rmdirSync savePageDir
          done()

      w.loadURL "file://#{fixtures}/pages/save_page/index.html"

  describe 'BrowserWindow options argument is optional', ->
    it 'should create a window with default size (800x600)', ->
      w.destroy()
      w = new BrowserWindow()
      size = w.getSize()
      assert.equal size[0], 800
      assert.equal size[1], 600