thunderbench 1.0.5

package/examples/complex-config.ts

@@ -0,0 +1,244 @@
+import { BenchmarkConfig } from "../src/types";
+
+/**
+ * 复杂的性能测试配置示例
+ * 展示了多种测试场景和配置选项
+ */
+const complexConfig: BenchmarkConfig = {
+  name: "复杂性能测试配置",
+  description: "展示多种测试场景和配置选项",
+  groups: [
+    // 用户认证相关API测试 - 并发模式
+    {
+      name: "user-authentication",
+      http: {
+        baseUrl: "https://jsonplaceholder.typicode.com",
+        timeout: 5000,
+        headers: {
+          "Content-Type": "application/json",
+          "User-Agent": "JS-Benchmark/1.0",
+        },
+      },
+      threads: 4,            // 4个线程
+      connections: 20,        // 20个连接
+      duration: 30,           // 30秒
+      timeout: 5,             // 5秒超时
+      latency: true,          // 启用延迟统计
+      executionMode: "parallel",
+      tests: [
+        {
+          name: "user-login",
+          weight: 40,
+          request: {
+            method: "POST",
+            url: "/users",
+            body: {
+              username: "testuser",
+              password: "testpass123",
+            },
+          },
+        },
+        {
+          name: "get-user-profile",
+          weight: 35,
+          request: {
+            method: "GET",
+            url: "/users/1",
+            headers: {
+              Authorization: "Bearer fake-token",
+            },
+          },
+        },
+        {
+          name: "update-user-profile",
+          weight: 25,
+          request: {
+            method: "PUT",
+            url: "/users/1",
+            body: {
+              name: "Updated Name",
+              email: "updated@example.com",
+            },
+          },
+        },
+      ],
+    },
+
+    // 内容管理API测试 - 串行模式，模拟按顺序执行的业务流程
+    {
+      name: "content-management",
+      http: {
+        baseUrl: "https://jsonplaceholder.typicode.com",
+        timeout: 3000,
+        headers: {
+          "Content-Type": "application/json",
+        },
+      },
+      threads: 2,            // 2个线程
+      connections: 10,        // 10个连接
+      duration: 20,           // 运行20秒
+      timeout: 3,             // 3秒超时
+      latency: true,          // 启用延迟统计
+      executionMode: "sequential",
+      delay: 2,               // 每批之间延迟2秒
+      tests: [
+        {
+          name: "list-posts",
+          weight: 50,
+          request: {
+            method: "GET",
+            url: "/posts",
+            query: {
+              _page: 1,
+              _limit: 10,
+              _sort: "id",
+              _order: "desc",
+            },
+          },
+        },
+        {
+          name: "create-post",
+          weight: 25,
+          request: {
+            method: "POST",
+            url: "/posts",
+            body: {
+              title: "Performance Test Post",
+              body: "This post was created during performance testing",
+              userId: 1,
+            },
+          },
+        },
+        {
+          name: "get-post-details",
+          weight: 15,
+          request: {
+            method: "GET",
+            url: "/posts/1",
+            query: {
+              _embed: "comments",
+            },
+          },
+        },
+        {
+          name: "delete-post",
+          weight: 10,
+          request: {
+            method: "DELETE",
+            url: "/posts/1",
+          },
+        },
+      ],
+    },
+
+    // API网关压力测试 - 高并发模式
+    {
+      name: "api-gateway-stress",
+      http: {
+        baseUrl: "https://jsonplaceholder.typicode.com",
+        timeout: 2000,
+        headers: {
+          Accept: "application/json",
+          "Cache-Control": "no-cache",
+        },
+      },
+      threads: 8,            // 8个线程
+      connections: 50,        // 50个连接
+      duration: 30,           // 30秒
+      timeout: 2,             // 2秒超时
+      latency: true,          // 启用延迟统计
+      executionMode: "parallel",
+      tests: [
+        {
+          name: "health-check",
+          weight: 30,
+          request: {
+            method: "GET",
+            url: "/posts/1", // 简单的健康检查
+          },
+        },
+        {
+          name: "data-query",
+          weight: 50,
+          request: {
+            method: "GET",
+            url: "/posts",
+            query: {
+              _limit: 20,
+            },
+          },
+        },
+        {
+          name: "data-creation",
+          weight: 20,
+          request: {
+            method: "POST",
+            url: "/posts",
+            body: {
+              title: "Stress Test",
+              body: "Testing high concurrency",
+              userId: 1,
+            },
+          },
+        },
+      ],
+    },
+
+    // 移动端API测试 - 模拟移动设备的间歇性请求
+    {
+      name: "mobile-api",
+      http: {
+        baseUrl: "https://jsonplaceholder.typicode.com",
+        timeout: 8000, // 移动端网络可能较慢
+        headers: {
+          "Content-Type": "application/json",
+          "User-Agent": "MobileApp/1.0",
+        },
+      },
+      threads: 2,            // 2个线程
+      connections: 10,        // 10个连接
+      duration: 30,           // 较长时间测试
+      timeout: 8,             // 8秒超时
+      latency: true,          // 启用延迟统计
+      executionMode: "sequential",
+      delay: 1,               // 1秒延迟模拟用户操作间隔
+      tests: [
+        {
+          name: "app-initialization",
+          weight: 20,
+          request: {
+            method: "GET",
+            url: "/users/1",
+          },
+        },
+        {
+          name: "content-sync",
+          weight: 60,
+          request: {
+            method: "GET",
+            url: "/posts",
+            query: {
+              userId: 1,
+              _limit: 5,
+            },
+          },
+        },
+        {
+          name: "offline-sync",
+          weight: 20,
+          request: {
+            method: "POST",
+            url: "/posts",
+            body: {
+              title: "Offline Post",
+              body: "Posted while offline, now syncing",
+              userId: 1,
+            },
+          },
+        },
+      ],
+    },
+  ],
+};
+
+export default complexConfig;

package/examples/complex-wrk-demo.ts

@@ -0,0 +1,121 @@
+import { BenchmarkConfig } from "../src/types";
+
+const config: BenchmarkConfig = {
+  name: "复杂 wrk 测试演示",
+  description: "展示 wrk 的各种参数配置和权重分配",
+  groups: [
+    {
+      name: "高并发测试组",
+      http: {
+        baseUrl: "http://localhost:3000",
+        headers: {
+          "User-Agent": "wrk-benchmark/1.0",
+          "Accept": "application/json",
+        },
+      },
+      threads: 8,           // 8个线程
+      connections: 200,      // 200个连接
+      duration: 30,          // 30秒
+      timeout: 10,           // 10秒超时
+      latency: true,         // 启用详细延迟统计
+      executionMode: "parallel",
+      tests: [
+        {
+          name: "用户注册",
+          request: {
+            method: "POST",
+            url: "/api/users/register",
+            headers: {
+              "Content-Type": "application/json",
+            },
+            body: {
+              username: "testuser",
+              email: "test@example.com",
+              password: "password123",
+            },
+          },
+          weight: 40, // 40% 的负载
+        },
+        {
+          name: "用户登录",
+          request: {
+            method: "POST",
+            url: "/api/users/login",
+            headers: {
+              "Content-Type": "application/json",
+            },
+            body: {
+              email: "test@example.com",
+              password: "password123",
+            },
+          },
+          weight: 60, // 60% 的负载
+        },
+      ],
+    },
+    {
+      name: "串行测试组",
+      http: {
+        baseUrl: "http://localhost:3000",
+        headers: {
+          "Authorization": "Bearer test-token",
+        },
+      },
+      threads: 4,            // 4个线程
+      connections: 100,       // 100个连接
+      duration: 20,           // 20秒
+      timeout: 5,             // 5秒超时
+      latency: true,          // 启用详细延迟统计
+      executionMode: "sequential",
+      delay: 5,               // 组间延迟5秒
+      tests: [
+        {
+          name: "获取用户信息",
+          request: {
+            method: "GET",
+            url: "/api/users/profile",
+          },
+          weight: 50, // 50% 的负载
+        },
+        {
+          name: "更新用户信息",
+          request: {
+            method: "PUT",
+            url: "/api/users/profile",
+            headers: {
+              "Content-Type": "application/json",
+            },
+            body: {
+              name: "Updated Name",
+              bio: "Updated bio",
+            },
+          },
+          weight: 50, // 50% 的负载
+        },
+      ],
+    },
+    {
+      name: "轻量级测试组",
+      http: {
+        baseUrl: "http://localhost:3000",
+      },
+      threads: 2,            // 2个线程
+      connections: 50,        // 50个连接
+      duration: 15,           // 15秒
+      latency: false,         // 不启用详细延迟统计
+      executionMode: "parallel",
+      tests: [
+        {
+          name: "健康检查",
+          request: {
+            method: "GET",
+            url: "/health",
+          },
+          weight: 100, // 100% 的负载
+        },
+      ],
+    },
+  ],
+};
+
+export default config;

package/examples/programmatic-usage-cjs.js

@@ -0,0 +1,156 @@
+// ThunderBench 编程使用示例 (CommonJS 版本)
+const { ThunderBench, runBenchmark, validateConfig } = require('thunderbench');
+
+// 方式1：使用 ThunderBench 类
+async function example1() {
+  const config = {
+    name: "编程API测试",
+    description: "通过编程方式运行性能测试",
+    groups: [
+      {
+        name: "基础测试组",
+        http: {
+          baseUrl: "http://localhost:3001",
+          headers: { "User-Agent": "thunderbench-programmatic/1.0" }
+        },
+        threads: 2,
+        connections: 50,
+        duration: 10,
+        timeout: 5,
+        latency: true,
+        executionMode: "parallel",
+        tests: [
+          {
+            name: "GET 请求测试",
+            request: { method: "GET", url: "/" },
+            weight: 100
+          }
+        ]
+      }
+    ]
+  };
+
+  // 创建 ThunderBench 实例
+  const thunderbench = new ThunderBench(config, {
+    outputDir: "./programmatic-reports",
+    verbose: true
+  });
+
+  try {
+    // 监听进度
+    thunderbench.getProgressStream().subscribe(progress => {
+      console.log(`进度: ${progress.groupName} - ${progress.percentage}%`);
+    });
+
+    // 监听统计
+    thunderbench.getStatsStream().subscribe(stats => {
+      console.log(`实时统计: ${stats.totalRequests} 请求, ${stats.requestsPerSecond.toFixed(1)} req/s`);
+    });
+
+    // 运行测试
+    const result = await thunderbench.runBenchmark();
+    console.log("测试完成:", result);
+    
+    return result;
+  } finally {
+    // 清理资源
+    thunderbench.destroy();
+  }
+}
+
+// 方式2：使用便捷函数
+async function example2() {
+  const config = {
+    name: "便捷函数测试",
+    groups: [
+      {
+        name: "简单测试",
+        http: { baseUrl: "http://localhost:3001" },
+        threads: 1,
+        connections: 10,
+        duration: 5,
+        executionMode: "parallel",
+        tests: [
+          {
+            name: "快速测试",
+            request: { method: "GET", url: "/" },
+            weight: 100
+          }
+        ]
+      }
+    ]
+  };
+
+  // 直接运行测试
+  const result = await runBenchmark(config, { verbose: true });
+  console.log("便捷函数测试完成:", result);
+  
+  return result;
+}
+
+// 方式3：配置验证
+function example3() {
+  const config = {
+    name: "配置验证测试",
+    groups: [
+      {
+        name: "测试组",
+        http: { baseUrl: "http://localhost:3001" },
+        threads: 2,
+        connections: 20,
+        duration: 10,
+        executionMode: "parallel",
+        tests: [
+          {
+            name: "验证测试",
+            request: { method: "GET", url: "/" },
+            weight: 100
+          }
+        ]
+      }
+    ]
+  };
+
+  try {
+    // 验证配置
+    validateConfig(config);
+    console.log("✅ 配置验证通过");
+    return true;
+  } catch (error) {
+    console.error("❌ 配置验证失败:", error.message);
+    return false;
+  }
+}
+
+// 主函数
+async function main() {
+  console.log("🚀 ThunderBench 编程使用示例 (CommonJS)\n");
+
+  try {
+    // 示例1：使用类
+    console.log("=== 示例1：使用 ThunderBench 类 ===");
+    await example1();
+    console.log();
+
+    // 示例2：使用便捷函数
+    console.log("=== 示例2：使用便捷函数 ===");
+    await example2();
+    console.log();
+
+    // 示例3：配置验证
+    console.log("=== 示例3：配置验证 ===");
+    example3();
+    console.log();
+
+    console.log("✅ 所有示例执行完成！");
+  } catch (error) {
+    console.error("❌ 示例执行失败:", error);
+  }
+}
+
+// 如果直接运行此文件
+if (require.main === module) {
+  main();
+}
+
+module.exports = { example1, example2, example3 };