All files Message.spec.ts

100% Statements 105/105
100% Branches 0/0
100% Functions 46/46
100% Lines 98/98

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 2741x 1x 1x                           1x 1x 1x 1x   1x     1x 1x   1x     1x 1x         1x       1x 1x 1x   1x     1x 1x         1x     1x 1x   1x         1x 1x 1x 1x 1x             1x 1x 1x                 1x 1x 1x 1x     1x 1x 1x     1x 1x 1x     1x 1x 1x         1x 1x 1x 1x               1x                         1x 1x   1x                       1x 1x 1x 1x   1x                 1x 1x 1x   1x               1x 1x   1x             1x 1x   1x             1x 1x   1x             1x 1x   1x                   1x 1x   1x                     1x 1x   1x     1x 1x   1x     1x 1x   1x     1x 1x   1x     1x 1x   1x     1x 1x   1x     1x 1x   1x      
import { describe, it } from 'mocha';
import { expect } from 'chai';
import {
    RPCMessage,
    RPCError,
    RPCRequest,
    RPCResponse,
    RPCResponseError,
    RPCResponseResult,
    JSONParseError,
    InvalidMessageError,
    InvalidRequestError,
    InvalidResponseError,
    ParseRPCMessage
} from './Message';
 
describe('RPCMessage', () => {
    describe('isRequest', () => {
        it('Should return true when constructed as RPCRequest', () => {
            let msg = new RPCRequest(69, "test");
 
            expect(msg.isRequest()).to.equal(true);
        });
 
        it('Should return false when constructed as RPCResponseResult', () => {
            let msg = new RPCResponseResult(69, "test");
 
            expect(msg.isRequest()).to.equal(false);
        });
 
        it('Should return false when constructed as RPCResponseError', () => {
            let msg = new RPCResponseResult(69, {
                code: 123,
                message: "testing"
            });
 
            expect(msg.isRequest()).to.equal(false);
        });
    });
 
    describe('isResponse', () => {
        it('Should return true when constructed as RPCResponseResult', () => {
            let msg = new RPCResponseResult(69, "test");
 
            expect(msg.isResponse()).to.equal(true);
        });
 
        it('Should return true when constructed as RPCResponseError', () => {
            let msg = new RPCResponseResult(69, {
                code: 123,
                message: "testing"
            });
 
            expect(msg.isResponse()).to.equal(true);
        });
 
        it('Should return false when constructed as RPCRequest', () => {
            let msg = new RPCRequest(69, "test");
 
            expect(msg.isResponse()).to.equal(false);
        });
    });
});
 
describe('RPCRequest', () => {
    describe('construct', () => {
        it('Should return a valid object when constructed without params', () => {
            let req = new RPCRequest(69, "test");
            expect(req).to.deep.equal({
                jsonrpc: "2.0",
                method: "test",
                id: 69
            });
        });
    
        it('Should return a valid object when constructed with params', () => {
            let req = new RPCRequest(69, "test", [1, 2, 3]);
            expect(req).to.deep.equal({
                jsonrpc: "2.0",
                method: "test",
                params: [1, 2, 3],
                id: 69
            });
        });
    });
 
    describe('isNotification', () => {
        it('Should return true when id is not provided', () => {
            let req = new RPCRequest(undefined, "test");
            expect(req.isNotification()).to.equal(true);
        });
    
        it('Should return true when id is null', () => {
            let req = new RPCRequest(null, "test");
            expect(req.isNotification()).to.equal(true);
        });
    
        it('Should return false when id is number', () => {
            let req = new RPCRequest(10, "test");
            expect(req.isNotification()).to.equal(false);
        });
 
        it('Should return false when id is string', () => {
            let req = new RPCRequest("test", "test");
            expect(req.isNotification()).to.equal(false);
        });
    });
});
 
describe('RPCResponseError', () => {
    describe('construct', () => {
        it('Should return a valid rpc response error object error when constructed', () => {
            let res = new RPCResponseError(69, {
                code: 123,
                message: "testing",
                data: {
                    test: true
                }
            });
    
            expect(res).to.deep.equal({
                jsonrpc: "2.0",
                id: 69,
                error: {
                    code: 123,
                    message: "testing",
                    data: {
                        test: true
                    }
                }
            });
        });
 
        it('Should initialise default values when constructed without params', () => {
            let res = new RPCResponseError(69, new RPCError());
    
            expect(res).to.deep.equal({
                jsonrpc: "2.0",
                id: 69,
                error: {
                    code: 0,
                    message: "",
                }
            });
        });
    });
});
 
describe('RPCResponseResult', () => {
    describe('construct', () => {
        it('Should return a valid rpc response result object when constructed', () => {
            let res = new RPCResponseResult(69, true);
 
            expect(res).to.deep.equal({
                jsonrpc: "2.0",
                id: 69,
                result: true
            });
        });
    });
});
 
describe('ParseRPCMessage', () => {
    it('Should return a RPCRequest when provided with a valid JSON RPC request object', () => {
        let request = '{"jsonrpc": "2.0", "method": "test", "params": [1, 2, 3], "id": 123}';
 
        expect(ParseRPCMessage(request)).to.deep.equal({
            jsonrpc: "2.0",
            method: "test",
            params: [1, 2, 3],
            id: 123
        });
    });
 
    it('Should return a RPCResponseResult when provided with a valid JSON RPC response result object', () => {
        let request = '{"jsonrpc": "2.0", "result": "success", "id": 69}';
 
        expect(ParseRPCMessage(request)).to.deep.equal({
            jsonrpc: "2.0",
            result: "success",
            id: 69
        });
    });
 
    it('Should return a RPCResponseResult when result is false', () => {
        let request = '{"jsonrpc": "2.0", "result": false, "id": 69}';
 
        expect(ParseRPCMessage(request)).to.deep.equal({
            jsonrpc: "2.0",
            result: false,
            id: 69
        });
    });
 
    it('Should return a RPCResponseResult when result is empty string', () => {
        let request = '{"jsonrpc": "2.0", "result": "", "id": 69}';
 
        expect(ParseRPCMessage(request)).to.deep.equal({
            jsonrpc: "2.0",
            result: "",
            id: 69
        });
    });
 
    it('Should return a RPCResponseError when provided with a valid JSON RPC response error object', () => {
        let request = '{"jsonrpc": "2.0", "error": {"code": -32700, "message": "Parse error"}, "id": 69}';
 
        expect(ParseRPCMessage(request)).to.deep.equal({
            jsonrpc: "2.0",
            error: {
                code: -32700,
                message: "Parse error"
            },
            id: 69
        });
    });
 
    it('Should return a RPCResponseError when provided with a valid JSON RPC response error object with data', () => {
        let request = '{"jsonrpc": "2.0", "error": {"code": -32700, "message": "Parse error", "data": "troll"}, "id": 69}';
 
        expect(ParseRPCMessage(request)).to.deep.equal({
            jsonrpc: "2.0",
            error: {
                code: -32700,
                message: "Parse error",
                data: "troll"
            },
            id: 69
        });
    });
 
    it('Should throw JSONParseError when invalid json is provided', () => {
        let request = '{"jsonrpc": "2.0"invalid, "method": "test", "params": [1, 2, 3], "id": 123}';
 
        expect(() => ParseRPCMessage(request)).to.throw(JSONParseError);
    });
 
    it('Should throw InvalidMessageError when jsonrpc field is wrong', () => {
        let request = '{"jsonrpc": "2.5", "result": "success", "id": 69}';
 
        expect(() => ParseRPCMessage(request)).to.throw(InvalidMessageError, 'wrong json rpc version');
    });
 
    it('Should throw InvalidMessageError when json object is of invalid JSON RPC type', () => {
        let request = '{"jsonrpc": "2.0", "id": 69}';
 
        expect(() => ParseRPCMessage(request)).to.throw(InvalidMessageError, 'unknown message type');
    });
 
    it('Should throw InvalidRequestError when method field is not string', () => {
        let request = '{"jsonrpc": "2.0", "method": 15, "id": 123}';
 
        expect(() => ParseRPCMessage(request)).to.throw(InvalidRequestError, 'method is not a string');
    });
 
    it('Should throw InvalidResponseError when id field is missing', () => {
        let request = '{"jsonrpc": "2.0", "result": "15"}';
 
        expect(() => ParseRPCMessage(request)).to.throw(InvalidResponseError, 'id not found');
    });
 
    it('Should throw InvalidResponseError when error code field is not a number', () => {
        let request = '{"jsonrpc": "2.0", "error": {"code": "test", "message": "msg"}}';
 
        expect(() => ParseRPCMessage(request)).to.throw(InvalidResponseError, 'error code is not a number');
    });
 
    it('Should throw InvalidResponseError when error message field is not string', () => {
        let request = '{"jsonrpc": "2.0", "error": {"code": 20, "message": 15}}';
 
        expect(() => ParseRPCMessage(request)).to.throw(InvalidResponseError, 'error message is not a string');
    });
});