fix!: remove deprecated statistics fields on TaskResult (#407)

Author: Uzlopak

src/task.ts

@@ -29,6 +29,10 @@ const hookNames = ['afterAll', 'beforeAll', 'beforeEach', 'afterEach'] as const
 
 const abortableStates = ['not-started', 'started'] as const
 
+const notStartedTaskResult: TaskResult = { state: 'not-started' }
+const abortedTaskResult: TaskResult = { state: 'aborted' }
+const startedTaskResult: TaskResult = { state: 'started' }
+
 /**
  * A class that represents each benchmark task in Tinybench. It keeps track of the
  * results, name, the task function, the number times the task function has been executed, ...
@@ -46,15 +50,6 @@ export class Task extends EventTarget {
     options?: RemoveEventListenerOptionsArgument
   ) => void
 
-  /**
-   * The result object
-   */
-  result: Readonly<TaskResult & TaskResultRuntimeInfo> = {
-    runtime: 'unknown',
-    runtimeVersion: 'unknown',
-    state: 'not-started',
-  }
-
   /**
    * The number of times the task function has been executed
    */
@@ -64,6 +59,14 @@ export class Task extends EventTarget {
     return this.#name
   }
 
+  get result (): TaskResult & TaskResultRuntimeInfo {
+    return {
+      ...this.#result,
+      runtime: this.#bench.runtime,
+      runtimeVersion: this.#bench.runtimeVersion,
+    }
+  }
+
   /**
    * The task asynchronous status
    */
@@ -89,6 +92,11 @@ export class Task extends EventTarget {
    */
   readonly #name: string
 
+  /**
+   * The result object
+   */
+  #result: TaskResult = notStartedTaskResult
+
   /**
    * The task-level abort signal
    */
@@ -148,7 +156,7 @@ export class Task extends EventTarget {
     if (emit) this.dispatchEvent(new BenchEvent('reset', this))
     this.runs = 0
 
-    this.#setTaskResult({ state: this.#aborted ? 'aborted' : 'not-started' })
+    this.#result = this.#aborted ? abortedTaskResult : notStartedTaskResult
   }
 
   /**
@@ -157,12 +165,10 @@ export class Task extends EventTarget {
    * @internal
    */
   async run (): Promise<Task> {
-    if (this.result.state !== 'not-started') {
+    if (this.#result.state !== 'not-started') {
       return this
     }
-    this.#setTaskResult({
-      state: 'started'
-    })
+    this.#result = { state: 'started' }
     this.dispatchEvent(new BenchEvent('start', this))
     await this.#bench.opts.setup(this, 'run')
     const { error, samples: latencySamples } = (await this.#benchmark(
@@ -183,17 +189,15 @@ export class Task extends EventTarget {
    * @internal
    */
   runSync (): this {
-    if (this.result.state !== 'not-started') {
+    if (this.#result.state !== 'not-started') {
       return this
     }
 
     invariant(
       this.#bench.concurrency === null,
       'Cannot use `concurrency` option when using `runSync`'
     )
-    this.#setTaskResult({
-      state: 'started'
-    })
+    this.#result = startedTaskResult
     this.dispatchEvent(new BenchEvent('start', this))
 
     const setupResult = this.#bench.opts.setup(this, 'run')
@@ -224,7 +228,7 @@ export class Task extends EventTarget {
    * @internal
    */
   async warmup (): Promise<void> {
-    if (this.result.state !== 'not-started') {
+    if (this.#result.state !== 'not-started') {
       return
     }
     this.dispatchEvent(new BenchEvent('warmup', this))
@@ -244,7 +248,7 @@ export class Task extends EventTarget {
    * @internal
    */
   warmupSync (): void {
-    if (this.result.state !== 'not-started') {
+    if (this.#result.state !== 'not-started') {
       return
     }
 
@@ -464,11 +468,9 @@ export class Task extends EventTarget {
 
   #onAbort (): void {
     if (
-      abortableStates.includes(this.result.state as typeof abortableStates[number])
+      abortableStates.includes(this.#result.state as typeof abortableStates[number])
     ) {
-      this.#setTaskResult({
-        state: 'aborted',
-      })
+      this.#result = abortedTaskResult
       const ev = new BenchEvent('abort', this)
       this.dispatchEvent(ev)
       this.#bench.dispatchEvent(ev)
@@ -477,10 +479,9 @@ export class Task extends EventTarget {
 
   #postWarmup (error: Error | undefined): void {
     if (error) {
-      this.#setTaskResult({
-        error,
-        state: 'errored',
-      })
+      /* eslint-disable perfectionist/sort-objects */
+      this.#result = { state: 'errored', error }
+      /* eslint-enable perfectionist/sort-objects */
       const ev = new BenchEvent('error', this, error)
       this.dispatchEvent(ev)
       this.#bench.dispatchEvent(ev)
@@ -520,28 +521,27 @@ export class Task extends EventTarget {
       sortSamples(throughputSamples)
       const throughputStatistics = getStatisticsSorted(throughputSamples)
 
-      this.#setTaskResult({
-        period: totalTime / this.runs,
+      /* eslint-disable perfectionist/sort-objects */
+      this.#result = {
         state: this.#aborted ? 'aborted-with-statistics' : 'completed',
-        totalTime,
-        // deprecated statistics included for backward compatibility
-        ...latencyStatistics,
-        hz: throughputStatistics.mean,
         latency: latencyStatistics,
+        period: totalTime / this.runs,
         throughput: throughputStatistics,
-      })
+        totalTime,
+      }
+      /* eslint-enable perfectionist/sort-objects */
     } else if (this.#aborted) {
       // If aborted with no samples, still set the aborted flag
-      this.#setTaskResult({
-        state: 'aborted',
-      })
+      this.#result = abortedTaskResult
     }
 
     if (error) {
-      this.#setTaskResult({
-        error,
+      /* eslint-disable perfectionist/sort-objects */
+      this.#result = {
         state: 'errored',
-      })
+        error,
+      }
+      /* eslint-enable perfectionist/sort-objects */
       const ev = new BenchEvent('error', this, error)
       this.dispatchEvent(ev)
       this.#bench.dispatchEvent(ev)
@@ -556,18 +556,6 @@ export class Task extends EventTarget {
     // cycle and complete are equal in Task
     this.dispatchEvent(new BenchEvent('complete', this))
   }
-
-  /**
-   * set the result object values
-   * @param result - the task result object to merge with the current result object values
-   */
-  #setTaskResult (result: TaskResult): void {
-    this.result = Object.freeze({
-      runtime: this.#bench.runtime,
-      runtimeVersion: this.#bench.runtimeVersion,
-      ...result,
-    })
-  }
 }
 
 /**

src/types.ts

@@ -382,7 +382,7 @@ export interface TaskResultStarted {
   state: 'started'
 }
 
-export interface TaskResultWithStatistics extends DeprecatedStatistics {
+export interface TaskResultWithStatistics {
   /**
    * the task latency statistics
    */
@@ -403,101 +403,3 @@ export interface TaskResultWithStatistics extends DeprecatedStatistics {
    */
   totalTime: number
 }
-
-interface DeprecatedStatistics {
-  /**
-   * the latency samples critical value
-   * @deprecated use `.latency.critical` instead
-   */
-  critical: number
-
-  /**
-   * the latency samples degrees of freedom
-   * @deprecated use `.latency.df` instead
-   */
-  df: number
-
-  /**
-   * the number of operations per second
-   * @deprecated use `.throughput.mean` instead
-   */
-  hz: number
-
-  /**
-   * the maximum latency samples value
-   * @deprecated use `.latency.max` instead
-   */
-  max: number
-
-  /**
-   * the latency samples mean/average
-   * @deprecated use `.latency.mean` instead
-   */
-  mean: number
-
-  /**
-   * the minimum latency samples value
-   * @deprecated use `.latency.min` instead
-   */
-  min: number
-
-  /**
-   * the latency samples margin of error
-   * @deprecated use `.latency.moe` instead
-   */
-  moe: number
-
-  /**
-   * the latency samples p75 percentile
-   * @deprecated use `.latency.p75` instead
-   */
-  p75: number
-
-  /**
-   * the latency samples p99 percentile
-   * @deprecated use `.latency.p99` instead
-   */
-  p99: number
-
-  /**
-   * the latency samples p995 percentile
-   * @deprecated use `.latency.p995` instead
-   */
-  p995: number
-
-  /**
-   * the latency samples p999 percentile
-   * @deprecated use `.latency.p999` instead
-   */
-  p999: number
-
-  /**
-   * the latency samples relative margin of error
-   * @deprecated use `.latency.rme` instead
-   */
-  rme: number
-
-  /**
-   * latency samples (ms)
-   * @deprecated use `.latency.samples` instead
-   */
-  samples: number[]
-
-  /**
-   * the latency samples standard deviation
-   * @deprecated use `.latency.sd` instead
-   */
-  sd: number
-
-  /**
-   * the latency standard error of the mean (a.k.a. the standard deviation of the distribution of the sample mean/average)
-   * @deprecated use `.latency.sem` instead
-   */
-  sem: number
-
-  /**
-   * the latency samples variance
-   * @deprecated use `.latency.variance` instead
-   */
-  variance: number
-}