@stoplight/moleculer/src/serializers/protobuf.js

Fast & powerful microservices framework for Node.JS

/*
 * moleculer
 * Copyright (c) 2018 MoleculerJS (https://github.com/moleculerjs/moleculer)
 * MIT Licensed
 */

"use strict";

const BaseSerializer = require("./base");
const P = require("../packets");
const { MoleculerServerError } = require("../errors");

/**
 * Protocol Buffer Serializer for Moleculer
 *
 * https://github.com/google/protobuf
 *
 * @class ProtoBufSerializer
 */
class ProtoBufSerializer extends BaseSerializer {
	/**
	 * Initialize Serializer
	 *
	 * @param {any} broker
	 *
	 * @memberof Serializer
	 */
	init(broker) {
		super.init(broker);

		try {
			require("protobufjs/minimal");
		} catch (err) {
			/* istanbul ignore next */
			this.broker.fatal(
				"The 'protobufjs' package is missing! Please install it with 'npm install protobufjs --save' command!",
				err,
				true
			);
		}

		this.packets = require("./proto/packets.proto.js").packets;
	}

	getPacketFromType(type) {
		switch (type) {
			case P.PACKET_EVENT:
				return this.packets.PacketEvent;
			case P.PACKET_REQUEST:
				return this.packets.PacketRequest;
			case P.PACKET_RESPONSE:
				return this.packets.PacketResponse;
			case P.PACKET_DISCOVER:
				return this.packets.PacketDiscover;
			case P.PACKET_INFO:
				return this.packets.PacketInfo;
			case P.PACKET_DISCONNECT:
				return this.packets.PacketDisconnect;
			case P.PACKET_HEARTBEAT:
				return this.packets.PacketHeartbeat;
			case P.PACKET_PING:
				return this.packets.PacketPing;
			case P.PACKET_PONG:
				return this.packets.PacketPong;
			case P.PACKET_GOSSIP_HELLO:
				return this.packets.PacketGossipHello;
			case P.PACKET_GOSSIP_REQ:
				return this.packets.PacketGossipRequest;
			case P.PACKET_GOSSIP_RES:
				return this.packets.PacketGossipResponse;
		}
	}

	/**
	 * Serializer a JS object to Buffer
	 *
	 * @param {Object} obj
	 * @param {String} type of packet
	 * @returns {Buffer}
	 *
	 * @memberof Serializer
	 */
	serialize(obj, type) {
		const p = this.getPacketFromType(type);
		if (!p) {
			/* istanbul ignore next */
			throw new MoleculerServerError("Invalid packet type!", 500, "INVALID_PACKET_TYPE");
		}

		this.serializeCustomFields(type, obj);

		const buf = p.encode(obj).finish();
		return buf;
	}

	/**
	 * Deserialize Buffer to JS object
	 *
	 * @param {Buffer} buf
	 * @param {String} type of packet
	 * @returns {Object}
	 *
	 * @memberof Serializer
	 */
	deserialize(buf, type) {
		const p = this.getPacketFromType(type);
		if (!p) {
			/* istanbul ignore next */
			throw new MoleculerServerError("Invalid packet type!", 500, "INVALID_PACKET_TYPE");
		}

		const obj = p.decode(buf);

		this.deserializeCustomFields(type, obj);

		return obj;
	}
}

module.exports = ProtoBufSerializer;