Pre-release v0.4-async

PyServe pre-v0.4-async Release Notes

Overview

This pre-release version introduces WebSocket support and extended protocol features to PyServe. The implementation includes native WebSocket support, proxying capabilities, and improved protocol handling.

New Features

WebSocket Support

• Native WebSocket protocol implementation (RFC 6455)
• Bidirectional communication support
• Frame-level WebSocket protocol handling
• Automatic protocol upgrade negotiation
• Support for text and binary messages
• Ping/Pong frame handling for connection health monitoring

WebSocket Proxying

• Transparent WebSocket connection proxying
• SSL/TLS support for secure WebSocket connections (WSS)
• Configurable proxy rules for WebSocket endpoints
• Automatic protocol detection and handling
• Connection pooling and management

Configuration Enhancements

• Unified proxy configuration for HTTP and WebSocket
• WebSocket-specific settings in config.yaml
• SSL/TLS configuration for both frontend and backend connections
• Path-based routing for WebSocket endpoints

Configuration Example

server:
  reverse_proxy:
    - host: localhost
      path: /ws
      port: 8080
      websocket: true    # Enable WebSocket support
      ssl: false         # Backend SSL/TLS
      
    - host: example.com
      path: /socket.io
      port: 443
      websocket: true
      ssl: true          # Use SSL for backend connection

Breaking Changes

• Proxy configuration structure has been updated to support WebSocket
• SSL configuration now requires explicit settings for WebSocket connections

Upcoming Features

• HTTP/2 support
• Server-Sent Events (SSE)
• Compression support (gzip, deflate, brotli)
• Enhanced MIME type handling
• Streaming response improvements

Documentation

Comprehensive documentation for WebSocket features is available in the /static/pages/reverse-proxy.html page.