perf(utils): setup microbenchmark for crawlFileSystem (#355)

Author: BioPhoton

packages/utils/perf/README.md

@@ -0,0 +1,9 @@
+# Micro Benchmarks
+
+Execute any benchmark by running `nx run utils:perf` naming the folder e.g. `nx run utils:perf score-report`.
+
+To list benchmarks run `ls -l | grep "^d" | awk '{print $9}'`
+
+## scoreReport
+
+`nx run utils:perf score-report`

packages/utils/perf/crawl-file-system/index.ts

@@ -0,0 +1,105 @@
+import * as Benchmark from 'benchmark';
+import { join } from 'path';
+import {
+  CrawlFileSystemOptions,
+  crawlFileSystem,
+} from '../../src/lib/file-system';
+import { crawlFileSystemOptimized0 } from './optimized0';
+
+const PROCESS_ARGUMENT_TARGET_DIRECTORY = String(
+  process.argv
+    .find(arg => arg.startsWith('--directory'))
+    ?.split('=')
+    .pop() || '',
+);
+const PROCESS_ARGUMENT_PATTERN = String(
+  process.argv
+    .find(arg => arg.startsWith('--pattern'))
+    ?.split('=')
+    .pop() || '',
+);
+
+const suite = new Benchmark.Suite('report-scoring');
+
+const TARGET_DIRECTORY =
+  PROCESS_ARGUMENT_TARGET_DIRECTORY ||
+  join(process.cwd(), '..', '..', '..', 'node_modules');
+const PATTERN = PROCESS_ARGUMENT_PATTERN || /.json$/;
+
+// ==================
+
+const start = performance.now();
+
+// Add listener
+const listeners = {
+  cycle: function (event: Benchmark.Event) {
+    console.info(String(event.target));
+  },
+  complete: () => {
+    if (typeof suite.filter === 'function') {
+      console.info(' ');
+      console.info(
+        `Total Duration: ${((performance.now() - start) / 1000).toFixed(
+          2,
+        )} sec`,
+      );
+      console.info('Fastest is ' + suite.filter('fastest').map('name'));
+    }
+  },
+};
+
+// ==================
+
+// Add tests
+const options = {
+  directory: TARGET_DIRECTORY,
+  pattern: PATTERN,
+};
+suite.add('Base', wrapWithDefer(crawlFileSystem));
+suite.add('Optimized 0', wrapWithDefer(crawlFileSystemOptimized0));
+
+// ==================
+
+// Add Listener
+Object.entries(listeners).forEach(([name, fn]) => {
+  suite.on(name, fn);
+});
+
+// ==================
+
+console.info('You can adjust the test with the following arguments:');
+console.info(
+  `directory      target directory of test      --directory=${TARGET_DIRECTORY}`,
+);
+console.info(
+  `pattern        pattern to search             --pattern=${PATTERN}`,
+);
+console.info(' ');
+console.info('Start benchmark...');
+console.info(' ');
+
+suite.run({
+  async: true,
+});
+
+// ==============================================================
+
+function wrapWithDefer<T>(
+  asyncFn: (options: CrawlFileSystemOptions<T>) => Promise<unknown[]>,
+) {
+  return {
+    defer: true, // important for async functions
+    fn: function (deferred: { resolve: () => void }) {
+      return asyncFn(options)
+        .catch(() => [])
+        .then((result: unknown[]) => {
+          if (result.length === 0) {
+            throw new Error(`Result length is ${result.length}`);
+          } else {
+            deferred.resolve();
+          }
+          return void 0;
+        });
+    },
+  };
+}

packages/utils/perf/crawl-file-system/optimized0.ts

@@ -0,0 +1,8 @@
+import { CrawlFileSystemOptions } from '../../src';
+
+export function crawlFileSystemOptimized0<T = string>(
+  options: CrawlFileSystemOptions<T>,
+): Promise<T[]> {
+  const { directory, pattern: needle = '@TODO' } = options;
+  return Promise.resolve([directory, needle] as T[]);
+}

packages/utils/perf/implementations/base.ts

@@ -1,10 +1,10 @@
 import * as Benchmark from 'benchmark';
 import { Report } from '@code-pushup/models';
-import { scoreReport } from './implementations/base';
-import { scoreReportOptimized0 } from './implementations/optimized0';
-import { scoreReportOptimized1 } from './implementations/optimized1';
-import { scoreReportOptimized2 } from './implementations/optimized2';
-import { scoreReportOptimized3 } from './implementations/optimized3';
+import { scoreReport } from '../../src/lib/scoring';
+import { scoreReportOptimized0 } from './optimized0';
+import { scoreReportOptimized1 } from './optimized1';
+import { scoreReportOptimized2 } from './optimized2';
+import { scoreReportOptimized3 } from './optimized3';
 
 interface MinimalReportOptions {
   numAuditsP1?: number;
@@ -66,7 +66,7 @@ const listeners = {
 // ==================
 
 // Add tests
-suite.add('scoreReport', _scoreReport);
+suite.add('scoreReport', scoreReport);
 suite.add('scoreReportOptimized0', _scoreReportOptimized0);
 suite.add('scoreReportOptimized1', _scoreReportOptimized1);
 suite.add('scoreReportOptimized2', _scoreReportOptimized2);
@@ -97,18 +97,16 @@ console.info(' ');
 
 const start = performance.now();
 
-suite.run();
-
-console.info(
-  `Total Duration: ${((performance.now() - start) / 1000).toFixed(2)} sec`,
-);
+suite.run({
+  onComplete: () => {
+    console.info(
+      `Total Duration: ${((performance.now() - start) / 1000).toFixed(2)} sec`,
+    );
+  },
+});
 
 // ==============================================================
 
-function _scoreReport() {
-  scoreReport(minimalReport());
-}
-
 function _scoreReportOptimized0() {
   scoreReportOptimized0(minimalReport());
 }

packages/utils/perf/index.ts renamed to packages/utils/perf/score-report/index.ts

@@ -30,7 +30,16 @@
       }
     },
     "perf": {
-      "command": "npx tsx ./packages/utils/perf --tsconfig=packages/utils/tsconfig.perf.json"
+      "command": "npx tsx --tsconfig=../tsconfig.perf.json",
+      "options": {
+        "cwd": "./packages/utils/perf"
+      }
+    },
+    "perf:list": {
+      "command": "ls -l | grep \"^d\" | awk '{print $9}'",
+      "options": {
+        "cwd": "./packages/utils/perf"
+      }
     },
     "unit-test": {
       "executor": "@nx/vite:test",

packages/utils/perf/implementations/optimized0.ts renamed to packages/utils/perf/score-report/optimized0.ts

@@ -10,6 +10,7 @@ export {
 export {
   FileResult,
   MultipleFileResults,
+  CrawlFileSystemOptions,
   crawlFileSystem,
   ensureDirectoryExists,
   fileExists,

packages/utils/perf/implementations/optimized1.ts renamed to packages/utils/perf/score-report/optimized1.ts

@@ -101,12 +101,14 @@ export async function importEsmModule<T = unknown>(
 export function pluginWorkDir(slug: string): string {
   return join('node_modules', '.code-pushup', slug);
 }
-
-export async function crawlFileSystem<T = string>(options: {
+export type CrawlFileSystemOptions<T> = {
   directory: string;
   pattern?: string | RegExp;
   fileTransform?: (filePath: string) => Promise<T> | T;
-}): Promise<T[]> {
+};
+export async function crawlFileSystem<T = string>(
+  options: CrawlFileSystemOptions<T>,
+): Promise<T[]> {
   const {
     directory,
     pattern,