feat: Add 'slowTestThreshold' and fix this.slow() inside specs (#18496)

Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com>
cypress-io · Oct 25, 2021 · 776b730 · 776b730 · cypress-bot · Oct 25, 2021
1 parent c027f28
commit 776b730
Show file tree

Hide file tree

Showing 16 changed files with 1,325 additions and 798 deletions.
diff --git a/cli/schema/cypress.schema.json b/cli/schema/cypress.schema.json
@@ -44,6 +44,11 @@
           "default": null,
           "description": "The reporter options used. Supported options depend on the reporter. See https://on.cypress.io/reporters#Reporter-Options"
         },
+        "slowTestThreshold": {
+          "type": "number",
+          "default": 10000,
+          "description": "Slow test threshold in milliseconds. Only affects the visual output of some reporters. For example, the spec reporter will display the test time in yellow if over the threshold. See https://on.cypress.io/configuration#Timeouts"
+        },
         "testFiles": {
           "type": [
             "string",

diff --git a/cli/types/cypress-npm-api.d.ts b/cli/types/cypress-npm-api.d.ts
@@ -91,6 +91,10 @@ declare namespace CypressCommandLine {
      * Specify mocha reporter options
      */
     reporterOptions: any
+    /**
+     * Slow test threshold in milliseconds. Only affects the visual output of some reporters. For example, the spec reporter will display the test time in yellow if over the threshold.
+     */
+    slowTestThreshold: number
     /**
      * Specify the specs to run
      */

diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -2577,6 +2577,11 @@ declare namespace Cypress {
      * @default "spec"
      */
     reporterOptions: { [key: string]: any }
+    /**
+     * Slow test threshold in milliseconds. Only affects the visual output of some reporters. For example, the spec reporter will display the test time in yellow if over the threshold.
+     * @default 10000
+     */
+    slowTestThreshold: number
     /**
      * Whether Cypress will watch and restart tests on test file changes
      * @default true

diff --git a/packages/driver/src/cypress/mocha.ts b/packages/driver/src/cypress/mocha.ts
@@ -500,6 +500,8 @@ const create = (specWindow, Cypress, config) => {
 
   const _mocha = createMocha(specWindow)
 
+  _mocha.slow(config('slowTestThreshold'))
+
   const _runner = getRunner(_mocha)
 
   _mocha.suite.file = Cypress.spec.relative

diff --git a/packages/driver/src/cypress/runner.ts b/packages/driver/src/cypress/runner.ts
@@ -21,7 +21,7 @@ const TEST_BEFORE_RUN_EVENT = 'runner:test:before:run'
 const TEST_AFTER_RUN_EVENT = 'runner:test:after:run'
 
 const RUNNABLE_LOGS = 'routes agents commands hooks'.split(' ')
-const RUNNABLE_PROPS = '_testConfig id order title _titlePath root hookName hookId err state failedFromHookId body speed type duration wallClockStartedAt wallClockDuration timings file originalTitle invocationDetails final currentRetry retries'.split(' ')
+const RUNNABLE_PROPS = '_testConfig id order title _titlePath root hookName hookId err state failedFromHookId body speed type duration wallClockStartedAt wallClockDuration timings file originalTitle invocationDetails final currentRetry retries _slow'.split(' ')
 
 const debug = debugFn('cypress:driver:runner')
 const debugErrors = debugFn('cypress:driver:errors')
@@ -581,6 +581,10 @@ const normalize = (runnable, tests, initialTests, onRunnable, onLogsById, getRun
         wrappedRunnable._testConfig = cfg
       }
 
+      if (cfg.slowTestThreshold) {
+        runnable.slow(cfg.slowTestThreshold)
+      }
+
       wrappedRunnable._titlePath = runnable.titlePath()
     }