koa-classic-server 2.6.1 → 3.0.0

package/__tests__/benchmark-results-v3.0.0.txt

@@ -0,0 +1,372 @@
+
+> koa-classic-server@3.0.0-alpha.0 test:performance
+> jest __tests__/performance.test.js --runInBand
+
+  console.warn
+    [koa-classic-server] WARNING: hidden.dotFiles.default and/or hidden.dotDirs.default are not explicitly set.
+      Since v3.0.0 the defaults are: dotFiles → "hidden", dotDirs → "visible".
+      To suppress this warning, add to your configuration:
+        hidden: { dotFiles: { default: 'hidden' }, dotDirs: { default: 'visible' } }
+      (adjust values to match your desired behaviour)
+
+      735 |         if (dotFilesImplicit || dotDirsImplicit) {
+      736 |             _hiddenDefaultWarnEmitted = true;
+    > 737 |             _logger.warn(...warnPayload(_logger,
+          |                     ^
+      738 |                 '[koa-classic-server] WARNING: hidden.dotFiles.default and/or hidden.dotDirs.default are not explicitly set.\n' +
+      739 |                 '  Since v3.0.0 the defaults are: dotFiles → "hidden", dotDirs → "visible".\n' +
+      740 |                 '  To suppress this warning, add to your configuration:\n' +
+
+      at koaClassicServer (index.cjs:737:21)
+      at Object.koaClassicServer (__tests__/performance.test.js:139:17)
+
+  console.log
+    
+    📊 Small File (1KB) Benchmark:
+
+      at Object.log (__tests__/performance.test.js:159:21)
+
+  console.log
+       Average: 2.09ms
+
+      at Object.log (__tests__/performance.test.js:160:21)
+
+  console.log
+       Median:  1.66ms
+
+      at Object.log (__tests__/performance.test.js:161:21)
+
+  console.log
+       Min:     1.40ms
+
+      at Object.log (__tests__/performance.test.js:162:21)
+
+  console.log
+       Max:     22.92ms
+
+      at Object.log (__tests__/performance.test.js:163:21)
+
+  console.log
+    
+    📊 Medium File (100KB) Benchmark:
+
+      at Object.log (__tests__/performance.test.js:178:21)
+
+  console.log
+       Average: 2.06ms
+
+      at Object.log (__tests__/performance.test.js:179:21)
+
+  console.log
+       Median:  1.93ms
+
+      at Object.log (__tests__/performance.test.js:180:21)
+
+  console.log
+       Min:     1.65ms
+
+      at Object.log (__tests__/performance.test.js:181:21)
+
+  console.log
+       Max:     4.47ms
+
+      at Object.log (__tests__/performance.test.js:182:21)
+
+  console.log
+    
+    📊 Large File (1MB) Benchmark:
+
+      at Object.log (__tests__/performance.test.js:197:21)
+
+  console.log
+       Average: 7.19ms
+
+      at Object.log (__tests__/performance.test.js:198:21)
+
+  console.log
+       Median:  5.82ms
+
+      at Object.log (__tests__/performance.test.js:199:21)
+
+  console.log
+       Min:     4.53ms
+
+      at Object.log (__tests__/performance.test.js:200:21)
+
+  console.log
+       Max:     21.60ms
+
+      at Object.log (__tests__/performance.test.js:201:21)
+
+  console.log
+    
+    📊 Small Directory (100 files) Benchmark:
+
+      at Object.log (__tests__/performance.test.js:219:21)
+
+  console.log
+       Average: 5.22ms
+
+      at Object.log (__tests__/performance.test.js:220:21)
+
+  console.log
+       Median:  4.65ms
+
+      at Object.log (__tests__/performance.test.js:221:21)
+
+  console.log
+       Min:     4.03ms
+
+      at Object.log (__tests__/performance.test.js:222:21)
+
+  console.log
+       Max:     17.47ms
+
+      at Object.log (__tests__/performance.test.js:223:21)
+
+  console.log
+    
+    📊 Large Directory (1,000 files) Benchmark:
+
+      at Object.log (__tests__/performance.test.js:237:21)
+
+  console.log
+       Average: 28.83ms
+
+      at Object.log (__tests__/performance.test.js:238:21)
+
+  console.log
+       Median:  28.80ms
+
+      at Object.log (__tests__/performance.test.js:239:21)
+
+  console.log
+       Min:     26.80ms
+
+      at Object.log (__tests__/performance.test.js:240:21)
+
+  console.log
+       Max:     31.02ms
+
+      at Object.log (__tests__/performance.test.js:241:21)
+
+  console.log
+       ⚠️  WARNING: This will be MUCH faster after async optimization
+
+      at Object.log (__tests__/performance.test.js:244:21)
+
+  console.log
+    
+    📊 Very Large Directory (10,000 files) Benchmark:
+
+      at Object.log (__tests__/performance.test.js:258:21)
+
+  console.log
+       Average: 265.99ms
+
+      at Object.log (__tests__/performance.test.js:259:21)
+
+  console.log
+       Median:  266.27ms
+
+      at Object.log (__tests__/performance.test.js:260:21)
+
+  console.log
+       Min:     261.83ms
+
+      at Object.log (__tests__/performance.test.js:261:21)
+
+  console.log
+       Max:     271.55ms
+
+      at Object.log (__tests__/performance.test.js:262:21)
+
+  console.log
+       ⚠️  WARNING: Event loop BLOCKED during this operation!
+
+      at Object.log (__tests__/performance.test.js:263:21)
+
+  console.log
+       ⚠️  Expected to drop to ~79.80ms after optimization
+
+      at Object.log (__tests__/performance.test.js:264:21)
+
+  console.log
+    
+    📊 10 Concurrent Small Files:
+
+      at Object.log (__tests__/performance.test.js:281:21)
+
+  console.log
+       Total time: 13.28ms
+
+      at Object.log (__tests__/performance.test.js:282:21)
+
+  console.log
+       Avg per request: 1.33ms
+
+      at Object.log (__tests__/performance.test.js:283:21)
+
+  console.log
+    
+    📊 5 Concurrent Directory Listings (100 files):
+
+      at Object.log (__tests__/performance.test.js:300:21)
+
+  console.log
+       Total time: 18.73ms
+
+      at Object.log (__tests__/performance.test.js:301:21)
+
+  console.log
+       Avg per request: 3.75ms
+
+      at Object.log (__tests__/performance.test.js:302:21)
+
+  console.log
+       ⚠️  With current sync code, these run SEQUENTIALLY
+
+      at Object.log (__tests__/performance.test.js:303:21)
+
+  console.log
+       ⚠️  After async optimization, will run in PARALLEL
+
+      at Object.log (__tests__/performance.test.js:304:21)
+
+  console.log
+    
+    📊 404 Not Found Benchmark:
+
+      at Object.log (__tests__/performance.test.js:321:21)
+
+  console.log
+       Average: 1.26ms
+
+      at Object.log (__tests__/performance.test.js:322:21)
+
+  console.log
+       Median:  1.11ms
+
+      at Object.log (__tests__/performance.test.js:323:21)
+
+  console.log
+       Min:     0.92ms
+
+      at Object.log (__tests__/performance.test.js:324:21)
+
+  console.log
+       Max:     3.88ms
+
+      at Object.log (__tests__/performance.test.js:325:21)
+
+  console.log
+    
+    📊 Memory Usage (10,000 files directory):
+
+      at Object.log (__tests__/performance.test.js:347:21)
+
+  console.log
+       Heap used increase: 6.97 MB
+
+      at Object.log (__tests__/performance.test.js:348:21)
+
+  console.log
+       External increase: 0.25 MB
+
+      at Object.log (__tests__/performance.test.js:349:21)
+
+  console.log
+       Response size: 0.02 MB
+
+      at Object.log (__tests__/performance.test.js:350:21)
+
+  console.log
+       ⚠️  Expected to reduce by ~30-40% after optimization
+
+      at Object.log (__tests__/performance.test.js:351:21)
+
+  console.log
+    
+    ======================================================================
+
+      at Object.log (__tests__/performance.test.js:358:13)
+
+  console.log
+    📋 BASELINE BENCHMARK SUMMARY
+
+      at Object.log (__tests__/performance.test.js:359:13)
+
+  console.log
+    ======================================================================
+
+      at Object.log (__tests__/performance.test.js:360:13)
+
+  console.log
+    
+    These results represent the CURRENT performance (v1.2.0)
+
+      at Object.log (__tests__/performance.test.js:361:13)
+
+  console.log
+    After implementing optimizations, run this test again to see improvements.
+
+      at Object.log (__tests__/performance.test.js:362:13)
+
+  console.log
+    Expected improvements after optimization:
+
+      at Object.log (__tests__/performance.test.js:363:13)
+
+  console.log
+      ✓ Small files:        10-20% faster (async operations)
+
+      at Object.log (__tests__/performance.test.js:364:13)
+
+  console.log
+      ✓ Large directories:  50-70% faster (async + array join)
+
+      at Object.log (__tests__/performance.test.js:365:13)
+
+  console.log
+      ✓ Concurrent requests: 5-10x faster (non-blocking event loop)
+
+      at Object.log (__tests__/performance.test.js:366:13)
+
+  console.log
+      ✓ Memory usage:       30-40% reduction (array join vs concatenation)
+
+      at Object.log (__tests__/performance.test.js:367:13)
+
+  console.log
+      ✓ With HTTP caching:  80-95% faster (304 responses)
+
+      at Object.log (__tests__/performance.test.js:368:13)
+
+  console.log
+    ======================================================================
+
+      at Object.log (__tests__/performance.test.js:369:13)
+
+PASS __tests__/performance.test.js
+  Performance Benchmarks - BASELINE (v1.2.0)
+    File Serving Performance
+      ✓ Benchmark: Small file (1KB) - 100 iterations (215 ms)
+      ✓ Benchmark: Medium file (100KB) - 50 iterations (107 ms)
+      ✓ Benchmark: Large file (1MB) - 20 iterations (146 ms)
+    Directory Listing Performance
+      ✓ Benchmark: Small directory (100 files) - 50 iterations (264 ms)
+      ✓ Benchmark: Large directory (1,000 files) - 20 iterations (579 ms)
+      ✓ Benchmark: Very large directory (10,000 files) - 5 iterations (1333 ms)
+    Concurrent Request Performance
+      ✓ Benchmark: 10 concurrent small file requests (15 ms)
+      ✓ Benchmark: 5 concurrent directory listings (100 files each) (21 ms)
+    404 Not Found Performance
+      ✓ Benchmark: Non-existent file - 50 iterations (65 ms)
+    Memory Usage (Informational)
+      ✓ Memory usage during large directory listing (269 ms)
+
+Test Suites: 1 passed, 1 total
+Tests:       10 passed, 10 total
+Snapshots:   0 total
+Time:        3.365 s, estimated 5 s
+Ran all test suites matching __tests__/performance.test.js.

package/__tests__/benchmark.js

@@ -20,7 +20,7 @@
 
 const autocannon = require('autocannon');
 const Koa = require('koa');
-const koaClassicServer = require('./index.cjs');
+const koaClassicServer = require('../index.cjs');
 const path = require('path');
 const fs = require('fs');
 

package/__tests__/caching-headers.test.js

@@ -2,8 +2,8 @@
  * HTTP Caching Headers Test
  *
  * Tests to verify correct caching behavior:
- * - When enableCaching: true -> proper cache headers
- * - When enableCaching: false -> anti-cache headers
+ * - When browserCacheEnabled: true -> proper cache headers
+ * - When browserCacheEnabled: false -> anti-cache headers
  */
 
 const Koa = require('koa');
@@ -30,7 +30,7 @@ describe('HTTP Caching Headers', () => {
         }
     });
 
-    describe('When caching is DISABLED (enableCaching: false)', () => {
+    describe('When caching is DISABLED (browserCacheEnabled: false)', () => {
         let app;
         let server;
         let request;
@@ -38,7 +38,7 @@ describe('HTTP Caching Headers', () => {
         beforeAll(() => {
             app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: false
+                browserCacheEnabled: false
             }));
             server = app.listen();
             request = supertest(server);
@@ -89,7 +89,7 @@ describe('HTTP Caching Headers', () => {
         });
     });
 
-    describe('When caching is ENABLED (enableCaching: true)', () => {
+    describe('When caching is ENABLED (browserCacheEnabled: true)', () => {
         let app;
         let server;
         let request;
@@ -97,8 +97,8 @@ describe('HTTP Caching Headers', () => {
         beforeAll(() => {
             app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true,
-                cacheMaxAge: 3600
+                browserCacheEnabled: true,
+                browserCacheMaxAge: 3600
             }));
             server = app.listen();
             request = supertest(server);
@@ -173,7 +173,7 @@ describe('HTTP Caching Headers', () => {
 
         beforeAll(() => {
             app = new Koa();
-            // No options provided - should default to enableCaching: false
+            // No options provided - should default to browserCacheEnabled: false
             app.use(koaClassicServer(TEST_DIR));
             server = app.listen();
             request = supertest(server);
@@ -193,12 +193,12 @@ describe('HTTP Caching Headers', () => {
         });
     });
 
-    describe('Custom cacheMaxAge values', () => {
-        test('Should respect custom cacheMaxAge: 7200', async () => {
+    describe('Custom browserCacheMaxAge values', () => {
+        test('Should respect custom browserCacheMaxAge: 7200', async () => {
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true,
-                cacheMaxAge: 7200
+                browserCacheEnabled: true,
+                browserCacheMaxAge: 7200
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -211,11 +211,11 @@ describe('HTTP Caching Headers', () => {
             server.close();
         });
 
-        test('Should respect custom cacheMaxAge: 0 (no browser cache)', async () => {
+        test('Should respect custom browserCacheMaxAge: 0 (no browser cache)', async () => {
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true,
-                cacheMaxAge: 0
+                browserCacheEnabled: true,
+                browserCacheMaxAge: 0
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -230,11 +230,11 @@ describe('HTTP Caching Headers', () => {
             server.close();
         });
 
-        test('Should respect custom cacheMaxAge: 86400 (1 day)', async () => {
+        test('Should respect custom browserCacheMaxAge: 86400 (1 day)', async () => {
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true,
-                cacheMaxAge: 86400
+                browserCacheEnabled: true,
+                browserCacheMaxAge: 86400
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -255,7 +255,7 @@ describe('HTTP Caching Headers', () => {
 
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true
+                browserCacheEnabled: true
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -290,7 +290,7 @@ describe('HTTP Caching Headers', () => {
 
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true
+                browserCacheEnabled: true
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -318,7 +318,7 @@ describe('HTTP Caching Headers', () => {
         test('304 response should have no body', async () => {
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true
+                browserCacheEnabled: true
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -348,7 +348,7 @@ describe('HTTP Caching Headers', () => {
         test('Should save bandwidth on multiple 304 responses', async () => {
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true
+                browserCacheEnabled: true
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -394,7 +394,7 @@ describe('HTTP Caching Headers', () => {
         test('HTML files should have cache headers', async () => {
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true
+                browserCacheEnabled: true
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -411,7 +411,7 @@ describe('HTTP Caching Headers', () => {
         test('JSON files should have cache headers', async () => {
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true
+                browserCacheEnabled: true
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -427,7 +427,7 @@ describe('HTTP Caching Headers', () => {
         test('CSS files should have cache headers', async () => {
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true
+                browserCacheEnabled: true
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -443,7 +443,7 @@ describe('HTTP Caching Headers', () => {
         test('JavaScript files should have cache headers', async () => {
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true
+                browserCacheEnabled: true
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -466,8 +466,8 @@ describe('HTTP Caching Headers', () => {
 
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true,
-                cacheMaxAge: 3600,
+                browserCacheEnabled: true,
+                browserCacheMaxAge: 3600,
                 template: {
                     ext: ['ejs'],
                     render: async (ctx, next, filePath) => {
@@ -499,7 +499,7 @@ describe('HTTP Caching Headers', () => {
         test('Multiple concurrent requests should handle caching correctly', async () => {
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true
+                browserCacheEnabled: true
             }));
             const server = app.listen();
             const request = supertest(server);
@@ -528,7 +528,7 @@ describe('HTTP Caching Headers', () => {
         test('Concurrent 304 responses should work correctly', async () => {
             const app = new Koa();
             app.use(koaClassicServer(TEST_DIR, {
-                enableCaching: true
+                browserCacheEnabled: true
             }));
             const server = app.listen();
             const request = supertest(server);

package/__tests__/compression-fixtures/data.json

@@ -0,0 +1 @@
+{"key":"value"}

package/__tests__/compression-fixtures/large.txt

@@ -0,0 +1 @@
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

package/__tests__/compression-fixtures/small.txt

@@ -0,0 +1 @@
+tiny