Jest reports open handles when running E2E

[aaemnnosttv]

Bug Description

> test:e2e
> cross-env WP_BASE_URL=http://localhost:9002 ./script.js "specs/api-cache"

**INFO** Skipping browser download. "PUPPETEER_SKIP_DOWNLOAD" was set in project config.
 PASS  specs/api-cache.test.js (16.158 s)
  API cache
    ✓ isolates client storage between sessions (5682 ms)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        16.282 s
Ran all test suites matching /specs\/api-cache/i.
Jest did not exit one second after the test run has completed.

This usually means that there are asynchronous operations that weren't stopped in your tests. Consider running Jest with `--detectOpenHandles` to troubleshoot this issue.

Note the last line above

Running with --detectOpenHandles found the cause related to dependencies used by Dockerode.

Ran all test suites matching /specs\/api-cache/i.

Jest has detected the following 1 open handle potentially keeping Jest from exiting:

  ●  ZLIB

      at Object.<anonymous> (../../node_modules/ssh2/lib/protocol/zlib.js:17:20)
      at Object.<anonymous> (../../node_modules/ssh2/lib/protocol/kex.js:48:5)

Steps to reproduce

1. Run an E2E test that does not produce any output to the WP container log stream (e.g. specs/api-cache)

---

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

• Jest warnings about open handles following E2E test runs are resolved

Implementation Brief

• The problem is due to the log stream reference only being stored when the log receives data. Since this doesn't always happen, the teardown doesn't clean up the open stream in these cases.
• Refactor with AbortController by passing an abortSignal to the call to container.logs https://github.com/apocas/dockerode/blob/7c3d517e9ca468aa1794f2b825a5b5533300c49d/lib/container.js#L1018C5-L1018C16
• Update the teardown to call abort() on the controller to close the stream in all cases, replacing the previous use of stream.destroy()
• Merge Fix Jest open handle warnings in E2E #10207

Test Coverage

• No changes

QA Brief

• This can be verified locally as it isn't visible in CI since it runs over all tests which causes the log to be populated at some point
• A simple test which can be used is to run npm run test:e2e -- specs/api-cache
  • This tests the happy path (no logs recorded)
  • To test this with log output, run the same with a small temporary modification to ensure the PHP log is written to during this test:

diff --git a/tests/e2e/mu-plugins/e2e-rest-time-endpoint.php b/tests/e2e/mu-plugins/e2e-rest-time-endpoint.php
index 912769d58b..abcd412266 100644
--- a/tests/e2e/mu-plugins/e2e-rest-time-endpoint.php
+++ b/tests/e2e/mu-plugins/e2e-rest-time-endpoint.php
@@ -24,6 +24,7 @@ add_action(
 			array(
 				'methods'             => WP_REST_Server::READABLE,
 				'callback'            => function () {
+					error_log( time() );
 					return array(
 						'time'      => time(),
 						'microtime' => microtime( true ),

You should be able to verify the additions to the logs by inspecting the wordpress-debug-log-1 container logs in Docker, but also, the test would be expected to fail due to this triggering our assertions (working correctly)

Changelog entry