Async test or hook not properly handled

Oct 13, 2025 by wbrum.org 137 views

Failing Test: Chrome X-Pack UI Functional Tests.x-pack/test/functional/apps/status_page/index.ts - Status page "after all" hook: afterTestSuite.trigger in "Status page"

In the world of software development, testing is a crucial step in ensuring the quality and reliability of a product. However, even with the best testing strategies in place, failures can still occur. In this article, we will delve into a specific test failure that occurred on a tracked branch, and explore the possible causes and solutions.

The error message that triggered this investigation is as follows:

Error: Timeout of 360000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (/opt/buildkite-agent/builds/bk-agent-prod-gcp-1741633057010394975/elastic/kibana-on-merge/kibana/x-pack/test/functional/apps/status_page/index.ts)
    at listOnTimeout (node:internal/timers:581:17)
    at processTimers (node:internal/timers:519:7) {
  code: 'ERR_MOCHA_TIMEOUT',
  timeout: 360000,
  file: '/opt/buildkite-agent/builds/bk-agent-prod-gcp-1741633057010394975/elastic/kibana-on-merge/kibana/x-pack/test/functional/apps/status_page/index.ts'
}

This error message indicates that a timeout occurred while running the test, and that the test did not complete within the allotted time frame.

The first failure occurred on the kibana-on-merge - main build. This build was triggered by a change to the codebase, and the test failure was detected during the execution of the test suite.

The test in question is a functional test that is designed to verify the behavior of the status page in the Chrome X-Pack UI. The test is written in TypeScript and uses the Mocha testing framework. The test is triggered by the afterTestSuite.trigger hook, which is a built-in hook in Mocha that is called after the test suite has completed.

There are several possible causes for this test failure. Some of the most likely causes include:

Insufficient test timeout: The test timeout may be set too low, causing the test to timeout before it has a chance to complete.
Async test or hook not properly handled: The test or hook may not be properly handling asynchronous operations, causing the test to timeout.
Test or hook not properly cleaning up: The test or hook may not be properly cleaning up after itself, causing the test to timeout.

To resolve this test failure, we need to identify the root cause and implement a solution. Some possible solutions include:

Increasing the test timeout: We can increase the test timeout to give the test more time to complete.
Properly handling async tests or hooks: We can ensure that async tests and hooks are properly handled, and that the done() function is called or a Promise is resolved.
Properly cleaning up after tests or hooks: We can ensure that tests and hooks properly clean up after themselves, to prevent test timeouts.

In conclusion, the test failure that occurred on the kibana-on-merge - main build was caused by a timeout that occurred while running the test. The possible causes of this failure include insufficient test timeout, async test or hook not properly handled, and test or hook not properly cleaning up. To resolve this failure, we need to identify the root cause and implement a solution. By increasing the test timeout, properly handling async tests or hooks, and properly cleaning up after tests or hooks, we can ensure that the test passes and that the product is reliable and of high quality.

Based on the analysis of this test failure, we recommend the following:

Increase the test timeout: We recommend increasing the test timeout to give the test more time to complete.
Properly handle async tests or hooks: We recommend ensuring that async tests and hooks are properly handled, and that the done() function is called or a Promise is resolved.
Properly clean up after tests or hooks: We recommend ensuring that tests and hooks properly clean up after themselves, to prevent test timeouts.

By following these recommendations, we can ensure that the test passes and that the product is reliable and of high quality.
Failing Test: Chrome X-Pack UI Functional Tests.x-pack/test/functional/apps/status_page/index.ts - Status page "after all" hook: afterTestSuite.trigger in "Status page"

In the previous article, we explored the test failure that occurred on the kibana-on-merge - main build. In this article, we will answer some of the most frequently asked questions related to this test failure.

Q: What is the cause of the test failure?

A: The test failure is caused by a timeout that occurred while running the test. The test did not complete within the allotted time frame, resulting in a timeout error.

Q: Why did the test timeout?

A: There are several possible reasons why the test timed out. Some of the most likely causes include:

Insufficient test timeout: The test timeout may be set too low, causing the test to timeout before it has a chance to complete.
Async test or hook not properly handled: The test or hook may not be properly handling asynchronous operations, causing the test to timeout.
Test or hook not properly cleaning up: The test or hook may not be properly cleaning up after itself, causing the test to timeout.

Q: How can I increase the test timeout?

A: To increase the test timeout, you can modify the test configuration to set a longer timeout value. This can be done by modifying the timeout property in the test configuration file.

Q: How can I properly handle async tests or hooks?

A: To properly handle async tests or hooks, you can use the done() function to indicate that the test or hook has completed. Alternatively, you can return a Promise that resolves when the test or hook has completed.

Q: How can I properly clean up after tests or hooks?

A: To properly clean up after tests or hooks, you can use the afterEach() hook to clean up any resources that were used during the test or hook.

Q: What are some best practices for writing tests?

A: Some best practices for writing tests include:

Keep tests simple and focused: Tests should be simple and focused on a specific piece of functionality.
Use descriptive names: Test names should be descriptive and clearly indicate what the test is testing.
Use assertions: Tests should use assertions to verify that the expected behavior occurs.
Use mocking: Tests should use mocking to isolate dependencies and make the test more reliable.

Q: What are some common pitfalls to avoid when writing tests?

A: Some common pitfalls to avoid when writing tests include:

Testing too much at once: Tests should be focused on a specific piece of functionality, rather than testing too much at once.
Not using assertions: Tests should use assertions to verify that the expected behavior occurs.
Not using mocking: Tests should use mocking to isolate dependencies and make the test more reliable.
Not cleaning up after tests: Tests should clean up after themselves to prevent test timeouts.

In conclusion, the test failure that occurred on the kibana-on-merge - main build was caused by a timeout that occurred while running the test. By understanding the possible causes of the failure and following best practices for writing tests, we can ensure that the test passes and that the product is reliable and of high quality.