@nestia/benchmark 10.0.2 → 11.0.0-dev.20260305

package/src/IBenchmarkEvent.ts

@@ -1,10 +1,10 @@
-import { IFetchRoute } from "@nestia/fetcher";
-
-export interface IBenchmarkEvent {
-  metadata: IFetchRoute<any>;
-  status: number | null;
-  started_at: string;
-  respond_at: string | null;
-  completed_at: string;
-  success: boolean;
-}
+import { IFetchRoute } from "@nestia/fetcher";
+
+export interface IBenchmarkEvent {
+  metadata: IFetchRoute<any>;
+  status: number | null;
+  started_at: string;
+  respond_at: string | null;
+  completed_at: string;
+  success: boolean;
+}

package/src/index.ts

@@ -1,2 +1,2 @@
-export * from "./DynamicBenchmarker";
-export * from "./IBenchmarkEvent";
+export * from "./DynamicBenchmarker";
+export * from "./IBenchmarkEvent";

package/src/internal/DynamicBenchmarkReporter.ts

@@ -1,104 +1,104 @@
-import os from "os";
-
-import { DynamicBenchmarker } from "../DynamicBenchmarker";
-
-export namespace DynamicBenchmarkReporter {
-  export const markdown = (report: DynamicBenchmarker.IReport): string => {
-    const format = (value: number | null) =>
-      value === null ? "N/A" : (Math.floor(value * 100) / 100).toLocaleString();
-    const head = () =>
-      [
-        "Type",
-        "Count",
-        "Success",
-        "Mean.",
-        "Stdev.",
-        "Minimum",
-        "Maximum",
-      ].join(" | ") +
-      "\n" +
-      new Array(7).fill("----").join("|");
-    const row = (title: string, s: DynamicBenchmarker.IReport.IStatistics) =>
-      [
-        title,
-        s.count.toLocaleString(),
-        s.success.toLocaleString(),
-        format(s.mean),
-        format(s.stdev),
-        format(s.minimum),
-        format(s.maximum),
-      ].join(" | ");
-    const line = (
-      title: string,
-      getter: (m: NodeJS.MemoryUsage) => number,
-    ): string =>
-      `line "${title}" [${report.memories.map((m) => Math.floor(getter(m.usage) / 1024 ** 2)).join(", ")}]`;
-
-    return [
-      `# Benchmark Report`,
-      "> Generated by [`@nestia/benchmark`](https://github.com/samchon/nestia)",
-      ``,
-      `  - Specifications`,
-      `    - CPU: ${os.cpus()[0].model}`,
-      `    - RAM: ${Math.floor(os.totalmem() / 1024 / 1024 / 1024).toLocaleString()} GB`,
-      `    - NodeJS Version: ${process.version}`,
-      `    - Backend Server: 1 core / 1 thread`,
-      `  - Arguments`,
-      `    - Count: ${report.count.toLocaleString()}`,
-      `    - Threads: ${report.threads.toLocaleString()}`,
-      `    - Simultaneous: ${report.simultaneous.toLocaleString()}`,
-      `  - Time`,
-      `    - Start: ${report.started_at}`,
-      `    - Complete: ${report.completed_at}`,
-      `    - Elapsed: ${(new Date(report.completed_at).getTime() - new Date(report.started_at).getTime()).toLocaleString()} ms`,
-      ``,
-      head(),
-      row("Total", report.statistics),
-      "",
-      "> Unit: milliseconds",
-      "",
-      "## Memory Consumptions",
-      "```mermaid",
-      "xychart-beta",
-      `  x-axis "Time (second)"`,
-      `  y-axis "Memory (MB)"`,
-      `  ${line("Resident Set Size", (m) => m.rss)}`,
-      `  ${line("Heap Total", (m) => m.heapTotal)}`,
-      `  ${line("Heap Used + External", (m) => m.heapUsed + m.external)}`,
-      `  ${line("Heap Used Only", (m) => m.heapUsed)}`,
-      "```",
-      "",
-      `> - 🟦 Resident Set Size`,
-      `> - 🟢 Heap Total`,
-      `> - 🔴 Heap Used + External`,
-      `> - 🟡 Heap Used Only`,
-      "",
-      "## Endpoints",
-      head(),
-      ...report.endpoints
-        .slice()
-        .sort((a, b) => (b.mean ?? 0) - (a.mean ?? 0))
-        .map((endpoint) =>
-          row(`${endpoint.method} ${endpoint.path}`, endpoint),
-        ),
-      "",
-      "> Unit: milliseconds",
-      "",
-      "## Failures",
-      "Method | Path | Count | Failures",
-      "-------|------|-------|----------",
-      ...report.endpoints
-        .filter((e) => e.success !== e.count)
-        .slice()
-        .sort((a, b) => b.count - a.count)
-        .map((e) =>
-          [
-            e.method,
-            e.path,
-            e.count.toLocaleString(),
-            (e.count - e.success).toLocaleString(),
-          ].join(" | "),
-        ),
-    ].join("\n");
-  };
-}
+import os from "os";
+
+import { DynamicBenchmarker } from "../DynamicBenchmarker";
+
+export namespace DynamicBenchmarkReporter {
+  export const markdown = (report: DynamicBenchmarker.IReport): string => {
+    const format = (value: number | null) =>
+      value === null ? "N/A" : (Math.floor(value * 100) / 100).toLocaleString();
+    const head = () =>
+      [
+        "Type",
+        "Count",
+        "Success",
+        "Mean.",
+        "Stdev.",
+        "Minimum",
+        "Maximum",
+      ].join(" | ") +
+      "\n" +
+      new Array(7).fill("----").join("|");
+    const row = (title: string, s: DynamicBenchmarker.IReport.IStatistics) =>
+      [
+        title,
+        s.count.toLocaleString(),
+        s.success.toLocaleString(),
+        format(s.mean),
+        format(s.stdev),
+        format(s.minimum),
+        format(s.maximum),
+      ].join(" | ");
+    const line = (
+      title: string,
+      getter: (m: NodeJS.MemoryUsage) => number,
+    ): string =>
+      `line "${title}" [${report.memories.map((m) => Math.floor(getter(m.usage) / 1024 ** 2)).join(", ")}]`;
+
+    return [
+      `# Benchmark Report`,
+      "> Generated by [`@nestia/benchmark`](https://github.com/samchon/nestia)",
+      ``,
+      `  - Specifications`,
+      `    - CPU: ${os.cpus()[0]!.model}`,
+      `    - RAM: ${Math.floor(os.totalmem() / 1024 / 1024 / 1024).toLocaleString()} GB`,
+      `    - NodeJS Version: ${process.version}`,
+      `    - Backend Server: 1 core / 1 thread`,
+      `  - Arguments`,
+      `    - Count: ${report.count.toLocaleString()}`,
+      `    - Threads: ${report.threads.toLocaleString()}`,
+      `    - Simultaneous: ${report.simultaneous.toLocaleString()}`,
+      `  - Time`,
+      `    - Start: ${report.started_at}`,
+      `    - Complete: ${report.completed_at}`,
+      `    - Elapsed: ${(new Date(report.completed_at).getTime() - new Date(report.started_at).getTime()).toLocaleString()} ms`,
+      ``,
+      head(),
+      row("Total", report.statistics),
+      "",
+      "> Unit: milliseconds",
+      "",
+      "## Memory Consumptions",
+      "```mermaid",
+      "xychart-beta",
+      `  x-axis "Time (second)"`,
+      `  y-axis "Memory (MB)"`,
+      `  ${line("Resident Set Size", (m) => m.rss)}`,
+      `  ${line("Heap Total", (m) => m.heapTotal)}`,
+      `  ${line("Heap Used + External", (m) => m.heapUsed + m.external)}`,
+      `  ${line("Heap Used Only", (m) => m.heapUsed)}`,
+      "```",
+      "",
+      `> - 🟦 Resident Set Size`,
+      `> - 🟢 Heap Total`,
+      `> - 🔴 Heap Used + External`,
+      `> - 🟡 Heap Used Only`,
+      "",
+      "## Endpoints",
+      head(),
+      ...report.endpoints
+        .slice()
+        .sort((a, b) => (b.mean ?? 0) - (a.mean ?? 0))
+        .map((endpoint) =>
+          row(`${endpoint.method} ${endpoint.path}`, endpoint),
+        ),
+      "",
+      "> Unit: milliseconds",
+      "",
+      "## Failures",
+      "Method | Path | Count | Failures",
+      "-------|------|-------|----------",
+      ...report.endpoints
+        .filter((e) => e.success !== e.count)
+        .slice()
+        .sort((a, b) => b.count - a.count)
+        .map((e) =>
+          [
+            e.method,
+            e.path,
+            e.count.toLocaleString(),
+            (e.count - e.success).toLocaleString(),
+          ].join(" | "),
+        ),
+    ].join("\n");
+  };
+}

package/src/internal/IBenchmarkMaster.ts

@@ -1,4 +1,4 @@
-export interface IBenchmarkMaster {
-  filter: (name: string) => boolean;
-  progress: (current: number) => void;
-}
+export interface IBenchmarkMaster {
+  filter: (name: string) => boolean;
+  progress: (current: number) => void;
+}

package/src/internal/IBenchmarkServant.ts

@@ -1,8 +1,8 @@
-import { IBenchmarkEvent } from "../IBenchmarkEvent";
-
-export interface IBenchmarkServant {
-  execute(props: {
-    count: number;
-    simultaneous: number;
-  }): Promise<IBenchmarkEvent[]>;
-}
+import { IBenchmarkEvent } from "../IBenchmarkEvent";
+
+export interface IBenchmarkServant {
+  execute(props: {
+    count: number;
+    simultaneous: number;
+  }): Promise<IBenchmarkEvent[]>;
+}

package/lib/DynamicBenchmarker.d.ts

@@ -1,185 +0,0 @@
-import { IConnection } from "@nestia/fetcher";
-import { WorkerServer } from "tgrid";
-import { IBenchmarkMaster } from "./internal/IBenchmarkMaster";
-import { IBenchmarkServant } from "./internal/IBenchmarkServant";
-/**
- * Dynamic benchmark executor running prefixed functions.
- *
- * `DynamicBenchmarker` is composed with two programs,
- * {@link DynamicBenchmarker.master} and
- * {@link DynamicBenchmarker.servant servants}. The master program creates
- * multiple servant programs, and the servant programs execute the prefixed
- * functions in parallel. When the pre-congirued count of requests are all
- * completed, the master program collects the results and returns them.
- *
- * Therefore, when you want to benchmark the performance of a backend server,
- * you have to make two programs; one for calling the
- * {@link DynamicBenchmarker.master} function, and the other for calling the
- * {@link DynamicBenchmarker.servant} function. Also, never forget to write the
- * path of the servant program to the
- * {@link DynamicBenchmarker.IMasterProps.servant} property.
- *
- * Also, you when you complete the benchmark execution through the
- * {@link DynamicBenchmarker.master} and {@link DynamicBenchmarker.servant}
- * functions, you can convert the result to markdown content by using the
- * {@link DynamicBenchmarker.markdown} function.
- *
- * Additionally, if you hope to see some utilization cases, see the below
- * example tagged links.
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @example
- *   https://github.com/samchon/nestia-start/blob/master/test/benchmaark/index.ts
- *
- * @example
- *   https://github.com/samchon/backend/blob/master/test/benchmark/index.ts
- */
-export declare namespace DynamicBenchmarker {
-    /** Properties of the master program. */
-    interface IMasterProps {
-        /** Total count of the requests. */
-        count: number;
-        /**
-         * Number of threads.
-         *
-         * The number of threads to be executed as parallel servant.
-         */
-        threads: number;
-        /**
-         * Number of simultaneous requests.
-         *
-         * The number of requests to be executed simultaneously.
-         *
-         * This property value would be divided by the {@link threads} in the
-         * servants.
-         */
-        simultaneous: number;
-        /**
-         * Path of the servant program.
-         *
-         * The path of the servant program executing the
-         * {@link DynamicBenchmarker.servant} function.
-         */
-        servant: string;
-        /**
-         * Filter function.
-         *
-         * The filter function to determine whether to execute the function in the
-         * servant or not.
-         *
-         * @param name Function name
-         * @returns Whether to execute the function or not.
-         */
-        filter?: (name: string) => boolean;
-        /**
-         * Progress callback function.
-         *
-         * @param complete The number of completed requests.
-         */
-        progress?: (complete: number) => void;
-        /**
-         * Get memory usage.
-         *
-         * Get the memory usage of the master program.
-         *
-         * Specify this property only when your backend server is running on a
-         * different process, so that need to measure the memory usage of the
-         * backend server from other process.
-         */
-        memory?: () => Promise<NodeJS.MemoryUsage>;
-        /**
-         * Standard I/O option.
-         *
-         * The standard I/O option for the servant programs.
-         */
-        stdio?: undefined | "overlapped" | "pipe" | "ignore" | "inherit";
-    }
-    /** Properties of the servant program. */
-    interface IServantProps<Parameters extends any[]> {
-        /**
-         * Default connection.
-         *
-         * Default connection to be used in the servant.
-         */
-        connection: IConnection;
-        /** Location of the benchmark functions. */
-        location: string;
-        /**
-         * Prefix of the benchmark functions.
-         *
-         * Every prefixed function will be executed in the servant.
-         *
-         * In other words, if a function name doesn't start with the prefix, then it
-         * would never be executed.
-         */
-        prefix: string;
-        /**
-         * Get parameters of a function.
-         *
-         * When composing the parameters, never forget to copy the
-         * {@link IConnection.logger} property of default connection to the returning
-         * parameters.
-         *
-         * @param connection Default connection instance
-         * @param name Function name
-         */
-        parameters: (connection: IConnection, name: string) => Parameters;
-    }
-    /** Benchmark report. */
-    interface IReport {
-        count: number;
-        threads: number;
-        simultaneous: number;
-        started_at: string;
-        completed_at: string;
-        statistics: IReport.IStatistics;
-        endpoints: Array<IReport.IEndpoint & IReport.IStatistics>;
-        memories: IReport.IMemory[];
-    }
-    namespace IReport {
-        interface IEndpoint {
-            method: string;
-            path: string;
-        }
-        interface IStatistics {
-            count: number;
-            success: number;
-            mean: number | null;
-            stdev: number | null;
-            minimum: number | null;
-            maximum: number | null;
-        }
-        interface IMemory {
-            time: string;
-            usage: NodeJS.MemoryUsage;
-        }
-    }
-    /**
-     * Master program.
-     *
-     * Creates a master program that executing the servant programs in parallel.
-     *
-     * Note that, {@link IMasterProps.servant} property must be the path of the
-     * servant program executing the {@link servant} function.
-     *
-     * @param props Properties of the master program
-     * @returns Benchmark report
-     */
-    const master: (props: IMasterProps) => Promise<IReport>;
-    /**
-     * Create a servant program.
-     *
-     * Creates a servant program executing the prefixed functions in parallel.
-     *
-     * @param props Properties of the servant program
-     * @returns Servant program as a worker server
-     */
-    const servant: <Parameters extends any[]>(props: IServantProps<Parameters>) => Promise<WorkerServer<null, IBenchmarkServant, IBenchmarkMaster>>;
-    /**
-     * Convert the benchmark report to markdown content.
-     *
-     * @param report Benchmark report
-     * @returns Markdown content
-     */
-    const markdown: (report: DynamicBenchmarker.IReport) => string;
-}