fastify-sse/test/stream.js

Provide Server-Sent Events to Fastify

/* eslint-disable no-confusing-arrow */

"use strict";

const fastifySse = require("../index");

const fastifyModule = require("fastify");
const test = require("tap").test;
const request = require("request");
const PassThrough = require("stream").PassThrough;

test("reply.sse could send Readable stream in object mode", (t) => {
  t.plan(7);

  const fastify = fastifyModule();
  fastify.register(fastifySse).after( (err) => {
    t.error(err);
  });

  const data = {hello: "world"};

  fastify.get("/", (request, reply) => {
    const pass = new PassThrough({objectMode: true});
    reply.sse(pass);
    pass.write(data);
    pass.end();
  });

  fastify.listen(0, (err) => {
    t.error(err);

    request({
      method: "GET",
      uri: `http://localhost:${fastify.server.address().port}`
    }, (err, response, body) => {
      t.error(err);
      t.strictEqual(response.statusCode, 200);
      t.strictEqual(response.headers["content-type"], "text/event-stream");
      t.strictEqual(response.headers["content-encoding"], "identity");
      t.equal(body, `id: 1\r\ndata: ${JSON.stringify(data)}\r\n\r\nevent: end\r\ndata: \r\n\r\n`);
      t.end();
      fastify.close();
    });
  });
});

test("reply.sse could send Readable stream in byte mode", (t) => {
  t.plan(7);

  const fastify = fastifyModule();
  fastify.register(fastifySse).after( (err) => {
    t.error(err);
  });

  const data = "hello: world";

  fastify.get("/", (request, reply) => {
    const pass = new PassThrough({objectMode: false});
    reply.sse(pass);
    pass.write(data);
    pass.end();
  });

  fastify.listen(0, (err) => {
    t.error(err);

    request({
      method: "GET",
      uri: `http://localhost:${fastify.server.address().port}`
    }, (err, response, body) => {
      t.error(err);
      t.strictEqual(response.statusCode, 200);
      t.strictEqual(response.headers["content-type"], "text/event-stream");
      t.strictEqual(response.headers["content-encoding"], "identity");
      t.equal(body, `id: 1\r\ndata: ${data}\r\n\r\nevent: end\r\ndata: \r\n\r\n`);
      t.end();
      fastify.close();
    });
  });
});

test("reply.sse with streams can generate id", (t) => {
  t.plan(7);

  const fastify = fastifyModule();
  fastify.register(fastifySse).after( (err) => {
    t.error(err);
  });

  const data = {hello: "world", num: 4};

  fastify.get("/", (request, reply) => {
    const pass = new PassThrough({objectMode: true});
    reply.sse(pass, {idGenerator: (event) => event ? event.num * 5 : undefined});
    pass.write(data);
    pass.end();
  });

  fastify.listen(0, (err) => {
    t.error(err);

    request({
      method: "GET",
      uri: `http://localhost:${fastify.server.address().port}`
    }, (err, response, body) => {
      t.error(err);
      t.strictEqual(response.statusCode, 200);
      t.strictEqual(response.headers["content-type"], "text/event-stream");
      t.strictEqual(response.headers["content-encoding"], "identity");
      t.equal(body, `id: ${4 * 5}\r\ndata: ${JSON.stringify(data)}\r\n\r\nevent: end\r\ndata: \r\n\r\n`);
      t.end();
      fastify.close();
    });
  });
});

test("reply.sse with streams can ignore id", (t) => {
  t.plan(7);

  const fastify = fastifyModule();
  fastify.register(fastifySse).after( (err) => {
    t.error(err);
  });

  const data = {hello: "world", num: 4};

  fastify.get("/", (request, reply) => {
    const pass = new PassThrough({objectMode: true});
    reply.sse(pass, {idGenerator: null});
    pass.write(data);
    pass.end();
  });

  fastify.listen(0, (err) => {
    t.error(err);

    request({
      method: "GET",
      uri: `http://localhost:${fastify.server.address().port}`
    }, (err, response, body) => {
      t.error(err);
      t.strictEqual(response.statusCode, 200);
      t.strictEqual(response.headers["content-type"], "text/event-stream");
      t.strictEqual(response.headers["content-encoding"], "identity");
      t.equal(body, `data: ${JSON.stringify(data)}\r\n\r\nevent: end\r\ndata: \r\n\r\n`);
      t.end();
      fastify.close();
    });
  });
});

test("reply.sse with streams can specify static events", (t) => {
  t.plan(7);

  const fastify = fastifyModule();
  fastify.register(fastifySse).after( (err) => {
    t.error(err);
  });

  const data = {hello: "world", num: 4};

  fastify.get("/", (request, reply) => {
    const pass = new PassThrough({objectMode: true});
    reply.sse(pass, {event: "test"});
    pass.write(data);
    pass.end();
  });

  fastify.listen(0, (err) => {
    t.error(err);

    request({
      method: "GET",
      uri: `http://localhost:${fastify.server.address().port}`
    }, (err, response, body) => {
      t.error(err);
      t.strictEqual(response.statusCode, 200);
      t.strictEqual(response.headers["content-type"], "text/event-stream");
      t.strictEqual(response.headers["content-encoding"], "identity");
      t.equal(body, `id: 1\r\nevent: test\r\ndata: ${JSON.stringify(data)}\r\n\r\nevent: end\r\ndata: \r\n\r\n`);
      t.end();
      fastify.close();
    });
  });
});

test("reply.sse with streams can generate dynamic events", (t) => {
  t.plan(7);

  const fastify = fastifyModule();
  fastify.register(fastifySse).after( (err) => {
    t.error(err);
  });

  const data = {hello: "world", name: "test function"};

  fastify.get("/", (request, reply) => {
    const pass = new PassThrough({objectMode: true});
    reply.sse(pass, {event: (event) => event ? event.name : undefined});
    pass.write(data);
    pass.end();
  });

  fastify.listen(0, (err) => {
    t.error(err);

    request({
      method: "GET",
      uri: `http://localhost:${fastify.server.address().port}`
    }, (err, response, body) => {
      t.error(err);
      t.strictEqual(response.statusCode, 200);
      t.strictEqual(response.headers["content-type"], "text/event-stream");
      t.strictEqual(response.headers["content-encoding"], "identity");
      t.equal(body, `id: 1\r\nevent: test function\r\ndata: ${JSON.stringify(data)}\r\n\r\nevent: end\r\ndata: \r\n\r\n`);
      t.end();
      fastify.close();
    });
  });
});