Faster
A fast middleware server with an absurdly small amount of code, inspired by the koa and oak projects. It also has a collection of useful middlewares. Faster’s ideology is: all you need is an optimized middleware manager, all other functionality is middleware. The middlware manager is just 313 lines of code and is written over Deno’s native http APIs, with no dependencies.
Example
Defining routes
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/*)
POST, read and return JSON:
import { req, res, Server } from "https://deno.land/x/faster/mod.ts";
const server = new Server();
server.post(
"/upload",
res("json"),
req("json"),
async (ctx: any, next: any) => {
console.log(ctx.body);
ctx.res.body = { msg: "json response example" };
await next();
},
);
await server.listen({ port: 80 });GET, return html:
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>
`;
await next();
},
);Get url params:
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) object
await next();
},
);Cookies:
import {
Cookie,
deleteCookie,
getCookies,
Server,
setCookie,
} from "https://deno.land/x/faster/mod.ts"; //alias to deno std
server.get(
"/cookies",
async (ctx: any, next: any) => {
setCookie(ctx.res.headers, { name: "user_name", value: "San" }); //explore interface 'Cookie' for more options
deleteCookie(ctx.res.headers, "last_order");
console.log(getCookies(ctx.req.headers));
await next();
},
);Redirect:
server.get(
"/redirect_example",
async (ctx: any, next: any) => {
ctx.redirect("/my_custom_url_or_path");
await next();
},
);Middleares
This project has a standard set of middleware useful for most cases.
Logger
Example:
server.use(logger());You can pass custom log file:
logger("./my_dir/my_custom_log.txt");Parsers (“res” and “req”)
Example:
server.post(
"/example_parsers",
res("json"),
req("json"),
async (ctx: any, next: any) => {
console.log(ctx.body); //the original (no parser) body is in ctx.req.body
ctx.res.body = { msg: "json response example" };
await next();
},
);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.append(
"Content-Type",
"application/json",
);
const data = await exCustomParseBody(ctx.req.body); //do what you want with ctx.req.body
ctx.res.body = JSON.stringify({ msg: "ok" });
await next();
},
);Rate Limit
Example:
server.use(rateLimit());With custom options:
rateLimit({ attempts: 30, interval: 10, maxTableSize: 100000 });Serve Static
Example (must end with “/*”):
server.get(
"/pub/*",
serveStatic("./pub"),
);Set Cors
Example:
server.options("/example_cors", setCORS()); //enable pre-fligh request
server.get(
"/example_cors",
setCORS(),
async (ctx, next) => {
await next();
},
);You can pass valid hosts to cors function:
setCORS("http://my.custom.url:8080");Token
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 TOKEN
Token.middleware,
async (ctx, next) => {
console.log(ctx.extra.tokenPayload);
console.log(ctx.extra.token);
await next();
},
);Generate Token ex:
await Token.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:
await Token.getPayload("YOUR_TOKEN_STRING"); //Do this at the beginning of your applicationRedirect
Ex:
server.get(
"/my_url_1",
redirect("/my_url_2"), //or the full url
);Session
Ex:
server.use(session());
//in routes:
server.get(
"/session_example",
async (ctx, next) => {
console.log(ctx.extra.session); //get session data
ctx.extra.session.foo = "bar"; //set session data
await next();
},
);OPTIONS (with default values):
session(getKeyFunc: GetKeyFuncFromContext = keyFromRemoteAddr, engine: SessionStorageEngine = new SQLiteStorageEngine(60)) //60 is 60 minutes to expire sessionATTENTION: Do not use the standard function “keyFromRemoteAddr”, it is just an unsafe example and must be replaced by your own implementation.
Upload
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!
Usage:
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) => { ...Uploads will be in ctx.extra.uploadedFiles;
upload(
path: storage directory.
extensions: optional ex: [‘jpg’, ‘png’], default allow all - [].
maxSizeBytes: optional, max total size in bytes for all files in form, default unlimited - Number.MAX_SAFE_INTEGER.
maxFileSizeBytes: optional, max size in bytes for each file in form, default unlimited - Number.MAX_SAFE_INTEGER.
saveFile: optional, if false the file will not be saved in the file system, and a temporary file generated by Deno std will returned in ‘tempfile’ field, default true. You can use it as an option to save the file in a custom way, like in a database.
readFile: optional, if true the file will be fully loaded on the ram and a Uint8Array will be returned in the ‘data’ field, default false.
useCurrentDir: optional, if true the path is relative to current Deno working directory, default true.
), next middlewares …
Request must contains a body with form type “multipart/form-data”, and inputs with type=”file”.
Ex:
.post("/pre_upload", preUploadValidate(["jpg", "png"], 20000000, 10000000), async (ctx: any, next: any) => { ...preUploadValidate(
extensions: optional ex: [‘jpg’, ‘png’], default allow all - [],
maxSizeBytes: optional, max total size in bytes for all files in form, default unlimited - Number.MAX_SAFE_INTEGER,
maxFileSizeBytes: optional, max size in bytes for each file in form, default unlimited - Number.MAX_SAFE_INTEGER
), next middlewares …
This middleware does a pre-validation before sending the form, for optimizations. To use it, send a JSON containing the objects “file”.
Examples:
Below an example to work with AJAX, also accepting type=”file” multiple:
var files = document.querySelector("#yourFormId input[type=file]").files;
var name = document.querySelector("#yourFormId input[type=file]").getAttribute(
"name",
);
var form = new FormData();
for (var i = 0; i < files.length; i++) {
form.append(`${name}_${i}`, files[i]);
}
var res = await fetch("/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 --------------
var validationData = {};
for (var i = 0; i < files.length; i++) {
var newObj = { //newObj is needed, JSON.stringify(files[i]) not work
"name": files[i].name,
"size": files[i].size,
};
validationData[`${name}_${i}`] = newObj;
}
var validations = await fetch("/pre_upload", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(validationData),
}).then((response) => response.json());
console.log(validations);In Deno:
import {
preUploadValidate,
res,
Server,
upload,
} from "https://deno.land/x/faster/mod.ts";
const server = new Server();
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;
await next();
},
);
server.post(
"/pre_upload",
res("json"),
preUploadValidate(["jpg", "png"], 20000000, 10000000),
async (ctx: any, next: any) => {
ctx.res.body = { msg: "Passed upload validations." };
await next();
},
);
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>
`;
await next();
});
await server.listen({ port: 80 });All imports:
import {
Context,
ContextResponse, //type
Cookie, //type, alias to deno std
deleteCookie, //alias to deno std
getCookies, //alias to deno std
GetKeyFuncFromContext, //type
keyFromRemoteAddr,
logger,
NextFunc, //type
Params, //type
parse,
preUploadValidate,
ProcessorFunc, //type
rateLimit,
redirect,
req,
res,
Route, //type
RouteFn, //type
Server,
serveStatic,
Session, //type
session,
SessionStorageEngine,
setCookie, //alias to deno std
setCORS,
SQLiteStorageEngine,
Token,
upload,
} from "https://deno.land/x/faster/mod.ts";Example Deploy
Example of depoly application “my-deno-app” in ubuntu environment. Change the “my-deno-app” and the directories to yours.
Create service
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.tsGive permission to the script:
chmod +x run-server.shCreate service files:
sudo touch /etc/systemd/system/my-deno-app.service
sudo 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.targetIf 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.serviceEnable 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 stop
sudo service my-deno-app startSee log:
journalctl -u my-deno-app.service --since=today -eConfigure https
Install 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";
const server = new Server();
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
);
await server.listen({ port: 80 });To run your application on https (Change “yourdomain.link” to your domain):
await server.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 renewOr also to check every 7 days:
0 0 * * 0 certbot -q renewAbout
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!