@rulebricks/cli 2.0.1 → 2.0.2

package/benchmarks/throughput-results.json

@@ -0,0 +1,298 @@
+{
+  "root_group": {
+    "name": "",
+    "path": "",
+    "id": "d41d8cd98f00b204e9800998ecf8427e",
+    "groups": [],
+    "checks": [
+        {
+          "name": "status is 200",
+          "path": "::status is 200",
+          "id": "6210a8cd14cd70477eba5c5e4cb3fb5f",
+          "passes": 24000,
+          "fails": 0
+        },
+        {
+          "name": "valid response",
+          "path": "::valid response",
+          "id": "74e6940490a7b557672e61f02e36f4e8",
+          "passes": 24000,
+          "fails": 0
+        },
+        {
+          "name": "no error in response",
+          "path": "::no error in response",
+          "id": "04d657588d6c66446d4937ecba2292a2",
+          "passes": 24000,
+          "fails": 0
+        }
+      ]
+  },
+  "options": {
+    "summaryTrendStats": [
+      "avg",
+      "min",
+      "med",
+      "max",
+      "p(90)",
+      "p(95)"
+    ],
+    "summaryTimeUnit": "",
+    "noColor": false
+  },
+  "state": {
+    "isStdOutTTY": true,
+    "isStdErrTTY": true,
+    "testRunDurationMs": 300227.96
+  },
+  "metrics": {
+    "request_duration": {
+      "type": "trend",
+      "contains": "default",
+      "values": {
+        "p(95)": 318,
+        "avg": 207.51141666666666,
+        "min": 98,
+        "med": 195,
+        "max": 1305,
+        "p(90)": 285
+      }
+    },
+    "http_req_sending": {
+      "values": {
+        "p(90)": 0.443,
+        "p(95)": 0.575,
+        "avg": 0.3505282157261422,
+        "min": 0.029,
+        "med": 0.265,
+        "max": 197.681
+      },
+      "type": "trend",
+      "contains": "time"
+    },
+    "http_req_failed": {
+      "type": "rate",
+      "contains": "default",
+      "values": {
+        "rate": 0,
+        "passes": 0,
+        "fails": 30001
+      }
+    },
+    "checks": {
+      "type": "rate",
+      "contains": "default",
+      "values": {
+        "rate": 1,
+        "passes": 72000,
+        "fails": 0
+      }
+    },
+    "successes": {
+      "type": "rate",
+      "contains": "default",
+      "values": {
+        "rate": 1,
+        "passes": 24000,
+        "fails": 0
+      }
+    },
+    "http_req_blocked": {
+      "contains": "time",
+      "values": {
+        "med": 0.001,
+        "max": 446.733,
+        "p(90)": 0.001,
+        "p(95)": 0.002,
+        "avg": 1.6850438318703274,
+        "min": 0
+      },
+      "type": "trend"
+    },
+    "http_req_receiving": {
+      "type": "trend",
+      "contains": "time",
+      "values": {
+        "avg": 2.110890670310989,
+        "min": 0.019,
+        "med": 0.203,
+        "max": 206.634,
+        "p(90)": 3.99,
+        "p(95)": 5.81
+      }
+    },
+    "http_req_duration": {
+      "values": {
+        "avg": 204.29118289390323,
+        "min": 97.82,
+        "med": 193.159,
+        "max": 990.433,
+        "p(90)": 283.411,
+        "p(95)": 316.351
+      },
+      "type": "trend",
+      "contains": "time"
+    },
+    "vus_max": {
+      "type": "gauge",
+      "contains": "default",
+      "values": {
+        "value": 200,
+        "min": 200,
+        "max": 200
+      }
+    },
+    "errors{phase:measurement}": {
+      "values": {
+        "rate": 0,
+        "passes": 0,
+        "fails": 24000
+      },
+      "thresholds": {
+        "rate<0.05": {
+          "ok": true
+        }
+      },
+      "type": "rate",
+      "contains": "default"
+    },
+    "http_reqs": {
+      "contains": "default",
+      "values": {
+        "count": 30001,
+        "rate": 99.9274018315949
+      },
+      "type": "counter"
+    },
+    "data_received": {
+      "type": "counter",
+      "contains": "data",
+      "values": {
+        "count": 409778192,
+        "rate": 1364890.172121211
+      }
+    },
+    "iterations": {
+      "type": "counter",
+      "contains": "default",
+      "values": {
+        "count": 30001,
+        "rate": 99.9274018315949
+      }
+    },
+    "data_sent": {
+      "type": "counter",
+      "contains": "data",
+      "values": {
+        "count": 104185619,
+        "rate": 347021.7064393336
+      }
+    },
+    "http_req_tls_handshaking": {
+      "type": "trend",
+      "contains": "time",
+      "values": {
+        "avg": 0.9106618112729572,
+        "min": 0,
+        "med": 0,
+        "max": 306.889,
+        "p(90)": 0,
+        "p(95)": 0
+      }
+    },
+    "http_req_waiting": {
+      "contains": "time",
+      "values": {
+        "p(90)": 280.835,
+        "p(95)": 313.283,
+        "avg": 201.82976400786623,
+        "min": 94.379,
+        "med": 190.745,
+        "max": 933.167
+      },
+      "type": "trend"
+    },
+    "iteration_duration": {
+      "type": "trend",
+      "contains": "time",
+      "values": {
+        "p(95)": 324.982625,
+        "avg": 209.38244802586436,
+        "min": 100.226958,
+        "med": 196.689375,
+        "max": 1306.521125,
+        "p(90)": 288.073125
+      }
+    },
+    "errors": {
+      "type": "rate",
+      "contains": "default",
+      "values": {
+        "rate": 0,
+        "passes": 0,
+        "fails": 24000
+      }
+    },
+    "http_req_duration{phase:measurement}": {
+      "type": "trend",
+      "contains": "time",
+      "values": {
+        "p(95)": 316.0782,
+        "avg": 205.77155337500048,
+        "min": 97.82,
+        "med": 194.721,
+        "max": 990.433,
+        "p(90)": 283.5602
+      },
+      "thresholds": {
+        "p(95)<2000": {
+          "ok": true
+        },
+        "p(99)<5000": {
+          "ok": true
+        }
+      }
+    },
+    "http_req_connecting": {
+      "type": "trend",
+      "contains": "time",
+      "values": {
+        "avg": 0.7645731142295258,
+        "min": 0,
+        "med": 0,
+        "max": 257.371,
+        "p(90)": 0,
+        "p(95)": 0
+      }
+    },
+    "http_req_duration{expected_response:true}": {
+      "contains": "time",
+      "values": {
+        "avg": 204.29118289390323,
+        "min": 97.82,
+        "med": 193.159,
+        "max": 990.433,
+        "p(90)": 283.411,
+        "p(95)": 316.351
+      },
+      "type": "trend"
+    },
+    "vus": {
+      "type": "gauge",
+      "contains": "default",
+      "values": {
+        "max": 71,
+        "value": 21,
+        "min": 13
+      }
+    },
+    "total_payloads": {
+      "contains": "default",
+      "values": {
+        "count": 1200000,
+        "rate": 3996.9628411690906
+      },
+      "type": "counter"
+    }
+  }
+}

package/benchmarks/throughput-test.js

@@ -0,0 +1,159 @@
+/**
+ * Throughput (Solutions Per Second) Benchmark Test
+ *
+ * Measures rule engine capacity by sending bulk payload requests at a constant rate.
+ * This test helps you understand:
+ * - How many rule evaluations your deployment can process per second
+ * - Maximum throughput for batch workloads
+ * - Engine performance under sustained load
+ *
+ * Test Structure:
+ * - 1 minute warm-up phase (allows cluster to scale, excluded from results)
+ * - 4 minutes measurement phase (steady-state performance)
+ *
+ * Usage:
+ *   k6 run -e API_URL=https://your-instance.com/api/v1/flows/flow_id \
+ *          -e API_KEY=your-api-key \
+ *          throughput-test.js
+ *
+ * Optional environment variables:
+ *   TEST_DURATION - Measurement duration after warm-up (default: 4m)
+ *   TARGET_RPS    - Target bulk requests per second (default: 100)
+ *   BULK_SIZE     - Number of payloads per request (default: 50)
+ */
+
+import { check } from "k6";
+import http from "k6/http";
+import { Counter, Rate, Trend } from "k6/metrics";
+import {
+  generateBulkPayload,
+  getConfig,
+  createRequestParams,
+} from "./lib/payload.js";
+import {
+  generateThroughputReport,
+  generateThroughputConsoleSummary,
+} from "./lib/report.js";
+
+// Load configuration
+const config = getConfig({
+  testDuration: "4m",
+  targetRps: 100,
+  bulkSize: 50,
+});
+
+// Custom metrics (only for measurement phase)
+const errorRate = new Rate("errors");
+const successRate = new Rate("successes");
+const requestDuration = new Trend("request_duration");
+const droppedRequests = new Counter("dropped_requests");
+const totalPayloads = new Counter("total_payloads");
+const failedPayloads = new Counter("failed_payloads");
+
+// k6 options with warm-up and measurement phases
+export const options = {
+  scenarios: {
+    // Warm-up phase: 1 minute to let cluster scale
+    warm_up: {
+      executor: "constant-arrival-rate",
+      rate: config.targetRps,
+      timeUnit: "1s",
+      duration: "1m",
+      preAllocatedVUs: Math.min(config.targetRps, 100),
+      maxVUs: Math.min(config.targetRps * 3, 500),
+      exec: "warmUp",
+      tags: { phase: "warmup" },
+    },
+    // Measurement phase: actual test after warm-up
+    throughput_test: {
+      executor: "constant-arrival-rate",
+      rate: config.targetRps,
+      timeUnit: "1s",
+      duration: config.testDuration,
+      preAllocatedVUs: Math.min(config.targetRps, 100),
+      maxVUs: Math.min(config.targetRps * 3, 500),
+      startTime: "1m", // Start after warm-up
+      exec: "measureTest",
+      tags: { phase: "measurement" },
+    },
+  },
+  thresholds: {
+    // Only apply thresholds to measurement phase
+    "http_req_duration{phase:measurement}": ["p(95)<2000", "p(99)<5000"],
+    "errors{phase:measurement}": ["rate<0.05"],
+  },
+};
+
+// Request parameters (longer timeout for bulk requests)
+const params = createRequestParams(config.apiKey, "30s");
+
+/**
+ * Warm-up function - same as test but metrics tagged differently
+ */
+export function warmUp() {
+  const bulkPayload = generateBulkPayload(config.bulkSize);
+
+  try {
+    http.post(config.apiUrl, JSON.stringify(bulkPayload), params);
+  } catch (error) {
+    // Ignore errors during warm-up
+  }
+}
+
+/**
+ * Measurement test function - sends bulk requests
+ */
+export function measureTest() {
+  const bulkPayload = generateBulkPayload(config.bulkSize);
+  const start = Date.now();
+
+  try {
+    const response = http.post(
+      config.apiUrl,
+      JSON.stringify(bulkPayload),
+      params
+    );
+
+    const duration = Date.now() - start;
+    requestDuration.add(duration);
+
+    const success = check(response, {
+      "status is 200": (r) => r.status === 200,
+      "valid response": (r) => r.body && r.body.length > 0,
+      "no error in response": (r) => {
+        try {
+          const body = JSON.parse(r.body);
+          return !body.error;
+        } catch (e) {
+          return false;
+        }
+      },
+    });
+
+    errorRate.add(!success);
+    successRate.add(success);
+    totalPayloads.add(config.bulkSize);
+
+    if (!success) {
+      droppedRequests.add(1);
+      failedPayloads.add(config.bulkSize);
+    }
+  } catch (error) {
+    errorRate.add(1);
+    successRate.add(0);
+    droppedRequests.add(1);
+    totalPayloads.add(config.bulkSize);
+    failedPayloads.add(config.bulkSize);
+  }
+}
+
+/**
+ * Generate summary report
+ */
+export function handleSummary(data) {
+  return {
+    stdout: generateThroughputConsoleSummary(data, config),
+    "throughput-report.html": generateThroughputReport(data, config),
+    "throughput-results.json": JSON.stringify(data, null, 2),
+  };
+}

package/dist/commands/deploy.js

@@ -1,6 +1,7 @@
 import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
 import { useState, useEffect, useCallback, useRef } from "react";
 import { Box, Text, useApp, useInput } from "ink";
+import { platform } from "os";
 import { BorderBox, Spinner, StatusLine, ThemeProvider, useTheme, Logo, } from "../components/common/index.js";
 import { DNSWaitScreen } from "../components/DNSWaitScreen.js";
 import { loadDeploymentConfig, loadDeploymentState, saveDeploymentState, updateDeploymentStatus, } from "../lib/config.js";
@@ -360,7 +361,7 @@ function DeployCommandInner({ name, skipInfra, skipDns, version, }) {
     // Complete screen
     if (step === "complete") {
         const tlsSkipped = status.helmUpgradeTls === "skipped" && !useExternalDns;
-        return (_jsx(BorderBox, { title: "Deployment Complete", children: _jsxs(Box, { flexDirection: "column", marginY: 1, children: [_jsx(Text, { color: colors.success, bold: true, children: "\u2713 Rulebricks deployed successfully!" }), _jsxs(Box, { marginTop: 1, flexDirection: "column", children: [_jsxs(Text, { children: ["URL:", " ", _jsxs(Text, { color: colors.accent, children: ["https://", config?.domain, "/auth/signup"] })] }), useExternalDns && (_jsx(Text, { color: colors.muted, children: "DNS records will be created automatically by external-dns" })), tlsSkipped && (_jsx(Box, { marginTop: 1, children: _jsxs(Text, { color: colors.warning, children: ["\u26A0 TLS not configured. Run `rulebricks deploy ", name, "` again after DNS setup."] }) }))] }), _jsxs(Box, { marginTop: 1, flexDirection: "column", children: [_jsx(Text, { bold: true, children: "Next steps:" }), _jsxs(Text, { color: colors.muted, children: [" ", "\u2022 Visit the URL to complete initial setup"] }), _jsxs(Text, { color: colors.muted, children: [" ", "\u2022 Run `rulebricks status ", name, "` to check deployment health"] }), tlsSkipped && (_jsxs(Text, { color: colors.muted, children: [" ", "\u2022 Configure DNS and re-run deploy for TLS"] }))] })] }) }));
+        return (_jsx(BorderBox, { title: "Deployment Complete", children: _jsxs(Box, { flexDirection: "column", marginY: 1, children: [_jsx(Text, { color: colors.success, bold: true, children: "\u2713 Rulebricks deployed successfully!" }), _jsxs(Box, { marginTop: 1, flexDirection: "column", children: [_jsxs(Text, { children: ["URL:", " ", _jsxs(Text, { color: colors.accent, children: ["https://", config?.domain, "/auth/signup"] })] }), useExternalDns && (_jsx(Text, { color: colors.muted, children: "DNS records will be created automatically by external-dns" })), tlsSkipped && (_jsx(Box, { marginTop: 1, children: _jsxs(Text, { color: colors.warning, children: ["\u26A0 TLS not configured. Run `rulebricks deploy ", name, "` again after DNS setup."] }) }))] }), _jsxs(Box, { marginTop: 1, flexDirection: "column", children: [_jsx(Text, { bold: true, children: "Next steps:" }), _jsxs(Text, { color: colors.muted, children: [" ", "\u2022 Visit the URL to complete initial setup"] }), _jsxs(Text, { color: colors.muted, children: [" ", "\u2022 Run `rulebricks status ", name, "` to check deployment health"] }), tlsSkipped && (_jsxs(Text, { color: colors.muted, children: [" ", "\u2022 Configure DNS and re-run deploy for TLS"] }))] }), _jsxs(Box, { marginTop: 1, flexDirection: "column", children: [_jsx(Text, { color: colors.muted, dimColor: true, children: "Tip: If the URL isn't accessible yet, your local DNS may need time to propagate." }), _jsxs(Text, { color: colors.muted, dimColor: true, children: ["Flush DNS cache: ", getDnsFlushCommand()] })] })] }) }));
     }
     // Progress screen
     const helmInstallLabel = useExternalDns
@@ -376,6 +377,16 @@ function DeployCommandInner({ name, skipInfra, skipDns, version, }) {
                                     ? "Applying infrastructure"
                                     : undefined }), _jsx(StatusLine, { status: status.kubeconfig, label: "Kubernetes configuration" }), _jsx(StatusLine, { status: status.helmInstall, label: helmInstallLabel }), !useExternalDns && (_jsxs(_Fragment, { children: [_jsx(StatusLine, { status: status.dnsConfig, label: "DNS configuration" }), _jsx(StatusLine, { status: status.helmUpgradeTls, label: "TLS configuration" })] })), step !== "dns-wait" && (_jsx(Box, { marginTop: 1, children: _jsx(Spinner, { label: getStepLabel(step, useExternalDns) }) }))] }) }));
 }
+function getDnsFlushCommand() {
+    switch (platform()) {
+        case "darwin":
+            return "sudo dscacheutil -flushcache && sudo killall -HUP mDNSResponder";
+        case "win32":
+            return "ipconfig /flushdns";
+        default:
+            return "sudo systemd-resolve --flush-caches";
+    }
+}
 function getStepLabel(step, useExternalDns) {
     switch (step) {
         case "loading":

package/dist/components/Wizard/steps/BenchmarkSteps.js

@@ -175,7 +175,7 @@ export function TestModeStep({ onComplete, onBack, state }) {
             ...defaults,
         });
     };
-    return (_jsxs(BorderBox, { title: "Test Mode", children: [_jsx(Box, { flexDirection: "column", marginY: 1, children: _jsx(Text, { children: "Select the type of benchmark to run:" }) }), _jsx(SelectInput, { items: items, onSelect: handleSelect, itemComponent: ({ isSelected, label }) => {
+    return (_jsxs(BorderBox, { title: "Test Mode", children: [_jsx(Box, { flexDirection: "column", marginY: 1, children: _jsx(Text, { children: "Select the type of benchmark to run:" }) }), _jsx(SelectInput, { items: items, onSelect: handleSelect, indicatorComponent: () => null, itemComponent: ({ isSelected, label }) => {
                     const item = items.find((i) => i.label === label);
                     return (_jsxs(Box, { flexDirection: "column", marginY: isSelected ? 1 : 0, children: [_jsxs(Text, { color: isSelected ? colors.accent : undefined, bold: isSelected, children: [isSelected ? "❯ " : "  ", label] }), isSelected && item && (_jsxs(Text, { color: colors.muted, dimColor: true, children: ["    ", item.description] }))] }));
                 } }), _jsx(Box, { marginTop: 1, children: _jsx(Text, { color: colors.muted, dimColor: true, children: "Esc to go back \u2022 Enter to select" }) })] }));
@@ -262,7 +262,7 @@ export function PresetsStep({ onComplete, onBack, state }) {
     if (customMode) {
         return (_jsxs(BorderBox, { title: "Custom Configuration", children: [_jsxs(Box, { flexDirection: "column", marginY: 1, children: [_jsx(Text, { children: "Configure your custom benchmark parameters:" }), _jsxs(Box, { marginTop: 1, flexDirection: "column", children: [_jsxs(Box, { children: [_jsxs(Text, { color: activeField === "rps" ? colors.accent : undefined, children: [activeField === "rps" ? "❯ " : "  ", "Target RPS:", " "] }), activeField === "rps" ? (_jsx(TextInput, { value: customRps, onChange: setCustomRps, onSubmit: handleCustomSubmit, placeholder: "e.g., 500" })) : (_jsx(Text, { children: customRps }))] }), _jsxs(Box, { children: [_jsxs(Text, { color: activeField === "duration" ? colors.accent : undefined, children: [activeField === "duration" ? "❯ " : "  ", "Duration:", " "] }), activeField === "duration" ? (_jsx(TextInput, { value: customDuration, onChange: setCustomDuration, onSubmit: handleCustomSubmit, placeholder: "e.g., 4m" })) : (_jsx(Text, { children: customDuration }))] }), state.testMode === "throughput" && (_jsxs(Box, { children: [_jsxs(Text, { color: activeField === "bulkSize" ? colors.accent : undefined, children: [activeField === "bulkSize" ? "❯ " : "  ", "Bulk Size:", " "] }), activeField === "bulkSize" ? (_jsx(TextInput, { value: customBulkSize, onChange: setCustomBulkSize, onSubmit: handleCustomSubmit, placeholder: "e.g., 50" })) : (_jsx(Text, { children: customBulkSize }))] }))] })] }), _jsx(Box, { marginTop: 1, children: _jsx(Text, { color: colors.muted, dimColor: true, children: "Tab to switch fields \u2022 Esc to go back \u2022 Enter to continue" }) })] }));
     }
-    return (_jsxs(BorderBox, { title: "Test Presets", children: [_jsx(Box, { flexDirection: "column", marginY: 1, children: _jsxs(Text, { children: ["Select a preset for your ", state.testMode.toUpperCase(), " test:"] }) }), _jsx(SelectInput, { items: items, onSelect: handleSelect, itemComponent: ({ isSelected, label }) => {
+    return (_jsxs(BorderBox, { title: "Test Presets", children: [_jsx(Box, { flexDirection: "column", marginY: 1, children: _jsxs(Text, { children: ["Select a preset for your ", state.testMode.toUpperCase(), " test:"] }) }), _jsx(SelectInput, { items: items, onSelect: handleSelect, indicatorComponent: () => null, itemComponent: ({ isSelected, label }) => {
                     const item = items.find((i) => i.label === label);
                     return (_jsxs(Box, { flexDirection: "column", marginY: isSelected ? 1 : 0, children: [_jsxs(Text, { color: isSelected ? colors.accent : undefined, bold: isSelected, children: [isSelected ? "❯ " : "  ", label] }), isSelected && item && (_jsxs(Text, { color: colors.muted, dimColor: true, children: ["    ", item.description] }))] }));
                 } }), _jsx(Box, { marginTop: 1, children: _jsx(Text, { color: colors.muted, dimColor: true, children: "Esc to go back \u2022 Enter to select" }) })] }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rulebricks/cli",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "CLI for deploying and managing private Rulebricks instances",
   "type": "module",
   "bin": {
@@ -59,7 +59,8 @@
   "pkg": {
     "scripts": "dist/**/*.js",
     "assets": [
-      "terraform/**/*"
+      "terraform/**/*",
+      "benchmarks/**/*"
     ],
     "targets": [
       "node20-linux-x64",
@@ -73,6 +74,7 @@
   "files": [
     "dist",
     "terraform",
-    "templates"
+    "templates",
+    "benchmarks"
   ]
 }