test packets

benchmark/perf-runner.js

@@ -5,7 +5,7 @@ const v8 = require('v8-natives');
 let ServiceBroker = require("../src/service-broker");
 let Context = require("../src/context");
 let Transporters = require("../src/transporters");
-let Serializer = require("../src/serializers/msgpack");
+let Serializer = require("../src/serializers/json");
 
 let { generateToken, json2String } = require("../src/utils");
 let Promise	= require("bluebird");

src/packets.js

@@ -93,7 +93,7 @@ class Packet {
 		const packetClass = getPacketClassByType(type);
 
 		const packet = new packetClass(transit);
-		packet.deserializePayload(payload);
+		packet.transformPayload(payload);
 
 		return packet;
 	}
@@ -105,7 +105,7 @@ class Packet {
 	 * 
 	 * @memberOf Packet
 	 */
-	deserializePayload(payload) {
+	transformPayload(payload) {
 		this.payload = payload;
 	}
 } 
@@ -146,8 +146,8 @@ class PacketDiscover extends Packet {
 		this.payload.actions = JSON.stringify(actions);
 	}
 
-	deserializePayload(payload) {
-		super.deserializePayload(payload);
+	transformPayload(payload) {
+		super.transformPayload(payload);
 		payload.actions = JSON.parse(payload.actions);
 	}
 }
@@ -164,8 +164,8 @@ class PacketInfo extends Packet {
 		this.payload.actions = JSON.stringify(actions);
 	}
 
-	deserializePayload(payload) {
-		super.deserializePayload(payload);
+	transformPayload(payload) {
+		super.transformPayload(payload);
 		payload.actions = JSON.parse(payload.actions);
 	}
 }
@@ -184,8 +184,8 @@ class PacketEvent extends Packet {
 		this.payload.data = JSON.stringify(data);
 	}
 
-	deserializePayload(payload) {
-		super.deserializePayload(payload);
+	transformPayload(payload) {
+		super.transformPayload(payload);
 		payload.data = JSON.parse(payload.data);
 	}	
 }
@@ -205,8 +205,8 @@ class PacketRequest extends Packet {
 		this.payload.params = JSON.stringify(params);
 	}
 
-	deserializePayload(payload) {
-		super.deserializePayload(payload);
+	transformPayload(payload) {
+		super.transformPayload(payload);
 		payload.params = JSON.parse(payload.params);
 	}	
 }
@@ -235,8 +235,8 @@ class PacketResponse extends Packet {
 		}
 	}
 
-	deserializePayload(payload) {
-		super.deserializePayload(payload);
+	transformPayload(payload) {
+		super.transformPayload(payload);
 		payload.data = JSON.parse(payload.data);
 		if (payload.error && payload.error.data)
 			payload.error.data = JSON.parse(payload.error.data);

test/unit/packets.spec.js

@@ -0,0 +1,201 @@
+const ServiceBroker = require("../../src/service-broker");
+const Transit = require("../../src/transit");
+const FakeTransporter = require("../../src/transporters/fake");
+const { ValidationError } = require("../../src/errors");
+
+const P = require("../../src/packets");
+
+describe("Test base Packet", () => {
+
+	const transit = {
+		nodeID: "node-1",
+		serialize: jest.fn(),
+		deserialize: jest.fn(msg => JSON.parse(msg))
+	};
+
+	it("create Packet without type", () => {
+		let packet = new P.Packet(transit);
+		expect(packet).toBeDefined();
+		expect(packet.transit).toBe(transit);
+		expect(packet.type).toBe(P.PACKET_UNKNOW);
+		expect(packet.target).toBeUndefined();
+		expect(packet.payload).toBeDefined();
+		expect(packet.payload.sender).toBe("node-1");
+	});
+
+	it("create Packet with type & target", () => {
+		let packet = new P.Packet(transit, P.PACKET_EVENT, "node-2");
+		expect(packet).toBeDefined();
+		expect(packet.transit).toBe(transit);
+		expect(packet.type).toBe(P.PACKET_EVENT);
+		expect(packet.target).toBe("node-2");
+		expect(packet.payload).toBeDefined();
+		expect(packet.payload.sender).toBe("node-1");
+	});
+
+	it("should call transit.serialize", () => {
+		transit.serialize.mockClear();
+
+		let packet = new P.Packet(transit, P.PACKET_EVENT, "node-2");
+		packet.serialize();
+		expect(transit.serialize).toHaveBeenCalledTimes(1);
+		expect(transit.serialize).toHaveBeenCalledWith(packet.payload, P.PACKET_EVENT);
+	});
+
+	it("should set payload", () => {
+		let packet = new P.Packet(transit, P.PACKET_EVENT, "node-2");
+		let obj = { a: 5 };
+		packet.transformPayload(obj);
+		expect(packet.payload).toBe(obj);
+	});
+
+	it("should return a Packet instance", () => {
+		transit.deserialize.mockClear();
+
+		let packet = P.Packet.deserialize(transit, P.PACKET_HEARTBEAT, '{"a": 5}');
+		expect(packet).toBeInstanceOf(P.PacketHeartbeat);
+		expect(packet.payload).toEqual({ a: 5 });
+		expect(transit.deserialize).toHaveBeenCalledTimes(1);
+		expect(transit.deserialize).toHaveBeenCalledWith('{"a": 5}', P.PACKET_HEARTBEAT);
+	});
+
+});
+
+describe("Test PacketDisconnect", () => {
+
+	const transit = { nodeID: "node-1" };
+
+	it("should set properties", () => {
+		let packet = new P.PacketDisconnect(transit);
+		expect(packet).toBeDefined();
+		expect(packet.type).toBe(P.PACKET_DISCONNECT);
+		expect(packet.target).toBeUndefined();
+		expect(packet.payload).toBeDefined();
+		expect(packet.payload.sender).toBe("node-1");
+	});
+
+});
+
+describe("Test PacketHeartbeat", () => {
+
+	const transit = { nodeID: "node-1" };
+
+	it("should set properties", () => {
+		let packet = new P.PacketHeartbeat(transit);
+		expect(packet).toBeDefined();
+		expect(packet.type).toBe(P.PACKET_HEARTBEAT);
+		expect(packet.target).toBeUndefined();
+		expect(packet.payload).toBeDefined();
+		expect(packet.payload.sender).toBe("node-1");
+	});
+
+});
+
+describe("Test PacketDiscover", () => {
+
+	const transit = { nodeID: "node-1" };
+
+	it("should set properties", () => {
+		let actions = { "posts.find": {} };
+		let packet = new P.PacketDiscover(transit, actions);
+		expect(packet).toBeDefined();
+		expect(packet.type).toBe(P.PACKET_DISCOVER);
+		expect(packet.target).toBeUndefined();
+		expect(packet.payload).toBeDefined();
+		expect(packet.payload.sender).toBe("node-1");
+		expect(packet.payload.actions).toBe("{\"posts.find\":{}}");
+	});
+
+});
+
+describe("Test PacketInfo", () => {
+
+	const transit = { nodeID: "node-1" };
+
+	it("should set properties", () => {
+		let actions = { "posts.find": {} };
+		let packet = new P.PacketInfo(transit, "node-2", actions);
+		expect(packet).toBeDefined();
+		expect(packet.type).toBe(P.PACKET_INFO);
+		expect(packet.target).toBe("node-2");
+		expect(packet.payload).toBeDefined();
+		expect(packet.payload.sender).toBe("node-1");
+		expect(packet.payload.actions).toBe("{\"posts.find\":{}}");
+	});
+
+});
+
+describe("Test PacketEvent", () => {
+
+	const transit = { nodeID: "node-1" };
+
+	it("should set properties", () => {
+		let data = { id: 5 };
+		let packet = new P.PacketEvent(transit, "user.created", data);
+		expect(packet).toBeDefined();
+		expect(packet.type).toBe(P.PACKET_EVENT);
+		expect(packet.target).toBeUndefined();
+		expect(packet.payload).toBeDefined();
+		expect(packet.payload.sender).toBe("node-1");
+		expect(packet.payload.event).toBe("user.created");
+		expect(packet.payload.data).toBe("{\"id\":5}");
+	});
+
+});
+
+describe("Test PacketRequest", () => {
+
+	const transit = { nodeID: "node-1" };
+
+	it("should set properties", () => {
+		let params = { id: 5 };
+		let packet = new P.PacketRequest(transit, "server-2", "12345", "posts.find", params);
+		expect(packet).toBeDefined();
+		expect(packet.type).toBe(P.PACKET_REQUEST);
+		expect(packet.target).toBe("server-2");
+		expect(packet.payload).toBeDefined();
+		expect(packet.payload.sender).toBe("node-1");
+		expect(packet.payload.requestID).toBe("12345");
+		expect(packet.payload.action).toBe("posts.find");
+		expect(packet.payload.params).toBe("{\"id\":5}");
+	});
+
+});
+
+describe("Test PacketResponse", () => {
+
+	const transit = { nodeID: "node-1" };
+
+	it("should set properties without error", () => {
+		let data = { id: 5 };
+		let packet = new P.PacketResponse(transit, "server-2", "12345", data);
+		expect(packet).toBeDefined();
+		expect(packet.type).toBe(P.PACKET_RESPONSE);
+		expect(packet.target).toBe("server-2");
+		expect(packet.payload).toBeDefined();
+		expect(packet.payload.sender).toBe("node-1");
+		expect(packet.payload.requestID).toBe("12345");
+		expect(packet.payload.success).toBe(true);
+		expect(packet.payload.data).toBe("{\"id\":5}");
+		expect(packet.payload.error).toBeUndefined();
+	});
+
+	it("should set properties with error", () => {
+		let err = new ValidationError("Validation error", { a: 5 });
+		let packet = new P.PacketResponse(transit, "server-2", "12345", null, err);
+		expect(packet).toBeDefined();
+		expect(packet.type).toBe(P.PACKET_RESPONSE);
+		expect(packet.target).toBe("server-2");
+		expect(packet.payload).toBeDefined();
+		expect(packet.payload.sender).toBe("node-1");
+		expect(packet.payload.requestID).toBe("12345");
+		expect(packet.payload.success).toBe(false);
+		//expect(packet.payload.data).toBeNull();
+		expect(packet.payload.error).toBeDefined();
+		expect(packet.payload.error.name).toBe("ValidationError");
+		expect(packet.payload.error.message).toBe("Validation error");
+		expect(packet.payload.error.code).toBe(422);
+		expect(packet.payload.error.data).toBe("{\"a\":5}");
+	});
+
+});