json-rpc-utils
Version:
JSON-RPC 2.0 client and server utilities
468 lines (467 loc) • 21.8 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
var mocha_1 = require("mocha");
var chai_1 = require("chai");
var _1 = require(".");
var models_1 = require("./models");
mocha_1.describe("JSONRPCServer", function () {
var server;
mocha_1.beforeEach(function () {
server = new _1.JSONRPCServer();
});
mocha_1.describe("having an echo method", function () {
mocha_1.beforeEach(function () {
server.addMethod("echo", function (_a, ServerContext) {
var text = _a.text;
if (ServerContext) {
return ServerContext.userID + " said " + text;
}
else {
return text;
}
});
});
mocha_1.describe("receiving a request to the method", function () {
mocha_1.it("should echo the text", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "echo",
params: { text: "foo" },
})];
case 1:
response = _a.sent();
chai_1.expect(response).to.deep.equal({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
result: "foo",
});
return [2 /*return*/];
}
});
}); });
});
mocha_1.describe("receiving a request to the method with user ID", function () {
mocha_1.it("should echo the text with the user ID", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "echo",
params: { text: "foo" },
}, { userID: "bar" })];
case 1:
response = _a.sent();
chai_1.expect(response).to.deep.equal({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
result: "bar said foo",
});
return [2 /*return*/];
}
});
}); });
});
});
mocha_1.describe("responding undefined", function () {
mocha_1.it("should response with null result", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
server.addMethod("ack", function () { return undefined; });
return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "ack",
})];
case 1:
response = _a.sent();
chai_1.expect(response).to.deep.equal({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
result: null,
});
return [2 /*return*/];
}
});
}); });
});
mocha_1.describe("throwing", function () {
mocha_1.it("should respond error", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
server.addMethod("throw", function () {
throw new Error("Test throwing");
});
return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "throw",
})];
case 1:
response = _a.sent();
chai_1.expect(response).to.deep.equal({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
error: {
code: 0,
message: "Test throwing",
},
});
return [2 /*return*/];
}
});
}); });
});
mocha_1.describe("rejecting", function () {
mocha_1.it("should respond error", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
server.addMethod("reject", function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
throw new Error("Test rejecting");
});
}); });
return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "reject",
})];
case 1:
response = _a.sent();
chai_1.expect(response).to.deep.equal({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
error: {
code: 0,
message: "Test rejecting",
},
});
return [2 /*return*/];
}
});
}); });
});
mocha_1.describe("with an onError option", function () {
var onErrorArgs = null;
mocha_1.beforeEach(function () {
onErrorArgs = null;
server = new _1.JSONRPCServer({
onError: function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
onErrorArgs = args;
},
});
});
mocha_1.it("should call the onError callback with the error", function () { return __awaiter(void 0, void 0, void 0, function () {
var error;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
error = new Error("Test rejecting");
server.addMethod("reject", function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
throw error;
});
}); });
return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "reject",
})];
case 1:
_a.sent();
chai_1.expect(onErrorArgs[0]).to.equal(error);
return [2 /*return*/];
}
});
}); });
});
mocha_1.describe("with a getErrorData option", function () {
mocha_1.beforeEach(function () {
server = new _1.JSONRPCServer({
getErrorData: function (error) { return ({ testErrorData: true }); },
});
});
mocha_1.it("should respond with the error and data if the handler throws synchronously", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
server.addMethod("throw", function () {
throw new Error("Test throwing");
});
return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "throw",
})];
case 1:
response = _a.sent();
chai_1.expect(response).to.deep.equal({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
error: {
code: 0,
message: "Test throwing",
data: { testErrorData: true },
},
});
return [2 /*return*/];
}
});
}); });
mocha_1.it("should respond with the error and data if the handler throws asnychronously", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
server.addMethod("reject", function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, Promise.resolve()];
case 1:
_a.sent(); // forces a nextTick()
throw new Error("Test rejecting");
}
});
}); });
return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "reject",
})];
case 1:
response = _a.sent();
chai_1.expect(response).to.deep.equal({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
error: {
code: 0,
message: "Test rejecting",
data: { testErrorData: true },
},
});
return [2 /*return*/];
}
});
}); });
});
mocha_1.describe("responding to a notification", function () {
mocha_1.it("should not respond", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
server.addMethod("foo", function () { return "foo"; });
return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
method: "foo",
})];
case 1:
response = _a.sent();
chai_1.expect(response).to.be.null;
return [2 /*return*/];
}
});
}); });
});
mocha_1.describe("error on a notification", function () {
mocha_1.it("should throw", function () { return __awaiter(void 0, void 0, void 0, function () {
var error_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
server.addMethod("foo", function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
throw new Error("foo");
});
}); });
_a.label = 1;
case 1:
_a.trys.push([1, 3, , 4]);
return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
method: "foo",
})];
case 2:
_a.sent();
return [3 /*break*/, 4];
case 3:
error_1 = _a.sent();
chai_1.expect(error_1.message).to.equal("foo");
return [3 /*break*/, 4];
case 4: return [2 /*return*/];
}
});
}); });
});
mocha_1.describe("responding with strange values", function () {
mocha_1.it("should respond with null", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
server.addMethod("foo", function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
return [2 /*return*/, null];
}); }); });
return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "foo",
})];
case 1:
response = _a.sent();
chai_1.expect(response).to.deep.equal({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
result: null,
});
return [2 /*return*/];
}
});
}); });
mocha_1.it("should respond with undefined", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
server.addMethod("foo", function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
return [2 /*return*/, undefined];
}); }); });
return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "foo",
})];
case 1:
response = _a.sent();
chai_1.expect(response).to.deep.equal({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
result: null,
});
return [2 /*return*/];
}
});
}); });
mocha_1.it("should respond with 0", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
server.addMethod("foo", function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
return [2 /*return*/, 0];
}); }); });
return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "foo",
})];
case 1:
response = _a.sent();
chai_1.expect(response).to.deep.equal({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
result: 0,
});
return [2 /*return*/];
}
});
}); });
});
mocha_1.describe("receiving a request to an unknown method", function () {
mocha_1.it("should respond error", function () { return __awaiter(void 0, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, server.process({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
method: "foo",
})];
case 1:
response = _a.sent();
chai_1.expect(response).to.deep.equal({
jsonrpc: _1.JSONRPCProtocol,
id: 0,
error: {
code: models_1.JSONRPCErrorCode.MethodNotFound,
message: "Method not found",
},
});
return [2 /*return*/];
}
});
}); });
});
mocha_1.describe("receiving an invalid request", function () {
mocha_1.it("should throw", function () { return __awaiter(void 0, void 0, void 0, function () {
var error_2;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, server.process({})];
case 1:
_a.sent();
return [3 /*break*/, 3];
case 2:
error_2 = _a.sent();
chai_1.expect(error_2.message).not.to.be.undefined;
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); });
});
});