blaze-performance-tester 1.1.22 → 2.0.1

package/package.json

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

package/readme

@@ -1,95 +1,71 @@
-Markdown
-# 🔥 Blaze Performance Tester
+🔥 Blaze Performance Tester
+Blaze is an ultra-high-performance, lightweight load testing engine powered by a native Rust core integration (NAPI-RS). It is architected to simulate massive parallel virtual user (VU) traffic concurrently while tracking script latencies, system throughput capacities, and error frequencies in real-time.
 
-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.
+🛠️ Prerequisites
+Because Blaze leverages a pre-compiled native core engine for bare-metal execution performance, your system must satisfy the following baseline parameters:
 
----
+1. Runtime Environment
+Node.js: v18.0.0 or higher (Node v20+ or v24+ recommended for peak ES Module stability).
 
-## 🚀 Key Features
+2. Operating System Dependencies (For Loading Pre-compiled Binaries)
+💡 No Rust Required: End-users do not need to install Rust, Cargo, or any compilation toolchains. Blaze ships with pre-built system binaries inside the NPM bundle. However, your host OS needs standard runtime compatibility libraries to interface with the binary layer:
 
-* **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.
-* **Zero-Configuration CSV Archiver:** Automatically records data into structured `.csv` reports inside a `results/` folder created dynamically wherever you invoke the command.
+Windows: Requires the standard Microsoft Visual C++ Redistributable installed (pre-installed on almost all developer setups, or packaged alongside Git/VS Code).
 
----
+macOS: Native architecture compatibility (Intel/Apple Silicon M-series). Ensure Xcode Command Line Tools are active (xcode-select --install).
 
-## 🛠️ Project Workspace Layout
+Linux: Requires glibc 2.28 or higher (standard on Ubuntu 20.04+, Debian 10+, Fedora, and CentOS).
 
-```text
-blaze-performance-tester/
-├── dist/                  # Compiled Distribution Assets
-│   ├── cli.js             # Bundled CLI Core
-│   ├── index.js           # Generated Native NAPI-RS Bridges
-│   ├── index.d.ts         # TypeScript Type Structure Mappings
-│   └── blaze.*.node       # Compiled Native Rust Binary
-├── src/
-│   └── lib.rs             # Multi-Threaded Rust Concurrency Core
-├── tests/                 # Dedicated Folder for Performance Scripts
-│   └── test-script.ts     # Scenario Workload Script
-├── bin.js                 # Anti-Hijack Executable Gateway for Windows WSH
-├── cli.ts                 # CLI Orchestration & Metrics Wrapper
-├── package.json           # Node Dependency & Build Script Pipeline
-└── Cargo.toml             # Rust Native Compilation Flags
-📦 Compilation & Installation
-Prerequisites
-Ensure you have the following installed on your machine:
+3. File System Permissions
+Blaze generates performance reporting assets on-disk at the end of each session. Ensure your terminal session has active write permissions inside your current active testing directory.
 
-Node.js (v18+)
+📦 Installation & Execution Philosophy
+You do not need to clone this repository, configure build configs, or install dependencies locally. Blaze utilizes a fully on-demand delivery layout via npx to keep your workspace pristine.
 
-Rust & Cargo MSRV Toolchain
-
-Setup & Build
-Clone the repository, download dependencies, and compile the native binary distribution bundle:
+📝 Step 1: Create a Workload Test Script
+Blaze targets modular test scripts to evaluate target endpoint resilience. Create a test directory and save the following workload layout as tests/test-script.ts (or use a standard .js extension):
 
+TypeScript
+// tests/test-script.ts
+
+export default async function workload() {
+  // Define the exact request workflow you want to load-test here
+  const response = await fetch('https://api.example.com/v1/health');
+  
+  if (!response.ok) {
+    throw new Error(`Target endpoint returned unhealthy status code: ${response.status}`);
+  }
+}
+💡 Design Constraint: Your script file must export a single default asynchronous function block. The underlying native Blaze runtime hooks directly into this entry point to distribute it across concurrent worker execution threads.
+
+🏃 Step 2: Execute the Performance Test Suite
+Trigger the core runner directly out of your execution context terminal layout by supplying your test script path, virtual user target count, and your benchmarking time window.
+
+Command Execution Syntax
 Bash
-# Install package dependencies
-npm install
-
-# Compile the native Rust modules, copy binaries, and bundle the ESM CLI wrapper
-npm run build
-🏃 Run Performance Workloads
-Blaze can be executed globally from any terminal folder via npx without needing global system mutations.
-
-To run a test, navigate to your target project folder, create your script file, and call the runner passing the script path, the number of concurrent Virtual Users (VUs), and the test duration in seconds:
+npx blaze-performance-tester@2.0.0 <path-to-script> <concurrent-vus> <duration-seconds>
+Execution Example
+To launch 10 concurrent virtual user threads pounding your target workload continuously for an execution duration window of 5 seconds, run this exact command inside your terminal:
 
 DOS
-# Usage: npx blaze-performance-tester <script-path> <vus> <duration-seconds>
-npx blaze-performance-tester tests/test-script.ts 10 5
-Writing a Workload Script (tests/test-script.ts)
-Your script workloads have instant access to the injected high-speed global native socket binding:
+C:\perf>npx blaze-performance-tester@1.1.22 tests/test-script.ts 10 5
+📊 Analytics & Telemetry Engine
+Upon wrapping up its concurrency window, Blaze automatically maps, calculates, and dumps a dual-layered architectural metrics profile straight into your working path.
 
-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 native Rust engine automatically handles 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
-📂 Where are results stored?
-Blaze captures execution contexts using process.cwd(). The moment a test run completes successfully, a new directory is instantly written inside the user's active terminal directory:
+1. Tabular Terminal Summary (JMeter CLI Layout)
+Blaze generates a strict, highly detailed performance grid directly into your active console screen for instant feedback:
 
 Plaintext
-your-active-directory/
-├── tests/
-│   └── test-script.ts
-└── results/               <-- Generated Automatically
-    └── summary_report.csv <-- Contains Raw Timestamp, Latency, Status, and Success Flags
+🔥 [Blaze] Injecting load tests using Blaze metrics aggregation engine...
+
+💻 ======================================== JMETER-STYLE SUMMARY REPORT ========================================
+ Label       | # Samples | Average (ms) | Min (ms) | Max (ms) | 90% Line | 95% Line | 99% Line | Error % | Throughput | Received KB/sec
+-------------|-----------|--------------|----------|----------|----------|----------|----------|---------|------------|----------------
+ test-script | 1250      | 42.6         | 14.2     | 184.1    | 54.2     | 78.5     | 142.1    | 0.00%   | 248.5/sec  | 1043.70 KB/s
+-------------|-----------|--------------|----------|----------|----------|----------|----------|---------|------------|----------------
+ Total       | 1250      | 42.6         | 14.2     | 184.1    | 54.2     | 78.5     | 142.1    | 0.00%   | 248.5/sec  | 1043.70 KB/s
+================================================================================================================
+Test Execution Finished. Elapsed time: 5.03s | Target VUs: 10
+2. Beautiful HTML Interactive Dashboard
+Alongside the console logs, a fully styled, portable, dark-mode data visualization dashboard file is generated on-disk:
+📁 Location: ./blaze-html-report.html