Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make screen compatible with document.body.replaceWith()
What: The screen utility no longer caches the body element at import time. When the body or entire HTML document changes with replaceWith(), the screen utility continues to operate on the global value. Why: My integration testing environment strives to creates testing scenarios that are as realistic to production as possible. This aligns with the library's guiding principles: > We try to only expose methods and utilities that encourage you to > write tests that closely resemble how your web pages are used. To assist with this, parts of my integration testing environment involve a 2-step process: 1. Run a command to dump the HTML documents rendered by the backend. 2. Load those dumps into a Jest test environment to assert JavaScript behavior. Loading the HTML document in Jest is a challenge as the global HTML document is setup by jest-environment-jsdom ahead of the test running. To make this work well, the environment "replaces" the jsdom HTML document like: ``` const content = loadHTML(...); const tmpDom = new jsdom.JSDOM(content); const tmpDocument = tmpDom.window.document; // Replace the global document with the one from the backend. document.documentElement.replaceWith(document.adoptNode(tmpDocument.documentElement)); ``` This works out great in practice for me. The JavaScript is tested against real HTML documents rather than fabricated ones for the test. In the event that the backend changes how elements are rendered that, the integration tests will expose this and force a fix to make the two compatible. With this change, the screen utility is now usable as a convenience. How: Rather than caching the document.body at import time, screen now dynamically uses the most up date value on the global document.
- Loading branch information