Merge pull request #16 from ilteoood/feat/benchmarks

Feat/benchmarks

Author: ilteoood

.github/workflows/bechmark.yml

@@ -0,0 +1,19 @@
+name: Benchmark workflow
+on: [push, pull_request]
+jobs:
+  benchmark:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: pnpm/action-setup@v2
+        with:
+          version: latest
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run benchmark

benchmarks/map-filter-reduce.test.ts

@@ -0,0 +1,33 @@
+import { describe, bench } from "vitest";
+
+import { pipeline } from "../src/pipeline";
+import { fromIterable } from "../src/fromIterable";
+import { map } from "../src/map";
+import { filter } from "../src/filter";
+import { sum } from "../src/numbers/sum";
+import { forEach } from "../src/forEach";
+
+describe("map-filter-reduce", () => {
+	const initialArray = new Array(10_000).fill(0).map((_, index) => index);
+
+	bench("normal", () => {
+		const result = initialArray
+			.map((value) => value * 2)
+			.filter((value) => value % 2 === 0)
+			.reduce((accumulator, value) => accumulator + value, 0);
+	});
+
+	bench("re-flusso", async () => {
+		let result: number;
+
+		await pipeline(
+			fromIterable(initialArray),
+			map((value) => value * 2),
+			filter((value) => value % 2 === 0),
+			sum(),
+			forEach<number>((sumResult) => {
+				result = sumResult;
+			}),
+		);
+	});
+});

package.json

@@ -23,17 +23,18 @@
     "url": "https://github.com/ilteoood/re-flusso"
   },
   "scripts": {
-    "format": "biome format ./src ./test ./examples",
+    "format": "biome format ./src ./test ./examples ./benchmarks",
     "format:fix": "pnpm run format --write",
-    "sort": "biome check --apply-unsafe ./src ./test ./examples",
-    "lint": "biome lint ./src ./test ./examples",
-    "lint:fix": "biome check --write ./src ./test ./examples",
+    "sort": "biome check --apply-unsafe ./src ./test ./examples ./benchmarks",
+    "lint": "biome lint ./src ./test ./examples ./benchmarks",
+    "lint:fix": "biome check --write ./src ./test ./examples ./benchmarks",
     "test": "pnpm run \"/^test:.*/\"",
     "test:node": "vitest --config ./vitest-node.config.ts",
     "test:browser": "vitest --config ./vitest-browser.config.ts",
     "test:edge": "vitest --config ./vitest-edge.config.ts",
     "build": "tsup",
-    "prepublish": "pnpm run build"
+    "prepublish": "pnpm run build",
+    "benchmark": "vitest bench --config ./vitest-benchmark.config.ts"
   },
   "keywords": [
     "streams",

vitest-benchmark.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+    test: {
+        pool: 'forks',
+        benchmark: {
+            include: ['benchmarks/**/*.test.ts'],
+        }
+    },
+})

vitest-browser.config.ts

@@ -2,6 +2,7 @@ import { defineConfig } from 'vitest/config'
 
 export default defineConfig({
     test: {
-        environment: 'edge-runtime'
+        environment: 'edge-runtime',
+        include: ['test/**/*.test.ts']
     },
 })

vitest-edge.config.ts

@@ -2,6 +2,7 @@ import { defineConfig } from 'vitest/config'
 
 export default defineConfig({
     test: {
-        environment: 'edge-runtime'
+        environment: 'edge-runtime',
+        include: ['test/**/*.test.ts']
     },
 })

vitest-node.config.ts

@@ -3,5 +3,6 @@ import { defineConfig } from 'vitest/config'
 export default defineConfig({
     test: {
         pool: 'forks',
+        include: ['test/**/*.test.ts']
     },
 })