kempo-server 1.10.2 → 1.10.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/{.github/copilot-instructions.md → AGENTS.md} +2 -16
- package/dist/requestWrapper.js +1 -1
- package/dist/router.js +1 -1
- package/package.json +6 -6
- package/src/requestWrapper.js +12 -0
- package/CONTRIBUTING.md +0 -136
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AGENTS
|
|
2
2
|
|
|
3
3
|
## Coding Style Guidelines
|
|
4
4
|
|
|
@@ -79,18 +79,4 @@ Create utility functions for shared logic.
|
|
|
79
79
|
Do not prefix identifiers with underscores.
|
|
80
80
|
- Never use leading underscores (`_`) for variable, property, method, or function names.
|
|
81
81
|
- Use clear, descriptive names without prefixes.
|
|
82
|
-
- When true privacy is needed inside classes, prefer native JavaScript private fields (e.g., `#myField`) instead of simulated privacy via underscores.
|
|
83
|
-
|
|
84
|
-
## Lit Components
|
|
85
|
-
|
|
86
|
-
### Component Architecture and Communication
|
|
87
|
-
|
|
88
|
-
- Use methods to cause actions; do not emit events to trigger logic. Events are for notifying that something already happened.
|
|
89
|
-
- Prefer `el.closest('ktf-test-framework')?.enqueueSuite({...})` over firing an `enqueue` event.
|
|
90
|
-
|
|
91
|
-
- Wrap dependent GUI components inside a parent `ktf-test-framework` element. Children find it via `closest('ktf-test-framework')` and call its methods. The framework can query its subtree to orchestrate children.
|
|
92
|
-
|
|
93
|
-
- Avoid `window` globals and global custom events for coordination. If broadcast is needed, scope events to the framework element; reserve window events for global, non-visual concerns (e.g., settings changes).
|
|
94
|
-
|
|
95
|
-
- Queued status must show the `scheduled` icon. Running may apply `animation="spin"`.
|
|
96
|
-
|
|
82
|
+
- When true privacy is needed inside classes, prefer native JavaScript private fields (e.g., `#myField`) instead of simulated privacy via underscores.
|
package/dist/requestWrapper.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{URL}from"url";export function createRequestWrapper(request,params={}){const url=new URL(request.url,`http://${request.headers.host||"localhost"}`),query=Object.fromEntries(url.searchParams);return{...request,_originalRequest:request,method:request.method,url:request.url,headers:request.headers,params:params,query:query,path:url.pathname,body:async()=>new Promise((resolve,reject)=>{let body="";request.on("data",chunk=>{body+=chunk.toString()}),request.on("end",()=>{resolve(body)}),request.on("error",reject)}),async json(){try{const body=await this.body();return JSON.parse(body)}catch(error){throw new Error("Invalid JSON in request body")}},async text(){return this.body()},buffer:async()=>new Promise((resolve,reject)=>{const chunks=[];request.on("data",chunk=>{chunks.push(chunk)}),request.on("end",()=>{resolve(Buffer.concat(chunks))}),request.on("error",reject)}),get:headerName=>request.headers[headerName.toLowerCase()],is(type){return(this.get("content-type")||"").includes(type)}}}export default createRequestWrapper;
|
|
1
|
+
import{URL}from"url";export function createRequestWrapper(request,params={}){const url=new URL(request.url,`http://${request.headers.host||"localhost"}`),query=Object.fromEntries(url.searchParams);return{...request,_originalRequest:request,method:request.method,url:request.url,headers:request.headers,params:params,query:query,path:url.pathname,cookies:(()=>{const cookieHeader=request.headers.cookie||request.headers.Cookie;return cookieHeader?cookieHeader.split(";").reduce((cookies,cookie)=>{const[name,...rest]=cookie.trim().split("=");return name&&(cookies[name]=rest.join("=")),cookies},{}):{}})(),body:async()=>new Promise((resolve,reject)=>{let body="";request.on("data",chunk=>{body+=chunk.toString()}),request.on("end",()=>{resolve(body)}),request.on("error",reject)}),async json(){try{const body=await this.body();return JSON.parse(body)}catch(error){throw new Error("Invalid JSON in request body")}},async text(){return this.body()},buffer:async()=>new Promise((resolve,reject)=>{const chunks=[];request.on("data",chunk=>{chunks.push(chunk)}),request.on("end",()=>{resolve(Buffer.concat(chunks))}),request.on("error",reject)}),get:headerName=>request.headers[headerName.toLowerCase()],is(type){return(this.get("content-type")||"").includes(type)}}}export default createRequestWrapper;
|
package/dist/router.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import path from"path";import{readFile}from"fs/promises";import{pathToFileURL}from"url";import defaultConfig from"./defaultConfig.js";import getFiles from"./getFiles.js";import findFile from"./findFile.js";import serveFile from"./serveFile.js";import MiddlewareRunner from"./middlewareRunner.js";import ModuleCache from"./moduleCache.js";import createRequestWrapper from"./requestWrapper.js";import createResponseWrapper from"./responseWrapper.js";import{corsMiddleware,compressionMiddleware,rateLimitMiddleware,securityMiddleware,loggingMiddleware}from"./builtinMiddleware.js";export default async(flags,log)=>{log("Initializing router",3);const rootPath=path.isAbsolute(flags.root)?flags.root:path.join(process.cwd(),flags.root);log(`Root path: ${rootPath}`,3);let config=defaultConfig;try{const configFileName=flags.config||".config.json",configPath=path.isAbsolute(configFileName)?configFileName:path.join(rootPath,configFileName);if(log(`Config file name: ${configFileName}`,3),log(`Config path: ${configPath}`,3),path.isAbsolute(configFileName))log("Config file name is absolute, skipping validation",4);else{const relativeConfigPath=path.relative(rootPath,configPath);if(log(`Relative config path: ${relativeConfigPath}`,4),log(`Starts with '..': ${relativeConfigPath.startsWith("..")}`,4),relativeConfigPath.startsWith("..")||path.isAbsolute(relativeConfigPath))throw log("Validation failed - throwing error",4),new Error(`Config file must be within the server root directory. Config path: ${configPath}, Root path: ${rootPath}`);log("Validation passed",4)}log(`Loading config from: ${configPath}`,3);const configContent=await readFile(configPath,"utf8"),userConfig=JSON.parse(configContent);config={...defaultConfig,...userConfig,allowedMimes:{...defaultConfig.allowedMimes,...userConfig.allowedMimes||{}},middleware:{...defaultConfig.middleware,...userConfig.middleware||{}},customRoutes:{...defaultConfig.customRoutes,...userConfig.customRoutes||{}},cache:{...defaultConfig.cache,...userConfig.cache||{}}},log("User config loaded and merged with defaults",3)}catch(e){if(e.message.includes("Config file must be within the server root directory"))throw e;log("Using default config (no config file found)",3)}const dis=new Set(config.disallowedRegex);dis.add("^/\\..*"),dis.add("\\.config$"),dis.add("\\.git/"),config.disallowedRegex=[...dis],log(`Config loaded with ${config.disallowedRegex.length} disallowed patterns`,3);let files=await getFiles(rootPath,config,log);log(`Initial scan found ${files.length} files`,2);const middlewareRunner=new MiddlewareRunner;if(config.middleware?.cors?.enabled&&(middlewareRunner.use(corsMiddleware(config.middleware.cors)),log("CORS middleware enabled",3)),config.middleware?.compression?.enabled&&(middlewareRunner.use(compressionMiddleware(config.middleware.compression)),log("Compression middleware enabled",3)),config.middleware?.rateLimit?.enabled&&(middlewareRunner.use(rateLimitMiddleware(config.middleware.rateLimit)),log("Rate limit middleware enabled",3)),config.middleware?.security?.enabled&&(middlewareRunner.use(securityMiddleware(config.middleware.security)),log("Security middleware enabled",3)),config.middleware?.logging?.enabled&&(middlewareRunner.use(loggingMiddleware(config.middleware.logging,log)),log("Logging middleware enabled",3)),config.middleware?.custom&&config.middleware.custom.length>0){log(`Loading ${config.middleware.custom.length} custom middleware files`,3);for(const middlewarePath of config.middleware.custom)try{const resolvedPath=path.isAbsolute(middlewarePath)?middlewarePath:path.resolve(rootPath,middlewarePath),customMiddleware=(await import(pathToFileURL(resolvedPath))).default;"function"==typeof customMiddleware?(middlewareRunner.use(customMiddleware(config.middleware)),log(`Custom middleware loaded: ${middlewarePath}`,3)):log(`Custom middleware error: ${middlewarePath} does not export a default function`,1)}catch(error){log(`Custom middleware error for ${middlewarePath}: ${error.message}`,1)}}let moduleCache=null;config.cache?.enabled&&(moduleCache=new ModuleCache(config.cache),log(`Module cache initialized: ${config.cache.maxSize} max modules, ${config.cache.maxMemoryMB}MB limit, ${config.cache.ttlMs}ms TTL`,2));const customRoutes=new Map,wildcardRoutes=new Map;if(config.customRoutes&&Object.keys(config.customRoutes).length>0){log(`Processing ${Object.keys(config.customRoutes).length} custom routes`,3);for(const[urlPath,filePath]of Object.entries(config.customRoutes))if(urlPath.includes("*")){const resolvedPath=path.isAbsolute(filePath)?filePath:path.resolve(rootPath,filePath);wildcardRoutes.set(urlPath,resolvedPath),log(`Wildcard route mapped: ${urlPath} -> ${resolvedPath}`,3)}else{const resolvedPath=path.isAbsolute(filePath)?filePath:path.resolve(rootPath,filePath);customRoutes.set(urlPath,resolvedPath),log(`Custom route mapped: ${urlPath} -> ${resolvedPath}`,3)}}const matchWildcardRoute=(requestPath,pattern)=>{const regexPattern=pattern.replace(/\*\*/g,"(.+)").replace(/\*/g,"([^/]+)");return new RegExp(`^${regexPattern}$`).exec(requestPath)},rescanAttempts=new Map,dynamicNoRescanPaths=new Set,shouldSkipRescan=requestPath=>config.noRescanPaths.some(pattern=>new RegExp(pattern).test(requestPath))?(log(`Skipping rescan for configured pattern: ${requestPath}`,3),!0):!!dynamicNoRescanPaths.has(requestPath)&&(log(`Skipping rescan for dynamically blacklisted path: ${requestPath}`,3),!0),handler=async(req,res)=>{const enhancedRequest=createRequestWrapper(req,{}),enhancedResponse=createResponseWrapper(res);await middlewareRunner.run(enhancedRequest,enhancedResponse,async()=>{const requestPath=enhancedRequest.url.split("?")[0];log(`${enhancedRequest.method} ${requestPath}`,4),log(`customRoutes keys: ${Array.from(customRoutes.keys()).join(", ")}`,4);const normalizePath=p=>{try{let np=decodeURIComponent(p);return np.startsWith("/")||(np="/"+np),np.length>1&&np.endsWith("/")&&(np=np.slice(0,-1)),np}catch(e){log(`Warning: Failed to decode URI component "${p}": ${e.message}`,1);let np=p;return np.startsWith("/")||(np="/"+np),np.length>1&&np.endsWith("/")&&(np=np.slice(0,-1)),np}},normalizedRequestPath=normalizePath(requestPath);log(`Normalized requestPath: ${normalizedRequestPath}`,4);let matchedKey=null;for(const key of customRoutes.keys())if(normalizePath(key)===normalizedRequestPath){matchedKey=key;break}if(matchedKey){const customFilePath=customRoutes.get(matchedKey);log(`Serving custom route: ${normalizedRequestPath} -> ${customFilePath}`,3);try{const{stat:stat}=await import("fs/promises");try{await stat(customFilePath),log(`Custom route file exists: ${customFilePath}`,4)}catch(e){return log(`Custom route file does NOT exist: ${customFilePath}`,1),res.writeHead(404,{"Content-Type":"text/plain"}),void res.end("Custom route file not found")}const fileExtension=path.extname(customFilePath).toLowerCase().slice(1),mimeConfig=config.allowedMimes[fileExtension];let mimeType,encoding;"string"==typeof mimeConfig?(mimeType=mimeConfig,encoding=mimeType.startsWith("text/")?"utf8":void 0):(mimeType=mimeConfig?.mime||"application/octet-stream",encoding="utf8"===mimeConfig?.encoding?"utf8":void 0);const fileContent=await readFile(customFilePath,encoding);log(`Serving custom file as ${mimeType} (${fileContent.length} bytes)`,2);const contentType="utf8"===encoding&&mimeType.startsWith("text/")?`${mimeType}; charset=utf-8`:mimeType;return res.writeHead(200,{"Content-Type":contentType}),void res.end(fileContent)}catch(error){return log(`Error serving custom route ${normalizedRequestPath}: ${error.message}`,1),res.writeHead(500,{"Content-Type":"text/plain"}),void res.end("Internal Server Error")}}const wildcardMatch=(requestPath=>{for(const[pattern,filePath]of wildcardRoutes){const matches=matchWildcardRoute(requestPath,pattern);if(matches)return{filePath:filePath,matches:matches}}return null})(requestPath);if(wildcardMatch){const resolvedFilePath=((filePath,matches)=>{let resolvedPath=filePath,matchIndex=1;for(;resolvedPath.includes("**")&&matchIndex<matches.length;)resolvedPath=resolvedPath.replace("**",matches[matchIndex]),matchIndex++;for(;resolvedPath.includes("*")&&matchIndex<matches.length;)resolvedPath=resolvedPath.replace("*",matches[matchIndex]),matchIndex++;return path.isAbsolute(resolvedPath)?resolvedPath:path.resolve(rootPath,resolvedPath)})(wildcardMatch.filePath,wildcardMatch.matches);log(`Serving wildcard route: ${requestPath} -> ${resolvedFilePath}`,3);try{const fileExtension=path.extname(resolvedFilePath).toLowerCase().slice(1),mimeConfig=config.allowedMimes[fileExtension];let mimeType,encoding;"string"==typeof mimeConfig?(mimeType=mimeConfig,encoding=mimeType.startsWith("text/")?"utf8":void 0):(mimeType=mimeConfig?.mime||"application/octet-stream",encoding="utf8"===mimeConfig?.encoding?"utf8":void 0);const fileContent=await readFile(resolvedFilePath,encoding);log(`Serving wildcard file as ${mimeType} (${fileContent.length} bytes)`,4);const contentType="utf8"===encoding&&mimeType.startsWith("text/")?`${mimeType}; charset=utf-8`:mimeType;return res.writeHead(200,{"Content-Type":contentType}),void res.end(fileContent)}catch(error){if("ENOENT"!==error.code)return log(`Error serving wildcard route ${requestPath}: ${error.message}`,1),enhancedResponse.writeHead(500,{"Content-Type":"text/plain"}),void enhancedResponse.end("Internal Server Error");log(`Wildcard route file not found: ${requestPath}`,2)}}const served=await serveFile(files,rootPath,requestPath,req.method,config,req,res,log,moduleCache);if(!served&&config.maxRescanAttempts>0&&!shouldSkipRescan(requestPath)){log("File not found, rescanning directory...",1),files=await getFiles(rootPath,config,log),log(`Rescan found ${files.length} files`,2);await serveFile(files,rootPath,requestPath,enhancedRequest.method,config,enhancedRequest,enhancedResponse,log,moduleCache)?rescanAttempts.delete(requestPath):((requestPath=>{const newAttempts=(rescanAttempts.get(requestPath)||0)+1;rescanAttempts.set(requestPath,newAttempts),newAttempts>config.maxRescanAttempts&&(dynamicNoRescanPaths.add(requestPath),log(`Path ${requestPath} added to dynamic blacklist after ${newAttempts} failed attempts`,1)),log(`Rescan attempt ${newAttempts}/${config.maxRescanAttempts} for: ${requestPath}`,3)})(requestPath),log(`404 - File not found after rescan: ${requestPath}`,1),enhancedResponse.writeHead(404,{"Content-Type":"text/plain"}),enhancedResponse.end("Not Found"))}else served||(shouldSkipRescan(requestPath)?log(`404 - Skipped rescan for: ${requestPath}`,2):log(`404 - File not found: ${requestPath}`,1),enhancedResponse.writeHead(404,{"Content-Type":"text/plain"}),enhancedResponse.end("Not Found"))})};return handler.moduleCache=moduleCache,handler.getStats=()=>moduleCache?.getStats()||null,handler.logCacheStats=()=>moduleCache?.logStats(log),handler.clearCache=()=>moduleCache?.clear(),handler};
|
|
1
|
+
import path from"path";import{readFile}from"fs/promises";import{pathToFileURL}from"url";import defaultConfig from"./defaultConfig.js";import getFiles from"./getFiles.js";import findFile from"./findFile.js";import serveFile from"./serveFile.js";import MiddlewareRunner from"./middlewareRunner.js";import ModuleCache from"./moduleCache.js";import createRequestWrapper from"./requestWrapper.js";import createResponseWrapper from"./responseWrapper.js";import{corsMiddleware,compressionMiddleware,rateLimitMiddleware,securityMiddleware,loggingMiddleware}from"./builtinMiddleware.js";export default async(flags,log)=>{log("Initializing router",3);const rootPath=path.isAbsolute(flags.root)?flags.root:path.join(process.cwd(),flags.root);log(`Root path: ${rootPath}`,3);let config=defaultConfig;try{const configFileName=flags.config||".config.json",configPath=path.isAbsolute(configFileName)?configFileName:path.join(rootPath,configFileName);if(log(`Config file name: ${configFileName}`,3),log(`Config path: ${configPath}`,3),path.isAbsolute(configFileName))log("Config file name is absolute, skipping validation",4);else{const relativeConfigPath=path.relative(rootPath,configPath);if(log(`Relative config path: ${relativeConfigPath}`,4),log(`Starts with '..': ${relativeConfigPath.startsWith("..")}`,4),relativeConfigPath.startsWith("..")||path.isAbsolute(relativeConfigPath))throw log("Validation failed - throwing error",4),new Error(`Config file must be within the server root directory. Config path: ${configPath}, Root path: ${rootPath}`);log("Validation passed",4)}log(`Loading config from: ${configPath}`,3);const configContent=await readFile(configPath,"utf8"),userConfig=JSON.parse(configContent);config={...defaultConfig,...userConfig,allowedMimes:{...defaultConfig.allowedMimes,...userConfig.allowedMimes||{}},middleware:{...defaultConfig.middleware,...userConfig.middleware||{}},customRoutes:{...defaultConfig.customRoutes,...userConfig.customRoutes||{}},cache:{...defaultConfig.cache,...userConfig.cache||{}}},log("User config loaded and merged with defaults",3)}catch(e){if(e.message.includes("Config file must be within the server root directory"))throw e;log("Using default config (no config file found)",3)}const dis=new Set(config.disallowedRegex);dis.add("^/\\..*"),dis.add("\\.config$"),dis.add("\\.git/"),config.disallowedRegex=[...dis],log(`Config loaded with ${config.disallowedRegex.length} disallowed patterns`,3);let files=await getFiles(rootPath,config,log);log(`Initial scan found ${files.length} files`,2);const middlewareRunner=new MiddlewareRunner;if(config.middleware?.cors?.enabled&&(middlewareRunner.use(corsMiddleware(config.middleware.cors)),log("CORS middleware enabled",3)),config.middleware?.compression?.enabled&&(middlewareRunner.use(compressionMiddleware(config.middleware.compression)),log("Compression middleware enabled",3)),config.middleware?.rateLimit?.enabled&&(middlewareRunner.use(rateLimitMiddleware(config.middleware.rateLimit)),log("Rate limit middleware enabled",3)),config.middleware?.security?.enabled&&(middlewareRunner.use(securityMiddleware(config.middleware.security)),log("Security middleware enabled",3)),config.middleware?.logging?.enabled&&(middlewareRunner.use(loggingMiddleware(config.middleware.logging,log)),log("Logging middleware enabled",3)),config.middleware?.custom&&config.middleware.custom.length>0){log(`Loading ${config.middleware.custom.length} custom middleware files`,3);for(const middlewarePath of config.middleware.custom)try{const resolvedPath=path.isAbsolute(middlewarePath)?middlewarePath:path.resolve(rootPath,middlewarePath),middlewareUrl=pathToFileURL(resolvedPath).href+`?t=${Date.now()}`,customMiddleware=(await import(middlewareUrl)).default;"function"==typeof customMiddleware?(middlewareRunner.use(customMiddleware(config.middleware)),log(`Custom middleware loaded: ${middlewarePath}`,3)):log(`Custom middleware error: ${middlewarePath} does not export a default function`,1)}catch(error){log(`Custom middleware error for ${middlewarePath}: ${error.message}`,1)}}let moduleCache=null;config.cache?.enabled&&(moduleCache=new ModuleCache(config.cache),log(`Module cache initialized: ${config.cache.maxSize} max modules, ${config.cache.maxMemoryMB}MB limit, ${config.cache.ttlMs}ms TTL`,2));const customRoutes=new Map,wildcardRoutes=new Map;if(config.customRoutes&&Object.keys(config.customRoutes).length>0){log(`Processing ${Object.keys(config.customRoutes).length} custom routes`,3);for(const[urlPath,filePath]of Object.entries(config.customRoutes))if(urlPath.includes("*")){const resolvedPath=path.isAbsolute(filePath)?filePath:path.resolve(rootPath,filePath);wildcardRoutes.set(urlPath,resolvedPath),log(`Wildcard route mapped: ${urlPath} -> ${resolvedPath}`,3)}else{const resolvedPath=path.isAbsolute(filePath)?filePath:path.resolve(rootPath,filePath);customRoutes.set(urlPath,resolvedPath),log(`Custom route mapped: ${urlPath} -> ${resolvedPath}`,3)}}const matchWildcardRoute=(requestPath,pattern)=>{const regexPattern=pattern.replace(/\*\*/g,"(.+)").replace(/\*/g,"([^/]+)");return new RegExp(`^${regexPattern}$`).exec(requestPath)},rescanAttempts=new Map,dynamicNoRescanPaths=new Set,shouldSkipRescan=requestPath=>config.noRescanPaths.some(pattern=>new RegExp(pattern).test(requestPath))?(log(`Skipping rescan for configured pattern: ${requestPath}`,3),!0):!!dynamicNoRescanPaths.has(requestPath)&&(log(`Skipping rescan for dynamically blacklisted path: ${requestPath}`,3),!0),handler=async(req,res)=>{const enhancedRequest=createRequestWrapper(req,{}),enhancedResponse=createResponseWrapper(res);await middlewareRunner.run(enhancedRequest,enhancedResponse,async()=>{const requestPath=enhancedRequest.url.split("?")[0];log(`${enhancedRequest.method} ${requestPath}`,4),log(`customRoutes keys: ${Array.from(customRoutes.keys()).join(", ")}`,4);const normalizePath=p=>{try{let np=decodeURIComponent(p);return np.startsWith("/")||(np="/"+np),np.length>1&&np.endsWith("/")&&(np=np.slice(0,-1)),np}catch(e){log(`Warning: Failed to decode URI component "${p}": ${e.message}`,1);let np=p;return np.startsWith("/")||(np="/"+np),np.length>1&&np.endsWith("/")&&(np=np.slice(0,-1)),np}},normalizedRequestPath=normalizePath(requestPath);log(`Normalized requestPath: ${normalizedRequestPath}`,4);let matchedKey=null;for(const key of customRoutes.keys())if(normalizePath(key)===normalizedRequestPath){matchedKey=key;break}if(matchedKey){const customFilePath=customRoutes.get(matchedKey);log(`Serving custom route: ${normalizedRequestPath} -> ${customFilePath}`,3);try{const{stat:stat}=await import("fs/promises");try{await stat(customFilePath),log(`Custom route file exists: ${customFilePath}`,4)}catch(e){return log(`Custom route file does NOT exist: ${customFilePath}`,1),res.writeHead(404,{"Content-Type":"text/plain"}),void res.end("Custom route file not found")}const fileExtension=path.extname(customFilePath).toLowerCase().slice(1),mimeConfig=config.allowedMimes[fileExtension];let mimeType,encoding;"string"==typeof mimeConfig?(mimeType=mimeConfig,encoding=mimeType.startsWith("text/")?"utf8":void 0):(mimeType=mimeConfig?.mime||"application/octet-stream",encoding="utf8"===mimeConfig?.encoding?"utf8":void 0);const fileContent=await readFile(customFilePath,encoding);log(`Serving custom file as ${mimeType} (${fileContent.length} bytes)`,2);const contentType="utf8"===encoding&&mimeType.startsWith("text/")?`${mimeType}; charset=utf-8`:mimeType;return res.writeHead(200,{"Content-Type":contentType}),void res.end(fileContent)}catch(error){return log(`Error serving custom route ${normalizedRequestPath}: ${error.message}`,1),res.writeHead(500,{"Content-Type":"text/plain"}),void res.end("Internal Server Error")}}const wildcardMatch=(requestPath=>{for(const[pattern,filePath]of wildcardRoutes){const matches=matchWildcardRoute(requestPath,pattern);if(matches)return{filePath:filePath,matches:matches}}return null})(requestPath);if(wildcardMatch){const resolvedFilePath=((filePath,matches)=>{let resolvedPath=filePath,matchIndex=1;for(;resolvedPath.includes("**")&&matchIndex<matches.length;)resolvedPath=resolvedPath.replace("**",matches[matchIndex]),matchIndex++;for(;resolvedPath.includes("*")&&matchIndex<matches.length;)resolvedPath=resolvedPath.replace("*",matches[matchIndex]),matchIndex++;return path.isAbsolute(resolvedPath)?resolvedPath:path.resolve(rootPath,resolvedPath)})(wildcardMatch.filePath,wildcardMatch.matches);log(`Serving wildcard route: ${requestPath} -> ${resolvedFilePath}`,3);try{const fileExtension=path.extname(resolvedFilePath).toLowerCase().slice(1),mimeConfig=config.allowedMimes[fileExtension];let mimeType,encoding;"string"==typeof mimeConfig?(mimeType=mimeConfig,encoding=mimeType.startsWith("text/")?"utf8":void 0):(mimeType=mimeConfig?.mime||"application/octet-stream",encoding="utf8"===mimeConfig?.encoding?"utf8":void 0);const fileContent=await readFile(resolvedFilePath,encoding);log(`Serving wildcard file as ${mimeType} (${fileContent.length} bytes)`,4);const contentType="utf8"===encoding&&mimeType.startsWith("text/")?`${mimeType}; charset=utf-8`:mimeType;return res.writeHead(200,{"Content-Type":contentType}),void res.end(fileContent)}catch(error){if("ENOENT"!==error.code)return log(`Error serving wildcard route ${requestPath}: ${error.message}`,1),enhancedResponse.writeHead(500,{"Content-Type":"text/plain"}),void enhancedResponse.end("Internal Server Error");log(`Wildcard route file not found: ${requestPath}`,2)}}const served=await serveFile(files,rootPath,requestPath,req.method,config,req,res,log,moduleCache);if(!served&&config.maxRescanAttempts>0&&!shouldSkipRescan(requestPath)){log("File not found, rescanning directory...",1),files=await getFiles(rootPath,config,log),log(`Rescan found ${files.length} files`,2);await serveFile(files,rootPath,requestPath,enhancedRequest.method,config,enhancedRequest,enhancedResponse,log,moduleCache)?rescanAttempts.delete(requestPath):((requestPath=>{const newAttempts=(rescanAttempts.get(requestPath)||0)+1;rescanAttempts.set(requestPath,newAttempts),newAttempts>config.maxRescanAttempts&&(dynamicNoRescanPaths.add(requestPath),log(`Path ${requestPath} added to dynamic blacklist after ${newAttempts} failed attempts`,1)),log(`Rescan attempt ${newAttempts}/${config.maxRescanAttempts} for: ${requestPath}`,3)})(requestPath),log(`404 - File not found after rescan: ${requestPath}`,1),enhancedResponse.writeHead(404,{"Content-Type":"text/plain"}),enhancedResponse.end("Not Found"))}else served||(shouldSkipRescan(requestPath)?log(`404 - Skipped rescan for: ${requestPath}`,2):log(`404 - File not found: ${requestPath}`,1),enhancedResponse.writeHead(404,{"Content-Type":"text/plain"}),enhancedResponse.end("Not Found"))})};return handler.moduleCache=moduleCache,handler.getStats=()=>moduleCache?.getStats()||null,handler.logCacheStats=()=>moduleCache?.logStats(log),handler.clearCache=()=>moduleCache?.clear(),handler};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "kempo-server",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "1.10.
|
|
4
|
+
"version": "1.10.4",
|
|
5
5
|
"description": "A lightweight, zero-dependency, file based routing server.",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
7
|
"exports": {
|
|
@@ -15,15 +15,15 @@
|
|
|
15
15
|
"scripts": {
|
|
16
16
|
"build": "node scripts/build.js",
|
|
17
17
|
"docs": "node dist/index.js -r ./docs",
|
|
18
|
-
"
|
|
19
|
-
"
|
|
20
|
-
"
|
|
21
|
-
"
|
|
18
|
+
"test": "npx kempo-test",
|
|
19
|
+
"test:gui": "npx kempo-test --gui",
|
|
20
|
+
"test:browser": "npx kempo-test -b",
|
|
21
|
+
"test:node": "npx kempo-test -n"
|
|
22
22
|
},
|
|
23
23
|
"author": "",
|
|
24
24
|
"license": "ISC",
|
|
25
25
|
"devDependencies": {
|
|
26
|
-
"kempo-testing-framework": "^1.
|
|
26
|
+
"kempo-testing-framework": "^1.4.4",
|
|
27
27
|
"terser": "^5.43.1"
|
|
28
28
|
},
|
|
29
29
|
"repository": {
|
package/src/requestWrapper.js
CHANGED
|
@@ -11,6 +11,17 @@ export function createRequestWrapper(request, params = {}) {
|
|
|
11
11
|
const url = new URL(request.url, `http://${request.headers.host || 'localhost'}`);
|
|
12
12
|
const query = Object.fromEntries(url.searchParams);
|
|
13
13
|
|
|
14
|
+
const parseCookies = () => {
|
|
15
|
+
const cookieHeader = request.headers.cookie || request.headers.Cookie;
|
|
16
|
+
if(!cookieHeader) return {};
|
|
17
|
+
|
|
18
|
+
return cookieHeader.split(';').reduce((cookies, cookie) => {
|
|
19
|
+
const [name, ...rest] = cookie.trim().split('=');
|
|
20
|
+
if(name) cookies[name] = rest.join('=');
|
|
21
|
+
return cookies;
|
|
22
|
+
}, {});
|
|
23
|
+
};
|
|
24
|
+
|
|
14
25
|
// Create the enhanced request object
|
|
15
26
|
const enhancedRequest = {
|
|
16
27
|
// Original request properties and methods
|
|
@@ -24,6 +35,7 @@ export function createRequestWrapper(request, params = {}) {
|
|
|
24
35
|
params,
|
|
25
36
|
query,
|
|
26
37
|
path: url.pathname,
|
|
38
|
+
cookies: parseCookies(),
|
|
27
39
|
|
|
28
40
|
// Body parsing methods
|
|
29
41
|
async body() {
|
package/CONTRIBUTING.md
DELETED
|
@@ -1,136 +0,0 @@
|
|
|
1
|
-
# Code Contribution Guidelines
|
|
2
|
-
|
|
3
|
-
## Coding Style Guidelines
|
|
4
|
-
|
|
5
|
-
### Code Organization
|
|
6
|
-
Use multi-line comments to separate code into logical sections. Group related functionality together.
|
|
7
|
-
- Example: In Lit components, group lifecycle callbacks, event handlers, public methods, utility functions, and rendering logic separately.
|
|
8
|
-
|
|
9
|
-
```javascript
|
|
10
|
-
/*
|
|
11
|
-
Lifecycle Callbacks
|
|
12
|
-
*/
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
### Avoid single-use variables/functions
|
|
16
|
-
Avoid defining a variable or function to only use it once; inline the logic where needed. Some exceptions include:
|
|
17
|
-
- recursion
|
|
18
|
-
- scope encapsulation (IIFE)
|
|
19
|
-
- context changes
|
|
20
|
-
|
|
21
|
-
### Minimal Comments, Empty Lines, and Spacing
|
|
22
|
-
|
|
23
|
-
Use minimal comments. Assume readers understand the language. Some exceptions include:
|
|
24
|
-
- complex logic
|
|
25
|
-
- anti-patterns
|
|
26
|
-
- code organization
|
|
27
|
-
|
|
28
|
-
Do not put random empty lines within code; put them where they make sense for readability, for example:
|
|
29
|
-
- above and below definitions for functions and classes.
|
|
30
|
-
- to help break up large sections of logic to be more readable. If there are 100 lines of code with no breaks, it gets hard to read.
|
|
31
|
-
- above multi-line comments to indicate the comment belongs to the code below
|
|
32
|
-
|
|
33
|
-
No empty lines in css.
|
|
34
|
-
|
|
35
|
-
End each file with an empty line.
|
|
36
|
-
|
|
37
|
-
End each line with a `;` when possible, even if it is optional.
|
|
38
|
-
|
|
39
|
-
Avoid unnecessary spacing, for example:
|
|
40
|
-
- after the word `if`
|
|
41
|
-
- within parentheses for conditional statements
|
|
42
|
-
|
|
43
|
-
```javascript
|
|
44
|
-
let count = 1;
|
|
45
|
-
|
|
46
|
-
const incrementOdd = (n) => {
|
|
47
|
-
if(n % 2 !== 0){
|
|
48
|
-
return n++;
|
|
49
|
-
}
|
|
50
|
-
return n;
|
|
51
|
-
};
|
|
52
|
-
|
|
53
|
-
count = incrementOdd(count);
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
### Prefer Arrow Functions
|
|
57
|
-
Prefer the use of arrow functions when possible, especially for class methods to avoid binding. Use normal functions if needed for preserving the proper context.
|
|
58
|
-
- For very basic logic, use implicit returns
|
|
59
|
-
- If there is a single parameter, omit the parentheses.
|
|
60
|
-
```javascript
|
|
61
|
-
const addOne = n => n + 1;
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### Module Exports
|
|
65
|
-
- If a module has only one export, use the "default" export, not a named export.
|
|
66
|
-
- Do not declare the default export as a const or give it a name; just export the value.
|
|
67
|
-
|
|
68
|
-
```javascript
|
|
69
|
-
export default (n) => n + 1;
|
|
70
|
-
```
|
|
71
|
-
- If a module has multiple exports, use named exports and do not use a "default" export.
|
|
72
|
-
|
|
73
|
-
### Code Reuse
|
|
74
|
-
Create utility functions for shared logic.
|
|
75
|
-
- If the shared logic is used in a single file, define a utility function in that file.
|
|
76
|
-
- If the shared logic is used in multiple files, create a utility function module file in `src/utils/`.
|
|
77
|
-
|
|
78
|
-
### Naming
|
|
79
|
-
Do not prefix identifiers with underscores.
|
|
80
|
-
- Never use leading underscores (`_`) for variable, property, method, or function names.
|
|
81
|
-
- Use clear, descriptive names without prefixes.
|
|
82
|
-
- When true privacy is needed inside classes, prefer native JavaScript private fields (e.g., `#myField`) instead of simulated privacy via underscores.
|
|
83
|
-
|
|
84
|
-
## Lit Components
|
|
85
|
-
|
|
86
|
-
### Component Architecture and Communication
|
|
87
|
-
|
|
88
|
-
- Use methods to cause actions; do not emit events to trigger logic. Events are for notifying that something already happened.
|
|
89
|
-
- Prefer `el.closest('ktf-test-framework')?.enqueueSuite({...})` over firing an `enqueue` event.
|
|
90
|
-
|
|
91
|
-
- Wrap dependent GUI components inside a parent `ktf-test-framework` element. Children find it via `closest('ktf-test-framework')` and call its methods. The framework can query its subtree to orchestrate children.
|
|
92
|
-
|
|
93
|
-
- Avoid `window` globals and global custom events for coordination. If broadcast is needed, scope events to the framework element; reserve window events for global, non-visual concerns (e.g., settings changes).
|
|
94
|
-
|
|
95
|
-
- Queued status must show the `scheduled` icon. Running may apply `animation="spin"`.
|
|
96
|
-
|
|
97
|
-
## Version Management and Publishing
|
|
98
|
-
|
|
99
|
-
This project uses automated workflows for version management and publishing to npm. There are three different workflows available:
|
|
100
|
-
|
|
101
|
-
### Automatic Patch Publishing
|
|
102
|
-
- **Workflow**: `publish-npm.yml`
|
|
103
|
-
- **Trigger**: Automatically runs on every push to `main` branch
|
|
104
|
-
- **Action**: Increments patch version (e.g., 1.5.1 → 1.5.2) and publishes to npm
|
|
105
|
-
- **Use for**: Bug fixes, small changes, documentation updates
|
|
106
|
-
|
|
107
|
-
### Manual Minor Version Publishing
|
|
108
|
-
- **Workflow**: `publish-minor.yml`
|
|
109
|
-
- **Trigger**: Manual workflow dispatch from GitHub Actions tab
|
|
110
|
-
- **Action**: Increments minor version (e.g., 1.5.2 → 1.6.0) and publishes to npm
|
|
111
|
-
- **Use for**: New features, backwards-compatible API additions
|
|
112
|
-
|
|
113
|
-
### Manual Major Version Publishing
|
|
114
|
-
- **Workflow**: `publish-major.yml`
|
|
115
|
-
- **Trigger**: Manual workflow dispatch from GitHub Actions tab
|
|
116
|
-
- **Action**: Increments major version (e.g., 1.6.0 → 2.0.0) and publishes to npm
|
|
117
|
-
- **Use for**: Breaking changes, major API overhauls
|
|
118
|
-
|
|
119
|
-
### How to Publish Minor or Major Versions
|
|
120
|
-
|
|
121
|
-
1. **Push your changes to main**: The automatic patch workflow will run and increment the patch version
|
|
122
|
-
2. **Go to GitHub Actions tab** in the repository
|
|
123
|
-
3. **Select the appropriate workflow**:
|
|
124
|
-
- "Publish Minor Version to npmjs" for minor bumps
|
|
125
|
-
- "Publish Major Version to npmjs" for major bumps
|
|
126
|
-
4. **Click "Run workflow"** button
|
|
127
|
-
5. **Confirm the run**: The workflow will increment the version and publish automatically
|
|
128
|
-
|
|
129
|
-
**Example workflow for a minor version**:
|
|
130
|
-
- Current version: 1.5.1
|
|
131
|
-
- Push changes → Auto patch: 1.5.1 → 1.5.2
|
|
132
|
-
- Manually run minor workflow: 1.5.2 → 1.6.0
|
|
133
|
-
- Final published version: 1.6.0
|
|
134
|
-
|
|
135
|
-
**Note**: You will "use up" one patch version number when doing manual minor/major bumps, but this ensures the automated system continues to work smoothly.
|
|
136
|
-
|