Command timeout vs assertion timeout in Cypress - Framework Approaches Compared

Framework Mode - Command timeout vs assertion timeout

Folder Structure of a Cypress Test Project

cypress/
├── e2e/                  # Test specs
│   ├── login.cy.js       # Example test file
│   └── dashboard.cy.js
├── fixtures/             # Test data files (JSON)
│   └── users.json
├── support/              # Custom commands and reusable code
│   ├── commands.js       # Custom Cypress commands
│   └── e2e.js            # Global support file
cypress.config.js         # Cypress configuration file
package.json             # Project dependencies and scripts

Test Framework Layers in Cypress

• Test Specs (cypress/e2e/): Contains the actual test scripts where commands and assertions run.
• Support Layer (cypress/support/): Holds reusable commands and setup code to keep tests clean.
• Fixtures (cypress/fixtures/): Stores test data like JSON files to use in tests.
• Configuration (cypress.config.js): Defines global settings like timeouts, base URL, and environment variables.

Configuration Patterns for Timeouts in Cypress

Cypress allows setting timeouts globally or per command/assertion:

• Command Timeout: Maximum time Cypress waits for a command to complete (like cy.get() or cy.click()).
• Assertion Timeout: Maximum time Cypress waits for an assertion to pass (like should('be.visible')).

Example cypress.config.js snippet:

export default defineConfig({
  e2e: {
    baseUrl: 'https://example.com',
    defaultCommandTimeout: 8000,    // 8 seconds for commands
    responseTimeout: 5000,          // 5 seconds for server responses
    pageLoadTimeout: 60000,         // 60 seconds for page load
    // Assertion timeout is controlled by 'timeout' option in assertions
  }
})

Override timeout in a test assertion example:

cy.get('#submit-button').should('be.visible', { timeout: 10000 })

Test Reporting and CI/CD Integration

• Reporting: Use Cypress built-in reporter or plugins like mochawesome for detailed HTML reports showing passed/failed tests and timing.
• CI/CD: Integrate Cypress tests in pipelines (GitHub Actions, Jenkins) to run tests on code changes automatically.
• Timeout Failures: If command or assertion timeouts are exceeded, tests fail and report the timeout error clearly.

Best Practices for Handling Command and Assertion Timeouts in Cypress

1. Set sensible global timeouts: Use defaultCommandTimeout to cover most commands but avoid too long waits that slow tests.
2. Use assertion timeouts wisely: Override assertion timeout only when waiting for slow UI changes, like animations or API responses.
3. Avoid mixing timeouts: Understand that command timeout is for finding elements or running commands, assertion timeout is for waiting conditions to be true.
4. Fail fast: Keep timeouts short enough to detect problems quickly but long enough to avoid flaky tests.
5. Use retries carefully: Cypress retries assertions automatically until timeout; do not add manual retries that conflict.

Self Check Question

Where in the Cypress project folder structure would you configure the global command timeout setting?

Key Result

In Cypress, command timeout controls how long to wait for commands, while assertion timeout controls how long to wait for conditions to be true; both are configured in cypress.config.js and can be overridden per test.

Practice

1. What is the main difference between command timeout and assertion timeout in Cypress?

easy

A. Command timeout is for API calls; assertion timeout is for UI rendering.

B. Command timeout waits for page load; assertion timeout waits for network requests.

C. Command timeout waits for actions like finding elements; assertion timeout waits for checks like visibility.

D. Command timeout waits for assertions; assertion timeout waits for commands.

Solution

1. Step 1: Understand command timeout purpose

   Command timeout is the time Cypress waits to find or interact with elements before failing.

2. Step 2: Understand assertion timeout purpose

   Assertion timeout is the time Cypress waits for conditions like visibility or text to become true in assertions.

3. Final Answer:

   Command timeout waits for actions like finding elements; assertion timeout waits for checks like visibility. -> Option C

4. Quick Check:

   Command timeout vs assertion timeout = Command timeout waits for actions like finding elements; assertion timeout waits for checks like visibility. [OK]

Hint: Command = action wait, Assertion = check wait [OK]

Common Mistakes:

• Confusing command timeout with page load timeout
• Thinking assertion timeout waits for commands
• Mixing up API calls with UI element waits

2. Which of the following is the correct way to set a command timeout of 10 seconds in Cypress?

easy

A. cy.get('button', { timeout: 10000 })

B. cy.get('button').timeout(10000)

C. cy.get('button').setTimeout(10000)

D. cy.get('button').waitTimeout(10000)

Solution

1. Step 1: Recall Cypress command timeout syntax

   Timeout for commands like cy.get() is set by passing an options object with timeout in milliseconds.

2. Step 2: Check each option for correct syntax

   Only cy.get('button', { timeout: 10000 }) uses the correct syntax. The others use invalid methods.

3. Final Answer:

   cy.get('button', { timeout: 10000 }) -> Option A

4. Quick Check:

   Command timeout syntax = cy.get('button', { timeout: 10000 }) [OK]

Hint: Timeout is an option object in commands [OK]

Common Mistakes:

• Using non-existent methods like .timeout()
• Passing timeout as a separate method
• Confusing assertion timeout syntax with command timeout

3. Consider this Cypress code snippet:

cy.get('#submit', { timeout: 5000 }).click();
cy.get('#message').should('be.visible', { timeout: 10000 });

What happens if the #submit button appears after 6 seconds and the #message appears after 8 seconds?

medium

A. Test fails at clicking #submit but passes the visibility check for #message.

B. Test passes both clicking #submit and visibility check for #message.

C. Test fails both clicking #submit and visibility check for #message.

D. Test passes clicking #submit but fails visibility check for #message.

Solution

1. Step 1: Analyze command timeout for #submit

   The command timeout is 5000 ms (5 seconds). The button appears after 6 seconds, which is too late, so the click command fails.

2. Step 2: Analyze assertion timeout for #message

   The assertion timeout is 10000 ms (10 seconds). The message appears after 8 seconds, which is within timeout, so the assertion passes.

3. Final Answer:

   Test fails at clicking #submit but passes the visibility check for #message. -> Option A

4. Quick Check:

   Command timeout too short, assertion timeout sufficient = Test fails at clicking #submit but passes the visibility check for #message. [OK]

Hint: Command timeout limits action wait; assertion timeout limits check wait [OK]

Common Mistakes:

• Assuming both timeouts behave the same
• Ignoring timeout values in options
• Thinking assertion timeout affects commands

4. You wrote this Cypress test:

cy.get('.loading', { timeout: 3000 }).should('not.exist');

But the test fails because the element disappears after 5 seconds. What is the best fix?

medium

A. Increase the command timeout to more than 5000 ms.

B. Change should('not.exist') to should('be.visible').

C. Add a cy.wait(5000) before the assertion.

D. Increase the assertion timeout to more than 5000 ms.

Solution

1. Step 1: Identify what is being waited on

   The test waits for the element to disappear, which is an assertion (should('not.exist')).

2. Step 2: Adjust the correct timeout

   The command timeout controls finding the element, but the assertion timeout controls waiting for the condition. Since the element disappears after 5 seconds, increase assertion timeout beyond 5000 ms.

3. Final Answer:

   Increase the assertion timeout to more than 5000 ms. -> Option D

4. Quick Check:

   Assertion timeout controls condition wait = Increase the assertion timeout to more than 5000 ms. [OK]

Hint: Wait for condition? Increase assertion timeout [OK]

Common Mistakes:

• Increasing command timeout instead of assertion timeout
• Using fixed wait instead of timeout adjustment
• Changing assertion logic incorrectly

5. You want to test a slow-loading modal that appears after clicking a button. The button may take up to 4 seconds to appear, and the modal may take up to 7 seconds to become visible. Which is the best way to set timeouts in Cypress?

hard

A. Use cy.get('button').click({ timeout: 7000 }) and cy.get('.modal').should('be.visible', { timeout: 4000 }).

B. Use cy.get('button', { timeout: 5000 }).click() and cy.get('.modal').should('be.visible', { timeout: 8000 }).

C. Use cy.get('button', { timeout: 3000 }).click() and cy.get('.modal').should('be.visible', { timeout: 3000 }).

D. Use cy.get('button').click() and cy.get('.modal').should('be.visible') with no timeouts set.

Solution

1. Step 1: Set command timeout for button appearance

   The button may appear after up to 4 seconds, so set command timeout slightly higher (5000 ms) to allow finding it.

2. Step 2: Set assertion timeout for modal visibility

   The modal may take up to 7 seconds to appear, so set assertion timeout higher (8000 ms) to wait for visibility.

3. Final Answer:

   Use cy.get('button', { timeout: 5000 }).click() and cy.get('.modal').should('be.visible', { timeout: 8000 }). -> Option B

4. Quick Check:

   Command timeout for action, assertion timeout for condition = Use cy.get('button', { timeout: 5000 }).click() and cy.get('.modal').should('be.visible', { timeout: 8000 }). [OK]

Hint: Set command timeout for element, assertion timeout for checks [OK]

Common Mistakes:

• Swapping timeout values between command and assertion
• Setting timeouts too low causing flaky tests
• Not setting timeouts causing premature failures