Extensor

Extend functions to the socket.io.

Currently implemented:

• Handler authentication;
• Grant unique connections;
• Made easy the serialization with schemapack.

Next:

• Serialization in acknowledge

PR's are welcome.

Contents

• Install
• API
• Benchmarks

Install

npm install extensor

Examples

Binary serialization with schemapack

import { parsers } from "extensor";

// create a schema map
const { parser, schemas } = parsers.schemapack({
  message: {
    // Convert the event name to int
    // it's a method to minimize the packet size
    id: 1,
    schema: {
      content: "string",
      ts: "varuint"
    }
  }
});

// On both, server and client
// initialize socketio with the extensor generated parser
const io = SocketIO({
  parser
});

// You can encode an object, if you need, like this:
const binary = schemas.message.encode({
  content: "hi",
  ts: Math.round(Date.now() / 1000)
});
console.log(schemas.message.decode(binary)); // => { content: "hi": ts: 159798894154 }

• All emitted "message" events are binary, according with the schema;
• Here we not use 2 packets like in socket.io-parser binary event.
• For the events that not in list, JSON parser is used.

Schemapack are the smallest JavaScript object serialization library.

All supported types and more info, you find at schemapack

Authentication

Server

import SocketIO from "socket.io";
import { auth } from "extensor";

const io = SocketIO();

auth.server(io, ({ socket, data }) => {
  if (data.token === 1) return { userId: 123 };

  return false;
});

io.on("connection", async socket => {
  await socket.auth;

  socket.on("msg", msg => console.log(msg));
});

Client

import SocketIOClient from "socket.io-client";
import { auth } from "extensor".

const socket = SocketIOClient();

socket.on("connect", () => {
  await auth.client(socket, { token: 1 });

  console.log(socket.userId); // => 123
});

   

Blocking multiple connections

To use in a cluster, you need an external storage, current have adapters for redis and ioredis modules.

Server

import { unique, adapters } from "extensor";

...

unique(io, {
  storage: adapters.IORedis(new Redis()) // default is stored in a simple local object
});

To catch a multiple attemp on client:

socket.on("error", err => {
  if (err === "multiple attemp") {
    alert("you already connected");
  }
});

 

API

parsers.schemapack( map: Object ): { parser: { Encoder, Decoder }, schemas, idmap }

Create a schemapack parser for both Socket.io server and client.

auth.server( io: SocketIO.Server, handler({ socket, data, done })[, options: Extensor.Options ]): void

Create a server middleware to handle authentication

auth.client( io: SocketIOClient.Socket, data[, callback(error?: string)]): Promise | void

Send credential to server

unique( io: SocketIO.Server [, options: ExtensorOptions ] )

Create a step on the server to force a single connection

License

MIT