Initial commit

Author: agjs

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+results

Dockerfile

@@ -0,0 +1,64 @@
+# Stage 1: Build the Fastify and Express apps
+FROM node:20.7 as build
+
+WORKDIR /app
+
+# Create the directory for the benchmark results
+RUN mkdir -p /results
+
+COPY package.json ./
+RUN npm install
+
+# Copy source code
+COPY src/ ./src/
+
+# Stage 2: Use a lighter base image and only copy essential files
+FROM ubuntu:latest
+
+# Avoid tzdata asking for geographical area
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Install Apache Bench, Node.js, and PostgreSQL
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends apache2-utils postgresql postgresql-contrib \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install curl
+RUN apt-get update && apt-get install -y curl
+
+# Install curl and xz-utils
+RUN apt-get update && apt-get install -y curl xz-utils
+
+# Download Node.js binary and install
+RUN curl -fsSLO --compressed "https://nodejs.org/dist/v20.7.0/node-v20.7.0-linux-x64.tar.xz" \
+    && tar -xJf "node-v20.7.0-linux-x64.tar.xz" -C /usr/local --strip-components=1 --no-same-owner \
+    && rm "node-v20.7.0-linux-x64.tar.xz" \
+    && ln -s /usr/local/bin/node /usr/local/bin/nodejs
+
+# Initialize PostgreSQL
+USER postgres
+COPY init.sql /init.sql
+RUN /etc/init.d/postgresql start && \
+    psql --command "CREATE USER myuser WITH SUPERUSER PASSWORD 'mypassword';" && \
+    createdb -O myuser mydatabase && \
+    psql mydatabase < /init.sql
+
+# Switch back to root user
+USER root
+
+# Set working directory
+WORKDIR /app
+
+# Copy essential files from the build stage
+COPY --from=build /app .
+
+# Add benchmark.sh and make it executable
+COPY benchmark.sh .
+RUN chmod +x benchmark.sh
+
+# Add startup script
+COPY start.sh .
+RUN chmod +x start.sh
+
+# Run PostgreSQL, Fastify and Express and then execute the benchmark
+CMD ["./start.sh"]

README.md

@@ -1 +1,57 @@
-# benchmarking-fastify-express
+# Benchmarking Fastify vs Express
+
+This repository contains a Dockerized environment for benchmarking Fastify and Express.js web frameworks. The focus is on comparing throughput and database operations.
+
+## Table of Contents
+
+- [Benchmarking Fastify vs Express](#benchmarking-fastify-vs-express)
+  - [Table of Contents](#table-of-contents)
+  - [Introduction](#introduction)
+  - [Setup](#setup)
+    - [Docker Setup](#docker-setup)
+  - [Docker Build and Run](#docker-build-and-run)
+  - [Metrics](#metrics)
+
+## Introduction
+
+Fastify and Express are both popular frameworks for building web applications in Node.js, but they have different performance characteristics. This Dockerized setup aims to provide a controlled environment to benchmark these frameworks based on throughput and database I/O.
+
+## Setup
+
+### Docker Setup
+
+- Build the Docker image.
+
+```bash
+docker build -t benchmark-fastify-express .
+```
+
+- Run the Docker container.
+
+```bash
+docker run -p 3000:3000 -p 3001:3001 benchmark-fastify-express
+```
+
+## Docker Build and Run
+
+The Docker image uses a multi-stage build to prepare the Node.js applications and then packages them into an Ubuntu image with Apache Bench installed. The Fastify and Express apps are started concurrently, and then the benchmark is executed. The results of the benchmark are saved to a `benchmark_results.txt` file, which is mapped to a `results` directory in your host system.
+
+```bash
+docker build -t benchmark-fastify-express .
+```
+
+```bash
+docker run -p 3000:3000 -p 3001:3001 -v $(pwd)/results:/results benchmark-fastify-express
+```
+
+After running the above command, you'll find the benchmark results in the `results` directory in your current working directory.
+
+## Metrics
+
+The following metrics are captured during the benchmarks:
+
+- Throughput (Requests per Second)
+- Latency (Average, P99)
+- Error Rate
+- Memory Usage
+- CPU Utilization

benchmark.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+echo "Benchmarking Fastify"
+
+# Benchmark Fastify for hello world
+echo "Benchmarking Fastify: Hello World"
+ab -n 5000 -c 100 http://localhost:3000/
+
+# Benchmark Fastify for DB
+echo "Benchmarking Fastify: DB Operations"
+ab -n 5000 -c 100 http://localhost:3000/db
+
+echo "Benchmarking Express"
+
+# Benchmark Express for hello world
+echo "Benchmarking Express: Hello World"
+ab -n 5000 -c 100 http://localhost:3001/
+
+# Benchmark Express for DB
+echo "Benchmarking Express: DB Operations"
+ab -n 5000 -c 100 http://localhost:3001/db

init.sql

@@ -0,0 +1,10 @@
+CREATE TABLE
+    IF NOT EXISTS dummy_table (
+        id serial PRIMARY KEY,
+        name VARCHAR(100) NOT NULL,
+        value INTEGER NOT NULL
+    );
+
+INSERT INTO
+    dummy_table (name, value)
+VALUES ('Item 1', 10), ('Item 2', 20), ('Item 3', 30), ('Item 4', 40);

package.json

@@ -0,0 +1,26 @@
+{
+  "name": "benchmarking-fastify-express",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "start:fastify": "node src/fastify.js",
+    "start:express": "node src/express.js",
+    "start": "bash -c 'npm run start:fastify & npm run start:express'"
+  },
+  "keywords": [],
+  "author": {
+    "name": "Aleksandar Grbic",
+    "email": "hi@programmer.network",
+    "url": "https://programmer.network"
+  },
+  "license": "ISC",
+  "dependencies": {
+    "express": "^4.18.2",
+    "fastify": "^4.24.2",
+    "pg": "^8.11.3"
+  },
+  "devDependencies": {
+    "concurrently": "^8.2.1"
+  }
+}

src/constants.js

@@ -0,0 +1,11 @@
+module.exports = {
+  dbOptions: {
+    user: "myuser",
+    host: "localhost",
+    database: "mydatabase",
+    password: "mypassword",
+    port: 5432,
+  },
+  expressPort: 3001,
+  fastifyPort: 3000
+};

src/db.js

@@ -0,0 +1,10 @@
+const { Pool } = require("pg");
+const { dbOptions } = require("./constants");
+
+const pool = new Pool(dbOptions);
+
+const getDummy = client => {
+  return client.query("SELECT * FROM dummy_table");
+};
+
+module.exports = { pool, getDummy };

src/express.js

@@ -0,0 +1,20 @@
+const express = require("express");
+const app = express();
+
+const { pool, getDummy } = require("./db");
+const { expressPort } = require("./constants");
+
+app.get("/", (req, res) => {
+  res.send("Hello, world!");
+});
+
+app.get('/db', async (req, res) => {
+  const client = await pool.connect();
+  const { rows } = await getDummy(client)
+  client.release();
+  res.send(rows);
+});
+
+app.listen(expressPort, () => {
+  console.log(`Express server running at http://localhost:${expressPort}`);
+});

src/fastify.js

@@ -0,0 +1,24 @@
+const fastify = require('fastify')({ logger: true });
+
+const { pool, getDummy } = require("./db");
+
+const { fastifyPort } = require("./constants");
+
+fastify.get('/', async (request, reply) => {
+  return 'Hello, world!';
+});
+
+fastify.get('/db', async (request, reply) => {
+  const client = await pool.connect();
+  const { rows } = await getDummy(client)
+  client.release();
+
+  return rows;
+});
+
+fastify.listen({ port: fastifyPort, host: '0.0.0.0' })
+  .then(address => console.log(`Fastify server is listening on ${address}:${fastifyPort}`))
+  .catch(err => {
+    console.log('Error starting server:', err);
+    process.exit(1);
+  });