refactor!: remove useless benchmark todos (#118)

jerome-benoit · web-flow · commit 434d07fea87c · 2024-10-14T18:01:25.000+02:00
Signed-off-by: Jérôme Benoit &lt;jerome.benoit@piment-noir.org&gt;
diff --git a/README.md b/README.md
@@ -45,7 +45,6 @@ bench
     await new Promise((r) => setTimeout(r, 1)); // we wait 1ms :)
     console.log('I am slower');
   })
-  .todo('unimplemented bench');
 
 await bench.warmup(); // make results more reliable, ref: https://github.com/tinylibs/tinybench/pull/50
 await bench.run();
@@ -59,15 +58,6 @@ console.table(bench.table());
 // │ 0       │ 'faster task' │ '38,832' │ 25751.297631307978   │ '±3.48%' │ '22016.49999997812±5.5000000145' │ 3884    │
 // │ 1       │ 'slower task' │ '669'    │ 1493338.567164177    │ '±5.98%' │ '1445076.0000000286'             │ 67      │
 // └─────────┴───────────────┴──────────┴──────────────────────┴──────────┴──────────────────────────────────┴─────────┘
-
-console.table(bench.table((task) => ({ 'Task name': task.name })));
-
-// Output:
-// ┌─────────┬───────────────────────┐
-// │ (index) │       Task name       │
-// ├─────────┼───────────────────────┤
-// │    0    │ 'unimplemented bench' │
-// └─────────┴───────────────────────┘
 ```
 
 The `add` method accepts a task name and a task function, so it can benchmark
@@ -157,8 +147,6 @@ export type Hook = (task: Task, mode: 'warmup' | 'run') => void | Promise<void>;
 - `get results(): (TaskResult | undefined)[]`: (getter) tasks results as an array
 - `get tasks(): Task[]`: (getter) tasks as an array
 - `getTask(name: string): Task | undefined`: get a task based on the name
-- `todo(name: string, fn?: Fn, opts: FnOptions)`: add a benchmark todo to the todo map
-- `get todos(): Task[]`: (getter) tasks todos as an array
 
 ### `Task`
 
@@ -334,7 +322,6 @@ export type BenchEvents =
   | 'cycle' // when running each benchmark task gets done (cycle)
   | 'add' // when a Task gets added to the Bench
   | 'remove' // when a Task gets removed of the Bench
-  | 'todo'; // when a todo Task gets added to the Bench
 
 /**
  * task events
diff --git a/examples/src/simple.ts b/examples/src/simple.ts
@@ -10,8 +10,7 @@ bench
   .add('slower task', async () => {
     await new Promise((r) => setTimeout(r, 1)); // we wait 1ms :)
     console.log('I am slower');
-  })
-  .todo('unimplemented bench');
+  });
 
 await bench.run();
 
@@ -24,16 +23,3 @@ console.table(bench.table());
 // │ 0       │ 'faster task' │ '38,832' │ 25751.297631307978   │ '±3.48%' │ '22016.49999997812±5.5000000145' │ 3884    │
 // │ 1       │ 'slower task' │ '669'    │ 1493338.567164177    │ '±5.98%' │ '1445076.0000000286'             │ 67      │
 // └─────────┴───────────────┴──────────┴──────────────────────┴──────────┴──────────────────────────────────┴─────────┘
-
-console.table(
-  bench.todos.map(({ name }) => ({
-    'Task name': name,
-  })),
-);
-
-// Output:
-// ┌─────────┬───────────────────────┐
-// │ (index) │       Task name       │
-// ├─────────┼───────────────────────┤
-// │    0    │ 'unimplemented bench' │
-// └─────────┴───────────────────────┘
diff --git a/src/bench.ts b/src/bench.ts
@@ -23,8 +23,6 @@ export default class Bench extends EventTarget {
    */
   private readonly _tasks: Map<string, Task> = new Map();
 
-  private readonly _todos: Map<string, Task> = new Map();
-
   /**
    * Executes tasks concurrently based on the specified concurrency mode.
    *
@@ -193,17 +191,6 @@ export default class Bench extends EventTarget {
     return this;
   }
 
-  /**
-   * add a benchmark todo to the todo map
-   */
-  // eslint-disable-next-line @typescript-eslint/no-empty-function
-  todo(name: string, fn: Fn = () => {}, opts: FnOptions = {}) {
-    const task = new Task(this, name, fn, opts);
-    this._todos.set(name, task);
-    this.dispatchEvent(createBenchEvent('todo', task));
-    return this;
-  }
-
   /**
    * remove a benchmark task from the task map
    */
@@ -268,10 +255,6 @@ export default class Bench extends EventTarget {
     return [...this._tasks.values()];
   }
 
-  get todos(): Task[] {
-    return [...this._todos.values()];
-  }
-
   /**
    * get a task based on the task name
    */
diff --git a/src/types.ts b/src/types.ts
@@ -156,7 +156,6 @@ export type BenchEvents =
   | 'cycle' // when running each benchmark task gets done (cycle)
   | 'add' // when a Task gets added to the Bench
   | 'remove' // when a Task gets removed of the Bench
-  | 'todo'; // when a todo Task gets added to the Bench
 
 export type Hook = (task: Task, mode: 'warmup' | 'run') => void | Promise<void>;
 
@@ -173,7 +172,6 @@ export interface BenchEventsMap{
   remove: TaskEventListener
   cycle: TaskEventListener
   error: TaskEventListener
-  todo: TaskEventListener
 }
 
 /**
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -187,21 +187,6 @@ test('events order 2', async () => {
   await new Promise((resolve) => setTimeout(resolve, 150));
 });
 
-test('todo event', async () => {
-  const bench = new Bench({ time: 50 });
-
-  let todoTask: Task;
-  bench.addEventListener('todo', ({ task }) => {
-    todoTask = task;
-  });
-
-  bench.todo('unimplemented bench');
-
-  await bench.run();
-
-  expect(todoTask!.name).toBe('unimplemented bench');
-});
-
 test('error event', async () => {
   const bench = new Bench({ time: 50 });
   const err = new Error();
