chore: introduce native glob benchmark

Author: mrmlnc

herebyfile.mjs

@@ -73,9 +73,9 @@ export const {
 	productStreamTask,
 	productSyncTask,
 } = {
-	productAsyncTask: makeBenchSuiteTask('product', 'async', PRODUCT_ASYNC_SUITE, ['fast-glob', 'node-glob', 'tinyglobby']),
+	productAsyncTask: makeBenchSuiteTask('product', 'async', PRODUCT_ASYNC_SUITE, ['fast-glob', 'node-glob', 'tinyglobby', 'native']),
 	productStreamTask: makeBenchSuiteTask('product', 'stream', PRODUCT_STREAM_SUITE, ['fast-glob', 'node-glob']),
-	productSyncTask: makeBenchSuiteTask('product', 'sync', PRODUCT_SYNC_SUITE, ['fast-glob', 'node-glob', 'tinyglobby']),
+	productSyncTask: makeBenchSuiteTask('product', 'sync', PRODUCT_SYNC_SUITE, ['fast-glob', 'node-glob', 'tinyglobby', 'native']),
 };
 
 export const {

src/benchmark/suites/product/async.ts

@@ -4,7 +4,7 @@ import * as bencho from 'bencho';
 
 import * as utils from '../../utils';
 
-type GlobImplementation = 'fast-glob' | 'node-glob' | 'tinyglobby';
+type GlobImplementation = 'fast-glob' | 'native' | 'node-glob' | 'tinyglobby';
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type GlobImplFunction = (...args: any[]) => Promise<unknown[]>;
 
@@ -17,6 +17,32 @@ class Glob {
 		this.#pattern = pattern;
 	}
 
+	/**
+	 * Assumptions:
+	 *
+	 * 1. The implementation returns entries with an absolute path, while all other solutions return a relative path.
+	 */
+	public async measureNative(): Promise<void> {
+		const glob = await utils.importAndMeasure(utils.importNativeGlob);
+
+		await this.#measure(async () => {
+			const iterator = await glob.glob(this.#pattern, {
+				cwd: this.#cwd,
+				withFileTypes: true,
+			});
+
+			const entries: string[] = [];
+
+			for await (const dirent of iterator) {
+				if (!dirent.isDirectory()) {
+					entries.push(`${dirent.parentPath}/${dirent.name}`);
+				}
+			}
+
+			return entries;
+		});
+	}
+
 	public async measureNodeGlob(): Promise<void> {
 		const glob = await utils.importAndMeasure(utils.importNodeGlob);
 
@@ -71,6 +97,11 @@ class Glob {
 	const glob = new Glob(cwd, pattern);
 
 	switch (impl) {
+		case 'native': {
+			await glob.measureNative();
+			break;
+		}
+
 		case 'node-glob': {
 			await glob.measureNodeGlob();
 			break;

src/benchmark/suites/product/sync.ts

@@ -4,7 +4,7 @@ import * as bencho from 'bencho';
 
 import * as utils from '../../utils';
 
-type GlobImplementation = 'fast-glob' | 'node-glob' | 'tinyglobby';
+type GlobImplementation = 'fast-glob' | 'native' | 'node-glob' | 'tinyglobby';
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type GlobImplFunction = (...args: any[]) => unknown[];
 
@@ -17,6 +17,32 @@ class Glob {
 		this.#pattern = pattern;
 	}
 
+	/**
+	 * Assumptions:
+	 *
+	 * 1. The implementation returns entries with an absolute path, while all other solutions return a relative path.
+	 */
+	public async measureNative(): Promise<void> {
+		const glob = await utils.importAndMeasure(utils.importNativeGlob);
+
+		this.#measure(() => {
+			const iterator = glob.globSync(this.#pattern, {
+				cwd: this.#cwd,
+				withFileTypes: true,
+			});
+
+			const entries: string[] = [];
+
+			for (const dirent of iterator) {
+				if (!dirent.isDirectory()) {
+					entries.push(`${dirent.parentPath}/${dirent.name}`);
+				}
+			}
+
+			return entries;
+		});
+	}
+
 	public async measureNodeGlob(): Promise<void> {
 		const glob = await utils.importAndMeasure(utils.importNodeGlob);
 
@@ -71,6 +97,11 @@ class Glob {
 	const glob = new Glob(cwd, pattern);
 
 	switch (impl) {
+		case 'native': {
+			await glob.measureNative();
+			break;
+		}
+
 		case 'node-glob': {
 			await glob.measureNodeGlob();
 			break;

src/benchmark/utils.ts

@@ -2,11 +2,22 @@ import { performance } from 'node:perf_hooks';
 
 import * as bencho from 'bencho';
 
+import type * as fs from 'node:fs';
 import type * as currentVersion from '..';
 import type * as previousVersion from 'fast-glob';
 import type * as glob from 'glob';
 import type * as tg from 'tinyglobby';
 
+type NativeGlobAsynchronous = (pattern: string, options: {
+	cwd: string;
+	withFileTypes: boolean;
+}) => Promise<AsyncIterable<fs.Dirent>>;
+
+type NativeGlobSynchronous = (pattern: string, options: {
+	cwd: string;
+	withFileTypes: boolean;
+}) => fs.Dirent[];
+
 export function timeStart(): number {
 	return performance.now();
 }
@@ -23,6 +34,20 @@ export function importCurrentFastGlob(): Promise<typeof currentVersion> {
 	return import('..');
 }
 
+export async function importNativeGlob(): Promise<{
+	glob: NativeGlobAsynchronous;
+	globSync: NativeGlobSynchronous;
+}> {
+	const fs = await import('node:fs');
+
+	return {
+		// @ts-expect-error The current version of @types/node has not definitions for this method.
+		glob: fs.promises.glob as NativeGlobAsynchronous,
+		// @ts-expect-error The current version of @types/node has not definitions for this method.
+		globSync: fs.globSync as NativeGlobSynchronous,
+	};
+}
+
 export function importPreviousFastGlob(): Promise<typeof previousVersion> {
 	return import('fast-glob');
 }