blaze-performance-tester 1.0.0 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blaze-performance-tester",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A high-performance, multi-threaded load testing engine built with Rust and QuickJS.",
   "type": "module",
   "main": "dist/index.js",

package/readme

@@ -0,0 +1,97 @@
+# 🔥 Blaze Performance Tester
+
+Blaze is an ultra-high-performance, multi-threaded load testing framework built with **Rust** and **QuickJS** (via `rquickjs`). It provides parallel virtual user execution by isolating JavaScript evaluation environments into dedicated native OS threads, delivering raw network speed and JMeter-style telemetry metrics with minimal footprint.
+
+---
+
+## 🚀 Key Features
+
+* **Multi-Threaded Concurrency Core:** Spawns lightweight native OS threads for every Virtual User (VU) to bypass common runtime bottlenecks.
+* **Native HTTP Execution Sockets:** Exposes a global `http_get()` binding inside JavaScript that routes network calls directly through Rust's high-speed `reqwest` stack.
+* **JMeter-Style Telemetry Aggregation:** Computes live data snapshots including throughput rates, error tallies, and crucial latency percentiles ($p50$, $p90$, $p95$, $p99$).
+* **Real-Time Terminal Progress Updates:** Keeps you updated via a live terminal countdown ticker while heavy parallel workloads run.
+* **CSV Result Archiver:** Automatically records every workload run into structured `.csv` reports inside the `results/` folder for data charting.
+
+---
+
+## 🛠️ Project Workspace Layout
+
+```text
+blaze-performance-tester/
+├── dist/                  # Compiled Distribution Assets
+│   ├── cli.js             # Bundled CLI Wrapper Script
+│   ├── index.js           # Generated Native NAPI-RS Bridges
+│   └── index.d.ts         # TypeScript Type Structure Mappings
+├── results/               # Aggregated Report Output Artifacts
+│   └── summary_report.csv # JMeter-style CSV performance dump
+├── src/
+│   └── lib.rs             # Multi-Threaded Rust Concurrency Core
+├── tests/                 # Dedicated Folder for Performance Scripts
+│   └── demo-load-test.ts  # Scenario Workload Script
+├── cli.ts                 # CLI Orchestration & Metrics Wrapper
+├── package.json           # Node Dependency Pipeline
+└── Cargo.toml             # Rust Native Compilation Flags
+📦 Compilation & Installation
+Prerequisites
+Ensure you have the following installed on your machine:
+
+Node.js (v18+)
+
+Rust & Cargo MSRV Toolchain
+
+Setup & Build
+Clone the repository, download dependencies, and compile the native binary distribution bundle:
+
+Bash
+# Install node dependencies
+npm install
+
+# Compile the native Rust modules and bundle the TypeScript CLI wrapper
+npm run build
+🏃 Run Performance Workloads
+To run a performance test script, call the core execution runner by passing your target test file, the number of parallel virtual users (VUs), and the test duration in seconds:
+
+Bash
+# Usage: npx tsx cli.ts <script-path> <vus> <duration-seconds>
+npx tsx cli.ts tests/demo-load-test.ts 10 5
+Writing a Workload Script (tests/demo-load-test.ts)
+Your scripts have access to the injected, native http_get global socket binding:
+
+TypeScript
+// Call the high-speed native network layer directly
+const status = http_get("[https://jsonplaceholder.typicode.com/posts/1](https://jsonplaceholder.typicode.com/posts/1)");
+
+// The engine automatically registers response times and error states!
+📊 Sample Performance Output Report
+When your test finishes running, Blaze renders a clean telemetry report right in your terminal and saves a copy to disk:
+
+Plaintext
+📊 ==================== JMeter-Style Performance Report ====================
+  Samples (Requests): 14,250
+  Throughput Rate:    2,850.00 req/sec
+  Error Rate:         0.00% (0 failed)
+-----------------------------------------------------------------------------
+📈 Latency Statistics (ms):
+  ├── Minimum:        2.10 ms
+  ├── Average:        3.45 ms
+  ├── Median (50%):   3.20 ms
+  └── 90th %ile:      4.10 ms
+  └── 95th %ile:      4.65 ms
+  └── 99th %ile:      5.90 ms
+  └── Maximum:        12.40 ms
+=============================================================================
+💾 Aggregated metrics saved to: .\results\summary_report.csv
+🧙 Interactive Scaffolding Wizard (create-blaze-tester)
+We provide a companion initializer utility to quickly set up new projects with an organized workspace folder structure.
+
+To execute the setup wizard out of an empty workspace directory, run:
+
+Bash
+npm init blaze-tester
+This interactive prompt automatically:
+
+Provisions a dedicated tests/ directory.
+
+Injects an example boilerplate script file (demo-load-test.ts).
+
+Appends test runner shortcut hooks directly into your local package.json.