velocious 1.0.546 → 1.0.548

package/build/testing/test-runner.js

@@ -237,6 +237,8 @@ export default class TestRunner {
     this._failedTestDetails = []
     /** @type {{fullDescription: string, filePath: string, line: number} | null} */
     this._lastTestContext = null
+    /** @type {Array<{fullDescription: string, filePath: string, line: number, durationMs: number}>} */
+    this._testDurations = []
   }
 
   /**
@@ -696,6 +698,17 @@ export default class TestRunner {
     return this._successfulTests + this._failedTests
   }
 
+  /**
+   * Returns the tests recorded during the run, slowest first.
+   * @param {number} [limit] - Maximum number of tests to return (0 returns all).
+   * @returns {Array<{fullDescription: string, filePath: string, line: number, durationMs: number}>} - Slowest tests, slowest first.
+   */
+  getSlowestTests(limit = 10) {
+    const sorted = [...this._testDurations].sort((testA, testB) => testB.durationMs - testA.durationMs)
+
+    return limit > 0 ? sorted.slice(0, limit) : sorted
+  }
+
   /**
    * Runs prepare.
    * @returns {Promise<void>} - Resolves when complete.
@@ -706,6 +719,7 @@ export default class TestRunner {
     this._successfulTests = 0
     this._testsCount = 0
     this._failedTestDetails = []
+    this._testDurations = []
     await this.importTestFiles()
     await this.analyzeTests(tests)
     this._onlyFocussed = this.anyTestsFocussed
@@ -940,6 +954,8 @@ export default class TestRunner {
 
         console.log(`${leftPadding}it ${testDescription}`)
 
+        const testStartMs = Date.now()
+
         while (true) {
           let shouldRetry = false
           /**
@@ -1180,6 +1196,13 @@ export default class TestRunner {
 
           break
         }
+
+        this._testDurations.push({
+          fullDescription: this.buildFullDescription(descriptions, testDescription),
+          filePath: testData.filePath ?? "<unknown>",
+          line: testData.line ?? 0,
+          durationMs: Date.now() - testStartMs
+        })
       }
 
       for (const subDescription in tests.subs) {

package/package.json

@@ -3,7 +3,7 @@
     "velocious": "build/bin/velocious.js"
   },
   "name": "velocious",
-  "version": "1.0.546",
+  "version": "1.0.548",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

package/src/cli/tenant-database-command-helper.js

@@ -2,19 +2,25 @@
 
 import TenantIterator from "../tenants/tenant-iterator.js"
 
+const DEFAULT_HEARTBEAT_INTERVAL_MS = 30_000
+
 export default class TenantDatabaseCommandHelper {
   /**
    * Runs constructor.
    * @param {object} args - Options object.
    * @param {import("./base-command.js").default} args.command - CLI command instance.
+   * @param {number} [args.heartbeatIntervalMs] - Interval between progress heartbeats.
    * @param {string | undefined} args.identifier - Tenant database identifier.
+   * @param {(message: string) => void} [args.output] - Progress output handler.
    */
-  constructor({command, identifier}) {
+  constructor({command, heartbeatIntervalMs = DEFAULT_HEARTBEAT_INTERVAL_MS, identifier, output = console.log}) {
     if (!identifier) throw new Error("Missing tenant database identifier argument")
 
     this.command = command
     this.configuration = command.getConfiguration()
+    this.heartbeatIntervalMs = heartbeatIntervalMs
     this.identifier = identifier
+    this.output = output
     this.provider = this.configuration.getTenantDatabaseProvider(identifier)
   }
 
@@ -78,13 +84,42 @@ export default class TenantDatabaseCommandHelper {
    */
   async eachTenant(callback) {
     const tenants = await this.listTenants()
+    const commandName = this.command.processArgs?.[0] || "db:tenants"
+    const parallelCount = this.parallelCount()
+    const progressPrefix = `${commandName} ${this.identifier}`
+    let activeTenantCount = 0
+    let completedTenantCount = 0
     const iterator = new TenantIterator({
       configuration: this.configuration,
       identifier: this.identifier,
-      parallelCount: this.parallelCount()
+      parallelCount
     })
+    const progressHeartbeat = setInterval(() => {
+      this.output(`${progressPrefix}: heartbeat: ${completedTenantCount}/${tenants.length} completed, ${activeTenantCount} active`)
+    }, this.heartbeatIntervalMs)
+
+    progressHeartbeat.unref()
+    this.output(`${progressPrefix}: processing ${tenants.length} tenant(s) with parallelism ${parallelCount}`)
+
+    try {
+      const processedTenantCount = await iterator.run(tenants, async (args) => {
+        activeTenantCount++
+
+        try {
+          await callback(args)
+          completedTenantCount++
+          this.output(`${progressPrefix}: completed ${TenantIterator.tenantLabel(args.tenant)} (${completedTenantCount}/${tenants.length})`)
+        } finally {
+          activeTenantCount--
+        }
+      })
 
-    return await iterator.run(tenants, callback)
+      this.output(`${progressPrefix}: finished ${processedTenantCount}/${tenants.length} tenant(s)`)
+
+      return processedTenantCount
+    } finally {
+      clearInterval(progressHeartbeat)
+    }
   }
 
   /**

package/src/environment-handlers/node/cli/commands/test.js

@@ -86,6 +86,25 @@ export default class VelociousCliCommandsTest extends BaseCommand {
       process.exit(1)
     }
 
+    // Report the slowest tests so suite hotspots are visible every run. Defaults to
+    // the top 10; tune with VELOCIOUS_SLOW_TEST_COUNT (0 disables). Skipped for
+    // single-test runs where it would just be noise.
+    const slowTestCount = resolveSlowTestCount(process.env.VELOCIOUS_SLOW_TEST_COUNT)
+
+    if (slowTestCount > 0 && executedTests > 1) {
+      const slowestTests = testRunner.getSlowestTests(slowTestCount)
+
+      if (slowestTests.length > 0) {
+        console.log(picocolors.cyan(`\nSlowest ${slowestTests.length} tests:`))
+
+        for (const slowTest of slowestTests) {
+          const location = slowTest.filePath && slowTest.line ? ` (${slowTest.filePath}:${slowTest.line})` : ""
+
+          console.log(picocolors.cyan(`  ${String(slowTest.durationMs).padStart(6)}ms  ${slowTest.fullDescription}${location}`))
+        }
+      }
+    }
+
     if (testRunner.isFailed()) {
       await testRunner.persistFailedTestConsoleOutputsToAssets()
       const failedTests = testRunner.getFailedTestDetails()
@@ -116,3 +135,16 @@ export default class VelociousCliCommandsTest extends BaseCommand {
     }
   }
 }
+
+/**
+ * Resolves how many slowest tests to report from the `VELOCIOUS_SLOW_TEST_COUNT`
+ * env value: defaults to 10 when unset; 0 (or an unparseable value) disables the
+ * report; otherwise the floored, non-negative integer.
+ * @param {string | undefined} rawEnvValue - Raw env value.
+ * @returns {number} - Number of slowest tests to report (0 disables).
+ */
+export function resolveSlowTestCount(rawEnvValue) {
+  if (rawEnvValue === undefined) return 10
+
+  return Math.max(0, Math.floor(Number(rawEnvValue)) || 0)
+}

package/src/tenants/tenant-iterator.js

@@ -101,9 +101,14 @@ export default class TenantIterator {
     if (tenant && typeof tenant === "object") {
       const tenantObject = /** @type {{id?: ?, name?: ?, slug?: ?}} */ (tenant)
 
-      if (tenantObject.slug) return String(tenantObject.slug)
-      if (tenantObject.name) return String(tenantObject.name)
-      if (tenantObject.id) return String(tenantObject.id)
+      for (const attributeName of /** @type {Array<"slug" | "name" | "id">} */ (["slug", "name", "id"])) {
+        const attributeOrAccessor = tenantObject[attributeName]
+        const attributeValue = typeof attributeOrAccessor === "function"
+          ? attributeOrAccessor.call(tenant)
+          : attributeOrAccessor
+
+        if (attributeValue) return String(attributeValue)
+      }
     }
 
     return JSON.stringify(tenant)

package/src/testing/test-runner.js

@@ -237,6 +237,8 @@ export default class TestRunner {
     this._failedTestDetails = []
     /** @type {{fullDescription: string, filePath: string, line: number} | null} */
     this._lastTestContext = null
+    /** @type {Array<{fullDescription: string, filePath: string, line: number, durationMs: number}>} */
+    this._testDurations = []
   }
 
   /**
@@ -696,6 +698,17 @@ export default class TestRunner {
     return this._successfulTests + this._failedTests
   }
 
+  /**
+   * Returns the tests recorded during the run, slowest first.
+   * @param {number} [limit] - Maximum number of tests to return (0 returns all).
+   * @returns {Array<{fullDescription: string, filePath: string, line: number, durationMs: number}>} - Slowest tests, slowest first.
+   */
+  getSlowestTests(limit = 10) {
+    const sorted = [...this._testDurations].sort((testA, testB) => testB.durationMs - testA.durationMs)
+
+    return limit > 0 ? sorted.slice(0, limit) : sorted
+  }
+
   /**
    * Runs prepare.
    * @returns {Promise<void>} - Resolves when complete.
@@ -706,6 +719,7 @@ export default class TestRunner {
     this._successfulTests = 0
     this._testsCount = 0
     this._failedTestDetails = []
+    this._testDurations = []
     await this.importTestFiles()
     await this.analyzeTests(tests)
     this._onlyFocussed = this.anyTestsFocussed
@@ -940,6 +954,8 @@ export default class TestRunner {
 
         console.log(`${leftPadding}it ${testDescription}`)
 
+        const testStartMs = Date.now()
+
         while (true) {
           let shouldRetry = false
           /**
@@ -1180,6 +1196,13 @@ export default class TestRunner {
 
           break
         }
+
+        this._testDurations.push({
+          fullDescription: this.buildFullDescription(descriptions, testDescription),
+          filePath: testData.filePath ?? "<unknown>",
+          line: testData.line ?? 0,
+          durationMs: Date.now() - testStartMs
+        })
       }
 
       for (const subDescription in tests.subs) {