Node.js Cache with Native SQLite

This project is a simple implementation of a cache system using Node.js and SQLite. The main objective is to test the native implementation of SQLite in Node.js, leveraging its built-in support for handling SQLite databases without external libraries.

Features

• Store key-value pairs in an SQLite database.
• Set expiration times for cache entries.
• Simple HTTP server to interact with the cache via GET and POST requests.

Prerequisites

• Node.js (version 22.5.0 or higher).
• Docker (for containerized execution).
• SQLite (optional, as Node.js can handle database creation natively).

Run the Project

Clone the repository:

## Clone using HTTPS
git clone https://github.com/BrunoSSantana/node-cache-sqlite.git cd node-cache-sqlite

## Clone using GitHub CLI
gh repo clone BrunoSSantana/node-cache-sqlite

Create the db.sqlite file (if it doesn't exist) and start the Docker containers:

make docker-up

This command ensures the db.sqlite file is created if missing, then builds and runs the Docker containers.

Stop the server and containers:

make docker-dow

To completely clean up (remove the database file and all volumes):

make clean

Usage

The server provides two main endpoints:

GET /

Retrieve data from the cache by passing query parameters.

Example:

GET http://localhost:3001/?sampleKey

Response:

 { "sampleKey": {} }

POST /

Insert or update a key-value pair in the cache with an expiration time.

Example:

POST http://localhost:3001/
content-type: application/json
{
  "key": "sampleKey",
  "value": {
    "sample": "value"
  }
}

Testing the API

After the server is running, you can test the API using the provided requests.http file. This file contains example HTTP requests (GET and POST) and can be used with the Rest Client extension in Visual Studio Code for making HTTP requests directly from your editor.

Project Structure

└── src
    ├── autocannon-testes.ts      # Script to run autocannon tests
    ├── cache-db                  # Cache database implementation
    │   ├── cache-redis-db.ts     # Redis cache implementation
    │   ├── cache-sqlite-db.ts    # SQLite cache implementation
    │   └── index.ts
    ├── main.ts                   # Main entry point
    └── server.ts                 # HTTP server

Native SQLite Implementation

This project was created to test and showcase the native support of SQLite in Node.js, without using external libraries like better-sqlite3 or sqlite3. The goal is to evaluate SQLite's performance and functionality as a lightweight, file-based database in a cache scenario.

Run Stress Tests

To run the autocannon stress tests, you can use the following command:

make docker-up

This will start container with the SQLite database and redis cache. To run the stress tests, you can use the following command:

pnpm test:stress

This will run the autocannon stress test, which will make a lot of requests to the server and measure the performance. The results will be created in the benchmark.md file.

License

This project is licensed under the MIT License.