Compare commits

...

6 Commits

Author SHA1 Message Date
8c3aad69a0 3.0.14 2024-01-09 10:14:07 +01:00
fb2692b50e fix(core): update 2024-01-09 10:14:06 +01:00
65c868aefe 3.0.13 2024-01-08 15:34:54 +01:00
11df25f028 fix(core): update 2024-01-08 15:34:53 +01:00
efb4229f58 3.0.12 2024-01-08 14:43:12 +01:00
61dcc6badc fix(core): update 2024-01-08 14:43:11 +01:00
6 changed files with 87 additions and 27 deletions

View File

@ -1,6 +1,6 @@
{
"name": "@api.global/typedserver",
"version": "3.0.11",
"version": "3.0.14",
"description": "easy serving of static files",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",

View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@api.global/typedserver',
version: '3.0.11',
version: '3.0.14',
description: 'easy serving of static files'
}

View File

@ -1,45 +1,90 @@
import * as plugins from '../typedserver.plugins.js';
export type TCompressionMethod = 'gzip' | 'deflate' | 'br' | 'none';
export interface ICompressionResult {
result: Buffer;
compressionMethod: TCompressionMethod;
}
export class Compressor {
private _cache: Map<string, Buffer>;
private MAX_CACHE_SIZE: number = 100 * 1024 * 1024; // 100 MB
constructor() {
this._cache = new Map<string, Buffer>();
}
private _addToCache(key: string, value: Buffer) {
this._cache.set(key, value);
this._manageCacheSize();
}
private _manageCacheSize() {
let currentSize = Array.from(this._cache.values()).reduce((acc, buffer) => acc + buffer.length, 0);
while (currentSize > this.MAX_CACHE_SIZE) {
const firstKey = this._cache.keys().next().value;
const firstValue = this._cache.get(firstKey)!;
currentSize -= firstValue.length;
this._cache.delete(firstKey);
}
}
public async compressContent(
content: Buffer,
method: 'gzip' | 'deflate' | 'br' | 'none'
): Promise<Buffer> {
const cacheKey = content.toString('base64') + method;
const cachedResult = this._cache.get(cacheKey);
if (cachedResult) {
return cachedResult;
}
return new Promise((resolve, reject) => {
const callback = (err: Error | null, result: Buffer) => {
if (err) reject(err);
else {
this._addToCache(cacheKey, result);
resolve(result);
}
};
switch (method) {
case 'gzip':
plugins.zlib.gzip(content, (err, result) => {
if (err) reject(err);
else resolve(result);
});
plugins.zlib.gzip(content, {
level: 1,
},callback,);
break;
case 'br':
plugins.zlib.brotliCompress(content, (err, result) => {
if (err) reject(err);
else resolve(result);
});
plugins.zlib.brotliCompress(content, {}, callback);
break;
case 'deflate':
plugins.zlib.deflate(content, (err, result) => {
if (err) reject(err);
else resolve(result);
});
plugins.zlib.deflate(content, callback);
break;
default:
this._addToCache(cacheKey, content);
resolve(content);
}
});
}
public determineCompression(acceptEncoding: string | string[]) {
public determineCompression(acceptEncoding: string | string[], preferredCompressionMethodsArg: TCompressionMethod[] = []) {
// Ensure acceptEncoding is a single string
const encodingString = Array.isArray(acceptEncoding)
? acceptEncoding.join(', ')
: acceptEncoding;
let compressionMethod: 'gzip' | 'deflate' | 'br' | 'none' = 'none';
let compressionMethod: TCompressionMethod = 'none';
// Check and prioritize compression methods
// Prioritize preferred compression methods if provided
for (const preferredMethod of preferredCompressionMethodsArg) {
if (new RegExp(`\\b${preferredMethod}\\b`).test(encodingString)) {
return preferredMethod;
}
}
// Fallback to default prioritization if no preferred method matches
if (/\bbr\b/.test(encodingString)) {
compressionMethod = 'br';
} else if (/\bgzip\b/.test(encodingString)) {
@ -51,9 +96,9 @@ export class Compressor {
return compressionMethod;
}
public async maybeCompress(requestHeaders: plugins.http.IncomingHttpHeaders, content: Buffer) {
public async maybeCompress(requestHeaders: plugins.http.IncomingHttpHeaders, content: Buffer, preferredCompressionMethodsArg?: TCompressionMethod[]): Promise<ICompressionResult> {
const acceptEncoding = requestHeaders['accept-encoding'];
const compressionMethod = this.determineCompression(acceptEncoding);
const compressionMethod = this.determineCompression(acceptEncoding, preferredCompressionMethodsArg);
const result = await this.compressContent(content, compressionMethod);
return {
result,
@ -62,15 +107,21 @@ export class Compressor {
}
public createCompressionStream(method: 'gzip' | 'deflate' | 'br' | 'none') {
let compressionStream: any;
switch (method) {
case 'gzip':
return plugins.zlib.createGzip();
compressionStream = plugins.zlib.createGzip();
case 'br':
return plugins.zlib.createBrotliCompress();
compressionStream = plugins.zlib.createBrotliCompress({
chunkSize: 16 * 1024,
params: {
},
});
case 'deflate':
return plugins.zlib.createDeflate();
compressionStream = plugins.zlib.createDeflate();
default:
throw new Error('Invalid compression method');
compressionStream = plugins.smartstream.createPassThrough();
}
}
}

View File

@ -2,7 +2,7 @@ import * as plugins from '../typedserver.plugins.js';
import * as interfaces from '../interfaces/index.js';
import { Handler } from './classes.handler.js';
import { Compressor } from './classes.compressor.js';
import { Compressor, type TCompressionMethod, type ICompressionResult } from './classes.compressor.js';
export class HandlerStatic extends Handler {
public compressor = new Compressor();
@ -13,6 +13,8 @@ export class HandlerStatic extends Handler {
responseModifier?: interfaces.TResponseModifier;
headers?: { [key: string]: string };
serveIndexHtmlDefault?: boolean;
enableCompression?: boolean;
preferredCompressionMethod?: 'gzip' | 'deflate' | 'br';
}
) {
super('GET', async (req, res) => {
@ -118,10 +120,16 @@ export class HandlerStatic extends Handler {
}
// lets finally deal with compression
const compressionResult = await this.compressor.maybeCompress(requestHeaders, fileBuffer);
let compressionResult: ICompressionResult;
if (optionsArg && optionsArg.enableCompression) {
compressionResult = await this.compressor.maybeCompress(requestHeaders, fileBuffer);
}
res.status(200);
res.header('Content-Encoding', compressionResult.compressionMethod);
if (compressionResult?.compressionMethod) {
res.header('Content-Encoding', compressionResult.compressionMethod);
}
res.write(compressionResult.result);
res.end();
});

View File

@ -3,6 +3,7 @@ import * as http from 'http';
import * as https from 'https';
import * as net from 'net';
import * as path from 'path';
import * as stream from 'stream';
import * as zlib from 'zlib';
export { http, https, net, path, zlib };

View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@api.global/typedserver',
version: '3.0.11',
version: '3.0.14',
description: 'easy serving of static files'
}