[Lens] Prepare Lens for jest-environment-jsdom migration

[dej611]

Summary

Fixes #95202

The message reported on the issue is really rewriting the original messages, which are referring to document.activeElement.

To reproduce the issue:

• Enable the jest-environment-jsdom environment in the packages/kbn-test/jest-preset.js

To see the original issue bubble up add skip to the following tests but one (others will interfere):
https://github.com/elastic/kibana/blob/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.test.tsx#L616

https://github.com/elastic/kibana/blob/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.test.tsx#L107

https://github.com/elastic/kibana/blob/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.test.tsx#L122

https://github.com/elastic/kibana/blob/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.test.tsx#L143

https://github.com/elastic/kibana/blob/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.test.tsx#L164

And something like this will show up:

 FAIL  x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.test.tsx (7.915 s)
  ● ConfigPanel › focus behavior when adding or removing layers › should focus the added layer

    TypeError: Cannot read property 'getAttribute' of undefined

      175 |       });
      176 |       const focusedEl = document.activeElement;
    > 177 |       expect(focusedEl?.children[0].getAttribute('data-test-subj')).toEqual('lns-layerPanel-1');
          |                                     ^
      178 |     });
      179 |   });
      180 | });

      at Object.<anonymous> (x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.test.tsx:177:37)

These specific tests were using the document.activeElement which in jsdom has a specific behaviour, as reported also on this Enzyme issue.

This PR implements the solution proposed here. Using directly document.body as suggested on the jsdom issue prints some very verbose performance warnings, so the container solution is the safest option.

Checklist

• Unit or functional tests were updated or added to match the most common scenarios

[elasticmachine]

Pinging @elastic/kibana-app (Team:KibanaApp)

[dej611]

Not sure why the type checker told me to remove the // @ts-expect-error before and now it wants them back 😓

[flash1293]

Code LGTM except for one typing nit

[flash1293]

Why expecting an error here? It seems like we can just extend the options type in packages/kbn-test/src/jest/utils/enzyme_helpers.tsx to take attachTo as well.

[mbondyra]

LGTM! If we can get rid of //@ts-expect-error with Joe's suggestion, let's do it, but otherwise approved!

[dej611]

@elasticmachine merge upstream

[dej611]

The changes in the helper triggered another review from elastic/kibana-operations. Sorry @spalger 😅 , but I hope that may be helpful for other teams as well.

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: c42e354
• Storybooks Preview

Metrics [docs]

✅ unchanged

History

• 💚 Build #114951 succeeded d0afe67
• 💔 Build #114938 failed dc23bc7

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

[kibanamachine]

💚 Backport successful

✅ 7.x / #95530

This backport PR will be merged automatically after passing CI.