2019-10-09 23:33:15 +00:00
|
|
|
import { expect } from 'chai'
|
|
|
|
import * as path from 'path'
|
|
|
|
import * as fs from 'fs'
|
|
|
|
import { BrowserWindow } from 'electron'
|
|
|
|
import { ifdescribe, ifit } from './spec-helpers'
|
|
|
|
import { closeAllWindows } from './window-helpers'
|
|
|
|
import * as childProcess from 'child_process'
|
2019-05-20 17:04:18 +00:00
|
|
|
|
2016-06-23 22:20:04 +00:00
|
|
|
const Module = require('module')
|
2019-05-20 17:04:18 +00:00
|
|
|
|
2019-10-09 23:33:15 +00:00
|
|
|
const features = process.electronBinding('features')
|
|
|
|
const nativeModulesEnabled = !process.env.ELECTRON_SKIP_NATIVE_MODULE_TESTS
|
2017-05-25 23:40:15 +00:00
|
|
|
|
2017-10-27 20:45:58 +00:00
|
|
|
describe('modules support', () => {
|
|
|
|
const fixtures = path.join(__dirname, 'fixtures')
|
2016-02-17 01:09:41 +00:00
|
|
|
|
2017-10-27 20:45:58 +00:00
|
|
|
describe('third-party module', () => {
|
2019-10-09 23:33:15 +00:00
|
|
|
ifdescribe(nativeModulesEnabled)('echo', () => {
|
|
|
|
afterEach(closeAllWindows)
|
|
|
|
it('can be required in renderer', async () => {
|
|
|
|
const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } })
|
|
|
|
w.loadURL('about:blank')
|
2019-12-18 06:24:50 +00:00
|
|
|
await expect(w.webContents.executeJavaScript(`{ require('echo'); null }`)).to.be.fulfilled()
|
2017-05-25 23:40:15 +00:00
|
|
|
})
|
2016-02-17 01:09:41 +00:00
|
|
|
|
2019-10-09 23:33:15 +00:00
|
|
|
ifit(features.isRunAsNodeEnabled())('can be required in node binary', function (done) {
|
|
|
|
const child = childProcess.fork(path.join(fixtures, 'module', 'echo.js'))
|
2017-10-27 20:45:58 +00:00
|
|
|
child.on('message', (msg) => {
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(msg).to.equal('ok')
|
2017-05-25 23:40:15 +00:00
|
|
|
done()
|
2016-03-25 20:03:49 +00:00
|
|
|
})
|
|
|
|
})
|
2018-10-16 00:26:34 +00:00
|
|
|
|
2019-10-09 23:33:15 +00:00
|
|
|
ifit(process.platform === 'win32')('can be required if electron.exe is renamed', () => {
|
|
|
|
const testExecPath = path.join(path.dirname(process.execPath), 'test.exe')
|
|
|
|
fs.copyFileSync(process.execPath, testExecPath)
|
|
|
|
try {
|
|
|
|
const fixture = path.join(fixtures, 'module', 'echo-renamed.js')
|
|
|
|
expect(fs.existsSync(fixture)).to.be.true()
|
|
|
|
const child = childProcess.spawnSync(testExecPath, [fixture])
|
|
|
|
expect(child.status).to.equal(0)
|
|
|
|
} finally {
|
|
|
|
fs.unlinkSync(testExecPath)
|
|
|
|
}
|
|
|
|
})
|
2017-05-25 23:40:15 +00:00
|
|
|
})
|
2016-02-17 01:09:41 +00:00
|
|
|
|
2017-10-27 20:45:58 +00:00
|
|
|
describe('q', () => {
|
|
|
|
describe('Q.when', () => {
|
|
|
|
it('emits the fullfil callback', (done) => {
|
2019-11-05 16:36:25 +00:00
|
|
|
const Q = require('q')
|
2019-10-09 23:33:15 +00:00
|
|
|
Q(true).then((val: boolean) => {
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(val).to.be.true()
|
2017-04-20 17:48:17 +00:00
|
|
|
done()
|
|
|
|
})
|
2016-03-25 20:03:49 +00:00
|
|
|
})
|
|
|
|
})
|
|
|
|
})
|
2017-01-11 03:29:22 +00:00
|
|
|
|
2019-04-20 17:20:37 +00:00
|
|
|
describe('coffeescript', () => {
|
2017-10-27 20:45:58 +00:00
|
|
|
it('can be registered and used to require .coffee files', () => {
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(() => {
|
2019-04-20 17:20:37 +00:00
|
|
|
require('coffeescript').register()
|
2019-05-20 17:04:18 +00:00
|
|
|
}).to.not.throw()
|
|
|
|
expect(require('./fixtures/module/test.coffee')).to.be.true()
|
2017-02-07 16:48:01 +00:00
|
|
|
})
|
|
|
|
})
|
|
|
|
})
|
|
|
|
|
2017-10-27 20:45:58 +00:00
|
|
|
describe('global variables', () => {
|
|
|
|
describe('process', () => {
|
|
|
|
it('can be declared in a module', () => {
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(require('./fixtures/module/declare-process')).to.equal('declared process')
|
2017-01-11 03:29:22 +00:00
|
|
|
})
|
|
|
|
})
|
|
|
|
|
2017-10-27 20:45:58 +00:00
|
|
|
describe('global', () => {
|
|
|
|
it('can be declared in a module', () => {
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(require('./fixtures/module/declare-global')).to.equal('declared global')
|
2017-01-11 03:29:22 +00:00
|
|
|
})
|
|
|
|
})
|
2017-02-06 23:08:08 +00:00
|
|
|
|
2017-10-27 20:45:58 +00:00
|
|
|
describe('Buffer', () => {
|
|
|
|
it('can be declared in a module', () => {
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(require('./fixtures/module/declare-buffer')).to.equal('declared Buffer')
|
2017-02-06 23:08:08 +00:00
|
|
|
})
|
|
|
|
})
|
2017-01-11 03:29:22 +00:00
|
|
|
})
|
2016-06-23 22:20:04 +00:00
|
|
|
|
2017-10-27 20:45:58 +00:00
|
|
|
describe('Module._nodeModulePaths', () => {
|
|
|
|
describe('when the path is inside the resources path', () => {
|
|
|
|
it('does not include paths outside of the resources path', () => {
|
2017-04-20 17:48:17 +00:00
|
|
|
let modulePath = process.resourcesPath
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(Module._nodeModulePaths(modulePath)).to.deep.equal([
|
2017-04-20 17:48:17 +00:00
|
|
|
path.join(process.resourcesPath, 'node_modules')
|
|
|
|
])
|
|
|
|
|
|
|
|
modulePath = process.resourcesPath + '-foo'
|
2017-10-27 20:45:58 +00:00
|
|
|
const nodeModulePaths = Module._nodeModulePaths(modulePath)
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(nodeModulePaths).to.include(path.join(modulePath, 'node_modules'))
|
|
|
|
expect(nodeModulePaths).to.include(path.join(modulePath, '..', 'node_modules'))
|
2017-04-20 17:48:17 +00:00
|
|
|
|
|
|
|
modulePath = path.join(process.resourcesPath, 'foo')
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(Module._nodeModulePaths(modulePath)).to.deep.equal([
|
2017-04-20 17:48:17 +00:00
|
|
|
path.join(process.resourcesPath, 'foo', 'node_modules'),
|
|
|
|
path.join(process.resourcesPath, 'node_modules')
|
|
|
|
])
|
|
|
|
|
|
|
|
modulePath = path.join(process.resourcesPath, 'node_modules', 'foo')
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(Module._nodeModulePaths(modulePath)).to.deep.equal([
|
2017-04-20 17:48:17 +00:00
|
|
|
path.join(process.resourcesPath, 'node_modules', 'foo', 'node_modules'),
|
|
|
|
path.join(process.resourcesPath, 'node_modules')
|
|
|
|
])
|
|
|
|
|
|
|
|
modulePath = path.join(process.resourcesPath, 'node_modules', 'foo', 'bar')
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(Module._nodeModulePaths(modulePath)).to.deep.equal([
|
2017-04-20 17:48:17 +00:00
|
|
|
path.join(process.resourcesPath, 'node_modules', 'foo', 'bar', 'node_modules'),
|
|
|
|
path.join(process.resourcesPath, 'node_modules', 'foo', 'node_modules'),
|
|
|
|
path.join(process.resourcesPath, 'node_modules')
|
|
|
|
])
|
|
|
|
|
|
|
|
modulePath = path.join(process.resourcesPath, 'node_modules', 'foo', 'node_modules', 'bar')
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(Module._nodeModulePaths(modulePath)).to.deep.equal([
|
2017-04-20 17:48:17 +00:00
|
|
|
path.join(process.resourcesPath, 'node_modules', 'foo', 'node_modules', 'bar', 'node_modules'),
|
|
|
|
path.join(process.resourcesPath, 'node_modules', 'foo', 'node_modules'),
|
|
|
|
path.join(process.resourcesPath, 'node_modules')
|
|
|
|
])
|
|
|
|
})
|
2016-06-23 22:20:04 +00:00
|
|
|
})
|
|
|
|
|
2017-10-27 20:45:58 +00:00
|
|
|
describe('when the path is outside the resources path', () => {
|
|
|
|
it('includes paths outside of the resources path', () => {
|
2018-10-02 01:56:31 +00:00
|
|
|
const modulePath = path.resolve('/foo')
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(Module._nodeModulePaths(modulePath)).to.deep.equal([
|
2017-04-20 17:48:17 +00:00
|
|
|
path.join(modulePath, 'node_modules'),
|
|
|
|
path.resolve('/node_modules')
|
|
|
|
])
|
|
|
|
})
|
2016-06-23 22:20:04 +00:00
|
|
|
})
|
|
|
|
})
|
2017-04-03 10:46:24 +00:00
|
|
|
|
2017-04-20 17:48:17 +00:00
|
|
|
describe('require', () => {
|
|
|
|
describe('when loaded URL is not file: protocol', () => {
|
2019-10-09 23:33:15 +00:00
|
|
|
afterEach(closeAllWindows)
|
2017-04-20 17:48:17 +00:00
|
|
|
it('searches for module under app directory', async () => {
|
2019-10-09 23:33:15 +00:00
|
|
|
const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } })
|
2017-04-20 17:48:17 +00:00
|
|
|
w.loadURL('about:blank')
|
|
|
|
const result = await w.webContents.executeJavaScript('typeof require("q").when')
|
2019-05-20 17:04:18 +00:00
|
|
|
expect(result).to.equal('function')
|
2017-04-20 17:48:17 +00:00
|
|
|
})
|
2017-04-04 00:08:27 +00:00
|
|
|
})
|
2017-04-03 10:46:24 +00:00
|
|
|
})
|
|
|
|
})
|