forked from electron/electron
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi-ipc-spec.js
More file actions
373 lines (319 loc) · 11.7 KB
/
api-ipc-spec.js
File metadata and controls
373 lines (319 loc) · 11.7 KB
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
'use strict'
const assert = require('assert')
const path = require('path')
const {closeWindow} = require('./window-helpers')
const {ipcRenderer, remote} = require('electron')
const {ipcMain, webContents, BrowserWindow} = remote
const comparePaths = function (path1, path2) {
if (process.platform === 'win32') {
path1 = path1.toLowerCase()
path2 = path2.toLowerCase()
}
assert.equal(path1, path2)
}
describe('ipc module', function () {
var fixtures = path.join(__dirname, 'fixtures')
var w = null
afterEach(function () {
return closeWindow(w).then(function () { w = null })
})
describe('remote.require', function () {
it('should returns same object for the same module', function () {
var dialog1 = remote.require('electron')
var dialog2 = remote.require('electron')
assert.equal(dialog1, dialog2)
})
it('should work when object contains id property', function () {
var a = remote.require(path.join(fixtures, 'module', 'id.js'))
assert.equal(a.id, 1127)
})
it('should work when object has no prototype', function () {
var a = remote.require(path.join(fixtures, 'module', 'no-prototype.js'))
assert.equal(a.foo.constructor.name, '')
assert.equal(a.foo.bar, 'baz')
assert.equal(a.foo.baz, false)
assert.equal(a.bar, 1234)
assert.equal(a.anonymous.constructor.name, '')
assert.equal(a.getConstructorName(Object.create(null)), '')
assert.equal(a.getConstructorName(new (class {})), '')
})
it('should search module from the user app', function () {
comparePaths(path.normalize(remote.process.mainModule.filename), path.resolve(__dirname, 'static', 'main.js'))
comparePaths(path.normalize(remote.process.mainModule.paths[0]), path.resolve(__dirname, 'static', 'node_modules'))
})
it('handles circular references in arrays and objects', function () {
var a = remote.require(path.join(fixtures, 'module', 'circular.js'))
var arrayA = ['foo']
var arrayB = [arrayA, 'bar']
arrayA.push(arrayB)
assert.deepEqual(a.returnArgs(arrayA, arrayB), [
['foo', [null, 'bar']],
[['foo', null], 'bar']
])
var objectA = {foo: 'bar'}
var objectB = {baz: objectA}
objectA.objectB = objectB
assert.deepEqual(a.returnArgs(objectA, objectB), [
{foo: 'bar', objectB: {baz: null}},
{baz: {foo: 'bar', objectB: null}}
])
arrayA = [1, 2, 3]
assert.deepEqual(a.returnArgs({foo: arrayA}, {bar: arrayA}), [
{foo: [1, 2, 3]},
{bar: [1, 2, 3]}
])
objectA = {foo: 'bar'}
assert.deepEqual(a.returnArgs({foo: objectA}, {bar: objectA}), [
{foo: {foo: 'bar'}},
{bar: {foo: 'bar'}}
])
arrayA = []
arrayA.push(arrayA)
assert.deepEqual(a.returnArgs(arrayA), [
[null]
])
objectA = {}
objectA.foo = objectA
objectA.bar = 'baz'
assert.deepEqual(a.returnArgs(objectA), [
{foo: null, bar: 'baz'}
])
objectA = {}
objectA.foo = {bar: objectA}
objectA.bar = 'baz'
assert.deepEqual(a.returnArgs(objectA), [
{foo: {bar: null}, bar: 'baz'}
])
})
})
describe('remote.createFunctionWithReturnValue', function () {
it('should be called in browser synchronously', function () {
var buf = new Buffer('test')
var call = remote.require(path.join(fixtures, 'module', 'call.js'))
var result = call.call(remote.createFunctionWithReturnValue(buf))
assert.equal(result.constructor.name, 'Buffer')
})
})
describe('remote object in renderer', function () {
it('can change its properties', function () {
var property = remote.require(path.join(fixtures, 'module', 'property.js'))
assert.equal(property.property, 1127)
property.property = 1007
assert.equal(property.property, 1007)
var property2 = remote.require(path.join(fixtures, 'module', 'property.js'))
assert.equal(property2.property, 1007)
property.property = 1127
})
it('can construct an object from its member', function () {
var call = remote.require(path.join(fixtures, 'module', 'call.js'))
var obj = new call.constructor()
assert.equal(obj.test, 'test')
})
it('can reassign and delete its member functions', function () {
var remoteFunctions = remote.require(path.join(fixtures, 'module', 'function.js'))
assert.equal(remoteFunctions.aFunction(), 1127)
remoteFunctions.aFunction = function () { return 1234 }
assert.equal(remoteFunctions.aFunction(), 1234)
assert.equal(delete remoteFunctions.aFunction, true)
})
it('is referenced by its members', function () {
let stringify = remote.getGlobal('JSON').stringify
global.gc()
stringify({})
})
})
describe('remote value in browser', function () {
const print = path.join(fixtures, 'module', 'print_name.js')
const printName = remote.require(print)
it('keeps its constructor name for objects', function () {
const buf = new Buffer('test')
assert.equal(printName.print(buf), 'Buffer')
})
it('supports instanceof Date', function () {
const now = new Date()
assert.equal(printName.print(now), 'Date')
assert.deepEqual(printName.echo(now), now)
})
it('supports TypedArray', function () {
const values = [1, 2, 3, 4]
const typedArray = printName.typedArray(values)
assert.deepEqual(values, typedArray)
})
})
describe('remote promise', function () {
it('can be used as promise in each side', function (done) {
var promise = remote.require(path.join(fixtures, 'module', 'promise.js'))
promise.twicePromise(Promise.resolve(1234)).then(function (value) {
assert.equal(value, 2468)
done()
})
})
it('handles rejections via catch(onRejected)', function (done) {
var promise = remote.require(path.join(fixtures, 'module', 'rejected-promise.js'))
promise.reject(Promise.resolve(1234)).catch(function (error) {
assert.equal(error.message, 'rejected')
done()
})
})
it('handles rejections via then(onFulfilled, onRejected)', function (done) {
var promise = remote.require(path.join(fixtures, 'module', 'rejected-promise.js'))
promise.reject(Promise.resolve(1234)).then(function () {}, function (error) {
assert.equal(error.message, 'rejected')
done()
})
})
it('does not emit unhandled rejection events in the main process', function (done) {
remote.process.once('unhandledRejection', function (reason) {
done(reason)
})
var promise = remote.require(path.join(fixtures, 'module', 'unhandled-rejection.js'))
promise.reject().then(function () {
done(new Error('Promise was not rejected'))
}).catch(function (error) {
assert.equal(error.message, 'rejected')
done()
})
})
it('emits unhandled rejection events in the renderer process', function (done) {
window.addEventListener('unhandledrejection', function (event) {
event.preventDefault()
assert.equal(event.reason.message, 'rejected')
done()
})
var promise = remote.require(path.join(fixtures, 'module', 'unhandled-rejection.js'))
promise.reject().then(function () {
done(new Error('Promise was not rejected'))
})
})
})
describe('remote webContents', function () {
it('can return same object with different getters', function () {
var contents1 = remote.getCurrentWindow().webContents
var contents2 = remote.getCurrentWebContents()
assert(contents1 === contents2)
})
})
describe('remote class', function () {
let cl = remote.require(path.join(fixtures, 'module', 'class.js'))
let base = cl.base
let derived = cl.derived
it('can get methods', function () {
assert.equal(base.method(), 'method')
})
it('can get properties', function () {
assert.equal(base.readonly, 'readonly')
})
it('can change properties', function () {
assert.equal(base.value, 'old')
base.value = 'new'
assert.equal(base.value, 'new')
base.value = 'old'
})
it('has unenumerable methods', function () {
assert(!base.hasOwnProperty('method'))
assert(Object.getPrototypeOf(base).hasOwnProperty('method'))
})
it('keeps prototype chain in derived class', function () {
assert.equal(derived.method(), 'method')
assert.equal(derived.readonly, 'readonly')
assert(!derived.hasOwnProperty('method'))
let proto = Object.getPrototypeOf(derived)
assert(!proto.hasOwnProperty('method'))
assert(Object.getPrototypeOf(proto).hasOwnProperty('method'))
})
it('is referenced by methods in prototype chain', function () {
let method = derived.method
derived = null
global.gc()
assert.equal(method(), 'method')
})
})
describe('ipc.sender.send', function () {
it('should work when sending an object containing id property', function (done) {
var obj = {
id: 1,
name: 'ly'
}
ipcRenderer.once('message', function (event, message) {
assert.deepEqual(message, obj)
done()
})
ipcRenderer.send('message', obj)
})
it('can send instance of Date', function (done) {
const currentDate = new Date()
ipcRenderer.once('message', function (event, value) {
assert.equal(value, currentDate.toISOString())
done()
})
ipcRenderer.send('message', currentDate)
})
})
describe('ipc.sendSync', function () {
afterEach(function () {
ipcMain.removeAllListeners('send-sync-message')
})
it('can be replied by setting event.returnValue', function () {
var msg = ipcRenderer.sendSync('echo', 'test')
assert.equal(msg, 'test')
})
it('does not crash when reply is not sent and browser is destroyed', function (done) {
this.timeout(10000)
w = new BrowserWindow({
show: false
})
ipcMain.once('send-sync-message', function (event) {
event.returnValue = null
done()
})
w.loadURL('file://' + path.join(fixtures, 'api', 'send-sync-message.html'))
})
it('does not crash when reply is sent by multiple listeners', function (done) {
w = new BrowserWindow({
show: false
})
ipcMain.on('send-sync-message', function (event) {
event.returnValue = null
})
ipcMain.on('send-sync-message', function (event) {
event.returnValue = null
done()
})
w.loadURL('file://' + path.join(fixtures, 'api', 'send-sync-message.html'))
})
})
describe('ipcRenderer.sendTo', function () {
let contents = null
beforeEach(function () {
contents = webContents.create({})
})
afterEach(function () {
ipcRenderer.removeAllListeners('pong')
contents.destroy()
contents = null
})
it('sends message to WebContents', function (done) {
const webContentsId = remote.getCurrentWebContents().id
ipcRenderer.once('pong', function (event, id) {
assert.equal(webContentsId, id)
done()
})
contents.once('did-finish-load', function () {
ipcRenderer.sendTo(contents.id, 'ping', webContentsId)
})
contents.loadURL('file://' + path.join(fixtures, 'pages', 'ping-pong.html'))
})
})
describe('remote listeners', function () {
it('can be added and removed correctly', function () {
w = new BrowserWindow({
show: false
})
var listener = function () {}
w.on('test', listener)
assert.equal(w.listenerCount('test'), 1)
w.removeListener('test', listener)
assert.equal(w.listenerCount('test'), 0)
})
})
})