thunderbench 1.0.5

package/examples/programmatic-usage.js

@@ -0,0 +1,205 @@
+// ThunderBench 编程使用示例
+import { ThunderBench, runBenchmark, validateConfig } from '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;
+  }
+}
+
+// 方式4：自定义报告生成
+async function example4() {
+  const config = {
+    name: "自定义报告测试",
+    groups: [
+      {
+        name: "报告测试组",
+        http: { baseUrl: "http://localhost:3001" },
+        threads: 1,
+        connections: 5,
+        duration: 5,
+        executionMode: "parallel",
+        tests: [
+          {
+            name: "报告测试",
+            request: { method: "GET", url: "/" },
+            weight: 100
+          }
+        ]
+      }
+    ]
+  };
+
+  const thunderbench = new ThunderBench(config, {
+    outputDir: "./custom-reports",
+    verbose: false
+  });
+
+  try {
+    const result = await thunderbench.runBenchmark();
+    
+    // 自定义报告处理
+    console.log("=== 自定义报告 ===");
+    console.log(`总请求数: ${result.overallStats.totalRequests}`);
+    console.log(`成功率: ${((result.overallStats.successfulRequests / result.overallStats.totalRequests) * 100).toFixed(1)}%`);
+    console.log(`平均响应时间: ${result.overallStats.averageResponseTime}ms`);
+    console.log(`吞吐量: ${result.overallStats.requestsPerSecond.toFixed(1)} req/s`);
+    
+    return result;
+  } finally {
+    thunderbench.destroy();
+  }
+}
+
+// 主函数
+async function main() {
+  console.log("🚀 ThunderBench 编程使用示例\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();
+
+    // 示例4：自定义报告
+    console.log("=== 示例4：自定义报告 ===");
+    await example4();
+    console.log();
+
+    console.log("✅ 所有示例执行完成！");
+  } catch (error) {
+    console.error("❌ 示例执行失败:", error);
+  }
+}
+
+// 如果直接运行此文件
+if (import.meta.url === `file://${process.argv[1]}`) {
+  main();
+}
+
+export { example1, example2, example3, example4 };

package/examples/simple-wrk-config.js

@@ -0,0 +1,33 @@
+const config = {
+  name: "简单 wrk 配置演示",
+  description: "展示基本的 wrk 参数配置",
+  groups: [
+    {
+      name: "基础测试组",
+      http: {
+        baseUrl: "http://localhost:3000",
+        headers: {
+          "User-Agent": "wrk-benchmark/1.0",
+        },
+      },
+      threads: 4, // 4个线程
+      connections: 100, // 100个连接
+      duration: 10, // 10秒
+      timeout: 5, // 5秒超时
+      latency: true, // 启用详细延迟统计
+      executionMode: "parallel",
+      tests: [
+        {
+          name: "GET 请求测试",
+          request: {
+            method: "GET",
+            url: "/techempower/json",
+          },
+          weight: 100,
+        },
+      ],
+    },
+  ],
+};
+
+export default config;

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "thunderbench",
+  "version": "1.0.5",
+  "description": "ThunderBench - 高性能API性能测试工具核心引擎",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist/",
+    "bin/",
+    "examples/",
+    "docs/",
+    "scripts/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "bun build src/index.ts --outdir ./dist --target node && tsc --project tsconfig.build.json",
+    "dev": "bun --watch src/index.ts",
+    "test": "vitest",
+    "prepublishOnly": "npm run build",
+    "release": "bumpp"
+  },
+  "keywords": [
+    "performance",
+    "benchmark",
+    "api-testing",
+    "wrk",
+    "load-testing",
+    "stress-testing",
+    "nodejs",
+    "typescript"
+  ],
+  "author": "ThunderBench Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thunderbench/thunderbench.git"
+  },
+  "homepage": "https://github.com/thunderbench/thunderbench#readme",
+  "bugs": {
+    "url": "https://github.com/thunderbench/thunderbench/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "fs-extra": "^11.2.0",
+    "glob": "^10.3.10",
+    "ora": "^7.0.1",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^20.10.0",
+    "bumpp": "^10.2.3",
+    "bun-types": "latest",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0"
+  }
+}

package/scripts/setup-wrk.js

@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+const BIN_DIR = path.join(__dirname, '..', 'bin');
+
+// 获取当前平台标识符
+function getPlatformIdentifier() {
+  const platform = process.platform;
+  const arch = process.arch;
+  
+  const platformMap = {
+    'darwin': 'darwin',
+    'linux': 'linux',
+    'win32': 'win32'
+  };
+  
+  const archMap = {
+    'x64': 'x64',
+    'x86': 'x86',
+    'arm64': 'arm64',
+    'arm': 'arm'
+  };
+  
+  const normalizedPlatform = platformMap[platform] || platform;
+  const normalizedArch = archMap[arch] || arch;
+  
+  return `${normalizedPlatform}-${normalizedArch}`;
+}
+
+// 主函数
+function main() {
+  console.log('🚀 检查 WRK 环境...\n');
+  
+  const platformId = getPlatformIdentifier();
+  console.log(`🖥️  当前平台: ${platformId}`);
+  
+  // 检查内置二进制文件
+  const builtinPath = path.join(BIN_DIR, platformId, 'wrk');
+  console.log(`📁 内置路径: ${builtinPath}`);
+  
+  if (fs.existsSync(builtinPath)) {
+    console.log(`✅ 内置二进制文件存在`);
+    
+    // 检查权限
+    try {
+      fs.accessSync(builtinPath, fs.constants.X_OK);
+      console.log(`✅ 二进制文件可执行`);
+      
+      // 测试运行
+      try {
+        // 使用 -v 参数测试，这个参数会输出版本信息
+        execSync(`"${builtinPath}" -v`, { stdio: 'pipe' });
+        console.log(`✅ 二进制文件运行正常`);
+      } catch (error) {
+        // wrk -v 通常返回非零退出码，这是正常的
+        console.log(`✅ 二进制文件运行正常 (wrk -v 返回非零退出码是正常的)`);
+      }
+      
+    } catch (error) {
+      console.log(`❌ 二进制文件权限不足`);
+    }
+    
+  } else {
+    console.log(`❌ 内置二进制文件不存在`);
+  }
+  
+  // 检查系统安装
+  try {
+    const systemWrk = execSync('which wrk', { encoding: 'utf8' }).trim();
+    console.log(`\n🔍 系统安装: ${systemWrk}`);
+  } catch (error) {
+    console.log(`\n🔍 系统安装: 未找到`);
+  }
+  
+  console.log(`\n📁 目录结构:`);
+  if (fs.existsSync(BIN_DIR)) {
+    const items = fs.readdirSync(BIN_DIR);
+    items.forEach(item => {
+      const itemPath = path.join(BIN_DIR, item);
+      const stats = fs.statSync(itemPath);
+      if (stats.isDirectory()) {
+        const wrkPath = path.join(itemPath, 'wrk');
+        const exists = fs.existsSync(wrkPath) ? '✅' : '❌';
+        console.log(`  ${item}/: ${exists} wrk`);
+      }
+    });
+  }
+}
+
+// 运行脚本
+if (require.main === module) {
+  main();
+}
+
+module.exports = { getPlatformIdentifier };