feat: rename invariant to assert and hide in stacktrace (#442)

* chore: rename invariant to assert

* hide assert in stackTrace

Author: Uzlopak

src/bench.ts

@@ -22,8 +22,8 @@ import {
 import { BenchEvent } from './event'
 import { Task } from './task'
 import {
+  assert,
   defaultConvertTaskResultForConsoleTable,
-  invariant,
   performanceNow,
   runtime,
   runtimeVersion,
@@ -274,7 +274,7 @@ export class Bench extends EventTarget implements BenchLike {
    * @returns the tasks array
    */
   runSync (): Task[] {
-    invariant(
+    assert(
       this.concurrency === null,
       'Cannot use `concurrency` option when using `runSync`'
     )

src/task.ts

@@ -14,8 +14,8 @@ import type {
 
 import { BenchEvent } from './event'
 import {
+  assert,
   getStatisticsSorted,
-  invariant,
   isFnAsyncResource,
   isPromiseLike,
   isValidSamples,
@@ -156,7 +156,7 @@ export class Task extends EventTarget {
 
     for (const hookName of hookNames) {
       if (this.#fnOpts[hookName] != null) {
-        invariant(
+        assert(
           typeof this.#fnOpts[hookName] === 'function',
           `'${hookName}' must be a function if provided`
         )
@@ -229,15 +229,15 @@ export class Task extends EventTarget {
       return this
     }
 
-    invariant(
+    assert(
       this.#bench.concurrency === null,
       'Cannot use `concurrency` option when using `runSync`'
     )
     this.#result = startedTaskResult
     this.dispatchEvent(new BenchEvent('start', this))
 
     const setupResult = this.#bench.setup(this, 'run')
-    invariant(
+    assert(
       !isPromiseLike(setupResult),
       '`setup` function must be sync when using `runSync()`'
     )
@@ -249,7 +249,7 @@ export class Task extends EventTarget {
     )
 
     const teardownResult = this.#bench.teardown(this, 'run')
-    invariant(
+    assert(
       !isPromiseLike(teardownResult),
       '`teardown` function must be sync when using `runSync()`'
     )
@@ -289,7 +289,7 @@ export class Task extends EventTarget {
     this.dispatchEvent(new BenchEvent('warmup', this))
 
     const setupResult = this.#bench.setup(this, 'warmup')
-    invariant(
+    assert(
       !isPromiseLike(setupResult),
       '`setup` function must be sync when using `runSync()`'
     )
@@ -301,7 +301,7 @@ export class Task extends EventTarget {
     )
 
     const teardownResult = this.#bench.teardown(this, 'warmup')
-    invariant(
+    assert(
       !isPromiseLike(teardownResult),
       '`teardown` function must be sync when using `runSync()`'
     )
@@ -404,7 +404,7 @@ export class Task extends EventTarget {
     if (this.#fnOpts.beforeAll) {
       try {
         const beforeAllResult = this.#fnOpts.beforeAll.call(this, mode)
-        invariant(
+        assert(
           !isPromiseLike(beforeAllResult),
           '`beforeAll` function must be sync when using `runSync()`'
         )
@@ -423,7 +423,7 @@ export class Task extends EventTarget {
       try {
         if (this.#fnOpts.beforeEach) {
           const beforeEachResult = this.#fnOpts.beforeEach.call(this, mode)
-          invariant(
+          assert(
             !isPromiseLike(beforeEachResult),
             '`beforeEach` function must be sync when using `runSync()`'
           )
@@ -436,7 +436,7 @@ export class Task extends EventTarget {
       } finally {
         if (this.#fnOpts.afterEach) {
           const afterEachResult = this.#fnOpts.afterEach.call(this, mode)
-          invariant(
+          assert(
             !isPromiseLike(afterEachResult),
             '`afterEach` function must be sync when using `runSync()`'
           )
@@ -459,7 +459,7 @@ export class Task extends EventTarget {
     if (this.#fnOpts.afterAll) {
       try {
         const afterAllResult = this.#fnOpts.afterAll.call(this, mode)
-        invariant(
+        assert(
           !isPromiseLike(afterAllResult),
           '`afterAll` function must be sync when using `runSync()`'
         )
@@ -500,7 +500,7 @@ export class Task extends EventTarget {
     const fnResult = this.#fn.call(this)
     let taskTime = this.#bench.now() - taskStart
 
-    invariant(
+    assert(
       !isPromiseLike(fnResult),
       'task function must be sync when using `runSync()`'
     )

src/utils.ts

@@ -462,9 +462,18 @@ export function getStatisticsSorted (samples: SortedSamples, retainSamples = fal
  * @param message - the error message to throw if the condition is false
  * @throws {Error} if the condition is false
  */
-export const invariant = (condition: boolean, message: string): void => {
+export const assert = (condition: boolean, message: string): void => {
   if (!condition) {
-    throw new Error(message)
+    const stackTraceLimit = Error.stackTraceLimit
+    try {
+      Error.stackTraceLimit = 0
+      const error = new Error(message)
+      Error.stackTraceLimit = stackTraceLimit
+      stackTraceLimit !== 0 && Error.captureStackTrace(error, assert)
+      throw error
+    } finally {
+      Error.stackTraceLimit = stackTraceLimit
+    }
   }
 }
 

test/utils-assert.test.ts

@@ -0,0 +1,39 @@
+import { expect, test } from 'vitest'
+
+import { assert } from '../src/utils'
+
+test('assert - true', () => {
+  expect(() => {
+    assert(true, 'everything fine')
+  }).not.toThrow()
+})
+
+test('assert - false', () => {
+  expect(() => {
+    assert(false, 'something went wrong')
+  }).toThrowError(new Error('something went wrong'))
+})
+
+test('assert - false stack trace', () => {
+  /**
+   *
+   */
+  function testFunction () {
+    assert(false, 'stack trace test')
+  }
+
+  try {
+    testFunction()
+  } catch (error) {
+    expect(error).toBeInstanceOf(Error)
+    if (error instanceof Error) {
+      expect(error.stack).toBeDefined()
+      if (error.stack) {
+        const stackLines = error.stack.split('\n')
+        expect(stackLines[0]).toBe('Error: stack trace test')
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        expect((stackLines[1]!).trim().startsWith('at testFunction')).toBe(true)
+      }
+    }
+  }
+})