de36b2aaba
Note that Prettier, purposely, has only limited [configuration options](https://prettier.io/docs/en/options.html). The configuration file is based on [the one in `mozilla central`](https://searchfox.org/mozilla-central/source/.prettierrc) with just a few additions (to avoid future breakage if the defaults ever changes). Prettier is being used for a couple of reasons: - To be consistent with `mozilla-central`, where Prettier is already in use across the tree. - To ensure a *consistent* coding style everywhere, which is automatically enforced during linting (since Prettier is used as an ESLint plugin). This thus ends "all" formatting disussions once and for all, removing the need for review comments on most stylistic matters. Many ESLint options are now redundant, and I've tried my best to remove all the now unnecessary options (but I may have missed some). Note also that since Prettier considers the `printWidth` option as a guide, rather than a hard rule, this patch resorts to a small hack in the ESLint config to ensure that *comments* won't become too long. *Please note:* This patch is generated automatically, by appending the `--fix` argument to the ESLint call used in the `gulp lint` task. It will thus require some additional clean-up, which will be done in a *separate* commit. (On a more personal note, I'll readily admit that some of the changes Prettier makes are *extremely* ugly. However, in the name of consistency we'll probably have to live with that.)
428 lines
12 KiB
JavaScript
428 lines
12 KiB
JavaScript
/* Copyright 2017 Mozilla Foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import {
|
|
AbortException,
|
|
createPromiseCapability,
|
|
UnknownErrorException,
|
|
} from "../../src/shared/util";
|
|
import { LoopbackPort } from "../../src/display/api";
|
|
import { MessageHandler } from "../../src/shared/message_handler";
|
|
|
|
describe("message_handler", function() {
|
|
// Sleep function to wait for sometime, similar to setTimeout but faster.
|
|
function sleep(ticks) {
|
|
return Promise.resolve().then(() => {
|
|
return ticks && sleep(ticks - 1);
|
|
});
|
|
}
|
|
|
|
describe("sendWithStream", function() {
|
|
it("should return a ReadableStream", function() {
|
|
let port = new LoopbackPort();
|
|
let messageHandler1 = new MessageHandler("main", "worker", port);
|
|
let readable = messageHandler1.sendWithStream("fakeHandler");
|
|
// Check if readable is an instance of ReadableStream.
|
|
expect(typeof readable).toEqual("object");
|
|
expect(typeof readable.getReader).toEqual("function");
|
|
});
|
|
|
|
it("should read using a reader", function(done) {
|
|
let log = "";
|
|
let port = new LoopbackPort();
|
|
let messageHandler1 = new MessageHandler("main", "worker", port);
|
|
let messageHandler2 = new MessageHandler("worker", "main", port);
|
|
messageHandler2.on("fakeHandler", (data, sink) => {
|
|
sink.onPull = function() {
|
|
log += "p";
|
|
};
|
|
sink.onCancel = function(reason) {
|
|
log += "c";
|
|
};
|
|
sink.ready
|
|
.then(() => {
|
|
sink.enqueue("hi");
|
|
return sink.ready;
|
|
})
|
|
.then(() => {
|
|
sink.close();
|
|
});
|
|
return sleep(5);
|
|
});
|
|
let readable = messageHandler1.sendWithStream(
|
|
"fakeHandler",
|
|
{},
|
|
{
|
|
highWaterMark: 1,
|
|
size() {
|
|
return 1;
|
|
},
|
|
}
|
|
);
|
|
let reader = readable.getReader();
|
|
sleep(10)
|
|
.then(() => {
|
|
expect(log).toEqual("");
|
|
return reader.read();
|
|
})
|
|
.then(result => {
|
|
expect(log).toEqual("p");
|
|
expect(result.value).toEqual("hi");
|
|
expect(result.done).toEqual(false);
|
|
return sleep(10);
|
|
})
|
|
.then(() => {
|
|
return reader.read();
|
|
})
|
|
.then(result => {
|
|
expect(result.value).toEqual(undefined);
|
|
expect(result.done).toEqual(true);
|
|
done();
|
|
});
|
|
});
|
|
|
|
it("should not read any data when cancelled", function(done) {
|
|
let log = "";
|
|
let port = new LoopbackPort();
|
|
let messageHandler2 = new MessageHandler("worker", "main", port);
|
|
messageHandler2.on("fakeHandler", (data, sink) => {
|
|
sink.onPull = function() {
|
|
log += "p";
|
|
};
|
|
sink.onCancel = function(reason) {
|
|
log += "c";
|
|
};
|
|
log += "0";
|
|
sink.ready
|
|
.then(() => {
|
|
log += "1";
|
|
sink.enqueue([1, 2, 3, 4], 4);
|
|
return sink.ready;
|
|
})
|
|
.then(() => {
|
|
log += "2";
|
|
sink.enqueue([5, 6, 7, 8], 4);
|
|
return sink.ready;
|
|
})
|
|
.then(
|
|
() => {
|
|
log += "3";
|
|
sink.close();
|
|
},
|
|
() => {
|
|
log += "4";
|
|
}
|
|
);
|
|
});
|
|
let messageHandler1 = new MessageHandler("main", "worker", port);
|
|
let readable = messageHandler1.sendWithStream(
|
|
"fakeHandler",
|
|
{},
|
|
{
|
|
highWaterMark: 4,
|
|
size(arr) {
|
|
return arr.length;
|
|
},
|
|
}
|
|
);
|
|
|
|
let reader = readable.getReader();
|
|
sleep(10)
|
|
.then(() => {
|
|
expect(log).toEqual("01");
|
|
return reader.read();
|
|
})
|
|
.then(result => {
|
|
expect(result.value).toEqual([1, 2, 3, 4]);
|
|
expect(result.done).toEqual(false);
|
|
return sleep(10);
|
|
})
|
|
.then(() => {
|
|
expect(log).toEqual("01p2");
|
|
return reader.cancel(new AbortException("reader cancelled."));
|
|
})
|
|
.then(() => {
|
|
expect(log).toEqual("01p2c4");
|
|
done();
|
|
});
|
|
});
|
|
|
|
it("should not read when errored", function(done) {
|
|
let log = "";
|
|
let port = new LoopbackPort();
|
|
let messageHandler2 = new MessageHandler("worker", "main", port);
|
|
messageHandler2.on("fakeHandler", (data, sink) => {
|
|
sink.onPull = function() {
|
|
log += "p";
|
|
};
|
|
sink.onCancel = function(reason) {
|
|
log += "c";
|
|
};
|
|
log += "0";
|
|
sink.ready
|
|
.then(() => {
|
|
log += "1";
|
|
sink.enqueue([1, 2, 3, 4], 4);
|
|
return sink.ready;
|
|
})
|
|
.then(() => {
|
|
log += "e";
|
|
sink.error(new Error("should not read when errored"));
|
|
});
|
|
});
|
|
let messageHandler1 = new MessageHandler("main", "worker", port);
|
|
let readable = messageHandler1.sendWithStream(
|
|
"fakeHandler",
|
|
{},
|
|
{
|
|
highWaterMark: 4,
|
|
size(arr) {
|
|
return arr.length;
|
|
},
|
|
}
|
|
);
|
|
|
|
let reader = readable.getReader();
|
|
|
|
sleep(10)
|
|
.then(() => {
|
|
expect(log).toEqual("01");
|
|
return reader.read();
|
|
})
|
|
.then(result => {
|
|
expect(result.value).toEqual([1, 2, 3, 4]);
|
|
expect(result.done).toEqual(false);
|
|
return reader.read();
|
|
})
|
|
.catch(reason => {
|
|
expect(log).toEqual("01pe");
|
|
expect(reason instanceof UnknownErrorException).toEqual(true);
|
|
expect(reason.message).toEqual("should not read when errored");
|
|
done();
|
|
});
|
|
});
|
|
|
|
it("should read data with blocking promise", function(done) {
|
|
let log = "";
|
|
let port = new LoopbackPort();
|
|
let messageHandler2 = new MessageHandler("worker", "main", port);
|
|
messageHandler2.on("fakeHandler", (data, sink) => {
|
|
sink.onPull = function() {
|
|
log += "p";
|
|
};
|
|
sink.onCancel = function(reason) {
|
|
log += "c";
|
|
};
|
|
log += "0";
|
|
sink.ready
|
|
.then(() => {
|
|
log += "1";
|
|
sink.enqueue([1, 2, 3, 4], 4);
|
|
return sink.ready;
|
|
})
|
|
.then(() => {
|
|
log += "2";
|
|
sink.enqueue([5, 6, 7, 8], 4);
|
|
return sink.ready;
|
|
})
|
|
.then(() => {
|
|
sink.close();
|
|
});
|
|
});
|
|
|
|
let messageHandler1 = new MessageHandler("main", "worker", port);
|
|
let readable = messageHandler1.sendWithStream(
|
|
"fakeHandler",
|
|
{},
|
|
{
|
|
highWaterMark: 4,
|
|
size(arr) {
|
|
return arr.length;
|
|
},
|
|
}
|
|
);
|
|
|
|
let reader = readable.getReader();
|
|
// Sleep for 10ms, so that read() is not unblocking the ready promise.
|
|
// Chain all read() to stream in sequence.
|
|
sleep(10)
|
|
.then(() => {
|
|
expect(log).toEqual("01");
|
|
return reader.read();
|
|
})
|
|
.then(result => {
|
|
expect(result.value).toEqual([1, 2, 3, 4]);
|
|
expect(result.done).toEqual(false);
|
|
return sleep(10);
|
|
})
|
|
.then(() => {
|
|
expect(log).toEqual("01p2");
|
|
return reader.read();
|
|
})
|
|
.then(result => {
|
|
expect(result.value).toEqual([5, 6, 7, 8]);
|
|
expect(result.done).toEqual(false);
|
|
return sleep(10);
|
|
})
|
|
.then(() => {
|
|
expect(log).toEqual("01p2p");
|
|
return reader.read();
|
|
})
|
|
.then(result => {
|
|
expect(result.value).toEqual(undefined);
|
|
expect(result.done).toEqual(true);
|
|
done();
|
|
});
|
|
});
|
|
|
|
it(
|
|
"should read data with blocking promise and buffer whole data" +
|
|
" into stream",
|
|
function(done) {
|
|
let log = "";
|
|
let port = new LoopbackPort();
|
|
let messageHandler2 = new MessageHandler("worker", "main", port);
|
|
messageHandler2.on("fakeHandler", (data, sink) => {
|
|
sink.onPull = function() {
|
|
log += "p";
|
|
};
|
|
sink.onCancel = function(reason) {
|
|
log += "c";
|
|
};
|
|
log += "0";
|
|
sink.ready
|
|
.then(() => {
|
|
log += "1";
|
|
sink.enqueue([1, 2, 3, 4], 4);
|
|
return sink.ready;
|
|
})
|
|
.then(() => {
|
|
log += "2";
|
|
sink.enqueue([5, 6, 7, 8], 4);
|
|
return sink.ready;
|
|
})
|
|
.then(() => {
|
|
sink.close();
|
|
});
|
|
return sleep(10);
|
|
});
|
|
|
|
let messageHandler1 = new MessageHandler("main", "worker", port);
|
|
let readable = messageHandler1.sendWithStream(
|
|
"fakeHandler",
|
|
{},
|
|
{
|
|
highWaterMark: 8,
|
|
size(arr) {
|
|
return arr.length;
|
|
},
|
|
}
|
|
);
|
|
|
|
let reader = readable.getReader();
|
|
|
|
sleep(10)
|
|
.then(() => {
|
|
expect(log).toEqual("012");
|
|
return reader.read();
|
|
})
|
|
.then(result => {
|
|
expect(result.value).toEqual([1, 2, 3, 4]);
|
|
expect(result.done).toEqual(false);
|
|
return sleep(10);
|
|
})
|
|
.then(() => {
|
|
expect(log).toEqual("012p");
|
|
return reader.read();
|
|
})
|
|
.then(result => {
|
|
expect(result.value).toEqual([5, 6, 7, 8]);
|
|
expect(result.done).toEqual(false);
|
|
return sleep(10);
|
|
})
|
|
.then(() => {
|
|
expect(log).toEqual("012p");
|
|
return reader.read();
|
|
})
|
|
.then(result => {
|
|
expect(result.value).toEqual(undefined);
|
|
expect(result.done).toEqual(true);
|
|
done();
|
|
});
|
|
}
|
|
);
|
|
|
|
it("should ignore any pull after close is called", function(done) {
|
|
let log = "";
|
|
let port = new LoopbackPort();
|
|
let capability = createPromiseCapability();
|
|
let messageHandler2 = new MessageHandler("worker", "main", port);
|
|
messageHandler2.on("fakeHandler", (data, sink) => {
|
|
sink.onPull = function() {
|
|
log += "p";
|
|
};
|
|
sink.onCancel = function(reason) {
|
|
log += "c";
|
|
};
|
|
log += "0";
|
|
sink.ready.then(() => {
|
|
log += "1";
|
|
sink.enqueue([1, 2, 3, 4], 4);
|
|
});
|
|
return capability.promise.then(() => {
|
|
sink.close();
|
|
});
|
|
});
|
|
|
|
let messageHandler1 = new MessageHandler("main", "worker", port);
|
|
let readable = messageHandler1.sendWithStream(
|
|
"fakeHandler",
|
|
{},
|
|
{
|
|
highWaterMark: 10,
|
|
size(arr) {
|
|
return arr.length;
|
|
},
|
|
}
|
|
);
|
|
|
|
let reader = readable.getReader();
|
|
|
|
sleep(10)
|
|
.then(() => {
|
|
expect(log).toEqual("01");
|
|
capability.resolve();
|
|
return capability.promise.then(() => {
|
|
return reader.read();
|
|
});
|
|
})
|
|
.then(result => {
|
|
expect(result.value).toEqual([1, 2, 3, 4]);
|
|
expect(result.done).toEqual(false);
|
|
return sleep(10);
|
|
})
|
|
.then(() => {
|
|
expect(log).toEqual("01");
|
|
return reader.read();
|
|
})
|
|
.then(result => {
|
|
expect(result.value).toEqual(undefined);
|
|
expect(result.done).toEqual(true);
|
|
done();
|
|
});
|
|
});
|
|
});
|
|
});
|