kempo-server 1.7.4 → 1.7.6

package/scripts/build.js

@@ -6,9 +6,52 @@ import { fileURLToPath } from 'url';
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const rootDir = join(__dirname, '..');
 const srcDir = join(rootDir, 'src');
+const utilsDir = join(rootDir, 'utils');
 const distDir = join(rootDir, 'dist');
 const docsDir = join(rootDir, 'docs');
 
+/*
+  File Processing Helper
+*/
+const processJsFile = async (srcPath, distPath) => {
+  const fileName = distPath.split(/[/\\]/).pop();
+  console.log(`Minifying ${fileName}...`);
+  
+  // Read source file
+  let sourceCode = await readFile(srcPath, 'utf8');
+  
+  // Check for and preserve shebang
+  let shebang = '';
+  if (sourceCode.startsWith('#!')) {
+    const firstNewline = sourceCode.indexOf('\n');
+    shebang = sourceCode.substring(0, firstNewline + 1);
+    sourceCode = sourceCode.substring(firstNewline + 1);
+  }
+  
+  // Minify with Terser
+  const result = await minify(sourceCode, {
+    module: true, // Enable ES module support
+    format: {
+      comments: false,
+    },
+    compress: {
+      dead_code: true,
+      drop_console: false,
+      drop_debugger: true,
+    },
+    mangle: false, // Keep function names for better debugging
+  });
+  
+  if (result.error) {
+    throw new Error(`Minification failed for ${fileName}: ${result.error}`);
+  }
+  
+  // Write minified file to dist with shebang if it existed
+  const finalCode = shebang + result.code;
+  await writeFile(distPath, finalCode);
+  console.log(`✓ Built ${fileName}`);
+};
+
 /*
   Build Process
 */
@@ -16,53 +59,24 @@ const build = async () => {
   try {
     // Ensure dist directory exists
     await mkdir(distDir, { recursive: true });
+    await mkdir(join(distDir, 'utils'), { recursive: true });
     
     console.log('Building JavaScript files...');
     
-    // Get all JS files in src directory
-    const files = await readdir(srcDir);
-    const jsFiles = files.filter(file => file.endsWith('.js'));
+    // Process src directory
+    const srcFiles = await readdir(srcDir);
+    const srcJsFiles = srcFiles.filter(file => file.endsWith('.js'));
+    
+    for (const file of srcJsFiles) {
+      await processJsFile(join(srcDir, file), join(distDir, file));
+    }
+    
+    // Process utils directory
+    const utilsFiles = await readdir(utilsDir);
+    const utilsJsFiles = utilsFiles.filter(file => file.endsWith('.js'));
     
-    // Process each JS file
-    for (const file of jsFiles) {
-      const srcPath = join(srcDir, file);
-      const distPath = join(distDir, file);
-      
-      console.log(`Minifying ${file}...`);
-      
-      // Read source file
-      let sourceCode = await readFile(srcPath, 'utf8');
-      
-      // Check for and preserve shebang
-      let shebang = '';
-      if (sourceCode.startsWith('#!')) {
-        const firstNewline = sourceCode.indexOf('\n');
-        shebang = sourceCode.substring(0, firstNewline + 1);
-        sourceCode = sourceCode.substring(firstNewline + 1);
-      }
-      
-      // Minify with Terser
-      const result = await minify(sourceCode, {
-        module: true, // Enable ES module support
-        format: {
-          comments: false,
-        },
-        compress: {
-          dead_code: true,
-          drop_console: false,
-          drop_debugger: true,
-        },
-        mangle: false, // Keep function names for better debugging
-      });
-      
-      if (result.error) {
-        throw new Error(`Minification failed for ${file}: ${result.error}`);
-      }
-      
-      // Write minified file to dist with shebang if it existed
-      const finalCode = shebang + result.code;
-      await writeFile(distPath, finalCode);
-      console.log(`✓ Built ${file}`);
+    for (const file of utilsJsFiles) {
+      await processJsFile(join(utilsDir, file), join(distDir, 'utils', file));
     }
     
     console.log('Copying kempo.min.css to docs...');

package/tests/getFiles.node-test.js

@@ -1,13 +1,13 @@
 import getFiles from '../src/getFiles.js';
 import defaultConfig from '../src/defaultConfig.js';
 import path from 'path';
-import {withTempDir, write, log} from './test-utils.js';
+import {withTestDir, write, log} from './test-utils.js';
 
 export default {
   'scans directories recursively and filters by mime and disallowed': async ({pass, fail}) => {
-    await withTempDir(async (dir) => {
+    await withTestDir(async (dir) => {
       const cfg = JSON.parse(JSON.stringify(defaultConfig));
-      await write(dir, 'index.html', '<!doctype html>');
+      // Create test-specific files for this test
       await write(dir, '.env', 'SECRET=1');
       await write(dir, 'notes.xyz', 'unknown');
       await write(dir, 'sub/app.js', 'console.log(1)');

package/tests/index.node-test.js

@@ -1,9 +1,10 @@
-import {startNode, randomPort, httpGet, withTempDir, write} from './test-utils.js';
+import {startNode, randomPort, httpGet, withTestDir, write} from './test-utils.js';
 import path from 'path';
 
 export default {
   'index.js CLI starts server and serves root': async ({pass, fail}) => {
-    await withTempDir(async (dir) => {
+    await withTestDir(async (dir) => {
+      // Create custom index.html for this test
       await write(dir, 'index.html', 'home');
       const port = randomPort();
       const args = [path.join(process.cwd(), 'dist/index.js'), '-r', '.', '-p', String(port), '-l', '0'];

package/tests/router-middleware.node-test.js

@@ -1,10 +1,10 @@
 import http from 'http';
-import {withTempDir, write, randomPort} from './test-utils.js';
+import {withTestDir, write, randomPort} from './test-utils.js';
 import router from '../src/router.js';
 
 export default {
   'built-in middleware can be configured on router': async ({pass, fail}) => {
-    await withTempDir(async (dir) => {
+    await withTestDir(async (dir) => {
       await write(dir, '.config.json', JSON.stringify({
         middleware: {
           cors: {enabled: true, origin: '*', methods: ['GET'], headers: ['X']},
@@ -14,7 +14,6 @@ export default {
           logging: {enabled: true, includeUserAgent: false, includeResponseTime: true}
         }
       }));
-      await write(dir, 'index.html', 'hello world');
       const prev = process.cwd();
       process.chdir(dir);
       const flags = {root: '.', logging: 0, scan: false};

package/tests/router.node-test.js

@@ -1,13 +1,12 @@
 import http from 'http';
 import path from 'path';
-import {withTempDir, write, randomPort, httpGet, log} from './test-utils.js';
+import {withTestDir, write, randomPort, httpGet, log} from './test-utils.js';
 import router from '../src/router.js';
 import defaultConfig from '../src/defaultConfig.js';
 
 export default {
   'serves static files and 404s unknown': async ({pass, fail}) => {
-    await withTempDir(async (dir) => {
-      await write(dir, 'index.html', '<h1>Home</h1>');
+    await withTestDir(async (dir) => {
       const prev = process.cwd();
       process.chdir(dir);
       const flags = {root: '.', logging: 0, scan: false};
@@ -38,7 +37,7 @@ export default {
     pass('static + 404');
   },
   'rescan on 404 when enabled and not blacklisted': async ({pass, fail}) => {
-    await withTempDir(async (dir) => {
+    await withTestDir(async (dir) => {
       const prev = process.cwd();
       process.chdir(dir);
       const flags = {root: '.', logging: 0, scan: true};
@@ -55,7 +54,7 @@ export default {
         return fail('first 404');
       }
       
-      await write(dir, 'late.html', 'later');
+      // File already exists, should be found on rescan
       const hit = await httpGet(`http://localhost:${port}/late.html`);
       if(hit.res.statusCode !== 200) {
         server.close();
@@ -69,9 +68,9 @@ export default {
     pass('rescan');
   },
   'custom and wildcard routes serve mapped files': async ({pass, fail}) => {
-    await withTempDir(async (dir) => {
-      const fileA = await write(dir, 'a.txt', 'A');
-      const fileB = await write(dir, 'b/1.txt', 'B1');
+    await withTestDir(async (dir) => {
+      const fileA = path.join(dir, 'a.txt');
+      const fileB = path.join(dir, 'b/1.txt');
       const prev = process.cwd();
       process.chdir(dir);
       const flags = {root: '.', logging: 0, scan: false};

package/tests/serveFile.node-test.js

@@ -2,14 +2,13 @@ import serveFile from '../src/serveFile.js';
 import findFile from '../src/findFile.js';
 import defaultConfig from '../src/defaultConfig.js';
 import path from 'path';
-import {createMockReq, createMockRes, withTempDir, write, log} from './test-utils.js';
+import {createMockReq, createMockRes, withTestDir, write, log} from './test-utils.js';
 
 export default {
   'serves static file with correct mime': async ({pass, fail}) => {
     try {
-      await withTempDir(async (dir) => {
+      await withTestDir(async (dir) => {
         const cfg = JSON.parse(JSON.stringify(defaultConfig));
-        await write(dir, 'index.html', '<h1>Hi</h1>');
         const files = [path.join(dir, 'index.html')];
         const res = createMockRes();
         const ok = await serveFile(files, dir, '/index.html', 'GET', cfg, createMockReq(), res, log);
@@ -22,9 +21,8 @@ export default {
   },
   'executes route files by calling default export': async ({pass, fail}) => {
     try {
-      await withTempDir(async (dir) => {
+      await withTestDir(async (dir) => {
         const cfg = JSON.parse(JSON.stringify(defaultConfig));
-        await write(dir, 'api/GET.js', "export default async (req, res) => { res.status(201).json({ok:true, params:req.params}); }\n");
         const files = [path.join(dir, 'api/GET.js')];
         const res = createMockRes();
         const ok = await serveFile(files, dir, '/api', 'GET', cfg, createMockReq(), res, log);
@@ -37,10 +35,9 @@ export default {
   },
   'handles route file without default function': async ({pass, fail}) => {
     try {
-      await withTempDir(async (dir) => {
+      await withTestDir(async (dir) => {
         const cfg = JSON.parse(JSON.stringify(defaultConfig));
-        await write(dir, 'api/GET.js', "export const x = 1;\n");
-        const files = [path.join(dir, 'api/GET.js')];
+        const files = [path.join(dir, 'api/no-default.js')];
         const res = createMockRes();
         const ok = await serveFile(files, dir, '/api', 'GET', cfg, createMockReq(), res, log);
         if(ok !== true) return fail('handled');

package/tests/test-server-root/.config.json

@@ -0,0 +1,5 @@
+{
+  "middleware": {
+    "cors": {}
+  }
+}

package/tests/test-server-root/README.md

@@ -0,0 +1,118 @@
+# Test Server Root
+
+This directory contains the persistent test server structure used by unit tests instead of creating temporary files for each test run. Tests use `withTestDir()` to get a temporary copy of this structure, maintaining isolation while providing consistent base files.
+
+## Directory Structure
+
+```
+test-server-root/
+├── README.md                              # This file
+├── .config.json                           # Basic config with middleware settings
+├── index.html                             # Basic home page: "<h1>Home</h1>"
+├── late.html                              # For rescan tests: "later"
+├── hello.html                             # For CLI tests: "hello world"
+├── a.txt                                  # Test file: "A"
+├── b/
+│   └── 1.txt                              # Test file: "B1"
+├── api/
+│   ├── GET.js                             # Route handler returning {ok:true, params}
+│   └── no-default.js                      # Route file without default export
+├── src/
+│   ├── file.js                            # Content: "single level"
+│   ├── file.txt                           # Content: "custom"
+│   ├── nested/
+│   │   └── file.js                        # Content: "nested level"
+│   ├── components/
+│   │   └── Button.js                      # Content: "export default Button"
+│   ├── utils/
+│   │   └── helpers/
+│   │       └── format.js                  # Content: "export const format = () => {}"
+│   └── deep/
+│       └── nested/
+│           └── folder/
+│               └── file.js                # Content: "export const deep = true"
+├── docs/
+│   ├── .config.json                       # Config with custom routes to ../src/**
+│   ├── api/
+│   │   └── data.json                      # Content: {"source": "static"}
+│   └── src/
+│       ├── nested/
+│       │   └── file.js                    # Content: "fallback file"
+│       ├── components/
+│       │   └── Button.js                  # Content: "WRONG FILE"
+│       └── utils/
+│           └── helpers/
+│               └── format.js              # Content: "WRONG FILE"
+├── custom/
+│   └── data.json                          # Content: {"source": "custom"}
+└── public/
+    └── src/
+        └── file.txt                       # Content: "static"
+```
+
+## Configuration Files
+
+### Root .config.json
+Basic configuration for middleware testing:
+```json
+{
+  "middleware": {
+    "cors": {}
+  }
+}
+```
+
+### docs/.config.json
+Configuration for wildcard routing tests:
+```json
+{
+  "customRoutes": {
+    "/src/*": "../src/$1"
+  },
+  "routePreference": "customRoute"
+}
+```
+
+## Usage in Tests
+
+### Simple Tests
+Use `withTestDir()` for tests that can leverage the existing structure:
+
+```javascript
+await withTestDir(async (dir) => {
+  // dir contains a copy of all the above files
+  // Use existing files or create additional ones as needed
+  const handler = await router({root: dir}, log);
+  // ... test the handler
+});
+```
+
+### Subdirectory Tests
+Use the `subdir` option to work within a specific folder:
+
+```javascript
+await withTestDir(async (dir) => {
+  // dir points to test-server-root/docs/
+  process.chdir(dir);
+  const handler = await router({root: '.'}, log);
+  // ... test from docs folder perspective
+}, {subdir: 'docs'});
+```
+
+### Complex Tests
+For tests requiring very specific or complex structures, continue using `withTempDir()`:
+
+```javascript
+await withTempDir(async (dir) => {
+  await write(dir, 'very/specific/structure.js', 'content');
+  // ... custom test setup
+});
+```
+
+## Benefits
+
+1. **Consistency** - All tests start with the same base structure
+2. **Speed** - No need to recreate common files for each test
+3. **Maintainability** - Centralized test file management  
+4. **Documentation** - Clear visibility of what test files exist
+5. **Isolation** - Each test still gets its own temporary copy

package/tests/test-server-root/a.txt

@@ -0,0 +1 @@
+A

package/tests/test-server-root/api/GET.js

@@ -0,0 +1 @@
+export default async (req, res) => { res.status(201).json({ok:true, params:req.params}); }

package/tests/test-server-root/api/no-default.js

@@ -0,0 +1 @@
+export const x = 1;

package/tests/test-server-root/b/1.txt

@@ -0,0 +1 @@
+B1

package/tests/test-server-root/custom/data.json

@@ -0,0 +1 @@
+{"source": "custom"}

package/tests/test-server-root/docs/.config.json

@@ -0,0 +1,6 @@
+{
+  "customRoutes": {
+    "/src/*": "../src/$1"
+  },
+  "routePreference": "customRoute"
+}

package/tests/test-server-root/docs/api/data.json

@@ -0,0 +1 @@
+{"source": "static"}

package/tests/test-server-root/docs/src/components/Button.js

@@ -0,0 +1 @@
+WRONG FILE

package/tests/test-server-root/docs/src/nested/file.js

@@ -0,0 +1 @@
+fallback file

package/tests/test-server-root/docs/src/utils/helpers/format.js

@@ -0,0 +1 @@
+WRONG FILE

package/tests/test-server-root/hello.html

@@ -0,0 +1 @@
+hello world

package/tests/test-server-root/index.html

@@ -0,0 +1 @@
+<h1>Home</h1>

package/tests/test-server-root/late.html

@@ -0,0 +1 @@
+later

package/tests/test-server-root/public/src/file.txt

@@ -0,0 +1 @@
+static

package/tests/test-server-root/src/components/Button.js

@@ -0,0 +1 @@
+export default Button

package/tests/test-server-root/src/deep/nested/folder/file.js

@@ -0,0 +1 @@
+export const deep = true

package/tests/test-server-root/src/file.js

@@ -0,0 +1 @@
+single level

package/tests/test-server-root/src/file.txt

@@ -0,0 +1 @@
+custom

package/tests/test-server-root/src/nested/file.js

@@ -0,0 +1 @@
+nested level

package/tests/test-server-root/src/utils/helpers/format.js

@@ -0,0 +1 @@
+export const format = () => {}

package/tests/test-utils.js

@@ -1,7 +1,11 @@
 import {Readable} from 'stream';
-import {mkdtemp, rm, writeFile, mkdir} from 'fs/promises';
+import {mkdtemp, rm, writeFile, mkdir, cp} from 'fs/promises';
 import os from 'os';
 import path from 'path';
+import {fileURLToPath} from 'url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const TEST_SERVER_ROOT = path.join(__dirname, 'test-server-root');
 
 export const createMockReq = ({method = 'GET', url = '/', headers = {}, body = null, remoteAddress = '127.0.0.1'} = {}) => {
   const stream = new Readable({read(){}});
@@ -43,6 +47,7 @@ export const createMockRes = () => {
   };
 };
 
+// Legacy function for backward compatibility - will be deprecated
 export const withTempDir = async (fn) => {
   const dir = await mkdtemp(path.join(os.tmpdir(), 'kempo-tests-'));
   try {
@@ -52,6 +57,50 @@ export const withTempDir = async (fn) => {
   }
 };
 
+// New function that uses the persistent test server root as a base
+export const withTestDir = async (fn, {subdir = null} = {}) => {
+  const tempDir = await mkdtemp(path.join(os.tmpdir(), 'kempo-tests-'));
+  try {
+    // Copy the test server root to the temporary directory
+    await cp(TEST_SERVER_ROOT, tempDir, {recursive: true});
+    let workingDir = tempDir;
+    
+    if (subdir) {
+      workingDir = path.join(tempDir, subdir);
+    }
+    
+    return await fn(workingDir);
+  } finally {
+    await rm(tempDir, {recursive: true, force: true});
+  }
+};
+
+// Helper to get the path to a file in the test server root
+export const getTestFilePath = (relativePath) => {
+  return path.join(TEST_SERVER_ROOT, relativePath);
+};
+
+// Helper to reset or prepare specific test scenarios
+export const prepareTestScenario = async (dir, scenario) => {
+  switch (scenario) {
+    case 'basic-server':
+      // Already has index.html, api/GET.js, etc.
+      break;
+    case 'wildcard-routes':
+      await write(dir, 'docs/.config.json', JSON.stringify({
+        customRoutes: { '/src/**': '../src/**' }
+      }));
+      break;
+    case 'middleware':
+      await write(dir, '.config.json', JSON.stringify({
+        middleware: { cors: {enabled: true} }
+      }));
+      break;
+    default:
+      // No special preparation needed
+  }
+};
+
 export const write = async (root, rel, content = '') => {
   const full = path.join(root, rel);
   await mkdir(path.dirname(full), {recursive: true});

package/config-examples/development.config.json

@@ -1,24 +0,0 @@
-{
-  "_comment": "Development configuration with aggressive file watching and conservative memory usage",
-  "cache": {
-    "enabled": true,
-    "maxSize": 50,
-    "maxMemoryMB": 25,
-    "ttlMs": 300000,
-    "maxHeapUsagePercent": 65,
-    "memoryCheckInterval": 15000,
-    "watchFiles": true,
-    "enableMemoryMonitoring": true
-  },
-  "middleware": {
-    "cors": {
-      "enabled": true,
-      "origin": "*"
-    },
-    "logging": {
-      "enabled": true,
-      "includeUserAgent": true,
-      "includeResponseTime": true
-    }
-  }
-}

package/config-examples/low-memory.config.json

@@ -1,23 +0,0 @@
-{
-  "_comment": "Low-memory configuration for resource-constrained environments",
-  "cache": {
-    "enabled": true,
-    "maxSize": 20,
-    "maxMemoryMB": 5,
-    "ttlMs": 120000,
-    "maxHeapUsagePercent": 60,
-    "memoryCheckInterval": 10000,
-    "watchFiles": true,
-    "enableMemoryMonitoring": true
-  },
-  "middleware": {
-    "compression": {
-      "enabled": true,
-      "threshold": 512
-    },
-    "logging": {
-      "enabled": true,
-      "includeResponseTime": false
-    }
-  }
-}

package/config-examples/no-cache.config.json

@@ -1,13 +0,0 @@
-{
-  "_comment": "Cache disabled configuration for debugging or special environments",
-  "cache": {
-    "enabled": false
-  },
-  "middleware": {
-    "logging": {
-      "enabled": true,
-      "includeUserAgent": true,
-      "includeResponseTime": true
-    }
-  }
-}

package/config-examples/production.config.json

@@ -1,38 +0,0 @@
-{
-  "_comment": "Production configuration with large cache and disabled file watching",
-  "cache": {
-    "enabled": true,
-    "maxSize": 1000,
-    "maxMemoryMB": 200,
-    "ttlMs": 3600000,
-    "maxHeapUsagePercent": 85,
-    "memoryCheckInterval": 60000,
-    "watchFiles": false,
-    "enableMemoryMonitoring": true
-  },
-  "middleware": {
-    "cors": {
-      "enabled": true,
-      "origin": ["https://myapp.com", "https://www.myapp.com"],
-      "credentials": true
-    },
-    "compression": {
-      "enabled": true,
-      "threshold": 1024
-    },
-    "security": {
-      "enabled": true,
-      "headers": {
-        "X-Content-Type-Options": "nosniff",
-        "X-Frame-Options": "DENY",
-        "X-XSS-Protection": "1; mode=block",
-        "Strict-Transport-Security": "max-age=31536000; includeSubDomains"
-      }
-    },
-    "logging": {
-      "enabled": true,
-      "includeUserAgent": false,
-      "includeResponseTime": true
-    }
-  }
-}