Task command for Node operations in Cypress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the task command in Cypress?

The task command lets Cypress run Node.js code outside the browser, enabling operations like file system access or database queries that the browser cannot perform.

intermediate

How do you define a custom task in Cypress?

You define a custom task inside the cypress.config.js file under the setupNodeEvents function using on('task', { ... }) and provide task names with their corresponding Node.js functions.

intermediate

Example: What does this Cypress task do?

on('task', { readFile(filename) { return fs.readFileSync(filename, 'utf8') } })

This task reads the content of a file named filename synchronously and returns its text content to the Cypress test.

beginner

Why can't Cypress tests directly use Node.js modules like fs inside cy.* commands?

Because Cypress commands run inside the browser environment, which does not have access to Node.js modules. The task command bridges this gap by running Node code in the background process.

beginner

How do you call a custom task named readFile from a Cypress test?

Use cy.task('readFile', 'path/to/file.txt').then(content => { ... }) to call the task and handle the returned content asynchronously.

What is the main reason to use cy.task in Cypress?

A To run Node.js code like file operations

B To interact with DOM elements

C To send HTTP requests

D To take screenshots

cy.task is used to run Node.js code such as file system operations, which cannot be done inside the browser environment where Cypress commands run.

Where do you define custom tasks in a Cypress project?

A In <code>cypress.config.js</code> under <code>setupNodeEvents</code>

B In <code>package.json</code>

C In the browser console

D Inside the test spec files

Custom tasks are defined in cypress.config.js inside the setupNodeEvents function using on('task', { ... }).

Which of these is a valid way to call a task named getData in a Cypress test?

A cy.getData()

B cy.invoke('getData')

C cy.task('getData')

D cy.run('getData')

You call tasks using cy.task('taskName') syntax.

What kind of code runs inside the task handler in Cypress?

A Browser JavaScript

B Node.js code

C CSS styles

D HTML markup

The task handler runs Node.js code in the background process, outside the browser.

If a task returns a value, how do you access it in your Cypress test?

A Directly as a return value

B Using a callback function

C It is not possible to get return values

D Using a <code>.then()</code> after <code>cy.task()</code>

Since cy.task() is asynchronous, you use .then() to access the returned value.

Explain how Cypress task commands help in performing Node.js operations during tests.

Think about what Cypress cannot do inside the browser and how tasks solve that.

Describe the steps to create and use a custom task that reads a file content in Cypress.

Focus on where to write the task and how to call it from the test.

Practice

1. What is the main purpose of the cy.task() command in Cypress?

easy

A. To run Node.js code during Cypress tests

B. To select elements on the webpage

C. To assert values in the DOM

D. To take screenshots automatically

Solution

1. Step 1: Understand the role of cy.task()

   The cy.task() command allows Cypress tests to execute Node.js code outside the browser environment.

2. Step 2: Differentiate from other commands

   Commands like selecting elements or assertions happen inside the browser, but cy.task() runs backend code for tasks like file access.

3. Final Answer:

   To run Node.js code during Cypress tests -> Option A

4. Quick Check:

   Node code execution = A [OK]

Hint: Remember: cy.task() runs backend Node code [OK]

Common Mistakes:

• Confusing cy.task() with DOM commands
• Thinking cy.task() runs in the browser
• Assuming cy.task() is for assertions

2. Which of the following is the correct way to call a task named readFile in a Cypress test?

easy

A. cy.command('readFile')

B. cy.readFile('readFile')

C. cy.task('readFile')

D. cy.nodeTask('readFile')

Solution

1. Step 1: Recall the syntax for calling tasks

   In Cypress, tasks defined in the config are called using cy.task('taskName').

2. Step 2: Verify other options

   cy.readFile is a different command for reading files in the browser context, not tasks. The others are invalid commands.

3. Final Answer:

   cy.task('readFile') -> Option C

4. Quick Check:

   Use cy.task() to call tasks [OK]

Hint: Use cy.task('name') to run tasks [OK]

Common Mistakes:

• Using cy.readFile instead of cy.task
• Trying non-existent commands like cy.nodeTask
• Passing task name without quotes

3. Given this task definition in cypress.config.js:

tasks: {
  getEnv() {
    return process.env.NODE_ENV
  }
}

What will this test print?

cy.task('getEnv').then(env => {
  cy.log(env)
})

medium

A. It throws a syntax error

B. It logs an empty string

C. It logs 'undefined'

D. It logs the current NODE_ENV value

Solution

1. Step 1: Understand the task function

   The task getEnv returns the value of process.env.NODE_ENV, which is the environment mode (like 'development' or 'production').

2. Step 2: Analyze the test code

   The test calls cy.task('getEnv') and logs the returned value, so it will print the current environment string.

3. Final Answer:

   It logs the current NODE_ENV value -> Option D

4. Quick Check:

   Task returns env string = B [OK]

Hint: Tasks return Node values; cy.task() logs them [OK]

Common Mistakes:

• Assuming task runs in browser context
• Expecting syntax errors from valid code
• Thinking environment variables are empty by default

4. What is wrong with this task definition in cypress.config.js?

tasks: {
  readFile(path) {
    const fs = require('fs')
    return fs.readFileSync(path, 'utf8')
  }
}

When called as cy.task('readFile', 'data.txt'), it throws an error.

medium

A. The task function must return a Promise or value, but readFileSync is synchronous

B. The task should be defined as an async function returning a Promise

C. Tasks cannot accept arguments

D. The require statement is not allowed inside tasks

Solution

1. Step 1: Understand task function requirements

   Cypress tasks should return a value or a Promise. Using synchronous readFileSync is allowed but can cause blocking issues.

2. Step 2: Identify best practice for async operations

   To avoid errors and improve performance, tasks reading files should be async and return a Promise, e.g., using fs.promises.readFile.

3. Step 3: Analyze the error cause

   The error likely occurs because Cypress expects a Promise for async tasks, so defining the task as async fixes it.

4. Final Answer:

   The task should be defined as an async function returning a Promise -> Option B

5. Quick Check:

   Async tasks return Promises = D [OK]

Hint: Use async functions for tasks doing file I/O [OK]

Common Mistakes:

• Thinking synchronous code always works in tasks
• Believing require is disallowed inside tasks
• Assuming tasks cannot take arguments

5. You want to create a Cypress task that reads a JSON file and returns only the keys of the top-level object. Which task definition is correct?

hard

A. async readKeys(file) {
const fs = require('fs').promises
const data = await fs.readFile(file, 'utf8')
return Object.keys(JSON.parse(data))
}

B. readKeys(file) {
const fs = require('fs')
const data = fs.readFileSync(file, 'utf8')
return JSON.parse(data).keys()
}

C. async readKeys(file) {
const fs = require('fs')
const data = await fs.readFile(file, 'utf8')
return Object.keys(data)
}

D. readKeys(file) {
const fs = require('fs')
const data = fs.readFileSync(file, 'utf8')
return Object.keys(data)
}

Solution

1. Step 1: Read file asynchronously and parse JSON

   async readKeys(file) { const fs = require('fs').promises const data = await fs.readFile(file, 'utf8') return Object.keys(JSON.parse(data)) } correctly uses fs.promises.readFile with await to read the file asynchronously, then parses JSON.

2. Step 2: Extract keys from parsed object

   It returns Object.keys() of the parsed JSON, which gives the top-level keys as required.

3. Step 3: Identify errors in other options

   readKeys(file) { const fs = require('fs') const data = fs.readFileSync(file, 'utf8') return JSON.parse(data).keys() } incorrectly calls .keys() on the parsed object (should use Object.keys()). Options C and D try to get keys from raw string data, which is incorrect.

4. Final Answer:

   async readKeys(file) { const fs = require('fs').promises const data = await fs.readFile(file, 'utf8') return Object.keys(JSON.parse(data)) } -> Option A

5. Quick Check:

   Async read + JSON parse + Object.keys = A [OK]

Hint: Parse JSON first, then get keys with Object.keys() [OK]

Common Mistakes:

• Calling .keys() on object instead of Object.keys()
• Trying to get keys from raw string data
• Using synchronous read without async/await properly