chore: add quick and dirty performance test

Author: toolbuilder

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toolbuilder/priority-buffer",
-  "description": "Priority queue buffer with limited capacity where implemented methods match Array signature.",
+  "description": "Priority queue buffer with limited capacity where push/shift/length match the Array API.",
   "version": "0.1.0",
   "keywords": [
     "priority",
@@ -9,7 +9,11 @@
   ],
   "license": "MIT",
   "main": "index.js",
-  "module": "src/priority-buffer.js",
+  "module": "./src/priority-buffer.js",
+  "exports": {
+    "import": "./src/priority-buffer.js",
+    "default": "./index.js"
+  },
   "files": [
     "src"
   ],
@@ -20,7 +24,8 @@
     "check:src": "eslint src test",
     "check:test": "run-s test",
     "check:uncommitted": "uncommitted",
-    "prerelease": "run-s check",
+    "docs": "pnpx documentation build src/priority-buffer.js -f md -o docs/priority-buffer.md",
+    "prerelease": "run-s docs check",
     "release": "standard-version",
     "test": "tape -r esm \"test/*test.js\""
   },
@@ -33,6 +38,7 @@
   "devDependencies": {
     "@toolbuilder/eslint-config": "^0.1.4",
     "@toolbuilder/package-json-lint-config": "^0.1.0",
+    "@toolbuilder/ring-buffer": "^1.1.2",
     "@toolbuilder/ring-buffer-tests": "^0.1.0",
     "@toolbuilder/rollup-config-pkgtest": "^0.1.2",
     "eslint": "^7.14.0",

pnpm-lock.yaml

@@ -0,0 +1,28 @@
+import { PriorityBuffer } from '../src/priority-buffer.js'
+import { RingBuffer } from '@toolbuilder/ring-buffer'
+
+const iterations = 50000000
+const length = 100
+
+const time = (queue) => {
+  for (let i = 0; i < length; ++i) {
+    queue.push(Math.random(i))
+  }
+  for (let i = 0; i < iterations; ++i) {
+    queue.shift()
+    queue.push(Math.random(i))
+  }
+}
+
+console.time('RingBuffer')
+time(new RingBuffer(length)) // unprioritized
+console.timeEnd('RingBuffer')
+
+console.time('array')
+time([]) // unprioritized
+console.timeEnd('array')
+
+console.time('PriorityBuffer')
+const comparator = (a, b) => a - b
+time(new PriorityBuffer(comparator, length))
+console.timeEnd('PriorityBuffer')

test/priority-buffer.perf.js

@@ -1,33 +1,11 @@
 import { test } from 'zora'
 import { PriorityBuffer } from '../src/priority-buffer.js'
 import { RingBufferDriver } from '@toolbuilder/ring-buffer-tests'
+import { SimplePriorityBuffer } from './simple-priority-buffer.js'
 
 // comparator for test
 const comparator = (a, b) => b - a
 
-/**
- * Super simple priority buffer to compare PriorityBuffer against.
- * Violates Liskov substitutability, but matches PriorityBuffer
- * behavior and API as required.
- */
-class SimplisticPriorityBuffer extends Array {
-  constructor (comparator, capacity) {
-    super()
-    this.capacity = capacity
-    this.comparator = comparator
-  }
-
-  front () { return this[0] }
-  back () { return this[this.length - 1] }
-
-  push (value) {
-    super.push(value)
-    super.sort(this.comparator)
-    if (this.length > this.capacity) this.pop()
-    return this.length
-  }
-}
-
 // Method collects state from buffers for comparing buffer states
 const getBufferState = (priorityBuffer) => {
   return {
@@ -41,7 +19,7 @@ const getBufferState = (priorityBuffer) => {
 
 // RingBufferDriver options for this test
 const driverOptions = {
-  exemplarFactory: (capacity) => new SimplisticPriorityBuffer(comparator, capacity),
+  exemplarFactory: (capacity) => new SimplePriorityBuffer(comparator, capacity),
   getState: getBufferState,
   methodPairs: [['push', 'shift']] // PriorityBuffer does not support unshift/pop
 }

test/priority-buffer.test.js

@@ -0,0 +1,23 @@
+/**
+ * Super simple priority buffer to act as an exemplar for PriorityBuffer tests.
+ * It matches the expected behavior of PriorityBuffer, but is extremely slow.
+ *
+ * It also violates Liskov substitutability for Array, but that's not an issue here.
+ */
+export class SimplePriorityBuffer extends Array {
+  constructor (comparator, capacity) {
+    super()
+    this.capacity = capacity
+    this.comparator = comparator
+  }
+
+  front () { return this[0] }
+  back () { return this[this.length - 1] }
+
+  push (value) {
+    super.push(value)
+    super.sort(this.comparator)
+    if (this.length > this.capacity) this.pop()
+    return this.length
+  }
+}