chore(functions): Add unwrap() benchmark (#1663)

Author: donmccurdy

benchmarks/benchmark.ts

@@ -12,21 +12,48 @@ import { VERSION } from '@gltf-transform/core';
  */
 
 const argv = process.argv;
+
 const parseFlag = (flag: string, value: string): string => {
 	if (!value || value.startsWith('-')) {
 		throw new Error(`Usage: ${flag} <value>`);
 	}
 	return value;
 };
+
 const flags = {
 	filter: argv.includes('--filter') ? parseFlag('--filter', argv[argv.indexOf('--filter') + 1]) : false,
 	past: argv.includes('--past'),
 	table: argv.includes('--table'),
 	report: argv.includes('--report') ? parseFlag('--report', argv[argv.indexOf('--report') + 1]) : false,
 	reportVersion: argv.includes('--report-version'),
 	print: argv.includes('--print'),
+	help: argv.includes('--help') || argv.includes('-h'),
 };
 
+if (flags.help) {
+	console.log(
+		`
+Usage: yarn bench [options]
+
+Execution:
+	--filter <pattern>: runs only benchmarks matching <pattern>
+	--past: skip running benchmarks, show historical output only
+
+Display:
+	--print: show historical results for all benchmarks
+	--table: show detailed report for current benchmark run only
+
+History:
+	--report <version>: append run to history as <version>, default to 'dev'
+	--report-version: append run to history as current npm version
+
+Miscellaneous:
+	--help, -h: display help and exit
+		`.trim(),
+	);
+	process.exit(0);
+}
+
 /******************************************************************************
  * CREATE BENCHMARK SUITE
  */

benchmarks/tasks/index.ts

@@ -6,6 +6,7 @@ import { tasks as disposeTasks } from './dispose.bench.js';
 import { tasks as flattenTasks } from './flatten.bench.js';
 import { tasks as joinTasks } from './join.bench.js';
 import { tasks as quantizeTasks } from './quantize.bench.js';
+import { tasks as unwrapTasks } from './unwrap.bench.js';
 import { tasks as weldTasks } from './weld.bench.js';
 
 export const tasks: Task[] = [
@@ -16,5 +17,6 @@ export const tasks: Task[] = [
 	...flattenTasks,
 	...joinTasks,
 	...quantizeTasks,
+	...unwrapTasks,
 	...weldTasks,
 ];

benchmarks/tasks/unwrap.bench.ts

@@ -0,0 +1,35 @@
+import { Document } from '@gltf-transform/core';
+import { unwrap } from '@gltf-transform/functions';
+import { createTorusKnotPrimitive } from '@gltf-transform/test-utils';
+import { Task } from '../constants';
+import { LOGGER } from '../utils';
+import * as watlas from 'watlas';
+
+let _document: Document;
+
+export const tasks: Task[] = [
+	[
+		'unwrap',
+		async () => {
+			await _document.transform(unwrap({ watlas, overwrite: true, groupBy: 'scene' }));
+		},
+		{
+			beforeAll: async () => watlas.Initialize(),
+			beforeEach: () => void (_document = createDocument(10, 10, 8)), // ~100 vertices / prim
+		},
+	],
+];
+
+function createDocument(primCount: number, radialSegments: number, tubularSegments: number): Document {
+	const document = new Document().setLogger(LOGGER);
+
+	const scene = document.createScene();
+	for (let i = 0; i < primCount; i++) {
+		const prim = createTorusKnotPrimitive(document, { radialSegments, tubularSegments });
+		const mesh = document.createMesh().addPrimitive(prim);
+		const node = document.createNode().setMesh(mesh);
+		scene.addChild(node);
+	}
+
+	return document;
+}