SSE Simplified

A simplified implementation of Server-Sent Events (SSE) for JSON-RPC communication.

Overview

This repository contains a simplified version of Server-Sent Events (SSE) implementation that maintains core functionality while being easy to understand and use. It provides both client and server implementations for SSE communication using the JSON-RPC 2.0 message format.

Features

• Simplified SSE Client: Connects to an SSE endpoint and handles incoming messages.
• Simplified SSE Server: Establishes SSE connections and handles incoming POST requests.
• JSON-RPC 2.0 Message Format: All communication follows the JSON-RPC 2.0 specification.
• Example Implementation: Demonstrates how to run both the client and server.
• Test Suite: Comprehensive test suite for testing various aspects of the SSE implementation.

Installation

# Clone the repository
git clone https://github.com/petesiki/sse-simplified.git
cd sse-simplified

# Install dependencies
npm install

Getting Started

Project Setup

1. Clone the repository:

   git clone https://github.com/petesiki/sse-simplified.git
   cd sse-simplified

2. Install dependencies:

   npm install

3. Build the project:

   npm run build

Running the Example

The example demonstrates a simple client-server interaction using SSE:

1. Start the development server:

   npm run dev

2. The example will automatically start both the server and client components.

   • The server will be available at http://localhost:3000/sse
   • You should see the client-server communication logs in the console

Running Tests

The test suite covers various aspects of the SSE implementation:

# Run all tests
npm test

# Run only SSE-specific tests
npm run test:sse

API

Client

import { SseClient } from 'sse-simplified';

// Create a client
const client = new SseClient(new URL('http://localhost:3000/sse'));

// Set up event handlers
client.onmessage = (message) => {
  console.log('Received message:', message);
};

client.onerror = (error) => {
  console.error('Error:', error);
};

client.onclose = () => {
  console.log('Connection closed');
};

// Start the client
await client.start();

// Send a message
await client.send({
  jsonrpc: '2.0',
  id: 1,
  method: 'example.method',
  params: { data: 'Hello from client' }
});

// Close the connection
await client.close();

Server

import http from 'node:http';
import { URL } from 'node:url';
import { SseServer } from 'sse-simplified';

// Create a server
const server = http.createServer((req, res) => {
  const url = new URL(req.url || '/', `http://${req.headers.host}`);
  const sessionId = url.searchParams.get('sessionId');
  
  // Handle SSE connection request
  if (req.method === 'GET' && url.pathname === '/sse') {
    const sseServer = new SseServer('/message', res);
    
    sseServer.onmessage = async (message) => {
      console.log('Received message:', message);
      
      // Send a response
      await sseServer.send({
        jsonrpc: '2.0',
        id: message.id,
        result: { data: 'Hello from server' }
      });
    };
    
    sseServer.start();
  }
  
  // Handle message POST requests
  if (req.method === 'POST' && url.pathname === '/message' && sessionId) {
    // Handle the message
    sseServer.handlePostMessage(req, res);
  }
});

server.listen(3000);

License

MIT