A fast and optimized middleware server with an absurdly small amount of code (300 lines) built on top of Deno's native HTTP APIs with no dependencies. It also has a collection of useful middlewares: log file, serve static, CORS, session, rate limit, token, body parsers, redirect, proxy and handle upload. In "README" there are examples of all the resources. Faster's ideology is: all you need is an optimized middleware manager, all other functionality is middleware.
The middleware is built on top of Deno's native HTTP APIs, see the benchmarks ('hello word' server):
Machine: 8 GiB, Intel® Core™ i5-10210U CPU @ 2.11GHz × 4
method: autocannon -c 100 -d 40 -p 10 localhost:80. Deno v1.19.3, Ubuntu
20.04 LTS.
| Framework | Version | Router? | Results |
|---|---|---|---|
| Express | 4.17.3 | ✓ | 167k requests in 40.11s, 29 MB read |
| Fastify | 3.27.4 | ✓ | 1105k requests in 40.07s ,193 MB read |
| Oak | 10.4.0 | ✓ | 260k requests in 40.09s, 45 MB read |
| Faster | 5.7 | ✓ | 1432k requests in 40.17s, 250 MB read |
Note that in addition to performance, Faster is a very complete framework considering its middleware collection.
Static (/foo, /foo/bar)
Parameter (/:title, /books/:title, /books/:genre/:title)
Parameter w/ Suffix (/movies/:title.mp4, /movies/:title.(mp4|mov))
Optional Parameters (/:title?, /books/:title?, /books/:genre/:title?)
Wildcards (*, /books/*, /books/:genre/*)
import{req,res,Server}from"https://deno.land/x/faster/mod.ts";constserver=newServer();server.post("/example_json",res("json"),req("json"),async(ctx: any,next: any)=>{console.log(ctx.body);ctx.res.body={msg: "json response example"};awaitnext();},);awaitserver.listen({port: 80});server.get("/example_html",res("html"),async(ctx: any,next: any)=>{ctx.res.body=` <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>title example</title> </head> </body> HTML body example <body> </html> `;awaitnext();},);server.get("/example_params/:ex1?foo=bar",async(ctx: any,next: any)=>{console.log(ctx.params.ex1);console.log(ctx.url.searchParams.get("foo"));//you can explore the URL (ctx.url) objectawaitnext();},);import{Cookie,deleteCookie,getCookies,Server,setCookie,}from"https://deno.land/x/faster/mod.ts";//alias to deno stdserver.get("/cookies",async(ctx: any,next: any)=>{setCookie(ctx.res.headers,{name: "user_name",value: "San"});//explore interface 'Cookie' for more optionsdeleteCookie(ctx.res.headers,"last_order");console.log(getCookies(ctx.req.headers));awaitnext();},);server.get("/redirect_example",async(ctx: any,next: any)=>{ctx.redirect("/my_custom_url_or_path");awaitnext();},);This project has a standard set of middleware useful for most cases.
Example:
server.use(logger());You can pass custom log file:
logger("./my_dir/my_custom_log.txt");Example:
server.post("/example_parsers",res("json"),//Response parserreq("json"),//Request parserasync(ctx: any,next: any)=>{console.log(ctx.body);//the original (no parser) body is in ctx.req.bodyctx.res.body={msg: "json response example"};awaitnext();},);The current supported options for "req" are: "arrayBuffer", "blob", "formData", "json", "text".
The current supported options for "res" are: "json", "html", "javascript".
If there are no parsers for your data, don't worry, you can handle the data manually, Ex:
server.post("/upload",async(ctx: any,next: any)=>{ctx.res.headers.set("Content-Type","application/json",);constdata=awaitexCustomParseBody(ctx.req.body);//do what you want with ctx.req.bodyctx.res.body=JSON.stringify({msg: "ok"});// //ctx.res.body can also be other data types such as streams, bytes and etc.awaitnext();},);Example:
server.use(rateLimit());OPTIONS (with default values):
rateLimit({attempts: 30,interval: 10,maxTableSize: 100000,id: (ctx: Context)=>JSON.stringify(ctx.conn.remoteAddr),});Example (must end with "/*"):
server.get("/pub/*",serveStatic("./pub"),);Example:
server.options("/example_cors",setCORS());//enable pre-fligh requestserver.get("/example_cors",setCORS(),async(ctx,next)=>{awaitnext();},);You can pass valid hosts to cors function:
setCORS("http://my.custom.url:8080");This middleware is encapsulated in an entire static class. It uses Bearer Token and default options with the "HS256" algorithm, and generates a random secret when starting the application (you can also set a secret manually). Ex:
server.get("/example_verify_token",//send token to server in Header => Authorization: Bearer TOKENToken.middleware,async(ctx,next)=>{console.log(ctx.extra.tokenPayload);console.log(ctx.extra.token);awaitnext();},);Generate Token ex:
awaitToken.generate({user_id: "172746"},null);//null to never expire, this parameter defaults to "1h"Set secret ex:
Token.setSecret("a3d2r366wgb3dh6yrwzw99kzx2");//Do this at the beginning of your applicationGet token payload out of middleware:
awaitToken.getPayload("YOUR_TOKEN_STRING");//Ex: use for get token data from token string in URL parameter.You can also use the static method Token.setConfigs.
Ex:
server.get("/my_url_1",redirect("/my_url_2"),//or the full url);Ex:
server.use(session());//in routes:server.get("/session_example",async(ctx,next)=>{console.log(ctx.extra.session);//get session datactx.extra.session.foo="bar";//set session dataawaitnext();},);OPTIONS (with default values):
session(engine: SessionStorageEngine = new SQLiteStorageEngine(60)) //60 is 60 minutes to expire session
Ex:
server.use(proxy({url: "https://my-url-example.com"}));In routes:
server.get("/proxy_example",async(ctx,next)=>{console.log(ctx.req);//req has changed as it now points to the proxyconsole.log(ctx.res);//res has changed because now it has the proxy answer//OR if replaceReqAndRes = falseconsole.log(ctx.extra.proxyReq);console.log(ctx.extra.proxyRes);awaitnext();},);Or proxy in specific route:
server.get("/proxy_example",proxy({url: "https://my-url-example.com/proxy_ex2",replaceProxyPath: false,//specific proxy route for the route "/proxy_example"}),async(ctx,next)=>{console.log(ctx.req);//req has changed as it now points to the proxyconsole.log(ctx.res);//res has changed because now it has the proxy answerawaitnext();},);Conditional proxy:
server.get("/proxy_example",proxy({url: "https://my-url-example.com/proxy_ex3",condition: (ctx)=>{if(ctx.url.searchParams.get("foo")){returntrue;}else{returnfalse;}},}),async(ctx,next)=>{console.log(ctx.extra.proxied);//will be true if proxy condition is trueconsole.log(ctx.req);//req has changed as it now points to the proxyconsole.log(ctx.res);//res has changed because now it has the proxy answerawaitnext();},);OPTIONS (with default values):
proxy(url: string, replaceReqAndRes: true, replaceProxyPath: true, condition: : (ctx: Context) => true )
Do not use "res body parsers" with 'replaceReqAndRes: true' (default) !!!
If you don't use Request body information before the proxy or in your condition, don't use "req body parsers" as this will increase the processing cost !!!
This middleware automatically organizes uploads to avoid file system problems and create dirs if not exists, perform validations and optimizes ram usage when uploading large files using Deno standard libraries!
Ex:
.post("/upload",upload(),async(ctx: any,next: any)=>{ ...Ex (with custom options):
.post("/upload",upload({path: 'uploads_custom_dir',extensions: ['jpg','png'],maxSizeBytes: 20000000,maxFileSizeBytes: 10000000,saveFile: true,readFile: false,useCurrentDir: true}),async(ctx: any,next: any)=>{ ...Request must contains a body with form type "multipart/form-data", and inputs with type="file".
Ex (pre validation):
.post("/pre_upload",preUploadValidate(["jpg","png"],20000000,10000000),async(ctx: any,next: any)=>{ ...Pre validation options:
preUploadValidate(
extensions: Array<string> = [],
maxSizeBytes: number = Number.MAX_SAFE_INTEGER,
maxFileSizeBytes: number = Number.MAX_SAFE_INTEGER,
)
Below an frontend example to work with AJAX, also accepting type="file" multiple:
varfiles=document.querySelector("#yourFormId input[type=file]").files;varname=document.querySelector("#yourFormId input[type=file]").getAttribute("name",);varform=newFormData();for(vari=0;i<files.length;i++){form.append(`${name}_${i}`,files[i]);}varres=awaitfetch("/upload",{//Fetch API automatically puts the form in the format "multipart/form-data".method: "POST",body: form,}).then((response)=>response.json());console.log(res);//VALIDATIONS --------------varvalidationData={};for(vari=0;i<files.length;i++){varnewObj={//newObj is needed, JSON.stringify(files[i]) not work"name": files[i].name,"size": files[i].size,};validationData[`${name}_${i}`]=newObj;}varvalidations=awaitfetch("/pre_upload",{method: "POST",headers: {"Content-Type": "application/json"},body: JSON.stringify(validationData),}).then((response)=>response.json());console.log(validations);In Deno (backend):
import{preUploadValidate,res,Server,upload,}from"https://deno.land/x/faster/mod.ts";constserver=newServer();server.post("/upload",res("json"),upload({path: "my_uploads",extensions: ["jpg","png"],maxSizeBytes: 20000000,maxFileSizeBytes: 10000000,}),async(ctx: any,next: any)=>{ctx.res.body=ctx.extra.uploadedFiles;awaitnext();},);server.post("/pre_upload",res("json"),preUploadValidate(["jpg","png"],20000000,10000000),async(ctx: any,next: any)=>{ctx.res.body={msg: "Passed upload validations."};awaitnext();},);server.get("/",res("html"),async(ctx: any,next: any)=>{ctx.res.body=` <form id="yourFormId" enctype="multipart/form-data" action="/upload" method="post"> <input type="file" name="file1" multiple><br> <input type="submit" value="Submit"> </form> `;awaitnext();});awaitserver.listen({port: 80});import{Context,ContextResponse,//typeCookie,//type, alias to deno stddeleteCookie,//alias to deno stdgetCookies,//alias to deno stdlogger,NextFunc,//typeParams,//typeparse,preUploadValidate,ProcessorFunc,//typeproxy,rateLimit,redirect,req,res,Route,//typeRouteFn,//typeServer,serveStatic,Session,//typesession,SessionStorageEngine,setCookie,//alias to deno stdsetCORS,SQLiteStorageEngine,Token,upload,}from"https://deno.land/x/faster/mod.ts";Example of depoly application "my-deno-app" in ubuntu environment. Change the "my-deno-app" and the directories to yours.
Create run script ("run-server.sh") in your application folder with the content:
#!/bin/bash
/home/ubuntu/.deno/bin/deno run --allow-net --allow-read --allow-write /home/ubuntu/my-deno-app/app.ts
Give permission to the script:
chmod +x run-server.shCreate service files:
sudo touch /etc/systemd/system/my-deno-app.servicesudo nano /etc/systemd/system/my-deno-app.serviceIn "my-deno-app".service (change the "Description", "WorkingDirectory" and "ExecStart" to yours):
[Unit]
Description=My Deno App
[Service]
WorkingDirectory=/home/ubuntu/my-deno-app
ExecStart=/home/ubuntu/my-deno-app/run-server.sh
TimeoutSec=30
Restart=always
RestartSec=1
[Install]
WantedBy=multi-user.target
If your application needs to wait for another service to start, such as the mongodb database, you can use the ´[Unit]´ section like this:
[Unit]
Description=My Deno App
After=mongod.service
Enable the "my-deno-app" service:
sudo systemctl enable my-deno-app.serviceTo start and stop the "my-deno-app" service:
sudo service my-deno-app stopsudo service my-deno-app startSee log:
journalctl -u my-deno-app.service --since=today -eInstall certbot:
sudo apt install certbotGenerate certificates:
sudo certbot certonly --manualIn your application, to verify the domain you will need something like:
import{Server,serveStatic}from"https://deno.land/x/faster/mod.ts";constserver=newServer();server.get(//verify http://<YOUR_DOMAIN>/.well-known/acme-challenge/<TOKEN>"/.well-known/*",serveStatic("./.well-known"),// ex: create .well-known folder in yor app folder);awaitserver.listen({port: 80});To run your application on https (Change "yourdomain.link" to your domain):
awaitserver.listen({port: 443,certFile: "/etc/letsencrypt/live/yourdomain.link/fullchain.pem",keyFile: "/etc/letsencrypt/live/yourdomain.link/privkey.pem",});The certificate is valid for a short period. Set crontab to update automatically. The command 'sudo crontab' opens roots crontab, all commands are executed as sudo. Do like this:
sudo crontab -eAdd to the end of the file (to check and renew if necessary every 12 hours):
0 */12 * * * certbot -q renew --standalone --preferred-challenges=http
Or also to check every 7 days:
0 0 * * 0 certbot -q renew --standalone --preferred-challenges=http
Author: Henrique Emanoel Viana, a Brazilian computer scientist, enthusiast of web technologies, cel: +55 (41) 99999-4664. URL: https://sites.google.com/site/henriqueemanoelviana
Improvements and suggestions are welcome!