routup 3.2.0 → 3.3.0

package/dist/constants.d.ts

@@ -20,6 +20,7 @@ export declare enum HeaderName {
     CONTENT_LENGTH = "content-length",
     CONTENT_RANGE = "content-range",
     CONTENT_TYPE = "content-type",
+    CONNECTION = "connection",
     COOKIE = "cookie",
     ETag = "etag",
     HOST = "host",
@@ -34,6 +35,7 @@ export declare enum HeaderName {
     RETRY_AFTER = "retry-after",
     SET_COOKIE = "set-cookie",
     TRANSFER_ENCODING = "transfer-encoding",
+    X_ACCEL_BUFFERING = "x-accel-buffering",
     X_FORWARDED_HOST = "x-forwarded-host",
     X_FORWARDED_FOR = "x-forwarded-for",
     X_FORWARDED_PROTO = "x-forwarded-proto"

package/dist/index.cjs

@@ -34,6 +34,7 @@ exports.HeaderName = void 0;
     HeaderName["CONTENT_LENGTH"] = "content-length";
     HeaderName["CONTENT_RANGE"] = "content-range";
     HeaderName["CONTENT_TYPE"] = "content-type";
+    HeaderName["CONNECTION"] = "connection";
     HeaderName["COOKIE"] = "cookie";
     HeaderName["ETag"] = "etag";
     HeaderName["HOST"] = "host";
@@ -48,6 +49,7 @@ exports.HeaderName = void 0;
     HeaderName["RETRY_AFTER"] = "retry-after";
     HeaderName["SET_COOKIE"] = "set-cookie";
     HeaderName["TRANSFER_ENCODING"] = "transfer-encoding";
+    HeaderName["X_ACCEL_BUFFERING"] = "x-accel-buffering";
     HeaderName["X_FORWARDED_HOST"] = "x-forwarded-host";
     HeaderName["X_FORWARDED_FOR"] = "x-forwarded-for";
     HeaderName["X_FORWARDED_PROTO"] = "x-forwarded-proto";
@@ -546,6 +548,10 @@ function getRequestHostName(req, options) {
     return index !== -1 ? hostname.substring(0, index) : hostname;
 }
 
+function isRequestHTTP2(req) {
+    return typeof getRequestHeader(req, ':path') !== 'undefined' && typeof getRequestHeader(req, ':method') !== 'undefined';
+}
+
 function getRequestIP(req, options) {
     options = options || {};
     let trustProxy;
@@ -761,6 +767,96 @@ function isResponseGone(res) {
     }
     return false;
 }
+function setResponseGone(res, value) {
+    res[GoneSymbol] = value;
+}
+
+function serializeEventStreamMessage(message) {
+    let result = '';
+    if (message.id) {
+        result += `id: ${message.id}\n`;
+    }
+    if (message.event) {
+        result += `event: ${message.event}\n`;
+    }
+    if (typeof message.retry === 'number' && Number.isInteger(message.retry)) {
+        result += `retry: ${message.retry}\n`;
+    }
+    result += `data: ${message.data}\n\n`;
+    return result;
+}
+
+class EventStream {
+    open() {
+        this.response.req.on('close', ()=>this.end());
+        this.response.req.on('error', (err)=>{
+            this.emit('error', err);
+            this.end();
+        });
+        this.passThrough.on('data', (chunk)=>this.response.write(chunk));
+        this.passThrough.on('error', (err)=>{
+            this.emit('error', err);
+            this.end();
+        });
+        this.passThrough.on('close', ()=>this.end());
+        this.response.setHeader(exports.HeaderName.CONTENT_TYPE, 'text/event-stream');
+        this.response.setHeader(exports.HeaderName.CACHE_CONTROL, 'private, no-cache, no-store, no-transform, must-revalidate, max-age=0');
+        this.response.setHeader(exports.HeaderName.X_ACCEL_BUFFERING, 'no');
+        if (!isRequestHTTP2(this.response.req)) {
+            this.response.setHeader(exports.HeaderName.CONNECTION, 'keep-alive');
+        }
+        this.response.statusCode = 200;
+    }
+    write(message) {
+        if (typeof message === 'string') {
+            this.write({
+                data: message
+            });
+            return;
+        }
+        if (!this.passThrough.closed && this.passThrough.writable) {
+            this.passThrough.write(serializeEventStreamMessage(message));
+        }
+    }
+    end() {
+        if (this.flushed) return;
+        this.flushed = true;
+        if (!this.passThrough.closed) {
+            this.passThrough.end();
+        }
+        this.emit('close');
+        setResponseGone(this.response, true);
+        this.response.end();
+    }
+    on(event, listener) {
+        if (typeof this.eventHandlers[event] === 'undefined') {
+            this.eventHandlers[event] = [];
+        }
+        this.eventHandlers[event].push(listener);
+    }
+    emit(event, ...args) {
+        if (typeof this.eventHandlers[event] === 'undefined') {
+            return;
+        }
+        const listeners = this.eventHandlers[event].slice();
+        for(let i = 0; i < listeners.length; i++){
+            listeners[i].apply(this, args);
+        }
+    }
+    constructor(response){
+        this.response = response;
+        this.passThrough = new readableStream.PassThrough({
+            encoding: 'utf-8'
+        });
+        this.flushed = false;
+        this.eventHandlers = {};
+        this.open();
+    }
+}
+
+function createEventStream(response) {
+    return new EventStream(response);
+}
 
 function appendResponseHeader(res, name, value) {
     let header = res.getHeader(name);
@@ -2141,6 +2237,7 @@ class Router {
 
 exports.DispatchErrorEvent = DispatchErrorEvent;
 exports.DispatchEvent = DispatchEvent;
+exports.EventStream = EventStream;
 exports.Handler = Handler;
 exports.HandlerSymbol = HandlerSymbol;
 exports.PathMatcher = PathMatcher;
@@ -2150,6 +2247,7 @@ exports.appendResponseHeader = appendResponseHeader;
 exports.appendResponseHeaderDirective = appendResponseHeaderDirective;
 exports.coreHandler = coreHandler;
 exports.createError = createError;
+exports.createEventStream = createEventStream;
 exports.createNodeDispatcher = createNodeDispatcher;
 exports.createRawDispatcher = createRawDispatcher;
 exports.createRequest = createRequest;
@@ -2179,6 +2277,7 @@ exports.isHandlerConfig = isHandlerConfig;
 exports.isPath = isPath;
 exports.isPlugin = isPlugin;
 exports.isRequestCacheable = isRequestCacheable;
+exports.isRequestHTTP2 = isRequestHTTP2;
 exports.isResponseGone = isResponseGone;
 exports.matchRequestContentType = matchRequestContentType;
 exports.send = send;
@@ -2198,6 +2297,7 @@ exports.setRequestParams = setRequestParams;
 exports.setRequestRouterPath = setRequestRouterPath;
 exports.setResponseCacheHeaders = setResponseCacheHeaders;
 exports.setResponseContentTypeByFileName = setResponseContentTypeByFileName;
+exports.setResponseGone = setResponseGone;
 exports.setResponseHeaderAttachment = setResponseHeaderAttachment;
 exports.setResponseHeaderContentType = setResponseHeaderContentType;
 exports.transformHeaderToTuples = transformHeaderToTuples;