moleculer/src/serializers/cbor.js

Fast & powerful microservices framework for Node.JS

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

"use strict";

const BaseSerializer = require("./base");
const _ = require("lodash");

/**
 * Import types
 *
 * @typedef {import("../service-broker")} ServiceBroker
 * @typedef {import("./cbor")} CborSerializerClass
 * @typedef {import("./cbor").CborSerializerOptions} CborSerializerOptions
 */

/**
 * CBOR serializer for Moleculer
 *
 * https://github.com/kriszyp/cbor-x
 *
 * @implements {CborSerializerClass}
 */
class CborSerializer extends BaseSerializer {
	/**
	 * Creates an instance of CborSerializer.
	 *
	 * Available options:
	 * 	https://github.com/kriszyp/cbor-x#options
	 *
	 * @param {CborSerializerOptions} opts
	 *
	 * @memberof Serializer
	 */
	constructor(opts) {
		super(opts);
		/** @type {CborSerializerOptions} */
		this.opts = _.defaultsDeep(opts, { useRecords: false, useTag259ForMaps: false });
	}

	/**
	 * Initialize Serializer
	 *
	 * @param {any} broker
	 *
	 * @memberof Serializer
	 */
	init(broker) {
		super.init(broker);

		try {
			const Cbor = require("cbor-x");
			this.encoder = new Cbor.Encoder(this.opts);
		} catch (err) {
			/* istanbul ignore next */
			this.broker.fatal(
				"The 'cbor-x' package is missing! Please install it with 'npm install cbor-x --save' command!",
				err,
				true
			);
		}
	}

	/**
	 * Serializer a JS object to Buffer
	 *
	 * @param {any} obj
	 * @returns {Buffer}
	 *
	 * @memberof Serializer
	 */
	serialize(obj) {
		const res = this.encoder.encode(obj);
		return res;
	}

	/**
	 * Deserialize Buffer to JS object
	 *
	 * @param {Buffer} buf
	 * @returns {any}
	 *
	 * @memberof Serializer
	 */
	deserialize(buf) {
		const res = this.encoder.decode(buf);
		return res;
	}
}

module.exports = CborSerializer;