XStatic: High-Performance Delegation

Overview

In traditional Node.js web frameworks, serving static files involves reading data from the disk into memory buffers, processing them through the JavaScript event loop, and writing them to the network socket. This approach introduces critical bottlenecks:

XStatic solves these issues by implementing a Zero-Copy IPC Delegation architecture. Instead of serving files through Node.js, XyPriss validates the request in TypeScript and then "delegates" the actual data transfer to the native XHSC (Go) engine.

Basic Usage

To enable XStatic, instantiate the component and define your routes:

import { XStatic, createServer } from "xypriss";

const app = createServer();
const xs = new XStatic(app, __sys__);

// Define a static route (URI path -> physical directory)
xs.define("/static", "public");

app.start();

Configuration Examples

xs.define("/assets", "./public", {
    allowOutsideRoot: false, // Default security boundary
    maxAge: "1d"             // Caching for 24 hours
});

xs.define("/global", "/mnt/shared/images", {
    allowOutsideRoot: true,
    maxAge: 3600 // 1 hour
});

Global Configuration

Settings in createServer define the default security and performance policy for all static instances.

static: { lruCacheSize: 10000 }

static: {
    dotfiles: {
        mode: "deny",
        custom: ["config.json", "private.key"] // Block specific sensitive files
    }
}

static: { zeroCopy: true }

Performance Benchmarks