Reporting tests with open handles preventing Jest from completing

[tylersmalley]

Github issue description exceeds 32767 characters. This is too long for Jira. See the GH issue.

[elasticmachine]

Pinging @elastic/kibana-reporting-services (Team:Reporting Services)

[tylersmalley]

Also while you're looking at this, I am wondering if we could suppress the debug logs triggered by these tests.

Example:

 PASS  x-pack/plugins/reporting/server/lib/screenshots/get_number_of_items.test.ts
  ● Console

    console.log
      debug Task to monitor for pending reports to run every 3s.

      at LevelLogger.<anonymous> (x-pack/plugins/reporting/server/test_helpers/create_mock_levellogger.ts:15:72)

    console.log
      warn Enabling the Chromium sandbox provides an additional layer of protection.

      at LevelLogger.<anonymous> (x-pack/plugins/reporting/server/test_helpers/create_mock_levellogger.ts:15:72)

    console.log
      debug waiting for elements or items count attribute; or not found to interrupt

      at LevelLogger.<anonymous> (x-pack/plugins/reporting/server/test_helpers/create_mock_levellogger.ts:15:72)

    console.log
      debug Task to monitor for pending reports to run every 3s.

      at LevelLogger.<anonymous> (x-pack/plugins/reporting/server/test_helpers/create_mock_levellogger.ts:15:72)

    console.log
      warn Enabling the Chromium sandbox provides an additional layer of protection.

      at LevelLogger.<anonymous> (x-pack/plugins/reporting/server/test_helpers/create_mock_levellogger.ts:15:72)

    console.log
      debug waiting for elements or items count attribute; or not found to interrupt

      at LevelLogger.<anonymous> (x-pack/plugins/reporting/server/test_helpers/create_mock_levellogger.ts:15:72)

    console.log
      debug Task to monitor for pending reports to run every 3s.

      at LevelLogger.<anonymous> (x-pack/plugins/reporting/server/test_helpers/create_mock_levellogger.ts:15:72)

    console.log
      warn Enabling the Chromium sandbox provides an additional layer of protection.

      at LevelLogger.<anonymous> (x-pack/plugins/reporting/server/test_helpers/create_mock_levellogger.ts:15:72)

    console.log
      debug waiting for elements or items count attribute; or not found to interrupt

      at LevelLogger.<anonymous> (x-pack/plugins/reporting/server/test_helpers/create_mock_levellogger.ts:15:72)

[jloleysens]

I looked into this a little bit and it looks like the issue for the open handles is the combination of jest and mock-fs (see tschaub/mock-fs#341).

This is not limited to Reporting tests as I was able to reproduce this in other tests using mock-fs. We could try and fix this upstream, create a patch for the module, or create a custom FS mock using jest. I think we can try fix this in that order :D

[vadimkibana]

I see @jloleysens you already have a fix PR for upstream dependency, which is great. Just wanted to check with you one more idea: what do you think about not mocking the file system? Instead using the real file system, then cleaning up once tests finish.

[jloleysens]

@vadimkibana , yeah I think that would be a feasible option too. Might just make the tests need to know even more about implementation details though.

[tsullivan]

Oops, there is still one skipped test that leaves an open handle:

kibana/x-pack/plugins/reporting/server/routes/deprecations.test.ts

Line 1 in 8695632

/*

node scripts/jest --detectOpenHandles --config x-pack/plugins/reporting/jest.config.js x-pack/plugins/reporting/server/routes/deprecations.test.ts

The tests are passing but the command stays open without exiting. I don't see nay warnings or clues about how to unskip this test.