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
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";
AddonTestUtils.init(this);
AddonTestUtils.createAppInfo(
"xpcshell@tests.mozilla.org",
"XPCShell",
"1",
"42"
);
add_task(async function setup() {
await AddonTestUtils.promiseStartupManager();
});
add_task(async function test_method_return_runtime_port() {
await runExtensionAPITest("API method returns an ExtensionPort instance", {
backgroundScript({ testAsserts, testLog }) {
try {
browser.mockExtensionAPI.methodReturnsPort("port-create-error");
throw new Error("methodReturnsPort should have raised an exception");
} catch (err) {
testAsserts.equal(
err?.message,
"An unexpected error occurred",
"Got the expected error"
);
}
const port = browser.mockExtensionAPI.methodReturnsPort(
"port-create-success"
);
testAsserts.equal(!!port, true, "Got a port");
testAsserts.equal(
typeof port.name,
"string",
"port.name should be a string"
);
testAsserts.equal(
typeof port.sender,
"object",
"port.sender should be an object"
);
testAsserts.equal(
typeof port.disconnect,
"function",
"port.disconnect method"
);
testAsserts.equal(
typeof port.postMessage,
"function",
"port.postMessage method"
);
testAsserts.equal(
typeof port.onDisconnect?.addListener,
"function",
"port.onDisconnect.addListener method"
);
testAsserts.equal(
typeof port.onMessage?.addListener,
"function",
"port.onDisconnect.addListener method"
);
return new Promise(resolve => {
let messages = [];
port.onDisconnect.addListener(() => resolve(messages));
port.onMessage.addListener((...args) => {
messages.push(args);
});
});
},
assertResults({ testError, testResult }) {
Assert.deepEqual(testError, null, "Got no error as expected");
Assert.deepEqual(
testResult,
[
[1, 2],
[3, 4],
[5, 6],
],
"Got the expected results"
);
},
mockAPIRequestHandler(policy, request) {
if (request.apiName == "methodReturnsPort") {
if (request.args[0] == "port-create-error") {
return {
type: Ci.mozIExtensionAPIRequestResult.RETURN_VALUE,
value: "not-a-valid-port",
};
}
return {
type: Ci.mozIExtensionAPIRequestResult.RETURN_VALUE,
value: {
portId: "port-id-1",
name: "a-port-name",
},
};
} else if (request.requestType == "addListener") {
if (request.apiObjectType !== "Port") {
throw new Error(`Unexpected objectType ${request}`);
}
switch (request.apiName) {
case "onDisconnect":
this._onDisconnectCb = request.eventListener;
return;
case "onMessage":
Promise.resolve().then(async () => {
await request.eventListener.callListener([1, 2]);
await request.eventListener.callListener([3, 4]);
await request.eventListener.callListener([5, 6]);
this._onDisconnectCb.callListener([]);
});
return;
}
} else if (
request.requestType == "getProperty" &&
request.apiObjectType == "Port" &&
request.apiName == "sender"
) {
return {
type: Ci.mozIExtensionAPIRequestResult.RETURN_VALUE,
value: { id: "fake-sender-id-prop" },
};
}
throw new Error(`Unexpected request: ${request}`);
},
});
});
add_task(async function test_port_as_event_listener_eventListener_param() {
await runExtensionAPITest(
"API event eventListener received an ExtensionPort parameter",
{
backgroundScript({ testAsserts, testLog }) {
const api = browser.mockExtensionAPI;
let listener;
return new Promise((resolve, reject) => {
testLog("addListener and wait for event to be fired");
listener = port => {
try {
testAsserts.equal(!!port, true, "Got a port parameter");
testAsserts.equal(
port.name,
"a-port-name-2",
"Got expected port.name value"
);
testAsserts.equal(
typeof port.disconnect,
"function",
"port.disconnect method"
);
testAsserts.equal(
typeof port.postMessage,
"function",
"port.disconnect method"
);
port.onMessage.addListener((msg, portArg) => {
if (msg === "test-done") {
testLog("Got a port.onMessage event");
testAsserts.equal(
portArg?.name,
"a-port-name-2",
"Got port as last argument"
);
testAsserts.equal(
portArg === port,
true,
"Got the same port instance as expected"
);
resolve();
} else {
reject(
new Error(
`port.onMessage got an unexpected message: ${msg}`
)
);
}
});
} catch (err) {
reject(err);
}
};
api.onTestEvent.addListener(listener);
});
},
assertResults({ testError }) {
Assert.deepEqual(testError, null, "Got no error as expected");
},
mockAPIRequestHandler(policy, request) {
if (
request.requestType == "addListener" &&
request.apiName == "onTestEvent"
) {
request.eventListener.callListener(["arg0", "arg1"], {
apiObjectType: Ci.mozIExtensionListenerCallOptions.RUNTIME_PORT,
apiObjectDescriptor: { portId: "port-id-2", name: "a-port-name-2" },
apiObjectPrepended: true,
});
return;
} else if (
request.requestType == "addListener" &&
request.apiObjectType == "Port" &&
request.apiObjectId == "port-id-2"
) {
request.eventListener.callListener(["test-done"], {
apiObjectType: Ci.mozIExtensionListenerCallOptions.RUNTIME_PORT,
apiObjectDescriptor: { portId: "port-id-2", name: "a-port-name-2" },
});
return;
}
throw new Error(`Unexpected request: ${request}`);
},
}
);
});
|
