Dynamic response stubbing in Cypress

Introduction

Dynamic response stubbing lets you change the data a server sends back during tests. This helps you test different situations without changing the real server.

You want to test how your app behaves with different server data without calling the real server.

You need to simulate errors or slow responses from the server to see how your app handles them.

You want to test user flows that depend on changing server responses.

You want to speed up tests by avoiding real network calls.

You want to isolate frontend tests from backend changes.

Syntax

Cypress

cy.intercept(method, url, (req) => {
  req.reply((res) => {
    // modify res.body or res.statusCode dynamically
  })
})

method is the HTTP method like 'GET' or 'POST'.

You can change the response inside req.reply callback before it reaches your app.

Examples

This changes the user list to always return one user named Alice.

Cypress

cy.intercept('GET', '/api/users', (req) => {
  req.reply((res) => {
    res.body = [{ id: 1, name: 'Alice' }]
  })
})

This returns an empty list for page 2 but lets other requests go to the real server.

Cypress

cy.intercept('GET', '/api/items', (req) => {
  if (req.query.page === '2') {
    req.reply({ body: [] })
  } else {
    req.continue()
  }
})

This blocks login for 'admin' user with a 403 error but allows others.

Cypress

cy.intercept('POST', '/api/login', (req) => {
  if (req.body.username === 'admin') {
    req.reply({ statusCode: 403, body: { error: 'Forbidden' } })
  } else {
    req.continue()
  }
})

Sample Program

This test changes the user list response dynamically. If the server returns no users, it adds a default user. Otherwise, it adds an extra user to the list. Then it checks the page shows users including the extra one.

Cypress

describe('Dynamic response stubbing example', () => {
  it('stubs user data dynamically', () => {
    cy.intercept('GET', '/api/users', (req) => {
      req.reply((res) => {
        if (!res.body || res.body.length === 0) {
          res.body = [{ id: 1, name: 'Default User' }]
        } else {
          res.body.push({ id: 2, name: 'Extra User' })
        }
      })
    })

    cy.visit('/users')
    cy.get('.user').should('have.length.greaterThan', 0)
    cy.get('.user').last().should('contain.text', 'Extra User')
  })
})

Important Notes

Use req.continue() to let the request go to the real server if you don't want to stub it.

Dynamic stubbing helps test many cases without writing separate static mocks.

Always check your selectors in cy.get() to match your app's HTML structure.

Summary

Dynamic response stubbing changes server replies during tests to simulate different scenarios.

It helps test error handling, different data sets, and speeds up tests by avoiding real network calls.

Use cy.intercept with a callback to modify responses on the fly.

Practice

1. What is the main purpose of dynamic response stubbing in Cypress tests?

easy

A. To change server responses during tests to simulate different scenarios

B. To speed up the browser rendering process

C. To automatically generate test data from the server

D. To record user interactions for playback

Solution

1. Step 1: Understand dynamic response stubbing

   Dynamic response stubbing allows tests to modify server replies on the fly to simulate various conditions.

2. Step 2: Identify the main goal

   This helps test how the app behaves with different data or errors without relying on real server responses.

3. Final Answer:

   To change server responses during tests to simulate different scenarios -> Option A

4. Quick Check:

   Dynamic stubbing = simulate different server replies [OK]

Hint: Dynamic stubbing means changing server replies during tests [OK]

Common Mistakes:

• Confusing stubbing with speeding up rendering
• Thinking it generates test data automatically
• Mixing it up with recording user actions

2. Which of the following is the correct way to stub a dynamic response using cy.intercept in Cypress?

easy

A. cy.intercept('GET', '/api/data', { status: 200, body: { value: 42 } })

B. cy.intercept('GET', '/api/data', (res) => { res.send({ value: 42 }) })

C. cy.intercept('GET', '/api/data', () => { return { value: 42 } })

D. cy.intercept('GET', '/api/data', (req) => { req.reply({ body: { value: 42 } }) })

Solution

1. Step 1: Recall cy.intercept syntax for dynamic stubbing

   To modify the response dynamically, use a callback with the request object and call req.reply() with the new body.

2. Step 2: Check each option

   cy.intercept('GET', '/api/data', (req) => { req.reply({ body: { value: 42 } }) }) correctly uses (req) => { req.reply({ body: ... }) }. cy.intercept('GET', '/api/data', { status: 200, body: { value: 42 } }) is static stubbing, C returns a value incorrectly, D uses res.send which is not Cypress syntax.

3. Final Answer:

   cy.intercept('GET', '/api/data', (req) => { req.reply({ body: { value: 42 } }) }) -> Option D

4. Quick Check:

   Dynamic stub uses req.reply() callback [OK]

Hint: Use req.reply() inside intercept callback for dynamic response [OK]

Common Mistakes:

• Using static object instead of callback for dynamic stubbing
• Returning response instead of calling req.reply()
• Using incorrect callback parameter names

3. Given the following Cypress code, what will be the response body when the app requests '/api/user'?

cy.intercept('GET', '/api/user', (req) => {
  const id = req.query.id
  if (id === '1') {
    req.reply({ body: { name: 'Alice' } })
  } else {
    req.reply({ body: { name: 'Guest' } })
  }
})

The app calls fetch('/api/user?id=1'). What is the response?

medium

A. Empty response body

B. { name: 'Guest' }

C. { name: 'Alice' }

D. An error occurs because req.query is undefined

Solution

1. Step 1: Analyze the intercept callback logic

   The callback checks req.query.id. If it equals '1', it replies with { name: 'Alice' }, else { name: 'Guest' }.

2. Step 2: Check the request URL query

   The app calls '/api/user?id=1', so req.query.id is '1'. Therefore, the response is { name: 'Alice' }.

3. Final Answer:

   { name: 'Alice' } -> Option C

4. Quick Check:

   Query id '1' returns Alice [OK]

Hint: Match query params in req.query to decide response [OK]

Common Mistakes:

• Assuming req.query is undefined in Cypress intercept
• Ignoring query parameters in the stub
• Confusing string and number types in comparison

4. Identify the error in this Cypress dynamic stub code:

cy.intercept('POST', '/api/login', (req) => {
  req.reply({ statusCode: 200, body: { token: 'abc123' } })
})

The test fails with an error about req.reply not being a function. What is wrong?

medium

A. The callback receives req but req.reply is not a function; should use req.continue

B. The callback parameter should be interception and interception.reply used

C. The callback parameter is correct, but req.reply is only available on res

D. The callback parameter should be named res instead of req

Solution

1. Step 1: Understand intercept callback parameter

   The callback receives an interception object, often named interception, which has the reply method.

2. Step 2: Identify the naming and usage error

   Using req as parameter is allowed but req.reply is not a function because the object is not the request but the interception. The correct approach is to name it interception and call interception.reply().

3. Final Answer:

   The callback parameter should be interception and interception.reply used -> Option B

4. Quick Check:

   Use interception.reply() in intercept callback [OK]

Hint: Use interception.reply(), not req.reply(), in intercept callback [OK]

Common Mistakes:

• Confusing request object with interception object
• Using req.reply() which does not exist
• Misnaming callback parameter causing method errors

5. You want to stub a GET request to '/api/items' so that the response body depends on a query parameter 'type'. If 'type' is 'fruit', respond with { items: ['apple', 'banana'] }. If 'type' is 'vegetable', respond with { items: ['carrot', 'lettuce'] }. Otherwise, respond with { items: [] }. Which code correctly implements this dynamic response stubbing?

hard

A. cy.intercept('GET', '/api/items', (interception) => {
const type = interception.query.type
if (type === 'fruit') {
interception.reply({ body: { items: ['apple', 'banana'] } })
} else if (type === 'vegetable') {
interception.reply({ body: { items: ['carrot', 'lettuce'] } })
} else {
interception.reply({ body: { items: [] } })
}
})

B. cy.intercept('GET', '/api/items', (req) => {
if (req.query.type === 'fruit') {
req.reply({ items: ['apple', 'banana'] })
} else if (req.query.type === 'vegetable') {
req.reply({ items: ['carrot', 'lettuce'] })
} else {
req.reply({ items: [] })
}
})

C. cy.intercept('GET', '/api/items', (req) => {
const type = req.query.type
if (type === 'fruit') {
req.reply({ body: { items: ['apple', 'banana'] } })
} else if (type === 'vegetable') {
req.reply({ body: { items: ['carrot', 'lettuce'] } })
} else {
req.reply({ body: { items: [] } })
}
})

D. cy.intercept('GET', '/api/items', (interception) => {
const type = interception.query.type
if (type === 'fruit') {
interception.send({ body: { items: ['apple', 'banana'] } })
} else if (type === 'vegetable') {
interception.send({ body: { items: ['carrot', 'lettuce'] } })
} else {
interception.send({ body: { items: [] } })
}
})

Solution

1. Step 1: Identify correct parameter and method usage

   The callback parameter should be named interception (or similar) and use interception.reply() to send the response with a body property.

2. Step 2: Check each option for correctness

   cy.intercept('GET', '/api/items', (interception) => { const type = interception.query.type if (type === 'fruit') { interception.reply({ body: { items: ['apple', 'banana'] } }) } else if (type === 'vegetable') { interception.reply({ body: { items: ['carrot', 'lettuce'] } }) } else { interception.reply({ body: { items: [] } }) } }) correctly uses interception.query.type and calls interception.reply({ body: ... }). cy.intercept('GET', '/api/items', (req) => { if (req.query.type === 'fruit') { req.reply({ items: ['apple', 'banana'] }) } else if (req.query.type === 'vegetable') { req.reply({ items: ['carrot', 'lettuce'] }) } else { req.reply({ items: [] }) } }) misses body wrapper. cy.intercept('GET', '/api/items', (req) => { const type = req.query.type if (type === 'fruit') { req.reply({ body: { items: ['apple', 'banana'] } }) } else if (type === 'vegetable') { req.reply({ body: { items: ['carrot', 'lettuce'] } }) } else { req.reply({ body: { items: [] } }) } }) uses req but req.reply is not a function. cy.intercept('GET', '/api/items', (interception) => { const type = interception.query.type if (type === 'fruit') { interception.send({ body: { items: ['apple', 'banana'] } }) } else if (type === 'vegetable') { interception.send({ body: { items: ['carrot', 'lettuce'] } }) } else { interception.send({ body: { items: [] } }) } }) uses interception.send which is not a Cypress method.

3. Final Answer:

   Option A code correctly implements dynamic response stubbing with query check and reply -> Option A

4. Quick Check:

   Use interception.reply({ body }) and check interception.query [OK]

Hint: Use interception.reply({ body }) and check interception.query.type [OK]

Common Mistakes:

• Using req.reply() which is undefined
• Omitting the body wrapper in reply
• Using interception.send() which does not exist