routup 3.1.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);
@@ -844,6 +940,78 @@ function setResponseHeaderContentType(res, input, ifNotExists) {
     }
 }
 
+async function sendStream(res, stream, next) {
+    if (isWebStream(stream)) {
+        return stream.pipeTo(new WritableStream({
+            write (chunk) {
+                res.write(chunk);
+            }
+        })).then(()=>{
+            if (next) {
+                return next();
+            }
+            res.end();
+            return Promise.resolve();
+        }).catch((err)=>{
+            if (next) {
+                return next(err);
+            }
+            return Promise.reject(err);
+        });
+    }
+    return new Promise((resolve, reject)=>{
+        stream.on('open', ()=>{
+            stream.pipe(res);
+        });
+        /* istanbul ignore next */ stream.on('error', (err)=>{
+            if (next) {
+                Promise.resolve().then(()=>next(err)).then(()=>resolve()).catch((e)=>reject(e));
+                return;
+            }
+            res.end();
+            reject(err);
+        });
+        stream.on('close', ()=>{
+            if (next) {
+                Promise.resolve().then(()=>next()).then(()=>resolve()).catch((e)=>reject(e));
+                return;
+            }
+            res.end();
+            resolve();
+        });
+    });
+}
+
+async function sendWebBlob(res, blob) {
+    setResponseHeaderContentType(res, blob.type);
+    await sendStream(res, blob.stream());
+}
+
+async function sendWebResponse(res, webResponse) {
+    if (webResponse.redirected) {
+        res.setHeader(exports.HeaderName.LOCATION, webResponse.url);
+    }
+    if (webResponse.status) {
+        res.statusCode = webResponse.status;
+    }
+    if (webResponse.statusText) {
+        res.statusMessage = webResponse.statusText;
+    }
+    webResponse.headers.forEach((value, key)=>{
+        if (key === exports.HeaderName.SET_COOKIE) {
+            res.appendHeader(key, splitCookiesString(value));
+        } else {
+            res.setHeader(key, value);
+        }
+    });
+    if (webResponse.body) {
+        await sendStream(res, webResponse.body);
+        return Promise.resolve();
+    }
+    res.end();
+    return Promise.resolve();
+}
+
 async function send(res, chunk) {
     switch(typeof chunk){
         case 'string':
@@ -855,11 +1023,28 @@ async function send(res, chunk) {
         case 'number':
         case 'object':
             {
-                if (buffer.Buffer.isBuffer(chunk)) {
-                    setResponseHeaderContentType(res, 'bin', true);
-                } else if (chunk !== null) {
-                    chunk = JSON.stringify(chunk);
-                    setResponseHeaderContentType(res, 'application/json', true);
+                if (chunk !== null) {
+                    if (chunk instanceof Error) {
+                        throw chunk;
+                    }
+                    if (isStream(chunk)) {
+                        await sendStream(res, chunk);
+                        return;
+                    }
+                    if (isWebBlob(chunk)) {
+                        await sendWebBlob(res, chunk);
+                        return;
+                    }
+                    if (isWebResponse(chunk)) {
+                        await sendWebResponse(res, chunk);
+                        return;
+                    }
+                    if (buffer.Buffer.isBuffer(chunk)) {
+                        setResponseHeaderContentType(res, 'bin', true);
+                    } else {
+                        chunk = JSON.stringify(chunk);
+                        setResponseHeaderContentType(res, 'application/json', true);
+                    }
                 }
                 break;
             }
@@ -942,48 +1127,6 @@ function sendCreated(res, chunk) {
     return send(res, chunk);
 }
 
-async function sendStream(res, stream, next) {
-    if (isWebStream(stream)) {
-        return stream.pipeTo(new WritableStream({
-            write (chunk) {
-                res.write(chunk);
-            }
-        })).then(()=>{
-            if (next) {
-                return next();
-            }
-            res.end();
-            return Promise.resolve();
-        }).catch((err)=>{
-            if (next) {
-                return next(err);
-            }
-            return Promise.reject(err);
-        });
-    }
-    return new Promise((resolve, reject)=>{
-        stream.on('open', ()=>{
-            stream.pipe(res);
-        });
-        /* istanbul ignore next */ stream.on('error', (err)=>{
-            if (next) {
-                Promise.resolve().then(()=>next(err)).then(()=>resolve()).catch((e)=>reject(e));
-                return;
-            }
-            res.end();
-            reject(err);
-        });
-        stream.on('close', ()=>{
-            if (next) {
-                Promise.resolve().then(()=>next()).then(()=>resolve()).catch((e)=>reject(e));
-                return;
-            }
-            res.end();
-            resolve();
-        });
-    });
-}
-
 async function sendFile(res, options, next) {
     let stats;
     try {
@@ -1073,36 +1216,6 @@ function sendRedirect(res, location, statusCode = 302) {
     return send(res, html);
 }
 
-async function sendWebResponse(res, webResponse) {
-    if (webResponse.redirected) {
-        res.setHeader(exports.HeaderName.LOCATION, webResponse.url);
-    }
-    if (webResponse.status) {
-        res.statusCode = webResponse.status;
-    }
-    if (webResponse.statusText) {
-        res.statusMessage = webResponse.statusText;
-    }
-    webResponse.headers.forEach((value, key)=>{
-        if (key === exports.HeaderName.SET_COOKIE) {
-            res.appendHeader(key, splitCookiesString(value));
-        } else {
-            res.setHeader(key, value);
-        }
-    });
-    if (webResponse.body) {
-        await sendStream(res, webResponse.body);
-        return Promise.resolve();
-    }
-    res.end();
-    return Promise.resolve();
-}
-
-async function sendWebBlob(res, blob) {
-    setResponseHeaderContentType(res, blob.type);
-    await sendStream(res, blob.stream());
-}
-
 function createResponse(request) {
     let output;
     let encoding;
@@ -1248,24 +1361,6 @@ function createResponse(request) {
     return writable;
 }
 
-async function sendData(event, chunk) {
-    if (chunk instanceof Error) {
-        return Promise.reject(createError(chunk));
-    }
-    if (isStream(chunk)) {
-        await sendStream(event.response, chunk);
-        return Promise.resolve();
-    }
-    if (isWebBlob(chunk)) {
-        await sendWebBlob(event.response, chunk);
-        return Promise.resolve();
-    }
-    if (isWebResponse(chunk)) {
-        await sendWebResponse(event.response, chunk);
-        return Promise.resolve();
-    }
-    return send(event.response, chunk);
-}
 function dispatch(event, target) {
     setRequestParams(event.request, event.params);
     setRequestMountPath(event.request, event.mountPath);
@@ -1299,7 +1394,7 @@ function dispatch(event, target) {
             handled = true;
             unsubscribe();
             if (!event.dispatched) {
-                await sendData(event, data);
+                await send(event.response, data);
             }
             return true;
         };
@@ -2142,6 +2237,7 @@ class Router {
 
 exports.DispatchErrorEvent = DispatchErrorEvent;
 exports.DispatchEvent = DispatchEvent;
+exports.EventStream = EventStream;
 exports.Handler = Handler;
 exports.HandlerSymbol = HandlerSymbol;
 exports.PathMatcher = PathMatcher;
@@ -2151,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;
@@ -2180,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;
@@ -2199,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;